ColorSpec.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_COLORSPEC_H
#define NV_VPI_COLORSPEC_H
 
#include "Export.h"
#include "detail/FormatUtils.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum
{
    VPI_COLOR_MODEL_UNDEFINED = 0,     
    VPI_COLOR_MODEL_YCbCr     = 1,     
    VPI_COLOR_MODEL_RGB       = 2,     
    VPI_COLOR_MODEL_RAW       = 2 + 7, 
    VPI_COLOR_MODEL_XYZ,               
} VPIColorModel;
 
typedef enum
{
    VPI_COLOR_SPACE_SENSOR, 
    VPI_COLOR_SPACE_BT601,  
    VPI_COLOR_SPACE_BT709,  
    VPI_COLOR_SPACE_BT2020, 
    VPI_COLOR_SPACE_DCIP3,  
    VPI_COLOR_SPACE_UNDEFINED = INT32_MAX, 
} VPIColorSpace;
 
typedef enum
{
    VPI_WHITE_POINT_D65, 
    VPI_WHITE_POINT_UNDEFINED = INT32_MAX 
} VPIWhitePoint;
 
typedef enum
{
    VPI_YCbCr_ENC_UNDEFINED = 0, 
    VPI_YCbCr_ENC_BT601,         
    VPI_YCbCr_ENC_BT709,         
    VPI_YCbCr_ENC_BT2020,        
    VPI_YCbCr_ENC_BT2020c,       
    VPI_YCbCr_ENC_SMPTE240M,     
} VPIYCbCrEncoding;
 
typedef enum
{
    VPI_COLOR_XFER_LINEAR,    
    VPI_COLOR_XFER_sRGB,      
    VPI_COLOR_XFER_sYCC,      
    VPI_COLOR_XFER_PQ,        
    VPI_COLOR_XFER_BT709,     
    VPI_COLOR_XFER_BT2020,    
    VPI_COLOR_XFER_SMPTE240M, 
} VPIColorTransferFunction;
 
typedef enum
{
    VPI_COLOR_RANGE_FULL,   
    VPI_COLOR_RANGE_LIMITED 
} VPIColorRange;
 
typedef enum
{
    VPI_CHROMA_LOC_EVEN   = 0, 
    VPI_CHROMA_LOC_CENTER = 1, 
    VPI_CHROMA_LOC_ODD    = 2, 
    VPI_CHROMA_LOC_BOTH   = 3, 
} VPIChromaLocation;
 
