gstbufferlist.c 10.2 KB
Newer Older
1 2 3
/* GStreamer
 * Copyright (C) 2009 Axis Communications <dev-gstreamer at axis dot com>
 * @author Jonas Holmberg <jonas dot holmberg at axis dot com>
4
 * Copyright (C) 2014 Tim-Philipp Müller <tim at centricular dot com>
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
 *
 * gstbufferlist.c: Buffer list
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
Tim-Philipp Müller's avatar
Tim-Philipp Müller committed
20 21
 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
 * Boston, MA 02110-1301, USA.
22 23 24 25
 */

/**
 * SECTION:gstbufferlist
26
 * @title: GstBufferList
Wim Taymans's avatar
Wim Taymans committed
27
 * @short_description: Lists of buffers for data-passing
28 29
 * @see_also: #GstPad, #GstMiniObject
 *
Wim Taymans's avatar
Wim Taymans committed
30
 * Buffer lists are an object containing a list of buffers.
31 32
 *
 * Buffer lists are created with gst_buffer_list_new() and filled with data
Wim Taymans's avatar
Wim Taymans committed
33
 * using a gst_buffer_list_insert().
34
 *
Wim Taymans's avatar
Wim Taymans committed
35 36 37
 * Buffer lists can be pushed on a srcpad with gst_pad_push_list(). This is
 * interesting when multiple buffers need to be pushed in one go because it
 * can reduce the amount of overhead for pushing each buffer individually.
38 39 40 41 42
 */
#include "gst_private.h"

#include "gstbuffer.h"
#include "gstbufferlist.h"
43
#include "gstutils.h"
44 45 46

#define GST_CAT_DEFAULT GST_CAT_BUFFER_LIST

47 48 49
#define GST_BUFFER_LIST_IS_USING_DYNAMIC_ARRAY(list) \
    ((list)->buffers != &(list)->arr[0])

Wim Taymans's avatar
Wim Taymans committed
50 51 52 53 54 55 56 57 58
/**
 * GstBufferList:
 *
 * Opaque list of grouped buffers.
 */
struct _GstBufferList
{
  GstMiniObject mini_object;

59 60 61 62 63 64 65 66 67 68
  GstBuffer **buffers;
  guint n_buffers;
  guint n_allocated;

  gsize slice_size;

  /* one-item array, in reality more items are pre-allocated
   * as part of the GstBufferList structure, and that
   * pre-allocated array extends beyond the declared struct */
  GstBuffer *arr[1];
69 70
};

Wim Taymans's avatar
Wim Taymans committed
71
GType _gst_buffer_list_type = 0;
72

73
GST_DEFINE_MINI_OBJECT_TYPE (GstBufferList, gst_buffer_list);
Wim Taymans's avatar
Wim Taymans committed
74

75
void
76
_priv_gst_buffer_list_initialize (void)
77
{
Wim Taymans's avatar
Wim Taymans committed
78
  _gst_buffer_list_type = gst_buffer_list_get_type ();
79 80 81 82 83
}

static GstBufferList *
_gst_buffer_list_copy (GstBufferList * list)
{
Wim Taymans's avatar
Wim Taymans committed
84 85
  GstBufferList *copy;
  guint i, len;
86

87 88
  len = list->n_buffers;
  copy = gst_buffer_list_new_sized (list->n_allocated);
89

Wim Taymans's avatar
Wim Taymans committed
90
  /* add and ref all buffers in the array */
91 92 93 94 95
  for (i = 0; i < len; i++)
    copy->buffers[i] = gst_buffer_ref (list->buffers[i]);

  copy->n_buffers = len;

Wim Taymans's avatar
Wim Taymans committed
96
  return copy;
97 98 99
}

static void
100
_gst_buffer_list_free (GstBufferList * list)
101
{
Wim Taymans's avatar
Wim Taymans committed
102
  guint i, len;
103

104 105
  GST_LOG ("free %p", list);

Wim Taymans's avatar
Wim Taymans committed
106
  /* unrefs all buffers too */
107
  len = list->n_buffers;
Wim Taymans's avatar
Wim Taymans committed
108
  for (i = 0; i < len; i++)
109 110 111 112
    gst_buffer_unref (list->buffers[i]);

  if (GST_BUFFER_LIST_IS_USING_DYNAMIC_ARRAY (list))
    g_free (list->buffers);
113

114
  g_slice_free1 (list->slice_size, list);
Wim Taymans's avatar
Wim Taymans committed
115 116 117
}

