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

2 years ago · ea5b375e0e
parent 8728808b3e
commit ea5b375e0e
1 changed files with 4 additions and 1 deletions
--- 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.