gstbufferlist.c 7.32 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
/* GStreamer
 * Copyright (C) 2009 Axis Communications <dev-gstreamer at axis dot com>
 * @author Jonas Holmberg <jonas dot holmberg at axis dot com>
 *
 * 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
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */

/**
 * SECTION:gstbufferlist
Wim Taymans's avatar
Wim Taymans committed
25
 * @short_description: Lists of buffers for data-passing
26 27
 * @see_also: #GstPad, #GstMiniObject
 *
Wim Taymans's avatar
Wim Taymans committed
28
 * Buffer lists are an object containing a list of buffers.
29 30
 *
 * Buffer lists are created with gst_buffer_list_new() and filled with data
Wim Taymans's avatar
Wim Taymans committed
31
 * using a gst_buffer_list_insert().
32
 *
Wim Taymans's avatar
Wim Taymans committed
33 34 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.
 *
 * Last reviewed on 2012-03-28 (0.11.3)
38 39 40 41 42 43 44 45
 */
#include "gst_private.h"

#include "gstbuffer.h"
#include "gstbufferlist.h"

#define GST_CAT_DEFAULT GST_CAT_BUFFER_LIST

Wim Taymans's avatar
Wim Taymans committed
46 47 48 49
/**
 * GstBufferList:
 *
 * Opaque list of grouped buffers.
50 51
 *
 * Since: 0.10.24
Wim Taymans's avatar
Wim Taymans committed
52 53 54 55 56
 */
struct _GstBufferList
{
  GstMiniObject mini_object;

Wim Taymans's avatar
Wim Taymans committed
57
  GArray *array;
58 59
};

Wim Taymans's avatar
Wim Taymans committed
60
GType _gst_buffer_list_type = 0;
61

62
GST_DEFINE_MINI_OBJECT_TYPE (GstBufferList, gst_buffer_list);
Wim Taymans's avatar
Wim Taymans committed
63

64
void
65
_priv_gst_buffer_list_initialize (void)
66
{
Wim Taymans's avatar
Wim Taymans committed
67
  _gst_buffer_list_type = gst_buffer_list_get_type ();
68 69 70 71 72
}

static GstBufferList *
_gst_buffer_list_copy (GstBufferList * list)
{
Wim Taymans's avatar
Wim Taymans committed
73 74
  GstBufferList *copy;
  guint i, len;
75

Wim Taymans's avatar
Wim Taymans committed
76
  len = list->array->len;
Wim Taymans's avatar
Wim Taymans committed
77
  copy = gst_buffer_list_new_sized (len);
78

Wim Taymans's avatar
Wim Taymans committed
79 80 81 82 83 84 85
  /* add and ref all buffers in the array */
  for (i = 0; i < len; i++) {
    GstBuffer *buf = g_array_index (list->array, GstBuffer *, i);
    buf = gst_buffer_ref (buf);
    g_array_append_val (copy->array, buf);
  }
  return copy;
86 87 88
}

static void
89
_gst_buffer_list_free (GstBufferList * list)
90
{
Wim Taymans's avatar
Wim Taymans committed
91
  guint i, len;
92 93
  GST_LOG ("free %p", list);

Wim Taymans's avatar
Wim Taymans committed
94 95 96 97 98
  /* unrefs all buffers too */
  len = list->array->len;
  for (i = 0; i < len; i++)
    gst_buffer_unref (g_array_index (list->array, GstBuffer *, i));
  g_array_free (list->array, TRUE);
99

100
  g_slice_free1 (sizeof (GstBufferList), list);
Wim Taymans's avatar
Wim Taymans committed
101 102 103
}

static void
104
gst_buffer_list_init (GstBufferList * list, guint asize)
Wim Taymans's avatar
Wim Taymans committed
105
{
106 107 108
  gst_mini_object_init (GST_MINI_OBJECT_CAST (list), _gst_buffer_list_type,
      (GstMiniObjectCopyFunction) _gst_buffer_list_copy, NULL,
      (GstMiniObjectFreeFunction) _gst_buffer_list_free);
109

Wim Taymans's avatar
Wim Taymans committed
110
  list->array = g_array_sized_new (FALSE, FALSE, sizeof (GstBuffer *), asize);
111 112

  GST_LOG ("init %p", list);
113 114 115
}

