2 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3 * 2000 Wim Taymans <wtay@chello.be>
5 * gstbuffer.c: Buffer operations
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., 59 Temple Place - Suite 330,
20 * Boston, MA 02111-1307, USA.
23 #include "gst_private.h"
25 #include "gstatomic_impl.h"
26 #include "gstdata_private.h"
27 #include "gstbuffer.h"
28 #include "gstmemchunk.h"
31 GType _gst_buffer_type;
33 #ifndef GST_DISABLE_TRACE
34 /* #define GST_WITH_ALLOC_TRACE */
37 static GstAllocTrace *_gst_buffer_trace;
40 static GstMemChunk *chunk;
43 _gst_buffer_initialize (void)
45 _gst_buffer_type = g_boxed_type_register_static ("GstBuffer",
46 (GBoxedCopyFunc) gst_data_ref,
47 (GBoxedFreeFunc) gst_data_unref);
49 #ifndef GST_DISABLE_TRACE
50 _gst_buffer_trace = gst_alloc_trace_register (GST_BUFFER_TRACE_NAME);
53 chunk = gst_mem_chunk_new ("GstBufferChunk", sizeof (GstBuffer),
54 sizeof (GstBuffer) * 200, 0);
56 GST_CAT_INFO (GST_CAT_BUFFER, "Buffers are initialized now");
60 gst_buffer_get_type (void)
62 return _gst_buffer_type;
66 _gst_buffer_sub_free (GstBuffer *buffer)
68 gst_data_unref (GST_DATA (buffer->buffer_private));
70 GST_BUFFER_DATA (buffer) = NULL;
71 GST_BUFFER_SIZE (buffer) = 0;
73 _GST_DATA_DISPOSE (GST_DATA (buffer));
75 gst_mem_chunk_free (chunk, GST_DATA (buffer));
76 #ifndef GST_DISABLE_TRACE
77 gst_alloc_trace_free (_gst_buffer_trace, buffer);
82 * gst_buffer_default_free:
83 * @buffer: a #GstBuffer to free.
85 * Frees the memory associated with the buffer including the buffer data,
86 * unless the GST_BUFFER_DONTFREE flags was set or the buffer data is NULL.
89 gst_buffer_default_free (GstBuffer *buffer)
91 g_return_if_fail (buffer != NULL);
94 if (GST_BUFFER_FREE_DATA_FUNC (buffer)) {
95 GST_BUFFER_FREE_DATA_FUNC (buffer) (buffer);
96 } else if (!GST_BUFFER_FLAG_IS_SET (buffer, GST_BUFFER_DONTFREE)) {
97 g_free (GST_BUFFER_DATA (buffer));
100 /* set to safe values */
101 GST_BUFFER_DATA (buffer) = NULL;
102 GST_BUFFER_SIZE (buffer) = 0;
104 _GST_DATA_DISPOSE (GST_DATA (buffer));
106 gst_mem_chunk_free (chunk, GST_DATA (buffer));
107 #ifndef GST_DISABLE_TRACE
108 gst_alloc_trace_free (_gst_buffer_trace, buffer);
114 * @dest: buffer to stamp
115 * @src: buffer to stamp from
117 * Copies additional information (timestamps and offsets) from one buffer to
121 gst_buffer_stamp (GstBuffer *dest, const GstBuffer *src)
123 g_return_if_fail (dest != NULL);
124 g_return_if_fail (src != NULL);
126 GST_BUFFER_TIMESTAMP (dest) = GST_BUFFER_TIMESTAMP (src);
127 GST_BUFFER_DURATION (dest) = GST_BUFFER_DURATION (src);
128 GST_BUFFER_OFFSET (dest) = GST_BUFFER_OFFSET (src);
129 GST_BUFFER_OFFSET_END (dest) = GST_BUFFER_OFFSET_END (src);
132 * gst_buffer_default_copy:
133 * @buffer: a #GstBuffer to make a copy of.
135 * Make a full newly allocated copy of the given buffer, data and all.
137 * Returns: the new #GstBuffer.
140 gst_buffer_default_copy (GstBuffer *buffer)
144 g_return_val_if_fail (buffer != NULL, NULL);
146 /* create a fresh new buffer */
147 copy = gst_mem_chunk_alloc (chunk);
148 #ifndef GST_DISABLE_TRACE
149 gst_alloc_trace_new (_gst_buffer_trace, copy);
152 _GST_DATA_INIT (GST_DATA (copy),
155 (GstDataFreeFunction) gst_buffer_default_free,
156 (GstDataCopyFunction) gst_buffer_default_copy);
158 /* we simply copy everything from our parent */
159 GST_BUFFER_DATA (copy) = g_memdup (GST_BUFFER_DATA (buffer),
160 GST_BUFFER_SIZE (buffer));
161 GST_BUFFER_SIZE (copy) = GST_BUFFER_SIZE (buffer);
162 GST_BUFFER_MAXSIZE (copy) = GST_BUFFER_SIZE (buffer);
164 gst_buffer_stamp (copy, buffer);
165 GST_BUFFER_FREE_DATA_FUNC (copy) = NULL;
166 GST_BUFFER_PRIVATE (copy) = NULL;
174 * Creates a newly allocated buffer without any data.
176 * Returns: the new #GstBuffer.
179 gst_buffer_new (void)
183 newbuf = gst_mem_chunk_alloc (chunk);
184 #ifndef GST_DISABLE_TRACE
185 gst_alloc_trace_new (_gst_buffer_trace, newbuf);
188 GST_CAT_LOG (GST_CAT_BUFFER, "new %p", newbuf);
190 _GST_DATA_INIT (GST_DATA (newbuf),
193 (GstDataFreeFunction) gst_buffer_default_free,
194 (GstDataCopyFunction) gst_buffer_default_copy);
196 GST_BUFFER_DATA (newbuf) = NULL;
197 GST_BUFFER_SIZE (newbuf) = 0;
198 GST_BUFFER_MAXSIZE (newbuf) = GST_BUFFER_MAXSIZE_NONE;
199 GST_BUFFER_TIMESTAMP (newbuf) = GST_CLOCK_TIME_NONE;
200 GST_BUFFER_DURATION (newbuf) = GST_CLOCK_TIME_NONE;
201 GST_BUFFER_OFFSET (newbuf) = GST_BUFFER_OFFSET_NONE;
202 GST_BUFFER_OFFSET_END (newbuf) = GST_BUFFER_OFFSET_NONE;
203 GST_BUFFER_FREE_DATA_FUNC (newbuf) = NULL;
204 GST_BUFFER_PRIVATE (newbuf) = NULL;
210 * gst_buffer_new_and_alloc:
211 * @size: the size of the new buffer's data.
213 * Creates a newly allocated buffer with data of the given size.
215 * Returns: the new #GstBuffer.
218 gst_buffer_new_and_alloc (guint size)
222 newbuf = gst_buffer_new ();
224 GST_BUFFER_DATA (newbuf) = g_malloc (size);
225 GST_BUFFER_SIZE (newbuf) = size;
226 GST_BUFFER_MAXSIZE (newbuf) = size;
232 * gst_buffer_create_sub:
233 * @parent: a parent #GstBuffer to create a subbuffer from.
234 * @offset: the offset into parent #GstBuffer.
235 * @size: the size of the new #GstBuffer sub-buffer (with size > 0).
237 * Creates a sub-buffer from the parent at a given offset.
238 * This sub-buffer uses the actual memory space of the parent buffer.
239 * This function will copy the offset and timestamp field when the
240 * offset is 0, else they are set to _NONE.
241 * The duration field of the new buffer are set to GST_CLOCK_TIME_NONE.
243 * Returns: the new #GstBuffer, or NULL if there was an error.
246 gst_buffer_create_sub (GstBuffer *parent, guint offset, guint size)
249 gpointer buffer_data;
251 g_return_val_if_fail (parent != NULL, NULL);
252 g_return_val_if_fail (GST_BUFFER_REFCOUNT_VALUE (parent) > 0, NULL);
253 g_return_val_if_fail (size > 0, NULL);
254 g_return_val_if_fail (parent->size >= offset + size, NULL);
256 /* remember the data for the new buffer */
257 buffer_data = parent->data + offset;
258 /* make sure we're child not child from a child buffer */
259 while (GST_BUFFER_FLAG_IS_SET (parent, GST_BUFFER_SUBBUFFER)) {
260 parent = GST_BUFFER (parent->buffer_private);
262 /* ref the real parent */
263 gst_data_ref (GST_DATA (parent));
265 /* create the new buffer */
266 buffer = gst_mem_chunk_alloc (chunk);
267 #ifndef GST_DISABLE_TRACE
268 gst_alloc_trace_new (_gst_buffer_trace, buffer);
271 GST_CAT_LOG (GST_CAT_BUFFER, "new subbuffer %p", buffer);
273 /* make sure nobody overwrites data in the new buffer
274 * by setting the READONLY flag */
275 _GST_DATA_INIT (GST_DATA (buffer),
277 GST_DATA_FLAG_SHIFT (GST_BUFFER_SUBBUFFER) |
278 GST_DATA_FLAG_SHIFT (GST_DATA_READONLY),
279 (GstDataFreeFunction) _gst_buffer_sub_free,
280 (GstDataCopyFunction) gst_buffer_default_copy);
282 /* set the right values in the child */
283 GST_BUFFER_DATA (buffer) = buffer_data;
284 GST_BUFFER_SIZE (buffer) = size;
285 GST_BUFFER_MAXSIZE (buffer) = size;
286 GST_BUFFER_FREE_DATA_FUNC (buffer) = NULL;
287 GST_BUFFER_PRIVATE (buffer) = parent;
288 /* we can copy the timestamp and offset if the new buffer starts at
291 GST_BUFFER_TIMESTAMP (buffer) = GST_BUFFER_TIMESTAMP (parent);
292 GST_BUFFER_OFFSET (buffer) = GST_BUFFER_OFFSET (parent);
295 GST_BUFFER_TIMESTAMP (buffer) = GST_CLOCK_TIME_NONE;
296 GST_BUFFER_OFFSET (buffer) = GST_BUFFER_OFFSET_NONE;
299 GST_BUFFER_DURATION (buffer) = GST_CLOCK_TIME_NONE;
300 GST_BUFFER_OFFSET_END (buffer) = GST_BUFFER_OFFSET_NONE;
302 if (GST_BUFFER_FLAG_IS_SET (parent, GST_BUFFER_DONTKEEP)) {
303 GST_BUFFER_FLAG_SET (buffer, GST_BUFFER_DONTKEEP);
305 if (GST_BUFFER_FLAG_IS_SET (parent, GST_BUFFER_READONLY)) {
306 GST_BUFFER_FLAG_SET (buffer, GST_BUFFER_READONLY);
315 * @buf1: a first source #GstBuffer to merge.
316 * @buf2: the second source #GstBuffer to merge.
318 * Create a new buffer that is the concatenation of the two source
319 * buffers. The original source buffers will not be modified or
322 * Internally is nothing more than a specialized gst_buffer_span(),
323 * so the same optimizations can occur.
325 * Returns: the new #GstBuffer that's the concatenation of the source buffers.
328 gst_buffer_merge (GstBuffer *buf1, GstBuffer *buf2)
332 /* we're just a specific case of the more general gst_buffer_span() */
333 result = gst_buffer_span (buf1, 0, buf2, buf1->size + buf2->size);
339 * gst_buffer_is_span_fast:
340 * @buf1: a first source #GstBuffer.
341 * @buf2: the second source #GstBuffer.
343 * Determines whether a gst_buffer_span() is free (as in free beer),
344 * or requires a memcpy.
346 * Returns: TRUE if the buffers are contiguous,
347 * FALSE if a copy would be required.
350 gst_buffer_is_span_fast (GstBuffer *buf1, GstBuffer *buf2)
352 g_return_val_if_fail (buf1 != NULL && buf2 != NULL, FALSE);
353 g_return_val_if_fail (GST_BUFFER_REFCOUNT_VALUE (buf1) > 0, FALSE);
354 g_return_val_if_fail (GST_BUFFER_REFCOUNT_VALUE (buf2) > 0, FALSE);
356 /* it's only fast if we have subbuffers of the same parent */
357 return ((GST_BUFFER_FLAG_IS_SET (buf1, GST_BUFFER_SUBBUFFER)) &&
358 (GST_BUFFER_FLAG_IS_SET (buf2, GST_BUFFER_SUBBUFFER)) &&
359 (buf1->buffer_private == buf2->buffer_private) &&
360 ((buf1->data + buf1->size) == buf2->data));
365 * @buf1: a first source #GstBuffer to merge.
366 * @offset: the offset in the first buffer from where the new
367 * buffer should start.
368 * @buf2: the second source #GstBuffer to merge.
369 * @len: the total length of the new buffer.
371 * Creates a new buffer that consists of part of buf1 and buf2.
372 * Logically, buf1 and buf2 are concatenated into a single larger
373 * buffer, and a new buffer is created at the given offset inside
374 * this space, with a given length.
376 * If the two source buffers are children of the same larger buffer,
377 * and are contiguous, the new buffer will be a child of the shared
378 * parent, and thus no copying is necessary. you can use
379 * gst_buffer_is_span_fast() to determine if a memcpy will be needed.
381 * Returns: the new #GstBuffer that spans the two source buffers.
384 gst_buffer_span (GstBuffer *buf1, guint32 offset, GstBuffer *buf2, guint32 len)
388 g_return_val_if_fail (buf1 != NULL && buf2 != NULL, FALSE);
389 g_return_val_if_fail (GST_BUFFER_REFCOUNT_VALUE (buf1) > 0, NULL);
390 g_return_val_if_fail (GST_BUFFER_REFCOUNT_VALUE (buf2) > 0, NULL);
391 g_return_val_if_fail (len > 0, NULL);
392 g_return_val_if_fail (len <= buf1->size + buf2->size - offset, NULL);
394 /* if the two buffers have the same parent and are adjacent */
395 if (gst_buffer_is_span_fast (buf1, buf2)) {
396 GstBuffer *parent = GST_BUFFER (buf1->buffer_private);
397 /* we simply create a subbuffer of the common parent */
398 newbuf = gst_buffer_create_sub (parent,
399 buf1->data - parent->data + offset, len);
402 GST_CAT_DEBUG (GST_CAT_BUFFER, "slow path taken while spanning buffers %p and %p",
404 /* otherwise we simply have to brute-force copy the buffers */
405 newbuf = gst_buffer_new_and_alloc (len);
407 /* copy the first buffer's data across */
408 memcpy (newbuf->data, buf1->data + offset, buf1->size - offset);
409 /* copy the second buffer's data across */
410 memcpy (newbuf->data + (buf1->size - offset), buf2->data,
411 len - (buf1->size - offset));
412 /* if the offset is 0, the new buffer has the same timestamp as buf1 */
414 GST_BUFFER_OFFSET (newbuf) = GST_BUFFER_OFFSET (buf1);
415 GST_BUFFER_TIMESTAMP (newbuf) = GST_BUFFER_TIMESTAMP (buf1);
418 /* if we completely merged the two buffers (appended), we can
419 * calculate the duration too. Also make sure we's not messing with
420 * invalid DURATIONS */
421 if (offset == 0 && buf1->size + buf2->size == len) {
422 if (GST_BUFFER_DURATION_IS_VALID (buf1) &&
423 GST_BUFFER_DURATION_IS_VALID (buf2)) {
425 GST_BUFFER_DURATION (newbuf) = GST_BUFFER_DURATION (buf1) +
426 GST_BUFFER_DURATION (buf2);
428 if (GST_BUFFER_OFFSET_END_IS_VALID (buf2)) {
430 GST_BUFFER_OFFSET_END (newbuf) = GST_BUFFER_OFFSET_END (buf2);