If this flag is set in ff_refstruct_alloc_ext_c(), the object will not be initially zeroed.

Definition at line 67 of file refstruct.h.

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.

Definition at line 196 of file refstruct.h.

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.

Definition at line 202 of file refstruct.h.

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.

The object passed to free_cb will be in the state left by the callbacks applied earlier (init_cb potentially followed by reset_cb).

Definition at line 213 of file refstruct.h.

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 flag had been provided.

Definition at line 221 of file refstruct.h.

Allocate a refcounted object of usable size size managed via the RefStruct API.

By default (in the absence of flags to the contrary), the returned object is initially zeroed.

Parameters

size Desired usable size of the returned object.

flags A bitwise combination of FF_REFSTRUCT_FLAG_* flags.

opaque A pointer that will be passed to the free_cb callback.

free_cb A callback for freeing this object's content when its reference count reaches zero; it must not free the object itself.

Returns

A pointer to an object of the desired size or NULL on failure.

Definition at line 102 of file refstruct.c.

Referenced by cbs_alloc_content(), and ff_refstruct_alloc_ext().

A wrapper around ff_refstruct_alloc_ext_c() for the common case of a non-const qualified opaque.

See also

ff_refstruct_alloc_ext_c()

Definition at line 94 of file refstruct.h.

Referenced by alloc_progress(), ff_cbs_sei_alloc_message_payload(), ff_h264_decode_picture_parameter_set(), ff_hevc_decode_nal_pps(), ff_hevc_decode_nal_vps(), ff_hwaccel_frame_priv_alloc(), ff_refstruct_allocz(), ff_refstruct_pool_alloc_ext_c(), nvdec_decoder_create(), pps_alloc(), refstruct_pool_get_ext(), sps_alloc(), update_frame_pool(), vp3_decode_init(), and vulkan_decode_bootstrap().

Equivalent to ff_refstruct_alloc_ext(size, 0, NULL, NULL)

Definition at line 105 of file refstruct.h.

Referenced by alloc_frame(), aps_decode_alf(), aps_decode_scaling(), ff_dovi_rpu_parse(), ff_h264_decode_seq_parameter_set(), ff_hevc_decode_nal_sps(), ff_hwaccel_frame_priv_alloc(), ff_thread_get_ext_buffer(), sps(), vp8_alloc_frame(), and wv_dsd_reset().

Decrement the reference count of the underlying object and automatically free the object if there are no more references to it.

*objp == NULL is legal and a no-op.

Parameters

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.

Definition at line 120 of file refstruct.c.

Referenced by alloc_progress(), aps_decode_alf(), aps_decode_scaling(), av1_decode_free(), av1_frame_unref(), cbs_av1_close(), cbs_av1_write_obu(), cbs_clone_noncomplex_unit_content(), cbs_free_user_data_registered(), cbs_free_user_data_unregistered(), cbs_h264_close(), cbs_h264_flush(), cbs_h265_close(), cbs_h265_flush(), cbs_h266_flush(), cbs_read_fragment_content(), cbs_sei_delete_message(), cbs_unit_uninit(), decode_pps(), decode_sps(), ff_cbs_make_unit_writable(), ff_cbs_sei_free_message_list(), ff_codec_close(), ff_dovi_ctx_flush(), ff_dovi_ctx_unref(), ff_frame_thread_free(), ff_h264_decode_picture_parameter_set(), ff_h264_decode_seq_parameter_set(), ff_h264_ps_uninit(), ff_h264_unref_picture(), ff_hevc_decode_nal_pps(), ff_hevc_decode_nal_sps(), ff_hevc_decode_nal_vps(), ff_hevc_ps_uninit(), ff_hevc_unref_frame(), ff_mpeg_unref_picture(), ff_nvdec_decode_uninit(), ff_nvdec_start_frame_sep_ref(), ff_refstruct_pool_uninit(), ff_refstruct_replace(), ff_thread_get_ext_buffer(), ff_thread_release_ext_buffer(), ff_vk_decode_uninit(), ff_vvc_ctu_free_cus(), ff_vvc_frame_ps_free(), ff_vvc_ps_uninit(), ff_vvc_unref_frame(), nvdec_decoder_create(), nvdec_fdd_priv_free(), nvdec_unmap_mapped_frame(), pps_alloc(), pps_free(), remove_pps(), remove_sps(), remove_vps(), slices_free(), sps_alloc(), sps_free(), update_frame_pool(), vaapi_encode_discard(), vaapi_encode_get_coded_data(), vaapi_encode_issue(), vaapi_encode_output(), vp3_decode_end(), vp8_alloc_frame(), vp8_release_frame(), vp9_frame_unref(), vulkan_decode_bootstrap(), wavpack_decode_end(), and wv_dsd_reset().

