nvmedia_vep.h

Go to the documentation of this file.

/*
 * Copyright (c) 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_VEP_H
#define _NVMEDIA_VEP_H

#ifdef __cplusplus
extern "C" {
#endif

#include "nvmedia_common.h"
#include "nvmedia_video.h"

#define NVMEDIA_VEP_VERSION_MAJOR   2

#define NVMEDIA_VEP_VERSION_MINOR   1

typedef enum {
    NVMEDIA_VIDEO_ENCODE_CODEC_H264,
    NVMEDIA_VIDEO_ENCODE_CODEC_HEVC,
    NVMEDIA_VIDEO_ENCODE_CODEC_VP9,
    NVMEDIA_VIDEO_ENCODE_CODEC_VP8
} NvMediaVideoEncodeType;

typedef struct {
    NvMediaVideoEncodeType codec;
    NvMediaSurfaceType inputFormat;
    NvMediaEncoderInstanceId instanceId;
} NvMediaVideoEncoder;


NvMediaStatus
NvMediaVideoEncoderGetVersion(
    NvMediaVersion *version
);

NvMediaVideoEncoder *
NvMediaVideoEncoderCreate(
    NvMediaDevice *device,
    NvMediaVideoEncodeType codec,
    void *initParams,
    NvMediaSurfaceType inputFormat,
    uint8_t maxInputBuffering,
    uint8_t maxOutputBuffering,
    NvMediaEncoderInstanceId instanceId
);

void NvMediaVideoEncoderDestroy(NvMediaVideoEncoder *encoder);

NvMediaStatus
NvMediaVideoEncoderFeedFrame(
    NvMediaVideoEncoder *encoder,
    NvMediaVideoSurface *frame,
    NvMediaRect *sourceRect,
    void *picParams,
    NvMediaEncoderInstanceId instanceId
);

NvMediaStatus
NvMediaVideoEncoderSetConfiguration(
    NvMediaVideoEncoder *encoder,
    void *configuration
);

NvMediaStatus
NvMediaVideoEncoderGetBits(
    NvMediaVideoEncoder *encoder,
    uint32_t *numBytes,
    void *buffer
);

NvMediaStatus
NvMediaVideoEncoderBitsAvailable(
    NvMediaVideoEncoder *encoder,
    uint32_t *numBytesAvailable,
    NvMediaBlockingType blockingType,
    uint32_t millisecondTimeout
);

/*
 * \defgroup history_nvmedia_vep History
 * Provides change history for the NvMedia Video Encode API.
 *
 * \section history_nvmedia_vcp Version History
 *
 * <b> Version 1.0 </b> March 21, 2017
 * - Initial release
 *
 * <b> Version 1.1 </b/> April 18, 2017
 * - Added \ref NvMediaVideoEncodeType
 * - Added \ref NvMediaVideoEncoderGetVersion
 * - Added instance ID parameter to \ref NvMediaVideoEncoderCreate()
 * - Added instance ID parameter to \ref NvMediaVideoEncoderFeedFrame()
 * - Added instanceId to \ref NvMediaVideoEncoder object
 * - Changed \ref NvMediaVideoEncoderCreate codec parameter to
 *   \ref NvMediaVideoEncodeType
 * - Changed to use standard data type
 *
 * <b> Version 2.0 </b> May 9, 2017
 * - Removed optionalDevice param from NvMediaVideoEncoderCreate()
 *
 * <b> Version 2.1 </b> Sept 1, 2017
 * - Added NVMEDIA_VIDEO_ENCODE_CODEC_VP8 in \ref NvMediaVideoEncodeType enum
 */

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

#endif /* _NVMEDIA_VEP_H */