static void
118
gst_buffer_list_init (GstBufferList * list, guint n_allocated, gsize slice_size)
Wim Taymans's avatar
Wim Taymans committed
119
{
120
  gst_mini_object_init (GST_MINI_OBJECT_CAST (list), 0, _gst_buffer_list_type,
121 122
      (GstMiniObjectCopyFunction) _gst_buffer_list_copy, NULL,
      (GstMiniObjectFreeFunction) _gst_buffer_list_free);
123

124 125 126 127
  list->buffers = &list->arr[0];
  list->n_buffers = 0;
  list->n_allocated = n_allocated;
  list->slice_size = slice_size;
128 129

  GST_LOG ("init %p", list);
130 131 132
}

/**
Wim Taymans's avatar
Wim Taymans committed
133
 * gst_buffer_list_new_sized:
Wim Taymans's avatar
Wim Taymans committed
134
 * @size: an initial reserved size
135 136
 *
 * Creates a new, empty #GstBufferList. The caller is responsible for unreffing
Wim Taymans's avatar
Wim Taymans committed
137 138
 * the returned #GstBufferList. The list will have @size space preallocated so
 * that memory reallocations can be avoided.
139
 *
140 141 142 143
 * Free-function: gst_buffer_list_unref
 *
 * Returns: (transfer full): the new #GstBufferList. gst_buffer_list_unref()
 *     after usage.
144 145
 */
GstBufferList *
Wim Taymans's avatar
Wim Taymans committed
146
gst_buffer_list_new_sized (guint size)
147 148
{
  GstBufferList *list;
149 150
  gsize slice_size;
  guint n_allocated;
151

152 153 154 155 156
  n_allocated = GST_ROUND_UP_16 (size);

  slice_size = sizeof (GstBufferList) + (n_allocated - 1) * sizeof (gpointer);

  list = g_slice_alloc0 (slice_size);
157

158 159
  GST_LOG ("new %p", list);

160
  gst_buffer_list_init (list, n_allocated, slice_size);
Wim Taymans's avatar
Wim Taymans committed
161

162 163 164 165
  return list;
}

/**
Wim Taymans's avatar
Wim Taymans committed
166 167 168 169 170 171 172 173 174 175 176 177 178
 * gst_buffer_list_new:
 *
 * Creates a new, empty #GstBufferList. The caller is responsible for unreffing
 * the returned #GstBufferList.
 *
 * Free-function: gst_buffer_list_unref
 *
 * Returns: (transfer full): the new #GstBufferList. gst_buffer_list_unref()
 *     after usage.
 */
GstBufferList *
gst_buffer_list_new (void)
{
Wim Taymans's avatar
Wim Taymans committed
179
  return gst_buffer_list_new_sized (8);
Wim Taymans's avatar
Wim Taymans committed
180 181 182
}

/**
Wim Taymans's avatar
Wim Taymans committed
183
 * gst_buffer_list_length:
184 185
 * @list: a #GstBufferList
 *
Wim Taymans's avatar
Wim Taymans committed
186
 * Returns the number of buffers in @list.
187
 *
Wim Taymans's avatar
Wim Taymans committed
188
 * Returns: the number of buffers in the buffer list
189 190
 */
guint
Wim Taymans's avatar
Wim Taymans committed
191
gst_buffer_list_length (GstBufferList * list)
192
{
Wim Taymans's avatar
Wim Taymans committed
193
  g_return_val_if_fail (GST_IS_BUFFER_LIST (list), 0);
194

195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214
  return list->n_buffers;
}

