nvmedia_iep.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: Copyright (c) 2021-2024 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_IEP_H
#define NVMEDIA_IEP_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
 
#include "nvmedia_core.h"
#include "nvscisync.h"
#include "nvscibuf.h"
#include "nvmedia_common_video.h"
#include "nvmedia_common_encode.h"
 
#define NVMEDIA_IEP_VERSION_MAJOR   1
 
#define NVMEDIA_IEP_VERSION_MINOR   1
 
#define NVMEDIA_IEP_VERSION_PATCH   0
 
#define NVMEDIA_IEP_MAX_PRENVSCISYNCFENCES  (16U)
 
typedef enum {
    NVMEDIA_IMAGE_ENCODE_H264,
    NVMEDIA_IMAGE_ENCODE_HEVC,
    NVMEDIA_IMAGE_ENCODE_VP9,
    NVMEDIA_IMAGE_ENCODE_AV1,
    NVMEDIA_IMAGE_ENCODE_END
} NvMediaIEPType;
 
typedef struct NvMediaIEP NvMediaIEP;
 
// coverity[misra_c_2012_rule_8_7_violation : FALSE]
NvMediaStatus
NvMediaIEPGetVersion(
    NvMediaVersion *version
);
 
// coverity[misra_c_2012_rule_8_7_violation : FALSE]
NvMediaIEP *
NvMediaIEPCreate(
    NvMediaIEPType encodeType,
    const void *initParams,
    NvSciBufAttrList bufAttrList,
    uint8_t maxInOutBuffering,
    NvMediaEncoderInstanceId instanceId
);
 
// coverity[misra_c_2012_rule_8_7_violation : FALSE]
NvMediaIEP *
NvMediaIEPCreateEx (
    NvMediaIEPType encodeType,
    const void *initParams,
    const NvSciBufSurfSampleType subsampleType,
    const NvSciBufSurfBPC bitdepth,
    uint8_t maxInOutBuffering,
    NvMediaEncoderInstanceId instanceId
);
 
#if !NV_IS_SAFETY
 
NvMediaIEP *
NvMediaIEPCreateCtx(
    void
);
 
NvMediaStatus
NvMediaIEPInit(
    const NvMediaIEP *encoder,
    NvMediaIEPType encodeType,
    const void *initParams,
    NvSciBufAttrList bufAttrList,
    uint8_t maxBuffering,
    NvMediaEncoderInstanceId instanceId
);
#endif /* !NV_IS_SAFETY */
 
// coverity[misra_c_2012_rule_8_7_violation : FALSE]
void NvMediaIEPDestroy(NvMediaIEP *encoder);
 
// coverity[misra_c_2012_rule_8_7_violation : FALSE]
NvMediaStatus
NvMediaIEPFeedFrame(
    NvMediaIEP *encoder,
    const NvSciBufObj frame,
    const void *picParams,
    NvMediaEncoderInstanceId instanceId
);
 
// coverity[misra_c_2012_rule_8_7_violation : FALSE]
NvMediaStatus
NvMediaIEPSetConfiguration(
    NvMediaIEP *encoder,
    const void *configuration
);
 
// coverity[misra_c_2012_rule_8_7_violation : FALSE]
NvMediaStatus
NvMediaIEPGetBits(
    const NvMediaIEP *encoder,
    uint32_t *numBytes,
    uint32_t numBitstreamBuffers,
    const NvMediaBitstreamBuffer *bitstreams,
    void *extradata
);
 
// coverity[misra_c_2012_rule_8_7_violation : FALSE]
NvMediaStatus
NvMediaIEPBitsAvailable(
    const NvMediaIEP *encoder,
    uint32_t *numBytesAvailable,
    NvMediaBlockingType blockingType,
    uint32_t millisecondTimeout
);
 
 
// coverity[misra_c_2012_rule_8_7_violation : FALSE]
NvMediaStatus
NvMediaIEPGetAttribute(
    const NvMediaIEP *encoder,
    NvMediaEncAttrType attrType,
    uint32_t attrSize,
    void *AttributeData
);
 
NvMediaStatus
NvMediaIEPRegisterNvSciBufObj(
    NvMediaIEP    *encoder,
    const NvSciBufObj   bufObj
);
 
// coverity[misra_c_2012_rule_8_7_violation : FALSE]
NvMediaStatus
NvMediaIEPUnregisterNvSciBufObj(
    const NvMediaIEP    *encoder,
    const NvSciBufObj   bufObj
);
 
 
NvMediaStatus
NvMediaIEPFillNvSciBufAttrList(
    NvMediaEncoderInstanceId  instanceId,
    NvSciBufAttrList          attrlist
);
 
 
NvMediaStatus
NvMediaIEPFillNvSciSyncAttrList(
    const NvMediaIEP           *encoder,
    NvSciSyncAttrList          attrlist,
    NvMediaNvSciSyncClientType clienttype
);
 
 
NvMediaStatus
NvMediaIEPRegisterNvSciSyncObj(
    const NvMediaIEP           *encoder,
    NvMediaNvSciSyncObjType    syncobjtype,
    NvSciSyncObj               syncObj
);
 
NvMediaStatus
NvMediaIEPUnregisterNvSciSyncObj(
    const NvMediaIEP  *encoder,
    NvSciSyncObj      syncObj
);
 
NvMediaStatus
NvMediaIEPSetNvSciSyncObjforEOF(
    const NvMediaIEP      *encoder,
    NvSciSyncObj          nvscisyncEOF
);
 
NvMediaStatus
NvMediaIEPInsertPreNvSciSyncFence(
    const NvMediaIEP         *encoder,
    const NvSciSyncFence     *prenvscisyncfence
);
 
NvMediaStatus
NvMediaIEPGetEOFNvSciSyncFence(
    const NvMediaIEP        *encoder,
    NvSciSyncObj      eofnvscisyncobj,
    NvSciSyncFence    *eofnvscisyncfence
);
 
NvMediaStatus
NvMediaIEPQueryDevices(
    NvMediaDeviceList *deviceList
);
 
/*
 * @defgroup 6x_history_nvmedia_iep History
 * Provides change history for the NvMedia IEP API.
 *
 * \section 6x_history_nvmedia_iep Version History
 *
 * <b> Version 1.0.0 </b> September 28, 2021
 * - Initial release
 *
 * <b> Version 1.0.1 </b> August 03, 2022
 * - Added new quality preset API, NvMediaEncPreset
 *
 * <b> Version 1.0.2</b> March 07, 2023
 * - Added new create API NvMediaIEPCreateEx which does not depends on reconciled attribute list
 *
 * <b> Version 1.1.0</b> May 02, 2024
 * - Added support for NvMediaIEPQueryDevices API
 *
 */
 
#ifdef __cplusplus
}     /* extern "C" */
#endif
 
#endif /* NVMEDIA_IEP_H */