nvmedia_ide.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: Copyright (c) 2021-2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
 * SPDX-License-Identifier: LicenseRef-NvidiaProprietary
 *
 * NVIDIA CORPORATION, its affiliates and licensors retain all intellectual
 * property and proprietary rights in and to this material, related
 * documentation and any modifications thereto. Any use, reproduction,
 * disclosure or distribution of this material and related documentation
 * without an express license agreement from NVIDIA CORPORATION or
 * its affiliates is strictly prohibited.
 */
 
#ifndef NVMEDIA_IDE_H
#define NVMEDIA_IDE_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
#include "nvmedia_common_video.h"
#include "nvmedia_common_decode.h"
#include "nvmedia_core.h"
#include "nvscibuf.h"
#include "nvscisync.h"
 
#define NVMEDIA_IDE_VERSION_MAJOR   1
 
#define NVMEDIA_IDE_VERSION_MINOR   1
 
#define NVMEDIA_IDE_VERSION_PATCH   0
 
#define NVMEDIA_IDE_MAX_PRENVSCISYNCFENCES  (16U)
 
typedef struct NvMediaIDE NvMediaIDE;
 
#define NVMEDIA_IDE_10BIT_DECODE (1U<<0)
 
#define NVMEDIA_IDE_PIXEL_REC_2020 (1U<<1)
 
#define NVMEDIA_IDE_OUTPUT_16BIT_SURFACES (1U<<2)
 
#define NVMEDIA_IDE_ENABLE_AES  (1U<<3)
 
#define NVMEDIA_IDE_NV24_OUTPUT (1U<<4)
 
#define NVMEDIA_IDE_PROFILING   (1U<<5)
 
#define NVMEDIA_IDE_DUMP_MV     (1U<<6)
 
#define NVMEDIA_IDE_INTERLACED_VIDEO     (1U<<7)
 
#define NVMEDIA_IDE_CHROMA_FMT_MASK     (0x3U<<8)
 
NvMediaStatus
NvMediaIDEGetVersion(
    NvMediaVersion *version
);
 
NvMediaIDE *
NvMediaIDECreate(
    NvMediaVideoCodec codec,
    uint16_t width,
    uint16_t height,
    uint16_t maxReferences,
    uint64_t maxBitstreamSize,
    uint8_t inputBuffering,
    uint32_t flags,
    NvMediaDecoderInstanceId instanceId
);
 
NvMediaIDE *
NvMediaIDECreateCtx(
    void
);
 
NvMediaStatus
NvMediaIDEInit(
    NvMediaIDE *decoder,
    NvMediaVideoCodec codec,
    uint16_t width,
    uint16_t height,
    uint16_t maxReferences,
    uint64_t maxBitstreamSize,
    uint8_t inputBuffering,
    uint32_t flags,
    NvMediaDecoderInstanceId instanceId
);
 
NvMediaStatus
NvMediaIDEDestroy(
   const NvMediaIDE *decoder
);
 
NvMediaStatus
NvMediaIDERegisterNvSciBufObj (
    NvMediaIDE         *decoder,
    NvSciBufObj        bufObj
);
 
NvMediaStatus
NvMediaIDEUnregisterNvSciBufObj (
    const NvMediaIDE *decoder,
    NvSciBufObj       bufObj
);
 
NvMediaStatus
NvMediaIDEDecoderRender(
    const NvMediaIDE *decoder,
    NvSciBufObj target,
    const NvMediaPictureInfo *pictureInfo,
    const void *encryptParams,
    uint32_t numBitstreamBuffers,
    const NvMediaBitstreamBuffer *bitstreams,
    NvMediaIDEFrameStats *FrameStatsDump,
    NvMediaDecoderInstanceId instanceId
);
 
NvMediaStatus
NvMediaIDESliceDecode (
    const NvMediaIDE *decoder,
    const NvSciBufObj target,
    const NvMediaSliceDecodeData *sliceDecData
);
 
NvMediaStatus
NvMediaIDEGetFrameDecodeStatus(
    const NvMediaIDE *decoder,
    uint32_t ringEntryIdx,
    NvMediaIDEFrameStatus *FrameStatus
);
 
NvMediaStatus
NvMediaIDEFillNvSciBufAttrList(
    NvMediaDecoderInstanceId  instanceId,
    NvSciBufAttrList          attrlist
);
 
NvMediaStatus
NvMediaIDEFillNvSciSyncAttrList(
    const NvMediaIDE           *decoder,
    NvSciSyncAttrList          attrlist,
    NvMediaNvSciSyncClientType clienttype
);
 
NvMediaStatus
NvMediaIDEGetBackwardUpdates(
    const NvMediaIDE *decoder,
    void *backupdates
);
 
NvMediaStatus
NvMediaIDERegisterNvSciSyncObj(
    const NvMediaIDE           *decoder,
    NvMediaNvSciSyncObjType    syncobjtype,
    NvSciSyncObj               nvscisync
);
 
NvMediaStatus
NvMediaIDEUnregisterNvSciSyncObj(
    const NvMediaIDE  *decoder,
    NvSciSyncObj      nvscisync
);
 
NvMediaStatus
NvMediaIDESetNvSciSyncObjforEOF(
    const NvMediaIDE      *decoder,
    NvSciSyncObj          nvscisyncEOF
);
 
NvMediaStatus
NvMediaIDEInsertPreNvSciSyncFence(
    const NvMediaIDE         *decoder,
    const NvSciSyncFence     *prenvscisyncfence
);
 
NvMediaStatus
NvMediaIDEGetEOFNvSciSyncFence(
    const NvMediaIDE        *decoder,
    NvSciSyncObj      eofnvscisyncobj,
    NvSciSyncFence    *eofnvscisyncfence
);
 
NvMediaStatus
NvMediaIDEQueryHWDevices(
    NvMediaDeviceList *deviceList
);
/*
 * @defgroup 6x_history_nvmedia_ide History
 * Provides change history for the NvMediaIDE API.
 *
 * \section 6x_history_nvmedia_ide Version History
 *
 * <b> Version 1.0.0 </b> September 28, 2021
 * - Initial release
 *
 * <b> Version 1.1.0 </b> May 02, 2024
 *  - Added interface dor device list query
 */
#ifdef __cplusplus
}     /* extern "C" */
#endif
 
#endif /* NVMEDIA_IDE_H */