ImageFormat.h

Go to the documentation of this file.

/*
 * Copyright 2020 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_FORMAT_H
#define NV_VPI_IMAGE_FORMAT_H
 
#include "Format.h"
#include "PixelFormat.h"
 
#include <assert.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum
{
    VPI_IMAGE_FORMAT_INVALID = 0,
 
    VPI_IMAGE_FORMAT_U8 = VPI_DETAIL_MAKE_IMAGE_FORMAT(NONCOLOR, NONE, PL, UNSIGNED, X000, 1, X8),
 
    VPI_IMAGE_FORMAT_S8 = VPI_DETAIL_MAKE_IMAGE_FORMAT(NONCOLOR, NONE, PL, SIGNED, X000, 1, X8),
 
    VPI_IMAGE_FORMAT_U16 = VPI_DETAIL_MAKE_IMAGE_FORMAT(NONCOLOR, NONE, PL, UNSIGNED, X000, 1, X16),
 
    VPI_IMAGE_FORMAT_S16 = VPI_DETAIL_MAKE_IMAGE_FORMAT(NONCOLOR, NONE, PL, SIGNED, X000, 1, X16),
 
    VPI_IMAGE_FORMAT_F32 = VPI_DETAIL_MAKE_IMAGE_FORMAT(NONCOLOR, NONE, PL, FLOAT, X000, 1, X32),
 
    VPI_IMAGE_FORMAT_F64 = VPI_DETAIL_MAKE_IMAGE_FORMAT(NONCOLOR, NONE, PL, FLOAT, X000, 1, X64),
 
    VPI_IMAGE_FORMAT_2F32 = VPI_DETAIL_MAKE_IMAGE_FORMAT(NONCOLOR, NONE, PL, FLOAT, XY00, 1, X32_Y32),
 
    VPI_IMAGE_FORMAT_NV12 = VPI_DETAIL_MAKE_IMAGE_FORMAT(YCbCr601_ER, 420_COSITED, PL, UNSIGNED, XYZ0, 2, X8, X8_Y8),
 
    VPI_IMAGE_FORMAT_NV12_BL = VPI_DETAIL_MAKE_IMAGE_FORMAT(YCbCr601_ER, 420_COSITED, BL, UNSIGNED, XYZ0, 2, X8, X8_Y8),
 
    VPI_IMAGE_FORMAT_RGB8 = VPI_DETAIL_MAKE_IMAGE_FORMAT(RGB, NONE, PL, UNSIGNED, XYZ1, 1, X8_Y8_Z8),
 
    VPI_IMAGE_FORMAT_BGR8 = VPI_DETAIL_MAKE_IMAGE_FORMAT(RGB, NONE, PL, UNSIGNED, ZYX1, 1, X8_Y8_Z8),
 
    VPI_IMAGE_FORMAT_RGBA8 = VPI_DETAIL_MAKE_IMAGE_FORMAT(RGB, NONE, PL, UNSIGNED, XYZW, 1, X8_Y8_Z8_W8),
 
    VPI_IMAGE_FORMAT_BGRA8 = VPI_DETAIL_MAKE_IMAGE_FORMAT(RGB, NONE, PL, UNSIGNED, ZYXW, 1, X8_Y8_Z8_W8),
 
    VPI_IMAGE_FORMAT_FORCE64 = INT64_MAX
    /* \endcond */
} VPIImageFormat;
 
#ifdef VPI_DOXYGEN
#    define VPI_MAKE_IMAGE_FORMAT(colorSpace, chromaSubsamp, memLayout, dataType, swizzle, numPlanes, packing0, \
                                  packing1, ...)
#else
#    define VPI_MAKE_IMAGE_FORMAT (VPIImageFormat) VPI_DETAIL_MAKE_IMAGE_FORMAT
#endif
 
#define vpiMakeImageFormat VPI_APINAME(vpiMakeImageFormat, 004)
#define vpiMakeImageFormatFromPlanes VPI_APINAME(vpiMakeImageFormatFromPlanes, 004)
#define vpiImageFormatGetPlanePacking VPI_APINAME(vpiImageFormatGetPlanePacking, 004)
#define vpiImageFormatGetPlaneBitsPerPixel VPI_APINAME(vpiImageFormatGetPlaneBitsPerPixel, 004)
#define vpiImageFormatGetDataType VPI_APINAME(vpiImageFormatGetDataType, 004)
#define vpiImageFormatGetSwizzle VPI_APINAME(vpiImageFormatGetSwizzle, 004)
#define vpiImageFormatGetSwizzleX VPI_APINAME(vpiImageFormatGetSwizzleX, 004)
#define vpiImageFormatGetSwizzleY VPI_APINAME(vpiImageFormatGetSwizzleY, 004)
#define vpiImageFormatGetSwizzleZ VPI_APINAME(vpiImageFormatGetSwizzleZ, 004)
#define vpiImageFormatGetSwizzleW VPI_APINAME(vpiImageFormatGetSwizzleW, 004)
#define vpiImageFormatGetMemLayout VPI_APINAME(vpiImageFormatGetMemLayout, 004)
#define vpiImageFormatGetColorSpace VPI_APINAME(vpiImageFormatGetColorSpace, 004)
#define vpiImageFormatGetColorModel VPI_APINAME(vpiImageFormatGetColorModel, 004)
#define vpiImageFormatGetChromaSubsampling VPI_APINAME(vpiImageFormatGetChromaSubsampling, 004)
#define vpiImageFormatGetChromaSubsamplingDivHoriz VPI_APINAME(vpiImageFormatGetChromaSubsamplingDivHoriz, 004)
#define vpiImageFormatGetChromaSubsamplingDivVert VPI_APINAME(vpiImageFormatGetChromaSubsamplingDivVert, 004)
#define vpiImageFormatGetChromaSubsamplingCenterHoriz VPI_APINAME(vpiImageFormatGetChromaSubsamplingCenterHoriz, 004)
#define vpiImageFormatGetChromaSubsamplingCenterVert VPI_APINAME(vpiImageFormatGetChromaSubsamplingCenterVert, 004)
#define vpiImageFormatGetPlaneChannelCount VPI_APINAME(vpiImageFormatGetPlaneChannelCount, 004)
#define vpiImageFormatGetPlaneCount VPI_APINAME(vpiImageFormatGetPlaneCount, 004)
#define vpiImageFormatGetChannelCount VPI_APINAME(vpiImageFormatGetChannelCount, 004)
#define vpiImageFormatGetPlaneSwizzle VPI_APINAME(vpiImageFormatGetPlaneSwizzle, 004)
#define vpiImageFormatGetPlaneFormat VPI_APINAME(vpiImageFormatGetPlaneFormat, 004)
 
