avdevice.c File Reference

#include "libavutil/avassert.h"
#include "libavutil/samplefmt.h"
#include "libavutil/pixfmt.h"
#include "libavcodec/avcodec.h"
#include "avdevice.h"
#include "internal.h"
#include "config.h"
#include "libavutil/ffversion.h"

Go to the source code of this file.

Macros
#define	E   AV_OPT_FLAG_ENCODING_PARAM
#define	D   AV_OPT_FLAG_DECODING_PARAM
#define	A   AV_OPT_FLAG_AUDIO_PARAM
#define	V   AV_OPT_FLAG_VIDEO_PARAM
#define	OFFSET(x)   offsetof(AVDeviceCapabilitiesQuery, x)
#define	LICENSE_PREFIX   "libavdevice license: "

Functions
unsigned	avdevice_version (void)
	Return the LIBAVDEVICE_VERSION_INT constant. More...
const char *	avdevice_configuration (void)
	Return the libavdevice build-time configuration. More...
const char *	avdevice_license (void)
	Return the libavdevice license. More...
static void *	device_next (void *prev, int output, AVClassCategory c1, AVClassCategory c2)
AVInputFormat *	av_input_audio_device_next (AVInputFormat *d)
	Audio input devices iterator. More...
AVInputFormat *	av_input_video_device_next (AVInputFormat *d)
	Video input devices iterator. More...
AVOutputFormat *	av_output_audio_device_next (AVOutputFormat *d)
	Audio output devices iterator. More...
AVOutputFormat *	av_output_video_device_next (AVOutputFormat *d)
	Video output devices iterator. More...
int	avdevice_app_to_dev_control_message (struct AVFormatContext *s, enum AVAppToDevMessageType type, void *data, size_t data_size)
	Send control message from application to device. More...
int	avdevice_dev_to_app_control_message (struct AVFormatContext *s, enum AVDevToAppMessageType type, void *data, size_t data_size)
	Send control message from device to application. More...
int	avdevice_capabilities_create (AVDeviceCapabilitiesQuery **caps, AVFormatContext *s, AVDictionary **device_options)
	Initialize capabilities probing API based on AVOption API. More...
void	avdevice_capabilities_free (AVDeviceCapabilitiesQuery **caps, AVFormatContext *s)
	Free resources created by avdevice_capabilities_create() More...
int	avdevice_list_devices (AVFormatContext *s, AVDeviceInfoList **device_list)
	List devices. More...
static int	list_devices_for_context (AVFormatContext *s, AVDictionary *options, AVDeviceInfoList **device_list)
int	avdevice_list_input_sources (AVInputFormat *device, const char *device_name, AVDictionary *device_options, AVDeviceInfoList **device_list)
	List devices. More...
int	avdevice_list_output_sinks (AVOutputFormat *device, const char *device_name, AVDictionary *device_options, AVDeviceInfoList **device_list)
void	avdevice_free_list_devices (AVDeviceInfoList **device_list)
	Convenient function to free result of avdevice_list_devices(). More...

Variables
const char	av_device_ffversion [] = "FFmpeg version " FFMPEG_VERSION
const AVOption	av_device_capabilities []
	AVOption table used by devices to implement device capabilities API. More...

Macro Definition Documentation

#define E   AV_OPT_FLAG_ENCODING_PARAM

Definition at line 30 of file avdevice.c.

#define D   AV_OPT_FLAG_DECODING_PARAM

Definition at line 31 of file avdevice.c.

#define A   AV_OPT_FLAG_AUDIO_PARAM

Definition at line 32 of file avdevice.c.

#define V   AV_OPT_FLAG_VIDEO_PARAM

Definition at line 33 of file avdevice.c.

#define OFFSET

(

x

)

offsetof(AVDeviceCapabilitiesQuery, x)

Definition at line 34 of file avdevice.c.

#define LICENSE_PREFIX   "libavdevice license: "

Referenced by avdevice_license().

Function Documentation

unsigned avdevice_version

(

void

)

Return the LIBAVDEVICE_VERSION_INT constant.

Definition at line 64 of file avdevice.c.

const char* avdevice_configuration

