FFmpeg  4.3
Macros | Functions | Variables
options.c File Reference
#include "avcodec.h"
#include "internal.h"
#include "libavutil/avassert.h"
#include "libavutil/internal.h"
#include "libavutil/mem.h"
#include "libavutil/opt.h"
#include <string.h>
#include "options_table.h"

Go to the source code of this file.

Macros

#define alloc_and_copy_or_fail(obj, size, pad)
 
#define FOFFSET(x)   offsetof(AVFrame,x)
 
#define SROFFSET(x)   offsetof(AVSubtitleRect,x)
 

Functions

FF_DISABLE_DEPRECATION_WARNINGS static const FF_ENABLE_DEPRECATION_WARNINGS char * context_to_name (void *ptr)
 
static voidcodec_child_next (void *obj, void *prev)
 
static const AVClasscodec_child_class_next (const AVClass *prev)
 
static AVClassCategory get_category (void *ptr)
 
static int init_context_defaults (AVCodecContext *s, const AVCodec *codec)
 
int avcodec_get_context_defaults3 (AVCodecContext *s, const AVCodec *codec)
 
AVCodecContextavcodec_alloc_context3 (const AVCodec *codec)
 Allocate an AVCodecContext and set its fields to default values. More...
 
void avcodec_free_context (AVCodecContext **pavctx)
 Free the codec context and everything associated with it and write NULL to the provided pointer. More...
 
static void copy_context_reset (AVCodecContext *avctx)
 
int avcodec_copy_context (AVCodecContext *dest, const AVCodecContext *src)
 Copy the settings of the source AVCodecContext into the destination AVCodecContext. More...
 
const AVClassavcodec_get_class (void)
 Get the AVClass for AVCodecContext. More...
 
const AVClassavcodec_get_frame_class (void)
 Get the AVClass for AVFrame. More...
 
const AVClassavcodec_get_subtitle_rect_class (void)
 Get the AVClass for AVSubtitleRect. More...
 

Variables

static const AVClass av_codec_context_class
 
static const AVOption frame_options []
 
static const AVClass av_frame_class
 
static const AVOption subtitle_rect_options []
 
static const AVClass av_subtitle_rect_class
 

Detailed Description

Options definition for AVCodecContext.

Definition in file options.c.

Macro Definition Documentation

◆ alloc_and_copy_or_fail

#define alloc_and_copy_or_fail (   obj,
  size,
  pad 
)
Value:
if (src->obj && size > 0) { \
dest->obj = av_malloc(size + pad); \
if (!dest->obj) \
goto fail; \
memcpy(dest->obj, src->obj, size); \
if (pad) \
memset(((uint8_t *) dest->obj) + size, 0, pad); \
}

◆ FOFFSET

#define FOFFSET (   x)    offsetof(AVFrame,x)

Definition at line 300 of file options.c.

◆ SROFFSET

#define SROFFSET (   x)    offsetof(AVSubtitleRect,x)

Definition at line 327 of file options.c.

Function Documentation

◆ context_to_name()

FF_DISABLE_DEPRECATION_WARNINGS static const FF_ENABLE_DEPRECATION_WARNINGS char* context_to_name ( void ptr)
static

Definition at line 39 of file options.c.

◆ codec_child_next()

static void* codec_child_next ( void obj,
void prev 
)
static

Definition at line 48 of file options.c.

◆ codec_child_class_next()

static const AVClass* codec_child_class_next ( const AVClass prev)
static

Definition at line 56 of file options.c.

◆ get_category()

static AVClassCategory get_category ( void ptr)
static

Definition at line 73 of file options.c.

◆ init_context_defaults()

static int init_context_defaults ( AVCodecContext s,
const AVCodec codec 
)
static

Definition at line 92 of file options.c.

Referenced by avcodec_alloc_context3(), and avcodec_get_context_defaults3().

◆ copy_context_reset()

static void copy_context_reset ( AVCodecContext avctx)
static

