capture_filter_info Struct Reference

#include <capture_filter.h>

Collaboration diagram for capture_filter_info:

Public Attributes
void(*	done )(void *state)
struct video_frame *(*	filter )(void *state, struct video_frame *f)
	Performs filtering.
int(*	init )(struct module *parent, const char *cfg, void **state)
	Initializes capture filter.

Detailed Description

Definition at line 49 of file capture_filter.h.

Member Data Documentation

done

void(* capture_filter_info::done) (void *state)

Definition at line 58 of file capture_filter.h.

Referenced by capture_filter_destroy(), and process_message().

filter

struct video_frame *(* capture_filter_info::filter) (void *state, struct video_frame *f)

Performs filtering.

Parameters

f	input frame

Note

Frame management note When input frame is no longer used (eg. returned new output frame), VIDEO_FRAME_DISPOSE(f) has to be called. Also, if you create new output frame, you may use its .dispose and .dispose_udata member to manage video_frame lifetime. This behavior may change towards use of shared_ptr<video_frame> in future.

Definition at line 58 of file capture_filter.h.

Referenced by capture_filter().

init

int(* capture_filter_info::init) (struct module *parent, const char *cfg, void **state)

Initializes capture filter.

Parameters

	parent	parent module
	cfg	configuration string from cmdline, not-NULL
[out]	state	output state

Return values

0	if initialized successfully
<0	if error
>0	no error but state was not returned, eg. showing help

Definition at line 57 of file capture_filter.h.

Referenced by create_filter().

---

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

• src/capture_filter.h