/**
Wim Taymans's avatar
Wim Taymans committed
116
 * gst_buffer_list_new_sized:
Wim Taymans's avatar
Wim Taymans committed
117
 * @size: an initial reserved size
118 119
 *
 * Creates a new, empty #GstBufferList. The caller is responsible for unreffing
Wim Taymans's avatar
Wim Taymans committed
120 121
 * the returned #GstBufferList. The list will have @size space preallocated so
 * that memory reallocations can be avoided.
122
 *
123 124 125 126
 * Free-function: gst_buffer_list_unref
 *
 * Returns: (transfer full): the new #GstBufferList. gst_buffer_list_unref()
 *     after usage.
127 128
 *
 * Since: 0.10.24
129 130
 */
GstBufferList *
Wim Taymans's avatar
Wim Taymans committed
131
gst_buffer_list_new_sized (guint size)
132 133 134
{
  GstBufferList *list;

135 136
  list = g_slice_new0 (GstBufferList);

137 138
  GST_LOG ("new %p", list);

139
  gst_buffer_list_init (list, size);
Wim Taymans's avatar
Wim Taymans committed
140

141 142 143 144
  return list;
}

/**
Wim Taymans's avatar
Wim Taymans committed
145 146 147 148 149 150 151 152 153 154 155 156 157 158 159
 * 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.
 *
 * Since: 0.10.24
 */
GstBufferList *
gst_buffer_list_new (void)
{
Wim Taymans's avatar
Wim Taymans committed
160
  return gst_buffer_list_new_sized (8);
Wim Taymans's avatar
Wim Taymans committed
161 162 163
}

/**
Wim Taymans's avatar
Wim Taymans committed
164
 * gst_buffer_list_length:
165 166
 * @list: a #GstBufferList
 *
Wim Taymans's avatar
Wim Taymans committed
167
 * Returns the number of buffers in @list.
168
 *
Wim Taymans's avatar
Wim Taymans committed
169
 * Returns: the number of buffers in the buffer list
170 171
 *
 * Since: 0.10.24
172 173
 */
guint
Wim Taymans's avatar
Wim Taymans committed
174
gst_buffer_list_length (GstBufferList * list)
175
{
Wim Taymans's avatar
Wim Taymans committed
176
  g_return_val_if_fail (GST_IS_BUFFER_LIST (list), 0);
177

Wim Taymans's avatar
Wim Taymans committed
178
  return list->array->len;
179 180
}

Wim Taymans's avatar
Wim Taymans committed
181 182 183
/**
 * gst_buffer_list_foreach:
 * @list: a #GstBufferList
184
 * @func: (scope call): a #GstBufferListFunc to call
185
 * @user_data: (closure): user data passed to @func
Wim Taymans's avatar
Wim Taymans committed
186 187 188 189
 *
 * 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
190 191
 * of @func define if this function returns or if the remaining buffers in
 * the list should be skipped.
192 193
 *
 * Since: 0.10.24
Wim Taymans's avatar
Wim Taymans committed
194 195 196 197 198
 */
void
gst_buffer_list_foreach (GstBufferList * list, GstBufferListFunc func,
    gpointer user_data)
{
199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215
  guint i, len;

  g_return_if_fail (GST_IS_BUFFER_LIST (list));
  g_return_if_fail (func != NULL);

  len = list->array->len;
  for (i = 0; i < len;) {
    GstBuffer *buf, *buf_ret;
    gboolean ret;

    buf = buf_ret = g_array_index (list->array, GstBuffer *, i);
    ret = func (&buf_ret, i, user_data);

    /* Check if the function changed the buffer */
    if (buf != buf_ret) {
      if (buf_ret == NULL) {
        g_array_remove_index (list->array, i);
216
        len--;
217 218 219 220 221 222 223 224 225 226 227 228
      } else {
        g_array_index (list->array, GstBuffer *, i) = buf_ret;
      }
    }

    if (!ret)
      break;

    /* If the buffer was not removed by func go to the next buffer */
    if (buf_ret != NULL)
      i++;
  }
Wim Taymans's avatar
Wim Taymans committed
229 230 231 232 233
}