Create a new reference to an object managed via this API, i.e.

increment the reference count of the underlying object and return obj.

Returns

a pointer equal to obj.

Definition at line 140 of file refstruct.c.

Referenced by cbs_av1_write_obu(), ff_cbs_insert_unit_content(), ff_cbs_sei_add_message(), ff_nvdec_start_frame(), ff_thread_ref_frame(), get_current_frame(), hevc_ref_frame(), vaapi_encode_output(), and vp9_frame_ref().

Analog of ff_refstruct_ref(), but for constant objects.

See also

ff_refstruct_ref()

Definition at line 149 of file refstruct.c.

Referenced by alloc_picture(), ff_h264_decode_picture_parameter_set(), and ff_refstruct_replace().

Ensure *dstp refers to the same object as src.

If *dstp is already equal to src, do nothing. Otherwise unreference *dstp and replace it with a new reference to src in case src != NULL (this involves incrementing the reference count of src's underlying object) or with NULL otherwise.

Parameters

dstp Pointer to a pointer that is either NULL or points to an object managed via this API.

src A pointer to an object managed via this API or NULL.

Definition at line 160 of file refstruct.c.

Referenced by aps_decode_alf(), aps_decode_scaling(), av1_frame_ref(), av1_receive_frame_internal(), cbs_av1_read_unit(), cbs_h2645_replace_ps(), decode_frame_ps(), decode_ph(), ff_dovi_ctx_replace(), ff_h264_update_thread_context(), ff_mpeg_ref_picture(), ff_thread_replace_frame(), ff_vk_update_thread_context(), ff_vvc_decode_aps(), ff_vvc_decode_sh(), h264_copy_picture_params(), h264_init_ps(), hevc_ref_frame(), parse_nal_units(), pps_alloc(), ref_frame(), slice_start(), sps_alloc(), update_context_from_thread(), and vp9_frame_ref().

Check whether the reference count of an object managed via this API is 1.

Parameters

obj A pointer to an object managed via this API.

Returns

1 if the reference count of obj is 1; 0 otherwise.

Definition at line 174 of file refstruct.c.

Referenced by ff_cbs_make_unit_writable().

Equivalent to ff_refstruct_pool_alloc(size, flags, NULL, NULL, NULL, NULL, NULL)

Definition at line 335 of file refstruct.c.

Referenced by frame_context_init(), h264_init_context(), init_table_pools(), pic_arrays_init(), and vp9_frame_alloc().

Allocate an FFRefStructPool, potentially using complex callbacks.

Parameters

size size of the entries of the pool

flags a bitwise combination of FF_REFSTRUCT_POOL_FLAG_* flags

opaque A pointer that will be passed to the callbacks below.

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.

reset A callback that will be called after an entry has been returned to the pool and before it is reused.

free_entry A callback that will be called when an entry is freed after the pool has been marked as to be uninitialized.

free A callback that will be called when the pool itself is freed (after the last entry has been returned and freed).

Definition at line 340 of file refstruct.c.

Referenced by ff_refstruct_pool_alloc_ext().

A wrapper around ff_refstruct_pool_alloc_ext_c() for the common case of a non-const qualified opaque.

See also

ff_refstruct_pool_alloc_ext_c()

Definition at line 258 of file refstruct.h.

Referenced by ff_nvdec_decode_init(), ff_refstruct_pool_alloc(), and ff_vaapi_encode_init().

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(). Otherwise undefined behaviour may occur.

Parameters

pool the pool from which to get the object

Returns

a reference to the object on success, NULL on error.

Definition at line 297 of file refstruct.c.

Referenced by alloc_cu(), alloc_frame(), alloc_picture(), alloc_tu(), ff_nvdec_start_frame(), ff_nvdec_start_frame_sep_ref(), vaapi_encode_issue(), and vp9_frame_alloc().

Mark the pool as being available for freeing.

It will actually be freed only once all the allocated buffers associated with the pool are released. Thus it is safe to call this function while some of the allocated buffers are still in use.

It is illegal to try to get a new entry after this function has been called.

Parameters

poolp pointer to a pointer to either NULL or a pool to be freed. *poolp will be set to NULL.

Definition at line 292 of file refstruct.h.

Referenced by ff_h264_free_tables(), ff_nvdec_decode_uninit(), ff_vaapi_encode_close(), frame_context_free(), h264_decode_end(), init_table_pools(), pic_arrays_free(), pic_arrays_init(), vp9_decode_free(), and vp9_frame_alloc().