AVCompat.h File Reference

#include "QtAV/QtAV_Global.h"
#include <libavformat/avformat.h>
#include <libswscale/swscale.h>
#include <libavcodec/avcodec.h>
#include <libavutil/avutil.h>
#include <libavutil/avstring.h>
#include <libavutil/dict.h>
#include <libavutil/imgutils.h>
#include <libavutil/log.h>
#include <libavutil/mathematics.h>
#include <libavutil/cpu.h>
#include <libavutil/error.h>
#include <libavutil/opt.h>
#include <libavutil/parseutils.h>
#include <libavutil/pixdesc.h>
#include <libavutil/channel_layout.h>
#include <libavutil/samplefmt.h>

Go to the source code of this file.

Macros
#define	QTAV_USE_FFMPEG(MODULE)   (MODULE##_VERSION_MICRO >= 100)
	NOTE: include this at last. More...
#define	QTAV_USE_LIBAV(MODULE)   !QTAV_USE_FFMPEG(MODULE)
#define	FFMPEG_MODULE_CHECK(MODULE, MAJOR, MINOR, MICRO)   (QTAV_USE_FFMPEG(MODULE) && MODULE##_VERSION_INT >= AV_VERSION_INT(MAJOR, MINOR, MICRO))
#define	LIBAV_MODULE_CHECK(MODULE, MAJOR, MINOR, MICRO)   (QTAV_USE_LIBAV(MODULE) && MODULE##_VERSION_INT >= AV_VERSION_INT(MAJOR, MINOR, MICRO))
#define	AV_MODULE_CHECK(MODULE, MAJOR, MINOR, MICRO, MINOR2, MICRO2)   (LIBAV_MODULE_CHECK(MODULE, MAJOR, MINOR, MICRO) || FFMPEG_MODULE_CHECK(MODULE, MAJOR, MINOR2, MICRO2))
#define	AV_ENSURE_OK(FUNC, ...)   AV_RUN_CHECK(FUNC, return, __VA_ARGS__)
	example: AV_ENSURE(avcodec_close(avctx), false) will print error and return false if failed. AV_WARN just prints error. More...
#define	AV_ENSURE(FUNC, ...)   AV_RUN_CHECK(FUNC, return, __VA_ARGS__)
#define	AV_WARN(FUNC)   AV_RUN_CHECK(FUNC, void)
#define	AV_VERSION_INT(a, b, c)   (a<<16 | b<<8 | c)
	Guide to uniform the api for different FFmpeg version(or other libraries) We use the existing old api to simulater . More...
#define	GCC_VERSION_AT_LEAST(major, minor, patch)   0
#define	QTAV_HAVE_AVBUFREF   AV_MODULE_CHECK(LIBAVUTIL, 52, 8, 0, 19, 100)
#define	AV_ERROR_MAX_STRING_SIZE   64
#define	avcodec_decode_audio3(avctx, samples, frame_size_ptr, avpkt)   avcodec_decode_audio2(avctx, samples, frame_size_ptr, (*avpkt).data, (*avpkt).size);
	defined(av_err2str) || GCC_VERSION_AT_LEAST(4, 7, 2) More...
#define	av_dump_format(...)   dump_format(__VA_ARGS__)
#define	QTAV_PIX_FMT_C(X)   PIX_FMT_##X
#define	PIX_FMT_PLANAR   16
	At least one pixel component is not in the first data plane. More...
#define	PIX_FMT_RGB   32
	The pixel format contains RGB-like data (as opposed to YUV/grayscale) More...
#define	PIX_FMT_PSEUDOPAL   64
#define	PIX_FMT_ALPHA   128
	The pixel format has an alpha channel. More...
