2 * Copyright (C) 2003 Benjamin Otte <in7y118@public.uni-hamburg.de>
4 * gstbufferstore.c: keep an easily accessible list of all buffers
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.
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.
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.
25 #include "gstbufferstore.h"
26 #include <gst/gstutils.h>
29 GST_DEBUG_CATEGORY_STATIC (gst_buffer_store_debug);
30 #define GST_CAT_DEFAULT gst_buffer_store_debug
42 static void gst_buffer_store_dispose (GObject * object);
44 static gboolean gst_buffer_store_add_buffer_func (GstBufferStore * store,
46 static void gst_buffer_store_cleared_func (GstBufferStore * store);
48 static guint gst_buffer_store_signals[LAST_SIGNAL] = { 0 };
50 #define _do_init(bla) \
51 GST_DEBUG_CATEGORY_INIT (gst_buffer_store_debug, "GstBufferStore", 0, "buffer store helper");
53 GST_BOILERPLATE_FULL (GstBufferStore, gst_buffer_store, GObject, G_TYPE_OBJECT, _do_init);
56 G_GNUC_UNUSED static void
57 debug_buffers (GstBufferStore *store)
59 GList *walk = store->buffers;
61 g_printerr ("BUFFERS in store:\n");
63 g_print ("%15"G_GUINT64_FORMAT" - %7u\n", GST_BUFFER_OFFSET (walk->data), GST_BUFFER_SIZE (walk->data));
64 walk = g_list_next (walk);
69 continue_accu (GSignalInvocationHint *ihint, GValue *return_accu,
70 const GValue *handler_return, gpointer data)
72 gboolean do_continue = g_value_get_boolean (handler_return);
73 g_value_set_boolean (return_accu, do_continue);
78 gst_buffer_store_base_init (gpointer g_class)
82 gst_buffer_store_class_init (GstBufferStoreClass *store_class)
84 GObjectClass *gobject_class = G_OBJECT_CLASS (store_class);
86 gobject_class->dispose = gst_buffer_store_dispose;
88 gst_buffer_store_signals[CLEARED] = g_signal_new ("cleared",
89 G_TYPE_FROM_CLASS (store_class), G_SIGNAL_RUN_LAST,
90 G_STRUCT_OFFSET (GstBufferStoreClass, cleared), NULL, NULL,
91 gst_marshal_VOID__VOID, G_TYPE_NONE, 0);
92 gst_buffer_store_signals[BUFFER_ADDED] = g_signal_new ("buffer-added",
93 G_TYPE_FROM_CLASS (store_class), G_SIGNAL_RUN_LAST,
94 G_STRUCT_OFFSET (GstBufferStoreClass, buffer_added), continue_accu, NULL,
95 gst_marshal_BOOLEAN__POINTER, G_TYPE_BOOLEAN, 1, GST_TYPE_BUFFER);
97 store_class->cleared = gst_buffer_store_cleared_func;
98 store_class->buffer_added = gst_buffer_store_add_buffer_func;
101 gst_buffer_store_init (GstBufferStore *store)
103 store->buffers = NULL;
106 gst_buffer_store_dispose (GObject *object)
108 GstBufferStore *store = GST_BUFFER_STORE (object);
110 gst_buffer_store_clear (store);
112 parent_class->dispose (object);
115 gst_buffer_store_add_buffer_func (GstBufferStore *store, GstBuffer *buffer)
117 g_assert (buffer != NULL);
119 if (!GST_BUFFER_OFFSET_IS_VALID (buffer) &&
121 GST_BUFFER_OFFSET_IS_VALID (store->buffers->data)) {
122 /* we assumed valid offsets, but suddenly they are not anymore */
123 GST_DEBUG_OBJECT (store, "attempting to add buffer %p with invalid offset to store with valid offset, abort",
126 } else if (!store->buffers || !GST_BUFFER_OFFSET_IS_VALID (store->buffers->data)) {
127 /* the starting buffer had an invalid offset, in that case we assume continuous buffers */
128 GST_LOG_OBJECT (store, "adding buffer %p with invalid offset and size %u",
129 buffer, GST_BUFFER_SIZE (buffer));
130 gst_data_ref (GST_DATA (buffer));
131 store->buffers = g_list_append (store->buffers, buffer);
134 /* both list and buffer have valid offsets, we can really go wild */
135 GList *walk, *current_list = NULL;
138 g_assert (GST_BUFFER_OFFSET_IS_VALID (buffer));
139 GST_LOG_OBJECT (store, "attempting to add buffer %p with offset %"G_GUINT64_FORMAT" and size %u",
140 buffer, GST_BUFFER_OFFSET (buffer), GST_BUFFER_SIZE (buffer));
141 /* we keep a sorted list of non-overlapping buffers */
142 walk = store->buffers;
144 current = GST_BUFFER (walk->data);
146 walk = g_list_next (walk);
147 if (GST_BUFFER_OFFSET (current) < GST_BUFFER_OFFSET (buffer)) {
149 } else if (GST_BUFFER_OFFSET (current) == GST_BUFFER_OFFSET (buffer)) {
152 needed_size = MIN (GST_BUFFER_SIZE (buffer),
153 GST_BUFFER_OFFSET (walk->data) - GST_BUFFER_OFFSET (current));
155 needed_size = GST_BUFFER_SIZE (buffer);
157 if (needed_size <= GST_BUFFER_SIZE (current)) {
161 if (needed_size < GST_BUFFER_SIZE (buffer)) {
162 /* need to create subbuffer to not have overlapping data */
163 GstBuffer *sub = gst_buffer_create_sub (buffer, 0, needed_size);
167 gst_data_ref (GST_DATA (buffer));
169 /* replace current buffer with new one */
170 GST_INFO_OBJECT (store, "replacing buffer %p with buffer %p with offset %"G_GINT64_FORMAT" and size %u",
171 current_list->data, buffer, GST_BUFFER_OFFSET (buffer), GST_BUFFER_SIZE (buffer));
172 gst_data_unref (GST_DATA (current_list->data));
173 current_list->data = buffer;
177 } else if (GST_BUFFER_OFFSET (current) > GST_BUFFER_OFFSET (buffer)) {
178 GList *previous = g_list_previous (current_list);
179 guint64 start_offset = previous ?
180 GST_BUFFER_OFFSET (previous->data) + GST_BUFFER_SIZE (previous->data) : 0;
182 if (start_offset == GST_BUFFER_OFFSET (current)) {
186 /* we have data to insert */
187 if (start_offset > GST_BUFFER_OFFSET (buffer) ||
188 GST_BUFFER_OFFSET (buffer) + GST_BUFFER_SIZE (buffer) > GST_BUFFER_OFFSET (current)) {
191 /* need a subbuffer */
192 start_offset = GST_BUFFER_OFFSET (buffer) > start_offset ? 0 :
193 start_offset - GST_BUFFER_OFFSET (buffer);
194 sub = gst_buffer_create_sub (buffer, start_offset,
195 MIN (GST_BUFFER_SIZE (buffer), GST_BUFFER_OFFSET (current) - start_offset - GST_BUFFER_OFFSET (buffer)));
197 GST_BUFFER_OFFSET (sub) = start_offset + GST_BUFFER_OFFSET (buffer);
200 gst_data_ref (GST_DATA (buffer));
202 GST_INFO_OBJECT (store, "adding buffer %p with offset %"G_GINT64_FORMAT" and size %u",
203 buffer, GST_BUFFER_OFFSET (buffer), GST_BUFFER_SIZE (buffer));
204 store->buffers = g_list_insert_before (store->buffers, current_list, buffer);
211 gst_data_ref (GST_DATA (buffer));
212 GST_INFO_OBJECT (store, "adding buffer %p with offset %"G_GINT64_FORMAT" and size %u",
213 buffer, GST_BUFFER_OFFSET (buffer), GST_BUFFER_SIZE (buffer));
215 g_list_append (current_list, buffer);
217 g_assert (store->buffers == NULL);
218 store->buffers = g_list_prepend (NULL, buffer);
225 gst_buffer_store_cleared_func (GstBufferStore *store)
227 g_list_foreach (store->buffers, (GFunc) gst_data_unref, NULL);
228 g_list_free (store->buffers);
229 store->buffers = NULL;
232 * gst_buffer_store_new:
234 * Creates a new bufferstore.
236 * Returns: the new bufferstore.
239 gst_buffer_store_new (void)
241 return GST_BUFFER_STORE (g_object_new (GST_TYPE_BUFFER_STORE, NULL));
244 * gst_buffer_store_clear:
245 * @store: a bufferstore
247 * Clears the buffer store. All buffers are removed and the buffer store
248 * behaves like it was just created.
250 /* FIXME: call this function _reset ? */
252 gst_buffer_store_clear (GstBufferStore *store)
254 g_return_if_fail (GST_IS_BUFFER_STORE (store));
256 g_signal_emit (store, gst_buffer_store_signals [CLEARED], 0, NULL);
259 * gst_buffer_store_add_buffer:
260 * @store: a bufferstore
261 * @buffer: the buffer to add
263 * Adds a buffer to the buffer store.
265 * Returns: TRUE, if the buffer was added, FALSE if an error occured.
268 gst_buffer_store_add_buffer (GstBufferStore *store, GstBuffer *buffer)
272 g_return_val_if_fail (GST_IS_BUFFER_STORE (store), FALSE);
273 g_return_val_if_fail (GST_IS_BUFFER (buffer), FALSE);
275 if (store->buffers &&
276 GST_BUFFER_OFFSET_IS_VALID (store->buffers->data) &&
277 !GST_BUFFER_OFFSET_IS_VALID (buffer))
280 g_signal_emit (store, gst_buffer_store_signals [BUFFER_ADDED], 0, buffer, &ret);
285 * gst_buffer_store_get_buffer:
286 * @store: a bufferstore
287 * @offset: starting offset of returned buffer
288 * @size: size of returned buffer
290 * Returns a buffer that corresponds to the given area of data. If part of the
291 * data is not available inside the store, NULL is returned. You have to unref
292 * the buffer after use.
294 * Returns: a buffer with the requested data or NULL if the data was not
298 gst_buffer_store_get_buffer (GstBufferStore *store, guint64 offset, guint size)
304 gboolean have_offset;
305 guint64 cur_offset = 0;
306 GstBuffer *ret = NULL;
308 g_return_val_if_fail (GST_IS_BUFFER_STORE (store), NULL);
310 walk = store->buffers;
313 if (GST_BUFFER_OFFSET_IS_VALID (walk->data)) {
319 current = GST_BUFFER (walk->data);
321 cur_offset = GST_BUFFER_OFFSET (current);
323 walk = g_list_next (walk);
324 if (cur_offset > offset) {
325 /* #include <windows.h>
326 do_nothing_loop (); */
327 } else if (cur_offset == offset &&
328 GST_BUFFER_SIZE (current) == size) {
329 GST_LOG_OBJECT (store, "found matching buffer %p for offset %"G_GUINT64_FORMAT" and size %u",
330 current, offset, size);
332 gst_data_ref (GST_DATA (ret));
333 GST_LOG_OBJECT (store, "refcount %d",
334 GST_DATA_REFCOUNT_VALUE(ret));
336 } else if (cur_offset + GST_BUFFER_SIZE (current) > offset) {
337 if (cur_offset + GST_BUFFER_SIZE (current) >= offset + size) {
338 ret = gst_buffer_create_sub (current, offset - cur_offset, size);
339 GST_LOG_OBJECT (store, "created subbuffer %p from buffer %p for offset %llu and size %u",
340 ret, current, offset, size);
343 /* uh, the requested data spans some buffers */
344 ret = gst_buffer_new_and_alloc (size);
345 GST_LOG_OBJECT (store, "created buffer %p for offset %"G_GUINT64_FORMAT
346 " and size %u, will fill with data now",
348 data = GST_BUFFER_DATA (ret);
349 tmp = GST_BUFFER_SIZE (current) - offset + cur_offset;
350 memcpy (data, GST_BUFFER_DATA (current) + offset - cur_offset, tmp);
356 GST_BUFFER_OFFSET (current) + GST_BUFFER_SIZE (current) != GST_BUFFER_OFFSET (walk->data))) {
357 GST_DEBUG_OBJECT (store, "not all data for offset %"G_GUINT64_FORMAT" and remaining size %u available, aborting",
359 gst_data_unref (GST_DATA (ret));
363 current = GST_BUFFER (walk->data);
364 walk = g_list_next (walk);
365 tmp = MIN (GST_BUFFER_SIZE (current), size);
366 memcpy (data, GST_BUFFER_DATA (current), tmp);
371 cur_offset += GST_BUFFER_SIZE (current);
379 * gst_buffer_store_get_size:
380 * @store: a bufferstore
381 * @offset: desired offset
383 * Calculates the number of bytes available starting from offset. This allows
384 * to query a buffer with the returned size.
386 * Returns: the number of continuous bytes in the bufferstore starting at
390 gst_buffer_store_get_size (GstBufferStore *store, guint64 offset)
393 gboolean have_offset;
394 gboolean counting = FALSE;
395 guint64 cur_offset = 0;
396 GstBuffer *current = NULL;
399 g_return_val_if_fail (GST_IS_BUFFER_STORE (store), 0);
401 walk = store->buffers;
404 if (GST_BUFFER_OFFSET_IS_VALID (walk->data)) {
410 if (have_offset && counting &&
411 cur_offset + GST_BUFFER_SIZE (current) != GST_BUFFER_OFFSET (walk->data)) {
414 current = GST_BUFFER (walk->data);
416 cur_offset = GST_BUFFER_OFFSET (current);
418 walk = g_list_next (walk);
420 ret += GST_BUFFER_SIZE (current);
422 if (cur_offset > offset)
424 if (cur_offset + GST_BUFFER_SIZE (current) > offset) {
425 /* we have at least some bytes */
426 ret = cur_offset + GST_BUFFER_SIZE (current) - offset;
431 cur_offset += GST_BUFFER_SIZE (current);