/**
 * gst_buffer_list_get:
 * @list: a #GstBufferList
Wim Taymans's avatar
Wim Taymans committed
234
 * @idx: the index
Wim Taymans's avatar
Wim Taymans committed
235
 *
Wim Taymans's avatar
Wim Taymans committed
236
 * Get the buffer at @idx.
Wim Taymans's avatar
Wim Taymans committed
237
 *
238 239
 * Returns: (transfer none): the buffer at @idx in @group or NULL when there
 *     is no buffer. The buffer remains valid as long as @list is valid.
240 241
 *
 * Since: 0.10.24
Wim Taymans's avatar
Wim Taymans committed
242 243
 */
GstBuffer *
Wim Taymans's avatar
Wim Taymans committed
244
gst_buffer_list_get (GstBufferList * list, guint idx)
Wim Taymans's avatar
Wim Taymans committed
245
{
Wim Taymans's avatar
Wim Taymans committed
246
  GstBuffer *buf;
247

Wim Taymans's avatar
Wim Taymans committed
248 249
  g_return_val_if_fail (GST_IS_BUFFER_LIST (list), NULL);
  g_return_val_if_fail (idx < list->array->len, NULL);
250

Wim Taymans's avatar
Wim Taymans committed
251
  buf = g_array_index (list->array, GstBuffer *, idx);
252

Wim Taymans's avatar
Wim Taymans committed
253
  return buf;
254 255
}

Wim Taymans's avatar
Wim Taymans committed
256 257 258 259 260 261 262
/**
 * gst_buffer_list_add:
 * @l: a #GstBufferList
 * @b: a #GstBuffer
 *
 * Append @b at the end of @l.
 */
263
/**
Wim Taymans's avatar
Wim Taymans committed
264 265 266 267
 * gst_buffer_list_insert:
 * @list: a #GstBufferList
 * @idx: the index
 * @buffer: a #GstBuffer
268
 *
Wim Taymans's avatar
Wim Taymans committed
269 270
 * Insert @buffer at @idx in @list. Other buffers are moved to make room for
 * this new buffer.
271
 *
Wim Taymans's avatar
Wim Taymans committed
272
 * A -1 value for @idx will append the buffer at the end.
273 274
 */
void
Wim Taymans's avatar
Wim Taymans committed
275
gst_buffer_list_insert (GstBufferList * list, guint idx, GstBuffer * buffer)
276
{
Wim Taymans's avatar
Wim Taymans committed
277
  g_return_if_fail (GST_IS_BUFFER_LIST (list));
278 279
  g_return_if_fail (buffer != NULL);

Wim Taymans's avatar
Wim Taymans committed
280 281 282 283 284
  if (idx == -1)
    g_array_append_val (list->array, buffer);
  else {
    g_return_if_fail (idx < list->array->len);
    g_array_insert_val (list->array, idx, buffer);
Wim Taymans's avatar
Wim Taymans committed
285
  }
286 287
}

Wim Taymans's avatar
Wim Taymans committed
288 289 290 291 292 293 294 295 296
/**
 * gst_buffer_list_remove:
 * @list: a #GstBufferList
 * @idx: the index
 * @length: the amount to remove
 *
 * Remove @length buffers starting from @idx in @list. The following buffers are
 * moved to close the gap.
 */
297
void
Wim Taymans's avatar
Wim Taymans committed
298
gst_buffer_list_remove (GstBufferList * list, guint idx, guint length)
299
{
Wim Taymans's avatar
Wim Taymans committed
300 301
  g_return_if_fail (GST_IS_BUFFER_LIST (list));
  g_return_if_fail (idx < list->array->len);
302

Wim Taymans's avatar
Wim Taymans committed
303
  g_array_remove_range (list->array, idx, length);
304
}