[FFmpeg-devel,7/7] avformat: deprecate AVFormatContext filename field

Submitted by Marton Balint on Jan. 6, 2018, 8:50 p.m.

Details

Message ID 20180106205032.15186-7-cus@passwd.hu
State New
Headers show

Commit Message

Marton Balint Jan. 6, 2018, 8:50 p.m.
Signed-off-by: Marton Balint <cus@passwd.hu>
---
 doc/APIchanges         |  4 ++++
 libavformat/avformat.h |  5 +++++
 libavformat/mux.c      | 10 ++++++++++
 libavformat/utils.c    |  8 ++++++++
 libavformat/version.h  |  3 +++
 5 files changed, 30 insertions(+)

Comments

Michael Niedermayer Jan. 14, 2018, 10:06 p.m.
On Sat, Jan 06, 2018 at 09:50:32PM +0100, Marton Balint wrote:
> Signed-off-by: Marton Balint <cus@passwd.hu>
> ---
>  doc/APIchanges         |  4 ++++
>  libavformat/avformat.h |  5 +++++
>  libavformat/mux.c      | 10 ++++++++++
>  libavformat/utils.c    |  8 ++++++++
>  libavformat/version.h  |  3 +++
>  5 files changed, 30 insertions(+)

LGTM

thx

[...]

Patch hide | download patch | download mbox

diff --git a/doc/APIchanges b/doc/APIchanges
index 4a91b7460a..9593f647cc 100644
--- a/doc/APIchanges
+++ b/doc/APIchanges
@@ -16,6 +16,10 @@  libavutil:     2017-10-21
 API changes, most recent first:
 
 2018-xx-xx - xxxxxxx - lavf 58.4.100 - avformat.h
+  Deprecate AVFormatContext filename field which had limited length, use the
+  new dynamically allocated url field instead.
+
+2018-xx-xx - xxxxxxx - lavf 58.4.100 - avformat.h
   Add url field to AVFormatContext and add ff_format_set_url helper function.
 
 2018-01-xx - xxxxxxx - lavfi 7.11.101 - avfilter.h
diff --git a/libavformat/avformat.h b/libavformat/avformat.h
index 9fa25abd90..05f742f46c 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..72ae400636 100644
--- a/libavformat/version.h
+++ b/libavformat/version.h
@@ -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