[FFmpeg-devel] [PATCH 3/3] avcodec/codec: add doxy to AVCodec.decode()

[James Almer]

On 3/7/2021 10:34 AM, Andreas Rheinhardt wrote:
> James Almer:
>> Signed-off-by: James Almer <jamrial at gmail.com>
>> ---
>>   libavcodec/codec.h | 11 +++++++++++
>>   1 file changed, 11 insertions(+)
>>
>> diff --git a/libavcodec/codec.h b/libavcodec/codec.h
>> index bcda061da1..c019e7357c 100644
>> --- a/libavcodec/codec.h
>> +++ b/libavcodec/codec.h
>> @@ -281,6 +281,17 @@ typedef struct AVCodec {
>>        */
>>       int (*encode2)(struct AVCodecContext *avctx, struct AVPacket *avpkt,
>>                      const struct AVFrame *frame, int *got_packet_ptr);
>> +    /**
>> +     * Decode picture or subtitle data.
>> +     *
>> +     * @param      avctx          codec context
> 
> For this to make sense you need to add the variable name in patch 2.

Good catch. Will do that.

> 
>> +     * @param      outdata        codec type dependent output struct
> 
> Why didn't you set the "[out]"?

Because i copied it from the encode2() doxy.

> 
>> +     * @param[out] got_packet_ptr decoder sets to 0 or 1 to indicate that a
> 
> Should be got_frame_ptr. (I am unsure whether we should retain that
> "_ptr". It seems superfluous.)

Fixed.

> 
>> +     *                            non-empty frame or subtitle was returned in
>> +     *                            outdata.
>> +     * @param[in]  avpkt          AVPacket containing the bitstream to be decoded
> 
> Maybe use data instead of bitstream. After all, it may also contain
> side-data and other information.

Ok.

> 
>> +     * @return amount of bytes read from the packet, negative error code on failure
>> +     */
>>       int (*decode)(struct AVCodecContext *, void *outdata, int *got_frame_ptr,
>>                     struct AVPacket *avpkt);
>>       int (*close)(struct AVCodecContext *);
>>
> 
> _______________________________________________
> ffmpeg-devel mailing list
> ffmpeg-devel at ffmpeg.org
> https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
> 
> To unsubscribe, visit link above, or email
> ffmpeg-devel-request at ffmpeg.org with subject "unsubscribe".
>