docs/random/ensonic/media-device-daemon.txt: more ideas (dbus)
[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_malloc (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 November 23th, 2005 (0.9.5)
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  * The buffer memory is not cleared.
268  *
269  * MT safe.
270  * Returns: the new #GstBuffer.
271  */
272 GstBuffer *
273 gst_buffer_new_and_alloc (guint size)
274 {
275   GstBuffer *newbuf;
276
277   newbuf = gst_buffer_new ();
278
279   newbuf->malloc_data = g_malloc (size);
280   GST_BUFFER_DATA (newbuf) = newbuf->malloc_data;
281   GST_BUFFER_SIZE (newbuf) = size;
282
283   GST_CAT_LOG (GST_CAT_BUFFER, "new %p of size %d", newbuf, size);
284
285   return newbuf;
286 }
287
288 /**
289  * gst_buffer_get_caps:
290  * @buffer: a #GstBuffer.
291  *
292  * Gets the media type of the buffer. This can be NULL if there
293  * is no media type attached to this buffer.
294  *
295  * Returns: a reference to the #GstCaps. unref after usage.
296  * Returns NULL if there were no caps on this buffer.
297  */
298 /* FIXME can we make this threadsafe without a lock on the buffer?
299  * We can use compare and swap and atomic reads. */
300 GstCaps *
301 gst_buffer_get_caps (GstBuffer * buffer)
302 {
303   GstCaps *ret;
304
305   g_return_val_if_fail (buffer != NULL, NULL);
306
307   ret = GST_BUFFER_CAPS (buffer);
308
309   if (ret)
310     gst_caps_ref (ret);
311
312   return ret;
313 }
314
315 /**
316  * gst_buffer_set_caps:
317  * @buffer: a #GstBuffer.
318  * @caps: a #GstCaps.
319  *
320  * Sets the media type on the buffer. The refcount of the caps will
321  * be increased and any previous caps on the buffer will be
322  * unreffed.
323  */
324 /* FIXME can we make this threadsafe without a lock on the buffer?
325  * We can use compare and swap and atomic reads. Another idea is to
326  * not attach the caps to the buffer but use an event to signal a caps
327  * change. */
328 void
329 gst_buffer_set_caps (GstBuffer * buffer, GstCaps * caps)
330 {
331   g_return_if_fail (buffer != NULL);
332
333   gst_caps_replace (&GST_BUFFER_CAPS (buffer), caps);
334 }
335
336 typedef struct _GstSubBuffer GstSubBuffer;
337 typedef struct _GstSubBufferClass GstSubBufferClass;
338
339 #define GST_TYPE_SUBBUFFER                         (gst_subbuffer_get_type())
340
341 #define GST_IS_SUBBUFFER(obj)  (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_SUBBUFFER))
342 #define GST_SUBBUFFER(obj)     (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_SUBBUFFER, GstSubBuffer))
343
344 struct _GstSubBuffer
345 {
346   GstBuffer buffer;
347
348   GstBuffer *parent;
349 };
350
351 struct _GstSubBufferClass
352 {
353   GstBufferClass buffer_class;
354 };
355
356 static GstBufferClass *sub_parent_class;
357
358 static void gst_subbuffer_init (GTypeInstance * instance, gpointer g_class);
359 static void gst_subbuffer_class_init (gpointer g_class, gpointer class_data);
360 static void gst_subbuffer_finalize (GstSubBuffer * buffer);
361
362 static GType
363 gst_subbuffer_get_type (void)
364 {
365   static GType _gst_subbuffer_type = 0;
366
367   if (G_UNLIKELY (_gst_subbuffer_type == 0)) {
368     static const GTypeInfo subbuffer_info = {
369       sizeof (GstSubBufferClass),
370       NULL,
371       NULL,
372       gst_subbuffer_class_init,
373       NULL,
374       NULL,
375       sizeof (GstSubBuffer),
376       0,
377       gst_subbuffer_init,
378       NULL
379     };
380
381     _gst_subbuffer_type = g_type_register_static (GST_TYPE_BUFFER,
382         "GstSubBuffer", &subbuffer_info, 0);
383   }
384   return _gst_subbuffer_type;
385 }
386
387 static void
388 gst_subbuffer_class_init (gpointer g_class, gpointer class_data)
389 {
390   GstBufferClass *buffer_class = GST_BUFFER_CLASS (g_class);
391
392   sub_parent_class = g_type_class_ref (GST_TYPE_BUFFER);
393
394   buffer_class->mini_object_class.finalize =
395       (GstMiniObjectFinalizeFunction) gst_subbuffer_finalize;
396 }
397
398 static void
399 gst_subbuffer_finalize (GstSubBuffer * buffer)
400 {
401   gst_buffer_unref (buffer->parent);
402
403   GST_MINI_OBJECT_CLASS (sub_parent_class)->finalize (GST_MINI_OBJECT (buffer));
404 }
405
406 static void
407 gst_subbuffer_init (GTypeInstance * instance, gpointer g_class)
408 {
409   GST_BUFFER_FLAG_SET (GST_BUFFER_CAST (instance), GST_BUFFER_FLAG_READONLY);
410 }
411
412 /**
413  * gst_buffer_create_sub:
414  * @parent: a #GstBuffer.
415  * @offset: the offset into parent #GstBuffer at which the new sub-buffer 
416  *          begins.
417  * @size: the size of the new #GstBuffer sub-buffer, in bytes (with size > 0).
418  *
419  * Creates a sub-buffer from @parent at @offset and @size.
420  * This sub-buffer uses the actual memory space of the parent buffer.
421  * This function will copy the offset and timestamp fields when the
422  * offset is 0, else they are set to #GST_CLOCK_TIME_NONE/#GST_BUFFER_OFFSET_NONE.
423  * The duration field of the new buffer is set to #GST_CLOCK_TIME_NONE.
424  *
425  * MT safe.
426  * Returns: the new #GstBuffer.
427  * Returns NULL if the arguments were invalid.
428  */
429 GstBuffer *
430 gst_buffer_create_sub (GstBuffer * buffer, guint offset, guint size)
431 {
432   GstSubBuffer *subbuffer;
433   GstBuffer *parent;
434
435   g_return_val_if_fail (buffer != NULL, NULL);
436   g_return_val_if_fail (buffer->mini_object.refcount > 0, NULL);
437   g_return_val_if_fail (size > 0, NULL);
438   g_return_val_if_fail (buffer->size >= offset + size, NULL);
439
440   /* find real parent */
441   if (GST_IS_SUBBUFFER (buffer)) {
442     parent = GST_SUBBUFFER (buffer)->parent;
443   } else {
444     parent = buffer;
445   }
446   gst_buffer_ref (parent);
447
448   /* create the new buffer */
449   subbuffer = (GstSubBuffer *) gst_mini_object_new (GST_TYPE_SUBBUFFER);
450   subbuffer->parent = parent;
451
452   GST_CAT_LOG (GST_CAT_BUFFER, "new subbuffer %p (parent %p)", subbuffer,
453       parent);
454
455   /* set the right values in the child */
456   GST_BUFFER_DATA (GST_BUFFER_CAST (subbuffer)) = buffer->data + offset;
457   GST_BUFFER_SIZE (GST_BUFFER_CAST (subbuffer)) = size;
458
459   /* we can copy the timestamp and offset if the new buffer starts at
460    * offset 0 */
461   if (offset == 0) {
462     GST_BUFFER_TIMESTAMP (subbuffer) = GST_BUFFER_TIMESTAMP (buffer);
463     GST_BUFFER_OFFSET (subbuffer) = GST_BUFFER_OFFSET (buffer);
464   } else {
465     GST_BUFFER_TIMESTAMP (subbuffer) = GST_CLOCK_TIME_NONE;
466     GST_BUFFER_OFFSET (subbuffer) = GST_BUFFER_OFFSET_NONE;
467   }
468
469   GST_BUFFER_DURATION (subbuffer) = GST_CLOCK_TIME_NONE;
470   GST_BUFFER_OFFSET_END (subbuffer) = GST_BUFFER_OFFSET_NONE;
471
472   GST_BUFFER_CAPS (subbuffer) = NULL;
473
474   return GST_BUFFER_CAST (subbuffer);
475 }
476
477 /**
478  * gst_buffer_is_span_fast:
479  * @buf1: the first #GstBuffer.
480  * @buf2: the second #GstBuffer.
481  *
482  * Determines whether a gst_buffer_span() can be done without copying
483  * the contents, that is, whether the data areas are contiguous sub-buffers of 
484  * the same buffer.
485  *
486  * MT safe.
487  * Returns: TRUE if the buffers are contiguous,
488  * FALSE if a copy would be required.
489  */
490 gboolean
491 gst_buffer_is_span_fast (GstBuffer * buf1, GstBuffer * buf2)
492 {
493   g_return_val_if_fail (buf1 != NULL && buf2 != NULL, FALSE);
494   g_return_val_if_fail (buf1->mini_object.refcount > 0, FALSE);
495   g_return_val_if_fail (buf2->mini_object.refcount > 0, FALSE);
496
497   /* it's only fast if we have subbuffers of the same parent */
498   return (GST_IS_SUBBUFFER (buf1) &&
499       GST_IS_SUBBUFFER (buf2) &&
500       (GST_SUBBUFFER (buf1)->parent == GST_SUBBUFFER (buf2)->parent) &&
501       ((buf1->data + buf1->size) == buf2->data));
502 }
503
504 /**
505  * gst_buffer_span:
506  * @buf1: the first source #GstBuffer to merge.
507  * @offset: the offset in the first buffer from where the new
508  * buffer should start.
509  * @buf2: the second source #GstBuffer to merge.
510  * @len: the total length of the new buffer.
511  *
512  * Creates a new buffer that consists of part of buf1 and buf2.
513  * Logically, buf1 and buf2 are concatenated into a single larger
514  * buffer, and a new buffer is created at the given offset inside
515  * this space, with a given length.
516  *
517  * If the two source buffers are children of the same larger buffer,
518  * and are contiguous, the new buffer will be a child of the shared
519  * parent, and thus no copying is necessary. you can use
520  * gst_buffer_is_span_fast() to determine if a memcpy will be needed.
521  *
522  * MT safe.
523  * Returns: the new #GstBuffer that spans the two source buffers.
524  * Returns NULL if the arguments are invalid.
525  */
526 GstBuffer *
527 gst_buffer_span (GstBuffer * buf1, guint32 offset, GstBuffer * buf2,
528     guint32 len)
529 {
530   GstBuffer *newbuf;
531
532   g_return_val_if_fail (buf1 != NULL && buf2 != NULL, NULL);
533   g_return_val_if_fail (buf1->mini_object.refcount > 0, NULL);
534   g_return_val_if_fail (buf2->mini_object.refcount > 0, NULL);
535   g_return_val_if_fail (len > 0, NULL);
536   g_return_val_if_fail (len <= buf1->size + buf2->size - offset, NULL);
537
538   /* if the two buffers have the same parent and are adjacent */
539   if (gst_buffer_is_span_fast (buf1, buf2)) {
540     GstBuffer *parent = GST_SUBBUFFER (buf1)->parent;
541
542     /* we simply create a subbuffer of the common parent */
543     newbuf = gst_buffer_create_sub (parent,
544         buf1->data - parent->data + offset, len);
545   } else {
546     GST_CAT_DEBUG (GST_CAT_BUFFER,
547         "slow path taken while spanning buffers %p and %p", buf1, buf2);
548     /* otherwise we simply have to brute-force copy the buffers */
549     newbuf = gst_buffer_new_and_alloc (len);
550
551     /* copy the first buffer's data across */
552     memcpy (newbuf->data, buf1->data + offset, buf1->size - offset);
553     /* copy the second buffer's data across */
554     memcpy (newbuf->data + (buf1->size - offset), buf2->data,
555         len - (buf1->size - offset));
556     /* if the offset is 0, the new buffer has the same timestamp as buf1 */
557     if (offset == 0) {
558       GST_BUFFER_OFFSET (newbuf) = GST_BUFFER_OFFSET (buf1);
559       GST_BUFFER_TIMESTAMP (newbuf) = GST_BUFFER_TIMESTAMP (buf1);
560     }
561   }
562   /* if we completely merged the two buffers (appended), we can
563    * calculate the duration too. Also make sure we's not messing with
564    * invalid DURATIONS */
565   if (offset == 0 && buf1->size + buf2->size == len) {
566     if (GST_BUFFER_DURATION_IS_VALID (buf1) &&
567         GST_BUFFER_DURATION_IS_VALID (buf2)) {
568       /* add duration */
569       GST_BUFFER_DURATION (newbuf) = GST_BUFFER_DURATION (buf1) +
570           GST_BUFFER_DURATION (buf2);
571     }
572     if (GST_BUFFER_OFFSET_END_IS_VALID (buf2)) {
573       /* add offset_end */
574       GST_BUFFER_OFFSET_END (newbuf) = GST_BUFFER_OFFSET_END (buf2);
575     }
576   }
577
578   return newbuf;
579 }