ImageFormat.h

Go to the documentation of this file.

/*
 * Copyright 2020-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_FORMAT_H
#define NV_VPI_IMAGE_FORMAT_H
 
#include "ColorSpec.h"
#include "DataLayout.h"
#include "PixelType.h"
 
#include <assert.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#ifdef __GNUC__
#    pragma GCC diagnostic push
#    pragma GCC diagnostic ignored "-Wpedantic"
#endif
typedef enum
{
    VPI_IMAGE_FORMAT_INVALID = 0,
 
    VPI_IMAGE_FORMAT_U8 = VPI_DETAIL_MAKE_NONCOLOR_FMT(PL, UNSIGNED, X000, 1, X8),
 
    VPI_IMAGE_FORMAT_S8 = VPI_DETAIL_MAKE_NONCOLOR_FMT(PL, SIGNED, X000, 1, X8),
 
    VPI_IMAGE_FORMAT_U16 = VPI_DETAIL_MAKE_NONCOLOR_FMT(PL, UNSIGNED, X000, 1, X16),
 
    VPI_IMAGE_FORMAT_S16 = VPI_DETAIL_MAKE_NONCOLOR_FMT(PL, SIGNED, X000, 1, X16),
 
    VPI_IMAGE_FORMAT_U32 = VPI_DETAIL_MAKE_NONCOLOR_FMT(PL, UNSIGNED, X000, 1, X32),
 
    VPI_IMAGE_FORMAT_S32 = VPI_DETAIL_MAKE_NONCOLOR_FMT(PL, SIGNED, X000, 1, X32),
 
    VPI_IMAGE_FORMAT_2S16 = VPI_DETAIL_MAKE_NONCOLOR_FMT(PL, SIGNED, XY00, 1, X16_Y16),
 
    VPI_IMAGE_FORMAT_2S16_BL = VPI_DETAIL_MAKE_NONCOLOR_FMT(BL, SIGNED, XY00, 1, X16_Y16),
 
    VPI_IMAGE_FORMAT_F32 = VPI_DETAIL_MAKE_NONCOLOR_FMT(PL, FLOAT, X000, 1, X32),
 
    VPI_IMAGE_FORMAT_F64 = VPI_DETAIL_MAKE_NONCOLOR_FMT(PL, FLOAT, X000, 1, X64),
 
    VPI_IMAGE_FORMAT_2F32 = VPI_DETAIL_MAKE_NONCOLOR_FMT(PL, FLOAT, XY00, 1, X32_Y32),
 
    VPI_IMAGE_FORMAT_Y8 = VPI_DETAIL_MAKE_YCbCr_FMT(BT601, NONE, PL, UNSIGNED, X000, 1, X8),
 
    VPI_IMAGE_FORMAT_Y8_ER = VPI_DETAIL_MAKE_YCbCr_FMT(BT601_ER, NONE, PL, UNSIGNED, X000, 1, X8),
 
    VPI_IMAGE_FORMAT_Y8_BL = VPI_DETAIL_MAKE_YCbCr_FMT(BT601, NONE, BL, UNSIGNED, X000, 1, X8),
 
    VPI_IMAGE_FORMAT_Y8_ER_BL = VPI_DETAIL_MAKE_YCbCr_FMT(BT601_ER, NONE, BL, UNSIGNED, X000, 1, X8),
 
    VPI_IMAGE_FORMAT_Y16_ER = VPI_DETAIL_MAKE_YCbCr_FMT(BT601_ER, NONE, PL, UNSIGNED, X000, 1, X16),
 
    VPI_IMAGE_FORMAT_Y16_ER_BL = VPI_DETAIL_MAKE_YCbCr_FMT(BT601_ER, NONE, BL, UNSIGNED, X000, 1, X16),
 
    VPI_IMAGE_FORMAT_NV12 = VPI_DETAIL_MAKE_YCbCr_FMT(BT601, 420, PL, UNSIGNED, XYZ0, 2, X8, X8_Y8),
 
    VPI_IMAGE_FORMAT_NV12_BL = VPI_DETAIL_MAKE_YCbCr_FMT(BT601, 420, BL, UNSIGNED, XYZ0, 2, X8, X8_Y8),
 
    VPI_IMAGE_FORMAT_NV12_ER = VPI_DETAIL_MAKE_YCbCr_FMT(BT601_ER, 420, PL, UNSIGNED, XYZ0, 2, X8, X8_Y8),
 
    VPI_IMAGE_FORMAT_NV12_ER_BL = VPI_DETAIL_MAKE_YCbCr_FMT(BT601_ER, 420, BL, UNSIGNED, XYZ0, 2, X8, X8_Y8),
 
    VPI_IMAGE_FORMAT_NV24 = VPI_DETAIL_MAKE_YCbCr_FMT(BT601, 444, PL, UNSIGNED, XYZ0, 2, X8, X8_Y8),
 
    VPI_IMAGE_FORMAT_NV24_BL = VPI_DETAIL_MAKE_YCbCr_FMT(BT601, 444, BL, UNSIGNED, XYZ0, 2, X8, X8_Y8),
 
    VPI_IMAGE_FORMAT_NV24_ER = VPI_DETAIL_MAKE_YCbCr_FMT(BT601_ER, 444, PL, UNSIGNED, XYZ0, 2, X8, X8_Y8),
 
    VPI_IMAGE_FORMAT_NV24_ER_BL = VPI_DETAIL_MAKE_YCbCr_FMT(BT601_ER, 444, BL, UNSIGNED, XYZ0, 2, X8, X8_Y8),
 
    VPI_IMAGE_FORMAT_UYVY = VPI_DETAIL_MAKE_YCbCr_FMT(BT601, 422, PL, UNSIGNED, XYZ1, 1, Y8_X8__Z8_X8),
 
    VPI_IMAGE_FORMAT_UYVY_BL = VPI_DETAIL_MAKE_YCbCr_FMT(BT601, 422, BL, UNSIGNED, XYZ1, 1, Y8_X8__Z8_X8),
 
    VPI_IMAGE_FORMAT_UYVY_ER = VPI_DETAIL_MAKE_YCbCr_FMT(BT601_ER, 422, PL, UNSIGNED, XYZ1, 1, Y8_X8__Z8_X8),
 
    VPI_IMAGE_FORMAT_UYVY_ER_BL = VPI_DETAIL_MAKE_YCbCr_FMT(BT601_ER, 422, BL, UNSIGNED, XYZ1, 1, Y8_X8__Z8_X8),
 
    VPI_IMAGE_FORMAT_YUYV = VPI_DETAIL_MAKE_YCbCr_FMT(BT601, 422, PL, UNSIGNED, XYZ1, 1, X8_Y8__X8_Z8),
 
    VPI_IMAGE_FORMAT_YUYV_BL = VPI_DETAIL_MAKE_YCbCr_FMT(BT601, 422, BL, UNSIGNED, XYZ1, 1, X8_Y8__X8_Z8),
 
    VPI_IMAGE_FORMAT_YUYV_ER = VPI_DETAIL_MAKE_YCbCr_FMT(BT601_ER, 422, PL, UNSIGNED, XYZ1, 1, X8_Y8__X8_Z8),
 
    VPI_IMAGE_FORMAT_YUYV_ER_BL = VPI_DETAIL_MAKE_YCbCr_FMT(BT601_ER, 422, BL, UNSIGNED, XYZ1, 1, X8_Y8__X8_Z8),
 
    VPI_IMAGE_FORMAT_RGB8 = VPI_DETAIL_MAKE_COLOR_FMT(RGB, UNDEFINED, PL, UNSIGNED, XYZ1, 1, X8_Y8_Z8),
 
    VPI_IMAGE_FORMAT_BGR8 = VPI_DETAIL_MAKE_COLOR_FMT(RGB, UNDEFINED, PL, UNSIGNED, ZYX1, 1, X8_Y8_Z8),
 
    VPI_IMAGE_FORMAT_RGBA8 = VPI_DETAIL_MAKE_COLOR_FMT(RGB, UNDEFINED, PL, UNSIGNED, XYZW, 1, X8_Y8_Z8_W8),
 
    VPI_IMAGE_FORMAT_BGRA8 = VPI_DETAIL_MAKE_COLOR_FMT(RGB, UNDEFINED, PL, UNSIGNED, ZYXW, 1, X8_Y8_Z8_W8),
 
    VPI_IMAGE_FORMAT_FORCE64 = INT64_MAX
    /* \endcond */
} VPIImageFormat;
#ifdef __GNUC__
#    pragma GCC diagnostic pop
#endif
 
