vlc_filter_operations Struct Reference

#include <vlc_filter.h>

Collaboration diagram for vlc_filter_operations:

Data Fields
union {
picture_t *(*   filter_video )(filter_t *, picture_t *)
	Filter a picture (video filter) More...
block_t *(*   filter_audio )(filter_t *, block_t *)
	Filter an audio block (audio filter) More...
void(*   blend_video )(filter_t *, picture_t *,        const picture_t *, int, int,        int)
	Blend a subpicture onto a picture (video blending) More...
subpicture_t *(*   source_sub )(filter_t *, vlc_tick_t)
	Generate a subpicture (sub source) More...
subpicture_t *(*   filter_sub )(filter_t *, subpicture_t *)
	Filter a subpicture (sub filter) More...
subpicture_region_t *(*   render )(filter_t *, const       subpicture_region_t *, const       vlc_fourcc_t *)
	Render text (text renderer) More...
};
union {
block_t *(*   drain_audio )(filter_t *)
	Drain (audio filter) More...
};
void(*	flush )(filter_t *)
	Flush.
void(*	change_viewpoint )(filter_t *, const vlc_viewpoint_t *)
	Change viewpoint.
int(*	video_mouse )(filter_t *, struct vlc_mouse_t *, const struct vlc_mouse_t *p_old)
	Filter mouse state (video filter).
void(*	close )(filter_t *)
	Close the filter and release its resources.

Field Documentation

[union]

union { ... } vlc_filter_operations

[union]

union { ... } vlc_filter_operations

blend_video

void(* vlc_filter_operations::blend_video) (filter_t *, picture_t *, const picture_t *, int, int, int)

Blend a subpicture onto a picture (video blending)

Referenced by filter_Blend().

change_viewpoint

void(* vlc_filter_operations::change_viewpoint) (filter_t *, const vlc_viewpoint_t *)

Change viewpoint.

Pass a new viewpoint to audio filters. Filters like the spatialaudio one used for Ambisonics rendering will change its output according to this viewpoint.

Referenced by filter_ChangeViewpoint().

close

void(* vlc_filter_operations::close) (filter_t *)

Close the filter and release its resources.

Referenced by vlc_filter_UnloadModule().

drain_audio

block_t *(* vlc_filter_operations::drain_audio) (filter_t *)

Drain (audio filter)

Referenced by filter_DrainAudio(), and vlc_audio_meter_AddPlugin().

filter_audio

block_t *(* vlc_filter_operations::filter_audio) (filter_t *, block_t *)

Filter an audio block (audio filter)

Referenced by aout_filter_Create(), aout_FiltersPipelinePlay(), and vlc_audio_meter_Process().

filter_sub

subpicture_t *(* vlc_filter_operations::filter_sub) (filter_t *, subpicture_t *)

Filter a subpicture (sub filter)

Referenced by SubFilter().

filter_video

picture_t *(* vlc_filter_operations::filter_video) (filter_t *, picture_t *)

Filter a picture (video filter)

Referenced by FilterSingleChainedFilter(), ImageConvert(), ImageRead(), ImageWrite(), and SpuRenderRegion().

flush

void(* vlc_filter_operations::flush) (filter_t *)

Flush.

Flush (i.e. discard) any internal buffer in a video or audio filter.

Referenced by filter_Flush().

render

subpicture_region_t *(* vlc_filter_operations::render) (filter_t *, const subpicture_region_t *, const vlc_fourcc_t *)

Render text (text renderer)

Returns

a picture-based region or NULL

Referenced by SpuRenderText().

source_sub

subpicture_t *(* vlc_filter_operations::source_sub) (filter_t *, vlc_tick_t)

Generate a subpicture (sub source)

Referenced by SubSourceGenerate().

video_mouse

int(* vlc_filter_operations::video_mouse) (filter_t *, struct vlc_mouse_t *, const struct vlc_mouse_t *p_old)

Filter mouse state (video filter).

If non-NULL, you must convert from output to input formats:

• If VLC_SUCCESS is returned, the mouse state is propagated.
• Otherwise, the mouse change is not propagated. If NULL, the mouse state is considered unchanged and will be propagated.

Referenced by filter_chain_HasMouseFilter(), and filter_chain_MouseFilter().

---

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

• include/vlc_filter.h