upipe-av/upipe_avfilter.h header reference
Upipe avfilter module More
Header inclusion [link]
Members [link]
Types [link]
- enum upipe_avfilt_command
- enum upipe_avfilt_mgr_command
Functions [link]
- const char * upipe_avfilt_command_str(int command)
- struct upipe_mgr * upipe_avfilt_mgr_alloc(void )
- int upipe_avfilt_mgr_get_color_primaries_name(struct upipe_mgr *mgr, int color_primaries, const char **name)
- int upipe_avfilt_mgr_get_color_space_name(struct upipe_mgr *mgr, int color_space, const char **name)
- int upipe_avfilt_mgr_get_color_transfer_name(struct upipe_mgr *mgr, int color_transfer, const char **name)
- int upipe_avfilt_mgr_get_pixfmt_name(struct upipe_mgr *mgr, struct uref *flow_def, const char **name, bool software)
- int upipe_avfilt_send_command(struct upipe *upipe, const char *target, const char *command, const char *arg)
- int upipe_avfilt_send_command_va(struct upipe *upipe, const char *target, const char *command, const char *format, ...)
- int upipe_avfilt_set_filters_desc(struct upipe *upipe, const char *filters_desc)
- int upipe_avfilt_set_hw_config(struct upipe *upipe, const char *hw_type, const char *hw_device)
Description [link]
Upipe avfilter module
Members detail [link]
#define UPIPE_AVFILT_SIGNATURE [link]
This macro is declared in upipe-av/upipe_avfilter.h source file, line 40.
#define UPIPE_AVFILT_SUB_SIGNATURE [link]
This macro is declared in upipe-av/upipe_avfilter.h source file, line 41.
#define _UPIPE_AV_UPIPE_AVFILTER_H_ [link]
This macro is declared in upipe-av/upipe_avfilter.h source file, line 33.
enum upipe_avfilt_command [link]
This enum is declared in upipe-av/upipe_avfilter.h source file, line 45.
This enum extends upipe_command with specific commands for avfilt.
| Identifier | Value | Description |
|---|---|---|
| UPIPE_AVFILT_SENTINEL | 0x8000 | |
| UPIPE_AVFILT_SET_FILTERS_DESC | 1 | set the filter graph description (const char *) |
| UPIPE_AVFILT_SET_HW_CONFIG | 2 | set the hardware config (const char *, const char *) |
| UPIPE_AVFILT_SEND_COMMAND | 3 | sends a command to one or more filter instances (const char *, const char *, const char *) |
const char * upipe_avfilt_command_str(int command) [link]
This function is declared in upipe-av/upipe_avfilter.h source file, line 63.
This function converts enum upipe_avfilt_command to a string.
Parameter list:
- command: command to convert
The return value is a string or NULL if invalid
This function is declared in upipe-av/upipe_avfilter.h source file, line 146.
This function returns the management structure for all avfilter pipes.
The return value is pointer to manager
enum upipe_avfilt_mgr_command [link]
This enum is declared in upipe-av/upipe_avfilter.h source file, line 149.
This enum extends upipe_mgr_command with specific commands for avfilt.
| Identifier | Value | Description |
|---|---|---|
| UPIPE_AVFILT_MGR_SENTINEL | 0x8000 | |
| UPIPE_AVFILT_MGR_GET_PIXFMT_NAME | 1 | gets the pixel format name from flow def (struct uref *, const char **, bool) |
| UPIPE_AVFILT_MGR_GET_COLOR_PRIMARIES_NAME | 2 | gets the color primaries name (int, const char **) |
| UPIPE_AVFILT_MGR_GET_COLOR_TRANSFER_NAME | 3 | gets the color transfer characteristics name (int, const char **) |
| UPIPE_AVFILT_MGR_GET_COLOR_SPACE_NAME | 4 | gets the color space name (int, const char **) |
int upipe_avfilt_mgr_get_color_primaries_name(struct upipe_mgr *mgr, int color_primaries, const char **name) [link]
This function is declared in upipe-av/upipe_avfilter.h source file, line 187.
This function returns the color primaries name for the given value.
Parameter list:
- mgr: pointer to manager
- color_primaries: color primaries value
- name: color primaries name
The return value is an error code
int upipe_avfilt_mgr_get_color_space_name(struct upipe_mgr *mgr, int color_space, const char **name) [link]
This function is declared in upipe-av/upipe_avfilter.h source file, line 215.
This function returns the color space name for the given value.
Parameter list:
- mgr: pointer to manager
- color_space: color space value
- name: color space name
The return value is an error code
int upipe_avfilt_mgr_get_color_transfer_name(struct upipe_mgr *mgr, int color_transfer, const char **name) [link]
This function is declared in upipe-av/upipe_avfilter.h source file, line 201.
This function returns the color transfer name for the given value.
Parameter list:
- mgr: pointer to manager
- color_transfer: color transfer characteristics value
- name: color transfer characteristics name
The return value is an error code
int upipe_avfilt_mgr_get_pixfmt_name(struct upipe_mgr *mgr, struct uref *flow_def, const char **name, bool software) [link]
This function is declared in upipe-av/upipe_avfilter.h source file, line 173.
This function returns the pixel format name for the given flow definition.
Parameter list:
- mgr: pointer to manager
- flow_def: flow definition packet
- name: pixel format name
The return value is an error code
int upipe_avfilt_send_command(struct upipe *upipe, const char *target, const char *command, const char *arg) [link]
This function is declared in upipe-av/upipe_avfilter.h source file, line 116.
This function sends a command to one or more filter instances
Parameter list:
- upipe: description structure of the pipe
- target: the filter(s) to which the command should be sent "all" sends to all filters otherwise it can be a filter or filter instance name which will send the command to all matching filters.
- command: the command to send
- arg: the arguments of the command
The return value is an error code
int upipe_avfilt_send_command_va(struct upipe *upipe, const char *target, const char *command, const char *format, ...) [link]
This function is declared in upipe-av/upipe_avfilter.h source file, line 137.
This function sends a command to one or more filter instances
Parameter list:
- upipe: description structure of the pipe
- target: the filter(s) to which the command should be sent "all" sends to all filters otherwise it can be a filter or filter instance name which will send the command to all matching filters.
- command: the command to send
- format: the arguments format string of the command
The return value is an error code
This function is declared in upipe-av/upipe_avfilter.h source file, line 81.
This function sets the filter graph description.
Parameter list:
- upipe: description structure of the pipe
- filters: filter graph description
The return value is an error code
int upipe_avfilt_set_hw_config(struct upipe *upipe, const char *hw_type, const char *hw_device) [link]
This function is declared in upipe-av/upipe_avfilter.h source file, line 96.
This function sets the hardware configuration.
Parameter list:
- upipe: description structure of the pipe
- hw_type: hardware type
- hw_device: hardware device (use NULL for default)
The return value is an error code