ffmpeg/doc
wm4 d682ae70b4 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>
2017-03-21 06:13:45 +01:00
..
doxy
examples Merge commit '9833a406d3d743d238e4cbee08ffcaa12e067dd2' 2017-01-31 17:35:41 +01:00
.gitignore
APIchanges avcodec, avformat: deprecate anything related to side data merging 2017-03-21 06:13:45 +01:00
authors.texi
bitstream_filters.texi doc/bsfs: various improvements 2016-11-17 10:49:51 -09:00
bootstrap.min.css
build_system.txt
codecs.texi doc: document cutoff option to ac3 and adjust the option's global documentation 2016-12-31 17:20:06 +01:00
decoders.texi cosmetics: fix some misspelled words 2016-07-17 13:10:27 -03:00
default.css
demuxers.texi doc: Add muxers/demuxers list option 2017-02-11 02:59:32 +01:00
developer.texi doc/developer: Mention mime type and patchwork in "Submitting patches" 2016-10-11 23:20:56 +02:00
devices.texi
doxy-wrapper.sh
Doxyfile doc: fix spelling errors 2016-10-21 23:58:47 +02:00
encoders.texi doc/encoders: mention valid values for compression_level when using FLAC encoder 2017-03-03 13:49:26 -03:00
errno.txt
faq.texi faq: use relative links to own documentation 2016-10-23 11:55:53 +02:00
fate_config.sh.template
fate.texi Merge commit '963b3ab11f98fcc4a311f0dc7b268890c5675da2' 2017-03-19 18:34:48 +01:00
ffmpeg-bitstream-filters.texi
ffmpeg-codecs.texi
ffmpeg-devices.texi
ffmpeg-filters.texi
ffmpeg-formats.texi
ffmpeg-protocols.texi
ffmpeg-resampler.texi
ffmpeg-scaler.texi
ffmpeg-utils.texi
ffmpeg.texi doc/ffmpeg: document trailing "?" in map option 2017-02-13 15:26:43 -09:00
ffmpeg.txt
ffplay.texi ffplay: allow borderless playback windows 2017-02-01 22:03:26 +01:00
ffprobe.texi Avoid using the term "file" and prefer "url" in some docs and comments 2016-12-05 21:30:12 +01:00
ffprobe.xsd lavf: add AV_DISPOSITION_TIMED_THUMBNAILS 2016-10-24 05:47:05 -05:00
ffserver.conf lavc: remove libfaac wrapper 2016-10-01 19:58:04 +01:00
ffserver.texi
fftools-common-opts.texi doc: Add muxers/demuxers list option 2017-02-11 02:59:32 +01:00
filter_design.txt
filters.texi add signature filter for MPEG7 video signature 2017-03-21 00:11:08 +01:00
formats.texi avformat: Add max_streams option 2016-12-08 18:25:30 +01:00
general.texi avcodec: add XPM decoder and demuxer 2017-03-12 18:24:49 +01:00
git-howto.texi
indevs.texi doc: remove remaining legacy x11grab references 2017-03-15 22:23:00 +01:00
issue_tracker.txt
lexicon doc: add a lexicon 2017-02-03 15:03:44 +01:00
libav-merge.txt Merge commit '75d642a944d5579e4ef20ff3701422a64692afcf' 2017-03-20 11:54:29 +01:00
libavcodec.texi
libavdevice.texi
libavfilter.texi
libavformat.texi
libavutil.texi
libswresample.texi
libswscale.texi
Makefile doc/examples: build http_multiclient example 2016-09-30 19:35:52 +02:00
metadata.texi
mips.txt
multithreading.txt
muxers.texi doc/muxers: cleanup mpegts section 2017-03-16 12:01:15 -08:00
nut.texi
optimization.txt
outdevs.texi avdevice/decklink_enc: add support to specify field order 2017-02-26 22:47:33 +01:00
patchwork doc/patchwork: Document the patchwork states 2016-10-26 19:46:00 +02:00
platform.texi doc: fix various typos and grammar errors 2016-10-11 16:57:46 +02:00
print_options.c
protocols.texi doc/protocols: add option usage description 2017-02-13 12:23:03 -09:00
rate_distortion.txt
resampler.texi swresample/options: enable linear_interp and exact_rational by default 2017-03-17 00:08:03 +07:00
scaler.texi doc/scaler: mention default scaling algorithm 2017-01-09 12:58:25 -09:00
snow.txt
style.min.css
swresample.txt
swscale.txt
t2h.init doc/t2h: use container 2016-10-03 00:16:27 +01:00
t2h.pm doc/t2h: use container 2016-10-03 00:16:27 +01:00
tablegen.txt
texi2pod.pl doc: escape left brace in texi2pod.pl regex 2016-07-10 13:34:57 +02:00
texidep.pl
utils.texi avutil/eval: add atan2 function 2017-01-30 11:04:31 +01:00
writing_filters.txt