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/gstcaps.h>
  29 #include <gst/gstsegment.h>
  30
  31 G_BEGIN_DECLS
  32
  33 GST_EXPORT GType _gst_sample_type;
  34
  35 #define GST_TYPE_SAMPLE      (_gst_sample_type)
  36 #define GST_IS_SAMPLE(obj)   (GST_IS_MINI_OBJECT_TYPE(obj, GST_TYPE_SAMPLE))
  37 #define GST_SAMPLE_CAST(obj) ((GstSample *)obj)
  38 #define GST_SAMPLE(obj)      (GST_SAMPLE_CAST(obj))
  39
  40 /**
  41  * GstSample:
  42  *
  43  * The opaque structure of a #GstSample. A sample contains a typed memory
  44  * block and the associated timing information. It is mainly used to
  45  * exchange buffers with an application.
  46  */
  47 typedef struct _GstSample GstSample;
  48
  49 GType gst_sample_get_type            (void);
  50
  51 /* allocation */
  52 GstSample *          gst_sample_new           (GstBuffer          *buffer,
  53                                                GstCaps            *caps,
  54                                                const GstSegment   *segment,
  55                                                GstStructure       *info);
  56
  57 GstBuffer *          gst_sample_get_buffer    (GstSample *sample);
  58 GstCaps *            gst_sample_get_caps      (GstSample *sample);
  59 GstSegment *         gst_sample_get_segment   (GstSample *sample);
  60 const GstStructure * gst_sample_get_info      (GstSample *sample);
  61 GstBufferList *      gst_sample_get_buffer_list (GstSample *sample);
  62 void                 gst_sample_set_buffer_list (GstSample *sample, GstBufferList *buffer_list);
  63
  64 /* refcounting */
  65 /**
  66  * gst_sample_ref:
  67  * @sample: a #GstSample
  68  *
  69  * Increases the refcount of the given sample by one.
  70  *
  71  * Returns: (transfer full): @sample
  72  */
  73 #ifdef _FOOL_GTK_DOC_
  74 G_INLINE_FUNC GstSample * gst_sample_ref (GstSample * sample);
  75 #endif
  76
  77 static inline GstSample *
  78 gst_sample_ref (GstSample * sample)
  79 {
  80   return GST_SAMPLE_CAST (gst_mini_object_ref (GST_MINI_OBJECT_CAST (
  81       sample)));
  82 }
  83
  84 /**
  85  * gst_sample_unref:
  86  * @sample: (transfer full): a #GstSample
  87  *
  88  * Decreases the refcount of the sample. If the refcount reaches 0, the
  89  * sample will be freed.
  90  */
  91 #ifdef _FOOL_GTK_DOC_
  92 G_INLINE_FUNC void gst_sample_unref (GstSample * sample);
  93 #endif
  94
  95 static inline void
  96 gst_sample_unref (GstSample * sample)
  97 {
  98   gst_mini_object_unref (GST_MINI_OBJECT_CAST (sample));
  99 }
 100
 101 /* copy sample */
 102 /**
 103  * gst_sample_copy:
 104  * @buf: a #GstSample.
 105  *
 106  * Create a copy of the given sample. This will also make a newly allocated
 107  * copy of the data the source sample contains.
 108  *
 109  * Returns: (transfer full): a new copy of @buf.
 110  *
 111  * Since: 1.2
 112  */
 113 #ifdef _FOOL_GTK_DOC_
 114 G_INLINE_FUNC GstSample * gst_sample_copy (const GstSample * buf);
 115 #endif
 116
 117 static inline GstSample *
 118 gst_sample_copy (const GstSample * buf)
 119 {
 120   return GST_SAMPLE_CAST (gst_mini_object_copy (GST_MINI_OBJECT_CONST_CAST (buf)));
 121 }
 122
 123 /**
 124  * gst_value_set_sample:
 125  * @v: a #GValue to receive the data
 126  * @b: (transfer none): a #GstSample to assign to the GstValue
 127  *
 128  * Sets @b as the value of @v.  Caller retains reference to sample.
 129  */
 130 #define         gst_value_set_sample(v,b)       g_value_set_boxed((v),(b))
 131 /**
 132  * gst_value_take_sample:
 133  * @v: a #GValue to receive the data
 134  * @b: (transfer full): a #GstSample to assign to the GstValue
 135  *
 136  * Sets @b as the value of @v.  Caller gives away reference to sample.
 137  */
 138 #define         gst_value_take_sample(v,b)      g_value_take_boxed(v,(b))
 139 /**
 140  * gst_value_get_sample:
 141  * @v: a #GValue to query
 142  *
 143  * Receives a #GstSample as the value of @v. Does not return a reference to
 144  * the sample, so the pointer is only valid for as long as the caller owns
 145  * a reference to @v.
 146  *
 147  * Returns: (transfer none): sample
 148  */
 149 #define         gst_value_get_sample(v)         GST_SAMPLE_CAST (g_value_get_boxed(v))
 150
 151 G_END_DECLS
 152
 153 #endif /* __GST_SAMPLE_H__ */