/* clang-format off */
typedef enum
{
    VPI_COLOR_SPEC_INVALID = INT32_MAX,
 
    VPI_COLOR_SPEC_DEFAULT          = VPI_DETAIL_MAKE_CSPC(SPACE_UNDEFINED, ENC_UNDEFINED, XFER_LINEAR, RANGE_FULL,    LOC_BOTH,   LOC_BOTH),
 
    VPI_COLOR_SPEC_UNDEFINED        = VPI_DETAIL_MAKE_CSPC(SPACE_BT709,  ENC_UNDEFINED, XFER_LINEAR,    RANGE_FULL,    LOC_BOTH,   LOC_BOTH),
 
    VPI_COLOR_SPEC_BT601            = VPI_DETAIL_MAKE_CSPC(SPACE_BT709,  ENC_BT601,     XFER_BT709,     RANGE_LIMITED, LOC_EVEN,   LOC_EVEN),
 
    VPI_COLOR_SPEC_BT601_ER         = VPI_DETAIL_MAKE_CSPC(SPACE_BT709,  ENC_BT601,     XFER_BT709,     RANGE_FULL,    LOC_EVEN,   LOC_EVEN),
 
    VPI_COLOR_SPEC_BT709            = VPI_DETAIL_MAKE_CSPC(SPACE_BT709,  ENC_BT709,     XFER_BT709,     RANGE_LIMITED, LOC_EVEN,   LOC_EVEN),
 
    VPI_COLOR_SPEC_BT709_ER         = VPI_DETAIL_MAKE_CSPC(SPACE_BT709,  ENC_BT709,     XFER_BT709,     RANGE_FULL,    LOC_EVEN,   LOC_EVEN),
 
    VPI_COLOR_SPEC_BT709_LINEAR     = VPI_DETAIL_MAKE_CSPC(SPACE_BT709,  ENC_BT709,     XFER_LINEAR,    RANGE_LIMITED, LOC_EVEN,   LOC_EVEN),
 
    VPI_COLOR_SPEC_BT2020           = VPI_DETAIL_MAKE_CSPC(SPACE_BT2020, ENC_BT2020,    XFER_BT2020,    RANGE_LIMITED, LOC_EVEN,   LOC_EVEN),
 
    VPI_COLOR_SPEC_BT2020_ER        = VPI_DETAIL_MAKE_CSPC(SPACE_BT2020, ENC_BT2020,    XFER_BT2020,    RANGE_FULL,    LOC_EVEN,   LOC_EVEN),
 
    VPI_COLOR_SPEC_BT2020_LINEAR    = VPI_DETAIL_MAKE_CSPC(SPACE_BT2020, ENC_BT2020,    XFER_LINEAR,    RANGE_LIMITED, LOC_EVEN,   LOC_EVEN),
 
    VPI_COLOR_SPEC_BT2020_PQ        = VPI_DETAIL_MAKE_CSPC(SPACE_BT2020, ENC_BT2020,    XFER_PQ,        RANGE_LIMITED, LOC_EVEN,   LOC_EVEN),
 
    VPI_COLOR_SPEC_BT2020_PQ_ER     = VPI_DETAIL_MAKE_CSPC(SPACE_BT2020, ENC_BT2020,    XFER_PQ,        RANGE_FULL,    LOC_EVEN,   LOC_EVEN),
 
    VPI_COLOR_SPEC_BT2020c          = VPI_DETAIL_MAKE_CSPC(SPACE_BT2020, ENC_BT2020c,   XFER_BT2020,    RANGE_LIMITED, LOC_EVEN,   LOC_EVEN),
 
    VPI_COLOR_SPEC_BT2020c_ER       = VPI_DETAIL_MAKE_CSPC(SPACE_BT2020, ENC_BT2020c,   XFER_BT2020,    RANGE_FULL,    LOC_EVEN,   LOC_EVEN),
 
    VPI_COLOR_SPEC_MPEG2_BT601      = VPI_DETAIL_MAKE_CSPC(SPACE_BT709,  ENC_BT601,     XFER_BT709,     RANGE_FULL,    LOC_EVEN,   LOC_CENTER),
 
    VPI_COLOR_SPEC_MPEG2_BT709      = VPI_DETAIL_MAKE_CSPC(SPACE_BT709,  ENC_BT709,     XFER_BT709,     RANGE_FULL,    LOC_EVEN,   LOC_CENTER),
 
    VPI_COLOR_SPEC_MPEG2_SMPTE240M  = VPI_DETAIL_MAKE_CSPC(SPACE_BT709,  ENC_SMPTE240M, XFER_SMPTE240M, RANGE_FULL,    LOC_EVEN,   LOC_CENTER),
 
    VPI_COLOR_SPEC_sRGB             = VPI_DETAIL_MAKE_CSPC(SPACE_BT709,  ENC_UNDEFINED, XFER_sRGB,      RANGE_FULL,    LOC_BOTH,   LOC_BOTH),
 
    VPI_COLOR_SPEC_sYCC             = VPI_DETAIL_MAKE_CSPC(SPACE_BT709,  ENC_BT601,     XFER_sYCC,      RANGE_FULL,    LOC_CENTER, LOC_CENTER),
 
    VPI_COLOR_SPEC_SMPTE240M        = VPI_DETAIL_MAKE_CSPC(SPACE_BT709,  ENC_SMPTE240M, XFER_SMPTE240M, RANGE_LIMITED, LOC_EVEN,   LOC_EVEN),
 
    VPI_COLOR_SPEC_DISPLAYP3        = VPI_DETAIL_MAKE_CSPC(SPACE_DCIP3,  ENC_UNDEFINED, XFER_sRGB,      RANGE_FULL,    LOC_BOTH,   LOC_BOTH),
 
    VPI_COLOR_SPEC_DISPLAYP3_LINEAR = VPI_DETAIL_MAKE_CSPC(SPACE_DCIP3,  ENC_UNDEFINED, XFER_LINEAR,    RANGE_FULL,    LOC_BOTH,   LOC_BOTH),
 
    VPI_COLOR_SPEC_SENSOR           = VPI_DETAIL_MAKE_CSPC(SPACE_SENSOR, ENC_UNDEFINED, XFER_LINEAR,    RANGE_FULL,    LOC_BOTH,   LOC_BOTH),
} VPIColorSpec;
/* clang-format on */
 