#ifdef VPI_DOXYGEN
#    define VPI_MAKE_YCbCr_IMAGE_FORMAT_ABBREV(colorSpec, chromaSubsamp, memLayout, dataType, swizzle, numPlanes, \
                                               packing0, packing1, ...)
#else
#    define VPI_MAKE_YCbCr_IMAGE_FORMAT_ABBREV (VPIImageFormat) VPI_DETAIL_MAKE_YCbCr_FMT
#endif
 
#ifdef VPI_DOXYGEN
#    define VPI_MAKE_YCbCr_IMAGE_FORMAT(colorModel, colorSpec, chromaSubsamp, memLayout, dataType, swizzle, numPlanes, \
                                        packing0, packing1, ...)
#else
#    define VPI_MAKE_YCbCr_IMAGE_FORMAT (VPIImageFormat) VPI_DETAIL_MAKE_YCbCr_FORMAT
#endif
 
#ifdef VPI_DOXYGEN
#    define VPI_MAKE_COLOR_IMAGE_FORMAT_ABBREV(colorModel, colorSpec, memLayout, dataType, swizzle, numPlanes, \
                                               packing0, packing1, ...)
#else
#    define VPI_MAKE_COLOR_IMAGE_FORMAT_ABBREV (VPIImageFormat) VPI_DETAIL_MAKE_COLOR_FMT
#endif
 
