|
|
@@ -16,8 +16,8 @@
|
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
|
|
*/
|
|
|
|
|
|
-#ifndef AVCODEC_REFSTRUCT_H
|
|
|
-#define AVCODEC_REFSTRUCT_H
|
|
|
+#ifndef AVUTIL_REFSTRUCT_H
|
|
|
+#define AVUTIL_REFSTRUCT_H
|
|
|
|
|
|
#include <stddef.h>
|
|
|
|
|
|
@@ -51,20 +51,20 @@
|
|
|
* This union is used for all opaque parameters in this API to spare the user
|
|
|
* to cast const away in case the opaque to use is const-qualified.
|
|
|
*
|
|
|
- * The functions provided by this API with an FFRefStructOpaque come in pairs
|
|
|
+ * The functions provided by this API with an AVRefStructOpaque come in pairs
|
|
|
* named foo_c and foo. The foo function accepts void* as opaque and is just
|
|
|
* a wrapper around the foo_c function; "_c" means "(potentially) const".
|
|
|
*/
|
|
|
typedef union {
|
|
|
void *nc;
|
|
|
const void *c;
|
|
|
-} FFRefStructOpaque;
|
|
|
+} AVRefStructOpaque;
|
|
|
|
|
|
/**
|
|
|
- * If this flag is set in ff_refstruct_alloc_ext_c(), the object will not
|
|
|
+ * If this flag is set in av_refstruct_alloc_ext_c(), the object will not
|
|
|
* be initially zeroed.
|
|
|
*/
|
|
|
-#define FF_REFSTRUCT_FLAG_NO_ZEROING (1 << 0)
|
|
|
+#define AV_REFSTRUCT_FLAG_NO_ZEROING (1 << 0)
|
|
|
|
|
|
/**
|
|
|
* Allocate a refcounted object of usable size `size` managed via
|
|
|
@@ -74,37 +74,37 @@ typedef union {
|
|
|
* the returned object is initially zeroed.
|
|
|
*
|
|
|
* @param size Desired usable size of the returned object.
|
|
|
- * @param flags A bitwise combination of FF_REFSTRUCT_FLAG_* flags.
|
|
|
+ * @param flags A bitwise combination of av_refstruct_FLAG_* flags.
|
|
|
* @param opaque A pointer that will be passed to the free_cb callback.
|
|
|
* @param free_cb A callback for freeing this object's content
|
|
|
* when its reference count reaches zero;
|
|
|
* it must not free the object itself.
|
|
|
* @return A pointer to an object of the desired size or NULL on failure.
|
|
|
*/
|
|
|
-void *ff_refstruct_alloc_ext_c(size_t size, unsigned flags, FFRefStructOpaque opaque,
|
|
|
- void (*free_cb)(FFRefStructOpaque opaque, void *obj));
|
|
|
+void *av_refstruct_alloc_ext_c(size_t size, unsigned flags, AVRefStructOpaque opaque,
|
|
|
+ void (*free_cb)(AVRefStructOpaque opaque, void *obj));
|
|
|
|
|
|
/**
|
|
|
- * A wrapper around ff_refstruct_alloc_ext_c() for the common case
|
|
|
+ * A wrapper around av_refstruct_alloc_ext_c() for the common case
|
|
|
* of a non-const qualified opaque.
|
|
|
*
|
|
|
- * @see ff_refstruct_alloc_ext_c()
|
|
|
+ * @see av_refstruct_alloc_ext_c()
|
|
|
*/
|
|
|
static inline
|
|
|
-void *ff_refstruct_alloc_ext(size_t size, unsigned flags, void *opaque,
|
|
|
- void (*free_cb)(FFRefStructOpaque opaque, void *obj))
|
|
|
+void *av_refstruct_alloc_ext(size_t size, unsigned flags, void *opaque,
|
|
|
+ void (*free_cb)(AVRefStructOpaque opaque, void *obj))
|
|
|
{
|
|
|
- return ff_refstruct_alloc_ext_c(size, flags, (FFRefStructOpaque){.nc = opaque},
|
|
|
+ return av_refstruct_alloc_ext_c(size, flags, (AVRefStructOpaque){.nc = opaque},
|
|
|
free_cb);
|
|
|
}
|
|
|
|
|
|
/**
|
|
|
- * Equivalent to ff_refstruct_alloc_ext(size, 0, NULL, NULL)
|
|
|
+ * Equivalent to av_refstruct_alloc_ext(size, 0, NULL, NULL)
|
|
|
*/
|
|
|
static inline
|
|
|
-void *ff_refstruct_allocz(size_t size)
|
|
|
+void *av_refstruct_allocz(size_t size)
|
|
|
{
|
|
|
- return ff_refstruct_alloc_ext(size, 0, NULL, NULL);
|
|
|
+ return av_refstruct_alloc_ext(size, 0, NULL, NULL);
|
|
|
}
|
|
|
|
|
|
/**
|
|
|
@@ -116,7 +116,7 @@ void *ff_refstruct_allocz(size_t size)
|
|
|
* @param objp Pointer to a pointer that is either NULL or points to an object
|
|
|
* managed via this API. `*objp` is set to NULL on return.
|
|
|
*/
|
|
|
-void ff_refstruct_unref(void *objp);
|
|
|
+void av_refstruct_unref(void *objp);
|
|
|
|
|
|
/**
|
|
|
* Create a new reference to an object managed via this API,
|
|
|
@@ -124,13 +124,13 @@ void ff_refstruct_unref(void *objp);
|
|
|
* and return obj.
|
|
|
* @return a pointer equal to obj.
|
|
|
*/
|
|
|
-void *ff_refstruct_ref(void *obj);
|
|
|
+void *av_refstruct_ref(void *obj);
|
|
|
|
|
|
/**
|
|
|
- * Analog of ff_refstruct_ref(), but for constant objects.
|
|
|
- * @see ff_refstruct_ref()
|
|
|
+ * Analog of av_refstruct_ref(), but for constant objects.
|
|
|
+ * @see av_refstruct_ref()
|
|
|
*/
|
|
|
-const void *ff_refstruct_ref_c(const void *obj);
|
|
|
+const void *av_refstruct_ref_c(const void *obj);
|
|
|
|
|
|
/**
|
|
|
* Ensure `*dstp` refers to the same object as src.
|
|
|
@@ -144,7 +144,7 @@ const void *ff_refstruct_ref_c(const void *obj);
|
|
|
* managed via this API.
|
|
|
* @param src A pointer to an object managed via this API or NULL.
|
|
|
*/
|
|
|
-void ff_refstruct_replace(void *dstp, const void *src);
|
|
|
+void av_refstruct_replace(void *dstp, const void *src);
|
|
|
|
|
|
/**
|
|
|
* Check whether the reference count of an object managed
|
|
|
@@ -153,10 +153,10 @@ void ff_refstruct_replace(void *dstp, const void *src);
|
|
|
* @param obj A pointer to an object managed via this API.
|
|
|
* @return 1 if the reference count of obj is 1; 0 otherwise.
|
|
|
*/
|
|
|
-int ff_refstruct_exclusive(const void *obj);
|
|
|
+int av_refstruct_exclusive(const void *obj);
|
|
|
|
|
|
/**
|
|
|
- * FFRefStructPool is an API for a thread-safe pool of objects managed
|
|
|
+ * AVRefStructPool is an API for a thread-safe pool of objects managed
|
|
|
* via the RefStruct API.
|
|
|
*
|
|
|
* Frequently allocating and freeing large or complicated objects may be slow
|
|
|
@@ -164,16 +164,16 @@ int ff_refstruct_exclusive(const void *obj);
|
|
|
* needs a set of interchangable objects.
|
|
|
*
|
|
|
* At the beginning, the user must call allocate the pool via
|
|
|
- * ff_refstruct_pool_alloc() or its analogue ff_refstruct_pool_alloc_ext().
|
|
|
- * Then whenever an object is needed, call ff_refstruct_pool_get() to
|
|
|
+ * av_refstruct_pool_alloc() or its analogue av_refstruct_pool_alloc_ext().
|
|
|
+ * Then whenever an object is needed, call av_refstruct_pool_get() to
|
|
|
* get a new or reused object from the pool. This new object works in all
|
|
|
- * aspects the same way as the ones created by ff_refstruct_alloc_ext().
|
|
|
+ * aspects the same way as the ones created by av_refstruct_alloc_ext().
|
|
|
* However, when the last reference to this object is unreferenced, it is
|
|
|
* (optionally) reset and returned to the pool instead of being freed and
|
|
|
- * will be reused for subsequent ff_refstruct_pool_get() calls.
|
|
|
+ * will be reused for subsequent av_refstruct_pool_get() calls.
|
|
|
*
|
|
|
* When the caller is done with the pool and no longer needs to create any new
|
|
|
- * objects, ff_refstruct_pool_uninit() must be called to mark the pool as
|
|
|
+ * objects, av_refstruct_pool_uninit() must be called to mark the pool as
|
|
|
* freeable. Then entries returned to the pool will then be freed.
|
|
|
* Once all the entries are freed, the pool will automatically be freed.
|
|
|
*
|
|
|
@@ -184,56 +184,56 @@ int ff_refstruct_exclusive(const void *obj);
|
|
|
/**
|
|
|
* The buffer pool. This structure is opaque and not meant to be accessed
|
|
|
* directly. It is allocated with the allocators below and freed with
|
|
|
- * ff_refstruct_pool_uninit().
|
|
|
+ * av_refstruct_pool_uninit().
|
|
|
*/
|
|
|
-typedef struct FFRefStructPool FFRefStructPool;
|
|
|
+typedef struct AVRefStructPool AVRefStructPool;
|
|
|
|
|
|
/**
|
|
|
* If this flag is not set, every object in the pool will be zeroed before
|
|
|
* the init callback is called or before it is turned over to the user
|
|
|
* for the first time if no init callback has been provided.
|
|
|
*/
|
|
|
-#define FF_REFSTRUCT_POOL_FLAG_NO_ZEROING FF_REFSTRUCT_FLAG_NO_ZEROING
|
|
|
+#define AV_REFSTRUCT_POOL_FLAG_NO_ZEROING AV_REFSTRUCT_FLAG_NO_ZEROING
|
|
|
/**
|
|
|
* If this flag is set and both init_cb and reset_cb callbacks are provided,
|
|
|
* then reset_cb will be called if init_cb fails.
|
|
|
* The object passed to reset_cb will be in the state left by init_cb.
|
|
|
*/
|
|
|
-#define FF_REFSTRUCT_POOL_FLAG_RESET_ON_INIT_ERROR (1 << 16)
|
|
|
+#define AV_REFSTRUCT_POOL_FLAG_RESET_ON_INIT_ERROR (1 << 16)
|
|
|
/**
|
|
|
* If this flag is set and both init_cb and free_entry_cb callbacks are
|
|
|
* provided, then free_cb will be called if init_cb fails.
|
|
|
*
|
|
|
* It will be called after reset_cb in case reset_cb and the
|
|
|
- * FF_REFSTRUCT_POOL_FLAG_RESET_ON_INIT_ERROR flag are also set.
|
|
|
+ * av_refstruct_POOL_FLAG_RESET_ON_INIT_ERROR flag are also set.
|
|
|
*
|
|
|
* The object passed to free_cb will be in the state left by
|
|
|
* the callbacks applied earlier (init_cb potentially followed by reset_cb).
|
|
|
*/
|
|
|
-#define FF_REFSTRUCT_POOL_FLAG_FREE_ON_INIT_ERROR (1 << 17)
|
|
|
+#define AV_REFSTRUCT_POOL_FLAG_FREE_ON_INIT_ERROR (1 << 17)
|
|
|
/**
|
|
|
* If this flag is set, the entries will be zeroed before
|
|
|
* being returned to the user (after the init or reset callbacks
|
|
|
* have been called (if provided)). Furthermore, to avoid zeroing twice
|
|
|
- * it also makes the pool behave as if the FF_REFSTRUCT_POOL_FLAG_NO_ZEROING
|
|
|
+ * it also makes the pool behave as if the av_refstruct_POOL_FLAG_NO_ZEROING
|
|
|
* flag had been provided.
|
|
|
*/
|
|
|
-#define FF_REFSTRUCT_POOL_FLAG_ZERO_EVERY_TIME (1 << 18)
|
|
|
+#define AV_REFSTRUCT_POOL_FLAG_ZERO_EVERY_TIME (1 << 18)
|
|
|
|
|
|
/**
|
|
|
- * Equivalent to ff_refstruct_pool_alloc(size, flags, NULL, NULL, NULL, NULL, NULL)
|
|
|
+ * Equivalent to av_refstruct_pool_alloc(size, flags, NULL, NULL, NULL, NULL, NULL)
|
|
|
*/
|
|
|
-FFRefStructPool *ff_refstruct_pool_alloc(size_t size, unsigned flags);
|
|
|
+AVRefStructPool *av_refstruct_pool_alloc(size_t size, unsigned flags);
|
|
|
|
|
|
/**
|
|
|
- * Allocate an FFRefStructPool, potentially using complex callbacks.
|
|
|
+ * Allocate an AVRefStructPool, potentially using complex callbacks.
|
|
|
*
|
|
|
* @param size size of the entries of the pool
|
|
|
- * @param flags a bitwise combination of FF_REFSTRUCT_POOL_FLAG_* flags
|
|
|
+ * @param flags a bitwise combination of av_refstruct_POOL_FLAG_* flags
|
|
|
* @param opaque A pointer that will be passed to the callbacks below.
|
|
|
* @param init A callback that will be called directly after a new entry
|
|
|
* has been allocated. obj has already been zeroed unless
|
|
|
- * the FF_REFSTRUCT_POOL_FLAG_NO_ZEROING flag is in use.
|
|
|
+ * the av_refstruct_POOL_FLAG_NO_ZEROING flag is in use.
|
|
|
* @param reset A callback that will be called after an entry has been
|
|
|
* returned to the pool and before it is reused.
|
|
|
* @param free_entry A callback that will be called when an entry is freed
|
|
|
@@ -241,28 +241,28 @@ FFRefStructPool *ff_refstruct_pool_alloc(size_t size, unsigned flags);
|
|
|
* @param free A callback that will be called when the pool itself is
|
|
|
* freed (after the last entry has been returned and freed).
|
|
|
*/
|
|
|
-FFRefStructPool *ff_refstruct_pool_alloc_ext_c(size_t size, unsigned flags,
|
|
|
- FFRefStructOpaque opaque,
|
|
|
- int (*init_cb)(FFRefStructOpaque opaque, void *obj),
|
|
|
- void (*reset_cb)(FFRefStructOpaque opaque, void *obj),
|
|
|
- void (*free_entry_cb)(FFRefStructOpaque opaque, void *obj),
|
|
|
- void (*free_cb)(FFRefStructOpaque opaque));
|
|
|
+AVRefStructPool *av_refstruct_pool_alloc_ext_c(size_t size, unsigned flags,
|
|
|
+ AVRefStructOpaque opaque,
|
|
|
+ int (*init_cb)(AVRefStructOpaque opaque, void *obj),
|
|
|
+ void (*reset_cb)(AVRefStructOpaque opaque, void *obj),
|
|
|
+ void (*free_entry_cb)(AVRefStructOpaque opaque, void *obj),
|
|
|
+ void (*free_cb)(AVRefStructOpaque opaque));
|
|
|
|
|
|
/**
|
|
|
- * A wrapper around ff_refstruct_pool_alloc_ext_c() for the common case
|
|
|
+ * A wrapper around av_refstruct_pool_alloc_ext_c() for the common case
|
|
|
* of a non-const qualified opaque.
|
|
|
*
|
|
|
- * @see ff_refstruct_pool_alloc_ext_c()
|
|
|
+ * @see av_refstruct_pool_alloc_ext_c()
|
|
|
*/
|
|
|
static inline
|
|
|
-FFRefStructPool *ff_refstruct_pool_alloc_ext(size_t size, unsigned flags,
|
|
|
+AVRefStructPool *av_refstruct_pool_alloc_ext(size_t size, unsigned flags,
|
|
|
void *opaque,
|
|
|
- int (*init_cb)(FFRefStructOpaque opaque, void *obj),
|
|
|
- void (*reset_cb)(FFRefStructOpaque opaque, void *obj),
|
|
|
- void (*free_entry_cb)(FFRefStructOpaque opaque, void *obj),
|
|
|
- void (*free_cb)(FFRefStructOpaque opaque))
|
|
|
+ int (*init_cb)(AVRefStructOpaque opaque, void *obj),
|
|
|
+ void (*reset_cb)(AVRefStructOpaque opaque, void *obj),
|
|
|
+ void (*free_entry_cb)(AVRefStructOpaque opaque, void *obj),
|
|
|
+ void (*free_cb)(AVRefStructOpaque opaque))
|
|
|
{
|
|
|
- return ff_refstruct_pool_alloc_ext_c(size, flags, (FFRefStructOpaque){.nc = opaque},
|
|
|
+ return av_refstruct_pool_alloc_ext_c(size, flags, (AVRefStructOpaque){.nc = opaque},
|
|
|
init_cb, reset_cb, free_entry_cb, free_cb);
|
|
|
}
|
|
|
|
|
|
@@ -270,13 +270,13 @@ FFRefStructPool *ff_refstruct_pool_alloc_ext(size_t size, unsigned flags,
|
|
|
* Get an object from the pool, reusing an old one from the pool when
|
|
|
* available.
|
|
|
*
|
|
|
- * Every call to this function must happen before ff_refstruct_pool_uninit().
|
|
|
+ * Every call to this function must happen before av_refstruct_pool_uninit().
|
|
|
* Otherwise undefined behaviour may occur.
|
|
|
*
|
|
|
* @param pool the pool from which to get the object
|
|
|
* @return a reference to the object on success, NULL on error.
|
|
|
*/
|
|
|
-void *ff_refstruct_pool_get(FFRefStructPool *pool);
|
|
|
+void *av_refstruct_pool_get(AVRefStructPool *pool);
|
|
|
|
|
|
/**
|
|
|
* Mark the pool as being available for freeing. It will actually be freed
|
|
|
@@ -289,9 +289,9 @@ void *ff_refstruct_pool_get(FFRefStructPool *pool);
|
|
|
* @param poolp pointer to a pointer to either NULL or a pool to be freed.
|
|
|
* `*poolp` will be set to NULL.
|
|
|
*/
|
|
|
-static inline void ff_refstruct_pool_uninit(FFRefStructPool **poolp)
|
|
|
+static inline void av_refstruct_pool_uninit(AVRefStructPool **poolp)
|
|
|
{
|
|
|
- ff_refstruct_unref(poolp);
|
|
|
+ av_refstruct_unref(poolp);
|
|
|
}
|
|
|
|
|
|
-#endif /* AVCODEC_REFSTRUCT_H */
|
|
|
+#endif /* AVUTIL_REFSTRUCT_H */
|