gstbufferlist.c 7.35 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 50 51 52 53 54
/**
 * GstBufferList:
 *
 * Opaque list of grouped buffers.
 */
struct _GstBufferList
{
  GstMiniObject mini_object;

Wim Taymans's avatar
Wim Taymans committed
55
  GArray *array;
56 57
};

Wim Taymans's avatar
Wim Taymans committed
58
GType _gst_buffer_list_type = 0;
59

60
GST_DEFINE_MINI_OBJECT_TYPE (GstBufferList, gst_buffer_list);
Wim Taymans's avatar
Wim Taymans committed
61

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

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

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

Wim Taymans's avatar
Wim Taymans committed
77 78 79 80 81 82 83
  /* 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;
84 85 86
}

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

Wim Taymans's avatar
Wim Taymans committed
92 93 94 95 96
  /* 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);
97

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

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

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

  GST_LOG ("init %p", list);
111 112 113
}

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

131 132
  list = g_slice_new0 (GstBufferList);

133 134
  GST_LOG ("new %p", list);

135
  gst_buffer_list_init (list, size);
Wim Taymans's avatar
Wim Taymans committed
136

137 138 139 140
  return list;
}

/**
Wim Taymans's avatar
Wim Taymans committed
141 142 143 144 145 146 147 148 149 150 151 152 153
 * 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
154
  return gst_buffer_list_new_sized (8);
Wim Taymans's avatar
Wim Taymans committed
155 156 157
}

/**
Wim Taymans's avatar
Wim Taymans committed
158
 * gst_buffer_list_length:
159 160
 * @list: a #GstBufferList
 *
Wim Taymans's avatar
Wim Taymans committed
161
 * Returns the number of buffers in @list.
162
 *
Wim Taymans's avatar
Wim Taymans committed
163
 * Returns: the number of buffers in the buffer list
164 165
 */
guint
Wim Taymans's avatar
Wim Taymans committed
166
gst_buffer_list_length (GstBufferList * list)
167
{
Wim Taymans's avatar
Wim Taymans committed
168
  g_return_val_if_fail (GST_IS_BUFFER_LIST (list), 0);
169

Wim Taymans's avatar
Wim Taymans committed
170
  return list->array->len;
171 172
}

Wim Taymans's avatar
Wim Taymans committed
173 174 175
/**
 * gst_buffer_list_foreach:
 * @list: a #GstBufferList
176
 * @func: (scope call): a #GstBufferListFunc to call
177
 * @user_data: (closure): user data passed to @func
Wim Taymans's avatar
Wim Taymans committed
178 179 180 181
 *
 * 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
182 183
 * of @func define if this function returns or if the remaining buffers in
 * the list should be skipped.
184 185 186
 *
 * Returns: %TRUE when @func returned %TRUE for each buffer in @list or when
 * @list is empty.
Wim Taymans's avatar
Wim Taymans committed
187
 */
188
gboolean
Wim Taymans's avatar
Wim Taymans committed
189 190 191
gst_buffer_list_foreach (GstBufferList * list, GstBufferListFunc func,
    gpointer user_data)
{
192
  guint i, len;
193
  gboolean ret = TRUE;
194

195 196
  g_return_val_if_fail (GST_IS_BUFFER_LIST (list), FALSE);
  g_return_val_if_fail (func != NULL, FALSE);
197 198 199 200 201 202 203 204 205 206 207 208

  len = list->array->len;
  for (i = 0; i < len;) {
    GstBuffer *buf, *buf_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);
209
        len--;
210 211 212 213 214 215 216 217 218 219 220 221
      } 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++;
  }
222
  return ret;
Wim Taymans's avatar
Wim Taymans committed
223 224 225 226 227
}

/**
 * gst_buffer_list_get:
 * @list: a #GstBufferList
Wim Taymans's avatar
Wim Taymans committed
228
 * @idx: the index
Wim Taymans's avatar
Wim Taymans committed
229
 *
Wim Taymans's avatar
Wim Taymans committed
230
 * Get the buffer at @idx.
Wim Taymans's avatar
Wim Taymans committed
231
 *
232 233
 * 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.
Wim Taymans's avatar
Wim Taymans committed
234 235
 */
GstBuffer *
Wim Taymans's avatar
Wim Taymans committed
236
gst_buffer_list_get (GstBufferList * list, guint idx)
Wim Taymans's avatar
Wim Taymans committed
237
{
Wim Taymans's avatar
Wim Taymans committed
238
  GstBuffer *buf;
239

Wim Taymans's avatar
Wim Taymans committed
240 241
  g_return_val_if_fail (GST_IS_BUFFER_LIST (list), NULL);
  g_return_val_if_fail (idx < list->array->len, NULL);
242

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

Wim Taymans's avatar
Wim Taymans committed
245
  return buf;
246 247
}

Wim Taymans's avatar
Wim Taymans committed
248 249 250 251 252 253 254
/**
 * gst_buffer_list_add:
 * @l: a #GstBufferList
 * @b: a #GstBuffer
 *
 * Append @b at the end of @l.
 */
255
/**
Wim Taymans's avatar
Wim Taymans committed
256 257 258
 * gst_buffer_list_insert:
 * @list: a #GstBufferList
 * @idx: the index
259
 * @buffer: (transfer full): a #GstBuffer
260
 *
Wim Taymans's avatar
Wim Taymans committed
261 262
 * Insert @buffer at @idx in @list. Other buffers are moved to make room for
 * this new buffer.
263
 *
Wim Taymans's avatar
Wim Taymans committed
264
 * A -1 value for @idx will append the buffer at the end.
265 266
 */
void
267
gst_buffer_list_insert (GstBufferList * list, gint idx, GstBuffer * buffer)
268
{
Wim Taymans's avatar
Wim Taymans committed
269
  g_return_if_fail (GST_IS_BUFFER_LIST (list));
270 271
  g_return_if_fail (buffer != NULL);

Wim Taymans's avatar
Wim Taymans committed
272 273 274 275 276
  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
277
  }
278 279
}

Wim Taymans's avatar
Wim Taymans committed
280 281 282 283 284 285 286 287 288
/**
 * 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.
 */
289
void
Wim Taymans's avatar
Wim Taymans committed
290
gst_buffer_list_remove (GstBufferList * list, guint idx, guint length)
291
{
Wim Taymans's avatar
Wim Taymans committed
292 293
  g_return_if_fail (GST_IS_BUFFER_LIST (list));
  g_return_if_fail (idx < list->array->len);
294

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