gst/gstbuffer.c: Copy more flags.
[platform/upstream/gstreamer.git] / gst / gstbuffer.c
1 /* GStreamer
2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3  *                    2000 Wim Taymans <wtay@chello.be>
4  *
5  * gstbuffer.c: Buffer operations
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  * SECTION:gstbuffer
25  * @short_description: Data-passing buffer type, supporting sub-buffers.
26  * @see_also: #GstPad, #GstMiniObject
27  *
28  * Buffers are the basic unit of data transfer in GStreamer.  The #GstBuffer type
29  * provides all the state necessary to define a region of memory as part of a
30  * stream.  Sub-buffers are also supported, allowing a smaller region of a
31  * buffer to become its own buffer, with mechanisms in place to ensure that
32  * neither memory space goes away prematurely.
33  *
34  * Buffers are usually created with gst_buffer_new(). After a buffer has been
35  * created one will typically allocate memory for it and set the size of the
36  * buffer data.  The following example creates a buffer that can hold a given
37  * video frame with a given width, height and bits per plane.
38  * <example>
39  * <title>Creating a buffer for a video frame</title>
40  *   <programlisting>
41  *   GstBuffer *buffer;
42  *   gint size, width, height, bpp;
43  *   ...
44  *   size = width * height * bpp;
45  *   buffer = gst_buffer_new ();
46  *   GST_BUFFER_SIZE (buffer) = size;
47  *   GST_BUFFER_MALLOCDATA (buffer) = g_alloc (size);
48  *   GST_BUFFER_DATA (buffer) = GST_BUFFER_MALLOCDATA (buffer);
49  *   ...
50  *   </programlisting>
51  * </example>
52  *
53  * Alternatively, use gst_buffer_new_and_alloc()
54  * to create a buffer with preallocated data of a given size.
55  *
56  * If an element knows what pad you will push the buffer out on, it should use
57  * gst_pad_alloc_buffer() instead to create a buffer.  This allows downstream
58  * elements to provide special buffers to write in, like hardware buffers.
59  *
60  * A buffer has a pointer to a #GstCaps describing the media type of the data
61  * in the buffer. Attach caps to the buffer with gst_buffer_set_caps(); this
62  * is typically done before pushing out a buffer using gst_pad_push() so that
63  * the downstream element knows the type of the buffer.
64  * 
65  * A buffer will usually have a timestamp, and a duration, but neither of these
66  * are guaranteed (they may be set to #GST_CLOCK_TIME_NONE). Whenever a 
67  * meaningful value can be given for these, they should be set. The timestamp 
68  * and duration are measured in nanoseconds (they are #GstClockTime values). 
69  * 
70  * A buffer can also have one or both of a start and an end offset. These are
71  * media-type specific. For video buffers, the start offset will generally be
72  * the frame number. For audio buffers, it will be the number of samples 
73  * produced so far. For compressed data, it could be the byte offset in a 
74  * source or destination file. Likewise, the end offset will be the offset of
75  * the end of the buffer. These can only be meaningfully interpreted if you
76  * know the media type of the buffer (the #GstCaps set on it). Either or both
77  * can be set to #GST_BUFFER_OFFSET_NONE.
78  *
79  * gst_buffer_ref() is used to increase the refcount of a buffer. This must be
80  * done when you want to keep a handle to the buffer after pushing it to the
81  * next element.
82  *
83  * To efficiently create a smaller buffer out of an existing one, you can
84  * use gst_buffer_create_sub().
85  *
86  * If the plug-in wants to modify the buffer in-place, it should first obtain
87  * a buffer that is safe to modify by using gst_buffer_make_writable().  This
88  * function is optimized so that a copy will only be made when it is necessary.
89  *
90  * Several flags of the buffer can be set and unset with the
91  * GST_BUFFER_FLAG_SET() and GST_BUFFER_FLAG_UNSET() macros. Use
92  * GST_BUFFER_FLAG_IS_SET() to test if a certain #GstBufferFlag is set.
93  *
94  * Buffers can be efficiently merged into a larger buffer with
95  * gst_buffer_merge() and gst_buffer_span() if the gst_buffer_is_span_fast()
96  * function returns TRUE.
97  *
98  * An element should either unref the buffer or push it out on a src pad
99  * using gst_pad_push() (see #GstPad).
100  *
101  * Buffers are usually freed by unreffing them with gst_buffer_unref(). When
102  * the refcount drops to 0, any data pointed to by GST_BUFFER_MALLOCDATA() will
103  * also be freed.
104  *
105  * Last reviewed on October 28th, 2005 (0.9.4)
106  */
107 #include "gst_private.h"
108
109 #include "gstbuffer.h"
110 #include "gstinfo.h"
111 #include "gstutils.h"
112 #include "gstminiobject.h"
113
114
115 static void gst_buffer_init (GTypeInstance * instance, gpointer g_class);
116 static void gst_buffer_class_init (gpointer g_class, gpointer class_data);
117 static void gst_buffer_finalize (GstBuffer * buffer);
118 static GstBuffer *_gst_buffer_copy (GstBuffer * buffer);
119
120
121 void
122 _gst_buffer_initialize (void)
123 {
124   gpointer ptr;
125
126   gst_buffer_get_type ();
127
128   /* the GstMiniObject types need to be class_ref'd once before it can be
129    * done from multiple threads;
130    * see http://bugzilla.gnome.org/show_bug.cgi?id=304551 */
131   ptr = g_type_class_ref (GST_TYPE_BUFFER);
132   g_type_class_unref (ptr);
133 }
134
135 GType
136 gst_buffer_get_type (void)
137 {
138   static GType _gst_buffer_type;
139
140   if (G_UNLIKELY (_gst_buffer_type == 0)) {
141     static const GTypeInfo buffer_info = {
142       sizeof (GstBufferClass),
143       NULL,
144       NULL,
145       gst_buffer_class_init,
146       NULL,
147       NULL,
148       sizeof (GstBuffer),
149       0,
150       gst_buffer_init,
151       NULL
152     };
153
154     _gst_buffer_type = g_type_register_static (GST_TYPE_MINI_OBJECT,
155         "GstBuffer", &buffer_info, 0);
156   }
157   return _gst_buffer_type;
158 }
159
160 static void
161 gst_buffer_class_init (gpointer g_class, gpointer class_data)
162 {
163   GstBufferClass *buffer_class = GST_BUFFER_CLASS (g_class);
164
165   buffer_class->mini_object_class.copy =
166       (GstMiniObjectCopyFunction) _gst_buffer_copy;
167   buffer_class->mini_object_class.finalize =
168       (GstMiniObjectFinalizeFunction) gst_buffer_finalize;
169
170 }
171
172 static void
173 gst_buffer_finalize (GstBuffer * buffer)
174 {
175   g_return_if_fail (buffer != NULL);
176
177   GST_CAT_LOG (GST_CAT_BUFFER, "finalize %p", buffer);
178
179   /* free our data */
180   if (buffer->malloc_data) {
181     g_free (buffer->malloc_data);
182   }
183
184   gst_caps_replace (&GST_BUFFER_CAPS (buffer), NULL);
185 }
186
187 static GstBuffer *
188 _gst_buffer_copy (GstBuffer * buffer)
189 {
190   GstBuffer *copy;
191   guint mask;
192
193   g_return_val_if_fail (buffer != NULL, NULL);
194
195   /* create a fresh new buffer */
196   copy = gst_buffer_new ();
197
198   GST_CAT_LOG (GST_CAT_BUFFER, "copy %p to %p", buffer, copy);
199
200   /* copy relevant flags */
201   mask = GST_BUFFER_FLAG_PREROLL | GST_BUFFER_FLAG_IN_CAPS |
202       GST_BUFFER_FLAG_DELTA_UNIT | GST_BUFFER_FLAG_DISCONT |
203       GST_BUFFER_FLAG_GAP;
204   GST_MINI_OBJECT (copy)->flags |= GST_MINI_OBJECT (buffer)->flags & mask;
205
206   /* we simply copy everything from our parent */
207   copy->data = g_memdup (buffer->data, buffer->size);
208   /* make sure it gets freed (even if the parent is subclassed, we return a
209      normal buffer */
210   copy->malloc_data = copy->data;
211
212   copy->size = buffer->size;
213
214   GST_BUFFER_TIMESTAMP (copy) = GST_BUFFER_TIMESTAMP (buffer);
215   GST_BUFFER_DURATION (copy) = GST_BUFFER_DURATION (buffer);
216   GST_BUFFER_OFFSET (copy) = GST_BUFFER_OFFSET (buffer);
217   GST_BUFFER_OFFSET_END (copy) = GST_BUFFER_OFFSET_END (buffer);
218
219   if (GST_BUFFER_CAPS (buffer))
220     GST_BUFFER_CAPS (copy) = gst_caps_ref (GST_BUFFER_CAPS (buffer));
221   else
222     GST_BUFFER_CAPS (copy) = NULL;
223
224   return copy;
225 }
226
227 static void
228 gst_buffer_init (GTypeInstance * instance, gpointer g_class)
229 {
230   GstBuffer *buffer;
231
232   buffer = (GstBuffer *) instance;
233
234   GST_CAT_LOG (GST_CAT_BUFFER, "init %p", buffer);
235
236   GST_BUFFER_TIMESTAMP (buffer) = GST_CLOCK_TIME_NONE;
237   GST_BUFFER_DURATION (buffer) = GST_CLOCK_TIME_NONE;
238   GST_BUFFER_OFFSET (buffer) = GST_BUFFER_OFFSET_NONE;
239   GST_BUFFER_OFFSET_END (buffer) = GST_BUFFER_OFFSET_NONE;
240 }
241
242 /**
243  * gst_buffer_new:
244  *
245  * Creates a newly allocated buffer without any data.
246  *
247  * MT safe.
248  * Returns: the new #GstBuffer.
249  */
250 GstBuffer *
251 gst_buffer_new (void)
252 {
253   GstBuffer *newbuf;
254
255   newbuf = (GstBuffer *) gst_mini_object_new (GST_TYPE_BUFFER);
256
257   GST_CAT_LOG (GST_CAT_BUFFER, "new %p", newbuf);
258
259   return newbuf;
260 }
261
262 /**
263  * gst_buffer_new_and_alloc:
264  * @size: the size of the new buffer's data.
265  *
266  * Creates a newly allocated buffer with data of the given size.
267  *
268  * MT safe.
269  * Returns: the new #GstBuffer.
270  */
271 GstBuffer *
272 gst_buffer_new_and_alloc (guint size)
273 {
274   GstBuffer *newbuf;
275
276   newbuf = gst_buffer_new ();
277
278   newbuf->malloc_data = g_malloc (size);
279   GST_BUFFER_DATA (newbuf) = newbuf->malloc_data;
280   GST_BUFFER_SIZE (newbuf) = size;
281
282   GST_CAT_LOG (GST_CAT_BUFFER, "new %p of size %d", newbuf, size);
283
284   return newbuf;
285 }
286
287 /**
288  * gst_buffer_get_caps:
289  * @buffer: a #GstBuffer.
290  *
291  * Gets the media type of the buffer. This can be NULL if there
292  * is no media type attached to this buffer.
293  *
294  * Returns: a reference to the #GstCaps.
295  * Returns NULL if there were no caps on this buffer.
296  */
297 /* FIXME can we make this threadsafe without a lock on the buffer?
298  * We can use compare and swap and atomic reads. */
299 GstCaps *
300 gst_buffer_get_caps (GstBuffer * buffer)
301 {
302   GstCaps *ret;
303
304   g_return_val_if_fail (buffer != NULL, NULL);
305
306   ret = GST_BUFFER_CAPS (buffer);
307
308   if (ret)
309     gst_caps_ref (ret);
310
311   return ret;
312 }
313
314 /**
315  * gst_buffer_set_caps:
316  * @buffer: a #GstBuffer.
317  * @caps: a #GstCaps.
318  *
319  * Sets the media type on the buffer. The refcount of the caps will
320  * be increased and any previous caps on the buffer will be
321  * unreffed.
322  */
323 /* FIXME can we make this threadsafe without a lock on the buffer?
324  * We can use compare and swap and atomic reads. Another idea is to
325  * not attach the caps to the buffer but use an event to signal a caps
326  * change. */
327 void
328 gst_buffer_set_caps (GstBuffer * buffer, GstCaps * caps)
329 {
330   g_return_if_fail (buffer != NULL);
331
332   gst_caps_replace (&GST_BUFFER_CAPS (buffer), caps);
333 }
334
335 typedef struct _GstSubBuffer GstSubBuffer;
336 typedef struct _GstSubBufferClass GstSubBufferClass;
337
338 #define GST_TYPE_SUBBUFFER                         (gst_subbuffer_get_type())
339
340 #define GST_IS_SUBBUFFER(obj)  (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_SUBBUFFER))
341 #define GST_SUBBUFFER(obj)     (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_SUBBUFFER, GstSubBuffer))
342
343 struct _GstSubBuffer
344 {
345   GstBuffer buffer;
346
347   GstBuffer *parent;
348 };
349
350 struct _GstSubBufferClass
351 {
352   GstBufferClass buffer_class;
353 };
354
355 static GstBufferClass *sub_parent_class;
356
357 static void gst_subbuffer_init (GTypeInstance * instance, gpointer g_class);
358 static void gst_subbuffer_class_init (gpointer g_class, gpointer class_data);
359 static void gst_subbuffer_finalize (GstSubBuffer * buffer);
360
361 static GType
362 gst_subbuffer_get_type (void)
363 {
364   static GType _gst_subbuffer_type = 0;
365
366   if (G_UNLIKELY (_gst_subbuffer_type == 0)) {
367     static const GTypeInfo subbuffer_info = {
368       sizeof (GstSubBufferClass),
369       NULL,
370       NULL,
371       gst_subbuffer_class_init,
372       NULL,
373       NULL,
374       sizeof (GstSubBuffer),
375       0,
376       gst_subbuffer_init,
377       NULL
378     };
379
380     _gst_subbuffer_type = g_type_register_static (GST_TYPE_BUFFER,
381         "GstSubBuffer", &subbuffer_info, 0);
382   }
383   return _gst_subbuffer_type;
384 }
385
386 static void
387 gst_subbuffer_class_init (gpointer g_class, gpointer class_data)
388 {
389   GstBufferClass *buffer_class = GST_BUFFER_CLASS (g_class);
390
391   sub_parent_class = g_type_class_ref (GST_TYPE_BUFFER);
392
393   buffer_class->mini_object_class.finalize =
394       (GstMiniObjectFinalizeFunction) gst_subbuffer_finalize;
395 }
396
397 static void
398 gst_subbuffer_finalize (GstSubBuffer * buffer)
399 {
400   gst_buffer_unref (buffer->parent);
401
402   GST_MINI_OBJECT_CLASS (sub_parent_class)->finalize (GST_MINI_OBJECT (buffer));
403 }
404
405 static void
406 gst_subbuffer_init (GTypeInstance * instance, gpointer g_class)
407 {
408   GST_BUFFER_FLAG_SET (GST_BUFFER_CAST (instance), GST_BUFFER_FLAG_READONLY);
409 }
410
411 /**
412  * gst_buffer_create_sub:
413  * @parent: a #GstBuffer.
414  * @offset: the offset into parent #GstBuffer at which the new sub-buffer 
415  *          begins.
416  * @size: the size of the new #GstBuffer sub-buffer, in bytes (with size > 0).
417  *
418  * Creates a sub-buffer from @parent at @offset and @size.
419  * This sub-buffer uses the actual memory space of the parent buffer.
420  * This function will copy the offset and timestamp fields when the
421  * offset is 0, else they are set to #GST_CLOCK_TIME_NONE/#GST_BUFFER_OFFSET_NONE.
422  * The duration field of the new buffer is set to #GST_CLOCK_TIME_NONE.
423  *
424  * MT safe.
425  * Returns: the new #GstBuffer.
426  * Returns NULL if the arguments were invalid.
427  */
428 GstBuffer *
429 gst_buffer_create_sub (GstBuffer * buffer, guint offset, guint size)
430 {
431   GstSubBuffer *subbuffer;
432   GstBuffer *parent;
433
434   g_return_val_if_fail (buffer != NULL, NULL);
435   g_return_val_if_fail (buffer->mini_object.refcount > 0, NULL);
436   g_return_val_if_fail (size > 0, NULL);
437   g_return_val_if_fail (buffer->size >= offset + size, NULL);
438
439   /* find real parent */
440   if (GST_IS_SUBBUFFER (buffer)) {
441     parent = GST_SUBBUFFER (buffer)->parent;
442   } else {
443     parent = buffer;
444   }
445   gst_buffer_ref (parent);
446
447   /* create the new buffer */
448   subbuffer = (GstSubBuffer *) gst_mini_object_new (GST_TYPE_SUBBUFFER);
449   subbuffer->parent = parent;
450
451   GST_CAT_LOG (GST_CAT_BUFFER, "new subbuffer %p (parent %p)", subbuffer,
452       parent);
453
454   /* set the right values in the child */
455   GST_BUFFER_DATA (GST_BUFFER_CAST (subbuffer)) = buffer->data + offset;
456   GST_BUFFER_SIZE (GST_BUFFER_CAST (subbuffer)) = size;
457
458   /* we can copy the timestamp and offset if the new buffer starts at
459    * offset 0 */
460   if (offset == 0) {
461     GST_BUFFER_TIMESTAMP (subbuffer) = GST_BUFFER_TIMESTAMP (buffer);
462     GST_BUFFER_OFFSET (subbuffer) = GST_BUFFER_OFFSET (buffer);
463   } else {
464     GST_BUFFER_TIMESTAMP (subbuffer) = GST_CLOCK_TIME_NONE;
465     GST_BUFFER_OFFSET (subbuffer) = GST_BUFFER_OFFSET_NONE;
466   }
467
468   GST_BUFFER_DURATION (subbuffer) = GST_CLOCK_TIME_NONE;
469   GST_BUFFER_OFFSET_END (subbuffer) = GST_BUFFER_OFFSET_NONE;
470
471   GST_BUFFER_CAPS (subbuffer) = NULL;
472
473   return GST_BUFFER_CAST (subbuffer);
474 }
475
476 /**
477  * gst_buffer_is_span_fast:
478  * @buf1: the first #GstBuffer.
479  * @buf2: the second #GstBuffer.
480  *
481  * Determines whether a gst_buffer_span() can be done without copying
482  * the contents, that is, whether the data areas are contiguous sub-buffers of 
483  * the same buffer.
484  *
485  * MT safe.
486  * Returns: TRUE if the buffers are contiguous,
487  * FALSE if a copy would be required.
488  */
489 gboolean
490 gst_buffer_is_span_fast (GstBuffer * buf1, GstBuffer * buf2)
491 {
492   g_return_val_if_fail (buf1 != NULL && buf2 != NULL, FALSE);
493   g_return_val_if_fail (buf1->mini_object.refcount > 0, FALSE);
494   g_return_val_if_fail (buf2->mini_object.refcount > 0, FALSE);
495
496   /* it's only fast if we have subbuffers of the same parent */
497   return (GST_IS_SUBBUFFER (buf1) &&
498       GST_IS_SUBBUFFER (buf2) &&
499       (GST_SUBBUFFER (buf1)->parent == GST_SUBBUFFER (buf2)->parent) &&
500       ((buf1->data + buf1->size) == buf2->data));
501 }
502
503 /**
504  * gst_buffer_span:
505  * @buf1: the first source #GstBuffer to merge.
506  * @offset: the offset in the first buffer from where the new
507  * buffer should start.
508  * @buf2: the second source #GstBuffer to merge.
509  * @len: the total length of the new buffer.
510  *
511  * Creates a new buffer that consists of part of buf1 and buf2.
512  * Logically, buf1 and buf2 are concatenated into a single larger
513  * buffer, and a new buffer is created at the given offset inside
514  * this space, with a given length.
515  *
516  * If the two source buffers are children of the same larger buffer,
517  * and are contiguous, the new buffer will be a child of the shared
518  * parent, and thus no copying is necessary. you can use
519  * gst_buffer_is_span_fast() to determine if a memcpy will be needed.
520  *
521  * MT safe.
522  * Returns: the new #GstBuffer that spans the two source buffers.
523  * Returns NULL if the arguments are invalid.
524  */
525 GstBuffer *
526 gst_buffer_span (GstBuffer * buf1, guint32 offset, GstBuffer * buf2,
527     guint32 len)
528 {
529   GstBuffer *newbuf;
530
531   g_return_val_if_fail (buf1 != NULL && buf2 != NULL, NULL);
532   g_return_val_if_fail (buf1->mini_object.refcount > 0, NULL);
533   g_return_val_if_fail (buf2->mini_object.refcount > 0, NULL);
534   g_return_val_if_fail (len > 0, NULL);
535   g_return_val_if_fail (len <= buf1->size + buf2->size - offset, NULL);
536
537   /* if the two buffers have the same parent and are adjacent */
538   if (gst_buffer_is_span_fast (buf1, buf2)) {
539     GstBuffer *parent = GST_SUBBUFFER (buf1)->parent;
540
541     /* we simply create a subbuffer of the common parent */
542     newbuf = gst_buffer_create_sub (parent,
543         buf1->data - parent->data + offset, len);
544   } else {
545     GST_CAT_DEBUG (GST_CAT_BUFFER,
546         "slow path taken while spanning buffers %p and %p", buf1, buf2);
547     /* otherwise we simply have to brute-force copy the buffers */
548     newbuf = gst_buffer_new_and_alloc (len);
549
550     /* copy the first buffer's data across */
551     memcpy (newbuf->data, buf1->data + offset, buf1->size - offset);
552     /* copy the second buffer's data across */
553     memcpy (newbuf->data + (buf1->size - offset), buf2->data,
554         len - (buf1->size - offset));
555     /* if the offset is 0, the new buffer has the same timestamp as buf1 */
556     if (offset == 0) {
557       GST_BUFFER_OFFSET (newbuf) = GST_BUFFER_OFFSET (buf1);
558       GST_BUFFER_TIMESTAMP (newbuf) = GST_BUFFER_TIMESTAMP (buf1);
559     }
560   }
561   /* if we completely merged the two buffers (appended), we can
562    * calculate the duration too. Also make sure we's not messing with
563    * invalid DURATIONS */
564   if (offset == 0 && buf1->size + buf2->size == len) {
565     if (GST_BUFFER_DURATION_IS_VALID (buf1) &&
566         GST_BUFFER_DURATION_IS_VALID (buf2)) {
567       /* add duration */
568       GST_BUFFER_DURATION (newbuf) = GST_BUFFER_DURATION (buf1) +
569           GST_BUFFER_DURATION (buf2);
570     }
571     if (GST_BUFFER_OFFSET_END_IS_VALID (buf2)) {
572       /* add offset_end */
573       GST_BUFFER_OFFSET_END (newbuf) = GST_BUFFER_OFFSET_END (buf2);
574     }
575   }
576
577   return newbuf;
578 }