nvmedia_iep.h

Go to the documentation of this file.

/*
 * Copyright (c) 2014-2017, 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.h"
#include "nvmedia_image.h"

#define NVMEDIA_IEP_VERSION_MAJOR   2

#define NVMEDIA_IEP_VERSION_MINOR   2

typedef enum {
    NVMEDIA_IMAGE_ENCODE_H264,
    NVMEDIA_IMAGE_ENCODE_HEVC,
    NVMEDIA_IMAGE_ENCODE_VP9,
    NVMEDIA_IMAGE_ENCODE_VP8
} NvMediaIEPType;


typedef struct {
    NvMediaIEPType encodeType;
    NvMediaSurfaceType inputFormat;
    NvMediaEncoderInstanceId instanceId;
} NvMediaIEP;

NvMediaStatus
NvMediaIEPGetVersion(
    NvMediaVersion *version
);

NvMediaIEP *
NvMediaIEPCreate(
    NvMediaDevice *device,
    NvMediaIEPType encodeType,
    void *initParams,
    NvMediaSurfaceType inputFormat,
    uint8_t maxInputBuffering,
    uint8_t maxOutputBuffering,
    NvMediaEncoderInstanceId instanceId
);

void NvMediaIEPDestroy(NvMediaIEP *encoder);

NvMediaStatus
NvMediaIEPFeedFrame(
    NvMediaIEP *encoder,
    NvMediaImage *frame,
    NvMediaRect *sourceRect,
    void *picParams,
    NvMediaEncoderInstanceId instanceId
);

NvMediaStatus
NvMediaIEPSetConfiguration(
    NvMediaIEP *encoder,
    void *configuration
);

NvMediaStatus
NvMediaIEPGetBitsEx(
    NvMediaIEP *encoder,
    uint32_t *numBytes,
    uint32_t numBitstreamBuffers,
    NvMediaBitstreamBuffer *bitstreams,
    void *extradata
);

NvMediaStatus
NvMediaIEPBitsAvailable(
    NvMediaIEP *encoder,
    uint32_t *numBytesAvailable,
    NvMediaBlockingType blockingType,
    uint32_t millisecondTimeout
);


NvMediaStatus
NvMediaIEPGetAttribute(
    NvMediaIEP *encoder,
    NvMediaEncAttrType attrType,
    uint32_t attrSize,
    void *AttributeData
);

/*
 * \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
 */

#ifdef __cplusplus
};     /* extern "C" */
#endif

#endif /* _NVMEDIA_IEP_H */