2 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3 * 2000 Wim Taymans <wtay@chello.be>
5 * gstsample.h: Header for GstSample object
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.
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.
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.
24 #ifndef __GST_SAMPLE_H__
25 #define __GST_SAMPLE_H__
27 #include <gst/gstbuffer.h>
28 #include <gst/gstcaps.h>
29 #include <gst/gstsegment.h>
33 GST_EXPORT GType _gst_sample_type;
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))
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.
47 typedef struct _GstSample GstSample;
49 GType gst_sample_get_type (void);
52 GstSample * gst_sample_new (GstBuffer *buffer,
54 const GstSegment *segment,
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);
65 * @sample: a #GstSample
67 * Increases the refcount of the given sample by one.
69 * Returns: (transfer full): @sample
72 G_INLINE_FUNC GstSample * gst_sample_ref (GstSample * sample);
75 static inline GstSample *
76 gst_sample_ref (GstSample * sample)
78 return GST_SAMPLE_CAST (gst_mini_object_ref (GST_MINI_OBJECT_CAST (
84 * @sample: (transfer full): a #GstSample
86 * Decreases the refcount of the sample. If the refcount reaches 0, the
87 * sample will be freed.
90 G_INLINE_FUNC void gst_sample_unref (GstSample * sample);
94 gst_sample_unref (GstSample * sample)
96 gst_mini_object_unref (GST_MINI_OBJECT_CAST (sample));
102 * @buf: a #GstSample.
104 * Create a copy of the given sample. This will also make a newly allocated
105 * copy of the data the source sample contains.
107 * Returns: (transfer full): a new copy of @buf.
111 #ifdef _FOOL_GTK_DOC_
112 G_INLINE_FUNC GstSample * gst_sample_copy (const GstSample * buf);
115 static inline GstSample *
116 gst_sample_copy (const GstSample * buf)
118 return GST_SAMPLE_CAST (gst_mini_object_copy (GST_MINI_OBJECT_CONST_CAST (buf)));
122 * gst_value_set_sample:
123 * @v: a #GValue to receive the data
124 * @b: (transfer none): a #GstSample to assign to the GstValue
126 * Sets @b as the value of @v. Caller retains reference to sample.
128 #define gst_value_set_sample(v,b) g_value_set_boxed((v),(b))
130 * gst_value_take_sample:
131 * @v: a #GValue to receive the data
132 * @b: (transfer full): a #GstSample to assign to the GstValue
134 * Sets @b as the value of @v. Caller gives away reference to sample.
136 #define gst_value_take_sample(v,b) g_value_take_boxed(v,(b))
138 * gst_value_get_sample:
139 * @v: a #GValue to query
141 * Receives a #GstSample as the value of @v. Does not return a reference to
142 * the sample, so the pointer is only valid for as long as the caller owns
145 * Returns: (transfer none): sample
147 #define gst_value_get_sample(v) GST_SAMPLE_CAST (g_value_get_boxed(v))
151 #endif /* __GST_SAMPLE_H__ */