1
0
mirror of https://github.com/FFmpeg/FFmpeg.git synced 2025-08-10 06:10:52 +02:00

lavu/fifo: clarify interaction of AV_FIFO_FLAG_AUTO_GROW with av_fifo_write()

This commit is contained in:
Anton Khirnov
2022-06-30 16:23:46 +02:00
parent 8728808b3e
commit ea5b375e0e

View File

@@ -124,9 +124,12 @@ int av_fifo_grow2(AVFifo *f, size_t inc);
/** /**
* Write data into a FIFO. * 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. * is returned.
* *
* Calling function is guaranteed to succeed if nb_elems <= av_fifo_can_write(f).
*
* @param f the FIFO buffer * @param f the FIFO buffer
* @param buf Data to be written. nb_elems * av_fifo_elem_size(f) bytes will be * @param buf Data to be written. nb_elems * av_fifo_elem_size(f) bytes will be
* read from buf on success. * read from buf on success.