Definition at line 191 of file options.c.

Referenced by avcodec_copy_context().

Variable Documentation

◆ av_codec_context_class

const AVClass av_codec_context_class
static
Initial value:
= {
.class_name = "AVCodecContext",
.item_name = context_to_name,
.option = avcodec_options,
.log_level_offset_offset = offsetof(AVCodecContext, log_level_offset),
.child_next = codec_child_next,
.child_class_next = codec_child_class_next,
.get_category = get_category,
}

Definition at line 80 of file options.c.

Referenced by avcodec_get_class(), and init_context_defaults().

◆ frame_options

const AVOption frame_options[]
static
Initial value:
={
{"best_effort_timestamp", "", FOFFSET(best_effort_timestamp), AV_OPT_TYPE_INT64, {.i64 = AV_NOPTS_VALUE }, INT64_MIN, INT64_MAX, 0},
{"pkt_pos", "", FOFFSET(pkt_pos), AV_OPT_TYPE_INT64, {.i64 = -1 }, INT64_MIN, INT64_MAX, 0},
{"pkt_size", "", FOFFSET(pkt_size), AV_OPT_TYPE_INT64, {.i64 = -1 }, INT64_MIN, INT64_MAX, 0},
{"sample_aspect_ratio", "", FOFFSET(sample_aspect_ratio), AV_OPT_TYPE_RATIONAL, {.dbl = 0 }, 0, INT_MAX, 0},
{"width", "", FOFFSET(width), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
{"height", "", FOFFSET(height), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
{"format", "", FOFFSET(format), AV_OPT_TYPE_INT, {.i64 = -1 }, 0, INT_MAX, 0},
{"channel_layout", "", FOFFSET(channel_layout), AV_OPT_TYPE_INT64, {.i64 = 0 }, 0, INT64_MAX, 0},
{"sample_rate", "", FOFFSET(sample_rate), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
{NULL},
}

Definition at line 302 of file options.c.

◆ av_frame_class

const AVClass av_frame_class
static
Initial value:
= {
.class_name = "AVFrame",
.item_name = NULL,
.option = frame_options,
}

Definition at line 315 of file options.c.

Referenced by avcodec_get_frame_class().

◆ subtitle_rect_options

const AVOption subtitle_rect_options[]
static
Initial value:
={
{"x", "", SROFFSET(x), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
{"y", "", SROFFSET(y), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
{"w", "", SROFFSET(w), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
{"h", "", SROFFSET(h), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
{"type", "", SROFFSET(type), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
{"flags", "", SROFFSET(flags), AV_OPT_TYPE_FLAGS, {.i64 = 0}, 0, 1, 0, "flags"},
{"forced", "", SROFFSET(flags), AV_OPT_TYPE_FLAGS, {.i64 = 0}, 0, 1, 0},
{NULL},
}

Definition at line 329 of file options.c.

◆ av_subtitle_rect_class

const AVClass av_subtitle_rect_class
static
Initial value:
= {
.class_name = "AVSubtitleRect",
.item_name = NULL,
}

Definition at line 340 of file options.c.

Referenced by avcodec_get_subtitle_rect_class().

AV_OPT_TYPE_RATIONAL
@ AV_OPT_TYPE_RATIONAL
Definition: opt.h:228
sample_rate
sample_rate
Definition: ffmpeg_filter.c:192
av_malloc
#define av_malloc(s)
Definition: tableprint_vlc.h:31
fail
#define fail()
Definition: checkasm.h:123
x
FFmpeg Automated Testing Environment ************************************Introduction Using FATE from your FFmpeg source directory Submitting the results to the FFmpeg result aggregation server Uploading new samples to the fate suite FATE makefile targets and variables Makefile targets Makefile variables Examples Introduction **************FATE is an extended regression suite on the client side and a means for results aggregation and presentation on the server side The first part of this document explains how you can use FATE from your FFmpeg source directory to test your ffmpeg binary The second part describes how you can run FATE to submit the results to FFmpeg’s FATE server In any way you can have a look at the publicly viewable FATE results by visiting this as it can be seen if some test on some platform broke with their recent contribution This usually happens on the platforms the developers could not test on The second part of this document describes how you can run FATE to submit your results to FFmpeg’s FATE server If you want to submit your results be sure to check that your combination of OS and compiler is not already listed on the above mentioned website In the third part you can find a comprehensive listing of FATE makefile targets and variables Using FATE from your FFmpeg source directory **********************************************If you want to run FATE on your machine you need to have the samples in place You can get the samples via the build target fate rsync Use this command from the top level source this will cause FATE to fail NOTE To use a custom wrapper to run the pass ‘ target exec’ to ‘configure’ or set the TARGET_EXEC Make variable Submitting the results to the FFmpeg result aggregation server ****************************************************************To submit your results to the server you should run fate through the shell script ‘tests fate sh’ from the FFmpeg sources This script needs to be invoked with a configuration file as its first argument tests fate sh path to fate_config A configuration file template with comments describing the individual configuration variables can be found at ‘doc fate_config sh template’ Create a configuration that suits your based on the configuration template The ‘slot’ configuration variable can be any string that is not yet but it is suggested that you name it adhering to the following pattern ‘ARCH OS COMPILER COMPILER VERSION’ The configuration file itself will be sourced in a shell therefore all shell features may be used This enables you to setup the environment as you need it for your build For your first test runs the ‘fate_recv’ variable should be empty or commented out This will run everything as normal except that it will omit the submission of the results to the server The following files should be present in $workdir as specified in the configuration it may help to try out the ‘ssh’ command with one or more ‘ v’ options You should get detailed output concerning your SSH configuration and the authentication process The only thing left is to automate the execution of the fate sh script and the synchronisation of the samples directory Uploading new samples to the fate suite *****************************************If you need a sample uploaded send a mail to samples request This is for developers who have an account on the fate suite server If you upload new please make sure they are as small as space on each network bandwidth and so on benefit from smaller test cases Also keep in mind older checkouts use existing sample that means in practice generally do not remove or overwrite files as it likely would break older checkouts or releases Also all needed samples for a commit should be ideally before the push If you need an account for frequently uploading samples or you wish to help others by doing that send a mail to ffmpeg devel rsync vauL Duo x
Definition: fate.txt:150
type
it s the only field you need to keep assuming you have a context There is some magic you don t need to care about around this just let it vf type
Definition: writing_filters.txt:86
subtitle_rect_options
static const AVOption subtitle_rect_options[]
Definition: options.c:329
width
#define width
format
Filter the word “frame” indicates either a video frame or a group of audio as stored in an AVFrame structure Format for each input and each output the list of supported formats For video that means pixel format For audio that means channel sample format(the sample packing is implied by the sample format) and sample rate. The lists are not just lists
AV_OPT_TYPE_INT64
@ AV_OPT_TYPE_INT64
Definition: opt.h:224
LIBAVUTIL_VERSION_INT
#define LIBAVUTIL_VERSION_INT
Definition: version.h:85
NULL
#define NULL
Definition: coverity.c:32
codec_child_next
static void * codec_child_next(void *obj, void *prev)
Definition: options.c:48
src
#define src
Definition: vp8dsp.c:254
AVClass::category
AVClassCategory category
Category used for visualization (like color) This is only set if the category is equal for all object...
Definition: log.h:130
codec_child_class_next
static const AVClass * codec_child_class_next(const AVClass *prev)
Definition: options.c:56
size
int size
Definition: twinvq_data.h:11134
AV_NOPTS_VALUE
#define AV_NOPTS_VALUE
Undefined timestamp value.
Definition: avutil.h:248
height
#define height
SROFFSET
#define SROFFSET(x)
Definition: options.c:327
uint8_t
uint8_t
Definition: audio_convert.c:194
frame_options
static const AVOption frame_options[]
Definition: options.c:302
w
FFmpeg Automated Testing Environment ************************************Introduction Using FATE from your FFmpeg source directory Submitting the results to the FFmpeg result aggregation server Uploading new samples to the fate suite FATE makefile targets and variables Makefile targets Makefile variables Examples Introduction **************FATE is an extended regression suite on the client side and a means for results aggregation and presentation on the server side The first part of this document explains how you can use FATE from your FFmpeg source directory to test your ffmpeg binary The second part describes how you can run FATE to submit the results to FFmpeg’s FATE server In any way you can have a look at the publicly viewable FATE results by visiting this as it can be seen if some test on some platform broke with their recent contribution This usually happens on the platforms the developers could not test on The second part of this document describes how you can run FATE to submit your results to FFmpeg’s FATE server If you want to submit your results be sure to check that your combination of OS and compiler is not already listed on the above mentioned website In the third part you can find a comprehensive listing of FATE makefile targets and variables Using FATE from your FFmpeg source directory **********************************************If you want to run FATE on your machine you need to have the samples in place You can get the samples via the build target fate rsync Use this command from the top level source this will cause FATE to fail NOTE To use a custom wrapper to run the pass ‘ target exec’ to ‘configure’ or set the TARGET_EXEC Make variable Submitting the results to the FFmpeg result aggregation server ****************************************************************To submit your results to the server you should run fate through the shell script ‘tests fate sh’ from the FFmpeg sources This script needs to be invoked with a configuration file as its first argument tests fate sh path to fate_config A configuration file template with comments describing the individual configuration variables can be found at ‘doc fate_config sh template’ Create a configuration that suits your based on the configuration template The ‘slot’ configuration variable can be any string that is not yet but it is suggested that you name it adhering to the following pattern ‘ARCH OS COMPILER COMPILER VERSION’ The configuration file itself will be sourced in a shell therefore all shell features may be used This enables you to setup the environment as you need it for your build For your first test runs the ‘fate_recv’ variable should be empty or commented out This will run everything as normal except that it will omit the submission of the results to the server The following files should be present in $workdir as specified in the configuration it may help to try out the ‘ssh’ command with one or more ‘ v’ options You should get detailed output concerning your SSH configuration and the authentication process The only thing left is to automate the execution of the fate sh script and the synchronisation of the samples directory Uploading new samples to the fate suite *****************************************If you need a sample uploaded send a mail to samples request This is for developers who have an account on the fate suite server If you upload new please make sure they are as small as space on each network bandwidth and so on benefit from smaller test cases Also keep in mind older checkouts use existing sample that means in practice generally do not remove or overwrite files as it likely would break older checkouts or releases Also all needed samples for a commit should be ideally before the push If you need an account for frequently uploading samples or you wish to help others by doing that send a mail to ffmpeg devel rsync vauL Duo ug o o w
Definition: fate.txt:150
get_category
static AVClassCategory get_category(void *ptr)
Definition: options.c:73
AVCodecContext
main external API structure.
Definition: avcodec.h:526
AV_OPT_TYPE_INT
@ AV_OPT_TYPE_INT
Definition: opt.h:223
AV_OPT_TYPE_FLAGS
@ AV_OPT_TYPE_FLAGS
Definition: opt.h:222
flags
#define flags(name, subs,...)
Definition: cbs_av1.c:564
avcodec_options
static const AVOption avcodec_options[]
Definition: options_table.h:45
FOFFSET
#define FOFFSET(x)
Definition: options.c:300
AV_CLASS_CATEGORY_ENCODER
@ AV_CLASS_CATEGORY_ENCODER
Definition: log.h:35
h
h
Definition: vp9dsp_template.c:2038
context_to_name
FF_DISABLE_DEPRECATION_WARNINGS static const FF_ENABLE_DEPRECATION_WARNINGS char * context_to_name(void *ptr)
Definition: options.c:39