nvmedia_imgdec.h

Go to the documentation of this file.

/*
 * Copyright (c) 2016-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_IMGDEC_H
#define NVMEDIA_IMGDEC_H

#ifdef __cplusplus
extern "C" {
#endif

#include "nvmedia_common.h"
#include "nvmedia_core.h"
#include "nvmedia_image.h"

#define NVMEDIA_IMAGEDEC_VERSION_MAJOR   2

#define NVMEDIA_IMAGEDEC_VERSION_MINOR   4

typedef enum {
    NVMEDIA_IMAGE_CODEC_H264 = 0,
    NVMEDIA_IMAGE_CODEC_HEVC = 8,
} NvMediaImageCodec;

typedef struct {
    NvMediaImageCodec codec;
    uint16_t width;
    uint16_t height;
    uint16_t maxReferences;
    NvMediaDecoderInstanceId instanceId;
    struct NvMediaImageDecoderPriv_ *decoderPriv;
} NvMediaImageDecoder;

#define NVMEDIA_IMAGE_DECODER_ATTRIBUTE_PROGRESSIVE_SEQUENCE       (1U<<0)

#define NVMEDIA_IMAGE_DECODER_10BIT_DECODE                         (1U<<1)

#define NVMEDIA_IMAGE_DECODER_PIXEL_REC_2020                       (1U<<2)

NvMediaStatus
NvMediaImageDecoderGetVersion(
    NvMediaVersion *version
);

NvMediaImageDecoder *
NvMediaImageDecoderCreate(
    const NvMediaDevice *device,
    NvMediaImageCodec codec,
    uint16_t width,
    uint16_t height,
    uint16_t maxReferences,
    uint64_t maxBitstreamSize,
    uint8_t inputBuffering,
    uint32_t flags,
    NvMediaDecoderInstanceId instanceId
);

void
NvMediaImageDecoderDestroy(
   const NvMediaImageDecoder *decoder
);

NvMediaStatus
NvMediaImageDecoderRender(
    const NvMediaImageDecoder *decoder,
    NvMediaImage        *target,
    const NvMediaPictureInfo *pictureInfo,
    uint32_t numBitstreamBuffers,
    const NvMediaBitstreamBuffer *bitstreams,
    NvMediaDecoderInstanceId instanceId
);

/*
 * \defgroup history_nvmedia_imgdec History
 * Provides change history for the NvMedia Image Decode API.
 *
 * \section history_nvmedia_imgdec Version History
 *
 * <b> Version 1.0 </b> May 1, 2016
 * - Initial release
 *
 * <b> Version 1.1 </b> May 27, 2016
 * - Added \ref NvMediaImageDecoderCheckVersion API
 *
 * <b> Version 2.0 </b> May 9, 2017
 * - Added instance ID parameter to \ref NvMediaImageDecoderCreate()
 *   and NvMediaImageDecoderRender()
 * - Added NvMediaDevice parameter to NvMediaImageDecoderCreate()
 * - NvMediaImageDecoderCheckVersion is now deprecated.
 *   Use NvMediaImageDecoderGetVersion() instead.
 * - All NvMedia data types are moved to standard data types
 *
 * <b> Version 2.1 </b> Dec 14, 2018
 * - Defined Macro constants as unsigned to fix MISRA issues
 * - Fix MISRA violations 21.1 and 21.2
 *
 * <b> Version 2.2 </b> January 15, 2019
 * - Fix MISRA violations 8.13
 *
 * <b> Version 2.3 </b> Feb 7, 2019
 * - Added opaque handle for decoder
 *   internal usage into Image decoder object
 * - Fix MISRA violations 11.3
 * - Fix MISRA violations 8.13
 *
 * <b> Version 2.4 </b> February 28, 2019
 * - Added required header include nvmedia_core.h
 *
 */
#ifdef __cplusplus
};     /* extern "C" */
#endif

#endif /* NVMEDIA_IMGDEC_H */