#define	AV_PIX_FMT_FLAG_BE   PIX_FMT_BE
#define	AV_PIX_FMT_FLAG_PAL   PIX_FMT_PAL
#define	AV_PIX_FMT_FLAG_BITSTREAM   PIX_FMT_BITSTREAM
#define	AV_PIX_FMT_FLAG_HWACCEL   PIX_FMT_HWACCEL
#define	AV_PIX_FMT_FLAG_PLANAR   PIX_FMT_PLANAR
#define	AV_PIX_FMT_FLAG_RGB   PIX_FMT_RGB
#define	AV_PIX_FMT_FLAG_PSEUDOPAL   PIX_FMT_PSEUDOPAL
#define	AV_PIX_FMT_FLAG_ALPHA   PIX_FMT_ALPHA
#define	QTAV_CODEC_ID(X)   CODEC_ID_##X
#define	av_frame_alloc()   avcodec_alloc_frame()
#define	av_frame_free(f)   avcodec_free_frame(f)
#define	av_packet_unref(pkt)   av_free_packet(pkt)
#define	AV_CODEC_ID_HEVC   ((AVCodecID)0)
#define	CODEC_ID_HEVC   ((AVCodecID)0)
#define	FF_PROFILE_HEVC_MAIN   -1
#define	FF_PROFILE_HEVC_MAIN_10   -1
#define	AV_CODEC_ID_VP9   ((AVCodecID)0)
#define	CODEC_ID_VP9   ((AVCodecID)0)
#define	FF_PROFILE_VP9_0   0
#define	FF_PROFILE_VP9_1   1
#define	FF_PROFILE_VP9_2   2
#define	FF_PROFILE_VP9_3   3
#define	AV_RUN_CHECK(FUNC, RETURN, ...)

Typedefs
typedef enum PixelFormat	AVPixelFormat
typedef enum CodecID	AVCodecID

Functions
void	ffmpeg_version_print ()
int	avio_feof (AVIOContext *s)
int	avformat_alloc_output_context2 (AVFormatContext **avctx, AVOutputFormat *oformat, const char *format, const char *filename)
av_always_inline char *	av_err2str (int errnum)
int64_t	av_get_default_channel_layout (int nb_channels)
const AVPixFmtDescriptor *	av_pix_fmt_desc_get (AVPixelFormat pix_fmt)
const AVPixFmtDescriptor *	av_pix_fmt_desc_next (const AVPixFmtDescriptor *prev)
AVPixelFormat	av_pix_fmt_desc_get_id (const AVPixFmtDescriptor *desc)
enum AVColorSpace	av_frame_get_colorspace (const AVFrame *frame)
enum AVColorRange	av_frame_get_color_range (const AVFrame *frame)
int	av_pix_fmt_count_planes (AVPixelFormat pix_fmt)
int	av_samples_copy (uint8_t **dst, uint8_t *const *src, int dst_offset, int src_offset, int nb_samples, int nb_channels, enum AVSampleFormat sample_fmt)
const char *	avcodec_get_name (enum AVCodecID id)
void	av_packet_rescale_ts (AVPacket *pkt, AVRational src_tb, AVRational dst_tb)
int	av_packet_copy_props (AVPacket *dst, const AVPacket *src)
void	av_packet_free_side_data (AVPacket *pkt)
int	av_packet_ref (AVPacket *dst, const AVPacket *src)
void	avcodec_free_context (AVCodecContext **avctx)
const char *	get_codec_long_name (AVCodecID id)

Macro Definition Documentation

AV_CODEC_ID_HEVC

#define AV_CODEC_ID_HEVC   ((AVCodecID)0)

AV_CODEC_ID_VP9

#define AV_CODEC_ID_VP9   ((AVCodecID)0)

av_dump_format

#define av_dump_format

(

...

)

dump_format(__VA_ARGS__)

AV_ENSURE

#define AV_ENSURE	(		FUNC,
			...
	)		AV_RUN_CHECK(FUNC, return, __VA_ARGS__)

AV_ENSURE_OK

#define AV_ENSURE_OK	(		FUNC,
			...
	)		AV_RUN_CHECK(FUNC, return, __VA_ARGS__)

example: AV_ENSURE(avcodec_close(avctx), false) will print error and return false if failed. AV_WARN just prints error.

AV_ERROR_MAX_STRING_SIZE

#define AV_ERROR_MAX_STRING_SIZE   64

av_frame_alloc

#define av_frame_alloc

(

void

)

avcodec_alloc_frame()

av_frame_free

#define av_frame_free

(

f

)

avcodec_free_frame(f)

AV_MODULE_CHECK

#define AV_MODULE_CHECK	(		MODULE,
			MAJOR,
			MINOR,
			MICRO,
			MINOR2,
			MICRO2
	)		(LIBAV_MODULE_CHECK(MODULE, MAJOR, MINOR, MICRO) || FFMPEG_MODULE_CHECK(MODULE, MAJOR, MINOR2, MICRO2))

av_packet_unref

#define av_packet_unref

(

pkt

)

av_free_packet(pkt)

AV_PIX_FMT_FLAG_ALPHA

#define AV_PIX_FMT_FLAG_ALPHA   PIX_FMT_ALPHA

