/*
* Copyright ( c ) 2000 , 2001 , 2002 Fabrice Bellard
*
* This file is part of FFmpeg .
*
* FFmpeg is free software ; you can redistribute it and / or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation ; either
* version 2.1 of the License , or ( at your option ) any later version .
*
* FFmpeg is distributed in the hope that it will be useful ,
* but WITHOUT ANY WARRANTY ; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE . See the GNU
* Lesser General Public License for more details .
*
* You should have received a copy of the GNU Lesser General Public
* License along with FFmpeg ; if not , write to the Free Software
* Foundation , Inc . , 51 Franklin Street , Fifth Floor , Boston , MA 02110 - 1301 USA
*/
# ifndef AVFORMAT_OPTIONS_TABLE_H
# define AVFORMAT_OPTIONS_TABLE_H
# include <limits.h>
# include "libavutil/opt.h"
# include "avformat.h"
# include "internal.h"
# define OFFSET(x) offsetof(AVFormatContext,x)
# define DEFAULT 0 //should be NAN but it does not work as it is not a constant in glibc as required by ANSI/ISO C
//these names are too long to be readable
# define E AV_OPT_FLAG_ENCODING_PARAM
# define D AV_OPT_FLAG_DECODING_PARAM
static const AVOption avformat_options [ ] = {
{ " avioflags " , NULL , OFFSET ( avio_flags ) , AV_OPT_TYPE_FLAGS , { . i64 = DEFAULT } , INT_MIN , INT_MAX , D | E , " avioflags " } ,
{ " direct " , " reduce buffering " , 0 , AV_OPT_TYPE_CONST , { . i64 = AVIO_FLAG_DIRECT } , INT_MIN , INT_MAX , D | E , " avioflags " } ,
{ " probesize " , " set probing size " , OFFSET ( probesize ) , AV_OPT_TYPE_INT64 , { . i64 = 5000000 } , 32 , INT64_MAX , D } ,
{ " formatprobesize " , " number of bytes to probe file format " , OFFSET ( format_probesize ) , AV_OPT_TYPE_INT , { . i64 = PROBE_BUF_MAX } , 0 , INT_MAX - 1 , D } ,
{ " packetsize " , " set packet size " , OFFSET ( packet_size ) , AV_OPT_TYPE_INT , { . i64 = DEFAULT } , 0 , INT_MAX , E } ,
{ " fflags " , NULL , OFFSET ( flags ) , AV_OPT_TYPE_FLAGS , { . i64 = AVFMT_FLAG_AUTO_BSF } , INT_MIN , INT_MAX , D | E , " fflags " } ,
{ " flush_packets " , " reduce the latency by flushing out packets immediately " , 0 , AV_OPT_TYPE_CONST , { . i64 = AVFMT_FLAG_FLUSH_PACKETS } , INT_MIN , INT_MAX , E , " fflags " } ,
{ " ignidx " , " ignore index " , 0 , AV_OPT_TYPE_CONST , { . i64 = AVFMT_FLAG_IGNIDX } , INT_MIN , INT_MAX , D , " fflags " } ,
{ " genpts " , " generate pts " , 0 , AV_OPT_TYPE_CONST , { . i64 = AVFMT_FLAG_GENPTS } , INT_MIN , INT_MAX , D , " fflags " } ,
{ " nofillin " , " do not fill in missing values that can be exactly calculated " , 0 , AV_OPT_TYPE_CONST , { . i64 = AVFMT_FLAG_NOFILLIN } , INT_MIN , INT_MAX , D , " fflags " } ,
{ " noparse " , " disable AVParsers, this needs nofillin too " , 0 , AV_OPT_TYPE_CONST , { . i64 = AVFMT_FLAG_NOPARSE } , INT_MIN , INT_MAX , D , " fflags " } ,
{ " igndts " , " ignore dts " , 0 , AV_OPT_TYPE_CONST , { . i64 = AVFMT_FLAG_IGNDTS } , INT_MIN , INT_MAX , D , " fflags " } ,
{ " discardcorrupt " , " discard corrupted frames " , 0 , AV_OPT_TYPE_CONST , { . i64 = AVFMT_FLAG_DISCARD_CORRUPT } , INT_MIN , INT_MAX , D , " fflags " } ,
{ " sortdts " , " try to interleave outputted packets by dts " , 0 , AV_OPT_TYPE_CONST , { . i64 = AVFMT_FLAG_SORT_DTS } , INT_MIN , INT_MAX , D , " fflags " } ,
avcodec, avformat: deprecate anything related to side data merging
This patch deprecates anything that has to do with merging/splitting
side data. Automatic side data merging (and splitting), as well as all
API symbols involved in it, are removed completely.
Two FF_API_ defines are dedicated to deprecating API symbols related to
this: FF_API_MERGE_SD_API removes av_packet_split/merge_side_data in
libavcodec, and FF_API_LAVF_KEEPSIDE_FLAG deprecates
AVFMT_FLAG_KEEP_SIDE_DATA in libavformat.
Since it was claimed that changing the default from merging side data to
not doing it is an ABI change, there are two additional FF_API_ defines,
which stop using the side data merging/splitting by default (and remove
any code in avformat/avcodec doing this): FF_API_MERGE_SD in libavcodec,
and FF_API_LAVF_MERGE_SD in libavformat.
It is very much intended that FF_API_MERGE_SD and FF_API_LAVF_MERGE_SD
are quickly defined to 0 in the next ABI bump, while the API symbols are
retained for a longer time for the sake of compatibility.
AVFMT_FLAG_KEEP_SIDE_DATA will (very much intentionally) do nothing for
most of the time it will still be defined. Keep in mind that no code
exists that actually tries to unset this flag for any reason, nor does
such code need to exist. Code setting this flag explicitly will work as
before. Thus it's ok for AVFMT_FLAG_KEEP_SIDE_DATA to do nothing once
side data merging has been removed from libavformat.
In order to avoid that anyone in the future does this incorrectly, here
is a small guide how to update the internal code on bumps:
- next ABI bump (probably soon):
- define FF_API_LAVF_MERGE_SD to 0, and remove all code covered by it
- define FF_API_MERGE_SD to 0, and remove all code covered by it
- next API bump (typically two years in the future or so):
- define FF_API_LAVF_KEEPSIDE_FLAG to 0, and remove all code covered
by it
- define FF_API_MERGE_SD_API to 0, and remove all code covered by it
This forces anyone who actually wants packet side data to temporarily
use deprecated API to get it all. If you ask me, this is batshit fucked
up crazy, but it's how we roll. Making AVFMT_FLAG_KEEP_SIDE_DATA to be
set by default was rejected as an ABI change, so I'm going all the way
to get rid of this once and for all.
Reviewed-by: James Almer <jamrial@gmail.com>
Reviewed-by: Rostislav Pehlivanov <atomnuker@gmail.com>
Reviewed-by: Michael Niedermayer <michael@niedermayer.cc>
8 years ago
# if FF_API_LAVF_KEEPSIDE_FLAG
{ " keepside " , " deprecated, does nothing " , 0 , AV_OPT_TYPE_CONST , { . i64 = AVFMT_FLAG_KEEP_SIDE_DATA } , INT_MIN , INT_MAX , D , " fflags " } ,
avcodec, avformat: deprecate anything related to side data merging
This patch deprecates anything that has to do with merging/splitting
side data. Automatic side data merging (and splitting), as well as all
API symbols involved in it, are removed completely.
Two FF_API_ defines are dedicated to deprecating API symbols related to
this: FF_API_MERGE_SD_API removes av_packet_split/merge_side_data in
libavcodec, and FF_API_LAVF_KEEPSIDE_FLAG deprecates
AVFMT_FLAG_KEEP_SIDE_DATA in libavformat.
Since it was claimed that changing the default from merging side data to
not doing it is an ABI change, there are two additional FF_API_ defines,
which stop using the side data merging/splitting by default (and remove
any code in avformat/avcodec doing this): FF_API_MERGE_SD in libavcodec,
and FF_API_LAVF_MERGE_SD in libavformat.
It is very much intended that FF_API_MERGE_SD and FF_API_LAVF_MERGE_SD
are quickly defined to 0 in the next ABI bump, while the API symbols are
retained for a longer time for the sake of compatibility.
AVFMT_FLAG_KEEP_SIDE_DATA will (very much intentionally) do nothing for
most of the time it will still be defined. Keep in mind that no code
exists that actually tries to unset this flag for any reason, nor does
such code need to exist. Code setting this flag explicitly will work as
before. Thus it's ok for AVFMT_FLAG_KEEP_SIDE_DATA to do nothing once
side data merging has been removed from libavformat.
In order to avoid that anyone in the future does this incorrectly, here
is a small guide how to update the internal code on bumps:
- next ABI bump (probably soon):
- define FF_API_LAVF_MERGE_SD to 0, and remove all code covered by it
- define FF_API_MERGE_SD to 0, and remove all code covered by it
- next API bump (typically two years in the future or so):
- define FF_API_LAVF_KEEPSIDE_FLAG to 0, and remove all code covered
by it
- define FF_API_MERGE_SD_API to 0, and remove all code covered by it
This forces anyone who actually wants packet side data to temporarily
use deprecated API to get it all. If you ask me, this is batshit fucked
up crazy, but it's how we roll. Making AVFMT_FLAG_KEEP_SIDE_DATA to be
set by default was rejected as an ABI change, so I'm going all the way
to get rid of this once and for all.
Reviewed-by: James Almer <jamrial@gmail.com>
Reviewed-by: Rostislav Pehlivanov <atomnuker@gmail.com>
Reviewed-by: Michael Niedermayer <michael@niedermayer.cc>
8 years ago
# endif
{ " fastseek " , " fast but inaccurate seeks " , 0 , AV_OPT_TYPE_CONST , { . i64 = AVFMT_FLAG_FAST_SEEK } , INT_MIN , INT_MAX , D , " fflags " } ,
# if FF_API_LAVF_MP4A_LATM
{ " latm " , " deprecated, does nothing " , 0 , AV_OPT_TYPE_CONST , { . i64 = AVFMT_FLAG_MP4A_LATM } , INT_MIN , INT_MAX , E , " fflags " } ,
# endif
{ " nobuffer " , " reduce the latency introduced by optional buffering " , 0 , AV_OPT_TYPE_CONST , { . i64 = AVFMT_FLAG_NOBUFFER } , 0 , INT_MAX , D , " fflags " } ,
{ " bitexact " , " do not write random/volatile data " , 0 , AV_OPT_TYPE_CONST , { . i64 = AVFMT_FLAG_BITEXACT } , 0 , 0 , E , " fflags " } ,
{ " shortest " , " stop muxing with the shortest stream " , 0 , AV_OPT_TYPE_CONST , { . i64 = AVFMT_FLAG_SHORTEST } , 0 , 0 , E , " fflags " } ,
{ " autobsf " , " add needed bsfs automatically " , 0 , AV_OPT_TYPE_CONST , { . i64 = AVFMT_FLAG_AUTO_BSF } , 0 , 0 , E , " fflags " } ,
{ " seek2any " , " allow seeking to non-keyframes on demuxer level when supported " , OFFSET ( seek2any ) , AV_OPT_TYPE_BOOL , { . i64 = 0 } , 0 , 1 , D } ,
{ " analyzeduration " , " specify how many microseconds are analyzed to probe the input " , OFFSET ( max_analyze_duration ) , AV_OPT_TYPE_INT64 , { . i64 = 0 } , 0 , INT64_MAX , D } ,
{ " cryptokey " , " decryption key " , OFFSET ( key ) , AV_OPT_TYPE_BINARY , { . dbl = 0 } , 0 , 0 , D } ,
{ " indexmem " , " max memory used for timestamp index (per stream) " , OFFSET ( max_index_size ) , AV_OPT_TYPE_INT , { . i64 = 1 < < 20 } , 0 , INT_MAX , D } ,
{ " rtbufsize " , " max memory used for buffering real-time frames " , OFFSET ( max_picture_buffer ) , AV_OPT_TYPE_INT , { . i64 = 3041280 } , 0 , INT_MAX , D } , /* defaults to 1s of 15fps 352x288 YUYV422 video */
{ " fdebug " , " print specific debug info " , OFFSET ( debug ) , AV_OPT_TYPE_FLAGS , { . i64 = DEFAULT } , 0 , INT_MAX , E | D , " fdebug " } ,
{ " ts " , NULL , 0 , AV_OPT_TYPE_CONST , { . i64 = FF_FDEBUG_TS } , INT_MIN , INT_MAX , E | D , " fdebug " } ,
{ " max_delay " , " maximum muxing or demuxing delay in microseconds " , OFFSET ( max_delay ) , AV_OPT_TYPE_INT , { . i64 = - 1 } , - 1 , INT_MAX , E | D } ,
{ " start_time_realtime " , " wall-clock time when stream begins (PTS==0) " , OFFSET ( start_time_realtime ) , AV_OPT_TYPE_INT64 , { . i64 = AV_NOPTS_VALUE } , INT64_MIN , INT64_MAX , E } ,
{ " fpsprobesize " , " number of frames used to probe fps " , OFFSET ( fps_probe_size ) , AV_OPT_TYPE_INT , { . i64 = - 1 } , - 1 , INT_MAX - 1 , D } ,
{ " audio_preload " , " microseconds by which audio packets should be interleaved earlier " , OFFSET ( audio_preload ) , AV_OPT_TYPE_INT , { . i64 = 0 } , 0 , INT_MAX - 1 , E } ,
{ " chunk_duration " , " microseconds for each chunk " , OFFSET ( max_chunk_duration ) , AV_OPT_TYPE_INT , { . i64 = 0 } , 0 , INT_MAX - 1 , E } ,
{ " chunk_size " , " size in bytes for each chunk " , OFFSET ( max_chunk_size ) , AV_OPT_TYPE_INT , { . i64 = 0 } , 0 , INT_MAX - 1 , E } ,
/* this is a crutch for avconv, since it cannot deal with identically named options in different contexts.
* to be removed when avconv is fixed */
{ " f_err_detect " , " set error detection flags (deprecated; use err_detect, save via avconv) " , OFFSET ( error_recognition ) , AV_OPT_TYPE_FLAGS , { . i64 = AV_EF_CRCCHECK } , INT_MIN , INT_MAX , D , " err_detect " } ,
{ " err_detect " , " set error detection flags " , OFFSET ( error_recognition ) , AV_OPT_TYPE_FLAGS , { . i64 = AV_EF_CRCCHECK } , INT_MIN , INT_MAX , D , " err_detect " } ,
{ " crccheck " , " verify embedded CRCs " , 0 , AV_OPT_TYPE_CONST , { . i64 = AV_EF_CRCCHECK } , INT_MIN , INT_MAX , D , " err_detect " } ,
{ " bitstream " , " detect bitstream specification deviations " , 0 , AV_OPT_TYPE_CONST , { . i64 = AV_EF_BITSTREAM } , INT_MIN , INT_MAX , D , " err_detect " } ,
{ " buffer " , " detect improper bitstream length " , 0 , AV_OPT_TYPE_CONST , { . i64 = AV_EF_BUFFER } , INT_MIN , INT_MAX , D , " err_detect " } ,
{ " explode " , " abort decoding on minor error detection " , 0 , AV_OPT_TYPE_CONST , { . i64 = AV_EF_EXPLODE } , INT_MIN , INT_MAX , D , " err_detect " } ,
{ " ignore_err " , " ignore errors " , 0 , AV_OPT_TYPE_CONST , { . i64 = AV_EF_IGNORE_ERR } , INT_MIN , INT_MAX , D , " err_detect " } ,
{ " careful " , " consider things that violate the spec, are fast to check and have not been seen in the wild as errors " , 0 , AV_OPT_TYPE_CONST , { . i64 = AV_EF_CAREFUL } , INT_MIN , INT_MAX , D , " err_detect " } ,
{ " compliant " , " consider all spec non compliancies as errors " , 0 , AV_OPT_TYPE_CONST , { . i64 = AV_EF_COMPLIANT | AV_EF_CAREFUL } , INT_MIN , INT_MAX , D , " err_detect " } ,
{ " aggressive " , " consider things that a sane encoder shouldn't do as an error " , 0 , AV_OPT_TYPE_CONST , { . i64 = AV_EF_AGGRESSIVE | AV_EF_COMPLIANT | AV_EF_CAREFUL } , INT_MIN , INT_MAX , D , " err_detect " } ,
{ " use_wallclock_as_timestamps " , " use wallclock as timestamps " , OFFSET ( use_wallclock_as_timestamps ) , AV_OPT_TYPE_BOOL , { . i64 = 0 } , 0 , 1 , D } ,
{ " skip_initial_bytes " , " set number of bytes to skip before reading header and frames " , OFFSET ( skip_initial_bytes ) , AV_OPT_TYPE_INT64 , { . i64 = 0 } , 0 , INT64_MAX - 1 , D } ,
{ " correct_ts_overflow " , " correct single timestamp overflows " , OFFSET ( correct_ts_overflow ) , AV_OPT_TYPE_BOOL , { . i64 = 1 } , 0 , 1 , D } ,
{ " flush_packets " , " enable flushing of the I/O context after each packet " , OFFSET ( flush_packets ) , AV_OPT_TYPE_INT , { . i64 = - 1 } , - 1 , 1 , E } ,
{ " metadata_header_padding " , " set number of bytes to be written as padding in a metadata header " , OFFSET ( metadata_header_padding ) , AV_OPT_TYPE_INT , { . i64 = - 1 } , - 1 , INT_MAX , E } ,
{ " output_ts_offset " , " set output timestamp offset " , OFFSET ( output_ts_offset ) , AV_OPT_TYPE_DURATION , { . i64 = 0 } , - INT64_MAX , INT64_MAX , E } ,
{ " max_interleave_delta " , " maximum buffering duration for interleaving " , OFFSET ( max_interleave_delta ) , AV_OPT_TYPE_INT64 , { . i64 = 10000000 } , 0 , INT64_MAX , E } ,
{ " f_strict " , " how strictly to follow the standards (deprecated; use strict, save via avconv) " , OFFSET ( strict_std_compliance ) , AV_OPT_TYPE_INT , { . i64 = DEFAULT } , INT_MIN , INT_MAX , D | E , " strict " } ,
{ " strict " , " how strictly to follow the standards " , OFFSET ( strict_std_compliance ) , AV_OPT_TYPE_INT , { . i64 = DEFAULT } , INT_MIN , INT_MAX , D | E , " strict " } ,
{ " very " , " strictly conform to a older more strict version of the spec or reference software " , 0 , AV_OPT_TYPE_CONST , { . i64 = FF_COMPLIANCE_VERY_STRICT } , INT_MIN , INT_MAX , D | E , " strict " } ,
{ " strict " , " strictly conform to all the things in the spec no matter what the consequences " , 0 , AV_OPT_TYPE_CONST , { . i64 = FF_COMPLIANCE_STRICT } , INT_MIN , INT_MAX , D | E , " strict " } ,
{ " normal " , NULL , 0 , AV_OPT_TYPE_CONST , { . i64 = FF_COMPLIANCE_NORMAL } , INT_MIN , INT_MAX , D | E , " strict " } ,
{ " unofficial " , " allow unofficial extensions " , 0 , AV_OPT_TYPE_CONST , { . i64 = FF_COMPLIANCE_UNOFFICIAL } , INT_MIN , INT_MAX , D | E , " strict " } ,
{ " experimental " , " allow non-standardized experimental variants " , 0 , AV_OPT_TYPE_CONST , { . i64 = FF_COMPLIANCE_EXPERIMENTAL } , INT_MIN , INT_MAX , D | E , " strict " } ,
{ " max_ts_probe " , " maximum number of packets to read while waiting for the first timestamp " , OFFSET ( max_ts_probe ) , AV_OPT_TYPE_INT , { . i64 = 50 } , 0 , INT_MAX , D } ,
{ " avoid_negative_ts " , " shift timestamps so they start at 0 " , OFFSET ( avoid_negative_ts ) , AV_OPT_TYPE_INT , { . i64 = - 1 } , - 1 , 2 , E , " avoid_negative_ts " } ,
{ " auto " , " enabled when required by target format " , 0 , AV_OPT_TYPE_CONST , { . i64 = AVFMT_AVOID_NEG_TS_AUTO } , INT_MIN , INT_MAX , E , " avoid_negative_ts " } ,
{ " disabled " , " do not change timestamps " , 0 , AV_OPT_TYPE_CONST , { . i64 = 0 } , INT_MIN , INT_MAX , E , " avoid_negative_ts " } ,
{ " make_non_negative " , " shift timestamps so they are non negative " , 0 , AV_OPT_TYPE_CONST , { . i64 = AVFMT_AVOID_NEG_TS_MAKE_NON_NEGATIVE } , INT_MIN , INT_MAX , E , " avoid_negative_ts " } ,
{ " make_zero " , " shift timestamps so they start at 0 " , 0 , AV_OPT_TYPE_CONST , { . i64 = AVFMT_AVOID_NEG_TS_MAKE_ZERO } , INT_MIN , INT_MAX , E , " avoid_negative_ts " } ,
{ " dump_separator " , " set information dump field separator " , OFFSET ( dump_separator ) , AV_OPT_TYPE_STRING , { . str = " , " } , 0 , 0 , D | E } ,
{ " codec_whitelist " , " List of decoders that are allowed to be used " , OFFSET ( codec_whitelist ) , AV_OPT_TYPE_STRING , { . str = NULL } , 0 , 0 , D } ,
{ " format_whitelist " , " List of demuxers that are allowed to be used " , OFFSET ( format_whitelist ) , AV_OPT_TYPE_STRING , { . str = NULL } , 0 , 0 , D } ,
{ " protocol_whitelist " , " List of protocols that are allowed to be used " , OFFSET ( protocol_whitelist ) , AV_OPT_TYPE_STRING , { . str = NULL } , 0 , 0 , D } ,
{ " protocol_blacklist " , " List of protocols that are not allowed to be used " , OFFSET ( protocol_blacklist ) , AV_OPT_TYPE_STRING , { . str = NULL } , 0 , 0 , D } ,
{ " max_streams " , " maximum number of streams " , OFFSET ( max_streams ) , AV_OPT_TYPE_INT , { . i64 = 1000 } , 0 , INT_MAX , D } ,
{ " skip_estimate_duration_from_pts " , " skip duration calculation in estimate_timings_from_pts " , OFFSET ( skip_estimate_duration_from_pts ) , AV_OPT_TYPE_BOOL , { . i64 = 0 } , 0 , 1 , D } ,
{ " max_probe_packets " , " Maximum number of packets to probe a codec " , OFFSET ( max_probe_packets ) , AV_OPT_TYPE_INT , { . i64 = 2500 } , 0 , INT_MAX , D } ,
{ NULL } ,
} ;
# undef E
# undef D
# undef DEFAULT
# undef OFFSET
# endif /* AVFORMAT_OPTIONS_TABLE_H */
