gst/gstbufferpool.h

   1 /* GStreamer
   2  * Copyright (C) 2010 Wim Taymans <wim.taymans@gmail.com>
   3  *
   4  * gstbufferpool.h: Header for GstBufferPool object
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Library General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Library General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Library General Public
  17  * License along with this library; if not, write to the
  18  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  19  * Boston, MA 02111-1307, USA.
  20  */
  21
  22
  23 #ifndef __GST_BUFFER_POOL_H__
  24 #define __GST_BUFFER_POOL_H__
  25
  26 #include <gst/gstminiobject.h>
  27 #include <gst/gstatomicqueue.h>
  28 #include <gst/gstpoll.h>
  29 #include <gst/gstclock.h>
  30 #include <gst/gstpad.h>
  31 #include <gst/gstbuffer.h>
  32
  33 G_BEGIN_DECLS
  34
  35 typedef struct _GstBufferPoolPrivate GstBufferPoolPrivate;
  36 typedef struct _GstBufferPoolClass GstBufferPoolClass;
  37
  38 #define GST_TYPE_BUFFER_POOL                 (gst_buffer_pool_get_type())
  39 #define GST_IS_BUFFER_POOL(obj)              (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_BUFFER_POOL))
  40 #define GST_IS_BUFFER_POOL_CLASS(klass)      (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_BUFFER_POOL))
  41 #define GST_BUFFER_POOL_GET_CLASS(obj)       (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_BUFFER_POOL, GstBufferPoolClass))
  42 #define GST_BUFFER_POOL(obj)                 (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_BUFFER_POOL, GstBufferPool))
  43 #define GST_BUFFER_POOL_CLASS(klass)         (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_BUFFER_POOL, GstBufferPoolClass))
  44 #define GST_BUFFER_POOL_CAST(obj)            ((GstBufferPool *)(obj))
  45
  46 /**
  47  * GstBufferPoolFlags:
  48  * @GST_BUFFER_POOL_FLAG_NONE: no flags
  49  * @GST_BUFFER_POOL_FLAG_KEY_UNIT: buffer is keyframe
  50  * @GST_BUFFER_POOL_FLAG_DONTWAIT: don't wait for buffer. This makes the
  51  * acquire_buffer method return GST_FLOW_UNEXPECTED.
  52  * @GST_BUFFER_POOL_FLAG_DISCONT: buffer is discont
  53  * @GST_BUFFER_POOL_FLAG_LAST: last flag, subclasses can use private flags
  54  *    starting from this value.
  55  *
  56  * Additional flags to control the allocation of a buffer
  57  */
  58 typedef enum {
  59   GST_BUFFER_POOL_FLAG_NONE     = 0,
  60   GST_BUFFER_POOL_FLAG_KEY_UNIT = (1 << 0),
  61   GST_BUFFER_POOL_FLAG_DONTWAIT = (1 << 1),
  62   GST_BUFFER_POOL_FLAG_DISCONT  = (1 << 2),
  63   GST_BUFFER_POOL_FLAG_LAST     = (1 << 16),
  64 } GstBufferPoolFlags;
  65
  66 /**
  67  * GstBufferPoolParams:
  68  * @format: the format of @start and @stop
  69  * @start: the start position
  70  * @stop: the stop position
  71  * @flags: additional flags
  72  *
  73  * Parameters passed to the gst_buffer_pool_acquire_buffer() function to control the
  74  * allocation of the buffer.
  75  *
  76  * The default implementation ignores the @start and @stop members but other
  77  * implementations can use this extra information to decide what buffer to
  78  * return.
  79  */
  80 typedef struct _GstBufferPoolParams {
  81   GstFormat          format;
  82   gint64             start;
  83   gint64             stop;
  84   GstBufferPoolFlags flags;
  85
  86   /*< private >*/
  87   gpointer _gst_reserved[GST_PADDING];
  88 } GstBufferPoolParams;
  89
  90 /**
  91  * GST_BUFFER_POOL_IS_FLUSHING:
  92  * @pool: a GstBufferPool
  93  *
  94  * Check if the bufferpool is flushing. Subclasses might want to check the
  95  * state of the pool in the acquire function.
  96  */
  97 #define GST_BUFFER_POOL_IS_FLUSHING(pool)  (g_atomic_int_get (&pool->flushing))
  98
  99 /**
 100  * GstBufferPool:
 101  * @object: the parent structure
 102  *
 103  * The structure of a #GstBufferPool. Use the associated macros to access the public
 104  * variables.
 105  */
 106 struct _GstBufferPool {
 107   GstObject            object;
 108
 109   /*< protected >*/
 110   gint                 flushing;
 111
 112   /*< private >*/
 113   GstBufferPoolPrivate *priv;
 114
 115   gpointer _gst_reserved[GST_PADDING];
 116 };
 117
 118 /**
 119  * GstBufferPoolClass:
 120  * @object_class:  Object parent class
 121  * @get_options: get a list of options supported by this pool
 122  * @set_config: apply the bufferpool configuration. The default configuration
 123  *              will parse the default config parameters
 124  * @start: start the bufferpool. The default implementation will preallocate
 125  *         min-buffers buffers and put them in the queue
 126  * @stop: stop the bufferpool. the default implementation will free the
 127  *        preallocated buffers. This function is called when all the buffers are
 128  *        returned to the pool.
 129  * @acquire_buffer: get a new buffer from the pool. The default implementation
 130  *        will take a buffer from the queue and optionally wait for a buffer to
 131  *        be released when there are no buffers available.
 132  * @alloc_buffer: allocate a buffer. the default implementation allocates
 133  *        buffers from the default memory allocator and with the configured
 134  *        size, prefix and alignment. All metadata that is present on the
 135  *        allocated buffer will be marked as #GST_META_FLAG_POOLED and will not
 136  *        be removed from the buffer in @reset_buffer.
 137  * @reset_buffer: reset the buffer to its state when it was freshly allocated.
 138  *        The default implementation will clear the flags, timestamps and
 139  *        will remove the metadata added after alloc_buffer.
 140  * @release_buffer: release a buffer back in the pool. The default
 141  *        implementation will put the buffer back in the queue and notify any
 142  *        blocking acquire_buffer calls.
 143  * @free_buffer: free a buffer. The default implementation unrefs the buffer.
 144  *
 145  * The GstBufferPool class.
 146  */
 147 struct _GstBufferPoolClass {
 148   GstObjectClass    object_class;
 149
 150   /* vmethods */
 151   const gchar ** (*get_options)    (GstBufferPool *pool);
 152   gboolean       (*set_config)     (GstBufferPool *pool, GstStructure *config);
 153
 154   gboolean       (*start)          (GstBufferPool *pool);
 155   gboolean       (*stop)           (GstBufferPool *pool);
 156
 157   GstFlowReturn  (*acquire_buffer) (GstBufferPool *pool, GstBuffer **buffer,
 158                                     GstBufferPoolParams *params);
 159   GstFlowReturn  (*alloc_buffer)   (GstBufferPool *pool, GstBuffer **buffer,
 160                                     GstBufferPoolParams *params);
 161   void           (*reset_buffer)   (GstBufferPool *pool, GstBuffer *buffer,
 162                                     GstBufferPoolParams *params);
 163   void           (*release_buffer) (GstBufferPool *pool, GstBuffer *buffer);
 164   void           (*free_buffer)    (GstBufferPool *pool, GstBuffer *buffer);
 165
 166   /*< private >*/
 167   gpointer _gst_reserved[GST_PADDING];
 168 };
 169
 170 GType       gst_buffer_pool_get_type (void);
 171
 172 /* allocation */
 173 GstBufferPool *  gst_buffer_pool_new  (void);
 174
 175 /* state management */
 176 gboolean         gst_buffer_pool_set_active      (GstBufferPool *pool, gboolean active);
 177 gboolean         gst_buffer_pool_is_active       (GstBufferPool *pool);
 178
 179 gboolean         gst_buffer_pool_set_config      (GstBufferPool *pool, GstStructure *config);
 180 GstStructure *   gst_buffer_pool_get_config      (GstBufferPool *pool);
 181
 182 const gchar **   gst_buffer_pool_get_options     (GstBufferPool *pool);
 183 gboolean         gst_buffer_pool_has_option      (GstBufferPool *pool, const gchar *option);
 184
 185 /* helpers for configuring the config structure */
 186 void             gst_buffer_pool_config_set      (GstStructure *config, const GstCaps *caps,
 187                                                   guint size, guint min_buffers, guint max_buffers,
 188                                                   guint prefix, guint align);
 189 gboolean         gst_buffer_pool_config_get      (GstStructure *config, const GstCaps **caps,
 190                                                   guint *size, guint *min_buffers, guint *max_buffers,
 191                                                   guint *prefix, guint *align);
 192
 193 /* options */
 194 guint            gst_buffer_pool_config_n_options   (GstStructure *config);
 195 void             gst_buffer_pool_config_add_option  (GstStructure *config, const gchar *option);
 196 const gchar *    gst_buffer_pool_config_get_option  (GstStructure *config, guint index);
 197 gboolean         gst_buffer_pool_config_has_option  (GstStructure *config, const gchar *option);
 198
 199 /* buffer management */
 200 GstFlowReturn    gst_buffer_pool_acquire_buffer  (GstBufferPool *pool, GstBuffer **buffer,
 201                                                   GstBufferPoolParams *params);
 202 void             gst_buffer_pool_release_buffer  (GstBufferPool *pool, GstBuffer *buffer);
 203
 204 G_END_DECLS
 205
 206 #endif /* __GST_BUFFER_POOL_H__ */