AV_PIX_FMT_FLAG_BE

#define AV_PIX_FMT_FLAG_BE   PIX_FMT_BE

AV_PIX_FMT_FLAG_BITSTREAM

#define AV_PIX_FMT_FLAG_BITSTREAM   PIX_FMT_BITSTREAM

AV_PIX_FMT_FLAG_HWACCEL

#define AV_PIX_FMT_FLAG_HWACCEL   PIX_FMT_HWACCEL

AV_PIX_FMT_FLAG_PAL

#define AV_PIX_FMT_FLAG_PAL   PIX_FMT_PAL

AV_PIX_FMT_FLAG_PLANAR

#define AV_PIX_FMT_FLAG_PLANAR   PIX_FMT_PLANAR

AV_PIX_FMT_FLAG_PSEUDOPAL

#define AV_PIX_FMT_FLAG_PSEUDOPAL   PIX_FMT_PSEUDOPAL

AV_PIX_FMT_FLAG_RGB

#define AV_PIX_FMT_FLAG_RGB   PIX_FMT_RGB

AV_RUN_CHECK

#define AV_RUN_CHECK	(		FUNC,
			RETURN,
			...
	)

Value:

do { \
    int ret = FUNC; \
    if (ret < 0) { \
        char str[AV_ERROR_MAX_STRING_SIZE]; \
        memset(str, 0, sizeof(str)); \
        av_strerror(ret, str, sizeof(str)); \
        av_log(NULL, AV_LOG_WARNING, "Error " #FUNC " @%d " __FILE__ ": (%#x) %s\n", __LINE__, ret, str); \
        RETURN __VA_ARGS__; \
     } } while(0)

AV_VERSION_INT

#define AV_VERSION_INT	(		a,
			b,
			c
	)		(a<<16 | b<<8 | c)

Guide to uniform the api for different FFmpeg version(or other libraries) We use the existing old api to simulater .

1. The old version does not have this api: Just add it.
2. The old version has similar api: Try using macro. e.g. the old is bool my_play(char* data, size_t size) the new is bool my_play2(const ByteArray& data) change: #define my_play2(data) my_play(data.data(), data.size());
3. The old version api is conflicted with the latest's. We can redefine the api e.g. the old is bool my_play(char* data, size_t size) the new is bool my_play(const ByteArray& data) change: typedef bool (my_play_t)(const ByteArray&); static my_play_t my_play_ptr = my_play; //using the existing my_play(char, size_t) #define my_play my_play_compat inline bool my_play_compat(const ByteArray& data) { return my_play_ptr(data.data(), data.size()); }
4. conflict macros see av_err2str

AV_WARN

#define AV_WARN

(

FUNC

)

AV_RUN_CHECK(FUNC, void)

avcodec_decode_audio3

#define avcodec_decode_audio3	(		avctx,
			samples,
			frame_size_ptr,
			avpkt
	)		avcodec_decode_audio2(avctx, samples, frame_size_ptr, (*avpkt).data, (*avpkt).size);

defined(av_err2str) || GCC_VERSION_AT_LEAST(4, 7, 2)

CODEC_ID_HEVC

#define CODEC_ID_HEVC   ((AVCodecID)0)

CODEC_ID_VP9

#define CODEC_ID_VP9   ((AVCodecID)0)

FF_PROFILE_HEVC_MAIN

#define FF_PROFILE_HEVC_MAIN   -1

FF_PROFILE_HEVC_MAIN_10

#define FF_PROFILE_HEVC_MAIN_10   -1

FF_PROFILE_VP9_0

#define FF_PROFILE_VP9_0   0

FF_PROFILE_VP9_1

#define FF_PROFILE_VP9_1   1

FF_PROFILE_VP9_2

#define FF_PROFILE_VP9_2   2

FF_PROFILE_VP9_3

#define FF_PROFILE_VP9_3   3

FFMPEG_MODULE_CHECK

#define FFMPEG_MODULE_CHECK	(		MODULE,
			MAJOR,
			MINOR,
			MICRO
	)		(QTAV_USE_FFMPEG(MODULE) && MODULE##_VERSION_INT >= AV_VERSION_INT(MAJOR, MINOR, MICRO))

GCC_VERSION_AT_LEAST

#define GCC_VERSION_AT_LEAST	(		major,
			minor,
			patch
	)		0

LIBAV_MODULE_CHECK

