ColorSpec.h

转到此文件的文档。

/*
 * 版权所有 2020-2021 NVIDIA Corporation。保留所有权利。
 *
 * 许可方须知：
 *
 * 此源代码和/或文档（“许可交付物”）受美国和国际版权法项下的 NVIDIA 知识产权保护。
 * 受美国和国际版权法项下的 NVIDIA 知识产权保护。
 * 国际版权法。
 *
 * 此处包含的这些许可交付物是 NVIDIA 的专有和机密信息，并根据 NVIDIA 软件许可协议（一种形式）的条款和条件提供，
 * 机密信息，并根据 NVIDIA 软件许可协议（一种形式）的条款和条件提供，
 * NVIDIA 与被许可方之间（“许可协议”）或被许可方以电子方式接受的协议。尽管许可协议中有任何相反的条款或条件，
 * NVIDIA 与被许可方之间（“许可协议”）或被许可方以电子方式接受的协议。尽管许可协议中有任何相反的条款或条件，
 * 被许可方接受。尽管许可协议中有任何相反的条款或条件，
 * 与许可协议中的条款或条件相反，未经 NVIDIA 明确书面同意，禁止向任何第三方复制或披露许可交付物。
 * 与许可协议中的条款或条件相反，未经 NVIDIA 明确书面同意，禁止向任何第三方复制或披露许可交付物。
 * 书面同意，禁止。
 *
 * 尽管许可协议中有任何相反的条款或条件，NVIDIA 对这些许可交付物用于任何目的的适用性不作任何陈述。
 * 许可协议，NVIDIA 对这些许可交付物用于任何目的的适用性不作任何陈述。
 * 适用性不作任何陈述。
 * 交付物“按原样”提供，不提供任何明示或暗示的保证。
 * NVIDIA 声明不对这些许可交付物承担任何保证责任，包括对适销性、非侵权性和特定用途适用性的所有默示保证。
 * NVIDIA 声明不对这些许可交付物承担任何保证责任，包括对适销性、非侵权性和特定用途适用性的所有默示保证。
 * 非侵权性和特定用途适用性的所有默示保证。
 * 尽管许可协议中有任何相反的条款或条件，在任何情况下，NVIDIA 均不对任何特殊、间接、附带或后果性损害，或任何因使用、数据或利润损失而造成的任何损害承担责任，
 * 尽管许可协议中有任何相反的条款或条件，在任何情况下，NVIDIA 均不对任何特殊、间接、附带或后果性损害，或任何因使用、数据或利润损失而造成的任何损害承担责任，
 * NVIDIA 均不对任何特殊、间接、附带或后果性损害，或任何因使用、数据或利润损失而造成的任何损害承担责任，
 * 或利润损失而造成的任何损害承担责任，
 * 无论是由于合同诉讼、过失或其他侵权行为，因使用或执行这些许可交付物而引起或与之相关的诉讼。
 * 无论是由于合同诉讼、过失或其他侵权行为，因使用或执行这些许可交付物而引起或与之相关的诉讼。
 * 这些许可交付物而引起或与之相关的诉讼。
 *
 * 美国政府最终用户。这些许可交付物是“商业项目”，该术语在 48 C.F.R. 2.101（OCT
 * 美国政府最终用户。这些许可交付物是“商业项目”，该术语在 48 C.F.R. 2.101（OCT
 * 1995) 中定义，包括“商业计算机软件”和“商业计算机软件文档”，这些术语在 48
 * 1995) 中定义，包括“商业计算机软件”和“商业计算机软件文档”，这些术语在 48
 * C.F.R. 12.212 (SEPT 1995) 中使用，并且仅作为商业最终项目提供给美国政府。与 48 C.F.R.12.212 和
 * C.F.R. 12.212 (SEPT 1995) 中使用，并且仅作为商业最终项目提供给美国政府。与 48 C.F.R.12.212 和
 * 48 C.F.R. 227.7202-1 至 227.7202-4 (1995 年 6 月) 一致，所有美国政府最终用户均根据本文规定的权利获得许可交付物。
 * 48 C.F.R. 227.7202-1 至 227.7202-4 (1995 年 6 月) 一致，所有美国政府最终用户均根据本文规定的权利获得许可交付物。
 * 仅根据本文规定的权利获得许可交付物。
 *
 * 在个人和商业软件中使用许可交付物时，必须在用户文档和代码内部注释中包含上述免责声明和美国政府最终用户须知。
 * 软件必须包括，在用户文档和内部
 * 注释到代码中，上述免责声明和美国政府最终
 * 用户须知。
 */

#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 */