#ifdef VPI_DOXYGEN
#    define VPI_MAKE_COLOR_IMAGE_FORMAT(colorModel, colorSpec, memLayout, dataType, swizzle, numPlanes, packing0, \
                                        packing1, ...)
#else
#    define VPI_MAKE_COLOR_IMAGE_FORMAT (VPIImageFormat) VPI_DETAIL_MAKE_COLOR_FORMAT
#endif
 
#ifdef VPI_DOXYGEN
#    define VPI_MAKE_NONCOLOR_IMAGE_FORMAT_ABBREV(memLayout, dataType, swizzle, numPlanes, packing0, packing1, ...)
#else
#    define VPI_MAKE_NONCOLOR_IMAGE_FORMAT_ABBREV (VPIImageFormat) VPI_DETAIL_MAKE_NONCOLOR_FMT
#endif
 
#ifdef VPI_DOXYGEN
#    define VPI_MAKE_NONCOLOR_IMAGE_FORMAT(memLayout, dataType, swizzle, numPlanes, packing0, packing1, ...)
#else
#    define VPI_MAKE_NONCOLOR_IMAGE_FORMAT (VPIImageFormat) VPI_DETAIL_MAKE_NONCOLOR_FORMAT
#endif
 
#ifdef VPI_DOXYGEN
#    define VPI_MAKE_RAW_IMAGE_FORMAT_ABBREV(rawPattern, memLayout, dataType, numPlanes, swizzle, packing)
#else
#    define VPI_MAKE_RAW_IMAGE_FORMAT_ABBREV (VPIImageFormat) VPI_DETAIL_MAKE_RAW_FMT
#endif
 
#ifdef VPI_DOXYGEN
#    define VPI_MAKE_RAW_IMAGE_FORMAT(rawPattern, memLayout, dataType, numPlanes, swizzle, packing)
#else
#    define VPI_MAKE_RAW_IMAGE_FORMAT (VPIImageFormat) VPI_DETAIL_MAKE_RAW_FORMAT
#endif
 
VPI_PUBLIC VPIImageFormat vpiMakeYCbCrImageFormat(VPIColorSpec colorSpec, VPIChromaSubsampling chromaSub,
                                                  VPIMemLayout memLayout, VPIDataType dataType, VPISwizzle swizzle,
                                                  VPIPacking packing0, VPIPacking packing1, VPIPacking packing2,
                                                  VPIPacking packing3);
 
VPI_PUBLIC VPIImageFormat vpiMakeColorImageFormat(VPIColorModel colorModel, VPIColorSpec colorSpec,
                                                  VPIMemLayout memLayout, VPIDataType dataType, VPISwizzle swizzle,
                                                  VPIPacking packing0, VPIPacking packing1, VPIPacking packing2,
                                                  VPIPacking packing3);
 
