codec_api.h File Reference

#include <stdbool.h>
#include "codec_app_def.h"
#include "codec_def.h"

Include dependency graph for codec_api.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	ISVCEncoderVtbl
struct	ISVCDecoderVtbl

Macros
#define	EXTAPI

Typedefs
typedef struct ISVCEncoderVtbl	ISVCEncoderVtbl
typedef const ISVCEncoderVtbl *	ISVCEncoder
typedef struct ISVCDecoderVtbl	ISVCDecoderVtbl
typedef const ISVCDecoderVtbl *	ISVCDecoder
typedef void(*	WelsTraceCallback) (void *ctx, int32_t level, const char *string)

Functions
int32_t	WelsCreateSVCEncoder (ISVCEncoder **ppEncoder)
	Create encoder.
void	WelsDestroySVCEncoder (ISVCEncoder *pEncoder)
	Destroy encoder.
int32_t	WelsGetDecoderCapability (SDecoderCapability *pDecCapability)
	Get the capability of decoder.
long	WelsCreateDecoder (ISVCDecoder **ppDecoder)
	Create decoder.
void	WelsDestroyDecoder (ISVCDecoder *pDecoder)
	Destroy decoder.
OpenH264Version	WelsGetCodecVersion (void)
	Get codec version Note, old versions of Mingw (GCC < 4.7) are buggy and use an incorrect/different ABI for calling this function, making it incompatible with MSVC builds.
void	WelsGetCodecVersionEx (OpenH264Version *pVersion)
	Get codec version.
const char *	esp_openh264_get_version (void)

Macro Definition Documentation

EXTAPI

#define EXTAPI

Typedef Documentation

ISVCDecoder

typedef const ISVCDecoderVtbl* ISVCDecoder

ISVCDecoderVtbl

typedef struct ISVCDecoderVtbl ISVCDecoderVtbl

ISVCEncoder

typedef const ISVCEncoderVtbl* ISVCEncoder

ISVCEncoderVtbl

typedef struct ISVCEncoderVtbl ISVCEncoderVtbl

WelsTraceCallback

typedef void(* WelsTraceCallback) (void *ctx, int32_t level, const char *string)

Function Documentation

esp_openh264_get_version()

const char * esp_openh264_get_version

(

void

)

WelsCreateDecoder()

long WelsCreateDecoder

(

ISVCDecoder **

ppDecoder

)

Create decoder.

Parameters

ppDecoder

decoder

Returns

0 - success; otherwise - failed;

WelsCreateSVCEncoder()

int32_t WelsCreateSVCEncoder

(

ISVCEncoder **

ppEncoder

)

Create encoder.

Parameters

ppEncoder

encoder

Returns

0 - success; otherwise - failed;

WelsDestroyDecoder()

void WelsDestroyDecoder

(

ISVCDecoder *

pDecoder

)

Destroy decoder.

Parameters

pDecoder

decoder

Returns

void

WelsDestroySVCEncoder()

void WelsDestroySVCEncoder

(

ISVCEncoder *

pEncoder

)

Destroy encoder.

Parameters

pEncoder

encoder

Returns

void

WelsGetCodecVersion()

OpenH264Version WelsGetCodecVersion

(

void

)

Get codec version Note, old versions of Mingw (GCC < 4.7) are buggy and use an incorrect/different ABI for calling this function, making it incompatible with MSVC builds.

Returns

The linked codec version

WelsGetCodecVersionEx()

void WelsGetCodecVersionEx

(

OpenH264Version *

pVersion

)

Get codec version.

Parameters

pVersion

struct to fill in with the version

WelsGetDecoderCapability()

int32_t WelsGetDecoderCapability

(

SDecoderCapability *

pDecCapability

)

Get the capability of decoder.

Parameters

pDecCapability

decoder capability

Returns

0 - success; otherwise - failed;