diff options
| author | Anton Khirnov <anton@khirnov.net> | 2022-06-30 16:23:46 +0200 |
|---|---|---|
| committer | Anton Khirnov <anton@khirnov.net> | 2022-09-05 08:59:36 +0200 |
| commit | ea5b375e0e95b05c88ec728d5953c916b4925bef (patch) | |
| tree | 0b5c7034b55318b6c22766f888be8ae45440d8b8 /libavutil/fifo.h | |
| parent | 8728808b3eadae96595cfc22424ae877d9276789 (diff) | |
| download | ffmpeg-ea5b375e0e95b05c88ec728d5953c916b4925bef.tar.gz | |
lavu/fifo: clarify interaction of AV_FIFO_FLAG_AUTO_GROW with av_fifo_write()
Diffstat (limited to 'libavutil/fifo.h')
| -rw-r--r-- | libavutil/fifo.h | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/libavutil/fifo.h b/libavutil/fifo.h index 89872d0972..70f9376d97 100644 --- a/libavutil/fifo.h +++ b/libavutil/fifo.h @@ -124,9 +124,12 @@ int av_fifo_grow2(AVFifo *f, size_t inc); /** * Write data into a FIFO. * - * In case nb_elems > av_fifo_can_write(f), nothing is written and an error + * In case nb_elems > av_fifo_can_write(f) and the AV_FIFO_FLAG_AUTO_GROW flag + * was not specified at FIFO creation, nothing is written and an error * is returned. * + * Calling function is guaranteed to succeed if nb_elems <= av_fifo_can_write(f). + * * @param f the FIFO buffer * @param buf Data to be written. nb_elems * av_fifo_elem_size(f) bytes will be * read from buf on success. |