gst/gstdevice.c

   1 /* GStreamer
   2  * Copyright (C) 2012 Olivier Crete <olivier.crete@collabora.com>
   3  *
   4  * gstdevice.c: Device discovery
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Library General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Library General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Library General Public
  17  * License along with this library; if not, write to the
  18  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  19  * Boston, MA 02111-1307, USA.
  20  */
  21
  22 /**
  23  * SECTION:gstdevice
  24  * @title: GstDevice
  25  * @short_description: Object representing a device
  26  * @see_also: #GstDeviceProvider
  27  *
  28  * #GstDevice are objects representing a device, they contain
  29  * relevant metadata about the device, such as its class and the #GstCaps
  30  * representing the media types it can produce or handle.
  31  *
  32  * #GstDevice are created by #GstDeviceProvider objects which can be
  33  * aggregated by #GstDeviceMonitor objects.
  34  *
  35  * Since: 1.4
  36  */
  37
  38 #ifdef HAVE_CONFIG_H
  39 #include "config.h"
  40 #endif
  41
  42 #include "gst_private.h"
  43
  44 #include "gstdevice.h"
  45
  46 enum
  47 {
  48   PROP_DISPLAY_NAME = 1,
  49   PROP_CAPS,
  50   PROP_DEVICE_CLASS,
  51   PROP_PROPERTIES
  52 };
  53
  54 enum
  55 {
  56   REMOVED,
  57   LAST_SIGNAL
  58 };
  59
  60 struct _GstDevicePrivate
  61 {
  62   GstCaps *caps;
  63   gchar *device_class;
  64   gchar *display_name;
  65   GstStructure *properties;
  66 };
  67
  68
  69 static guint signals[LAST_SIGNAL];
  70
  71 G_DEFINE_ABSTRACT_TYPE (GstDevice, gst_device, GST_TYPE_OBJECT);
  72
  73 static void gst_device_get_property (GObject * object, guint property_id,
  74     GValue * value, GParamSpec * pspec);
  75 static void gst_device_set_property (GObject * object, guint property_id,
  76     const GValue * value, GParamSpec * pspec);
  77 static void gst_device_finalize (GObject * object);
  78
  79
  80 static void
  81 gst_device_class_init (GstDeviceClass * klass)
  82 {
  83   GObjectClass *object_class = G_OBJECT_CLASS (klass);
  84
  85   g_type_class_add_private (klass, sizeof (GstDevicePrivate));
  86
  87   object_class->get_property = gst_device_get_property;
  88   object_class->set_property = gst_device_set_property;
  89   object_class->finalize = gst_device_finalize;
  90
  91   g_object_class_install_property (object_class, PROP_DISPLAY_NAME,
  92       g_param_spec_string ("display-name", "Display Name",
  93           "The user-friendly name of the device", "",
  94           G_PARAM_STATIC_STRINGS | G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
  95   g_object_class_install_property (object_class, PROP_CAPS,
  96       g_param_spec_boxed ("caps", "Device Caps",
  97           "The possible caps of a device", GST_TYPE_CAPS,
  98           G_PARAM_STATIC_STRINGS | G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
  99   g_object_class_install_property (object_class, PROP_DEVICE_CLASS,
 100       g_param_spec_string ("device-class", "Device Class",
 101           "The Class of the device", "",
 102           G_PARAM_STATIC_STRINGS | G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
 103   g_object_class_install_property (object_class, PROP_PROPERTIES,
 104       g_param_spec_boxed ("properties", "Properties",
 105           "The extra properties of the device", GST_TYPE_STRUCTURE,
 106           G_PARAM_STATIC_STRINGS | G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
 107
 108   signals[REMOVED] = g_signal_new ("removed", G_TYPE_FROM_CLASS (klass),
 109       G_SIGNAL_RUN_LAST, 0, NULL, NULL, NULL, G_TYPE_NONE, 0);
 110 }
 111
 112 static void
 113 gst_device_init (GstDevice * device)
 114 {
 115   device->priv = G_TYPE_INSTANCE_GET_PRIVATE (device, GST_TYPE_DEVICE,
 116       GstDevicePrivate);
 117 }
 118
 119 static void
 120 gst_device_finalize (GObject * object)
 121 {
 122   GstDevice *device = GST_DEVICE (object);
 123
 124   gst_caps_replace (&device->priv->caps, NULL);
 125
 126   if (device->priv->properties)
 127     gst_structure_free (device->priv->properties);
 128   g_free (device->priv->display_name);
 129   g_free (device->priv->device_class);
 130
 131   G_OBJECT_CLASS (gst_device_parent_class)->finalize (object);
 132 }
 133
 134 static void
 135 gst_device_get_property (GObject * object, guint prop_id,
 136     GValue * value, GParamSpec * pspec)
 137 {
 138   GstDevice *gstdevice;
 139
 140   gstdevice = GST_DEVICE_CAST (object);
 141
 142   switch (prop_id) {
 143     case PROP_DISPLAY_NAME:
 144       g_value_take_string (value, gst_device_get_display_name (gstdevice));
 145       break;
 146     case PROP_CAPS:
 147       if (gstdevice->priv->caps)
 148         g_value_take_boxed (value, gst_device_get_caps (gstdevice));
 149       break;
 150     case PROP_DEVICE_CLASS:
 151       g_value_take_string (value, gst_device_get_device_class (gstdevice));
 152       break;
 153     case PROP_PROPERTIES:
 154       if (gstdevice->priv->properties)
 155         g_value_take_boxed (value, gst_device_get_properties (gstdevice));
 156       break;
 157     default:
 158       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 159       break;
 160   }
 161 }
 162
 163
 164 static void
 165 gst_device_set_property (GObject * object, guint prop_id,
 166     const GValue * value, GParamSpec * pspec)
 167 {
 168   GstDevice *gstdevice;
 169
 170   gstdevice = GST_DEVICE_CAST (object);
 171
 172   switch (prop_id) {
 173     case PROP_DISPLAY_NAME:
 174       gstdevice->priv->display_name = g_value_dup_string (value);
 175       break;
 176     case PROP_CAPS:
 177       gst_caps_replace (&gstdevice->priv->caps, g_value_get_boxed (value));
 178       break;
 179     case PROP_DEVICE_CLASS:
 180       gstdevice->priv->device_class = g_value_dup_string (value);
 181       break;
 182     case PROP_PROPERTIES:
 183       if (gstdevice->priv->properties)
 184         gst_structure_free (gstdevice->priv->properties);
 185       gstdevice->priv->properties = g_value_dup_boxed (value);
 186       break;
 187     default:
 188       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 189       break;
 190   }
 191 }
 192
 193 /**
 194  * gst_device_create_element:
 195  * @device: a #GstDevice
 196  * @name: (allow-none): name of new element, or %NULL to automatically
 197  * create a unique name.
 198  *
 199  * Creates the element with all of the required parameters set to use
 200  * this device.
 201  *
 202  * Returns: (transfer full) (nullable): a new #GstElement configured to use
 203  * this device
 204  *
 205  * Since: 1.4
 206  */
 207 GstElement *
 208 gst_device_create_element (GstDevice * device, const gchar * name)
 209 {
 210   GstDeviceClass *klass = GST_DEVICE_GET_CLASS (device);
 211
 212   g_return_val_if_fail (GST_IS_DEVICE (device), NULL);
 213
 214   if (klass->create_element)
 215     return klass->create_element (device, name);
 216   else
 217     return NULL;
 218 }
 219
 220 /**
 221  * gst_device_get_caps:
 222  * @device: a #GstDevice
 223  *
 224  * Getter for the #GstCaps that this device supports.
 225  *
 226  * Returns: (nullable): The #GstCaps supported by this device. Unref with
 227  * gst_caps_unref() when done.
 228  *
 229  * Since: 1.4
 230  */
 231 GstCaps *
 232 gst_device_get_caps (GstDevice * device)
 233 {
 234   g_return_val_if_fail (GST_IS_DEVICE (device), NULL);
 235
 236   if (device->priv->caps)
 237     return gst_caps_ref (device->priv->caps);
 238   else
 239     return NULL;
 240 }
 241
 242 /**
 243  * gst_device_get_display_name:
 244  * @device: a #GstDevice
 245  *
 246  * Gets the user-friendly name of the device.
 247  *
 248  * Returns: The device name. Free with g_free() after use.
 249  *
 250  * Since: 1.4
 251  */
 252 gchar *
 253 gst_device_get_display_name (GstDevice * device)
 254 {
 255   g_return_val_if_fail (GST_IS_DEVICE (device), NULL);
 256
 257   return
 258       g_strdup (device->priv->display_name ? device->priv->display_name : "");
 259 }
 260
 261 /**
 262  * gst_device_get_device_class:
 263  * @device: a #GstDevice
 264  *
 265  * Gets the "class" of a device. This is a "/" separated list of
 266  * classes that represent this device. They are a subset of the
 267  * classes of the #GstDeviceProvider that produced this device.
 268  *
 269  * Returns: The device class. Free with g_free() after use.
 270  *
 271  * Since: 1.4
 272  */
 273 gchar *
 274 gst_device_get_device_class (GstDevice * device)
 275 {
 276   g_return_val_if_fail (GST_IS_DEVICE (device), NULL);
 277
 278   if (device->priv->device_class != NULL)
 279     return g_strdup (device->priv->device_class);
 280   else
 281     return g_strdup ("");
 282 }
 283
 284 /**
 285  * gst_device_get_properties:
 286  * @device: a #GstDevice
 287  *
 288  * Gets the extra properties of a device.
 289  *
 290  * Returns: (nullable): The extra properties or %NULL when there are none.
 291  *          Free with gst_structure_free() after use.
 292  *
 293  * Since: 1.6
 294  */
 295 GstStructure *
 296 gst_device_get_properties (GstDevice * device)
 297 {
 298   g_return_val_if_fail (GST_IS_DEVICE (device), NULL);
 299
 300   if (device->priv->properties != NULL)
 301     return gst_structure_copy (device->priv->properties);
 302   else
 303     return NULL;
 304 }
 305
 306 /**
 307  * gst_device_reconfigure_element:
 308  * @device: a #GstDevice
 309  * @element: a #GstElement
 310  *
 311  * Tries to reconfigure an existing element to use the device. If this
 312  * function fails, then one must destroy the element and create a new one
 313  * using gst_device_create_element().
 314  *
 315  * Note: This should only be implemented for elements can change their
 316  * device in the PLAYING state.
 317  *
 318  * Returns: %TRUE if the element could be reconfigured to use this device,
 319  * %FALSE otherwise.
 320  *
 321  * Since: 1.4
 322  */
 323 gboolean
 324 gst_device_reconfigure_element (GstDevice * device, GstElement * element)
 325 {
 326   GstDeviceClass *klass = GST_DEVICE_GET_CLASS (device);
 327
 328   g_return_val_if_fail (GST_IS_DEVICE (device), FALSE);
 329
 330   if (klass->reconfigure_element)
 331     return klass->reconfigure_element (device, element);
 332   else
 333     return FALSE;
 334 }
 335
 336 /**
 337  * gst_device_has_classesv:
 338  * @device: a #GstDevice
 339  * @classes: (array zero-terminated=1): a %NULL terminated array of classes
 340  *   to match, only match if all classes are matched
 341  *
 342  * Check if @factory matches all of the given classes
 343  *
 344  * Returns: %TRUE if @device matches.
 345  *
 346  * Since: 1.4
 347  */
 348 gboolean
 349 gst_device_has_classesv (GstDevice * device, gchar ** classes)
 350 {
 351   g_return_val_if_fail (GST_IS_DEVICE (device), FALSE);
 352
 353   if (!classes)
 354     return TRUE;
 355
 356   for (; classes[0]; classes++) {
 357     const gchar *klass = classes[0];
 358     const gchar *found;
 359     guint len;
 360
 361     if (*klass == '\0')
 362       continue;
 363
 364     found = strstr (device->priv->device_class, klass);
 365
 366     if (!found)
 367       return FALSE;
 368     if (found != device->priv->device_class && *(found - 1) != '/')
 369       return FALSE;
 370
 371     len = strlen (klass);
 372     if (found[len] != 0 && found[len] != '/')
 373       return FALSE;
 374   }
 375
 376   return TRUE;
 377 }
 378
 379 /**
 380  * gst_device_has_classes:
 381  * @device: a #GstDevice
 382  * @classes: a "/"-separated list of device classes to match, only match if
 383  *  all classes are matched
 384  *
 385  * Check if @device matches all of the given classes
 386  *
 387  * Returns: %TRUE if @device matches.
 388  *
 389  * Since: 1.4
 390  */
 391 gboolean
 392 gst_device_has_classes (GstDevice * device, const gchar * classes)
 393 {
 394   gchar **classesv;
 395   gboolean res;
 396
 397   g_return_val_if_fail (GST_IS_DEVICE (device), FALSE);
 398
 399   if (!classes)
 400     return TRUE;
 401
 402   classesv = g_strsplit (classes, "/", 0);
 403
 404   res = gst_device_has_classesv (device, classesv);
 405
 406   g_strfreev (classesv);
 407
 408   return res;
 409 }