nvmedia_iep.h

Go to the documentation of this file.

/*
 * Copyright (c) 2014-2020, 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_IEP_H
#define NVMEDIA_IEP_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include "nvmedia_common_encode.h"
#include "nvmedia_core.h"
#include "nvmedia_image.h"
#include "nvmedia_surface.h"
 
#define NVMEDIA_IEP_VERSION_MAJOR   2
 
#define NVMEDIA_IEP_VERSION_MINOR   14
 
typedef enum {
    NVMEDIA_IMAGE_ENCODE_H264,
    NVMEDIA_IMAGE_ENCODE_HEVC,
    NVMEDIA_IMAGE_ENCODE_VP9,
    NVMEDIA_IMAGE_ENCODE_VP8
} NvMediaIEPType;
 
typedef struct NvMediaIEPRec {
    NvMediaIEPType encodeType;
    NvMediaSurfaceType inputFormat;
    NvMediaEncoderInstanceId instanceId;
    struct NvMediaIEPPriv_ *encPriv;
} 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(
    const NvMediaDevice *device,
    NvMediaIEPType encodeType,
    const void *initParams,
    NvMediaSurfaceType inputFormat,
    uint8_t maxInputBuffering,
    uint8_t maxOutputBuffering,
    NvMediaEncoderInstanceId instanceId
);
 
#if !NV_IS_SAFETY
 
NvMediaIEP *
NvMediaIEPCreateCtx(
    void
);
 
NvMediaStatus
NvMediaIEPInit(
    const NvMediaIEP *encoder,
    const NvMediaDevice *device,
    NvMediaIEPType encodeType,
    const void *initParams,
    NvMediaSurfaceType inputFormat,
    uint8_t maxInputBuffering,
    uint8_t maxOutputBuffering,
    NvMediaEncoderInstanceId instanceId
);
#endif
 
// coverity[misra_c_2012_rule_8_7_violation : FALSE]
void NvMediaIEPDestroy(const NvMediaIEP *encoder);
 
// coverity[misra_c_2012_rule_8_7_violation : FALSE]
NvMediaStatus
NvMediaIEPFeedFrame(
    const NvMediaIEP *encoder,
    const NvMediaImage *frame,
    NvMediaRect *sourceRect,
    const void *picParams,
    NvMediaEncoderInstanceId instanceId
);
 
// coverity[misra_c_2012_rule_8_7_violation : FALSE]
NvMediaStatus
NvMediaIEPSetConfiguration(
    const NvMediaIEP *encoder,
    const void *configuration
);
 
// coverity[misra_c_2012_rule_8_7_violation : FALSE]
NvMediaStatus
NvMediaIEPGetBitsEx(
    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
NvMediaIEPImageRegister(
    const NvMediaIEP   *encoder,
    const NvMediaImage *image,
    NvMediaAccessMode  accessMode
);
 
// coverity[misra_c_2012_rule_8_7_violation : FALSE]
NvMediaStatus
NvMediaIEPImageUnRegister(
    const NvMediaIEP   *encoder,
    const NvMediaImage *image
);
 
/*
 * \defgroup history_nvmedia_iep History
 * Provides change history for the NvMedia IEP API.
 *
 * \section history_nvmedia_iep Version History
 *
 * <b> Version 1.0 </b> March 14, 2016
 * - Initial release
 *
 * <b> Version 1.1 </b> May 11, 2016
 * - Added \ref NvMediaICPCheckVersion API
 *
 * <b> Version 1.2 </b> May 5, 2017
 * - Added \ref NvMediaIEPGetBitsEx and \ref NvMediaIEPSetInputExtraData API
 * - Added \ref NvMediaIEPGetAttribute
 *
 * <b> Version 2.0 </b> May 9, 2017
 * - Added instance ID parameter to NvMediaIEPCreate() and NvMediaIEPFeedFrame()
 * - optionalDevice parameter is removed from NvMediaIEPCreate()
 * - NvMediaIEPGetVersion() is added to get the version of NvMedia Image Encoder library
 * - NvMediaIEPGetBits() is deprecated. Use NvMediaIEPGetBitsEx() instead.
 * - All NvMedia data types are moved to standard data types
 *
 * <b> Version 2.1 </b> June 30, 2017
 * - Removed \ref NvMediaIEPSetInputExtraData API
 *
 * <b> Version 2.2 </b> Sept 1, 2017
 * - Added NVMEDIA_IMAGE_ENCODE_VP8 in \ref NvMediaIEPType enum
 *
 * <b> Version 2.3 </b> Dec 14, 2018
 * - Fix MISRA violations 21.1 and 21.2
 *
 * <b> Version 2.4 </b> January 15, 2019
 * - Fix MISRA violations 8.13
 *
 * <b> Version 2.5 </b> Feb 7, 2019
 * - Added opaque handle for encoder
 *   internal usage into Image encoder object
 * - Fix MISRA violations 11.3
 * - Fix MISRA violations 8.13
 *
 * <b> Version 2.6 </b> Feb 28, 2019
 * - Added required header includes nvmedia_core.h and nvmedia_surface.h
 *
 * <b> Version 2.7 </b> July 10, 2019
 * - Header include nvmedia_common.h is replaced with nvmedia_common_encode.h
 *
 *  <b> Version 2.8 </b> July 13, 2019
 * - Corrected parameter description for \ref NvMediaIEPCreate and
 *   \ref NvMediaIEPFeedFrame.
 *
 *  <b> Version 2.9 </b> July 15, 2019
 * - Fix MISRA violations 8.13
 *
 *  <b> Version 2.10 </b> Jul 16, 2019
 * - Added \ref NvMediaIEPImageRegister API
 * - Added \ref NvMediaIEPImageUnRegister API
 *
 *  <b> Version 2.11 </b> October 5, 2019
 * - Fix MISRA violations 8.13
 * - Added Coverity Code annotations to suppress partial 8.7 violations
 *
 *  <b> Version 2.12 </b> November 25, 2019
 * - Fix MISRA violations 8.13
 *
 *  <b> Version 2.13 </b> September 3, 2020
 * - Added \ref NvMediaIEPCreateCtx API (non-safety build)
 * - Added \ref NvMediaIEPInit API (non-safety build)
 *
 *  <b> Version 2.14 </b> November 20, 2020
 * - Updated input format requirements for all supported codecs only
 *   in comments section of \ref NvMediaIEPCreate as part of documentation
 */
 
#ifdef __cplusplus
};     /* extern "C" */
#endif
 
#endif /* NVMEDIA_IEP_H */