tracer: latency: Fix bug when dropping sub-latency probe event
[platform/upstream/gstreamer.git] / gst / gstbufferpool.h
index 5d26e81..d36d066 100644 (file)
@@ -132,20 +132,22 @@ struct _GstBufferPool {
  *        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. Memory will be marked
- *        with GST_BUFFER_FLAG_TAG_MEMORY.
+ *        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, 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 removed, this function can also try to
- *        restore the memory and set the #GST_BUFFER_FLAG_TAG_MEMORY again.
+ *        #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 when the #GST_BUFFER_FLAG_TAG_MEMORY
- *        is set on the buffer. If #GST_BUFFER_FLAG_TAG_MEMORY is not set, the 
+ *        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.
  */
@@ -166,45 +168,87 @@ struct _GstBufferPoolClass {
   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 */
+
+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,
                                                   GstBufferPoolAcquireParams *params);
+
+GST_API
 void             gst_buffer_pool_release_buffer  (GstBufferPool *pool, GstBuffer *buffer);
 
 G_END_DECLS