NvsCommonDef.h

Go to the documentation of this file.

//================================================================================
//
// (c) Copyright Meishe Co. Ltd, 2016. All rights reserved.
//
// This code and information is provided "as is" without warranty of any kind,
// either expressed or implied, including but not limited to the implied
// warranties of merchantability and/or fitness for a particular purpose.
//
//--------------------------------------------------------------------------------
//   Birth Date:    Dec 29. 2016
//   Author:        Meishe video team
//================================================================================
 
#pragma once
 
#include <stdint.h>
 
#define NVS_EXPORT  __attribute__((visibility("default")))
 
typedef enum {
    NvsAudSmpFmt_None = -1,
    NvsAudSmpFmt_U8,       
    NvsAudSmpFmt_S16,      
    NvsAudSmpFmt_S32,      
    NvsAudSmpFmt_FLT,      
    NvsAudSmpFmt_DBL,      
 
    NvsAudSmpFmt_U8P,      
    NvsAudSmpFmt_S16P,     
    NvsAudSmpFmt_S32P,     
    NvsAudSmpFmt_FLTP,     
    NvsAudSmpFmt_DBLP,     
 
    NvsAudSmpFmt_Count
} NvsAudioSampleFormat;
 
typedef enum {
    NvsAVFileType_Unknown = -1,      
    NvsAVFileType_AudioVideo = 0,    
    NvsAVFileType_Audio,             
    NvsAVFileType_Image              
} NvsAVFileType;
 
typedef enum
{
    NvsVideoRotation_0 = 0,
    NvsVideoRotation_90,
    NvsVideoRotation_180,
    NvsVideoRotation_270
} NvsVideoRotation;
 
typedef enum
{
    NvsVideoCodecType_Unknown = 0,
    NvsVideoCodecType_H264,
    NvsVideoCodecType_H265,
    NvsVideoCodecType_MPEG4,
    NvsVideoCodecType_VP8,
    NvsVideoCodecType_VP9,
    NvsVideoCodecType_WMV,
    NvsVideoCodecType_MPEG1,
    NvsVideoCodecType_MPEG2,
    NvsVideoCodecType_MJPEG,
    NvsVideoCodecType_AV1,
    NvsVideoCodecType_ProRes
 
} NvsVideoCodecType;
 
typedef enum
{
    NvsVideoColorTransfer_SDR_VIDEO = 0,  //SMPTE 170M transfer characteristic curve used by BT.601/BT.709/BT.2020. This is the curve used by most non-HDR video content.
    NvsVideoColorTransfer_ST2084, //SMPTE ST 2084 transfer function. This is used by some HDR video content
    NvsVideoColorTransfer_HLG //ARIB STD-B67 hybrid-log-gamma transfer function. This is used by some HDR video content.
} NvsVideoColorTransfer;
 
typedef enum
{
    NvsVideoHDRType_None = 0,  //This is used by SDR video content.
    NvsVideoHDRType_HDR10, //SMPTE ST 2084 transfer function. This is used by some HDR video content
    NvsVideoHDRType_HLG, //ARIB STD-B67 hybrid-log-gamma transfer function. This is used by some HDR video content.
    NvsVideoHDRType_HDR10Plus, //This is used by HDR10+ video content, has dynamic meta data.
    NvsVideoHDRType_DolbyVision, //This is used by dolby vision hdr video content, has dynamic meta data.
    NvsVideoHDRType_Vivid //This is used by vivid hdr video content, has dynamic meta data.
} NvsVideoHDRType;
 
typedef enum NvsRoleInTheme
{
    NvsRoleInThemeGeneral,   
    NvsRoleInThemeTitle,     
    NvsRoleInThemeTrailer    
} NvsRoleInTheme;
 
typedef enum NvsTextAlignment
{
    NvsTextAlignmentLeft = 0,
    NvsTextAlignmentCenter,
    NvsTextAlignmentRight,
    NvsTextAlignmentTop,
    NvsTextAlignmentBottom,
    NvsTextAlignmentVCenter
} NvsTextAlignment;
 
typedef enum NvsLetterSpacingType
{
    NvsLetterSpacingTypePercentage = 0,
    NvsLetterSpacingTypeAbsolute
} NvsLetterSpacingType;
 
typedef enum NvsAssetDefaultParam
{
    USE_ASSET_DEFAULT_PARAM = 0,
    NOT_USE_ASSET_DEFAULT_PARAM
} NvsAssetDefaultParam;
 
typedef enum NvsCategory
{
    NvsDefaultCategory,   
    NvsUserCategory,      
    NvsThemeCategory      
} NvsCategory;
 
typedef enum NvsVideoFramePixelFormat
{
    NvsPixelFormat_Nv12,  
    NvsPixelFormat_YUV420, 
    NvsPixelFormat_BGRA, 
    NvsPixelFormat_RGBA, 
    NvsPixelFormat_P010  
} NvsVideoFramePixelFormat;
 
typedef enum NvsGpuVideoFrameFormat
{
    NvsGpuVideoFrameFormat_RGBA8,
    NvsGpuVideoFrameFormat_RGBA16F, 
 } NvsGpuVideoFrameFormat;
 
