#define __GST_BUFFER_POOL_H__
#include <gst/gstminiobject.h>
-#include <gst/gstatomicqueue.h>
-#include <gst/gstpoll.h>
-#include <gst/gstclock.h>
#include <gst/gstpad.h>
#include <gst/gstbuffer.h>
typedef struct _GstBufferPoolPrivate GstBufferPoolPrivate;
typedef struct _GstBufferPoolClass GstBufferPoolClass;
-/**
- * GST_BUFFER_POOL_TRACE_NAME:
- *
- * The name used for tracing memory allocations.
- */
-#define GST_BUFFER_POOL_TRACE_NAME "GstBufferPool"
-
#define GST_TYPE_BUFFER_POOL (gst_buffer_pool_get_type())
#define GST_IS_BUFFER_POOL(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_BUFFER_POOL))
#define GST_IS_BUFFER_POOL_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_BUFFER_POOL))
* GstBufferPoolFlags:
* @GST_BUFFER_POOL_FLAG_NONE: no flags
* @GST_BUFFER_POOL_FLAG_KEY_UNIT: buffer is keyframe
- * @GST_BUFFER_POOL_FLAG_WAIT: wait for buffer
+ * @GST_BUFFER_POOL_FLAG_DONTWAIT: don't wait for buffer. This makes the
+ * acquire_buffer method return GST_FLOW_UNEXPECTED.
* @GST_BUFFER_POOL_FLAG_DISCONT: buffer is discont
+ * @GST_BUFFER_POOL_FLAG_LAST: last flag, subclasses can use private flags
+ * starting from this value.
*
* Additional flags to control the allocation of a buffer
*/
typedef enum {
GST_BUFFER_POOL_FLAG_NONE = 0,
GST_BUFFER_POOL_FLAG_KEY_UNIT = (1 << 0),
- GST_BUFFER_POOL_FLAG_WAIT = (1 << 1),
+ GST_BUFFER_POOL_FLAG_DONTWAIT = (1 << 1),
GST_BUFFER_POOL_FLAG_DISCONT = (1 << 2),
GST_BUFFER_POOL_FLAG_LAST = (1 << 16),
} GstBufferPoolFlags;
*
* Parameters passed to the gst_buffer_pool_acquire_buffer() function to control the
* allocation of the buffer.
+ *
+ * The default implementation ignores the @start and @stop members but other
+ * implementations can use this extra information to decide what buffer to
+ * return.
*/
typedef struct _GstBufferPoolParams {
GstFormat format;
gint64 start;
gint64 stop;
GstBufferPoolFlags flags;
+
+ /*< private >*/
+ gpointer _gst_reserved[GST_PADDING];
} GstBufferPoolParams;
/**
+ * GST_BUFFER_POOL_IS_FLUSHING:
+ * @pool: a GstBufferPool
+ *
+ * Check if the bufferpool is flushing. Subclasses might want to check the
+ * state of the pool in the acquire function.
+ */
+#define GST_BUFFER_POOL_IS_FLUSHING(pool) (g_atomic_int_get (&pool->flushing))
+
+/**
* GstBufferPool:
- * @mini_object: the parent structure
+ * @object: the parent structure
*
* The structure of a #GstBufferPool. Use the associated macros to access the public
* variables.
struct _GstBufferPool {
GstObject object;
- /*< private >*/
- gboolean active;
- gboolean flushing;
- gboolean started;
- gint outstanding;
- GstAtomicQueue *queue;
- GstPoll *poll;
-
- gboolean configured;
- GstStructure *config;
+ /*< protected >*/
+ gint flushing;
+ /*< private >*/
GstBufferPoolPrivate *priv;
gpointer _gst_reserved[GST_PADDING];
};
+/**
+ * GstBufferPoolClass:
+ * @object_class: Object parent class
+ * @get_options: get a list of options supported by this pool
+ * @set_config: apply the bufferpool configuration. The default configuration
+ * will parse the default config parameters
+ * @start: start the bufferpool. The default implementation will preallocate
+ * min-buffers buffers and put them in the queue
+ * @stop: stop the bufferpool. the default implementation will free the
+ * preallocated buffers. This function is called when all the buffers are
+ * returned to the pool.
+ * @acquire_buffer: get a new buffer from the pool. The default implementation
+ * will take a buffer from the queue and optionally wait for a buffer to
+ * be released when there are no buffers available.
+ * @alloc_buffer: allocate a buffer. the default implementation allocates
+ * buffers from the default memory allocator and with the configured
+ * size, prefix and alignment. All metadata that is present on the
+ * allocated buffer will be marked as #GST_META_FLAG_POOLED and will not
+ * be removed from the buffer in @reset_buffer.
+ * @reset_buffer: reset the buffer to its state when it was freshly allocated.
+ * The default implementation will clear the flags, timestamps and
+ * will remove the metadata added after alloc_buffer.
+ * @release_buffer: release a buffer back in the pool. The default
+ * implementation will put the buffer back in the queue and notify any
+ * blocking acquire_buffer calls.
+ * @free_buffer: free a buffer. The default implementation unrefs the buffer.
+ *
+ * The GstBufferPool class.
+ */
struct _GstBufferPoolClass {
GstObjectClass object_class;
/* vmethods */
+ const gchar ** (*get_options) (GstBufferPool *pool);
gboolean (*set_config) (GstBufferPool *pool, GstStructure *config);
gboolean (*start) (GstBufferPool *pool);
GstBufferPoolParams *params);
GstFlowReturn (*alloc_buffer) (GstBufferPool *pool, GstBuffer **buffer,
GstBufferPoolParams *params);
+ void (*reset_buffer) (GstBufferPool *pool, GstBuffer *buffer,
+ GstBufferPoolParams *params);
void (*release_buffer) (GstBufferPool *pool, GstBuffer *buffer);
void (*free_buffer) (GstBufferPool *pool, GstBuffer *buffer);
+ /*< private >*/
gpointer _gst_reserved[GST_PADDING];
};
GType gst_buffer_pool_get_type (void);
/* allocation */
-GstBufferPool * gst_buffer_pool_new (void);
+GstBufferPool * gst_buffer_pool_new (void);
/* state management */
-gboolean gst_buffer_pool_set_active (GstBufferPool *pool, gboolean active);
+gboolean gst_buffer_pool_set_active (GstBufferPool *pool, gboolean active);
+gboolean gst_buffer_pool_is_active (GstBufferPool *pool);
+
+gboolean gst_buffer_pool_set_config (GstBufferPool *pool, GstStructure *config);
+GstStructure * gst_buffer_pool_get_config (GstBufferPool *pool);
-gboolean gst_buffer_pool_set_config (GstBufferPool *pool, GstStructure *config);
-GstStructure * gst_buffer_pool_get_config (GstBufferPool *pool);
+const gchar ** gst_buffer_pool_get_options (GstBufferPool *pool);
+gboolean gst_buffer_pool_has_option (GstBufferPool *pool, const gchar *option);
/* helpers for configuring the config structure */
-void gst_buffer_pool_config_set (GstStructure *config, const GstCaps *caps,
- guint size, guint min_buffers, guint max_buffers,
- guint prefix, guint postfix, guint align);
-gboolean gst_buffer_pool_config_get (GstStructure *config, const GstCaps **caps,
- guint *size, guint *min_buffers, guint *max_buffers,
- guint *prefix, guint *postfix, guint *align);
+void gst_buffer_pool_config_set (GstStructure *config, const GstCaps *caps,
+ guint size, guint min_buffers, guint max_buffers,
+ guint prefix, guint align);
+gboolean gst_buffer_pool_config_get (GstStructure *config, const GstCaps **caps,
+ guint *size, guint *min_buffers, guint *max_buffers,
+ guint *prefix, guint *align);
+
+/* options */
+guint gst_buffer_pool_config_n_options (GstStructure *config);
+void gst_buffer_pool_config_add_option (GstStructure *config, const gchar *option);
+const gchar * gst_buffer_pool_config_get_option (GstStructure *config, guint index);
+gboolean gst_buffer_pool_config_has_option (GstStructure *config, const gchar *option);
/* buffer management */
-GstFlowReturn gst_buffer_pool_acquire_buffer (GstBufferPool *pool, GstBuffer **buffer,
- GstBufferPoolParams *params);
-void gst_buffer_pool_release_buffer (GstBufferPool *pool, GstBuffer *buffer);
+GstFlowReturn gst_buffer_pool_acquire_buffer (GstBufferPool *pool, GstBuffer **buffer,
+ GstBufferPoolParams *params);
+void gst_buffer_pool_release_buffer (GstBufferPool *pool, GstBuffer *buffer);
G_END_DECLS
projects / platform / upstream / gstreamer.git / blobdiff