(

void

)

Return the libavdevice build-time configuration.

Definition at line 70 of file avdevice.c.

const char* avdevice_license

(

void

)

Return the libavdevice license.

Definition at line 75 of file avdevice.c.

static void* device_next ( void *  prev, int  output, AVClassCategory  c1, AVClassCategory  c2  )

static

Definition at line 81 of file avdevice.c.

Referenced by av_input_audio_device_next(), av_input_video_device_next(), av_output_audio_device_next(), and av_output_video_device_next().

AVInputFormat* av_input_audio_device_next

(

AVInputFormat *

d

)

Audio input devices iterator.

If d is NULL, returns the first registered input audio/video device, if d is non-NULL, returns the next registered input audio/video device after d or NULL if d is the last one.

Definition at line 103 of file avdevice.c.

AVInputFormat* av_input_video_device_next

(

AVInputFormat *

d

)

Video input devices iterator.

If d is NULL, returns the first registered input audio/video device, if d is non-NULL, returns the next registered input audio/video device after d or NULL if d is the last one.

Definition at line 109 of file avdevice.c.

AVOutputFormat* av_output_audio_device_next

(

AVOutputFormat *

d

)

Audio output devices iterator.

If d is NULL, returns the first registered output audio/video device, if d is non-NULL, returns the next registered output audio/video device after d or NULL if d is the last one.

Definition at line 115 of file avdevice.c.

AVOutputFormat* av_output_video_device_next

(

AVOutputFormat *

d

)

Video output devices iterator.

If d is NULL, returns the first registered output audio/video device, if d is non-NULL, returns the next registered output audio/video device after d or NULL if d is the last one.

Definition at line 121 of file avdevice.c.

int avdevice_app_to_dev_control_message	(	struct AVFormatContext *	s,
		enum AVAppToDevMessageType	type,
		void *	data,
		size_t	data_size
	)

Send control message from application to device.

Parameters

s	device context.
type	message type.
data	message data. Exact type depends on message type.
data_size	size of message data.

Returns

>= 0 on success, negative on error. AVERROR(ENOSYS) when device doesn't implement handler of the message.

Definition at line 127 of file avdevice.c.

int avdevice_dev_to_app_control_message	(	struct AVFormatContext *	s,
		enum AVDevToAppMessageType	type,
		void *	data,
		size_t	data_size
	)

Send control message from device to application.

Parameters

s	device context.
type	message type.
data	message data. Can be NULL.
data_size	size of message data.

Returns

>= 0 on success, negative on error. AVERROR(ENOSYS) when application doesn't implement handler of the message.

Definition at line 135 of file avdevice.c.

Referenced by opengl_create_window(), opengl_draw(), opengl_release_window(), opengl_resize(), opengl_write_header(), opengl_write_trailer(), pulse_audio_sink_input_cb(), pulse_overflow(), pulse_stream_writable(), pulse_underflow(), and pulse_write_packet().

int avdevice_capabilities_create	(	AVDeviceCapabilitiesQuery **	caps,
		AVFormatContext *	s,
		AVDictionary **	device_options
	)

Initialize capabilities probing API based on AVOption API.

avdevice_capabilities_free() must be called when query capabilities API is not used anymore.

Parameters

[out]	caps	Device capabilities data. Pointer to a NULL pointer must be passed.
	s	Context of the device.
	device_options	An AVDictionary filled with device-private options. On return this parameter will be destroyed and replaced with a dict containing options that were not found. May be NULL. The same options must be passed later to avformat_write_header() for output devices or avformat_open_input() for input devices, or at any other place that affects device-private options.

Returns

>= 0 on success, negative otherwise.

Definition at line 143 of file avdevice.c.

void avdevice_capabilities_free	(	AVDeviceCapabilitiesQuery **	caps,
		AVFormatContext *	s
	)

Free resources created by avdevice_capabilities_create()

Parameters

caps	Device capabilities data to be freed.
s	Context of the device.

Definition at line 172 of file avdevice.c.

int avdevice_list_devices	(	struct AVFormatContext *	s,
		AVDeviceInfoList **	device_list
	)

List devices.

