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