Image.h

Go to the documentation of this file.

/*
 * Copyright 2019-2021 NVIDIA Corporation. All rights reserved.
 *
 * NOTICE TO LICENSEE:
 *
 * This source code and/or documentation ("Licensed Deliverables") are
 * subject to NVIDIA intellectual property rights under U.S. and
 * international Copyright laws.
 *
 * These Licensed Deliverables contained herein is PROPRIETARY and
 * CONFIDENTIAL to NVIDIA and is being provided under the terms and
 * conditions of a form of NVIDIA software license agreement by and
 * between NVIDIA and Licensee ("License Agreement") or electronically
 * accepted by Licensee. Notwithstanding any terms or conditions to
 * the contrary in the License Agreement, reproduction or disclosure
 * of the Licensed Deliverables to any third party without the express
 * written consent of NVIDIA is prohibited.
 *
 * NOTWITHSTANDING ANY TERMS OR CONDITIONS TO THE CONTRARY IN THE
 * LICENSE AGREEMENT, NVIDIA MAKES NO REPRESENTATION ABOUT THE
 * SUITABILITY OF THESE LICENSED DELIVERABLES FOR ANY PURPOSE. IT IS
 * PROVIDED "AS IS" WITHOUT EXPRESS OR IMPLIED WARRANTY OF ANY KIND.
 * NVIDIA DISCLAIMS ALL WARRANTIES WITH REGARD TO THESE LICENSED
 * DELIVERABLES, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY,
 * NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE.
 * NOTWITHSTANDING ANY TERMS OR CONDITIONS TO THE CONTRARY IN THE
 * LICENSE AGREEMENT, IN NO EVENT SHALL NVIDIA BE LIABLE FOR ANY
 * SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, OR ANY
 * DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
 * WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
 * ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
 * OF THESE LICENSED DELIVERABLES.
 *
 * U.S. Government End Users. These Licensed Deliverables are a
 * "commercial item" as that term is defined at 48 C.F.R. 2.101 (OCT
 * 1995), consisting of "commercial computer software" and "commercial
 * computer software documentation" as such terms are used in 48
 * C.F.R. 12.212 (SEPT 1995) and is provided to the U.S. Government
 * only as a commercial end item. Consistent with 48 C.F.R.12.212 and
 * 48 C.F.R. 227.7202-1 through 227.7202-4 (JUNE 1995), all
 * U.S. Government End Users acquire the Licensed Deliverables with
 * only those rights set forth herein.
 *
 * Any use of the Licensed Deliverables in individual and commercial
 * software must include, in the user documentation and internal
 * comments to the code, the above Disclaimer and U.S. Government End
 * Users Notice.
 */
 
#ifndef NV_VPI_IMAGE_H
#define NV_VPI_IMAGE_H
 
#include "Export.h"
#include "ImageFormat.h"
#include "PixelType.h"
#include "Status.h"
#include "Types.h"
 
#include <stdint.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct VPIImagePlanePitchLinearRec
{
    VPIPixelType pixelType;
 
    int32_t width;
 
    int32_t height;
 
    int32_t pitchBytes;
 
    int64_t offsetBytes;
 
    VPIByte *pBase;
 
} VPIImagePlanePitchLinear;
 
#define VPI_MAX_PLANE_COUNT (6)
 
typedef struct VPIImageBufferPitchLinearRec
{
    VPIImageFormat format;
 
    int32_t numPlanes;
 
    VPIImagePlanePitchLinear planes[VPI_MAX_PLANE_COUNT];
 
} VPIImageBufferPitchLinear;
 
typedef enum
{
    VPI_IMAGE_BUFFER_INVALID,
 
    VPI_IMAGE_BUFFER_HOST_PITCH_LINEAR,
 
    VPI_IMAGE_BUFFER_CUDA_PITCH_LINEAR,
 
    VPI_IMAGE_BUFFER_CUDA_ARRAY,
 
    VPI_IMAGE_BUFFER_EGLIMAGE,
 
    VPI_IMAGE_BUFFER_NVBUFFER,
 
} VPIImageBufferType;
 
typedef void *EGLImageKHR;
typedef struct cudaArray *cudaArray_t;
 
typedef union VPIImageBufferRec
{
    VPIImageBufferPitchLinear pitch;
 
    cudaArray_t cudaarray;
 
    EGLImageKHR egl;
 
    int fd;
 
} VPIImageBuffer;
 
typedef struct VPIImageDataRec
{
    VPIImageBufferType bufferType;
 
    VPIImageBuffer buffer;
 
} VPIImageData;
 
VPI_PUBLIC VPIStatus vpiImageCreate(int32_t width, int32_t height, VPIImageFormat fmt, uint64_t flags, VPIImage *img);
 
typedef struct
{
    VPIColorSpec colorSpec;
} VPIImageWrapperParams;
 
VPI_PUBLIC VPIStatus vpiInitImageWrapperParams(VPIImageWrapperParams *params);
 
VPI_PUBLIC VPIStatus vpiImageCreateView(VPIImage imgParent, const VPIRectangleI *clipBounds, uint64_t flags,
                                        VPIImage *imgView);
 
VPI_PUBLIC VPIStatus vpiImageSetView(VPIImage view, VPIImage parent, const VPIRectangleI *clipBounds);
 
VPI_PUBLIC VPIStatus vpiImageCreateWrapper(const VPIImageData *data, const VPIImageWrapperParams *params,
                                           uint64_t flags, VPIImage *img);
 
VPI_PUBLIC VPIStatus vpiImageSetWrapper(VPIImage img, const VPIImageData *data);
 
VPI_PUBLIC void vpiImageDestroy(VPIImage img);
 
VPI_PUBLIC VPIStatus vpiImageGetSize(VPIImage img, int32_t *width, int32_t *height);
 
VPI_PUBLIC VPIStatus vpiImageGetFormat(VPIImage img, VPIImageFormat *format);
 
VPI_PUBLIC VPIStatus vpiImageGetFlags(VPIImage img, uint64_t *flags);
 
VPI_PUBLIC VPIStatus vpiImageLock(VPIImage img, VPILockMode mode);
 
VPI_PUBLIC VPIStatus vpiImageLockData(VPIImage img, VPILockMode mode, VPIImageBufferType bufType, VPIImageData *data);
 
VPI_PUBLIC VPIStatus vpiImageUnlock(VPIImage img);
 
#ifdef __cplusplus
}
#endif
 
#endif /* NV_VPI_IMAGE_H */