diff mbox

[FFmpeg-devel,1/3] avcodec/avcodec.h: clarify decoupled decode/encode API docs

Message ID 20170315024758.8875-1-cus@passwd.hu
State Accepted
Commit 51546504133cbea93284aeda3e30e531fe2c1633
Headers show

Commit Message

Marton Balint March 15, 2017, 2:47 a.m. UTC
Signed-off-by: Marton Balint <cus@passwd.hu>
---
 libavcodec/avcodec.h | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

Comments

wm4 March 15, 2017, 3:55 a.m. UTC | #1
On Wed, 15 Mar 2017 03:47:56 +0100
Marton Balint <cus@passwd.hu> wrote:

> Signed-off-by: Marton Balint <cus@passwd.hu>
> ---
>  libavcodec/avcodec.h | 5 +++--
>  1 file changed, 3 insertions(+), 2 deletions(-)
> 
> diff --git a/libavcodec/avcodec.h b/libavcodec/avcodec.h
> index e32f579..8d3d06e 100644
> --- a/libavcodec/avcodec.h
> +++ b/libavcodec/avcodec.h
> @@ -142,8 +142,9 @@
>   *
>   * Not all codecs will follow a rigid and predictable dataflow; the only
>   * guarantee is that an AVERROR(EAGAIN) return value on a send/receive call on
> - * one end implies that a receive/send call on the other end will succeed. In
> - * general, no codec will permit unlimited buffering of input or output.
> + * one end implies that a receive/send call on the other end will succeed, or
> + * at least will not fail with AVERROR(EAGAIN). In general, no codec will
> + * permit unlimited buffering of input or output.
>   *
>   * This API replaces the following legacy functions:
>   * - avcodec_decode_video2() and avcodec_decode_audio4():

Fine with me.
Marton Balint March 21, 2017, 11:49 p.m. UTC | #2
On Wed, 15 Mar 2017, wm4 wrote:

> On Wed, 15 Mar 2017 03:47:56 +0100
> Marton Balint <cus@passwd.hu> wrote:
>
>> Signed-off-by: Marton Balint <cus@passwd.hu>
>> ---
>>  libavcodec/avcodec.h | 5 +++--
>>  1 file changed, 3 insertions(+), 2 deletions(-)
>> 
>> diff --git a/libavcodec/avcodec.h b/libavcodec/avcodec.h
>> index e32f579..8d3d06e 100644
>> --- a/libavcodec/avcodec.h
>> +++ b/libavcodec/avcodec.h
>> @@ -142,8 +142,9 @@
>>   *
>>   * Not all codecs will follow a rigid and predictable dataflow; the only
>>   * guarantee is that an AVERROR(EAGAIN) return value on a send/receive call on
>> - * one end implies that a receive/send call on the other end will succeed. In
>> - * general, no codec will permit unlimited buffering of input or output.
>> + * one end implies that a receive/send call on the other end will succeed, or
>> + * at least will not fail with AVERROR(EAGAIN). In general, no codec will
>> + * permit unlimited buffering of input or output.
>>   *
>>   * This API replaces the following legacy functions:
>>   * - avcodec_decode_video2() and avcodec_decode_audio4():
>
> Fine with me.

Thanks, applied.

Regards,
Marton
diff mbox

Patch

diff --git a/libavcodec/avcodec.h b/libavcodec/avcodec.h
index e32f579..8d3d06e 100644
--- a/libavcodec/avcodec.h
+++ b/libavcodec/avcodec.h
@@ -142,8 +142,9 @@ 
  *
  * Not all codecs will follow a rigid and predictable dataflow; the only
  * guarantee is that an AVERROR(EAGAIN) return value on a send/receive call on
- * one end implies that a receive/send call on the other end will succeed. In
- * general, no codec will permit unlimited buffering of input or output.
+ * one end implies that a receive/send call on the other end will succeed, or
+ * at least will not fail with AVERROR(EAGAIN). In general, no codec will
+ * permit unlimited buffering of input or output.
  *
  * This API replaces the following legacy functions:
  * - avcodec_decode_video2() and avcodec_decode_audio4():