diff mbox

[FFmpeg-devel] avio: add a destructor for AVIOContext

Message ID 20170827163117.7784-1-jamrial@gmail.com
State New
Headers show

Commit Message

James Almer Aug. 27, 2017, 4:31 p.m. UTC
From: Anton Khirnov <anton@khirnov.net>

Before this commit, AVIOContext is to be freed with a plain av_free(),
which prevents us from adding any deeper structure to it.

(cherry picked from commit 99684f3ae752fc8bfb44a2dd1482f8d7a3d8536d)
Signed-off-by: James Almer <jamrial@gmail.com>
---
 doc/APIchanges        |  3 +++
 libavformat/avio.h    |  8 ++++++++
 libavformat/aviobuf.c | 17 ++++++++++++++---
 libavformat/version.h |  2 +-
 4 files changed, 26 insertions(+), 4 deletions(-)

Comments

James Almer Sept. 1, 2017, 4:53 a.m. UTC | #1
On 8/27/2017 1:31 PM, James Almer wrote:
> From: Anton Khirnov <anton@khirnov.net>
> 
> Before this commit, AVIOContext is to be freed with a plain av_free(),
> which prevents us from adding any deeper structure to it.
> 
> (cherry picked from commit 99684f3ae752fc8bfb44a2dd1482f8d7a3d8536d)
> Signed-off-by: James Almer <jamrial@gmail.com>
> ---
>  doc/APIchanges        |  3 +++
>  libavformat/avio.h    |  8 ++++++++
>  libavformat/aviobuf.c | 17 ++++++++++++++---
>  libavformat/version.h |  2 +-
>  4 files changed, 26 insertions(+), 4 deletions(-)

Pushed.
Ronald S. Bultje Sept. 1, 2017, 12:10 p.m. UTC | #2
Hi,

On Fri, Sep 1, 2017 at 12:53 AM, James Almer <jamrial@gmail.com> wrote:

> On 8/27/2017 1:31 PM, James Almer wrote:
> > From: Anton Khirnov <anton@khirnov.net>
> >
> > Before this commit, AVIOContext is to be freed with a plain av_free(),
> > which prevents us from adding any deeper structure to it.


The docs for avio_alloc_context() state:

441  * Allocate and initialize an AVIOContext for buffered I/O. It must be
later
442  * freed with av_free().

Should that be updated?

Ronald
Hendrik Leppkes Sept. 1, 2017, 12:25 p.m. UTC | #3
On Fri, Sep 1, 2017 at 2:10 PM, Ronald S. Bultje <rsbultje@gmail.com> wrote:
> Hi,
>
> On Fri, Sep 1, 2017 at 12:53 AM, James Almer <jamrial@gmail.com> wrote:
>
>> On 8/27/2017 1:31 PM, James Almer wrote:
>> > From: Anton Khirnov <anton@khirnov.net>
>> >
>> > Before this commit, AVIOContext is to be freed with a plain av_free(),
>> > which prevents us from adding any deeper structure to it.
>
>
> The docs for avio_alloc_context() state:
>
> 441  * Allocate and initialize an AVIOContext for buffered I/O. It must be
> later
> 442  * freed with av_free().
>
> Should that be updated?
>

It should. While av_free remains "OK" for now (deprecation period
etc), documentation should of course mention the appropriate function.

- Hendrik
James Almer Sept. 1, 2017, 3:28 p.m. UTC | #4
On 9/1/2017 9:25 AM, Hendrik Leppkes wrote:
> On Fri, Sep 1, 2017 at 2:10 PM, Ronald S. Bultje <rsbultje@gmail.com> wrote:
>> Hi,
>>
>> On Fri, Sep 1, 2017 at 12:53 AM, James Almer <jamrial@gmail.com> wrote:
>>
>>> On 8/27/2017 1:31 PM, James Almer wrote:
>>>> From: Anton Khirnov <anton@khirnov.net>
>>>>
>>>> Before this commit, AVIOContext is to be freed with a plain av_free(),
>>>> which prevents us from adding any deeper structure to it.
>>
>>
>> The docs for avio_alloc_context() state:
>>
>> 441  * Allocate and initialize an AVIOContext for buffered I/O. It must be
>> later
>> 442  * freed with av_free().
>>
>> Should that be updated?
>>
> 
> It should. While av_free remains "OK" for now (deprecation period
> etc), documentation should of course mention the appropriate function.
> 
> - Hendrik

