nvmedia_viddec.h

Go to the documentation of this file.

/*
 * Copyright (c) 2017-2019, 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_VIDDEC_H
#define NVMEDIA_VIDDEC_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include "nvmedia_common_decode.h"
#include "nvmedia_core.h"
#include "nvmedia_video.h"
 
#define NVMEDIA_VIDEODEC_VERSION_MAJOR   1
 
#define NVMEDIA_VIDEODEC_VERSION_MINOR   12
 
typedef struct{
    uint32_t hwClockValue;
    uint16_t decode_error;
    uint32_t decoded_mbs;
    uint32_t concealed_mbs;        // number of macroblocks concealed
    uint32_t decoding_status;
    uint32_t hwDecodeTime;
} NvMediaVideoDecodeFrameStatus;
 
typedef enum {
    NVMEDIA_MBTYPE_B,
    NVMEDIA_MBTYPE_P_FORWARD,
    NVMEDIA_MBTYPE_P_BACKWARD,
    NVMEDIA_MBTYPE_I
} NvMediaMacroBlockType;
 
typedef enum {
    NVMEDIA_SKIP,
    NVMEDIA_P,
    NVMEDIA_B,
    NVMEDIA_I,
    NVMEDIA_UNKNOWN_TYPE
} NvMedia_MB_Type_enum;
 
typedef enum {
    NVMEDIA_PART_16x16,
    NVMEDIA_PART_16x8,
    NVMEDIA_PART_8x16,
    NVMEDIA_PART_8x8,
    NVMEDIA_UNKNOWN_PART
} NvMedia_MB_Part_enum;
 
typedef struct {
    uint16_t mbNum;
    NvMediaMacroBlockType MBType;
    int16_t mv_for_x;
    int16_t mv_for_y;
    int16_t mv_bac_x;
    int16_t mv_bac_y;
    uint8_t qp;
    NvMedia_MB_Type_enum mb_type;
    NvMedia_MB_Part_enum mb_part;
} NvMediaMotionVectorMB_Metadata;
 
typedef struct{
    uint32_t frameNumDecodeOrder;
    uint32_t mbCount;
    NvMediaBool  bMVDumpPresent;
    NvMediaMotionVectorMB_Metadata *mv;
} NvMediaMotionVectorFrameMetaData;
 
typedef struct{
    uint32_t uRingEntryIdx;
    uint32_t uErrorRefPOC;
    NvMediaMotionVectorFrameMetaData mvfData;
} NvMediaVideoDecodeStats;
 
typedef struct {
    NvMediaVideoCodec codec;
    uint16_t width;
    uint16_t height;
    uint16_t maxReferences;
    NvMediaDecoderInstanceId instanceId;
    struct NvMediaVideoDecoderPriv_ *decoderPriv;
} NvMediaVideoDecoder;
 
 
#define NVMEDIA_VIDEO_DECODER_10BIT_DECODE (1U<<0)
 
#define NVMEDIA_VIDEO_DECODER_PIXEL_REC_2020 (1U<<1)
 
#define NVMEDIA_VIDEO_DECODER_OUTPUT_16BIT_SURFACES (1U<<2)
 
#define NVMEDIA_VIDEO_DECODER_ENABLE_AES  (1U<<3)
 
#define NVMEDIA_VIDEO_DECODER_NV24_OUTPUT (1U<<4)
 
#define NVMEDIA_VIDEO_DECODER_PROFILING   (1U<<5)
 
#define NVMEDIA_VIDEO_DECODER_DUMP_MV     (1U<<6)
 
NvMediaStatus
NvMediaVideoDecoderGetVersion(
    NvMediaVersion *version
);
 
NvMediaVideoDecoder *
NvMediaVideoDecoderCreateEx(
    const NvMediaDevice *device,
    NvMediaVideoCodec codec,
    uint16_t width,
    uint16_t height,
    uint16_t maxReferences,
    uint64_t maxBitstreamSize,
    uint8_t inputBuffering,
    uint32_t flags,
    NvMediaDecoderInstanceId instanceId
);
 
void
NvMediaVideoDecoderDestroy(
   const NvMediaVideoDecoder *decoder
);
 
 
void
NvMediaVideoDecoderUnRegisterPinnedSurfaces(
    const NvMediaVideoDecoder *decoder
);
 
NvMediaStatus
NvMediaVideoDecoderRenderEx(
    const NvMediaVideoDecoder *decoder,
    const NvMediaVideoSurface *target,
    const NvMediaPictureInfo *pictureInfo,
    const void *encryptParams,
    uint32_t numBitstreamBuffers,
    const NvMediaBitstreamBuffer *bitstreams,
    NvMediaVideoDecodeStats *FrameStatsDump,
    NvMediaDecoderInstanceId instanceId
);
 
NvMediaStatus
NvMediaVideoDecoderSliceDecode (
    const NvMediaVideoDecoder *decoder,
    const NvMediaVideoSurface *target,
    const NvMediaSliceDecodeData *sliceDecData
);
 
 
NvMediaStatus
NvMediaVideoDecoderGetFrameDecodeStatus(
    const NvMediaVideoDecoder *decoder,
    uint32_t ringEntryIdx,
    NvMediaVideoDecodeFrameStatus *FrameStatus
);
 
NvMediaStatus
NvMediaVideoDecoderGetBackwardUpdates(
    const NvMediaVideoDecoder *decoder,
    void *backupdates
);
 
/*
 * \defgroup history_nvmedia_viddec History
 * Provides change history for the NvMedia Video Decode API.
 *
 * \section history_nvmedia_viddec Version History
 *
 * <b> Version 1.0 </b> March 21, 2017
 * - Initial release
 *
 * <b> Version 1.1 </b> April 07, 2017
 * - Added hwClockValue in \ref NvMediaVideoDecodeFrameStatus
 * - Rename NvMediaVideoBackwardUpdates to \ref NvMediaVideoDecoderGetBackwardUpdates
 *
 * <b> Version 1.2 </b> April 18, 2017
 * - Deprecated NvMediaVideoDecoderCreate() and NvMediaVideoDecoderRender()
 * - Added \ref NvMediaVideoDecoderGetVersion()
 * - Added device and instance ID parameters to \ref NvMediaVideoDecoderCreateEx()
 * - Added instanceId parameter to \ref NvMediaVideoDecoderRenderEx()
 * - Added instanceId to \ref NvMediaVideoDecoder object
 * - Changed to use standard data types
 *
 * <b> Version 1.3 </b> May 17, 2017
 * - Added deprecated warning message for \ref NvMediaVideoDecoderSetAttributes
 *
 * <b> Version 1.4 </b> June 05, 2017
 * - Removed \ref -NvMediaVideoDecoderCopySliceData interface
 * - Added \ref NvMediaVideoDecoderSliceDecode interface
 * - Added \ref NvMediaSliceDecodeData structure required for
 *   \ref NvMediaVideoDecoderSliceDecode argument.
 *
 * <b> Version 1.5 </b> June 15, 2017
 * - Deprecated \ref NvMediaVideoDecoderSetAttributes()
 *
 * <b> Version 1.6 </b> July 04, 2017
 * - Added \ref NvMedia_MB_Type_enum enumerator
 * - Added \ref NvMedia_MB_Part_enum enumerator
 * - Added qp, mb_type and mb_part to \ref NvMediaMotionVectorMB_Metadata structure
 *
 * <b> Version 1.7 </b> Dec 14, 2018
 * - Defined Macro constants as unsigned to fix MISRA issues
 * - Fix MISRA violations 21.1 and 21.2
 *
 * <b> Version 1.8 </b> January 15, 2019
 * - Fix MISRA violations 8.13
 *
 * <b> Version 1.9 </b> Feb 11, 2019
 * - Added opaque handle for decoder
 *   internal usage into video decoder object
 * - Fix MISRA violations 11.3
 * - Fix MISRA violations 8.13
 *
 * <b> Version 1.10 </b> Feb 28, 2019
 * - Added required header include nvmedia_core.h
 *
 * <b> Version 1.11 </b> July 10, 2019
 * - Header include nvmedia_common.h is replaced with nvmedia_common_decode.h
 *
 * <b> Version 1.12 </b> August 20, 2019
 * - Added New API \ref NvMediaVideoDecoderUnRegisterPinnedSurfaces for
 *   Unpinning of Pinned Surfaces.
 */
 
#ifdef __cplusplus
};     /* extern "C" */
#endif
 
#endif /* NVMEDIA_VIDDEC_H */