FFmpeg數據結構AVBuffer

本文爲做者原創，轉載請註明出處：http://www.javashuo.com/article/p-sdecochf-bt.html

AVBuffer是FFmpeg中很經常使用的一種緩衝區，緩衝區使用引用計數(reference-counted)機制。
AVBufferRef則對AVBuffer緩衝區提供了一層封裝，最主要的是做引用計數處理，實現了一種安全機制。用戶不該直接訪問AVBuffer，應經過AVBufferRef來訪問AVBuffer，以保證安全。
FFmpeg中不少基礎的數據結構都包含了AVBufferRef成員，來間接使用AVBuffer緩衝區。
本文使用的FFmpeg版本號爲FFmpeg 4.1。

AVBuffer和AVBufferRef結構體定義及操做函數位於libavutil中的buffer.h、buffer_internal.h、buffer.c三個文件中。須要關注的要點是AVBufferRef和AVBuffer的關係以及緩衝區引用計數的概念。

1. 數據結構定義

1.1 struct AVBuffer

struct AVBuffer定義於「libavutil/buffer_internal.h」，buffer_internal.h位於FFmpeg工程源碼中，而FFmpeg提供的開發庫頭文件中並沒有此文件，所以這是一個內部數據結構，不向用戶開放，用戶不該直接訪問AVBuffer，應經過AVBufferRef來訪問AVBuffer，以保證安全。

struct AVBuffer {
    uint8_t *data; /**< data described by this buffer */
    int      size; /**< size of data in bytes */

    /**
     *  number of existing AVBufferRef instances referring to this buffer
     */
    atomic_uint refcount;

    /**
     * a callback for freeing the data
     */
    void (*free)(void *opaque, uint8_t *data);

    /**
     * an opaque pointer, to be used by the freeing callback
     */
    void *opaque;

    /**
     * A combination of BUFFER_FLAG_*
     */
    int flags;
};

• data: 緩衝區地址
  
• size: 緩衝區大小
  
• refcount: 引用計數值
  
• free: 用於釋放緩衝區內存的回調函數
  
• opaque: 提供給free回調函數的參數
  
• flags: 緩衝區標誌

1.2 struct AVBufferRef

struct AVBufferRef定義於buffer.h中：

/**
 * A reference to a data buffer.
 *
 * The size of this struct is not a part of the public ABI and it is not meant
 * to be allocated directly.
 */
typedef struct AVBufferRef {
    AVBuffer *buffer;

    /**
     * The data buffer. It is considered writable if and only if
     * this is the only reference to the buffer, in which case
     * av_buffer_is_writable() returns 1.
     */
    uint8_t *data;
    /**
     * Size of data in bytes.
     */
    int      size;
} AVBufferRef;

• buffer: AVBuffer
• data: 緩衝區地址，實際等於buffer->data
• size: 緩衝區大小，實際等於buffer->size

2. 關鍵函數實現

2.1 av_buffer_alloc()

AVBufferRef *av_buffer_alloc(int size)
{
    AVBufferRef *ret = NULL;
    uint8_t    *data = NULL;

    data = av_malloc(size);
    if (!data)
        return NULL;

    ret = av_buffer_create(data, size, av_buffer_default_free, NULL, 0);
    if (!ret)
        av_freep(&data);

    return ret;
}

av_buffer_alloc()做了以下處理:

a) 使用av_malloc分配緩衝區

b) 調用av_buffer_create()建立AVBuffer AVBufferRef::*buffer成員，用於管理AVBuffer緩衝區

c) 返回AVBufferRef *對象

2.2 av_buffer_create()

AVBufferRef *av_buffer_create(uint8_t *data, int size,
                              void (*free)(void *opaque, uint8_t *data),
                              void *opaque, int flags)
{
    AVBufferRef *ref = NULL;
    AVBuffer    *buf = NULL;

    buf = av_mallocz(sizeof(*buf));
    if (!buf)
        return NULL;

    buf->data     = data;
    buf->size     = size;
    buf->free     = free ? free : av_buffer_default_free;
    buf->opaque   = opaque;

    atomic_init(&buf->refcount, 1);

    if (flags & AV_BUFFER_FLAG_READONLY)
        buf->flags |= BUFFER_FLAG_READONLY;

    ref = av_mallocz(sizeof(*ref));
    if (!ref) {
        av_freep(&buf);
        return NULL;
    }

    ref->buffer = buf;
    ref->data   = data;
    ref->size   = size;

    return ref;
}

av_buffer_create()是一個比較核心的函數，從其實現代碼很容易看出AVBufferRef和AVBuffer這間的關係。
函數主要功能就是初始化AVBuffer AVBufferRef::*buffer成員，即爲上述清單ref->buffer各字段賦值，最終，AVBufferRef *ref所有構造完畢，將之返回。

其中void (*free)(void *opaque, uint8_t *data)參數賦值爲av_buffer_default_free，實現以下。其實就是直接調用了av_free回收內存。

void av_buffer_default_free(void *opaque, uint8_t *data)
{
    av_free(data);
}

2.3 av_buffer_ref()

AVBufferRef *av_buffer_ref(AVBufferRef *buf)
{
    AVBufferRef *ret = av_mallocz(sizeof(*ret));

    if (!ret)
        return NULL;

    *ret = *buf;

    atomic_fetch_add_explicit(&buf->buffer->refcount, 1, memory_order_relaxed);

    return ret;
}

av_buffer_ref()處理以下：

a) *ret = *buf;一句將buf各成員值賦值給ret中對應成員，buf和ret將共用同一份AVBuffer緩衝區

b) atomic_fetch_add_explicit(...);一句將AVBuffer緩衝區引用計數加1
注意此處的關鍵點：共用緩衝區(緩衝區不拷貝)，緩衝區引用計數加1

2.4 av_buffer_unref()

static void buffer_replace(AVBufferRef **dst, AVBufferRef **src)
{
    AVBuffer *b;

    b = (*dst)->buffer;

    if (src) {
        **dst = **src;
        av_freep(src);
    } else
        av_freep(dst);

    if (atomic_fetch_add_explicit(&b->refcount, -1, memory_order_acq_rel) == 1) {
        b->free(b->opaque, b->data);
        av_freep(&b);
    }
}

void av_buffer_unref(AVBufferRef **buf)
{
    if (!buf || !*buf)
        return;

    buffer_replace(buf, NULL);
}

av_buffer_unref()處理以下：

a) 回收AVBufferRef **buf內存

b) 將(*buf)->buffer(即AVBAVBufferRef的成員AVBuffer)的引用計數減1，若引用計數爲0，則經過b->free(b->opaque, b->data);調用回調函數回收AVBuffer緩衝區內存
注意此處的關鍵點：銷燬一個AVBufferRef時，將其AVBuffer緩衝區引用計數減1，若緩衝區引用計數變爲0，則將緩衝區也回收，這很容易理解，只有當緩衝區不被任何對象引用時，緩衝區才能被銷燬

3. 修改記錄

2018-12-13 V1.0 初稿