Typedefs | |
| typedef struct bgav_options_s | bgav_options_t |
| Opaque option container. | |
| typedef void(* | bgav_log_callback )(void *data, bgav_log_level_t level, const char *log_domain, const char *message) |
| Function to be called for loggins messages. | |
| typedef void(* | bgav_name_change_callback )(void *data, const char *name) |
| Function to be called if the track name changes. | |
| typedef void(* | bgav_metadata_change_callback )(void *data, const bgav_metadata_t *metadata) |
| Function to be called if the metadata change. | |
| typedef void(* | bgav_track_change_callback )(void *data, int track) |
| Function to be called if the track number changes. | |
| typedef void(* | bgav_buffer_callback )(void *data, float percentage) |
| Function to be called if the input module is buffering data. | |
| typedef int(* | bgav_user_pass_callback )(void *data, const char *resource, char **username, char **password) |
| Function to be called if the input module needs authentication data. | |
| typedef void(* | bgav_aspect_callback )(void *data, int stream, int pixel_width, int pixel_height) |
| Function to be called if a change of the aspect ratio was detected. | |
| typedef void(* | bgav_index_callback )(void *data, float percentage) |
| Function to be called periodically while an index is built. | |
Enumerations | |
| enum | bgav_log_level_t { BGAV_LOG_DEBUG, BGAV_LOG_WARNING, BGAV_LOG_ERROR, BGAV_LOG_INFO } |
| Enumeration for log levels. More... | |
Functions | |
| bgav_options_t * | bgav_get_options (bgav_t *bgav) |
| Get the options of a decoder instance. | |
| bgav_options_t * | bgav_options_create () |
| Create an options container. | |
| void | bgav_options_destroy (bgav_options_t *opt) |
| Destroy option cotainer. | |
| void | bgav_options_copy (bgav_options_t *dst, const bgav_options_t *src) |
| Copy options. | |
| void | bgav_options_set_connect_timeout (bgav_options_t *opt, int timeout) |
| Set connect timeout. | |
| void | bgav_options_set_read_timeout (bgav_options_t *opt, int timeout) |
| Set read timeout. | |
| void | bgav_options_set_rtp_port_base (bgav_options_t *b, int p) |
| Set RTP port pase. | |
| void | bgav_options_set_rtp_try_tcp (bgav_options_t *b, int enable) |
| Try TCP before UDP. | |
| void | bgav_options_set_network_bandwidth (bgav_options_t *opt, int bandwidth) |
| Set network bandwidth. | |
| void | bgav_options_set_network_buffer_size (bgav_options_t *opt, int size) |
| Set network buffer size. | |
| void | bgav_options_set_http_use_proxy (bgav_options_t *opt, int enable) |
| Set proxy usage. | |
| void | bgav_options_set_http_proxy_host (bgav_options_t *opt, const char *host) |
| Set proxy host. | |
| void | bgav_options_set_http_proxy_port (bgav_options_t *opt, int port) |
| Set proxy port. | |
| void | bgav_options_set_http_proxy_auth (bgav_options_t *opt, int enable) |
| Enable or disable proxy authentication. | |
| void | bgav_options_set_http_proxy_user (bgav_options_t *opt, const char *user) |
| Set proxy username. | |
| void | bgav_options_set_http_proxy_pass (bgav_options_t *opt, const char *pass) |
| Set proxy password. | |
| void | bgav_options_set_http_shoutcast_metadata (bgav_options_t *opt, int enable) |
| Enable or disable shoutcast metadata streaming. | |
| void | bgav_options_set_ftp_anonymous (bgav_options_t *opt, int enable) |
| Enable or disable anonymous ftp login. | |
| void | bgav_options_set_ftp_anonymous_password (bgav_options_t *opt, const char *pass) |
| Set anonymous password. | |
| void | bgav_options_set_default_subtitle_encoding (bgav_options_t *opt, const char *encoding) |
| Set default subtitle encoding. | |
| void | bgav_options_set_audio_dynrange (bgav_options_t *opt, int audio_dynrange) |
| Enable dynamic range control. | |
| void | bgav_options_set_seamless (bgav_options_t *opt, int seamless) |
| Enable seamless playback. | |
| void | bgav_options_set_sample_accurate (bgav_options_t *opt, int enable) |
| Try to be sample accurate. | |
| void | bgav_options_set_cache_time (bgav_options_t *opt, int t) |
| Set the index creation time for caching. | |
| void | bgav_options_set_cache_size (bgav_options_t *opt, int s) |
| Set the maximum total size of the index cache. | |
| void | bgav_options_set_seek_subtitles (bgav_options_t *opt, int seek_subtitles) |
| Enable external subtitle files. | |
| void | bgav_options_set_pp_level (bgav_options_t *opt, int pp_level) |
| Set postprocessing level. | |
| void | bgav_options_set_dvb_channels_file (bgav_options_t *opt, const char *file) |
| Set DVB channels file. | |
| void | bgav_options_set_prefer_ffmpeg_demuxers (bgav_options_t *opt, int prefer) |
| Preference of ffmpeg demultiplexers. | |
| void | bgav_options_set_dv_datetime (bgav_options_t *opt, int datetime) |
| Exports the date and time as timecode field of DV streams. | |
| void | bgav_options_set_shrink (bgav_options_t *opt, int factor) |
| Shrink factor. | |
| void | bgav_options_set_log_callback (bgav_options_t *opt, bgav_log_callback callback, void *data) |
| Set the callback for log messages. | |
| void | bgav_options_set_name_change_callback (bgav_options_t *opt, bgav_name_change_callback callback, void *data) |
| Set the callback for name change events. | |
| void | bgav_options_set_metadata_change_callback (bgav_options_t *opt, bgav_metadata_change_callback callback, void *data) |
| Set the callback for metadata change events. | |
| void | bgav_options_set_track_change_callback (bgav_options_t *opt, bgav_track_change_callback callback, void *data) |
| Set the callback for track change events. | |
| void | bgav_options_set_buffer_callback (bgav_options_t *opt, bgav_buffer_callback callback, void *data) |
| Set the callback for buffering notification. | |
| void | bgav_options_set_user_pass_callback (bgav_options_t *opt, bgav_user_pass_callback callback, void *data) |
| Set the callback for user authentication. | |
| void | bgav_options_set_aspect_callback (bgav_options_t *opt, bgav_aspect_callback callback, void *data) |
| Set aspect ratio change callback. | |
| void | bgav_options_set_index_callback (bgav_options_t *opt, bgav_index_callback callback, void *data) |
| Set index build callback. | |
All options become valid with (and should not be changed after) the call to one of the bgav_open* functions.
| typedef struct bgav_options_s bgav_options_t |
Opaque option container.
| typedef void(* bgav_log_callback)(void *data, bgav_log_level_t level, const char *log_domain, const char *message) |
Function to be called for loggins messages.
| data | The data you passed to bgav_options_set_log_callback. | |
| level | The log level | |
| log_domain | A string describing the module from which the message comes | |
| message | The message itself |
| typedef void(* bgav_name_change_callback)(void *data, const char *name) |
Function to be called if the track name changes.
| data | The data you passed to bgav_options_set_name_change_callback. | |
| name | The new name of the track |
| typedef void(* bgav_metadata_change_callback)(void *data, const bgav_metadata_t *metadata) |
Function to be called if the metadata change.
| data | The data you passed to bgav_options_set_metadata_change_callback. | |
| metadata | The new metadata of the track |
| typedef void(* bgav_track_change_callback)(void *data, int track) |
Function to be called if the track number changes.
| data | The data you passed to bgav_options_set_track_change_callback. | |
| track | The new track number |
| typedef void(* bgav_buffer_callback)(void *data, float percentage) |
Function to be called if the input module is buffering data.
| data | The data you passed to bgav_options_set_buffer_callback. | |
| percentage | The percentage done so far (0.0 .. 1.0) |
| typedef int(* bgav_user_pass_callback)(void *data, const char *resource, char **username, char **password) |
Function to be called if the input module needs authentication data.
| data | The data you passed to bgav_options_set_user_pass_callback. | |
| resource | A string describing the resource (e.g. the hostname of the server) | |
| username | Returns the username. | |
| password | Returns the password. |
| typedef void(* bgav_aspect_callback)(void *data, int stream, int pixel_width, int pixel_height) |
Function to be called if a change of the aspect ratio was detected.
| data | The data you passed to bgav_options_set_aspect_callback. | |
| stream | Index of the video stream (starts with 0) | |
| pixel_width | New pixel width | |
| pixel_height | New pixel height |
| typedef void(* bgav_index_callback)(void *data, float percentage) |
Function to be called periodically while an index is built.
| data | The data you passed to bgav_options_set_index_callback. | |
| perc | Percentage completed to far |
| enum bgav_log_level_t |
Enumeration for log levels.
These will be called from within log callbacks
| bgav_options_t* bgav_get_options | ( | bgav_t * | bgav | ) |
Get the options of a decoder instance.
| bgav_options_t* bgav_options_create | ( | ) |
Create an options container.
To pass the options to a decoder structure, use bgav_get_options and bgav_options_copy.
| void bgav_options_destroy | ( | bgav_options_t * | opt | ) |
Destroy option cotainer.
| opt | option cotainer |
| void bgav_options_copy | ( | bgav_options_t * | dst, | |
| const bgav_options_t * | src | |||
| ) |
Copy options.
| dst | Destination | |
| src | Source |
| void bgav_options_set_connect_timeout | ( | bgav_options_t * | opt, | |
| int | timeout | |||
| ) |
Set connect timeout.
| opt | Option container | |
| timeout | Timeout in milliseconds. |
| void bgav_options_set_read_timeout | ( | bgav_options_t * | opt, | |
| int | timeout | |||
| ) |
Set read timeout.
| opt | Option container | |
| timeout | Timeout in milliseconds. |
| void bgav_options_set_rtp_port_base | ( | bgav_options_t * | b, | |
| int | p | |||
| ) |
Set RTP port pase.
| opt | Option container | |
| p | Port base |
| void bgav_options_set_rtp_try_tcp | ( | bgav_options_t * | b, | |
| int | enable | |||
| ) |
Try TCP before UDP.
| opt | Option container | |
| enable | 1 to try TCP, 0 else |
| void bgav_options_set_network_bandwidth | ( | bgav_options_t * | opt, | |
| int | bandwidth | |||
| ) |
Set network bandwidth.
| opt | Option container | |
| bandwidth | Bandwidth of your internet connection (in bits per second) |
| void bgav_options_set_network_buffer_size | ( | bgav_options_t * | opt, | |
| int | size | |||
| ) |
Set network buffer size.
| opt | Option container | |
| size | Buffer size in bytes |
| void bgav_options_set_http_use_proxy | ( | bgav_options_t * | opt, | |
| int | enable | |||
| ) |
Set proxy usage.
| opt | Option container | |
| enable | Set 1 of you use a http proxy, 0 else. |
| void bgav_options_set_http_proxy_host | ( | bgav_options_t * | opt, | |
| const char * | host | |||
| ) |
Set proxy host.
| opt | Option container | |
| host | Hostname of the proxy. |
| void bgav_options_set_http_proxy_port | ( | bgav_options_t * | opt, | |
| int | port | |||
| ) |
Set proxy port.
| opt | Option container | |
| port | Port of the proxy. |
| void bgav_options_set_http_proxy_auth | ( | bgav_options_t * | opt, | |
| int | enable | |||
| ) |
Enable or disable proxy authentication.
| opt | Option container | |
| enable | Set 1 if your http proxy needs authentication, 0 else. |
| void bgav_options_set_http_proxy_user | ( | bgav_options_t * | opt, | |
| const char * | user | |||
| ) |
Set proxy username.
| opt | Option container | |
| user | The username for the proxy. |
| void bgav_options_set_http_proxy_pass | ( | bgav_options_t * | opt, | |
| const char * | pass | |||
| ) |
Set proxy password.
| opt | Option container | |
| pass | The password for the proxy. |
| void bgav_options_set_http_shoutcast_metadata | ( | bgav_options_t * | opt, | |
| int | enable | |||
| ) |
Enable or disable shoutcast metadata streaming.
| opt | Option container | |
| enable | Set to 1 if the decoder should try to get shoutcast metadata, 0 else |
| void bgav_options_set_ftp_anonymous | ( | bgav_options_t * | opt, | |
| int | enable | |||
| ) |
Enable or disable anonymous ftp login.
| opt | Option container | |
| enable | Set to 1 if the decoder should try log anonymously into ftp servers, 0 else |
| void bgav_options_set_ftp_anonymous_password | ( | bgav_options_t * | opt, | |
| const char * | pass | |||
| ) |
Set anonymous password.
| opt | Option container | |
| pass | Note that you must enable anonymous ftp login with bgav_options_set_ftp_anonymous. |
| void bgav_options_set_default_subtitle_encoding | ( | bgav_options_t * | opt, | |
| const char * | encoding | |||
| ) |
Set default subtitle encoding.
| opt | Option container | |
| encoding | Encoding |
| void bgav_options_set_audio_dynrange | ( | bgav_options_t * | opt, | |
| int | audio_dynrange | |||
| ) |
Enable dynamic range control.
| opt | Option container | |
| audio_dynrange | 1 for enabling dynamic range control. |
| void bgav_options_set_seamless | ( | bgav_options_t * | opt, | |
| int | seamless | |||
| ) |
Enable seamless playback.
| opt | Option container | |
| seamless | 1 for enabling seamless playback |
| void bgav_options_set_sample_accurate | ( | bgav_options_t * | opt, | |
| int | enable | |||
| ) |
Try to be sample accurate.
| opt | Option container | |
| enable | 1 is sample accurate mode is requested |
| void bgav_options_set_cache_time | ( | bgav_options_t * | opt, | |
| int | t | |||
| ) |
Set the index creation time for caching.
| opt | Option container | |
| t | Time (in milliseconds) needed for creating the index |
| void bgav_options_set_cache_size | ( | bgav_options_t * | opt, | |
| int | s | |||
| ) |
Set the maximum total size of the index cache.
| opt | Option container | |
| s | Maximum size (in megabytes) of the whole cache directory |
| void bgav_options_set_seek_subtitles | ( | bgav_options_t * | opt, | |
| int | seek_subtitles | |||
| ) |
Enable external subtitle files.
| opt | Option container | |
| seek_subtitles | If 1, subtitle files will be seeked for video files. If 2, subtitles will be seeked for all files. |
| void bgav_options_set_pp_level | ( | bgav_options_t * | opt, | |
| int | pp_level | |||
| ) |
Set postprocessing level.
| opt | Option container | |
| pp_level | Value between 0 (no postprocessing) and 6 (maximum postprocessing) |
| void bgav_options_set_dvb_channels_file | ( | bgav_options_t * | opt, | |
| const char * | file | |||
| ) |
Set DVB channels file.
| opt | Option container | |
| file | Name of the channel configurations file |
| void bgav_options_set_prefer_ffmpeg_demuxers | ( | bgav_options_t * | opt, | |
| int | prefer | |||
| ) |
Preference of ffmpeg demultiplexers.
| opt | Option container | |
| prefer | 1 to prefer ffmpeg demultiplexers, 0 else |
| void bgav_options_set_dv_datetime | ( | bgav_options_t * | opt, | |
| int | datetime | |||
| ) |
Exports the date and time as timecode field of DV streams.
| opt | Option container | |
| datetime | 1 to export date and time as timecodes, 0 else |
| void bgav_options_set_shrink | ( | bgav_options_t * | opt, | |
| int | factor | |||
| ) |
Shrink factor.
| opt | Option container | |
| Exponent | of the shrink factor |
| void bgav_options_set_log_callback | ( | bgav_options_t * | opt, | |
| bgav_log_callback | callback, | |||
| void * | data | |||
| ) |
Set the callback for log messages.
| opt | Option container | |
| callback | The callback | |
| data | Some data you want to get passed to the callback |
| void bgav_options_set_name_change_callback | ( | bgav_options_t * | opt, | |
| bgav_name_change_callback | callback, | |||
| void * | data | |||
| ) |
Set the callback for name change events.
| opt | Option container | |
| callback | The callback | |
| data | Some data you want to get passed to the callback |
| void bgav_options_set_metadata_change_callback | ( | bgav_options_t * | opt, | |
| bgav_metadata_change_callback | callback, | |||
| void * | data | |||
| ) |
Set the callback for metadata change events.
| opt | Option container | |
| callback | The callback | |
| data | Some data you want to get passed to the callback |
| void bgav_options_set_track_change_callback | ( | bgav_options_t * | opt, | |
| bgav_track_change_callback | callback, | |||
| void * | data | |||
| ) |
Set the callback for track change events.
| opt | Option container | |
| callback | The callback | |
| data | Some data you want to get passed to the callback |
| void bgav_options_set_buffer_callback | ( | bgav_options_t * | opt, | |
| bgav_buffer_callback | callback, | |||
| void * | data | |||
| ) |
Set the callback for buffering notification.
| opt | Option container | |
| callback | The callback | |
| data | Some data you want to get passed to the callback |
| void bgav_options_set_user_pass_callback | ( | bgav_options_t * | opt, | |
| bgav_user_pass_callback | callback, | |||
| void * | data | |||
| ) |
Set the callback for user authentication.
| opt | Option container | |
| callback | The callback | |
| data | Some data you want to get passed to the callback |
| void bgav_options_set_aspect_callback | ( | bgav_options_t * | opt, | |
| bgav_aspect_callback | callback, | |||
| void * | data | |||
| ) |
Set aspect ratio change callback.
| opt | Option container | |
| callback | The callback | |
| data | Some data you want to get passed to the callback |
| void bgav_options_set_index_callback | ( | bgav_options_t * | opt, | |
| bgav_index_callback | callback, | |||
| void * | data | |||
| ) |
Set index build callback.
| opt | Option container | |
| callback | The callback | |
| data | Some data you want to get passed to the callback |
1.5.7