gst/gstcontext.c

   1 /* GStreamer
   2  * Copyright (C) 2013 Collabora Ltd.
   3  *   Author: Sebastian Dröge <sebastian.droege@collabora.co.uk>
   4  * Copyright (C) 2013 Sebastian Dröge <slomo@circular-chaos.org>
   5  *
   6  * gstcontext.h: Header for GstContext subsystem
   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., 51 Franklin St, Fifth Floor,
  21  * Boston, MA 02110-1301, USA.
  22  */
  23
  24 /**
  25  * SECTION:gstcontext
  26  * @title: GstContext
  27  * @short_description: Lightweight objects to represent element contexts
  28  * @see_also: #GstMiniObject, #GstElement
  29  *
  30  * #GstContext is a container object used to store contexts like a device
  31  * context, a display server connection and similar concepts that should
  32  * be shared between multiple elements.
  33  *
  34  * Applications can set a context on a complete pipeline by using
  35  * gst_element_set_context(), which will then be propagated to all
  36  * child elements. Elements can handle these in #GstElementClass.set_context()
  37  * and merge them with the context information they already have.
  38  *
  39  * When an element needs a context it will do the following actions in this
  40  * order until one step succeeds:
  41  * 1. Check if the element already has a context
  42  * 2. Query downstream with GST_QUERY_CONTEXT for the context
  43  * 3. Query upstream with GST_QUERY_CONTEXT for the context
  44  * 4. Post a GST_MESSAGE_NEED_CONTEXT message on the bus with the required
  45  *    context types and afterwards check if a usable context was set now
  46  * 5. Create a context by itself and post a GST_MESSAGE_HAVE_CONTEXT message
  47  *    on the bus.
  48  *
  49  * Bins will catch GST_MESSAGE_NEED_CONTEXT messages and will set any previously
  50  * known context on the element that asks for it if possible. Otherwise the
  51  * application should provide one if it can.
  52  *
  53  * #GstContext<!-- -->s can be persistent.
  54  * A persistent #GstContext is kept in elements when they reach
  55  * %GST_STATE_NULL, non-persistent ones will be removed.
  56  * Also, a non-persistent context won't override a previous persistent
  57  * context set to an element.
  58  *
  59  * Since: 1.2
  60  */
  61
  62 #include "gst_private.h"
  63 #include <string.h>
  64 #include "gstcontext.h"
  65 #include "gstquark.h"
  66
  67 struct _GstContext
  68 {
  69   GstMiniObject mini_object;
  70
  71   gchar *context_type;
  72   GstStructure *structure;
  73   gboolean persistent;
  74 };
  75
  76 #define GST_CONTEXT_STRUCTURE(c)  (((GstContext *)(c))->structure)
  77
  78 GType _gst_context_type = 0;
  79 GST_DEFINE_MINI_OBJECT_TYPE (GstContext, gst_context);
  80
  81 void
  82 _priv_gst_context_initialize (void)
  83 {
  84   GST_CAT_INFO (GST_CAT_GST_INIT, "init contexts");
  85
  86   /* the GstMiniObject types need to be class_ref'd once before it can be
  87    * done from multiple threads;
  88    * see http://bugzilla.gnome.org/show_bug.cgi?id=304551 */
  89   gst_context_get_type ();
  90
  91   _gst_context_type = gst_context_get_type ();
  92 }
  93
  94 static void
  95 _gst_context_free (GstContext * context)
  96 {
  97   GstStructure *structure;
  98
  99   g_return_if_fail (context != NULL);
 100
 101   GST_CAT_LOG (GST_CAT_CONTEXT, "finalize context %p: %" GST_PTR_FORMAT,
 102       context, GST_CONTEXT_STRUCTURE (context));
 103
 104   structure = GST_CONTEXT_STRUCTURE (context);
 105   if (structure) {
 106     gst_structure_set_parent_refcount (structure, NULL);
 107     gst_structure_free (structure);
 108   }
 109   g_free (context->context_type);
 110
 111   g_slice_free1 (sizeof (GstContext), context);
 112 }
 113
 114 static void gst_context_init (GstContext * context);
 115
 116 static GstContext *
 117 _gst_context_copy (GstContext * context)
 118 {
 119   GstContext *copy;
 120   GstStructure *structure;
 121
 122   GST_CAT_LOG (GST_CAT_CONTEXT, "copy context %p: %" GST_PTR_FORMAT, context,
 123       GST_CONTEXT_STRUCTURE (context));
 124
 125   copy = g_slice_new0 (GstContext);
 126
 127   gst_context_init (copy);
 128
 129   copy->context_type = g_strdup (context->context_type);
 130
 131   structure = GST_CONTEXT_STRUCTURE (context);
 132   GST_CONTEXT_STRUCTURE (copy) = gst_structure_copy (structure);
 133   gst_structure_set_parent_refcount (GST_CONTEXT_STRUCTURE (copy),
 134       &copy->mini_object.refcount);
 135
 136   copy->persistent = context->persistent;
 137
 138   return GST_CONTEXT_CAST (copy);
 139 }
 140
 141 static void
 142 gst_context_init (GstContext * context)
 143 {
 144   gst_mini_object_init (GST_MINI_OBJECT_CAST (context), 0, _gst_context_type,
 145       (GstMiniObjectCopyFunction) _gst_context_copy, NULL,
 146       (GstMiniObjectFreeFunction) _gst_context_free);
 147 }
 148
 149 /**
 150  * gst_context_new:
 151  * @context_type: Context type
 152  * @persistent: Persistent context
 153  *
 154  * Create a new context.
 155  *
 156  * Returns: (transfer full): The new context.
 157  *
 158  * Since: 1.2
 159  */
 160 GstContext *
 161 gst_context_new (const gchar * context_type, gboolean persistent)
 162 {
 163   GstContext *context;
 164   GstStructure *structure;
 165
 166   g_return_val_if_fail (context_type != NULL, NULL);
 167
 168   context = g_slice_new0 (GstContext);
 169
 170   GST_CAT_LOG (GST_CAT_CONTEXT, "creating new context %p", context);
 171
 172   structure = gst_structure_new_id_empty (GST_QUARK (CONTEXT));
 173   gst_structure_set_parent_refcount (structure, &context->mini_object.refcount);
 174   gst_context_init (context);
 175
 176   context->context_type = g_strdup (context_type);
 177   GST_CONTEXT_STRUCTURE (context) = structure;
 178   context->persistent = persistent;
 179
 180   return context;
 181 }
 182
 183 /**
 184  * gst_context_get_context_type:
 185  * @context: The #GstContext.
 186  *
 187  * Get the type of @context.
 188  *
 189  * Returns: The type of the context.
 190  *
 191  * Since: 1.2
 192  */
 193 const gchar *
 194 gst_context_get_context_type (const GstContext * context)
 195 {
 196   g_return_val_if_fail (GST_IS_CONTEXT (context), NULL);
 197
 198   return context->context_type;
 199 }
 200
 201 /**
 202  * gst_context_has_context_type:
 203  * @context: The #GstContext.
 204  * @context_type: Context type to check.
 205  *
 206  * Checks if @context has @context_type.
 207  *
 208  * Returns: %TRUE if @context has @context_type.
 209  *
 210  * Since: 1.2
 211  */
 212 gboolean
 213 gst_context_has_context_type (const GstContext * context,
 214     const gchar * context_type)
 215 {
 216   g_return_val_if_fail (GST_IS_CONTEXT (context), FALSE);
 217   g_return_val_if_fail (context_type != NULL, FALSE);
 218
 219   return strcmp (context->context_type, context_type) == 0;
 220 }
 221
 222 /**
 223  * gst_context_get_structure:
 224  * @context: The #GstContext.
 225  *
 226  * Access the structure of the context.
 227  *
 228  * Returns: (transfer none): The structure of the context. The structure is
 229  * still owned by the context, which means that you should not modify it,
 230  * free it and that the pointer becomes invalid when you free the context.
 231  *
 232  * Since: 1.2
 233  */
 234 const GstStructure *
 235 gst_context_get_structure (const GstContext * context)
 236 {
 237   g_return_val_if_fail (GST_IS_CONTEXT (context), NULL);
 238
 239   return GST_CONTEXT_STRUCTURE (context);
 240 }
 241
 242 /**
 243  * gst_context_writable_structure:
 244  * @context: The #GstContext.
 245  *
 246  * Get a writable version of the structure.
 247  *
 248  * Returns: The structure of the context. The structure is still
 249  * owned by the context, which means that you should not free it and
 250  * that the pointer becomes invalid when you free the context.
 251  * This function checks if @context is writable.
 252  *
 253  * Since: 1.2
 254  */
 255 GstStructure *
 256 gst_context_writable_structure (GstContext * context)
 257 {
 258   g_return_val_if_fail (GST_IS_CONTEXT (context), NULL);
 259   g_return_val_if_fail (gst_context_is_writable (context), NULL);
 260
 261   return GST_CONTEXT_STRUCTURE (context);
 262 }
 263
 264 /**
 265  * gst_context_is_persistent:
 266  * @context: The #GstContext.
 267  *
 268  * Check if @context is persistent.
 269  *
 270  * Returns: %TRUE if the context is persistent.
 271  *
 272  * Since: 1.2
 273  */
 274 gboolean
 275 gst_context_is_persistent (const GstContext * context)
 276 {
 277   g_return_val_if_fail (GST_IS_CONTEXT (context), FALSE);
 278
 279   return context->persistent;
 280 }