PixelType.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_PIXEL_TYPE_H
#define NV_VPI_PIXEL_TYPE_H
 
#include "DataLayout.h"
#include "detail/FormatUtils.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#ifdef __GNUC__
#    pragma GCC diagnostic push
#    pragma GCC diagnostic ignored "-Wpedantic"
#endif
/* clang-format off */
typedef enum
{
    VPI_PIXEL_TYPE_DEFAULT = 0,
    VPI_PIXEL_TYPE_INVALID = VPI_PIXEL_TYPE_DEFAULT,                      
 
    VPI_PIXEL_TYPE_U8   = VPI_DETAIL_MAKE_PIXEL_FMT(PL, UNSIGNED, X8),
    VPI_PIXEL_TYPE_2U8  = VPI_DETAIL_MAKE_PIXEL_FMT(PL, UNSIGNED, X8_Y8),
    VPI_PIXEL_TYPE_3U8  = VPI_DETAIL_MAKE_PIXEL_FMT(PL, UNSIGNED, X8_Y8_Z8),
    VPI_PIXEL_TYPE_4U8  = VPI_DETAIL_MAKE_PIXEL_FMT(PL, UNSIGNED, X8_Y8_Z8_W8),
 
    VPI_PIXEL_TYPE_S8   = VPI_DETAIL_MAKE_PIXEL_FMT(PL, SIGNED, X8),
    VPI_PIXEL_TYPE_2S8  = VPI_DETAIL_MAKE_PIXEL_FMT(PL, SIGNED, X8_Y8),
    VPI_PIXEL_TYPE_3S8  = VPI_DETAIL_MAKE_PIXEL_FMT(PL, SIGNED, X8_Y8_Z8),
    VPI_PIXEL_TYPE_4S8  = VPI_DETAIL_MAKE_PIXEL_FMT(PL, SIGNED, X8_Y8_Z8_W8),
 
    VPI_PIXEL_TYPE_U16  = VPI_DETAIL_MAKE_PIXEL_FMT(PL, UNSIGNED, X16),
    VPI_PIXEL_TYPE_2U16 = VPI_DETAIL_MAKE_PIXEL_FMT(PL, UNSIGNED, X16_Y16),
    VPI_PIXEL_TYPE_3U16 = VPI_DETAIL_MAKE_PIXEL_FMT(PL, UNSIGNED, X16_Y16_Z16),
    VPI_PIXEL_TYPE_4U16 = VPI_DETAIL_MAKE_PIXEL_FMT(PL, UNSIGNED, X16_Y16_Z16_W16),
 
    VPI_PIXEL_TYPE_S16  = VPI_DETAIL_MAKE_PIXEL_FMT(PL, SIGNED, X16),
    VPI_PIXEL_TYPE_2S16 = VPI_DETAIL_MAKE_PIXEL_FMT(PL, SIGNED, X16_Y16),
    VPI_PIXEL_TYPE_3S16 = VPI_DETAIL_MAKE_PIXEL_FMT(PL, SIGNED, X16_Y16_Z16),
    VPI_PIXEL_TYPE_4S16 = VPI_DETAIL_MAKE_PIXEL_FMT(PL, SIGNED, X16_Y16_Z16_W16),
 
    VPI_PIXEL_TYPE_U32  = VPI_DETAIL_MAKE_PIXEL_FMT(PL, UNSIGNED, X32),
    VPI_PIXEL_TYPE_2U32 = VPI_DETAIL_MAKE_PIXEL_FMT(PL, UNSIGNED, X32_Y32),
    VPI_PIXEL_TYPE_3U32 = VPI_DETAIL_MAKE_PIXEL_FMT(PL, UNSIGNED, X32_Y32_Z32),
    VPI_PIXEL_TYPE_4U32 = VPI_DETAIL_MAKE_PIXEL_FMT(PL, UNSIGNED, X32_Y32_Z32_W32),
 
    VPI_PIXEL_TYPE_S32  = VPI_DETAIL_MAKE_PIXEL_FMT(PL, SIGNED, X32),
    VPI_PIXEL_TYPE_2S32 = VPI_DETAIL_MAKE_PIXEL_FMT(PL, SIGNED, X32_Y32),
    VPI_PIXEL_TYPE_3S32 = VPI_DETAIL_MAKE_PIXEL_FMT(PL, SIGNED, X32_Y32_Z32),
    VPI_PIXEL_TYPE_4S32 = VPI_DETAIL_MAKE_PIXEL_FMT(PL, SIGNED, X32_Y32_Z32_W32),
 
    VPI_PIXEL_TYPE_F32  = VPI_DETAIL_MAKE_PIXEL_FMT(PL, FLOAT, X32),
    VPI_PIXEL_TYPE_2F32 = VPI_DETAIL_MAKE_PIXEL_FMT(PL, FLOAT, X32_Y32),
    VPI_PIXEL_TYPE_3F32 = VPI_DETAIL_MAKE_PIXEL_FMT(PL, FLOAT, X32_Y32_Z32),
    VPI_PIXEL_TYPE_4F32 = VPI_DETAIL_MAKE_PIXEL_FMT(PL, FLOAT, X32_Y32_Z32_W32),
 
    VPI_PIXEL_TYPE_U64  = VPI_DETAIL_MAKE_PIXEL_FMT(PL, UNSIGNED, X64),
    VPI_PIXEL_TYPE_2U64 = VPI_DETAIL_MAKE_PIXEL_FMT(PL, UNSIGNED, X64_Y64),
    VPI_PIXEL_TYPE_3U64 = VPI_DETAIL_MAKE_PIXEL_FMT(PL, UNSIGNED, X64_Y64_Z64),
    VPI_PIXEL_TYPE_4U64 = VPI_DETAIL_MAKE_PIXEL_FMT(PL, UNSIGNED, X64_Y64_Z64_W64),
 
    VPI_PIXEL_TYPE_S64  = VPI_DETAIL_MAKE_PIXEL_FMT(PL, SIGNED, X64),
    VPI_PIXEL_TYPE_2S64 = VPI_DETAIL_MAKE_PIXEL_FMT(PL, SIGNED, X64_Y64),
    VPI_PIXEL_TYPE_3S64 = VPI_DETAIL_MAKE_PIXEL_FMT(PL, SIGNED, X64_Y64_Z64),
    VPI_PIXEL_TYPE_4S64 = VPI_DETAIL_MAKE_PIXEL_FMT(PL, SIGNED, X64_Y64_Z64_W64),
 
    VPI_PIXEL_TYPE_F64  = VPI_DETAIL_MAKE_PIXEL_FMT(PL, FLOAT, X64),
    VPI_PIXEL_TYPE_2F64 = VPI_DETAIL_MAKE_PIXEL_FMT(PL, FLOAT, X64_Y64),
    VPI_PIXEL_TYPE_3F64 = VPI_DETAIL_MAKE_PIXEL_FMT(PL, FLOAT, X64_Y64_Z64),
    VPI_PIXEL_TYPE_4F64 = VPI_DETAIL_MAKE_PIXEL_FMT(PL, FLOAT, X64_Y64_Z64_W64),
 
    VPI_PIXEL_TYPE_FORCE64 = INT64_MAX
    /* \endcond */
} VPIPixelType;
/* clang-format on */
#ifdef __GNUC__
#    pragma GCC diagnostic pop
#endif
 
