Merge remote-tracking branch 'origin/master' into 0.11
[platform/upstream/gstreamer.git] / gst / gstsample.c
1 /* GStreamer
2  * Copyright (C) 2011 Wim Taymans <wim.taymans@gmail.com>
3  *
4  * gstsample.c: media sample
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Library General Public
8  * License as published by the Free Software Foundation; either
9  * version 2 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Library General Public License for more details.
15  *
16  * You should have received a copy of the GNU Library General Public
17  * License along with this library; if not, write to the
18  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19  * Boston, MA 02111-1307, USA.
20  */
21
22 /**
23  * SECTION:gstsample
24  * @short_description: A media sample
25  * @see_also: #GstBuffer, #GstCaps, #GstSegment
26  *
27  * A #GstSample is a small object containing data, a type, timing and
28  * extra arbitrary information.
29  */
30 #include "gst_private.h"
31
32 #include "gstsample.h"
33
34 /**
35  * GstSample:
36  *
37  */
38 struct _GstSample
39 {
40   GstMiniObject mini_object;
41
42   GstBuffer *buffer;
43   GstCaps *caps;
44   GstSegment segment;
45   GstStructure *info;
46 };
47
48 GType _gst_sample_type = 0;
49
50 GST_DEFINE_MINI_OBJECT_TYPE (GstSample, gst_sample);
51
52 void
53 _priv_gst_sample_initialize (void)
54 {
55   _gst_sample_type = gst_sample_get_type ();
56 }
57
58 static GstSample *
59 _gst_sample_copy (GstSample * sample)
60 {
61   GstSample *copy;
62
63   copy = gst_sample_new (sample->buffer, sample->caps, &sample->segment,
64       gst_structure_copy (sample->info));
65
66   return copy;
67 }
68
69 static void
70 _gst_sample_free (GstSample * sample)
71 {
72   GST_LOG ("free %p", sample);
73
74   if (sample->buffer)
75     gst_buffer_unref (sample->buffer);
76   if (sample->caps)
77     gst_caps_unref (sample->caps);
78
79   g_slice_free1 (GST_MINI_OBJECT_SIZE (sample), sample);
80 }
81
82 /**
83  * gst_sample_new:
84  * @buffer: a #GstBuffer
85  * @caps: a #GstCaps
86  * @segment: a #GstSegment
87  * @info: a #GstStructure
88  *
89  * Create a new #GstSample with the provided details.
90  *
91  * Free-function: gst_sample_unref
92  *
93  * Returns: (transfer full): the new #GstSample. gst_sample_unref()
94  *     after usage.
95  *
96  * Since: 0.10.24
97  */
98 GstSample *
99 gst_sample_new (GstBuffer * buffer, GstCaps * caps, const GstSegment * segment,
100     GstStructure * info)
101 {
102   GstSample *sample;
103
104   sample = g_slice_new0 (GstSample);
105
106   GST_LOG ("new %p", sample);
107
108   gst_mini_object_init (GST_MINI_OBJECT_CAST (sample), _gst_sample_type,
109       sizeof (GstSample));
110
111   sample->mini_object.copy = (GstMiniObjectCopyFunction) _gst_sample_copy;
112   sample->mini_object.free = (GstMiniObjectFreeFunction) _gst_sample_free;
113
114   sample->buffer = buffer ? gst_buffer_ref (buffer) : NULL;
115   sample->caps = caps ? gst_caps_ref (caps) : NULL;
116
117   if (segment)
118     gst_segment_copy_into (segment, &sample->segment);
119   else
120     gst_segment_init (&sample->segment, GST_FORMAT_TIME);
121
122   if (info) {
123     if (!gst_structure_set_parent_refcount (info,
124             &sample->mini_object.refcount))
125       goto had_parent;
126
127     sample->info = info;
128   }
129   return sample;
130
131   /* ERRORS */
132 had_parent:
133   {
134     gst_sample_unref (sample);
135     g_warning ("structure is already owned by another object");
136     return NULL;
137   }
138 }
139
140 /**
141  * gst_sample_get_buffer:
142  * @sample: a #GstSample
143  *
144  * Get the buffer associated with @sample
145  *
146  * Returns: (transfer none): the buffer of @sample or NULL when there
147  *  is no buffer. The buffer remains valid as long as @sample is valid.
148  */
149 GstBuffer *
150 gst_sample_get_buffer (GstSample * sample)
151 {
152   g_return_val_if_fail (GST_IS_SAMPLE (sample), NULL);
153
154   return sample->buffer;
155 }
156
157 /**
158  * gst_sample_get_caps:
159  * @sample: a #GstSample
160  *
161  * Get the caps associated with @sample
162  *
163  * Returns: (transfer none): the caps of @sample or NULL when there
164  *  is no caps. The caps remain valid as long as @sample is valid.
165  */
166 GstCaps *
167 gst_sample_get_caps (GstSample * sample)
168 {
169   g_return_val_if_fail (GST_IS_SAMPLE (sample), NULL);
170
171   return sample->caps;
172 }
173
174 /**
175  * gst_sample_get_segment:
176  * @sample: a #GstSample
177  *
178  * Get the segment associated with @sample
179  *
180  * Returns: (transfer none): the segment of @sample.
181  *  The segment remains valid as long as @sample is valid.
182  */
183 GstSegment *
184 gst_sample_get_segment (GstSample * sample)
185 {
186   g_return_val_if_fail (GST_IS_SAMPLE (sample), NULL);
187
188   return &sample->segment;
189 }
190
191 /**
192  * gst_sample_get_info:
193  * @sample: a #GstSample
194  *
195  * Get extra information associated with @sample.
196  *
197  * Returns: (transfer none): the extra info of @sample.
198  *  The info remains valid as long as @sample is valid.
199  */
200 const GstStructure *
201 gst_sample_get_info (GstSample * sample)
202 {
203   g_return_val_if_fail (GST_IS_SAMPLE (sample), NULL);
204
205   return sample->info;
206 }