Returns available device names and their parameters.

Note

: Some devices may accept system-dependent device names that cannot be autodetected. The list returned by this function cannot be assumed to be always completed.

Parameters

	s	device context.
[out]	device_list	list of autodetected devices.

Returns

count of autodetected devices, negative on error.

Definition at line 187 of file avdevice.c.

Referenced by list_devices_for_context().

static int list_devices_for_context ( AVFormatContext *  s, AVDictionary *  options, AVDeviceInfoList **  device_list  )

static

Definition at line 212 of file avdevice.c.

Referenced by avdevice_list_input_sources(), and avdevice_list_output_sinks().

int avdevice_list_input_sources	(	struct AVInputFormat *	device,
		const char *	device_name,
		AVDictionary *	device_options,
		AVDeviceInfoList **	device_list
	)

List devices.

Returns available device names and their parameters. These are convinient wrappers for avdevice_list_devices(). Device context is allocated and deallocated internally.

Parameters

	device	device format. May be NULL if device name is set.
	device_name	device name. May be NULL if device format is set.
	device_options	An AVDictionary filled with device-private options. May be NULL. The same options must be passed later to avformat_write_header() for output devices or avformat_open_input() for input devices, or at any other place that affects device-private options.
[out]	device_list	list of autodetected devices

Returns

count of autodetected devices, negative on error.

Note

device argument takes precedence over device_name when both are set.

Definition at line 228 of file avdevice.c.

int avdevice_list_output_sinks	(	AVOutputFormat *	device,
		const char *	device_name,
		AVDictionary *	device_options,
		AVDeviceInfoList **	device_list
	)

Definition at line 239 of file avdevice.c.

void avdevice_free_list_devices

(

AVDeviceInfoList **

device_list

)

Convenient function to free result of avdevice_list_devices().

Parameters

devices

device list to be freed.

Definition at line 250 of file avdevice.c.

Referenced by avdevice_list_devices().

Variable Documentation

const char av_device_ffversion[] = "FFmpeg version " FFMPEG_VERSION

Definition at line 28 of file avdevice.c.

const AVOption av_device_capabilities[]

Initial value:

= {
    { "codec", "codec", OFFSET(codec), AV_OPT_TYPE_INT,
        {.i64 = AV_CODEC_ID_NONE}, AV_CODEC_ID_NONE, INT_MAX, E|D|A|V },
    { "sample_format", "sample format", OFFSET(sample_format), AV_OPT_TYPE_SAMPLE_FMT,
        {.i64 = AV_SAMPLE_FMT_NONE}, AV_SAMPLE_FMT_NONE, INT_MAX, E|D|A },
    { "sample_rate", "sample rate", OFFSET(sample_rate), AV_OPT_TYPE_INT,
        {.i64 = -1}, -1, INT_MAX, E|D|A },
    { "channels", "channels", OFFSET(channels), AV_OPT_TYPE_INT,
        {.i64 = -1}, -1, INT_MAX, E|D|A },
    { "channel_layout", "channel layout", OFFSET(channel_layout), AV_OPT_TYPE_CHANNEL_LAYOUT,
        {.i64 = -1}, -1, INT_MAX, E|D|A },
    { "pixel_format", "pixel format", OFFSET(pixel_format), AV_OPT_TYPE_PIXEL_FMT,
        {.i64 = AV_PIX_FMT_NONE}, AV_PIX_FMT_NONE, INT_MAX, E|D|V },
    { "window_size", "window size", OFFSET(window_width), AV_OPT_TYPE_IMAGE_SIZE,
        {.str = NULL}, -1, INT_MAX, E|D|V },
    { "frame_size", "frame size", OFFSET(frame_width), AV_OPT_TYPE_IMAGE_SIZE,
        {.str = NULL}, -1, INT_MAX, E|D|V },
    { "fps", "fps", OFFSET(fps), AV_OPT_TYPE_RATIONAL,
        {.dbl = -1}, -1, INT_MAX, E|D|V },
    { NULL }
}

AVOption table used by devices to implement device capabilities API.

Should not be used by a user.

Definition at line 36 of file avdevice.c.