diff mbox

[FFmpeg-devel] avcodec/utils: document allocation requirement of extradata

Message ID 20180824175912.6264-1-timo@rothenpieler.org
State Superseded
Headers show

Commit Message

Timo Rothenpieler Aug. 24, 2018, 5:59 p.m. UTC 
---
 libavcodec/avcodec.h | 1 +
 1 file changed, 1 insertion(+)

Comments

James Almer Aug. 24, 2018, 6:03 p.m. UTC | #1 
On 8/24/2018 2:59 PM, Timo Rothenpieler wrote:
> ---
>  libavcodec/avcodec.h | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/libavcodec/avcodec.h b/libavcodec/avcodec.h
> index 31e50d5a94..5ec7a2430b 100644
> --- a/libavcodec/avcodec.h
> +++ b/libavcodec/avcodec.h
> @@ -1616,6 +1616,7 @@ typedef struct AVCodecContext {
>       * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger
>       * than extradata_size to avoid problems if it is read with the bitstream reader.
>       * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
> +     * Must be allocated with av_malloc() in any case.

Use "Must be allocated with the av_malloc() family of functions"
instead. That's what's used in the doxy for other functions.

>       * - encoding: Set/allocated/freed by libavcodec.
>       * - decoding: Set/allocated/freed by user.
>       */
>
diff mbox

Patch

diff --git a/libavcodec/avcodec.h b/libavcodec/avcodec.h
index 31e50d5a94..5ec7a2430b 100644
--- a/libavcodec/avcodec.h
+++ b/libavcodec/avcodec.h
@@ -1616,6 +1616,7 @@  typedef struct AVCodecContext {
      * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger
      * than extradata_size to avoid problems if it is read with the bitstream reader.
      * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
+     * Must be allocated with av_malloc() in any case.
      * - encoding: Set/allocated/freed by libavcodec.
      * - decoding: Set/allocated/freed by user.
      */