gst/gstdeviceproviderfactory.c

   1 /* GStreamer
   2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
   3  *                    2000 Wim Taymans <wtay@chello.be>
   4  *                    2003 Benjamin Otte <in7y118@public.uni-hamburg.de>
   5  *
   6  * gstdeviceproviderfactory.c: GstDeviceProviderFactory object, support routines
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Library General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2 of the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Library General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Library General Public
  19  * License along with this library; if not, write to the
  20  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  21  * Boston, MA 02111-1307, USA.
  22  */
  23
  24 /**
  25  * SECTION:gstdeviceproviderfactory
  26  * @short_description: Create GstDeviceProviders from a factory
  27  * @see_also: #GstDeviceProvider, #GstPlugin, #GstPluginFeature, #GstPadTemplate.
  28  *
  29  * #GstDeviceProviderFactory is used to create instances of device providers. A
  30  * GstDeviceProviderfactory can be added to a #GstPlugin as it is also a
  31  * #GstPluginFeature.
  32  *
  33  * Use the gst_device_provider_factory_find() and
  34  * gst_device_provider_factory_get() functions to create device
  35  * provider instances or use gst_device_provider_factory_get_by_name() as a
  36  * convenient shortcut.
  37  *
  38  * Since: 1.4
  39  */
  40
  41 #ifdef HAVE_CONFIG_H
  42 #include "config.h"
  43 #endif
  44
  45 #include "gst_private.h"
  46
  47 #include "gstdeviceproviderfactory.h"
  48 #include "gst.h"
  49
  50 #include "glib-compat-private.h"
  51
  52 GST_DEBUG_CATEGORY_STATIC (device_provider_factory_debug);
  53 #define GST_CAT_DEFAULT device_provider_factory_debug
  54
  55 static void gst_device_provider_factory_finalize (GObject * object);
  56 static void gst_device_provider_factory_cleanup (GstDeviceProviderFactory *
  57     factory);
  58
  59 /* static guint gst_device_provider_factory_signals[LAST_SIGNAL] = { 0 }; */
  60
  61 /* this is defined in gstelement.c */
  62 extern GQuark __gst_deviceproviderclass_factory;
  63
  64 #define _do_init \
  65 { \
  66   GST_DEBUG_CATEGORY_INIT (device_provider_factory_debug, "GST_DEVICE_PROVIDER_FACTORY", \
  67       GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, \
  68       "device provider factories keep information about installed device providers"); \
  69 }
  70
  71 G_DEFINE_TYPE_WITH_CODE (GstDeviceProviderFactory, gst_device_provider_factory,
  72     GST_TYPE_PLUGIN_FEATURE, _do_init);
  73
  74 static void
  75 gst_device_provider_factory_class_init (GstDeviceProviderFactoryClass * klass)
  76 {
  77   GObjectClass *gobject_class = (GObjectClass *) klass;
  78
  79   gobject_class->finalize = gst_device_provider_factory_finalize;
  80 }
  81
  82 static void
  83 gst_device_provider_factory_init (GstDeviceProviderFactory * factory)
  84 {
  85 }
  86
  87 static void
  88 gst_device_provider_factory_finalize (GObject * object)
  89 {
  90   GstDeviceProviderFactory *factory = GST_DEVICE_PROVIDER_FACTORY (object);
  91   GstDeviceProvider *provider;
  92
  93   gst_device_provider_factory_cleanup (factory);
  94
  95   provider = g_atomic_pointer_get (&factory->provider);
  96   if (provider)
  97     gst_object_unref (provider);
  98
  99   G_OBJECT_CLASS (gst_device_provider_factory_parent_class)->finalize (object);
 100 }
 101
 102 /**
 103  * gst_device_provider_factory_find:
 104  * @name: name of factory to find
 105  *
 106  * Search for an device provider factory of the given name. Refs the returned
 107  * device provider factory; caller is responsible for unreffing.
 108  *
 109  * Returns: (transfer full) (nullable): #GstDeviceProviderFactory if
 110  * found, %NULL otherwise
 111  *
 112  * Since: 1.4
 113  */
 114 GstDeviceProviderFactory *
 115 gst_device_provider_factory_find (const gchar * name)
 116 {
 117   GstPluginFeature *feature;
 118
 119   g_return_val_if_fail (name != NULL, NULL);
 120
 121   feature = gst_registry_find_feature (gst_registry_get (), name,
 122       GST_TYPE_DEVICE_PROVIDER_FACTORY);
 123   if (feature)
 124     return GST_DEVICE_PROVIDER_FACTORY (feature);
 125
 126   /* this isn't an error, for instance when you query if an device provider factory is
 127    * present */
 128   GST_LOG ("no such device provider factory \"%s\"", name);
 129
 130   return NULL;
 131 }
 132
 133 static void
 134 gst_device_provider_factory_cleanup (GstDeviceProviderFactory * factory)
 135 {
 136   if (factory->metadata) {
 137     gst_structure_free ((GstStructure *) factory->metadata);
 138     factory->metadata = NULL;
 139   }
 140   if (factory->type) {
 141     factory->type = G_TYPE_INVALID;
 142   }
 143 }
 144
 145 #define CHECK_METADATA_FIELD(klass, name, key)                                 \
 146   G_STMT_START {                                                               \
 147     const gchar *metafield = gst_device_provider_class_get_metadata (klass, key);      \
 148     if (G_UNLIKELY (metafield == NULL || *metafield == '\0')) {                \
 149       g_warning ("Device provider factory metadata for '%s' has no valid %s field", name, key);    \
 150       goto detailserror;                                                       \
 151     } \
 152   } G_STMT_END;
 153
 154 /**
 155  * gst_device_provider_register:
 156  * @plugin: (allow-none): #GstPlugin to register the device provider with, or %NULL for
 157  *     a static device provider.
 158  * @name: name of device providers of this type
 159  * @rank: rank of device provider (higher rank means more importance when autoplugging)
 160  * @type: GType of device provider to register
 161  *
 162  * Create a new device providerfactory capable of instantiating objects of the
 163  * @type and add the factory to @plugin.
 164  *
 165  * Returns: %TRUE, if the registering succeeded, %FALSE on error
 166  *
 167  * Since: 1.4
 168  */
 169 gboolean
 170 gst_device_provider_register (GstPlugin * plugin, const gchar * name,
 171     guint rank, GType type)
 172 {
 173   GstPluginFeature *existing_feature;
 174   GstRegistry *registry;
 175   GstDeviceProviderFactory *factory;
 176   GstDeviceProviderClass *klass;
 177
 178   g_return_val_if_fail (name != NULL, FALSE);
 179   g_return_val_if_fail (g_type_is_a (type, GST_TYPE_DEVICE_PROVIDER), FALSE);
 180
 181   registry = gst_registry_get ();
 182
 183   /* check if feature already exists, if it exists there is no need to update it
 184    * when the registry is getting updated, outdated plugins and all their
 185    * features are removed and readded.
 186    */
 187   existing_feature = gst_registry_lookup_feature (registry, name);
 188   if (existing_feature) {
 189     GST_DEBUG_OBJECT (registry, "update existing feature %p (%s)",
 190         existing_feature, name);
 191     factory = GST_DEVICE_PROVIDER_FACTORY_CAST (existing_feature);
 192     factory->type = type;
 193     existing_feature->loaded = TRUE;
 194     g_type_set_qdata (type, __gst_deviceproviderclass_factory, factory);
 195     gst_object_unref (existing_feature);
 196     return TRUE;
 197   }
 198
 199   factory =
 200       GST_DEVICE_PROVIDER_FACTORY_CAST (g_object_newv
 201       (GST_TYPE_DEVICE_PROVIDER_FACTORY, 0, NULL));
 202   gst_plugin_feature_set_name (GST_PLUGIN_FEATURE_CAST (factory), name);
 203   GST_LOG_OBJECT (factory, "Created new device providerfactory for type %s",
 204       g_type_name (type));
 205
 206   /* provide info needed during class structure setup */
 207   g_type_set_qdata (type, __gst_deviceproviderclass_factory, factory);
 208   klass = GST_DEVICE_PROVIDER_CLASS (g_type_class_ref (type));
 209
 210   CHECK_METADATA_FIELD (klass, name, GST_ELEMENT_METADATA_LONGNAME);
 211   CHECK_METADATA_FIELD (klass, name, GST_ELEMENT_METADATA_KLASS);
 212   CHECK_METADATA_FIELD (klass, name, GST_ELEMENT_METADATA_DESCRIPTION);
 213   CHECK_METADATA_FIELD (klass, name, GST_ELEMENT_METADATA_AUTHOR);
 214
 215   factory->type = type;
 216   factory->metadata = gst_structure_copy ((GstStructure *) klass->metadata);
 217
 218   if (plugin && plugin->desc.name) {
 219     GST_PLUGIN_FEATURE_CAST (factory)->plugin_name = plugin->desc.name;
 220     GST_PLUGIN_FEATURE_CAST (factory)->plugin = plugin;
 221     g_object_add_weak_pointer ((GObject *) plugin,
 222         (gpointer *) & GST_PLUGIN_FEATURE_CAST (factory)->plugin);
 223   } else {
 224     GST_PLUGIN_FEATURE_CAST (factory)->plugin_name = "NULL";
 225     GST_PLUGIN_FEATURE_CAST (factory)->plugin = NULL;
 226   }
 227   gst_plugin_feature_set_rank (GST_PLUGIN_FEATURE_CAST (factory), rank);
 228   GST_PLUGIN_FEATURE_CAST (factory)->loaded = TRUE;
 229
 230   gst_registry_add_feature (registry, GST_PLUGIN_FEATURE_CAST (factory));
 231
 232   return TRUE;
 233
 234   /* ERRORS */
 235 detailserror:
 236   {
 237     gst_device_provider_factory_cleanup (factory);
 238     return FALSE;
 239   }
 240 }
 241
 242 /**
 243  * gst_device_provider_factory_get:
 244  * @factory: factory to instantiate
 245  *
 246  * Returns the device provider of the type defined by the given device
 247  * providerfactory.
 248  *
 249  * Returns: (transfer full) (nullable): the #GstDeviceProvider or %NULL
 250  * if the device provider couldn't be created
 251  *
 252  * Since: 1.4
 253  */
 254 GstDeviceProvider *
 255 gst_device_provider_factory_get (GstDeviceProviderFactory * factory)
 256 {
 257   GstDeviceProvider *device_provider;
 258   GstDeviceProviderClass *oclass;
 259   GstDeviceProviderFactory *newfactory;
 260
 261   g_return_val_if_fail (factory != NULL, NULL);
 262
 263   newfactory =
 264       GST_DEVICE_PROVIDER_FACTORY (gst_plugin_feature_load (GST_PLUGIN_FEATURE
 265           (factory)));
 266
 267   if (newfactory == NULL)
 268     goto load_failed;
 269
 270   factory = newfactory;
 271
 272   GST_INFO ("getting device provider \"%s\"", GST_OBJECT_NAME (factory));
 273
 274   if (factory->type == 0)
 275     goto no_type;
 276
 277   device_provider = g_atomic_pointer_get (&newfactory->provider);
 278   if (device_provider) {
 279     gst_object_unref (factory);
 280     return gst_object_ref (device_provider);
 281   }
 282
 283   /* create an instance of the device provider, cast so we don't assert on NULL
 284    * also set name as early as we can
 285    */
 286   device_provider = GST_DEVICE_PROVIDER_CAST (g_object_newv (factory->type, 0,
 287           NULL));
 288   if (G_UNLIKELY (device_provider == NULL))
 289     goto no_device_provider;
 290
 291   /* fill in the pointer to the factory in the device provider class. The
 292    * class will not be unreffed currently.
 293    * Be thread safe as there might be 2 threads creating the first instance of
 294    * an device provider at the same moment
 295    */
 296   oclass = GST_DEVICE_PROVIDER_GET_CLASS (device_provider);
 297   if (!g_atomic_pointer_compare_and_exchange (&oclass->factory, NULL, factory)) {
 298     gst_object_unref (factory);
 299   } else {
 300     /* This ref will never be dropped as the class is never destroyed */
 301     GST_OBJECT_FLAG_SET (factory, GST_OBJECT_FLAG_MAY_BE_LEAKED);
 302   }
 303
 304   gst_object_ref_sink (device_provider);
 305
 306   /* We use an atomic to make sure we don't create two in parallel */
 307   if (!g_atomic_pointer_compare_and_exchange (&newfactory->provider, NULL,
 308           device_provider)) {
 309     gst_object_unref (device_provider);
 310
 311     device_provider = g_atomic_pointer_get (&newfactory->provider);
 312   }
 313
 314   GST_DEBUG ("created device provider \"%s\"", GST_OBJECT_NAME (factory));
 315
 316   return gst_object_ref (device_provider);
 317
 318   /* ERRORS */
 319 load_failed:
 320   {
 321     GST_WARNING_OBJECT (factory,
 322         "loading plugin containing feature %s returned NULL!",
 323         GST_OBJECT_NAME (factory));
 324     return NULL;
 325   }
 326 no_type:
 327   {
 328     GST_WARNING_OBJECT (factory, "factory has no type");
 329     gst_object_unref (factory);
 330     return NULL;
 331   }
 332 no_device_provider:
 333   {
 334     GST_WARNING_OBJECT (factory, "could not create device provider");
 335     gst_object_unref (factory);
 336     return NULL;
 337   }
 338 }
 339
 340 /**
 341  * gst_device_provider_factory_get_by_name:
 342  * @factoryname: a named factory to instantiate
 343  *
 344  * Returns the device provider of the type defined by the given device
 345  * provider factory.
 346  *
 347  * Returns: (transfer full) (nullable): a #GstDeviceProvider or %NULL
 348  * if unable to create device provider
 349  *
 350  * Since: 1.4
 351  */
 352 GstDeviceProvider *
 353 gst_device_provider_factory_get_by_name (const gchar * factoryname)
 354 {
 355   GstDeviceProviderFactory *factory;
 356   GstDeviceProvider *device_provider;
 357
 358   g_return_val_if_fail (factoryname != NULL, NULL);
 359   g_return_val_if_fail (gst_is_initialized (), NULL);
 360
 361   GST_LOG ("gstdeviceproviderfactory: get_by_name \"%s\"", factoryname);
 362
 363   factory = gst_device_provider_factory_find (factoryname);
 364   if (factory == NULL)
 365     goto no_factory;
 366
 367   GST_LOG_OBJECT (factory, "found factory %p", factory);
 368   device_provider = gst_device_provider_factory_get (factory);
 369   if (device_provider == NULL)
 370     goto create_failed;
 371
 372   gst_object_unref (factory);
 373   return device_provider;
 374
 375   /* ERRORS */
 376 no_factory:
 377   {
 378     GST_INFO ("no such device provider factory \"%s\"!", factoryname);
 379     return NULL;
 380   }
 381 create_failed:
 382   {
 383     GST_INFO_OBJECT (factory, "couldn't create instance!");
 384     gst_object_unref (factory);
 385     return NULL;
 386   }
 387 }
 388
 389 /**
 390  * gst_device_provider_factory_get_device_provider_type:
 391  * @factory: factory to get managed #GType from
 392  *
 393  * Get the #GType for device providers managed by this factory. The type can
 394  * only be retrieved if the device provider factory is loaded, which can be
 395  * assured with gst_plugin_feature_load().
 396  *
 397  * Returns: the #GType for device providers managed by this factory.
 398  *
 399  * Since: 1.4
 400  */
 401 GType
 402 gst_device_provider_factory_get_device_provider_type (GstDeviceProviderFactory *
 403     factory)
 404 {
 405   g_return_val_if_fail (GST_IS_DEVICE_PROVIDER_FACTORY (factory),
 406       G_TYPE_INVALID);
 407
 408   return factory->type;
 409 }
 410
 411 /**
 412  * gst_device_provider_factory_get_metadata:
 413  * @factory: a #GstDeviceProviderFactory
 414  * @key: a key
 415  *
 416  * Get the metadata on @factory with @key.
 417  *
 418  * Returns: (nullable): the metadata with @key on @factory or %NULL
 419  * when there was no metadata with the given @key.
 420  *
 421  * Since: 1.4
 422  */
 423 const gchar *
 424 gst_device_provider_factory_get_metadata (GstDeviceProviderFactory * factory,
 425     const gchar * key)
 426 {
 427   return gst_structure_get_string ((GstStructure *) factory->metadata, key);
 428 }
 429
 430 /**
 431  * gst_device_provider_factory_get_metadata_keys:
 432  * @factory: a #GstDeviceProviderFactory
 433  *
 434  * Get the available keys for the metadata on @factory.
 435  *
 436  * Returns: (transfer full) (element-type utf8) (array zero-terminated=1) (nullable):
 437  * a %NULL-terminated array of key strings, or %NULL when there is no
 438  * metadata. Free with g_strfreev() when no longer needed.
 439  *
 440  * Since: 1.4
 441  */
 442 gchar **
 443 gst_device_provider_factory_get_metadata_keys (GstDeviceProviderFactory *
 444     factory)
 445 {
 446   GstStructure *metadata;
 447   gchar **arr;
 448   gint i, num;
 449
 450   g_return_val_if_fail (GST_IS_DEVICE_PROVIDER_FACTORY (factory), NULL);
 451
 452   metadata = (GstStructure *) factory->metadata;
 453   if (metadata == NULL)
 454     return NULL;
 455
 456   num = gst_structure_n_fields (metadata);
 457   if (num == 0)
 458     return NULL;
 459
 460   arr = g_new (gchar *, num + 1);
 461   for (i = 0; i < num; ++i) {
 462     arr[i] = g_strdup (gst_structure_nth_field_name (metadata, i));
 463   }
 464   arr[i] = NULL;
 465   return arr;
 466 }
 467
 468 /**
 469  * gst_device_provider_factory_has_classesv:
 470  * @factory: a #GstDeviceProviderFactory
 471  * @classes: (array zero-terminated=1) (allow-none): a %NULL terminated array
 472  *   of classes to match, only match if all classes are matched
 473  *
 474  * Check if @factory matches all of the given classes
 475  *
 476  * Returns: %TRUE if @factory matches.
 477  *
 478  * Since: 1.4
 479  */
 480 gboolean
 481 gst_device_provider_factory_has_classesv (GstDeviceProviderFactory * factory,
 482     gchar ** classes)
 483 {
 484   const gchar *klass;
 485
 486   g_return_val_if_fail (GST_IS_DEVICE_PROVIDER_FACTORY (factory), FALSE);
 487
 488   klass = gst_device_provider_factory_get_metadata (factory,
 489       GST_ELEMENT_METADATA_KLASS);
 490
 491   if (klass == NULL) {
 492     GST_ERROR_OBJECT (factory,
 493         "device provider factory is missing klass identifiers");
 494     return FALSE;
 495   }
 496
 497   for (; classes != NULL && classes[0] != NULL; classes++) {
 498     const gchar *found;
 499     guint len;
 500
 501     if (classes[0] == '\0')
 502       continue;
 503
 504     found = strstr (klass, classes[0]);
 505
 506     if (!found)
 507       return FALSE;
 508     if (found != klass && *(found - 1) != '/')
 509       return FALSE;
 510
 511     len = strlen (classes[0]);
 512     if (found[len] != 0 && found[len] != '/')
 513       return FALSE;
 514   }
 515
 516   return TRUE;
 517 }
 518
 519 /**
 520  * gst_device_provider_factory_has_classes:
 521  * @factory: a #GstDeviceProviderFactory
 522  * @classes: (allow-none): a "/" separate list of classes to match, only match
 523  *     if all classes are matched
 524  *
 525  * Check if @factory matches all of the given @classes
 526  *
 527  * Returns: %TRUE if @factory matches or if @classes is %NULL.
 528  *
 529  * Since: 1.4
 530  */
 531 gboolean
 532 gst_device_provider_factory_has_classes (GstDeviceProviderFactory * factory,
 533     const gchar * classes)
 534 {
 535   gchar **classesv;
 536   gboolean res;
 537
 538   if (classes == NULL)
 539     return TRUE;
 540
 541   classesv = g_strsplit (classes, "/", 0);
 542
 543   res = gst_device_provider_factory_has_classesv (factory, classesv);
 544
 545   g_strfreev (classesv);
 546
 547   return res;
 548 }
 549
 550 static gboolean
 551 device_provider_filter (GstPluginFeature * feature, GstRank * minrank)
 552 {
 553   /* we only care about device provider factories */
 554   if (G_UNLIKELY (!GST_IS_DEVICE_PROVIDER_FACTORY (feature)))
 555     return FALSE;
 556
 557   return (gst_plugin_feature_get_rank (feature) >= *minrank);
 558 }
 559
 560 /**
 561  * gst_device_provider_factory_list_get_device_providers:
 562  * @minrank: Minimum rank
 563  *
 564  * Get a list of factories with a rank greater or equal to @minrank.
 565  * The list of factories is returned by decreasing rank.
 566  *
 567  * Returns: (transfer full) (element-type Gst.DeviceProviderFactory):
 568  * a #GList of #GstDeviceProviderFactory device providers. Use
 569  * gst_plugin_feature_list_free() after usage.
 570  *
 571  * Since: 1.4
 572  */
 573 GList *
 574 gst_device_provider_factory_list_get_device_providers (GstRank minrank)
 575 {
 576   GList *result;
 577
 578   /* get the feature list using the filter */
 579   result = gst_registry_feature_filter (gst_registry_get (),
 580       (GstPluginFeatureFilter) device_provider_filter, FALSE, &minrank);
 581
 582   /* sort on rank and name */
 583   result = g_list_sort (result, gst_plugin_feature_rank_compare_func);
 584
 585   return result;
 586 }