X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=gst%2Fgstbufferpool.h;h=d36d066d9d372a5799d12400ea4c5996d2eb746d;hb=5470f6df00595f4ab44871e0e633bf15006abc5c;hp=639fd267ab9b4ec0498cf580169dd54e7bedf6b8;hpb=e10666a9d008d019cad1903f636e92b21163806d;p=platform%2Fupstream%2Fgstreamer.git diff --git a/gst/gstbufferpool.h b/gst/gstbufferpool.h index 639fd26..d36d066 100644 --- a/gst/gstbufferpool.h +++ b/gst/gstbufferpool.h @@ -15,8 +15,8 @@ * * 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. + * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, + * Boston, MA 02110-1301, USA. */ @@ -24,9 +24,6 @@ #define __GST_BUFFER_POOL_H__ #include -#include -#include -#include #include #include @@ -35,13 +32,6 @@ G_BEGIN_DECLS 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)) @@ -51,27 +41,30 @@ typedef struct _GstBufferPoolClass GstBufferPoolClass; #define GST_BUFFER_POOL_CAST(obj) ((GstBufferPool *)(obj)) /** - * GstBufferPoolFlags: - * @GST_BUFFER_POOL_FLAG_NONE: no flags - * @GST_BUFFER_POOL_FLAG_KEY_UNIT: buffer is keyframe - * @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 + * GstBufferPoolAcquireFlags: + * @GST_BUFFER_POOL_ACQUIRE_FLAG_NONE: no flags + * @GST_BUFFER_POOL_ACQUIRE_FLAG_KEY_UNIT: buffer is keyframe + * @GST_BUFFER_POOL_ACQUIRE_FLAG_DONTWAIT: when the bufferpool is empty, acquire_buffer + * will by default block until a buffer is released into the pool again. Setting + * this flag makes acquire_buffer return #GST_FLOW_EOS instead of blocking. + * @GST_BUFFER_POOL_ACQUIRE_FLAG_DISCONT: buffer is discont + * @GST_BUFFER_POOL_ACQUIRE_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_DONTWAIT = (1 << 1), - GST_BUFFER_POOL_FLAG_DISCONT = (1 << 2), - GST_BUFFER_POOL_FLAG_LAST = (1 << 16), -} GstBufferPoolFlags; + GST_BUFFER_POOL_ACQUIRE_FLAG_NONE = 0, + GST_BUFFER_POOL_ACQUIRE_FLAG_KEY_UNIT = (1 << 0), + GST_BUFFER_POOL_ACQUIRE_FLAG_DONTWAIT = (1 << 1), + GST_BUFFER_POOL_ACQUIRE_FLAG_DISCONT = (1 << 2), + GST_BUFFER_POOL_ACQUIRE_FLAG_LAST = (1 << 16), +} GstBufferPoolAcquireFlags; + +typedef struct _GstBufferPoolAcquireParams GstBufferPoolAcquireParams; /** - * GstBufferPoolParams: + * GstBufferPoolAcquireParams: * @format: the format of @start and @stop * @start: the start position * @stop: the stop position @@ -84,12 +77,15 @@ typedef enum { * implementations can use this extra information to decide what buffer to * return. */ -typedef struct _GstBufferPoolParams { - GstFormat format; - gint64 start; - gint64 stop; - GstBufferPoolFlags flags; -} GstBufferPoolParams; +struct _GstBufferPoolAcquireParams { + GstFormat format; + gint64 start; + gint64 stop; + GstBufferPoolAcquireFlags flags; + + /*< private >*/ + gpointer _gst_reserved[GST_PADDING]; +}; /** * GST_BUFFER_POOL_IS_FLUSHING: @@ -102,7 +98,6 @@ typedef struct _GstBufferPoolParams { /** * GstBufferPool: - * @object: the parent structure * * The structure of a #GstBufferPool. Use the associated macros to access the public * variables. @@ -110,17 +105,10 @@ typedef struct _GstBufferPoolParams { 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]; @@ -141,21 +129,32 @@ struct _GstBufferPool { * 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. + * buffers from the configured memory allocator and with the configured + * parameters. All metadata that is present on the allocated buffer will + * be marked as #GST_META_FLAG_POOLED and #GST_META_FLAG_LOCKED and will + * not be removed from the buffer in @reset_buffer. The buffer should + * have the GST_BUFFER_FLAG_TAG_MEMORY cleared. * @reset_buffer: reset the buffer to its state when it was freshly allocated. - * The default implementation will clear the flags and timestamps. + * The default implementation will clear the flags, timestamps and + * will remove the metadata without the #GST_META_FLAG_POOLED flag (even + * the metadata with #GST_META_FLAG_LOCKED). If the + * #GST_BUFFER_FLAG_TAG_MEMORY was set, this function can also try to + * restore the memory and clear the #GST_BUFFER_FLAG_TAG_MEMORY again. * @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. + * blocking acquire_buffer calls when the #GST_BUFFER_FLAG_TAG_MEMORY + * is not set on the buffer. If #GST_BUFFER_FLAG_TAG_MEMORY is set, the + * buffer will be freed with @free_buffer. * @free_buffer: free a buffer. The default implementation unrefs the buffer. + * @flush_start: enter the flushing state. (Since 1.4) + * @flush_stop: leave the flushign state. (Since 1.4) * * The GstBufferPool class. */ struct _GstBufferPoolClass { GstObjectClass object_class; - /* vmethods */ + /*< public >*/ const gchar ** (*get_options) (GstBufferPool *pool); gboolean (*set_config) (GstBufferPool *pool, GstStructure *config); @@ -163,50 +162,93 @@ struct _GstBufferPoolClass { gboolean (*stop) (GstBufferPool *pool); GstFlowReturn (*acquire_buffer) (GstBufferPool *pool, GstBuffer **buffer, - GstBufferPoolParams *params); + GstBufferPoolAcquireParams *params); GstFlowReturn (*alloc_buffer) (GstBufferPool *pool, GstBuffer **buffer, - GstBufferPoolParams *params); - void (*reset_buffer) (GstBufferPool *pool, GstBuffer *buffer, - GstBufferPoolParams *params); + GstBufferPoolAcquireParams *params); + void (*reset_buffer) (GstBufferPool *pool, GstBuffer *buffer); void (*release_buffer) (GstBufferPool *pool, GstBuffer *buffer); void (*free_buffer) (GstBufferPool *pool, GstBuffer *buffer); + void (*flush_start) (GstBufferPool *pool); + void (*flush_stop) (GstBufferPool *pool); /*< private >*/ - gpointer _gst_reserved[GST_PADDING]; + gpointer _gst_reserved[GST_PADDING - 2]; }; +GST_API GType gst_buffer_pool_get_type (void); /* allocation */ + +GST_API GstBufferPool * gst_buffer_pool_new (void); /* state management */ + +GST_API gboolean gst_buffer_pool_set_active (GstBufferPool *pool, gboolean active); + +GST_API gboolean gst_buffer_pool_is_active (GstBufferPool *pool); +GST_API gboolean gst_buffer_pool_set_config (GstBufferPool *pool, GstStructure *config); + +GST_API GstStructure * gst_buffer_pool_get_config (GstBufferPool *pool); +GST_API const gchar ** gst_buffer_pool_get_options (GstBufferPool *pool); + +GST_API gboolean gst_buffer_pool_has_option (GstBufferPool *pool, const gchar *option); +GST_API +void gst_buffer_pool_set_flushing (GstBufferPool *pool, gboolean flushing); + /* 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 align); -gboolean gst_buffer_pool_config_get (GstStructure *config, const GstCaps **caps, - guint *size, guint *min_buffers, guint *max_buffers, - guint *prefix, guint *align); + +GST_API +void gst_buffer_pool_config_set_params (GstStructure *config, GstCaps *caps, + guint size, guint min_buffers, guint max_buffers); + +GST_API +gboolean gst_buffer_pool_config_get_params (GstStructure *config, GstCaps **caps, + guint *size, guint *min_buffers, guint *max_buffers); + +GST_API +void gst_buffer_pool_config_set_allocator (GstStructure *config, GstAllocator *allocator, + const GstAllocationParams *params); + +GST_API +gboolean gst_buffer_pool_config_get_allocator (GstStructure *config, GstAllocator **allocator, + GstAllocationParams *params); /* options */ + +GST_API guint gst_buffer_pool_config_n_options (GstStructure *config); + +GST_API void gst_buffer_pool_config_add_option (GstStructure *config, const gchar *option); + +GST_API const gchar * gst_buffer_pool_config_get_option (GstStructure *config, guint index); + +GST_API gboolean gst_buffer_pool_config_has_option (GstStructure *config, const gchar *option); +GST_API +gboolean gst_buffer_pool_config_validate_params (GstStructure *config, GstCaps *caps, + guint size, guint min_buffers, guint max_buffers); + /* buffer management */ + +GST_API GstFlowReturn gst_buffer_pool_acquire_buffer (GstBufferPool *pool, GstBuffer **buffer, - GstBufferPoolParams *params); + GstBufferPoolAcquireParams *params); + +GST_API void gst_buffer_pool_release_buffer (GstBufferPool *pool, GstBuffer *buffer); G_END_DECLS