[FFmpeg-devel] [PATCH] avformat/avformat.h: elaborate documentation for avformat_open_input() on error condition

[Marth64]

Hi,

Pinging on an old patch (quoted below).
Any objections?
I checked and this still holds true.

On Fri, Feb 9, 2024 at 4:08 PM Marth64 <marth64 at proxyid.net> wrote:
>
> Signed-off-by: Marth64 <marth64 at proxyid.net>
> ---
>  libavformat/avformat.h | 5 +++--
>  1 file changed, 3 insertions(+), 2 deletions(-)
>
> diff --git a/libavformat/avformat.h b/libavformat/avformat.h
> index 5d0fe82250..070ed7023d 100644
> --- a/libavformat/avformat.h
> +++ b/libavformat/avformat.h
> @@ -2175,7 +2175,7 @@ int av_probe_input_buffer(AVIOContext *pb, const AVInputFormat **fmt,
>   *                 which case an AVFormatContext is allocated by this
>   *                 function and written into ps.
>   *                 Note that a user-supplied AVFormatContext will be freed
> - *                 on failure.
> + *                 on failure and its pointer set to NULL.
>   * @param url      URL of the stream to open.
>   * @param fmt      If non-NULL, this parameter forces a specific input format.
>   *                 Otherwise the format is autodetected.
> @@ -2184,7 +2184,8 @@ int av_probe_input_buffer(AVIOContext *pb, const AVInputFormat **fmt,
>   *                 On return this parameter will be destroyed and replaced with
>   *                 a dict containing options that were not found. May be NULL.
>   *
> - * @return 0 on success, a negative AVERROR on failure.
> + * @return 0 on success; on failure: frees ps, sets its pointer to NULL,
> + *         and returns a negative AVERROR.
>   *
>   * @note If you want to use custom IO, preallocate the format context and set its pb field.
>   */
> --
> 2.34.1
>