nvmedia_surface.h

Go to the documentation of this file.

/*
 * Copyright (c) 2017-2018, NVIDIA CORPORATION.  All rights reserved.  All
 * information contained herein is proprietary and confidential to NVIDIA
 * Corporation.  Any use, reproduction, or disclosure without the written
 * permission of NVIDIA Corporation is prohibited.
 */

#ifndef _NVMEDIA_SURFACE_H
#define _NVMEDIA_SURFACE_H

#ifdef __cplusplus
extern "C" {
#endif

#include "nvmedia_core.h"

#define NVMEDIA_SURFACE_VERSION_MAJOR   1

#define NVMEDIA_SURFACE_VERSION_MINOR   9


typedef enum {
    NVM_SURF_ATTR_SURF_TYPE = 0,
    NVM_SURF_ATTR_LAYOUT,
    NVM_SURF_ATTR_DATA_TYPE,
    NVM_SURF_ATTR_MEMORY,
    NVM_SURF_ATTR_SUB_SAMPLING_TYPE,
    NVM_SURF_ATTR_BITS_PER_COMPONENT,
    NVM_SURF_ATTR_COMPONENT_ORDER,
    NVM_SURF_FMT_ATTR_MAX,
} NvMediaSurfFormatAttrType;

#define NVM_SURF_ATTR_SURF_TYPE_YUV                       0x00000001

#define NVM_SURF_ATTR_SURF_TYPE_RGBA                      0x00000002

#define NVM_SURF_ATTR_SURF_TYPE_RAW                       0x00000003

#define NVM_SURF_ATTR_LAYOUT_BL                           0x00000001

#define NVM_SURF_ATTR_LAYOUT_PL                           0x00000002

#define NVM_SURF_ATTR_DATA_TYPE_UINT                      0x00000001

#define NVM_SURF_ATTR_DATA_TYPE_INT                       0x00000002

#define NVM_SURF_ATTR_DATA_TYPE_FLOAT                     0x00000003

#define NVM_SURF_ATTR_DATA_TYPE_FLOATISP                  0x00000004

#define NVM_SURF_ATTR_MEMORY_PLANAR                       0x00000001

#define NVM_SURF_ATTR_MEMORY_SEMI_PLANAR                  0x00000002

#define NVM_SURF_ATTR_MEMORY_PACKED                       0x00000003

#define NVM_SURF_ATTR_SUB_SAMPLING_TYPE_420               0x00000001

#define NVM_SURF_ATTR_SUB_SAMPLING_TYPE_422               0x00000002

#define NVM_SURF_ATTR_SUB_SAMPLING_TYPE_444               0x00000003

#define NVM_SURF_ATTR_SUB_SAMPLING_TYPE_422R              0x00000004

#define NVM_SURF_ATTR_SUB_SAMPLING_TYPE_NONE              0x00000000

#define NVM_SURF_ATTR_BITS_PER_COMPONENT_8                 0x00000001

#define NVM_SURF_ATTR_BITS_PER_COMPONENT_10                0x00000002

#define NVM_SURF_ATTR_BITS_PER_COMPONENT_12                0x00000003

#define NVM_SURF_ATTR_BITS_PER_COMPONENT_14                0x00000004

#define NVM_SURF_ATTR_BITS_PER_COMPONENT_16                0x00000005

#define NVM_SURF_ATTR_BITS_PER_COMPONENT_32                0x00000006

#define NVM_SURF_ATTR_BITS_PER_COMPONENT_LAYOUT_16_8_8     0x00000007

#define NVM_SURF_ATTR_BITS_PER_COMPONENT_LAYOUT_10_8_8     0x00000008

#define NVM_SURF_ATTR_BITS_PER_COMPONENT_LAYOUT_2_10_10_10 0x00000009

#define NVM_SURF_ATTR_BITS_PER_COMPONENT_20                0x0000000A

#define NVM_SURF_ATTR_COMPONENT_ORDER_LUMA                0x00000001

#define NVM_SURF_ATTR_COMPONENT_ORDER_YUV                 0x00000002

#define NVM_SURF_ATTR_COMPONENT_ORDER_YVU                 0x00000003

#define NVM_SURF_ATTR_COMPONENT_ORDER_YUYV                0x00000004

#define NVM_SURF_ATTR_COMPONENT_ORDER_YVYU                0x00000005

#define NVM_SURF_ATTR_COMPONENT_ORDER_VYUY                0x00000006

#define NVM_SURF_ATTR_COMPONENT_ORDER_UYVY                0x00000007

#define NVM_SURF_ATTR_COMPONENT_ORDER_XUYV                0x00000008

#define NVM_SURF_ATTR_COMPONENT_ORDER_XYUV                0x00000009

#define NVM_SURF_ATTR_COMPONENT_ORDER_VUYX                0x0000000A

#define NVM_SURF_ATTR_COMPONENT_ORDER_ALPHA               0x00000011

#define NVM_SURF_ATTR_COMPONENT_ORDER_RGBA                0x00000012

#define NVM_SURF_ATTR_COMPONENT_ORDER_ARGB                0x00000013

#define NVM_SURF_ATTR_COMPONENT_ORDER_BGRA                0x00000014

#define NVM_SURF_ATTR_COMPONENT_ORDER_RG                  0x00000015

#define NVM_SURF_ATTR_COMPONENT_ORDER_RGGB                0x00000021

#define NVM_SURF_ATTR_COMPONENT_ORDER_BGGR                0x00000022

#define NVM_SURF_ATTR_COMPONENT_ORDER_GRBG                0x00000023

#define NVM_SURF_ATTR_COMPONENT_ORDER_GBRG                0x00000024

#define NVM_SURF_ATTR_COMPONENT_ORDER_RCCB                0x00000025

#define NVM_SURF_ATTR_COMPONENT_ORDER_BCCR                0x00000026

#define NVM_SURF_ATTR_COMPONENT_ORDER_CRBC                0x00000027

#define NVM_SURF_ATTR_COMPONENT_ORDER_CBRC                0x00000028

#define NVM_SURF_ATTR_COMPONENT_ORDER_RCCC                0x00000029

#define NVM_SURF_ATTR_COMPONENT_ORDER_CCCR                0x0000002A

#define NVM_SURF_ATTR_COMPONENT_ORDER_CRCC                0x0000002B

#define NVM_SURF_ATTR_COMPONENT_ORDER_CCRC                0x0000002C

#define NVM_SURF_ATTR_COMPONENT_ORDER_CCCC                0x0000002D

typedef struct {
    NvMediaSurfFormatAttrType type;
    unsigned int value;
} NvMediaSurfFormatAttr;

#define NVM_SURF_FMT_DEFINE_ATTR(x)                                                   \
    NvMediaSurfFormatAttr x[] = {                                                     \
        {                                                                             \
            .type = NVM_SURF_ATTR_SURF_TYPE,                                          \
            .value = 0,                                                               \
        },                                                                            \
        {                                                                             \
            .type = NVM_SURF_ATTR_LAYOUT,                                             \
            .value = 0,                                                               \
        },                                                                            \
        {                                                                             \
            .type = NVM_SURF_ATTR_DATA_TYPE,                                          \
            .value = 0,                                                               \
        },                                                                            \
        {                                                                             \
            .type = NVM_SURF_ATTR_MEMORY,                                             \
            .value = 0,                                                               \
        },                                                                            \
        {                                                                             \
            .type = NVM_SURF_ATTR_SUB_SAMPLING_TYPE,                                  \
            .value = 0,                                                               \
        },                                                                            \
        {                                                                             \
            .type = NVM_SURF_ATTR_BITS_PER_COMPONENT,                                 \
            .value = 0,                                                               \
        },                                                                            \
        {                                                                             \
            .type = NVM_SURF_ATTR_COMPONENT_ORDER,                                    \
            .value = 0,                                                               \
        },                                                                            \
    };                                                                                \


#define NVM_SURF_FMT_SET_ATTR_YUV(attr, order, samplingtype, memory, datatype, bpc, layout)       \
{                                                                                                 \
    attr[0].type = NVM_SURF_ATTR_SURF_TYPE;                                                       \
    attr[0].value = NVM_SURF_ATTR_SURF_TYPE_YUV;                                                  \
                                                                                                  \
    attr[1].type = NVM_SURF_ATTR_LAYOUT;                                                          \
    attr[1].value = NVM_SURF_ATTR_LAYOUT_##layout;                                                \
                                                                                                  \
    attr[2].type = NVM_SURF_ATTR_DATA_TYPE;                                                       \
    attr[2].value = NVM_SURF_ATTR_DATA_TYPE_##datatype;                                           \
                                                                                                  \
    attr[3].type = NVM_SURF_ATTR_MEMORY;                                                          \
    attr[3].value = NVM_SURF_ATTR_MEMORY_##memory;                                                \
                                                                                                  \
    attr[4].type = NVM_SURF_ATTR_SUB_SAMPLING_TYPE;                                               \
    attr[4].value = NVM_SURF_ATTR_SUB_SAMPLING_TYPE_##samplingtype;                               \
                                                                                                  \
    attr[5].type = NVM_SURF_ATTR_BITS_PER_COMPONENT;                                              \
    attr[5].value = NVM_SURF_ATTR_BITS_PER_COMPONENT_##bpc;                                       \
                                                                                                  \
    attr[6].type = NVM_SURF_ATTR_COMPONENT_ORDER;                                                 \
    attr[6].value = NVM_SURF_ATTR_COMPONENT_ORDER_##order;                                        \
}

#define NVM_SURF_FMT_SET_ATTR_RGBA(attr, order, datatype, bpc, layout)                            \
{                                                                                                 \
    attr[0].type = NVM_SURF_ATTR_SURF_TYPE;                                                       \
    attr[0].value = NVM_SURF_ATTR_SURF_TYPE_RGBA;                                                 \
                                                                                                  \
    attr[1].type = NVM_SURF_ATTR_LAYOUT;                                                          \
    attr[1].value = NVM_SURF_ATTR_LAYOUT_##layout;                                                \
                                                                                                  \
    attr[2].type = NVM_SURF_ATTR_DATA_TYPE;                                                       \
    attr[2].value = NVM_SURF_ATTR_DATA_TYPE_##datatype;                                           \
                                                                                                  \
    attr[3].type = NVM_SURF_ATTR_MEMORY;                                                          \
    attr[3].value = NVM_SURF_ATTR_MEMORY_PACKED;                                                  \
                                                                                                  \
    attr[4].type = NVM_SURF_ATTR_SUB_SAMPLING_TYPE;                                               \
    attr[4].value = 0;                                                                            \
                                                                                                  \
    attr[5].type = NVM_SURF_ATTR_BITS_PER_COMPONENT;                                              \
    attr[5].value = NVM_SURF_ATTR_BITS_PER_COMPONENT_##bpc;                                       \
                                                                                                  \
    attr[6].type = NVM_SURF_ATTR_COMPONENT_ORDER;                                                 \
    attr[6].value = NVM_SURF_ATTR_COMPONENT_ORDER_##order;                                        \
}

#define NVM_SURF_FMT_SET_ATTR_RAW(attr, order, datatype, bpc, layout)                             \
{                                                                                                 \
    attr[0].type = NVM_SURF_ATTR_SURF_TYPE;                                                       \
    attr[0].value = NVM_SURF_ATTR_SURF_TYPE_RAW;                                                  \
                                                                                                  \
    attr[1].type = NVM_SURF_ATTR_LAYOUT;                                                          \
    attr[1].value = NVM_SURF_ATTR_LAYOUT_##layout;                                                \
                                                                                                  \
    attr[2].type = NVM_SURF_ATTR_DATA_TYPE;                                                       \
    attr[2].value = NVM_SURF_ATTR_DATA_TYPE_##datatype;                                           \
                                                                                                  \
    attr[3].type = NVM_SURF_ATTR_MEMORY;                                                          \
    attr[3].value = NVM_SURF_ATTR_MEMORY_PACKED;                                                  \
                                                                                                  \
    attr[4].type = NVM_SURF_ATTR_SUB_SAMPLING_TYPE;                                               \
    attr[4].value = 0;                                                                            \
                                                                                                  \
    attr[5].type = NVM_SURF_ATTR_BITS_PER_COMPONENT;                                              \
    attr[5].value = NVM_SURF_ATTR_BITS_PER_COMPONENT_##bpc;                                       \
                                                                                                  \
    attr[6].type = NVM_SURF_ATTR_COMPONENT_ORDER;                                                 \
    attr[6].value = NVM_SURF_ATTR_COMPONENT_ORDER_##order;                                        \
}

typedef enum {
    NVM_SURF_ATTR_WIDTH,
    NVM_SURF_ATTR_HEIGHT,
    NVM_SURF_ATTR_EMB_LINES_TOP,
    NVM_SURF_ATTR_EMB_LINES_BOTTOM,
    NVM_SURF_ATTR_CPU_ACCESS,
    NVM_SURF_ATTR_ALLOC_TYPE,
    NVM_SURF_ATTR_PEER_VM_ID,
    NVM_SURF_ATTR_SCAN_TYPE,
    NVM_SURF_ATTR_COLOR_STD_TYPE,
    NVM_SURF_ALLOC_ATTR_MAX,
} NvMediaSurfAllocAttrType;

#define NVM_SURF_ATTR_CPU_ACCESS_UNCACHED                 0x00000001

#define NVM_SURF_ATTR_CPU_ACCESS_CACHED                   0x00000002

#define NVM_SURF_ATTR_CPU_ACCESS_UNMAPPED                 0x00000003

#define NVM_SURF_ATTR_ALLOC_ISOCHRONOUS                   0x00000001

#define NVM_SURF_ATTR_ALLOC_SECURED                       0x00000002

#define NVM_SURF_ATTR_SCAN_PROGRESSIVE                    0x00000001

#define NVM_SURF_ATTR_SCAN_INTERLACED                     0x00000002

#define NVM_SURF_ATTR_COLOR_STD_SRGB                      0x00000001

#define NVM_SURF_ATTR_COLOR_STD_REC601_SR                 0x00000002

#define NVM_SURF_ATTR_COLOR_STD_REC601_ER                 0x00000003

#define NVM_SURF_ATTR_COLOR_STD_REC709_SR                 0x00000004

#define NVM_SURF_ATTR_COLOR_STD_REC709_ER                 0x00000005

#define NVM_SURF_ATTR_COLOR_STD_REC2020_RGB               0x00000006

#define NVM_SURF_ATTR_COLOR_STD_REC2020_SR                0x00000007

#define NVM_SURF_ATTR_COLOR_STD_REC2020_ER                0x00000008

#define NVM_SURF_ATTR_COLOR_STD_YcCbcCrc_SR               0x00000009

#define NVM_SURF_ATTR_COLOR_STD_YcCbcCrc_ER               0x0000000A

#define NVM_SURF_ATTR_COLOR_STD_SENSOR_RGBA               0x0000000B

#define NVM_SURF_ATTR_COLOR_STD_REC2020PQ_ER              0x0000000C

typedef struct {
    NvMediaSurfAllocAttrType type;
    unsigned int value;
} NvMediaSurfAllocAttr;

#define NvMediaSurfaceType    uint32_t

#define NvMediaSurfaceType_Video_420                                  1000
#define NvMediaSurfaceType_Video_420_10bit                            1001
#define NvMediaSurfaceType_Video_420_12bit                            1002

#define NvMediaSurfaceType_Video_422                                  1003
#define NvMediaSurfaceType_Video_422_10bit                            1004
#define NvMediaSurfaceType_Video_422_12bit                            1005

#define NvMediaSurfaceType_Video_444                                  1006
#define NvMediaSurfaceType_Video_444_10bit                            1007
#define NvMediaSurfaceType_Video_444_12bit                            1008

#define NvMediaSurfaceType_VideoCapture_422                           1009

#define NvMediaSurfaceType_VideoCapture_YUYV_422                      1010

#define NvMediaSurfaceType_R8G8B8A8                                   1011

#define NvMediaSurfaceType_R8G8B8A8_BottomOrigin                      1012

#define NvMediaSurfaceType_Image_Monochrome                           1013

#define NvMediaSurfaceType_Image_YUV_420                              1014

#define NvMediaSurfaceType_Image_YUV_422                              1015

#define NvMediaSurfaceType_Image_YUV_444                              1016

#define NvMediaSurfaceType_Image_YUYV_422                             1017

#define NvMediaSurfaceType_Image_RGBA                                 1018

#define NvMediaSurfaceType_Image_RAW                                  1019

#define NvMediaSurfaceType_Image_V16Y16U16X16                         1020

#define NvMediaSurfaceType_Image_Y16                                  1021

#define NvMediaSurfaceType_Image_X2U10Y10V10                          1022

#define NvMediaSurfaceType_Image_Y10U8V8_420                          1023

#define NvMediaSurfaceType_Image_Y10                                  1024

#define NvMediaSurfaceType_A8                                         1025

#define NvMediaSurfaceType_Unsupported                                99999

#define NvMediaSurfaceType_YV12 NvMediaSurfaceType_Video_420

#define NvMediaSurfaceType_YV16 NvMediaSurfaceType_Video_422

#define NvMediaSurfaceType_YV24 NvMediaSurfaceType_Video_444

#define NvMediaSurfaceType_YV16x2 NvMediaSurfaceType_VideoCapture_422

NvMediaSurfaceType
NvMediaSurfaceFormatGetType(
    NvMediaSurfFormatAttr *attrs,
    unsigned int numAttrs
);

NvMediaStatus
NvMediaSurfaceFormatGetAttrs(
    NvMediaSurfaceType type,
    NvMediaSurfFormatAttr *attrs,
    unsigned int numAttrs
);

NvMediaStatus
NvMediaSurfaceGetVersion(
    NvMediaVersion *version
);

/*
 * \defgroup history_nvmedia_surface History
 * Provides change history for the NvMedia Surface API.
 *
 * \section history_nvmedia_surface Version History
 *
 * <b> Version 1.0 </b> March 1, 2017
 * - Initial release
 *
 *
 * <b> Version 1.1 </b> April 24, 2017
 * - Added NVM_SURF_ATTR_COMPONENT_ORDER_XYUV and
 *   NVM_SURF_ATTR_COMPONENT_ORDER_RG component order flags
 *
 * <b> Version 1.2 </b> May 18, 2017
 * - Added NVM_SURF_ATTR_COLOR_STD_TYPE and
 *   NVM_SURF_ATTR_COLOR_STD flags
 *
 * <b> Version 1.3 </b> June 08, 2017
 * - Removed NvMediaSurfaceType_Image_NonColor_S16_XY and
 *   NvMediaSurfaceType_Image_NonColor_S16_X surface types
 *
 * <b> Version 1.4 </b> June 12, 2017
 * - Added NVM_SURF_ATTR_COMPONENT_ORDER_VUYX flag
 *
 * <b> Version 1.5 </b> October 09, 2017
 * - Added NVM_SURF_ATTR_COLOR_STD_SENSOR_RGBA and
 *   NVM_SURF_ATTR_COLOR_STD_REC2020PQ_ER flags
 *
 * <b> Version 1.6 </b> October 31, 2017
 * - Added NVM_SURF_ATTR_DATA_TYPE_FLOATISP type
 *
 * <b> Version 1.7 </b> November 07, 2017
 * - Added NVM_SURF_ATTR_BITS_PER_COMPONENT_20
 *
 * <b> Version 1.8 </b> June 04, 2018
 * - Added NVM_SURF_ATTR_COMPONENT_ORDER_CCCC component order
 *
 * <b> Version 1.9 </b> July 10, 2018
 * - Added NvMediaSurfaceGetVersion API
 *
 */
#ifdef __cplusplus
};     /* extern "C" */
#endif

#endif /* _NVMEDIA_SURFACE_H */