#define LIBAV_MODULE_CHECK	(		MODULE,
			MAJOR,
			MINOR,
			MICRO
	)		(QTAV_USE_LIBAV(MODULE) && MODULE##_VERSION_INT >= AV_VERSION_INT(MAJOR, MINOR, MICRO))

PIX_FMT_ALPHA

#define PIX_FMT_ALPHA   128

The pixel format has an alpha channel.

PIX_FMT_PLANAR

#define PIX_FMT_PLANAR   16

At least one pixel component is not in the first data plane.

PIX_FMT_PSEUDOPAL

#define PIX_FMT_PSEUDOPAL   64

PIX_FMT_RGB

#define PIX_FMT_RGB   32

The pixel format contains RGB-like data (as opposed to YUV/grayscale)

QTAV_CODEC_ID

#define QTAV_CODEC_ID

(

X

)

CODEC_ID_##X

QTAV_HAVE_AVBUFREF

#define QTAV_HAVE_AVBUFREF   AV_MODULE_CHECK(LIBAVUTIL, 52, 8, 0, 19, 100)

QTAV_PIX_FMT_C

#define QTAV_PIX_FMT_C

(

X

)

PIX_FMT_##X

QTAV_USE_FFMPEG

#define QTAV_USE_FFMPEG

(

MODULE

)

(MODULE##_VERSION_MICRO >= 100)

NOTE: include this at last.

QTAV_USE_LIBAV

#define QTAV_USE_LIBAV

(

MODULE

)

!QTAV_USE_FFMPEG(MODULE)

Typedef Documentation

AVCodecID

typedef enum CodecID AVCodecID

AVPixelFormat

typedef enum PixelFormat AVPixelFormat

Function Documentation

av_err2str()

av_always_inline char* av_err2str

(

int

errnum

)

av_frame_get_color_range()

enum AVColorRange av_frame_get_color_range

(

const AVFrame *

frame

)

av_frame_get_colorspace()

enum AVColorSpace av_frame_get_colorspace

(

const AVFrame *

frame

)

av_get_default_channel_layout()

int64_t av_get_default_channel_layout

(

int

nb_channels

)

av_packet_copy_props()

int av_packet_copy_props	(	AVPacket *	dst,
		const AVPacket *	src
	)

av_packet_free_side_data()

void av_packet_free_side_data

(

AVPacket *

pkt

)

av_packet_ref()

int av_packet_ref	(	AVPacket *	dst,
		const AVPacket *	src
	)

av_packet_rescale_ts()

void av_packet_rescale_ts	(	AVPacket *	pkt,
		AVRational	src_tb,
		AVRational	dst_tb
	)

av_pix_fmt_count_planes()

int av_pix_fmt_count_planes

(

AVPixelFormat

pix_fmt

)

av_pix_fmt_desc_get()

const AVPixFmtDescriptor* av_pix_fmt_desc_get

(

AVPixelFormat

pix_fmt

)

av_pix_fmt_desc_get_id()

AVPixelFormat av_pix_fmt_desc_get_id

(

const AVPixFmtDescriptor *

desc

)

av_pix_fmt_desc_next()

const AVPixFmtDescriptor* av_pix_fmt_desc_next

(

const AVPixFmtDescriptor *

prev

)

av_samples_copy()

int av_samples_copy	(	uint8_t **	dst,
		uint8_t *const *	src,
		int	dst_offset,
		int	src_offset,
		int	nb_samples,
		int	nb_channels,
		enum AVSampleFormat	sample_fmt
	)

Copy samples from src to dst.

Parameters

dst	destination array of pointers to data planes
src	source array of pointers to data planes
dst_offset	offset in samples at which the data will be written to dst
src_offset	offset in samples at which the data will be read from src
nb_samples	number of samples to be copied
nb_channels	number of audio channels
sample_fmt	audio sample format

avcodec_free_context()

void avcodec_free_context

(

AVCodecContext **

avctx

)

avcodec_get_name()

const char* avcodec_get_name

(

enum AVCodecID

id

)

avformat_alloc_output_context2()

int avformat_alloc_output_context2	(	AVFormatContext **	avctx,
		AVOutputFormat *	oformat,
		const char *	format,
		const char *	filename
	)

avio_feof()

int avio_feof

(

AVIOContext *

s

)

ffmpeg_version_print()

void ffmpeg_version_print

(

)

get_codec_long_name()

const char* get_codec_long_name

(

AVCodecID

id

)