third_party_ffmpeg/doc
Philip Langdale 22b25b3ea5 avcodec: Add explicit capability flag for encoder flushing
Previously, there was no way to flush an encoder such that after
draining, the encoder could be used again. We generally suggested
that clients teardown and replace the encoder instance in these
situations. However, for at least some hardware encoders, the cost of
this tear down/replace cycle is very high, which can get in the way of
some use-cases - for example: segmented encoding with nvenc.

To help address that use case, we added support for calling
avcodec_flush_buffers() to nvenc and things worked in practice,
although it was not clearly documented as to whether this should work
or not. There was only one previous example of an encoder implementing
the flush callback (audiotoolboxenc) and it's unclear if that was
intentional or not. However, it was clear that calling
avocdec_flush_buffers() on any other encoder would leave the encoder in
an undefined state, and that's not great.

As part of cleaning this up, this change introduces a formal capability
flag for encoders that support flushing and ensures a flush call is a
no-op for any other encoder. This allows client code to check if it is
meaningful to call flush on an encoder before actually doing it.

I have not attempted to separate the steps taken inside
avcodec_flush_buffers() because it's not doing anything that's wrong
for an encoder. But I did add a sanity check to reject attempts to
flush a frame threaded encoder because I couldn't wrap my head around
whether that code path was actually safe or not. As this combination
doesn't exist today, we'll deal with it if it ever comes up.
2020-04-15 14:54:42 -07:00
..
doxy Merge commit '257f00ec1ab06a2a161f535036c6512f3fc8e801' 2016-06-22 11:28:51 +02:00
examples examples/avio_dir_cmd: drop support for move/delete operations 2020-03-16 09:23:37 +01:00
.gitignore Merge commit '257f00ec1ab06a2a161f535036c6512f3fc8e801' 2016-06-22 11:28:51 +02:00
APIchanges avcodec: Add explicit capability flag for encoder flushing 2020-04-15 14:54:42 -07:00
authors.texi
bitstream_filters.texi doc/bitstream_filters: Fix copy an paste typo 2019-11-05 21:21:32 +01:00
bootstrap.min.css
build_system.txt tools: add a fuzzer tool for bitstream filters 2019-12-05 20:49:15 -03:00
codecs.texi avcodec: add an AVCodecContext flag to export PRFT side data on demand 2020-02-22 23:19:07 -03:00
decoders.texi avcodec/libzvbi-teletextdec: add option to set default G0 character set 2020-02-24 00:14:21 +01:00
default.css
demuxers.texi doc/demuxers: update mov section 2020-03-06 11:05:30 +05:30
developer.texi doc/developer.texi: Add variadic macros to allowed C language features 2020-03-26 19:29:54 +01:00
devices.texi
doxy-wrapper.sh doc: make apidoc output independent of SRC_PATH 2016-01-02 12:11:36 +01:00
Doxyfile doc: fix spelling errors 2016-10-21 23:58:47 +02:00
encoders.texi avcodec/libaomenc.c: Add a libaom command-line option 'tune' 2020-04-11 15:12:34 -07:00
errno.txt doc/errno: fix description typo for ENAMETOOLONG 2015-12-18 04:04:14 +01:00
faq.texi doc/faq: update macOS and URLs 2019-02-11 10:13:31 +05:30
fate_config.sh.template Merge commit '35d1f726eb9fdd376ab900587fb02122b72f2b9a' 2017-05-05 09:27:18 +02:00
fate.texi doc/fate: Document how to request samples upload access 2019-08-09 01:33:49 +02:00
ffmpeg-bitstream-filters.texi Remove the ffserver program 2018-01-06 18:31:37 +00:00
ffmpeg-codecs.texi Remove the ffserver program 2018-01-06 18:31:37 +00:00
ffmpeg-devices.texi Remove the ffserver program 2018-01-06 18:31:37 +00:00
ffmpeg-filters.texi Remove the ffserver program 2018-01-06 18:31:37 +00:00
ffmpeg-formats.texi Remove the ffserver program 2018-01-06 18:31:37 +00:00
ffmpeg-protocols.texi Remove the ffserver program 2018-01-06 18:31:37 +00:00
ffmpeg-resampler.texi Remove the ffserver program 2018-01-06 18:31:37 +00:00
ffmpeg-scaler.texi Remove the ffserver program 2018-01-06 18:31:37 +00:00
ffmpeg-utils.texi Remove the ffserver program 2018-01-06 18:31:37 +00:00
ffmpeg.texi doc/ffmpeg: Document device selection for Vulkan 2020-02-09 20:36:45 +00:00
ffmpeg.txt
ffplay.texi ffplay: always show stats at all log levels if requested by user 2020-04-04 15:17:24 +05:30
ffprobe.texi doc/ffprobe: fix typo and update URL in man 2019-02-09 20:01:18 +01:00
ffprobe.xsd fftools/ffprobe: Add S12M Timecode output as side data (such as SEI TC) 2019-05-27 00:28:34 +02:00
fftools-common-opts.texi avutil/log: drop support for NO_COLOR environment variable 2020-02-09 20:31:44 +01:00
filter_design.txt doc: update filter_design.txt. 2017-09-12 11:03:51 +02:00
filters.texi doc/filters: clarify metadata and logging for blackdetect 2020-04-13 11:23:24 +05:30
formats.texi avformat: Add max_probe_packets option 2019-11-03 11:52:32 +01:00
general.texi doc/general: update avisynth docs with a way to install just the headers using CMake 2020-04-05 11:51:08 +02:00
git-howto.texi Merge commit '41ed7ab45fc693f7d7fc35664c0233f4c32d69bb' 2016-06-21 21:55:34 +02:00
indevs.texi avdevice/decklink: deprecate the -list_devices option 2020-01-03 18:13:22 +01:00
issue_tracker.txt Remove the ffserver program 2018-01-06 18:31:37 +00:00
lexicon doc: add a lexicon 2017-02-03 15:03:44 +01:00
libav-merge.txt doc/libav-merge: add a line about the previous skipped merge 2019-02-20 13:51:19 -03:00
libavcodec.texi Remove the ffserver program 2018-01-06 18:31:37 +00:00
libavdevice.texi Remove the ffserver program 2018-01-06 18:31:37 +00:00
libavfilter.texi Remove the ffserver program 2018-01-06 18:31:37 +00:00
libavformat.texi Remove the ffserver program 2018-01-06 18:31:37 +00:00
libavutil.texi Remove the ffserver program 2018-01-06 18:31:37 +00:00
libswresample.texi Remove the ffserver program 2018-01-06 18:31:37 +00:00
libswscale.texi Remove the ffserver program 2018-01-06 18:31:37 +00:00
mailing-list-faq.texi doc/mailing-list-faq: auto unsubscribe due to DMARC 2019-04-20 13:55:39 -08:00
Makefile doc: Add mailing list FAQ 2017-10-03 15:25:07 -08:00
metadata.texi doc/metadata: fix error in timebase description 2018-12-14 12:57:34 +01:00
mips.txt Edit documentation and versioning for the fixed point AAC decoder 2015-07-22 23:25:33 +02:00
multithreading.txt pthread_frame: merge the functionality for normal decoder init and init_thread_copy 2020-04-10 15:24:54 +02:00
muxers.texi avformat/hlsenc: add hls_fmp4_init_resend option 2020-04-15 12:45:16 +08:00
nut.texi Merge commit '41ed7ab45fc693f7d7fc35664c0233f4c32d69bb' 2016-06-21 21:55:34 +02:00
optimization.txt build: Prefer NASM assembler over YASM 2017-06-21 17:00:30 -03:00
outdevs.texi doc/outdevs: Mention "sdl2" alias for "sdl". 2020-01-26 13:15:07 +01:00
patchwork doc/patchwork: Document the patchwork states 2016-10-26 19:46:00 +02:00
platform.texi configure: error out on unsupported MSVC versions 2018-05-18 02:22:57 +01:00
print_options.c Merge commit '2025d3787158ba272a1b8fbc0493fa20dd7a8484' 2017-03-29 15:20:10 +02:00
protocols.texi avformat/libzmq: Make default pkt_size value consistent with amqp 2020-03-09 22:07:18 +01: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/swscaler: explain default Lanczos parameter 2019-05-27 21:32:33 +05:30
snow.txt doc/snow: fix typos 2019-02-10 16:46:56 +01:00
style.min.css
swresample.txt
swscale.txt cosmetics: Fix spelling mistakes 2016-05-04 18:16:21 +02:00
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
undefined.txt doc: Add initial documentation explaining undefined behavior and SUINT 2017-07-21 17:37:05 +02:00
utils.texi doc/utils: add hexadecagonal channel layout 2019-10-19 13:00:36 +05:30
writing_filters.txt doc/writing_filters: Use ff_filter_get_nb_threads() get number of threads 2019-05-22 17:43:41 +08:00