FFmpeg
avdevice.c
Go to the documentation of this file.
1 /*
2  * This file is part of FFmpeg.
3  *
4  * FFmpeg is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2.1 of the License, or (at your option) any later version.
8  *
9  * FFmpeg is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with FFmpeg; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17  */
18 
19 #include "libavutil/avassert.h"
20 #include "avdevice.h"
21 #include "internal.h"
22 
23 #if FF_API_DEVICE_CAPABILITIES
25  { NULL }
26 };
27 #endif
28 
30  void *data, size_t data_size)
31 {
32  if (!s->oformat || !s->oformat->control_message)
33  return AVERROR(ENOSYS);
34  return s->oformat->control_message(s, type, data, data_size);
35 }
36 
38  void *data, size_t data_size)
39 {
40  if (!s->control_message_cb)
41  return AVERROR(ENOSYS);
42  return s->control_message_cb(s, type, data, data_size);
43 }
44 
45 #if FF_API_DEVICE_CAPABILITIES
47  AVDictionary **device_options)
48 {
49  return AVERROR(ENOSYS);
50 }
51 
53 {
54  return;
55 }
56 #endif
57 
59 {
60  int ret;
61  av_assert0(s);
62  av_assert0(device_list);
63  av_assert0(s->oformat || s->iformat);
64  if ((s->oformat && !s->oformat->get_device_list) ||
65  (s->iformat && !s->iformat->get_device_list)) {
66  *device_list = NULL;
67  return AVERROR(ENOSYS);
68  }
69  *device_list = av_mallocz(sizeof(AVDeviceInfoList));
70  if (!(*device_list))
71  return AVERROR(ENOMEM);
72  /* no default device by default */
73  (*device_list)->default_device = -1;
74  if (s->oformat)
75  ret = s->oformat->get_device_list(s, *device_list);
76  else
77  ret = s->iformat->get_device_list(s, *device_list);
78  if (ret < 0) {
79  avdevice_free_list_devices(device_list);
80  return ret;
81  }
82  return (*device_list)->nb_devices;
83 }
84 
86  AVDeviceInfoList **device_list)
87 {
89  int ret;
90 
91  av_dict_copy(&tmp, options, 0);
93  goto fail;
94  ret = avdevice_list_devices(s, device_list);
95  fail:
96  av_dict_free(&tmp);
98  return ret;
99 }
100 
101 int avdevice_list_input_sources(const AVInputFormat *device, const char *device_name,
102  AVDictionary *device_options, AVDeviceInfoList **device_list)
103 {
105  int ret;
106 
107  if ((ret = ff_alloc_input_device_context(&s, device, device_name)) < 0)
108  return ret;
109  return list_devices_for_context(s, device_options, device_list);
110 }
111 
112 int avdevice_list_output_sinks(const AVOutputFormat *device, const char *device_name,
113  AVDictionary *device_options, AVDeviceInfoList **device_list)
114 {
116  int ret;
117 
118  if ((ret = avformat_alloc_output_context2(&s, device, device_name, NULL)) < 0)
119  return ret;
120  return list_devices_for_context(s, device_options, device_list);
121 }
122 
124 {
126  AVDeviceInfo *dev;
127  int i;
128 
129  av_assert0(device_list);
130  list = *device_list;
131  if (!list)
132  return;
133 
134  for (i = 0; i < list->nb_devices; i++) {
135  dev = list->devices[i];
136  if (dev) {
137  av_freep(&dev->device_name);
139  av_freep(&dev->media_types);
140  av_free(dev);
141  }
142  }
143  av_freep(&list->devices);
144  av_freep(device_list);
145 }
AVERROR
Filter the word “frame” indicates either a video frame or a group of audio as stored in an AVFrame structure Format for each input and each output the list of supported formats For video that means pixel format For audio that means channel sample they are references to shared objects When the negotiation mechanism computes the intersection of the formats supported at each end of a all references to both lists are replaced with a reference to the intersection And when a single format is eventually chosen for a link amongst the remaining all references to the list are updated That means that if a filter requires that its input and output have the same format amongst a supported all it has to do is use a reference to the same list of formats query_formats can leave some formats unset and return AVERROR(EAGAIN) to cause the negotiation mechanism toagain later. That can be used by filters with complex requirements to use the format negotiated on one link to set the formats supported on another. Frame references ownership and permissions
AVDeviceInfo::device_name
char * device_name
device name, format depends on device
Definition: avdevice.h:464
AVDeviceCapabilitiesQuery
Following API allows user to probe device capabilities (supported codecs, pixel formats,...
Definition: avdevice.h:407
avdevice_list_devices
int avdevice_list_devices(AVFormatContext *s, AVDeviceInfoList **device_list)
List devices.
Definition: avdevice.c:58
tmp
static uint8_t tmp[11]
Definition: aes_ctr.c:28
av_device_capabilities
const AVOption av_device_capabilities[]
AVOption table used by devices to implement device capabilities API.
Definition: avdevice.c:24
avdevice_capabilities_create
int avdevice_capabilities_create(AVDeviceCapabilitiesQuery **caps, AVFormatContext *s, AVDictionary **device_options)
Initialize capabilities probing API based on AVOption API.
Definition: avdevice.c:46
AVOption
AVOption.
Definition: opt.h:251
AVAppToDevMessageType
AVAppToDevMessageType
Message types used by avdevice_app_to_dev_control_message().
Definition: avdevice.h:125
data
const char data[16]
Definition: mxf.c:146
avdevice_dev_to_app_control_message
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.
Definition: avdevice.c:37
AVDictionary
Definition: dict.c:30
avdevice_list_output_sinks
int avdevice_list_output_sinks(const AVOutputFormat *device, const char *device_name, AVDictionary *device_options, AVDeviceInfoList **device_list)
Definition: avdevice.c:112
fail
#define fail()
Definition: checkasm.h:131
type
it s the only field you need to keep assuming you have a context There is some magic you don t need to care about around this just let it vf type
Definition: writing_filters.txt:86
avassert.h
AVInputFormat
Definition: avformat.h:656
avdevice_list_input_sources
int avdevice_list_input_sources(const AVInputFormat *device, const char *device_name, AVDictionary *device_options, AVDeviceInfoList **device_list)
List devices.
Definition: avdevice.c:101
s
#define s(width, name)
Definition: cbs_vp9.c:256
av_assert0
#define av_assert0(cond)
assert() equivalent, that is always enabled.
Definition: avassert.h:37
AVDeviceInfo::media_types
enum AVMediaType * media_types
array indicating what media types(s), if any, a device can provide.
Definition: avdevice.h:466
AVFormatContext
Format I/O context.
Definition: avformat.h:1213
list_devices_for_context
static int list_devices_for_context(AVFormatContext *s, AVDictionary *options, AVDeviceInfoList **device_list)
Definition: avdevice.c:85
NULL
#define NULL
Definition: coverity.c:32
internal.h
list
Filter the word “frame” indicates either a video frame or a group of audio as stored in an AVFrame structure Format for each input and each output the list of supported formats For video that means pixel format For audio that means channel sample they are references to shared objects When the negotiation mechanism computes the intersection of the formats supported at each end of a all references to both lists are replaced with a reference to the intersection And when a single format is eventually chosen for a link amongst the remaining list
Definition: filter_design.txt:25
avdevice_capabilities_free
void avdevice_capabilities_free(AVDeviceCapabilitiesQuery **caps, AVFormatContext *s)
Free resources created by avdevice_capabilities_create()
Definition: avdevice.c:52
options
const OptionDef options[]
AVDeviceInfo
Structure describes basic parameters of the device.
Definition: avdevice.h:463
avdevice.h
avdevice_free_list_devices
void avdevice_free_list_devices(AVDeviceInfoList **device_list)
Convenient function to free result of avdevice_list_devices().
Definition: avdevice.c:123
AV_OPT_SEARCH_CHILDREN
#define AV_OPT_SEARCH_CHILDREN
Search in possible children of the given object first.
Definition: opt.h:563
av_opt_set_dict2
int av_opt_set_dict2(void *obj, AVDictionary **options, int search_flags)
Set all the options from a given dictionary on an object.
Definition: opt.c:1743
av_dict_free
void av_dict_free(AVDictionary **pm)
Free all the memory allocated for an AVDictionary struct and all keys and values.
Definition: dict.c:203
AVDevToAppMessageType
AVDevToAppMessageType
Message types used by avdevice_dev_to_app_control_message().
Definition: avdevice.h:204
AVDeviceInfo::device_description
char * device_description
human friendly name
Definition: avdevice.h:465
AVOutputFormat
Definition: avformat.h:509
i
#define i(width, name, range_min, range_max)
Definition: cbs_h2645.c:269
av_mallocz
void * av_mallocz(size_t size)
Allocate a memory block with alignment suitable for all memory accesses (including vectors if availab...
Definition: mem.c:264
ret
ret
Definition: filter_design.txt:187
AVDeviceInfoList
List of devices.
Definition: avdevice.h:473
ff_alloc_input_device_context
av_warn_unused_result int ff_alloc_input_device_context(struct AVFormatContext **avctx, const AVInputFormat *iformat, const char *format)
Definition: utils.c:23
avformat_free_context
void avformat_free_context(AVFormatContext *s)
Free an AVFormatContext and all its streams.
Definition: avformat.c:95
avdevice_app_to_dev_control_message
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.
Definition: avdevice.c:29
av_free
#define av_free(p)
Definition: tableprint_vlc.h:33
av_freep
#define av_freep(p)
Definition: tableprint_vlc.h:34
av_dict_copy
int av_dict_copy(AVDictionary **dst, const AVDictionary *src, int flags)
Copy entries from one AVDictionary struct into another.
Definition: dict.c:217
avformat_alloc_output_context2
int avformat_alloc_output_context2(AVFormatContext **ctx, const AVOutputFormat *oformat, const char *format_name, const char *filename)
Allocate an AVFormatContext for an output format.
Definition: mux.c:91