#ifdef VPI_DOXYGEN
#    define VPI_MAKE_PIXEL_TYPE_ABBREV(memLayout, dataType, packing)
#else
#    define VPI_MAKE_PIXEL_TYPE_ABBREV (VPIPixelType) VPI_DETAIL_MAKE_PIXEL_FMT
#endif
 
#ifdef VPI_DOXYGEN
#    define VPI_MAKE_PIXEL_TYPE(memLayout, dataType, packing)
#else
#    define VPI_MAKE_PIXEL_TYPE (VPIPixelType) VPI_DETAIL_MAKE_PIXEL_TYPE
#endif
 
VPI_PUBLIC VPIPixelType vpiMakePixelType(VPIMemLayout memLayout, VPIDataType dataType, VPIPacking packing);
 
VPI_PUBLIC VPIPacking vpiPixelTypeGetPacking(VPIPixelType type);
 
VPI_PUBLIC int vpiPixelTypeGetBitsPerPixel(VPIPixelType type);
 
VPI_PUBLIC void vpiPixelTypeGetBitsPerChannel(VPIPixelType type, int32_t *bits);
 
VPI_PUBLIC VPIDataType vpiPixelTypeGetDataType(VPIPixelType type);
 
VPI_PUBLIC VPIMemLayout vpiPixelTypeGetMemLayout(VPIPixelType type);
 
VPI_PUBLIC int vpiPixelTypeGetChannelCount(VPIPixelType type);
 
VPI_PUBLIC const char *vpiPixelTypeGetName(VPIPixelType type);
 
#ifdef __cplusplus
}
#endif
 
#endif /* NV_VPI_PIXEL_TYPE_H */