typedef enum NvsVideoFrameYUVColorMatrix
{
    NvsVideoFrameYUVColorMatrix_Bt601, 
    NvsVideoFrameYUVColorMatrix_Bt709, 
    NvsVideoFrameYUVColorMatrix_Bt2020 
} NvsVideoFrameYUVColorMatrix;
 
 
typedef enum NvsVideoFrameColorTransfer
{
    NvsVideoFrameColorTransfer_sRGB,
    NvsVideoFrameColorTransfer_SMPTE2084, 
    NvsVideoFrameColorTransfer_ARIB_STD_B67, 
    NvsVideoFrameColorTransfer_sRGB_HDR     
} NvsVideoFrameColorTransfer;
 
 
typedef enum NvsVideoFrameColorPrimaries
{
    NvsVideoFrameColorPrimaries_Bt709, 
    NvsVideoFrameColorPrimaries_Bt2020, 
    NvsVideoFrameColorPrimaries_DisplayP3 
} NvsVideoFrameColorPrimaries;
 
 
typedef enum NvsVideoResolutionBitDepth
{
    NvsVideoResolutionBitDepth_8Bit,            
    NvsVideoResolutionBitDepth_16Bit_Float,     
    NvsVideoResolutionBitDepth_Auto             
} NvsVideoResolutionBitDepth;
 
 
typedef enum {
    NvsLiveWindowFillModePreserveAspectCrop = 0,
 
    NvsLiveWindowFillModePreserveAspectFit,
 
    NvsLiveWindowFillModeStretch
} NvsLiveWindowFillMode;
 
 
typedef enum {
    NvsLiveWindowHDRDisplayMode_SDR = 0,                 
    NvsLiveWindowHDRDisplayMode_Device ,                
    NvsLiveWindowHDRDisplayMode_TONE_MAP_SDR ,          
} NvsLiveWindowHDRDisplayMode;
 
typedef struct {
    int num;    
    int den;    
} NvsRational;
 
typedef struct {
    int width;    
    int height;   
} NvsSize;
 
typedef struct {
    float left;   
    float right;  
    float bottom; 
    float top;    
} NvsRect;
 
typedef struct {
    unsigned int sampleRate;            
    NvsAudioSampleFormat sampleFormat;  
    unsigned int channelCount;          
} NvsAudioResolution;
 
typedef struct {
    unsigned int imageWidth;  
    unsigned int imageHeight; 
    NvsRational imagePAR;     
    NvsVideoResolutionBitDepth bitDepth;   
    NvsVideoFrameColorTransfer colorTransfer; 
    NvsVideoFrameColorPrimaries colorPrimaries; 
} NvsVideoResolution;
 
static inline NvsVideoResolution NvsMakeDefaultVideoResolution()
{
    NvsVideoResolution res;
    res.imageWidth = 0;
    res.imageHeight = 0;
    res.imagePAR.num = 1;
    res.imagePAR.den = 1;
    res.bitDepth = NvsVideoResolutionBitDepth_8Bit;
    res.colorTransfer = NvsVideoFrameColorTransfer_sRGB;
    res.colorPrimaries = NvsVideoFrameColorPrimaries_Bt709;
    return res;
}
 
typedef struct {
    float r, g, b, a;
} NvsColor;
 
typedef struct {
    float x, y;
} NvsPosition2D;
 
typedef struct {
    float x, y, z;
} NvsPosition3D;
 
typedef struct {
    double x;
    double y;
} NvsPointD;
 
#define NVS_VIDEO_FRAME_MAX_PLANES     4
 
typedef struct{
    int frameWidth;                                 
    int frameHeight;                                
    int planeRowPitch[NVS_VIDEO_FRAME_MAX_PLANES];  
    void* planePtr[NVS_VIDEO_FRAME_MAX_PLANES];
    NvsVideoFramePixelFormat pixelFormat;           
    int64_t frameTimestamp;                         
    bool isRec601;                                  
    bool isFullRangeYUV;                            
 
    int displayRotation;                            
    bool flipHorizontally;                          
} NvsVideoFrameInfo;
 
typedef struct{
    NvsVideoFrameInfo frameInfo;
    NvsVideoFrameYUVColorMatrix colorMatrix;
    NvsVideoFrameColorTransfer colorTransfer;
    NvsVideoFrameColorPrimaries colorPrimaries;
} NvsVideoFrameInfoExt;
 
#ifndef NV_AUDIO_MAX_CHANNEL_COUNT
    #define NV_AUDIO_MAX_CHANNEL_COUNT 8
#endif
 
typedef struct{
    void *data[NV_AUDIO_MAX_CHANNEL_COUNT];
    int planeSizeInBytes;   // For planar audio: size in bytes of each plane(channel)
                            // For packed audio: size in bytes of total samples
    int sampleRate;                     
    int channelCount;                   
    NvsAudioSampleFormat sampleFormat;  
    int actualSampleCount;              
    int64_t timeStamp;                  
} NvsAudioSampleBuffers;
 
typedef struct{
    int sampleRate;              
} NvsCapturedAudioSampleInfo;