static inline void
gst_buffer_list_remove_range_internal (GstBufferList * list, guint idx,
    guint length, gboolean unref_old)
{
  guint i;

  if (unref_old) {
    for (i = idx; i < idx + length; ++i)
      gst_buffer_unref (list->buffers[i]);
  }

  if (idx + length != list->n_buffers) {
    memmove (&list->buffers[idx], &list->buffers[idx + length],
        (list->n_buffers - (idx + length)) * sizeof (void *));
  }

  list->n_buffers -= length;
215 216
}

Wim Taymans's avatar
Wim Taymans committed
217 218 219
/**
 * gst_buffer_list_foreach:
 * @list: a #GstBufferList
220
 * @func: (scope call): a #GstBufferListFunc to call
221
 * @user_data: (closure): user data passed to @func
Wim Taymans's avatar
Wim Taymans committed
222 223 224 225
 *
 * Call @func with @data for each buffer in @list.
 *
 * @func can modify the passed buffer pointer or its contents. The return value
Wim Taymans's avatar
Wim Taymans committed
226 227
 * of @func define if this function returns or if the remaining buffers in
 * the list should be skipped.
228 229 230
 *
 * Returns: %TRUE when @func returned %TRUE for each buffer in @list or when
 * @list is empty.
Wim Taymans's avatar
Wim Taymans committed
231
 */
232
gboolean
Wim Taymans's avatar
Wim Taymans committed
233 234 235
gst_buffer_list_foreach (GstBufferList * list, GstBufferListFunc func,
    gpointer user_data)
{
236
  guint i, len;
237
  gboolean ret = TRUE;
238

239 240
  g_return_val_if_fail (GST_IS_BUFFER_LIST (list), FALSE);
  g_return_val_if_fail (func != NULL, FALSE);
241

242
  len = list->n_buffers;
243 244 245
  for (i = 0; i < len;) {
    GstBuffer *buf, *buf_ret;

246
    buf = buf_ret = list->buffers[i];
247 248 249 250 251
    ret = func (&buf_ret, i, user_data);

    /* Check if the function changed the buffer */
    if (buf != buf_ret) {
      if (buf_ret == NULL) {
252 253
        gst_buffer_list_remove_range_internal (list, i, 1, FALSE);
        --len;
254
      } else {
255
        list->buffers[i] = buf_ret;
256 257 258 259 260 261 262 263 264 265
      }
    }

    if (!ret)
      break;

    /* If the buffer was not removed by func go to the next buffer */
    if (buf_ret != NULL)
      i++;
  }
266
  return ret;
Wim Taymans's avatar
Wim Taymans committed
267 268 269 270 271
}

/**
 * gst_buffer_list_get:
 * @list: a #GstBufferList
Wim Taymans's avatar
Wim Taymans committed
272
 * @idx: the index
Wim Taymans's avatar
Wim Taymans committed
273
 *
Wim Taymans's avatar
Wim Taymans committed
274
 * Get the buffer at @idx.
Wim Taymans's avatar
Wim Taymans committed
275
 *
276 277
 * Returns: (transfer none) (nullable): the buffer at @idx in @group
 *     or %NULL when there is no buffer. The buffer remains valid as
278
 *     long as @list is valid and buffer is not removed from the list.
Wim Taymans's avatar
Wim Taymans committed
279 280
 */
GstBuffer *
Wim Taymans's avatar
Wim Taymans committed
281
gst_buffer_list_get (GstBufferList * list, guint idx)
Wim Taymans's avatar
Wim Taymans committed
282
{
Wim Taymans's avatar
Wim Taymans committed
283
  g_return_val_if_fail (GST_IS_BUFFER_LIST (list), NULL);
284
  g_return_val_if_fail (idx < list->n_buffers, NULL);
285

286
  return list->buffers[idx];
287 288
}

Wim Taymans's avatar
Wim Taymans committed
289 290 291 292 293 294 295
/**
 * gst_buffer_list_add:
 * @l: a #GstBufferList
 * @b: a #GstBuffer
 *
 * Append @b at the end of @l.
 */
296
/**
Wim Taymans's avatar
Wim Taymans committed
297 298 299
 * gst_buffer_list_insert:
 * @list: a #GstBufferList
 * @idx: the index
300
 * @buffer: (transfer full): a #GstBuffer
301
 *
Wim Taymans's avatar
Wim Taymans committed
302 303
 * Insert @buffer at @idx in @list. Other buffers are moved to make room for
 * this new buffer.
304
 *
Wim Taymans's avatar
Wim Taymans committed
305
 * A -1 value for @idx will append the buffer at the end.
306 307
 */
