gst/gstbufferlist.h

   1 /* GStreamer
   2  * Copyright (C) 2009 Axis Communications <dev-gstreamer at axis dot com>
   3  * @author Jonas Holmberg <jonas dot holmberg at axis dot com>
   4  *
   5  * gstbufferlist.h: Header for GstBufferList object
   6  *
   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.
  11  *
  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.
  16  *
  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.
  21  */
  22
  23 #ifndef __GST_BUFFER_LIST_H__
  24 #define __GST_BUFFER_LIST_H__
  25
  26 #include <gst/gstbuffer.h>
  27
  28 G_BEGIN_DECLS
  29
  30 #define GST_TYPE_BUFFER_LIST (gst_buffer_list_get_type ())
  31 #define GST_IS_BUFFER_LIST(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_BUFFER_LIST))
  32 #define GST_IS_BUFFER_LIST_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_BUFFER_LIST))
  33 #define GST_BUFFER_LIST_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_BUFFER_LIST, GstBufferListClass))
  34 #define GST_BUFFER_LIST(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_BUFFER_LIST, GstBufferList))
  35 #define GST_BUFFER_LIST_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_BUFFER_LIST, GstBufferListClass))
  36 #define GST_BUFFER_LIST_CAST(obj) ((GstBufferList *)obj)
  37
  38 typedef struct _GstBufferList GstBufferList;
  39 typedef struct _GstBufferListClass GstBufferListClass;
  40 typedef struct _GstBufferListIterator GstBufferListIterator;
  41
  42 /**
  43  * GstBufferListDoFunction:
  44  * @buffer: the #GstBuffer
  45  * @user_data: user data
  46  *
  47  * A function for accessing the last buffer returned by
  48  * gst_buffer_list_iterator_next(). The function can leave @buffer in the list,
  49  * replace @buffer in the list or remove @buffer from the list, depending on
  50  * the return value. If the function returns NULL, @buffer will be removed from
  51  * the list, otherwise @buffer will be replaced with the returned buffer.
  52  *
  53  * The last buffer returned by gst_buffer_list_iterator_next() will be replaced
  54  * with the buffer returned from the function. The function takes ownership of
  55  * @buffer and if a different value than @buffer is returned, @buffer must be
  56  * unreffed. If NULL is returned, the buffer will be removed from the list. The
  57  * list must be writable.
  58  *
  59  * Returns: the buffer to replace @buffer in the list, or NULL to remove @buffer
  60  * from the list
  61  */
  62 typedef GstBuffer* (*GstBufferListDoFunction) (GstBuffer * buffer, gpointer user_data);
  63
  64 /**
  65  * GstBufferListItem:
  66  * @GST_BUFFER_LIST_CONTINUE:   Retrieve next buffer
  67  * @GST_BUFFER_LIST_SKIP_GROUP: Skip to next group
  68  * @GST_BUFFER_LIST_REMOVE:     Remove the current buffer
  69  * @GST_BUFFER_LIST_END:        End iteration
  70  *
  71  * The result of the #GstBufferListFunc.
  72  */
  73 typedef enum {
  74   GST_BUFFER_LIST_CONTINUE,
  75   GST_BUFFER_LIST_SKIP_GROUP,
  76   GST_BUFFER_LIST_END
  77 } GstBufferListItem;
  78
  79 /**
  80  * GstBufferListFunc:
  81  * @buffer: pointer the buffer
  82  * @group: the group index of @buffer
  83  * @idx: the index in @group of @buffer
  84  * @user_data: user data passed to gst_buffer_list_foreach()
  85  *
  86  * A function that will be called from gst_buffer_list_foreach(). The @buffer
  87  * field will point to a the reference of the buffer at @idx in @group.
  88  *
  89  * When this function returns #GST_BUFFER_LIST_CONTINUE, the next buffer will be
  90  * returned. When #GST_BUFFER_LIST_SKIP_GROUP is returned, all remaining buffers
  91  * in the current group will be skipped and the first buffer of the next group
  92  * is returned (if any). When GST_BUFFER_LIST_END is returned,
  93  * gst_buffer_list_foreach() will return.
  94  *
  95  * When @buffer is set to NULL, the item will be removed from the bufferlist.
  96  * When @buffer has been made writable, the new buffer reference can be assigned
  97  * to @buffer. This function is responsible for unreffing the old buffer when
  98  * removing or modifying.
  99  *
 100  * Returns: a #GstBufferListItem
 101  */
 102 typedef GstBufferListItem (*GstBufferListFunc)   (GstBuffer **buffer, guint group, guint idx,
 103                                                   gpointer user_data);
 104
 105
 106 GType gst_buffer_list_get_type (void);
 107
 108 /* allocation */
 109 GstBufferList *gst_buffer_list_new (void);
 110
 111 /* refcounting */
 112 /**
 113  * gst_buffer_list_ref:
 114  * @list: a #GstBufferList
 115  *
 116  * Increases the refcount of the given buffer list by one.
 117  *
 118  * Note that the refcount affects the writeability of @list and its data, see
 119  * gst_buffer_list_make_writable(). It is important to note that keeping
 120  * additional references to GstBufferList instances can potentially increase
 121  * the number of memcpy operations in a pipeline.
 122  *
 123  * Returns: @list
 124  */
 125 #ifdef _FOOL_GTK_DOC_
 126 G_INLINE_FUNC GstBufferList * gst_buffer_list_ref (GstBufferList * list);
 127 #endif
 128
 129 static inline GstBufferList *
 130 gst_buffer_list_ref (GstBufferList * list)
 131 {
 132   return GST_BUFFER_LIST_CAST (gst_mini_object_ref (GST_MINI_OBJECT_CAST (
 133       list)));
 134 }
 135
 136 /**
 137  * gst_buffer_list_unref:
 138  * @list: a #GstBufferList
 139  *
 140  * Decreases the refcount of the buffer list. If the refcount reaches 0, the
 141  * buffer list will be freed.
 142  */
 143 #ifdef _FOOL_GTK_DOC_
 144 G_INLINE_FUNC void gst_buffer_list_unref (GstBufferList * list);
 145 #endif
 146
 147 static inline void
 148 gst_buffer_list_unref (GstBufferList * list)
 149 {
 150   gst_mini_object_unref (GST_MINI_OBJECT_CAST (list));
 151 }
 152
 153 /* copy */
 154 /**
 155  * gst_buffer_list_copy:
 156  * @list: a #GstBufferList
 157  *
 158  * Create a shallow copy of the given buffer list. This will make a newly
 159  * allocated copy of the source list with copies of buffer pointers. The
 160  * refcount of buffers pointed to will be increased by one.
 161  *
 162  * Returns: a new copy of @list.
 163  */
 164 #ifdef _FOOL_GTK_DOC_
 165 G_INLINE_FUNC GstBufferList * gst_buffer_list_copy (const GstBufferList * list);
 166 #endif
 167
 168 static inline GstBufferList *
 169 gst_buffer_list_copy (const GstBufferList * list)
 170 {
 171   return GST_BUFFER_LIST (gst_mini_object_copy (GST_MINI_OBJECT_CAST (list)));
 172 }
 173
 174 /**
 175  * gst_buffer_list_is_writable:
 176  * @list: a #GstBufferList
 177  *
 178  * Tests if you can safely add buffers and groups into a buffer list.
 179  */
 180 #define gst_buffer_list_is_writable(list) gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (list))
 181
 182 /**
 183  * gst_buffer_list_make_writable:
 184  * @list: a #GstBufferList
 185  *
 186  * Makes a writable buffer list from the given buffer list. If the source buffer
 187  * list is already writable, this will simply return the same buffer list. A
 188  * copy will otherwise be made using gst_buffer_list_copy().
 189  */
 190 #define gst_buffer_list_make_writable(list) GST_BUFFER_LIST_CAST (gst_mini_object_make_writable (GST_MINI_OBJECT_CAST (list)))
 191
 192 guint                    gst_buffer_list_n_groups              (GstBufferList *list);
 193
 194 void                     gst_buffer_list_foreach               (GstBufferList *list,
 195                                                                 GstBufferListFunc func,
 196                                                                 gpointer user_data);
 197 GstBuffer *              gst_buffer_list_get                   (GstBufferList *list, guint group, guint idx);
 198
 199 /* iterator */
 200 GstBufferListIterator *  gst_buffer_list_iterate               (GstBufferList *list);
 201 void                     gst_buffer_list_iterator_free         (GstBufferListIterator *it);
 202
 203 guint                    gst_buffer_list_iterator_n_buffers    (const GstBufferListIterator *it);
 204 GstBuffer *              gst_buffer_list_iterator_next         (GstBufferListIterator *it);
 205 gboolean                 gst_buffer_list_iterator_next_group   (GstBufferListIterator *it);
 206
 207 void                     gst_buffer_list_iterator_add          (GstBufferListIterator *it, GstBuffer *buffer);
 208 void                     gst_buffer_list_iterator_add_group    (GstBufferListIterator *it);
 209 void                     gst_buffer_list_iterator_remove       (GstBufferListIterator *it);
 210 GstBuffer *              gst_buffer_list_iterator_steal        (GstBufferListIterator *it);
 211 void                     gst_buffer_list_iterator_take         (GstBufferListIterator *it, GstBuffer *buffer);
 212
 213 GstBuffer *              gst_buffer_list_iterator_do           (GstBufferListIterator *it, GstBufferListDoFunction do_func,
 214                                                                 gpointer user_data);
 215
 216 /* conversion */
 217 GstBuffer *              gst_buffer_list_iterator_merge_group  (const GstBufferListIterator *it);
 218
 219 G_END_DECLS
 220
 221 #endif /* __GST_BUFFER_LIST_H__ */