Merge commit '996697e266c8adc0ad9b7fc7568406c7529c97cf'

[ffmpeg] / libavdevice / avdevice.h

diff --git a/libavdevice/avdevice.h b/libavdevice/avdevice.h
index a6408ea4db1ad89088ca40eba5b59784a2f82583..28344ca161f18b9cdb620a9a048c0e2ad8d27a03 100644 (file)
--- a/libavdevice/avdevice.h
+++ b/libavdevice/avdevice.h
@@ -119,8 +119,13 @@ enum AVDevToAppMessageType {
      * Device requests to create a window buffer. Exact meaning is device-
      * and application-dependent. Message is sent before rendering first
      * frame and all one-shot initializations should be done here.
+     * Application is allowed to ignore preferred window buffer size.
      *
-     * data: NULL.
+     * @note: Application is obligated to inform about window buffer size
+     *        with AV_APP_TO_DEV_WINDOW_SIZE message.
+     *
+     * data: AVDeviceRect: preferred size of the window buffer.
+     *       NULL: no preferred size of the window buffer.
      */
     AV_DEV_TO_APP_CREATE_WINDOW_BUFFER = MKBETAG('B','C','R','E'),
 
@@ -186,4 +191,43 @@ int avdevice_dev_to_app_control_message(struct AVFormatContext *s,
                                         enum AVDevToAppMessageType type,
                                         void *data, size_t data_size);
 
+/**
+ * Structure describes basic parameters of the device.
+ */
+typedef struct AVDeviceInfo {
+    char *device_name;                   /**< device name, format depends on device */
+    char *device_description;            /**< human friendly name */
+} AVDeviceInfo;
+
+/**
+ * List of devices.
+ */
+typedef struct AVDeviceInfoList {
+    AVDeviceInfo **devices;              /**< list of autodetected devices */
+    int nb_devices;                      /**< number of autodetected devices */
+    int default_device;                  /**< index of default device or -1 if no default */
+} AVDeviceInfoList;
+
+/**
+ * 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.
+ *
+ * @param s                device context.
+ * @param[out] device_list list of autodetected devices.
+ * @return count of autodetected devices, negative on error.
+ */
+int avdevice_list_devices(struct AVFormatContext *s, AVDeviceInfoList **device_list);
+
+/**
+ * Convinient function to free result of avdevice_list_devices().
+ *
+ * @param devices device list to be freed.
+ */
+void avdevice_free_list_devices(AVDeviceInfoList **device_list);
+
 #endif /* AVDEVICE_AVDEVICE_H */