[FFmpeg-devel] [PATCH 6/6] avformat: deprecate AVFormatContext filename field

[James Almer]

On 12/30/2017 6:16 PM, Marton Balint wrote:
> Signed-off-by: Marton Balint <cus at passwd.hu>
> ---
>  doc/APIchanges         |  4 ++++
>  libavformat/avformat.h |  5 +++++
>  libavformat/mux.c      | 10 ++++++++++
>  libavformat/utils.c    |  8 ++++++++
>  libavformat/version.h  |  5 ++++-
>  5 files changed, 31 insertions(+), 1 deletion(-)
> 
> diff --git a/doc/APIchanges b/doc/APIchanges
> index 7ca097486e..073a75ec44 100644
> --- a/doc/APIchanges
> +++ b/doc/APIchanges
> @@ -15,6 +15,10 @@ libavutil:     2017-10-21
>  
>  API changes, most recent first:
>  
> +201x-xx-xx - xxxxxxx - lavf 58.5.100 - avformat.h
> +  Deprecate AVFormatContext filename field which had limited length, use the
> +  new dynamically allocated url field instead.
> +
>  2017-xx-xx - xxxxxxx - lavf 58.4.100 - avformat.h
>    Add url field to AVFormatContext and add ff_format_set_url helper function.
>  
> diff --git a/libavformat/avformat.h b/libavformat/avformat.h
> index c3229ed0e1..49ad5d1570 100644
> --- a/libavformat/avformat.h
> +++ b/libavformat/avformat.h
> @@ -1382,13 +1382,18 @@ typedef struct AVFormatContext {
>       */
>      AVStream **streams;
>  
> +#if FF_API_FORMAT_FILENAME
>      /**
>       * input or output filename
>       *
>       * - demuxing: set by avformat_open_input()
>       * - muxing: may be set by the caller before avformat_write_header()
> +     *
> +     * @deprecated Use url instead.
>       */
> +    attribute_deprecated
>      char filename[1024];
> +#endif
>  
>      /**
>       * input or output URL. Unlike the old filename field, this field has no
> diff --git a/libavformat/mux.c b/libavformat/mux.c
> index de63f2ca25..a13f0e3a1b 100644
> --- a/libavformat/mux.c
> +++ b/libavformat/mux.c
> @@ -187,7 +187,11 @@ int avformat_alloc_output_context2(AVFormatContext **avctx, AVOutputFormat *ofor
>          s->priv_data = NULL;
>  
>      if (filename) {
> +#if FF_API_FORMAT_FILENAME
> +FF_DISABLE_DEPRECATION_WARNINGS
>          av_strlcpy(s->filename, filename, sizeof(s->filename));
> +FF_ENABLE_DEPRECATION_WARNINGS
> +#endif
>          if (!(s->url = av_strdup(filename)))
>              goto nomem;
>  
> @@ -255,7 +259,13 @@ static int init_muxer(AVFormatContext *s, AVDictionary **options)
>          (ret = av_opt_set_dict2(s->priv_data, &tmp, AV_OPT_SEARCH_CHILDREN)) < 0)
>          goto fail;
>  
> +#if FF_API_FORMAT_FILENAME
> +FF_DISABLE_DEPRECATION_WARNINGS
>      if (!s->url && !(s->url = av_strdup(s->filename))) {
> +FF_ENABLE_DEPRECATION_WARNINGS
> +#else
> +    if (!s->url && !(s->url = av_strdup(""))) {
> +#endif
>          ret = AVERROR(ENOMEM);
>          goto fail;
>      }
> diff --git a/libavformat/utils.c b/libavformat/utils.c
> index a74046591e..c9136a3a3b 100644
> --- a/libavformat/utils.c
> +++ b/libavformat/utils.c
> @@ -556,7 +556,11 @@ int avformat_open_input(AVFormatContext **ps, const char *filename,
>          goto fail;
>      }
>  
> +#if FF_API_FORMAT_FILENAME
> +FF_DISABLE_DEPRECATION_WARNINGS
>      av_strlcpy(s->filename, filename ? filename : "", sizeof(s->filename));
> +FF_ENABLE_DEPRECATION_WARNINGS
> +#endif
>      if ((ret = init_input(s, filename, &tmp)) < 0)
>          goto fail;
>      s->probe_score = ret;
> @@ -5636,5 +5640,9 @@ void ff_format_set_url(AVFormatContext *s, char *url)
>      av_assert0(url);
>      av_freep(&s->url);
>      s->url = url;
> +#if FF_API_FORMAT_FILENAME
> +FF_DISABLE_DEPRECATION_WARNINGS
>      av_strlcpy(s->filename, url, sizeof(s->filename));
> +FF_ENABLE_DEPRECATION_WARNINGS
> +#endif
>  }
> diff --git a/libavformat/version.h b/libavformat/version.h
> index 49b9906a20..b8e50db8c7 100644
> --- a/libavformat/version.h
> +++ b/libavformat/version.h
> @@ -32,7 +32,7 @@
>  // Major bumping may affect Ticket5467, 5421, 5451(compatibility with Chromium)
>  // Also please add any ticket numbers that you believe might be affected here
>  #define LIBAVFORMAT_VERSION_MAJOR  58
> -#define LIBAVFORMAT_VERSION_MINOR   4
> +#define LIBAVFORMAT_VERSION_MINOR   5

IMO, just leave it as 4. One version bump to deprecate a field and add a
replacement is enough.

>  #define LIBAVFORMAT_VERSION_MICRO 100
>  
>  #define LIBAVFORMAT_VERSION_INT AV_VERSION_INT(LIBAVFORMAT_VERSION_MAJOR, \
> @@ -82,6 +82,9 @@
>  #ifndef FF_API_OLD_AVIO_EOF_0
>  #define FF_API_OLD_AVIO_EOF_0           (LIBAVFORMAT_VERSION_MAJOR < 59)
>  #endif
> +#ifndef FF_API_FORMAT_FILENAME
> +#define FF_API_FORMAT_FILENAME          (LIBAVFORMAT_VERSION_MAJOR < 59)
> +#endif
>  
>  
>  #ifndef FF_API_R_FRAME_RATE
>