diff mbox

[FFmpeg-devel] lavc/avcodec: Improve av_parser_parse() documentation

Message ID 201609042205.03590.cehoyos@ag.or.at
State Accepted
Commit 7a8e5ff1fd06c0363ed4bb26cda5262fcd925b74
Headers show

Commit Message

Carl Eugen Hoyos Sept. 4, 2016, 8:05 p.m. UTC
Hi!

Attached patch fixes ticket #5809.

Please comment, Carl Eugen
From 377749b388637c09f8822e501e53c565e7d4cb94 Mon Sep 17 00:00:00 2001
From: Carl Eugen Hoyos <cehoyos@ag.or.at>
Date: Sun, 4 Sep 2016 22:03:12 +0200
Subject: [PATCH] lavc/avcodec: Improve av_parser_parse() documentation,
 mention padding.

Fixes ticket #5809.
---
 libavcodec/avcodec.h |    5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

Comments

Michael Niedermayer Sept. 4, 2016, 8:41 p.m. UTC | #1
On Sun, Sep 04, 2016 at 10:05:03PM +0200, Carl Eugen Hoyos wrote:
> Hi!
> 
> Attached patch fixes ticket #5809.
> 
> Please comment, Carl Eugen

>  avcodec.h |    5 ++++-
>  1 file changed, 4 insertions(+), 1 deletion(-)
> 61bd44b05d7472493311c7f483ab03c0c74870a4  0001-lavc-avcodec-Improve-av_parser_parse-documentation-m.patch
> From 377749b388637c09f8822e501e53c565e7d4cb94 Mon Sep 17 00:00:00 2001
> From: Carl Eugen Hoyos <cehoyos@ag.or.at>
> Date: Sun, 4 Sep 2016 22:03:12 +0200
> Subject: [PATCH] lavc/avcodec: Improve av_parser_parse() documentation,
>  mention padding.
> 
> Fixes ticket #5809.
> ---
>  libavcodec/avcodec.h |    5 ++++-
>  1 file changed, 4 insertions(+), 1 deletion(-)

LGTM, but please wait a day or 2 to allow others to comment

thx

[...]
Carl Eugen Hoyos Sept. 7, 2016, 4:42 p.m. UTC | #2
2016-09-04 22:41 GMT+02:00 Michael Niedermayer <michael@niedermayer.cc>:

>> Fixes ticket #5809.
>> ---
>>  libavcodec/avcodec.h |    5 ++++-
>>  1 file changed, 4 insertions(+), 1 deletion(-)
>
> LGTM, but please wait a day or 2 to allow others to comment

Patch applied.

Thank you, Carl Eugen
diff mbox

Patch

diff --git a/libavcodec/avcodec.h b/libavcodec/avcodec.h
index e2dad5d..6b17892 100644
--- a/libavcodec/avcodec.h
+++ b/libavcodec/avcodec.h
@@ -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.