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_EXPORT 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_EXPORT
  51 GType                gst_sample_get_type      (void);
  52
  53 /* allocation */
  54
  55 GST_EXPORT
  56 GstSample *          gst_sample_new           (GstBuffer          *buffer,
  57                                                GstCaps            *caps,
  58                                                const GstSegment   *segment,
  59                                                GstStructure       *info);
  60 GST_EXPORT
  61 GstBuffer *          gst_sample_get_buffer    (GstSample *sample);
  62
  63 GST_EXPORT
  64 GstCaps *            gst_sample_get_caps      (GstSample *sample);
  65
  66 GST_EXPORT
  67 GstSegment *         gst_sample_get_segment   (GstSample *sample);
  68
  69 GST_EXPORT
  70 const GstStructure * gst_sample_get_info      (GstSample *sample);
  71
  72 GST_EXPORT
  73 GstBufferList *      gst_sample_get_buffer_list (GstSample *sample);
  74
  75 GST_EXPORT
  76 void                 gst_sample_set_buffer_list (GstSample *sample, GstBufferList *buffer_list);
  77
  78 /* refcounting */
  79 /**
  80  * gst_sample_ref:
  81  * @sample: a #GstSample
  82  *
  83  * Increases the refcount of the given sample by one.
  84  *
  85  * Returns: (transfer full): @sample
  86  */
  87 static inline GstSample *
  88 gst_sample_ref (GstSample * sample)
  89 {
  90   return GST_SAMPLE_CAST (gst_mini_object_ref (GST_MINI_OBJECT_CAST (
  91       sample)));
  92 }
  93
  94 /**
  95  * gst_sample_unref:
  96  * @sample: (transfer full): a #GstSample
  97  *
  98  * Decreases the refcount of the sample. If the refcount reaches 0, the
  99  * sample will be freed.
 100  */
 101 static inline void
 102 gst_sample_unref (GstSample * sample)
 103 {
 104   gst_mini_object_unref (GST_MINI_OBJECT_CAST (sample));
 105 }
 106
 107 /* copy sample */
 108 /**
 109  * gst_sample_copy:
 110  * @buf: a #GstSample.
 111  *
 112  * Create a copy of the given sample. This will also make a newly allocated
 113  * copy of the data the source sample contains.
 114  *
 115  * Returns: (transfer full): a new copy of @buf.
 116  *
 117  * Since: 1.2
 118  */
 119 static inline GstSample *
 120 gst_sample_copy (const GstSample * buf)
 121 {
 122   return GST_SAMPLE_CAST (gst_mini_object_copy (GST_MINI_OBJECT_CONST_CAST (buf)));
 123 }
 124
 125 /**
 126  * gst_value_set_sample:
 127  * @v: a #GValue to receive the data
 128  * @b: (transfer none): a #GstSample to assign to the GstValue
 129  *
 130  * Sets @b as the value of @v.  Caller retains reference to sample.
 131  */
 132 #define         gst_value_set_sample(v,b)       g_value_set_boxed((v),(b))
 133 /**
 134  * gst_value_take_sample:
 135  * @v: a #GValue to receive the data
 136  * @b: (transfer full): a #GstSample to assign to the GstValue
 137  *
 138  * Sets @b as the value of @v.  Caller gives away reference to sample.
 139  */
 140 #define         gst_value_take_sample(v,b)      g_value_take_boxed(v,(b))
 141 /**
 142  * gst_value_get_sample:
 143  * @v: a #GValue to query
 144  *
 145  * Receives a #GstSample as the value of @v. Does not return a reference to
 146  * the sample, so the pointer is only valid for as long as the caller owns
 147  * a reference to @v.
 148  *
 149  * Returns: (transfer none): sample
 150  */
 151 #define         gst_value_get_sample(v)         GST_SAMPLE_CAST (g_value_get_boxed(v))
 152
 153 #ifdef G_DEFINE_AUTOPTR_CLEANUP_FUNC
 154 G_DEFINE_AUTOPTR_CLEANUP_FUNC(GstSample, gst_sample_unref)
 155 #endif
 156
 157 G_END_DECLS
 158
 159 #endif /* __GST_SAMPLE_H__ */