#ifdef VPI_DOXYGEN
#    define VPI_MAKE_COLOR_SPEC_ABBREV(cspace, encoding, xferFunc, range, locHoriz, locVert)
#else
#    define VPI_MAKE_COLOR_SPEC_ABBREV (VPIColorSpec) VPI_DETAIL_MAKE_CSPC
#endif
 
#ifdef VPI_DOXYGEN
#    define VPI_MAKE_COLOR_SPEC(cspace, encoding, xferFunc, range, locHoriz, locVert)
#else
#    define VPI_MAKE_COLOR_SPEC (VPIColorSpec) VPI_DETAIL_MAKE_COLOR_SPEC
#endif
 
VPI_PUBLIC VPIColorSpec vpiMakeColorSpec(VPIColorSpace cspace, VPIYCbCrEncoding encoding,
                                         VPIColorTransferFunction xferFunc, VPIColorRange range,
                                         VPIChromaLocation locHoriz, VPIChromaLocation locVert);
 
typedef enum
{
    VPI_RAW_INVALID, 
    VPI_RAW_BAYER_RGGB,
    VPI_RAW_BAYER_BGGR,
    VPI_RAW_BAYER_GRBG,
    VPI_RAW_BAYER_GBRG,
 
    VPI_RAW_BAYER_RCCB,
    VPI_RAW_BAYER_BCCR,
    VPI_RAW_BAYER_CRBC,
    VPI_RAW_BAYER_CBRC,
 
    VPI_RAW_BAYER_RCCC,
    VPI_RAW_BAYER_CRCC,
    VPI_RAW_BAYER_CCRC,
    VPI_RAW_BAYER_CCCR,
 
    VPI_RAW_BAYER_CCCC,
 
    VPI_RAW_FORCE8 = UINT8_MAX
    /* \endcond */
} VPIRawPattern;
 
typedef enum
{
    VPI_CSS_INVALID = -1, 
    VPI_CSS_NONE = 0,
 
    VPI_CSS_444 = VPI_CSS_NONE,
 
    VPI_CSS_422,
 
    VPI_CSS_422R,
 
    VPI_CSS_411,
 
    VPI_CSS_411R,
 
    VPI_CSS_420,
} VPIChromaSubsampling;
 
VPI_PUBLIC VPIChromaSubsampling vpiMakeChromaSubsampling(int samplesHoriz, int samplesVert);
 
VPI_PUBLIC int vpiChromaSubsamplingGetSamplesHoriz(VPIChromaSubsampling css);
 
VPI_PUBLIC int vpiChromaSubsamplingGetSamplesVert(VPIChromaSubsampling css);
 
VPI_PUBLIC VPIChromaLocation vpiColorSpecGetChromaLocHoriz(VPIColorSpec cspec);
 
VPI_PUBLIC VPIChromaLocation vpiColorSpecGetChromaLocVert(VPIColorSpec cspec);
 
VPI_PUBLIC VPIColorSpec vpiColorSpecSetChromaLoc(VPIColorSpec cspec, VPIChromaLocation locHoriz,
                                                 VPIChromaLocation locVert);
 
VPI_PUBLIC VPIColorSpace vpiColorSpecGetSpace(VPIColorSpec cspec);
 
VPI_PUBLIC VPIColorSpec vpiColorSpecSetSpace(VPIColorSpec cspec, VPIColorSpace cspace);
 
VPI_PUBLIC VPIYCbCrEncoding vpiColorSpecGetYCbCrEncoding(VPIColorSpec cspec);
 
VPI_PUBLIC VPIColorSpec vpiColorSpecSetYCbCrEncoding(VPIColorSpec cspec, VPIYCbCrEncoding encoding);
 
VPI_PUBLIC VPIColorTransferFunction vpiColorSpecGetTransferFunction(VPIColorSpec cspec);
 
VPI_PUBLIC VPIColorSpec vpiColorSpecSetTransferFunction(VPIColorSpec cspec, VPIColorTransferFunction xferFunc);
 
VPI_PUBLIC VPIColorRange vpiColorSpecGetRange(VPIColorSpec cspec);
 
VPI_PUBLIC VPIColorSpec vpiColorSpecSetRange(VPIColorSpec cspec, VPIColorRange range);
 
VPI_PUBLIC const char *vpiColorSpecGetName(VPIColorSpec cspec);
 
#ifdef __cplusplus
}
#endif
 
#endif /* NV_VPI_COLORSPEC_H */