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  *
  46  * A function for accessing the last buffer returned by
  47  * gst_buffer_list_iterator_next(). The function can leave @buffer in the list,
  48  * replace @buffer in the list or remove @buffer from the list, depending on
  49  * the return value. If the function returns NULL, @buffer will be removed from
  50  * the list, otherwise @buffer will be replaced with the returned buffer.
  51  *
  52  * The last buffer returned by gst_buffer_list_iterator_next() will be replaced
  53  * with the buffer returned from the function. The function takes ownership of
  54  * @buffer and if a different value than @buffer is returned, @buffer must be
  55  * unreffed. If NULL is returned, the buffer will be removed from the list. The
  56  * list must be writable.
  57  *
  58  * Returns: the buffer to replace @buffer in the list, or NULL to remove @buffer
  59  * from the list
  60  */
  61 typedef GstBuffer* (*GstBufferListDoFunction) (GstBuffer * buffer);
  62
  63 /**
  64  * GstBufferListDoDataFunction:
  65  * @buffer: the #GstBuffer
  66  * @data: the gpointer to optional user data.
  67  *
  68  * A function for accessing the last buffer returned by
  69  * gst_buffer_list_iterator_next(). The function can leave @buffer in the list,
  70  * replace @buffer in the list or remove @buffer from the list, depending on
  71  * the return value. If the function returns NULL, @buffer will be removed from
  72  * the list, otherwise @buffer will be replaced with the returned buffer.
  73  *
  74  * The last buffer returned by gst_buffer_list_iterator_next() will be replaced
  75  * with the buffer returned from the function. The function takes ownership of
  76  * @buffer and if a different value than @buffer is returned, @buffer must be
  77  * unreffed. If NULL is returned, the buffer will be removed from the list. The
  78  * list must be writable.
  79  *
  80  * Returns: the buffer to replace @buffer in the list, or NULL to remove @buffer
  81  * from the list
  82  */
  83 typedef GstBuffer* (*GstBufferListDoDataFunction) (GstBuffer * buffer, gpointer data);
  84
  85 GType gst_buffer_list_get_type (void);
  86
  87 /* allocation */
  88 GstBufferList *gst_buffer_list_new (void);
  89
  90 /* refcounting */
  91 /**
  92  * gst_buffer_list_ref:
  93  * @list: a #GstBufferList
  94  *
  95  * Increases the refcount of the given buffer list by one.
  96  *
  97  * Note that the refcount affects the writeability of @list and its data, see
  98  * gst_buffer_list_make_writable(). It is important to note that keeping
  99  * additional references to GstBufferList instances can potentially increase
 100  * the number of memcpy operations in a pipeline.
 101  *
 102  * Returns: @list
 103  */
 104 #ifdef _FOOL_GTK_DOC_
 105 G_INLINE_FUNC GstBufferList * gst_buffer_list_ref (GstBufferList * list);
 106 #endif
 107
 108 static inline GstBufferList *
 109 gst_buffer_list_ref (GstBufferList * list)
 110 {
 111   return GST_BUFFER_LIST_CAST (gst_mini_object_ref (GST_MINI_OBJECT_CAST (
 112       list)));
 113 }
 114
 115 /**
 116  * gst_buffer_list_unref:
 117  * @list: a #GstBufferList
 118  *
 119  * Decreases the refcount of the buffer list. If the refcount reaches 0, the
 120  * buffer list will be freed.
 121  */
 122 #ifdef _FOOL_GTK_DOC_
 123 G_INLINE_FUNC void gst_buffer_list_unref (GstBufferList * list);
 124 #endif
 125
 126 static inline void
 127 gst_buffer_list_unref (GstBufferList * list)
 128 {
 129   gst_mini_object_unref (GST_MINI_OBJECT_CAST (list));
 130 }
 131
 132 /* copy */
 133 /**
 134  * gst_buffer_list_copy:
 135  * @list: a #GstBufferList
 136  *
 137  * Create a shallow copy of the given buffer list. This will make a newly
 138  * allocated copy of the source list with copies of buffer pointers. The
 139  * refcount of buffers pointed to will be increased by one.
 140  *
 141  * Returns: a new copy of @list.
 142  */
 143 #ifdef _FOOL_GTK_DOC_
 144 G_INLINE_FUNC GstBufferList * gst_buffer_list_copy (const GstBufferList * list);
 145 #endif
 146
 147 static inline GstBufferList *
 148 gst_buffer_list_copy (const GstBufferList * list)
 149 {
 150   return GST_BUFFER_LIST (gst_mini_object_copy (GST_MINI_OBJECT_CAST (list)));
 151 }
 152
 153 /**
 154  * gst_buffer_list_is_writable:
 155  * @list: a #GstBufferList
 156  *
 157  * Tests if you can safely add buffers and groups into a buffer list.
 158  */
 159 #define gst_buffer_list_is_writable(list) gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (list))
 160
 161 /**
 162  * gst_buffer_list_make_writable:
 163  * @list: a #GstBufferList
 164  *
 165  * Makes a writable buffer list from the given buffer list. If the source buffer
 166  * list is already writable, this will simply return the same buffer list. A
 167  * copy will otherwise be made using gst_buffer_list_copy().
 168  */
 169 #define gst_buffer_list_make_writable(list) GST_BUFFER_LIST_CAST (gst_mini_object_make_writable (GST_MINI_OBJECT_CAST (list)))
 170
 171 guint                    gst_buffer_list_n_groups              (GstBufferList *list);
 172
 173 /* iterator */
 174 GstBufferListIterator *  gst_buffer_list_iterate               (GstBufferList *list);
 175 void                     gst_buffer_list_iterator_free         (GstBufferListIterator *it);
 176
 177 guint                    gst_buffer_list_iterator_n_buffers    (const GstBufferListIterator *it);
 178 GstBuffer *              gst_buffer_list_iterator_next         (GstBufferListIterator *it);
 179 gboolean                 gst_buffer_list_iterator_next_group   (GstBufferListIterator *it);
 180
 181 void                     gst_buffer_list_iterator_add          (GstBufferListIterator *it, GstBuffer *buffer);
 182 void                     gst_buffer_list_iterator_add_group    (GstBufferListIterator *it);
 183 void                     gst_buffer_list_iterator_remove       (GstBufferListIterator *it);
 184 GstBuffer *              gst_buffer_list_iterator_steal        (GstBufferListIterator *it);
 185 void                     gst_buffer_list_iterator_take         (GstBufferListIterator *it, GstBuffer *buffer);
 186
 187 GstBuffer *              gst_buffer_list_iterator_do           (GstBufferListIterator *it, GstBufferListDoFunction do_func);
 188 GstBuffer *              gst_buffer_list_iterator_do_data      (GstBufferListIterator *it, GstBufferListDoDataFunction do_func,
 189                                                                 gpointer data, GDestroyNotify data_notify);
 190
 191 /* conversion */
 192 GstBuffer *              gst_buffer_list_iterator_merge_group  (const GstBufferListIterator *it);
 193
 194 G_END_DECLS
 195
 196 #endif /* __GST_BUFFER_LIST_H__ */