VPI_PUBLIC VPIImageFormat vpiMakeImageFormat(VPIColorSpace colorSpace, VPIChromaSubsampling chromaSub,
                                             VPIMemLayout memLayout, VPIFormatDataType dataType, VPISwizzle swizzle,
                                             VPIFormatPacking packing0, VPIFormatPacking packing1,
                                             VPIFormatPacking packing2, VPIFormatPacking packing3);
 
VPI_PUBLIC VPIFormatPacking vpiImageFormatGetPlanePacking(VPIImageFormat fmt, int plane);
 
VPI_PUBLIC int vpiImageFormatGetPlaneBitsPerPixel(VPIImageFormat fmt, int plane);
 
VPI_PUBLIC VPIImageFormat vpiImageFormatSetDataType(VPIImageFormat fmt, VPIFormatDataType dataType);
 
VPI_PUBLIC VPIFormatDataType vpiImageFormatGetDataType(VPIImageFormat fmt);
 
VPI_PUBLIC VPISwizzle vpiImageFormatGetSwizzle(VPIImageFormat fmt);
 
VPI_PUBLIC VPISwizzle vpiImageFormatGetPlaneSwizzle(VPIImageFormat fmt, int plane);
 
VPI_PUBLIC VPISwizzleChannel vpiImageFormatGetSwizzleX(VPIImageFormat fmt);
 
VPI_PUBLIC VPISwizzleChannel vpiImageFormatGetSwizzleY(VPIImageFormat fmt);
 
VPI_PUBLIC VPISwizzleChannel vpiImageFormatGetSwizzleZ(VPIImageFormat fmt);
 
VPI_PUBLIC VPISwizzleChannel vpiImageFormatGetSwizzleW(VPIImageFormat fmt);
 
VPI_PUBLIC VPIImageFormat vpiImageFormatSetMemLayout(VPIImageFormat fmt, VPIMemLayout memLayout);
 
VPI_PUBLIC VPIMemLayout vpiImageFormatGetMemLayout(VPIImageFormat fmt);
 
VPI_PUBLIC VPIImageFormat vpiImageFormatSetColorSpace(VPIImageFormat fmt, VPIColorSpace colorSpace);
 
VPI_PUBLIC VPIColorSpace vpiImageFormatGetColorSpace(VPIImageFormat fmt);
 
VPI_PUBLIC VPIColorModel vpiImageFormatGetColorModel(VPIImageFormat fmt);
 
VPI_PUBLIC VPIImageFormat vpiImageFormatSetChromaSubsampling(VPIImageFormat fmt, VPIChromaSubsampling css);
 
VPI_PUBLIC VPIChromaSubsampling vpiImageFormatGetChromaSubsampling(VPIImageFormat fmt);
 
VPI_PUBLIC int vpiImageFormatGetChromaSubsamplingDivHoriz(VPIImageFormat fmt);
 
VPI_PUBLIC int vpiImageFormatGetChromaSubsamplingDivVert(VPIImageFormat fmt);
 
VPI_PUBLIC int vpiImageFormatGetChromaSubsamplingCenterHoriz(VPIImageFormat fmt);
 
VPI_PUBLIC int vpiImageFormatGetChromaSubsamplingCenterVert(VPIImageFormat fmt);
 
VPI_PUBLIC int vpiImageFormatGetPlaneChannelCount(VPIImageFormat fmt, int plane);
 
VPI_PUBLIC int vpiImageFormatGetPlaneCount(VPIImageFormat fmt);
 
VPI_PUBLIC int vpiImageFormatGetChannelCount(VPIImageFormat fmt);
 
VPI_PUBLIC VPIPixelFormat vpiImageFormatGetPlanePixelFormat(VPIImageFormat fmt, int plane);
 
VPI_PUBLIC VPIImageFormat vpiImageFormatGetPlaneFormat(VPIImageFormat fmt, int plane);
 
VPI_PUBLIC VPIImageFormat vpiMakeImageFormatFromPlanes(VPIImageFormat plane0, VPIImageFormat plane1,
                                                       VPIImageFormat plane2, VPIImageFormat plane3);
 
#ifdef __cplusplus
}
#endif
 
#endif // NV_VPI_IMAGE_FORMAT_H