gst/gstcontext.h

   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 #ifndef __GST_CONTEXT_H__
  25 #define __GST_CONTEXT_H__
  26
  27 #include <glib.h>
  28
  29 G_BEGIN_DECLS
  30
  31 typedef struct _GstContext GstContext;
  32
  33 #include <gst/gstminiobject.h>
  34 #include <gst/gststructure.h>
  35
  36 GST_EXPORT GType _gst_context_type;
  37
  38 #define GST_TYPE_CONTEXT                         (_gst_context_type)
  39 #define GST_IS_CONTEXT(obj)                      (GST_IS_MINI_OBJECT_TYPE (obj, GST_TYPE_CONTEXT))
  40 #define GST_CONTEXT_CAST(obj)                    ((GstContext*)(obj))
  41 #define GST_CONTEXT(obj)                         (GST_CONTEXT_CAST(obj))
  42
  43
  44
  45 GType           gst_context_get_type            (void);
  46
  47
  48 /* refcounting */
  49 /**
  50  * gst_context_ref:
  51  * @context: the context to ref
  52  *
  53  * Convenience macro to increase the reference count of the context.
  54  *
  55  * Returns: @context (for convenience when doing assignments)
  56  */
  57 #ifdef _FOOL_GTK_DOC_
  58 G_INLINE_FUNC GstContext * gst_context_ref (GstContext * context);
  59 #endif
  60
  61 static inline GstContext *
  62 gst_context_ref (GstContext * context)
  63 {
  64   return (GstContext *) gst_mini_object_ref (GST_MINI_OBJECT_CAST (context));
  65 }
  66
  67 /**
  68  * gst_context_unref:
  69  * @context: the context to unref
  70  *
  71  * Convenience macro to decrease the reference count of the context, possibly
  72  * freeing it.
  73  */
  74 #ifdef _FOOL_GTK_DOC_
  75 G_INLINE_FUNC void gst_context_unref (GstContext * context);
  76 #endif
  77
  78 static inline void
  79 gst_context_unref (GstContext * context)
  80 {
  81   gst_mini_object_unref (GST_MINI_OBJECT_CAST (context));
  82 }
  83
  84 /* copy context */
  85 /**
  86  * gst_context_copy:
  87  * @context: the context to copy
  88  *
  89  * Creates a copy of the context. Returns a copy of the context.
  90  *
  91  * Returns: (transfer full): a new copy of @context.
  92  *
  93  * MT safe
  94  */
  95 #ifdef _FOOL_GTK_DOC_
  96 G_INLINE_FUNC GstContext * gst_context_copy (const GstContext * context);
  97 #endif
  98
  99 static inline GstContext *
 100 gst_context_copy (const GstContext * context)
 101 {
 102   return GST_CONTEXT_CAST (gst_mini_object_copy (GST_MINI_OBJECT_CONST_CAST (context)));
 103 }
 104
 105 /**
 106  * gst_context_is_writable:
 107  * @context: a #GstContext
 108  *
 109  * Tests if you can safely write into a context's structure or validly
 110  * modify the seqnum and timestamp fields.
 111  */
 112 #define         gst_context_is_writable(context)     gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (context))
 113 /**
 114  * gst_context_make_writable:
 115  * @context: (transfer full): the context to make writable
 116  *
 117  * Checks if a context is writable. If not, a writable copy is made and
 118  * returned.
 119  *
 120  * Returns: (transfer full): a context (possibly a duplicate) that is writable.
 121  *
 122  * MT safe
 123  */
 124 #define         gst_context_make_writable(context)  GST_CONTEXT_CAST (gst_mini_object_make_writable (GST_MINI_OBJECT_CAST (context)))
 125 /**
 126  * gst_context_replace:
 127  * @old_context: (inout) (transfer full): pointer to a pointer to a #GstContext
 128  *     to be replaced.
 129  * @new_context: (allow-none) (transfer none): pointer to a #GstContext that will
 130  *     replace the context pointed to by @old_context.
 131  *
 132  * Modifies a pointer to a #GstContext to point to a different #GstContext. The
 133  * modification is done atomically (so this is useful for ensuring thread safety
 134  * in some cases), and the reference counts are updated appropriately (the old
 135  * context is unreffed, the new one is reffed).
 136  *
 137  * Either @new_context or the #GstContext pointed to by @old_context may be %NULL.
 138  *
 139  * Returns: %TRUE if @new_context was different from @old_context
 140  */
 141 #ifdef _FOOL_GTK_DOC_
 142 G_INLINE_FUNC gboolean gst_context_replace (GstContext **old_context, GstContext *new_context);
 143 #endif
 144
 145 static inline gboolean
 146 gst_context_replace (GstContext **old_context, GstContext *new_context)
 147 {
 148   return gst_mini_object_replace ((GstMiniObject **) old_context, (GstMiniObject *) new_context);
 149 }
 150
 151 GstContext *          gst_context_new                      (const gchar * context_type,
 152                                                             gboolean persistent) G_GNUC_MALLOC;
 153
 154 const gchar *         gst_context_get_context_type         (const GstContext * context);
 155 gboolean              gst_context_has_context_type         (const GstContext * context, const gchar * context_type);
 156 const GstStructure *  gst_context_get_structure            (const GstContext * context);
 157 GstStructure *        gst_context_writable_structure       (GstContext * context);
 158
 159 gboolean              gst_context_is_persistent            (const GstContext * context);
 160
 161 G_END_DECLS
 162
 163 #endif /* __GST_CONTEXT_H__ */