Updated. Thanks for noticing.
diff mbox

Patch

diff --git a/doc/APIchanges b/doc/APIchanges
index 7babf5babb..880c791f5c 100644
--- a/doc/APIchanges
+++ b/doc/APIchanges
@@ -15,6 +15,9 @@  libavutil:     2015-08-28
 
 API changes, most recent first:
 
+2017-xx-xx - xxxxxxx - lavf 57.79.100 / 57.11.0 - avio.h
+  Add avio_context_free(). From now on it must be used for freeing AVIOContext.
+
 2017-08-08 - xxxxxxx - lavu 55.74.100 - pixdesc.h
   Add AV_PIX_FMT_FLAG_FLOAT pixel format flag.
 
diff --git a/libavformat/avio.h b/libavformat/avio.h
index f14b003ba5..ea56dad503 100644
--- a/libavformat/avio.h
+++ b/libavformat/avio.h
@@ -467,6 +467,14 @@  AVIOContext *avio_alloc_context(
                   int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
                   int64_t (*seek)(void *opaque, int64_t offset, int whence));
 
+/**
+ * Free the supplied IO context and everything associated with it.
+ *
+ * @param s Double pointer to the IO context. This function will write NULL
+ * into s.
+ */
+void avio_context_free(AVIOContext **s);
+
 void avio_w8(AVIOContext *s, int b);
 void avio_write(AVIOContext *s, const unsigned char *buf, int size);
 void avio_wl64(AVIOContext *s, uint64_t val);
diff --git a/libavformat/aviobuf.c b/libavformat/aviobuf.c
index ec21fc7d38..716c42eda9 100644
--- a/libavformat/aviobuf.c
+++ b/libavformat/aviobuf.c
@@ -143,6 +143,11 @@  AVIOContext *avio_alloc_context(
     return s;
 }
 
+void avio_context_free(AVIOContext **ps)
+{
+    av_freep(ps);
+}
+
 static void writeout(AVIOContext *s, const uint8_t *data, int len)
 {
     if (!s->error) {
@@ -1123,7 +1128,9 @@  int avio_close(AVIOContext *s)
     else
         av_log(s, AV_LOG_DEBUG, "Statistics: %"PRId64" bytes read, %d seeks\n", s->bytes_read, s->seek_count);
     av_opt_free(s);
-    av_free(s);
+
+    avio_context_free(&s);
+
     return ffurl_close(h);
 }
 
@@ -1356,7 +1363,9 @@  int avio_close_dyn_buf(AVIOContext *s, uint8_t **pbuffer)
     *pbuffer = d->buffer;
     size = d->size;
     av_free(d);
-    av_free(s);
+
+    avio_context_free(&s);
+
     return size - padding;
 }
 
@@ -1399,6 +1408,8 @@  int ffio_close_null_buf(AVIOContext *s)
 
     size = d->size;
     av_free(d);
-    av_free(s);
+
+    avio_context_free(&s);
+
     return size;
 }
diff --git a/libavformat/version.h b/libavformat/version.h
index 94081aca81..3029a5e767 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  57
-#define LIBAVFORMAT_VERSION_MINOR  78
+#define LIBAVFORMAT_VERSION_MINOR  79
 #define LIBAVFORMAT_VERSION_MICRO 100
 
 #define LIBAVFORMAT_VERSION_INT AV_VERSION_INT(LIBAVFORMAT_VERSION_MAJOR, \