gst/gstsample.h

   1 /* GStreamer
   2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
   3  *                    2000 Wim Taymans <wtay@chello.be>
   4  *
   5  * gstsample.h: Header for GstSample object
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Library General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Library General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Library General Public
  18  * License along with this library; if not, write to the
  19  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  20  * Boston, MA 02110-1301, USA.
  21  */
  22
  23
  24 #ifndef __GST_SAMPLE_H__
  25 #define __GST_SAMPLE_H__
  26
  27 #include <gst/gstbuffer.h>
  28 #include <gst/gstbufferlist.h>
  29 #include <gst/gstcaps.h>
  30 #include <gst/gstsegment.h>
  31
  32 G_BEGIN_DECLS
  33
  34 GST_API GType _gst_sample_type;
  35
  36 #define GST_TYPE_SAMPLE      (_gst_sample_type)
  37 #define GST_IS_SAMPLE(obj)   (GST_IS_MINI_OBJECT_TYPE(obj, GST_TYPE_SAMPLE))
  38 #define GST_SAMPLE_CAST(obj) ((GstSample *)obj)
  39 #define GST_SAMPLE(obj)      (GST_SAMPLE_CAST(obj))
  40
  41 /**
  42  * GstSample:
  43  *
  44  * The opaque structure of a #GstSample. A sample contains a typed memory
  45  * block and the associated timing information. It is mainly used to
  46  * exchange buffers with an application.
  47  */
  48 typedef struct _GstSample GstSample;
  49
  50 GST_API
  51 GType                gst_sample_get_type      (void);
  52
  53 /* allocation */
  54
  55 GST_API
  56 GstSample *          gst_sample_new           (GstBuffer          *buffer,
  57                                                GstCaps            *caps,
  58                                                const GstSegment   *segment,
  59                                                GstStructure       *info);
  60 GST_API
  61 GstBuffer *          gst_sample_get_buffer    (GstSample *sample);
  62
  63 GST_API
  64 GstCaps *            gst_sample_get_caps      (GstSample *sample);
  65
  66 GST_API
  67 GstSegment *         gst_sample_get_segment   (GstSample *sample);
  68
  69 GST_API
  70 const GstStructure * gst_sample_get_info      (GstSample *sample);
  71
  72 GST_API
  73 GstBufferList *      gst_sample_get_buffer_list (GstSample *sample);
  74
  75 GST_API
  76 void                 gst_sample_set_buffer_list (GstSample *sample, GstBufferList *buffer_list);
  77
  78 GST_API
  79 void                 gst_sample_set_buffer    (GstSample *sample, GstBuffer *buffer);
  80
  81 GST_API
  82 void                 gst_sample_set_caps      (GstSample *sample, GstCaps *caps);
  83
  84 GST_API
  85 void                 gst_sample_set_segment   (GstSample * sample, const GstSegment *segment);
  86
  87 GST_API
  88 gboolean             gst_sample_set_info      (GstSample *sample, GstStructure *info);
  89
  90 /* refcounting */
  91 /**
  92  * gst_sample_ref:
  93  * @sample: a #GstSample
  94  *
  95  * Increases the refcount of the given sample by one.
  96  *
  97  * Returns: (transfer full): @sample
  98  */
  99 static inline GstSample *
 100 gst_sample_ref (GstSample * sample)
 101 {
 102   return GST_SAMPLE_CAST (gst_mini_object_ref (GST_MINI_OBJECT_CAST (
 103       sample)));
 104 }
 105
 106 /**
 107  * gst_sample_unref:
 108  * @sample: (transfer full): a #GstSample
 109  *
 110  * Decreases the refcount of the sample. If the refcount reaches 0, the
 111  * sample will be freed.
 112  */
 113 static inline void
 114 gst_sample_unref (GstSample * sample)
 115 {
 116   gst_mini_object_unref (GST_MINI_OBJECT_CAST (sample));
 117 }
 118
 119 /**
 120  * gst_sample_is_writable:
 121  *
 122  * Tests if you can safely set the buffer and / or buffer list of @sample.
 123  *
 124  * Since: 1.16
 125  */
 126 #define         gst_sample_is_writable(sample)     gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (sample))
 127
 128 /**
 129  * gst_sample_make_writable:
 130  * @sample: (transfer full):
 131  *
 132  * Returns a writable copy of @sample. If the source sample is
 133  * already writable, this will simply return the same sample.
 134  *
 135  * Use this function to ensure that a sample can be safely modified before
 136  * making changes to it, for example before calling gst_sample_set_buffer()
 137  *
 138  * If the reference count of the source sample @sample is exactly one, the caller
 139  * is the sole owner and this function will return the sample object unchanged.
 140  *
 141  * If there is more than one reference on the object, a copy will be made using
 142  * gst_sample_copy(). The passed-in @sample will be unreffed in that case, and the
 143  * caller will now own a reference to the new returned sample object.
 144  *
 145  * In short, this function unrefs the sample in the argument and refs the sample
 146  * that it returns. Don't access the argument after calling this function unless
 147  * you have an additional reference to it.
 148  *
 149  * Returns: (transfer full): a writable sample which may or may not be the
 150  *     same as @sample
 151  *
 152  * Since: 1.16
 153  */
 154 #define         gst_sample_make_writable(sample)   GST_SAMPLE_CAST (gst_mini_object_make_writable (GST_MINI_OBJECT_CAST (sample)))
 155
 156
 157 /* copy sample */
 158 /**
 159  * gst_sample_copy:
 160  * @buf: a #GstSample.
 161  *
 162  * Create a copy of the given sample. This will also make a newly allocated
 163  * copy of the data the source sample contains.
 164  *
 165  * Returns: (transfer full): a new copy of @buf.
 166  *
 167  * Since: 1.2
 168  */
 169 static inline GstSample *
 170 gst_sample_copy (const GstSample * buf)
 171 {
 172   return GST_SAMPLE_CAST (gst_mini_object_copy (GST_MINI_OBJECT_CONST_CAST (buf)));
 173 }
 174
 175 /**
 176  * gst_value_set_sample:
 177  * @v: a #GValue to receive the data
 178  * @b: (transfer none): a #GstSample to assign to the GstValue
 179  *
 180  * Sets @b as the value of @v.  Caller retains reference to sample.
 181  */
 182 #define         gst_value_set_sample(v,b)       g_value_set_boxed((v),(b))
 183 /**
 184  * gst_value_take_sample:
 185  * @v: a #GValue to receive the data
 186  * @b: (transfer full): a #GstSample to assign to the GstValue
 187  *
 188  * Sets @b as the value of @v.  Caller gives away reference to sample.
 189  */
 190 #define         gst_value_take_sample(v,b)      g_value_take_boxed(v,(b))
 191 /**
 192  * gst_value_get_sample:
 193  * @v: a #GValue to query
 194  *
 195  * Receives a #GstSample as the value of @v. Does not return a reference to
 196  * the sample, so the pointer is only valid for as long as the caller owns
 197  * a reference to @v.
 198  *
 199  * Returns: (transfer none): sample
 200  */
 201 #define         gst_value_get_sample(v)         GST_SAMPLE_CAST (g_value_get_boxed(v))
 202
 203 #ifdef G_DEFINE_AUTOPTR_CLEANUP_FUNC
 204 G_DEFINE_AUTOPTR_CLEANUP_FUNC(GstSample, gst_sample_unref)
 205 #endif
 206
 207 G_END_DECLS
 208
 209 #endif /* __GST_SAMPLE_H__ */