video_frame_callbacks Struct Reference

Struct containing callbacks of a video_frame. More...

#include <types.h>

Collaboration diagram for video_frame_callbacks:

Public Attributes
void(*	copy )(struct video_frame *)
void(*	data_deleter )(struct video_frame *)
void(*	recycle )(struct video_frame *)
void(*	dispose )(struct video_frame *)
void *	dispose_udata

Detailed Description

Struct containing callbacks of a video_frame.

Definition at line 230 of file types.h.

Member Data Documentation

copy

void(* video_frame_callbacks::copy) (struct video_frame *)

This function is used to copy extra data held by the frame and is automatically called by the vf_get_copy function. This function is currently used to make new references to hw surfaces when creating copies of hw frames.

Definition at line 271 of file types.h.

Referenced by vf_get_copy().

data_deleter

void(* video_frame_callbacks::data_deleter) (struct video_frame *)

This function (if defined) is called by vf_free() to destruct video data (tile::data members).

Definition at line 256 of file types.h.

Referenced by allocate_result_frame(), create_jpeg_frame(), decode_frame_h264(), decode_video_frame(), display_dump_reconfigure(), display_file_getf(), filter(), filter(), filter(), filter(), filter(), filter(), filter(), video_frame_pool::impl::get_pod_frame(), process_video_pkt(), recreate_textures(), vf_alloc_desc_data(), vf_free(), vf_get_copy(), and vidcap_testcard2_grab().

dispose

void(* video_frame_callbacks::dispose) (struct video_frame *)

Note

Can be changed only by frame originator.

Deprecated

This is currently used only by video_capture and capture_filter modules and should not be used elsewhere!

This function (if defined) is called when frame is no longer needed by processing queue.

Note

Currently, this is only used in sending workflow, not the receiving one! Can be called from arbitrary thread.

Definition at line 245 of file types.h.

Referenced by capture_thread(), cf_crop_filter(), cf_deinterlace_filter(), cf_text_filter(), display_decklink_getf(), display_decklink_putf(), display_pipe_getf(), filter(), filter(), filter(), filter(), filter(), filter(), filter(), filter(), filter(), filter(), filter(), filter(), hd_rum_decompress::state_transcoder_decompress::frame_arrived(), video_frame_pool::impl::get_disposable_frame(), get_sps_pps_frame(), vidcap_state_aja::grab(), j2k_compress_pop(), process_video_pkt(), slave_worker(), vidcap_bitflow_grab(), vidcap_deltacast_dvi_grab(), vidcap_import_grab(), vidcap_ndi_grab(), vidcap_rtsp_grab(), vidcap_spout_grab(), vidcap_syphon_grab(), vidcap_testcard2_grab(), vidcap_ug_input_grab(), and vidcap_v4l2_grab().

dispose_udata

void* video_frame_callbacks::dispose_udata

Additional data needed to dispose the frame

Definition at line 249 of file types.h.

Referenced by allocate_frame(), capture_thread(), cineform_compress_pop(), delete_frame(), delete_frame(), display_decklink_getf(), display_decklink_putf(), display_file_getf(), display_frame(), display_pw_putf(), dispose_frame(), dispose_frame(), dispose_frame(), filter(), filter(), filter(), video_frame_pool::impl::get_disposable_frame(), video_frame_pool::impl::get_pod_frame(), vidcap_state_aja::grab(), Texture::load_frame(), recreate_textures(), recycle_frame(), slave_worker(), vf_sdl_texture_data_deleter(), vidcap_deltacast_dvi_dispose(), vidcap_deltacast_dvi_grab(), vidcap_import_dispose_video_frame(), vidcap_import_grab(), vidcap_ndi_grab(), vidcap_v4l2_dispose_video_frame(), vidcap_v4l2_grab(), worker(), and write_video_frame().

recycle

void(* video_frame_callbacks::recycle) (struct video_frame *)

This function is used to free extra data held by the frame and should be called before returning the frame to frame pool. This function is currently used to free references to hw surfaces.

Definition at line 263 of file types.h.

Referenced by allocate_result_frame(), av_drm_prime_to_ug_drm_prime(), hw_drm_recycle_callback(), hw_vdpau_recycle_callback(), vf_alloc_desc_data(), and vf_recycle().

---

The documentation for this struct was generated from the following file:

• src/types.h