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., 59 Temple Place - Suite 330,
  20  * Boston, MA 02111-1307, 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 extern 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 and application.
  46  */
  47 typedef struct _GstSample GstSample;
  48
  49 /**
  50  * GST_SAMPLE_TRACE_NAME:
  51  *
  52  * The name used for tracing memory allocations.
  53  */
  54 #define GST_SAMPLE_TRACE_NAME           "GstSample"
  55
  56 GType gst_sample_get_type            (void);
  57
  58 /* allocation */
  59 GstSample *          gst_sample_new           (GstBuffer          *buffer,
  60                                                GstCaps            *caps,
  61                                                const GstSegment   *segment,
  62                                                GstStructure       *info);
  63
  64 GstBuffer *          gst_sample_get_buffer    (GstSample *sample);
  65 GstCaps *            gst_sample_get_caps      (GstSample *sample);
  66 GstSegment *         gst_sample_get_segment   (GstSample *sample);
  67 const GstStructure * gst_sample_get_info      (GstSample *sample);
  68
  69 /* refcounting */
  70 /**
  71  * gst_sample_ref:
  72  * @sample: a #GstSample
  73  *
  74  * Increases the refcount of the given sample by one.
  75  *
  76  * Returns: (transfer full): @sample
  77  */
  78 #ifdef _FOOL_GTK_DOC_
  79 G_INLINE_FUNC GstSample * gst_sample_ref (GstSample * sample);
  80 #endif
  81
  82 static inline GstSample *
  83 gst_sample_ref (GstSample * sample)
  84 {
  85   return GST_SAMPLE_CAST (gst_mini_object_ref (GST_MINI_OBJECT_CAST (
  86       sample)));
  87 }
  88
  89 /**
  90  * gst_sample_unref:
  91  * @sample: (transfer full): a #GstSample
  92  *
  93  * Decreases the refcount of the sample. If the refcount reaches 0, the
  94  * sample will be freed.
  95  */
  96 #ifdef _FOOL_GTK_DOC_
  97 G_INLINE_FUNC void gst_sample_unref (GstSample * sample);
  98 #endif
  99
 100 static inline void
 101 gst_sample_unref (GstSample * sample)
 102 {
 103   gst_mini_object_unref (GST_MINI_OBJECT_CAST (sample));
 104 }
 105
 106 /**
 107  * gst_value_set_sample:
 108  * @v: a #GValue to receive the data
 109  * @b: (transfer none): a #GstSample to assign to the GstValue
 110  *
 111  * Sets @b as the value of @v.  Caller retains reference to sample.
 112  */
 113 #define         gst_value_set_sample(v,b)       g_value_set_boxed((v),(b))
 114 /**
 115  * gst_value_take_sample:
 116  * @v: a #GValue to receive the data
 117  * @b: (transfer full): a #GstSample to assign to the GstValue
 118  *
 119  * Sets @b as the value of @v.  Caller gives away reference to sample.
 120  */
 121 #define         gst_value_take_sample(v,b)      g_value_take_boxed(v,(b))
 122 /**
 123  * gst_value_get_sample:
 124  * @v: a #GValue to query
 125  *
 126  * Receives a #GstSample as the value of @v. Does not return a reference to
 127  * the sample, so the pointer is only valid for as long as the caller owns
 128  * a reference to @v.
 129  *
 130  * Returns: (transfer none): sample
 131  */
 132 #define         gst_value_get_sample(v)         GST_SAMPLE_CAST (g_value_get_boxed(v))
 133
 134 G_END_DECLS
 135
 136 #endif /* __GST_SAMPLE_H__ */