void
308
gst_buffer_list_insert (GstBufferList * list, gint idx, GstBuffer * buffer)
309
{
310 311
  guint want_alloc;

Wim Taymans's avatar
Wim Taymans committed
312
  g_return_if_fail (GST_IS_BUFFER_LIST (list));
313
  g_return_if_fail (buffer != NULL);
314
  g_return_if_fail (gst_buffer_list_is_writable (list));
315

316 317 318
  if (idx == -1 && list->n_buffers < list->n_allocated) {
    list->buffers[list->n_buffers++] = buffer;
    return;
Wim Taymans's avatar
Wim Taymans committed
319
  }
320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346

  if (idx == -1 || idx > list->n_buffers)
    idx = list->n_buffers;

  want_alloc = list->n_buffers + 1;

  if (want_alloc > list->n_allocated) {
    want_alloc = MAX (GST_ROUND_UP_16 (want_alloc), list->n_allocated * 2);

    if (GST_BUFFER_LIST_IS_USING_DYNAMIC_ARRAY (list)) {
      list->buffers = g_renew (GstBuffer *, list->buffers, want_alloc);
    } else {
      list->buffers = g_new0 (GstBuffer *, want_alloc);
      memcpy (list->buffers, &list->arr[0], list->n_buffers * sizeof (void *));
      GST_CAT_LOG (GST_CAT_PERFORMANCE, "exceeding pre-alloced array");
    }

    list->n_allocated = want_alloc;
  }

  if (idx < list->n_buffers) {
    memmove (&list->buffers[idx + 1], &list->buffers[idx],
        (list->n_buffers - idx) * sizeof (void *));
  }

  ++list->n_buffers;
  list->buffers[idx] = buffer;
347 348
}

Wim Taymans's avatar
Wim Taymans committed
349 350 351 352 353 354
/**
 * gst_buffer_list_remove:
 * @list: a #GstBufferList
 * @idx: the index
 * @length: the amount to remove
 *
355 356
 * Remove @length buffers starting from @idx in @list. The following buffers
 * are moved to close the gap.
Wim Taymans's avatar
Wim Taymans committed
357
 */
358
void
Wim Taymans's avatar
Wim Taymans committed
359
gst_buffer_list_remove (GstBufferList * list, guint idx, guint length)
360
{
Wim Taymans's avatar
Wim Taymans committed
361
  g_return_if_fail (GST_IS_BUFFER_LIST (list));
362 363
  g_return_if_fail (idx < list->n_buffers);
  g_return_if_fail (idx + length <= list->n_buffers);
364
  g_return_if_fail (gst_buffer_list_is_writable (list));
365

366
  gst_buffer_list_remove_range_internal (list, idx, length, TRUE);
367
}
368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392

/**
 * gst_buffer_list_copy_deep:
 * @list: a #GstBufferList
 *
 * Create a copy of the given buffer list. This will make a newly allocated
 * copy of the buffer that the source buffer list contains.
 *
 * Returns: (transfer full): a new copy of @list.
 *
 * Since: 1.6
 */
GstBufferList *
gst_buffer_list_copy_deep (const GstBufferList * list)
{
  guint i, len;
  GstBufferList *result = NULL;

  g_return_val_if_fail (GST_IS_BUFFER_LIST (list), NULL);

  result = gst_buffer_list_new ();

  len = list->n_buffers;
  for (i = 0; i < len; i++) {
    GstBuffer *old = list->buffers[i];
393 394 395 396 397 398 399 400 401 402
    GstBuffer *new = gst_buffer_copy_deep (old);

    if (G_LIKELY (new)) {
      gst_buffer_list_insert (result, i, new);
    } else {
      g_warning
          ("Failed to deep copy buffer %p while deep "
          "copying buffer list %p. Buffer list copy "
          "will be incomplete", old, list);
    }
403 404 405 406
  }

  return result;
}