VPI_PUBLIC VPIImageFormat vpiMakeNonColorImageFormat(VPIMemLayout memLayout, VPIDataType dataType, VPISwizzle swizzle,
                                                     VPIPacking packing0, VPIPacking packing1, VPIPacking packing2,
                                                     VPIPacking packing3);
 
VPI_PUBLIC VPIImageFormat vpiMakeRawImageFormat(VPIRawPattern rawPattern, VPIMemLayout memLayout, VPIDataType dataType,
                                                VPISwizzle swizzle, VPIPacking packing0, VPIPacking packing1,
                                                VPIPacking packing2, VPIPacking packing3);
 
VPI_PUBLIC VPIImageFormat vpiMakeImageFormatFromFourCC(uint32_t fourcc, VPIColorSpec colorSpec, VPIMemLayout memLayout);
 
VPI_PUBLIC uint32_t vpiImageFormatGetFourCC(VPIImageFormat fmt);
 
VPI_PUBLIC VPIPacking vpiImageFormatGetPlanePacking(VPIImageFormat fmt, int plane);
 
VPI_PUBLIC VPIImageFormat vpiImageFormatSetSwizzleAndPacking(VPIImageFormat fmt, VPISwizzle swizzle,
                                                             VPIPacking packing0, VPIPacking packing1,
                                                             VPIPacking packing2, VPIPacking packing3);
 
VPI_PUBLIC int vpiImageFormatGetPlaneBitsPerPixel(VPIImageFormat fmt, int plane);
 
VPI_PUBLIC VPIImageFormat vpiImageFormatSetDataType(VPIImageFormat fmt, VPIDataType dataType);
 
VPI_PUBLIC VPIDataType vpiImageFormatGetDataType(VPIImageFormat fmt);
 
VPI_PUBLIC VPISwizzle vpiImageFormatGetSwizzle(VPIImageFormat fmt);
 
VPI_PUBLIC VPISwizzle vpiImageFormatGetPlaneSwizzle(VPIImageFormat fmt, int plane);
 
VPI_PUBLIC VPIImageFormat vpiImageFormatSetMemLayout(VPIImageFormat fmt, VPIMemLayout memLayout);
 
VPI_PUBLIC VPIMemLayout vpiImageFormatGetMemLayout(VPIImageFormat fmt);
 
VPI_PUBLIC VPIImageFormat vpiImageFormatSetColorSpec(VPIImageFormat fmt, VPIColorSpec colorSpec);
 
VPI_PUBLIC VPIColorSpec vpiImageFormatGetColorSpec(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 vpiImageFormatGetPlaneChannelCount(VPIImageFormat fmt, int plane);
 
VPI_PUBLIC int vpiImageFormatGetPlaneCount(VPIImageFormat fmt);
 
VPI_PUBLIC int vpiImageFormatGetChannelCount(VPIImageFormat fmt);
 
VPI_PUBLIC void vpiImageFormatGetBitsPerChannel(VPIImageFormat fmt, int32_t *bits);
 
VPI_PUBLIC VPIPixelType vpiImageFormatGetPlanePixelType(VPIImageFormat fmt, int plane);
 
VPI_PUBLIC VPIImageFormat vpiImageFormatGetPlaneFormat(VPIImageFormat fmt, int plane);
 
VPI_PUBLIC VPIImageFormat vpiMakeImageFormatFromPlanes(VPIImageFormat plane0, VPIImageFormat plane1,
                                                       VPIImageFormat plane2, VPIImageFormat plane3);
 
VPI_PUBLIC const char *vpiImageFormatGetName(VPIImageFormat fmt);
 
VPI_PUBLIC VPIRawPattern vpiImageFormatGetRawPattern(VPIImageFormat fmt);
 
VPI_PUBLIC VPIImageFormat vpiImageFormatSetRawPattern(VPIImageFormat fmt, VPIRawPattern rawPattern);
 
VPI_PUBLIC int vpiImageFormatHasSameDataLayout(VPIImageFormat a, VPIImageFormat b);
 
#ifdef __cplusplus
}
#endif
 
#endif /* NV_VPI_IMAGE_FORMAT_H */