lavc/avcodec: Improve av_parser_parse() documentation, mention padding.
authorCarl Eugen Hoyos <cehoyos@ag.or.at>
Sun, 4 Sep 2016 20:03:12 +0000 (22:03 +0200)
committerCarl Eugen Hoyos <cehoyos@ag.or.at>
Wed, 7 Sep 2016 16:37:01 +0000 (18:37 +0200)
Fixes ticket #5809.

libavcodec/avcodec.h

index 4d92f69..01f9b29 100644 (file)
@@ -5146,7 +5146,10 @@ AVCodecParserContext *av_parser_init(int codec_id);
  * @param poutbuf       set to pointer to parsed buffer or NULL if not yet finished.
  * @param poutbuf_size  set to size of parsed buffer or zero if not yet finished.
  * @param buf           input buffer.
- * @param buf_size      input length, to signal EOF, this should be 0 (so that the last frame can be output).
+ * @param buf_size      buffer size in bytes without the padding. I.e. the full buffer
+                        size is assumed to be buf_size + AV_INPUT_BUFFER_PADDING_SIZE.
+                        To signal EOF, this should be 0 (so that the last frame
+                        can be output).
  * @param pts           input presentation timestamp.
  * @param dts           input decoding timestamp.
  * @param pos           input byte position in stream.