2 * Copyright (C) 2010 Wim Taymans <wim.taymans@gmail.com>
4 * gstbufferpool.c: GstBufferPool baseclass
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.
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.
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., 51 Franklin St, Fifth Floor,
19 * Boston, MA 02110-1301, USA.
23 * SECTION:gstbufferpool
24 * @short_description: Pool for buffers
25 * @see_also: #GstBuffer
27 * A #GstBufferPool is an object that can be used to pre-allocate and recycle
28 * buffers of the same size and with the same properties.
30 * A #GstBufferPool is created with gst_buffer_pool_new().
32 * Once a pool is created, it needs to be configured. A call to
33 * gst_buffer_pool_get_config() returns the current configuration structure from
34 * the pool. With gst_buffer_pool_config_set_params() and
35 * gst_buffer_pool_config_set_allocator() the bufferpool parameters and
36 * allocator can be configured. Other properties can be configured in the pool
37 * depending on the pool implementation.
39 * A bufferpool can have extra options that can be enabled with
40 * gst_buffer_pool_config_add_option(). The available options can be retrieved
41 * with gst_buffer_pool_get_options(). Some options allow for additional
42 * configuration properties to be set.
44 * After the configuration structure has been configured,
45 * gst_buffer_pool_set_config() updates the configuration in the pool. This can
46 * fail when the configuration structure is not accepted.
48 * After the a pool has been configured, it can be activated with
49 * gst_buffer_pool_set_active(). This will preallocate the configured resources
52 * When the pool is active, gst_buffer_pool_acquire_buffer() can be used to
53 * retrieve a buffer from the pool.
55 * Buffers allocated from a bufferpool will automatically be returned to the
56 * pool with gst_buffer_pool_release_buffer() when their refcount drops to 0.
58 * The bufferpool can be deactivated again with gst_buffer_pool_set_active().
59 * All further gst_buffer_pool_acquire_buffer() calls will return an error. When
60 * all buffers are returned to the pool they will be freed.
62 * Use gst_object_unref() to release the reference to a bufferpool. If the
63 * refcount of the pool reaches 0, the pool will be freed.
66 #include "gst_private.h"
67 #include "glib-compat-private.h"
73 #include <sys/types.h>
75 #include "gstatomicqueue.h"
81 #include "gstbufferpool.h"
83 GST_DEBUG_CATEGORY_STATIC (gst_buffer_pool_debug);
84 #define GST_CAT_DEFAULT gst_buffer_pool_debug
86 #define GST_BUFFER_POOL_GET_PRIVATE(obj) \
87 (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GST_TYPE_BUFFER_POOL, GstBufferPoolPrivate))
89 #define GST_BUFFER_POOL_LOCK(pool) (g_rec_mutex_lock(&pool->priv->rec_lock))
90 #define GST_BUFFER_POOL_UNLOCK(pool) (g_rec_mutex_unlock(&pool->priv->rec_lock))
92 struct _GstBufferPoolPrivate
94 GstAtomicQueue *queue;
101 gint outstanding; /* number of buffers that are in use */
104 GstStructure *config;
110 GstAllocator *allocator;
111 GstAllocationParams params;
114 static void gst_buffer_pool_finalize (GObject * object);
116 G_DEFINE_TYPE (GstBufferPool, gst_buffer_pool, GST_TYPE_OBJECT);
118 static gboolean default_start (GstBufferPool * pool);
119 static gboolean default_stop (GstBufferPool * pool);
120 static gboolean default_set_config (GstBufferPool * pool,
121 GstStructure * config);
122 static GstFlowReturn default_alloc_buffer (GstBufferPool * pool,
123 GstBuffer ** buffer, GstBufferPoolAcquireParams * params);
124 static GstFlowReturn default_acquire_buffer (GstBufferPool * pool,
125 GstBuffer ** buffer, GstBufferPoolAcquireParams * params);
126 static void default_reset_buffer (GstBufferPool * pool, GstBuffer * buffer);
127 static void default_free_buffer (GstBufferPool * pool, GstBuffer * buffer);
128 static void default_release_buffer (GstBufferPool * pool, GstBuffer * buffer);
131 gst_buffer_pool_class_init (GstBufferPoolClass * klass)
133 GObjectClass *gobject_class = (GObjectClass *) klass;
135 g_type_class_add_private (klass, sizeof (GstBufferPoolPrivate));
137 gobject_class->finalize = gst_buffer_pool_finalize;
139 klass->start = default_start;
140 klass->stop = default_stop;
141 klass->set_config = default_set_config;
142 klass->acquire_buffer = default_acquire_buffer;
143 klass->reset_buffer = default_reset_buffer;
144 klass->alloc_buffer = default_alloc_buffer;
145 klass->release_buffer = default_release_buffer;
146 klass->free_buffer = default_free_buffer;
148 GST_DEBUG_CATEGORY_INIT (gst_buffer_pool_debug, "bufferpool", 0,
153 gst_buffer_pool_init (GstBufferPool * pool)
155 GstBufferPoolPrivate *priv;
157 priv = pool->priv = GST_BUFFER_POOL_GET_PRIVATE (pool);
159 g_rec_mutex_init (&priv->rec_lock);
161 priv->poll = gst_poll_new_timer ();
162 priv->queue = gst_atomic_queue_new (16);
164 priv->active = FALSE;
165 priv->configured = FALSE;
166 priv->started = FALSE;
167 priv->config = gst_structure_new_id_empty (GST_QUARK (BUFFER_POOL_CONFIG));
168 gst_buffer_pool_config_set_params (priv->config, NULL, 0, 0, 0);
169 priv->allocator = NULL;
170 gst_allocation_params_init (&priv->params);
171 gst_buffer_pool_config_set_allocator (priv->config, priv->allocator,
173 /* 1 control write for flushing */
174 gst_poll_write_control (priv->poll);
175 /* 1 control write for marking that we are not waiting for poll */
176 gst_poll_write_control (priv->poll);
178 GST_DEBUG_OBJECT (pool, "created");
182 gst_buffer_pool_finalize (GObject * object)
185 GstBufferPoolPrivate *priv;
187 pool = GST_BUFFER_POOL_CAST (object);
190 GST_DEBUG_OBJECT (pool, "finalize");
192 gst_buffer_pool_set_active (pool, FALSE);
193 gst_atomic_queue_unref (priv->queue);
194 gst_poll_free (priv->poll);
195 gst_structure_free (priv->config);
196 g_rec_mutex_clear (&priv->rec_lock);
198 gst_object_unref (priv->allocator);
200 G_OBJECT_CLASS (gst_buffer_pool_parent_class)->finalize (object);
204 * gst_buffer_pool_new:
206 * Creates a new #GstBufferPool instance.
208 * Returns: (transfer floating): a new #GstBufferPool instance
211 gst_buffer_pool_new (void)
213 GstBufferPool *result;
215 result = g_object_newv (GST_TYPE_BUFFER_POOL, 0, NULL);
216 GST_DEBUG_OBJECT (result, "created new buffer pool");
222 default_alloc_buffer (GstBufferPool * pool, GstBuffer ** buffer,
223 GstBufferPoolAcquireParams * params)
225 GstBufferPoolPrivate *priv = pool->priv;
228 gst_buffer_new_allocate (priv->allocator, priv->size, &priv->params);
231 return GST_FLOW_ERROR;
237 mark_meta_pooled (GstBuffer * buffer, GstMeta ** meta, gpointer user_data)
239 GstBufferPool *pool = user_data;
241 GST_DEBUG_OBJECT (pool, "marking meta %p as POOLED in buffer %p", *meta,
243 GST_META_FLAG_SET (*meta, GST_META_FLAG_POOLED);
244 GST_META_FLAG_SET (*meta, GST_META_FLAG_LOCKED);
250 do_alloc_buffer (GstBufferPool * pool, GstBuffer ** buffer,
251 GstBufferPoolAcquireParams * params)
253 GstBufferPoolPrivate *priv = pool->priv;
254 GstFlowReturn result;
255 gint cur_buffers, max_buffers;
256 GstBufferPoolClass *pclass;
258 pclass = GST_BUFFER_POOL_GET_CLASS (pool);
260 if (G_UNLIKELY (!pclass->alloc_buffer))
263 max_buffers = priv->max_buffers;
265 /* increment the allocation counter */
266 cur_buffers = g_atomic_int_add (&priv->cur_buffers, 1);
267 if (max_buffers && cur_buffers >= max_buffers)
270 result = pclass->alloc_buffer (pool, buffer, params);
271 if (G_UNLIKELY (result != GST_FLOW_OK))
274 /* lock all metadata and mark as pooled, we want this to remain on
275 * the buffer and we want to remove any other metadata that gets added
277 gst_buffer_foreach_meta (*buffer, mark_meta_pooled, pool);
279 /* un-tag memory, this is how we expect the buffer when it is
281 GST_BUFFER_FLAG_UNSET (*buffer, GST_BUFFER_FLAG_TAG_MEMORY);
283 GST_LOG_OBJECT (pool, "allocated buffer %d/%d, %p", cur_buffers,
284 max_buffers, *buffer);
291 GST_ERROR_OBJECT (pool, "no alloc function");
292 return GST_FLOW_NOT_SUPPORTED;
296 GST_DEBUG_OBJECT (pool, "max buffers reached");
297 g_atomic_int_add (&priv->cur_buffers, -1);
302 GST_WARNING_OBJECT (pool, "alloc function failed");
303 g_atomic_int_add (&priv->cur_buffers, -1);
308 /* the default implementation for preallocating the buffers in the pool */
310 default_start (GstBufferPool * pool)
313 GstBufferPoolPrivate *priv = pool->priv;
314 GstBufferPoolClass *pclass;
316 pclass = GST_BUFFER_POOL_GET_CLASS (pool);
318 /* we need to prealloc buffers */
319 for (i = 0; i < priv->min_buffers; i++) {
322 if (do_alloc_buffer (pool, &buffer, NULL) != GST_FLOW_OK)
325 /* release to the queue, we call the vmethod directly, we don't need to do
326 * the other refcount handling right now. */
327 if (G_LIKELY (pclass->release_buffer))
328 pclass->release_buffer (pool, buffer);
335 GST_WARNING_OBJECT (pool, "failed to allocate buffer");
340 /* must be called with the lock */
342 do_start (GstBufferPool * pool)
344 GstBufferPoolPrivate *priv = pool->priv;
346 if (!priv->started) {
347 GstBufferPoolClass *pclass;
349 pclass = GST_BUFFER_POOL_GET_CLASS (pool);
351 GST_LOG_OBJECT (pool, "starting");
352 /* start the pool, subclasses should allocate buffers and put them
354 if (G_LIKELY (pclass->start)) {
355 if (!pclass->start (pool))
358 priv->started = TRUE;
364 default_free_buffer (GstBufferPool * pool, GstBuffer * buffer)
366 gst_buffer_unref (buffer);
370 do_free_buffer (GstBufferPool * pool, GstBuffer * buffer)
372 GstBufferPoolPrivate *priv;
373 GstBufferPoolClass *pclass;
376 pclass = GST_BUFFER_POOL_GET_CLASS (pool);
378 g_atomic_int_add (&priv->cur_buffers, -1);
379 GST_LOG_OBJECT (pool, "freeing buffer %p (%u left)", buffer,
382 if (G_LIKELY (pclass->free_buffer))
383 pclass->free_buffer (pool, buffer);
386 /* must be called with the lock */
388 default_stop (GstBufferPool * pool)
390 GstBufferPoolPrivate *priv = pool->priv;
394 while ((buffer = gst_atomic_queue_pop (priv->queue))) {
395 gst_poll_read_control (priv->poll);
396 do_free_buffer (pool, buffer);
398 return priv->cur_buffers == 0;
401 /* must be called with the lock */
403 do_stop (GstBufferPool * pool)
405 GstBufferPoolPrivate *priv = pool->priv;
408 GstBufferPoolClass *pclass;
410 pclass = GST_BUFFER_POOL_GET_CLASS (pool);
412 GST_LOG_OBJECT (pool, "stopping");
413 if (G_LIKELY (pclass->stop)) {
414 if (!pclass->stop (pool))
417 priv->started = FALSE;
422 /* must be called with the lock */
424 do_set_flushing (GstBufferPool * pool, gboolean flushing)
426 GstBufferPoolPrivate *priv = pool->priv;
427 GstBufferPoolClass *pclass;
429 pclass = GST_BUFFER_POOL_GET_CLASS (pool);
431 if (GST_BUFFER_POOL_IS_FLUSHING (pool) == flushing)
435 g_atomic_int_set (&pool->flushing, 1);
436 gst_poll_write_control (priv->poll);
438 if (pclass->flush_start)
439 pclass->flush_start (pool);
441 if (pclass->flush_stop)
442 pclass->flush_stop (pool);
444 gst_poll_read_control (priv->poll);
445 g_atomic_int_set (&pool->flushing, 0);
450 * gst_buffer_pool_set_active:
451 * @pool: a #GstBufferPool
452 * @active: the new active state
454 * Control the active state of @pool. When the pool is inactive, new calls to
455 * gst_buffer_pool_acquire_buffer() will return with %GST_FLOW_FLUSHING.
457 * Activating the bufferpool will preallocate all resources in the pool based on
458 * the configuration of the pool.
460 * Deactivating will free the resources again when there are no outstanding
461 * buffers. When there are outstanding buffers, they will be freed as soon as
462 * they are all returned to the pool.
464 * Returns: %FALSE when the pool was not configured or when preallocation of the
468 gst_buffer_pool_set_active (GstBufferPool * pool, gboolean active)
471 GstBufferPoolPrivate *priv;
473 g_return_val_if_fail (GST_IS_BUFFER_POOL (pool), FALSE);
475 GST_LOG_OBJECT (pool, "active %d", active);
479 GST_BUFFER_POOL_LOCK (pool);
480 /* just return if we are already in the right state */
481 if (priv->active == active)
484 /* we need to be configured */
485 if (!priv->configured)
489 if (!do_start (pool))
492 /* flush_stop my release buffers, setting to active to avoid running
493 * do_stop while activating the pool */
496 /* unset the flushing state now */
497 do_set_flushing (pool, FALSE);
501 /* set to flushing first */
502 do_set_flushing (pool, TRUE);
504 /* when all buffers are in the pool, free them. Else they will be
505 * freed when they are released */
506 outstanding = g_atomic_int_get (&priv->outstanding);
507 GST_LOG_OBJECT (pool, "outstanding buffers %d", outstanding);
508 if (outstanding == 0) {
513 priv->active = FALSE;
515 GST_BUFFER_POOL_UNLOCK (pool);
521 GST_DEBUG_OBJECT (pool, "pool was in the right state");
522 GST_BUFFER_POOL_UNLOCK (pool);
527 GST_ERROR_OBJECT (pool, "pool was not configured");
528 GST_BUFFER_POOL_UNLOCK (pool);
533 GST_ERROR_OBJECT (pool, "start failed");
534 GST_BUFFER_POOL_UNLOCK (pool);
539 GST_WARNING_OBJECT (pool, "stop failed");
540 GST_BUFFER_POOL_UNLOCK (pool);
546 * gst_buffer_pool_is_active:
547 * @pool: a #GstBufferPool
549 * Check if @pool is active. A pool can be activated with the
550 * gst_buffer_pool_set_active() call.
552 * Returns: %TRUE when the pool is active.
555 gst_buffer_pool_is_active (GstBufferPool * pool)
559 GST_BUFFER_POOL_LOCK (pool);
560 res = pool->priv->active;
561 GST_BUFFER_POOL_UNLOCK (pool);
567 default_set_config (GstBufferPool * pool, GstStructure * config)
569 GstBufferPoolPrivate *priv = pool->priv;
571 guint size, min_buffers, max_buffers;
572 GstAllocator *allocator;
573 GstAllocationParams params;
575 /* parse the config and keep around */
576 if (!gst_buffer_pool_config_get_params (config, &caps, &size, &min_buffers,
580 if (!gst_buffer_pool_config_get_allocator (config, &allocator, ¶ms))
583 GST_DEBUG_OBJECT (pool, "config %" GST_PTR_FORMAT, config);
586 priv->min_buffers = min_buffers;
587 priv->max_buffers = max_buffers;
588 priv->cur_buffers = 0;
591 gst_object_unref (priv->allocator);
592 if ((priv->allocator = allocator))
593 gst_object_ref (allocator);
594 priv->params = params;
600 GST_WARNING_OBJECT (pool, "invalid config %" GST_PTR_FORMAT, config);
606 * gst_buffer_pool_set_config:
607 * @pool: a #GstBufferPool
608 * @config: (transfer full): a #GstStructure
610 * Set the configuration of the pool. If the pool is already configured, and
611 * the configuration haven't change, this function will return %TRUE. If the
612 * pool is active, this function will try deactivating it. Buffers allocated
613 * form this pool must be returned or else this function will do nothing and
616 * @config is a #GstStructure that contains the configuration parameters for
617 * the pool. A default and mandatory set of parameters can be configured with
618 * gst_buffer_pool_config_set_params(), gst_buffer_pool_config_set_allocator()
619 * and gst_buffer_pool_config_add_option().
621 * If the parameters in @config can not be set exactly, this function returns
622 * %FALSE and will try to update as much state as possible. The new state can
623 * then be retrieved and refined with gst_buffer_pool_get_config().
625 * This function takes ownership of @config.
627 * Returns: %TRUE when the configuration could be set.
630 gst_buffer_pool_set_config (GstBufferPool * pool, GstStructure * config)
633 GstBufferPoolClass *pclass;
634 GstBufferPoolPrivate *priv;
636 g_return_val_if_fail (GST_IS_BUFFER_POOL (pool), FALSE);
637 g_return_val_if_fail (config != NULL, FALSE);
641 GST_BUFFER_POOL_LOCK (pool);
643 /* nothing to do if config is unchanged */
644 if (priv->configured && gst_structure_is_equal (config, priv->config))
645 goto config_unchanged;
647 /* can't change the settings when active */
649 GST_BUFFER_POOL_UNLOCK (pool);
650 if (!gst_buffer_pool_set_active (pool, FALSE)) {
651 GST_BUFFER_POOL_LOCK (pool);
654 GST_BUFFER_POOL_LOCK (pool);
656 /* not likely but as we released the lock */
661 /* we can't change when outstanding buffers */
662 if (g_atomic_int_get (&priv->outstanding) != 0)
663 goto have_outstanding;
665 pclass = GST_BUFFER_POOL_GET_CLASS (pool);
667 /* set the new config */
668 if (G_LIKELY (pclass->set_config))
669 result = pclass->set_config (pool, config);
673 /* save the config regardless of the result so user can read back the
674 * modified config and evaluate if the changes are acceptable */
676 gst_structure_free (priv->config);
677 priv->config = config;
680 /* now we are configured */
681 priv->configured = TRUE;
683 GST_BUFFER_POOL_UNLOCK (pool);
689 gst_structure_free (config);
690 GST_BUFFER_POOL_UNLOCK (pool);
696 gst_structure_free (config);
697 GST_WARNING_OBJECT (pool, "can't change config, we are active");
698 GST_BUFFER_POOL_UNLOCK (pool);
703 gst_structure_free (config);
704 GST_WARNING_OBJECT (pool, "can't change config, have outstanding buffers");
705 GST_BUFFER_POOL_UNLOCK (pool);
711 * gst_buffer_pool_get_config:
712 * @pool: a #GstBufferPool
714 * Get a copy of the current configuration of the pool. This configuration
715 * can either be modified and used for the gst_buffer_pool_set_config() call
716 * or it must be freed after usage.
718 * Returns: (transfer full): a copy of the current configuration of @pool. use
719 * gst_structure_free() after usage or gst_buffer_pool_set_config().
722 gst_buffer_pool_get_config (GstBufferPool * pool)
724 GstStructure *result;
726 g_return_val_if_fail (GST_IS_BUFFER_POOL (pool), NULL);
728 GST_BUFFER_POOL_LOCK (pool);
729 result = gst_structure_copy (pool->priv->config);
730 GST_BUFFER_POOL_UNLOCK (pool);
735 static const gchar *empty_option[] = { NULL };
738 * gst_buffer_pool_get_options:
739 * @pool: a #GstBufferPool
741 * Get a %NULL terminated array of string with supported bufferpool options for
742 * @pool. An option would typically be enabled with
743 * gst_buffer_pool_config_add_option().
745 * Returns: (array zero-terminated=1) (transfer none): a %NULL terminated array
749 gst_buffer_pool_get_options (GstBufferPool * pool)
751 GstBufferPoolClass *pclass;
752 const gchar **result;
754 g_return_val_if_fail (GST_IS_BUFFER_POOL (pool), NULL);
756 pclass = GST_BUFFER_POOL_GET_CLASS (pool);
758 if (G_LIKELY (pclass->get_options)) {
759 if ((result = pclass->get_options (pool)) == NULL)
762 result = empty_option;
769 g_warning ("bufferpool subclass returned NULL options");
775 * gst_buffer_pool_has_option:
776 * @pool: a #GstBufferPool
779 * Check if the bufferpool supports @option.
781 * Returns: %TRUE if the buffer pool contains @option.
784 gst_buffer_pool_has_option (GstBufferPool * pool, const gchar * option)
787 const gchar **options;
789 g_return_val_if_fail (GST_IS_BUFFER_POOL (pool), FALSE);
790 g_return_val_if_fail (option != NULL, FALSE);
792 options = gst_buffer_pool_get_options (pool);
794 for (i = 0; options[i]; i++) {
795 if (g_str_equal (options[i], option))
802 * gst_buffer_pool_config_set_params:
803 * @config: a #GstBufferPool configuration
804 * @caps: caps for the buffers
805 * @size: the size of each buffer, not including prefix and padding
806 * @min_buffers: the minimum amount of buffers to allocate.
807 * @max_buffers: the maximum amount of buffers to allocate or 0 for unlimited.
809 * Configure @config with the given parameters.
812 gst_buffer_pool_config_set_params (GstStructure * config, GstCaps * caps,
813 guint size, guint min_buffers, guint max_buffers)
815 g_return_if_fail (config != NULL);
816 g_return_if_fail (max_buffers == 0 || min_buffers <= max_buffers);
817 g_return_if_fail (caps == NULL || gst_caps_is_fixed (caps));
819 gst_structure_id_set (config,
820 GST_QUARK (CAPS), GST_TYPE_CAPS, caps,
821 GST_QUARK (SIZE), G_TYPE_UINT, size,
822 GST_QUARK (MIN_BUFFERS), G_TYPE_UINT, min_buffers,
823 GST_QUARK (MAX_BUFFERS), G_TYPE_UINT, max_buffers, NULL);
827 * gst_buffer_pool_config_set_allocator:
828 * @config: a #GstBufferPool configuration
829 * @allocator: (allow-none): a #GstAllocator
830 * @params: (allow-none): #GstAllocationParams
832 * Set the @allocator and @params on @config.
834 * One of @allocator and @params can be %NULL, but not both. When @allocator
835 * is %NULL, the default allocator of the pool will use the values in @param
836 * to perform its allocation. When @param is %NULL, the pool will use the
837 * provided @allocator with its default #GstAllocationParams.
839 * A call to gst_buffer_pool_set_config() can update the allocator and params
840 * with the values that it is able to do. Some pools are, for example, not able
841 * to operate with different allocators or cannot allocate with the values
842 * specified in @params. Use gst_buffer_pool_get_config() to get the currently
846 gst_buffer_pool_config_set_allocator (GstStructure * config,
847 GstAllocator * allocator, const GstAllocationParams * params)
849 g_return_if_fail (config != NULL);
850 g_return_if_fail (allocator != NULL || params != NULL);
852 gst_structure_id_set (config,
853 GST_QUARK (ALLOCATOR), GST_TYPE_ALLOCATOR, allocator,
854 GST_QUARK (PARAMS), GST_TYPE_ALLOCATION_PARAMS, params, NULL);
858 * gst_buffer_pool_config_add_option:
859 * @config: a #GstBufferPool configuration
860 * @option: an option to add
862 * Enabled the option in @config. This will instruct the @bufferpool to enable
863 * the specified option on the buffers that it allocates.
865 * The supported options by @pool can be retrieved with gst_buffer_pool_get_options().
868 gst_buffer_pool_config_add_option (GstStructure * config, const gchar * option)
871 GValue option_value = { 0, };
874 g_return_if_fail (config != NULL);
876 value = gst_structure_id_get_value (config, GST_QUARK (OPTIONS));
878 len = gst_value_array_get_size (value);
879 for (i = 0; i < len; ++i) {
880 const GValue *nth_val = gst_value_array_get_value (value, i);
882 if (g_str_equal (option, g_value_get_string (nth_val)))
886 GValue new_array_val = { 0, };
888 g_value_init (&new_array_val, GST_TYPE_ARRAY);
889 gst_structure_id_take_value (config, GST_QUARK (OPTIONS), &new_array_val);
890 value = gst_structure_id_get_value (config, GST_QUARK (OPTIONS));
892 g_value_init (&option_value, G_TYPE_STRING);
893 g_value_set_string (&option_value, option);
894 gst_value_array_append_and_take_value ((GValue *) value, &option_value);
898 * gst_buffer_pool_config_n_options:
899 * @config: a #GstBufferPool configuration
901 * Retrieve the number of values currently stored in the options array of the
904 * Returns: the options array size as a #guint.
907 gst_buffer_pool_config_n_options (GstStructure * config)
912 g_return_val_if_fail (config != NULL, 0);
914 value = gst_structure_id_get_value (config, GST_QUARK (OPTIONS));
916 size = gst_value_array_get_size (value);
922 * gst_buffer_pool_config_get_option:
923 * @config: a #GstBufferPool configuration
924 * @index: position in the option array to read
926 * Parse an available @config and get the option at @index of the options API
929 * Returns: a #gchar of the option at @index.
932 gst_buffer_pool_config_get_option (GstStructure * config, guint index)
935 const gchar *ret = NULL;
937 g_return_val_if_fail (config != NULL, 0);
939 value = gst_structure_id_get_value (config, GST_QUARK (OPTIONS));
941 const GValue *option_value;
943 option_value = gst_value_array_get_value (value, index);
945 ret = g_value_get_string (option_value);
951 * gst_buffer_pool_config_has_option:
952 * @config: a #GstBufferPool configuration
955 * Check if @config contains @option.
957 * Returns: %TRUE if the options array contains @option.
960 gst_buffer_pool_config_has_option (GstStructure * config, const gchar * option)
965 g_return_val_if_fail (config != NULL, 0);
967 value = gst_structure_id_get_value (config, GST_QUARK (OPTIONS));
969 len = gst_value_array_get_size (value);
970 for (i = 0; i < len; ++i) {
971 const GValue *nth_val = gst_value_array_get_value (value, i);
973 if (g_str_equal (option, g_value_get_string (nth_val)))
981 * gst_buffer_pool_config_get_params:
982 * @config: (transfer none): a #GstBufferPool configuration
983 * @caps: (out) (transfer none) (allow-none): the caps of buffers
984 * @size: (out) (allow-none): the size of each buffer, not including prefix and padding
985 * @min_buffers: (out) (allow-none): the minimum amount of buffers to allocate.
986 * @max_buffers: (out) (allow-none): the maximum amount of buffers to allocate or 0 for unlimited.
988 * Get the configuration values from @config.
990 * Returns: %TRUE if all parameters could be fetched.
993 gst_buffer_pool_config_get_params (GstStructure * config, GstCaps ** caps,
994 guint * size, guint * min_buffers, guint * max_buffers)
996 g_return_val_if_fail (config != NULL, FALSE);
999 *caps = g_value_get_boxed (gst_structure_id_get_value (config,
1002 return gst_structure_id_get (config,
1003 GST_QUARK (SIZE), G_TYPE_UINT, size,
1004 GST_QUARK (MIN_BUFFERS), G_TYPE_UINT, min_buffers,
1005 GST_QUARK (MAX_BUFFERS), G_TYPE_UINT, max_buffers, NULL);
1009 * gst_buffer_pool_config_get_allocator:
1010 * @config: (transfer none): a #GstBufferPool configuration
1011 * @allocator: (transfer none): a #GstAllocator
1012 * @params: #GstAllocationParams
1014 * Get the @allocator and @params from @config.
1016 * Returns: %TRUE, if the values are set.
1019 gst_buffer_pool_config_get_allocator (GstStructure * config,
1020 GstAllocator ** allocator, GstAllocationParams * params)
1022 g_return_val_if_fail (config != NULL, FALSE);
1025 *allocator = g_value_get_object (gst_structure_id_get_value (config,
1026 GST_QUARK (ALLOCATOR)));
1028 GstAllocationParams *p;
1030 p = g_value_get_boxed (gst_structure_id_get_value (config,
1031 GST_QUARK (PARAMS)));
1035 gst_allocation_params_init (params);
1042 * gst_buffer_pool_config_validate_params:
1043 * @config: (transfer none): a #GstBufferPool configuration
1044 * @caps: (transfer none): the excepted caps of buffers
1045 * @size: the expected size of each buffer, not including prefix and padding
1046 * @min_buffers: the expected minimum amount of buffers to allocate.
1047 * @max_buffers: the expect maximum amount of buffers to allocate or 0 for unlimited.
1049 * Validate that changes made to @config are still valid in the context of the
1050 * expected parameters. This function is a helper that can be used to validate
1051 * changes made by a pool to a config when gst_buffer_pool_set_config()
1052 * returns %FALSE. This expects that @caps and @size haven't changed, and that
1053 * @min_buffers aren't lower then what we initially expected. This does not check
1054 * if options or allocator parameters.
1058 * Returns: %TRUE, if the parameters are valid in this context.
1061 gst_buffer_pool_config_validate_params (GstStructure * config, GstCaps * caps,
1062 guint size, guint min_buffers, G_GNUC_UNUSED guint max_buffers)
1065 guint newsize, newmin;
1066 gboolean ret = FALSE;
1068 g_return_val_if_fail (config != NULL, FALSE);
1070 gst_buffer_pool_config_get_params (config, &newcaps, &newsize, &newmin, NULL);
1072 if (gst_caps_is_equal (caps, newcaps) && (size == newsize)
1073 && (newmin >= min_buffers))
1079 static GstFlowReturn
1080 default_acquire_buffer (GstBufferPool * pool, GstBuffer ** buffer,
1081 GstBufferPoolAcquireParams * params)
1083 GstFlowReturn result;
1084 GstBufferPoolPrivate *priv = pool->priv;
1087 if (G_UNLIKELY (GST_BUFFER_POOL_IS_FLUSHING (pool)))
1090 /* try to get a buffer from the queue */
1091 *buffer = gst_atomic_queue_pop (priv->queue);
1092 if (G_LIKELY (*buffer)) {
1093 gst_poll_read_control (priv->poll);
1094 result = GST_FLOW_OK;
1095 GST_LOG_OBJECT (pool, "acquired buffer %p", *buffer);
1099 /* no buffer, try to allocate some more */
1100 GST_LOG_OBJECT (pool, "no buffer, trying to allocate");
1101 result = do_alloc_buffer (pool, buffer, NULL);
1102 if (G_LIKELY (result == GST_FLOW_OK))
1103 /* we have a buffer, return it */
1106 if (G_UNLIKELY (result != GST_FLOW_EOS))
1107 /* something went wrong, return error */
1110 /* check if we need to wait */
1111 if (params && (params->flags & GST_BUFFER_POOL_ACQUIRE_FLAG_DONTWAIT)) {
1112 GST_LOG_OBJECT (pool, "no more buffers");
1116 /* now we release the control socket, we wait for a buffer release or
1118 gst_poll_read_control (pool->priv->poll);
1119 GST_LOG_OBJECT (pool, "waiting for free buffers or flushing");
1120 gst_poll_wait (priv->poll, GST_CLOCK_TIME_NONE);
1121 gst_poll_write_control (pool->priv->poll);
1129 GST_DEBUG_OBJECT (pool, "we are flushing");
1130 return GST_FLOW_FLUSHING;
1135 dec_outstanding (GstBufferPool * pool)
1137 if (g_atomic_int_dec_and_test (&pool->priv->outstanding)) {
1138 /* all buffers are returned to the pool, see if we need to free them */
1139 if (GST_BUFFER_POOL_IS_FLUSHING (pool)) {
1140 /* take the lock so that set_active is not run concurrently */
1141 GST_BUFFER_POOL_LOCK (pool);
1142 /* now that we have the lock, check if we have been de-activated with
1143 * outstanding buffers */
1144 if (!pool->priv->active)
1147 GST_BUFFER_POOL_UNLOCK (pool);
1153 remove_meta_unpooled (GstBuffer * buffer, GstMeta ** meta, gpointer user_data)
1155 if (!GST_META_FLAG_IS_SET (*meta, GST_META_FLAG_POOLED)) {
1156 GST_META_FLAG_UNSET (*meta, GST_META_FLAG_LOCKED);
1163 default_reset_buffer (GstBufferPool * pool, GstBuffer * buffer)
1165 GST_BUFFER_FLAGS (buffer) &= GST_BUFFER_FLAG_TAG_MEMORY;
1167 GST_BUFFER_PTS (buffer) = GST_CLOCK_TIME_NONE;
1168 GST_BUFFER_DTS (buffer) = GST_CLOCK_TIME_NONE;
1169 GST_BUFFER_DURATION (buffer) = GST_CLOCK_TIME_NONE;
1170 GST_BUFFER_OFFSET (buffer) = GST_BUFFER_OFFSET_NONE;
1171 GST_BUFFER_OFFSET_END (buffer) = GST_BUFFER_OFFSET_NONE;
1173 /* remove all metadata without the POOLED flag */
1174 gst_buffer_foreach_meta (buffer, remove_meta_unpooled, pool);
1178 * gst_buffer_pool_acquire_buffer:
1179 * @pool: a #GstBufferPool
1180 * @buffer: (out): a location for a #GstBuffer
1181 * @params: (transfer none) (allow-none): parameters.
1183 * Acquire a buffer from @pool. @buffer should point to a memory location that
1184 * can hold a pointer to the new buffer.
1186 * @params can be %NULL or contain optional parameters to influence the
1189 * Returns: a #GstFlowReturn such as %GST_FLOW_FLUSHING when the pool is
1193 gst_buffer_pool_acquire_buffer (GstBufferPool * pool, GstBuffer ** buffer,
1194 GstBufferPoolAcquireParams * params)
1196 GstBufferPoolClass *pclass;
1197 GstFlowReturn result;
1199 g_return_val_if_fail (GST_IS_BUFFER_POOL (pool), GST_FLOW_ERROR);
1200 g_return_val_if_fail (buffer != NULL, GST_FLOW_ERROR);
1202 pclass = GST_BUFFER_POOL_GET_CLASS (pool);
1204 /* assume we'll have one more outstanding buffer we need to do that so
1205 * that concurrent set_active doesn't clear the buffers */
1206 g_atomic_int_inc (&pool->priv->outstanding);
1208 if (G_LIKELY (pclass->acquire_buffer))
1209 result = pclass->acquire_buffer (pool, buffer, params);
1211 result = GST_FLOW_NOT_SUPPORTED;
1213 if (G_LIKELY (result == GST_FLOW_OK)) {
1214 /* all buffers from the pool point to the pool and have the refcount of the
1215 * pool incremented */
1216 (*buffer)->pool = gst_object_ref (pool);
1218 dec_outstanding (pool);
1225 default_release_buffer (GstBufferPool * pool, GstBuffer * buffer)
1227 GST_LOG_OBJECT (pool, "released buffer %p %d", buffer,
1228 GST_MINI_OBJECT_FLAGS (buffer));
1230 /* memory should be untouched */
1231 if (G_UNLIKELY (GST_BUFFER_FLAG_IS_SET (buffer, GST_BUFFER_FLAG_TAG_MEMORY)))
1234 /* size should have been reset. This is not a catch all, pool with
1235 * size requirement per memory should do their own check. */
1236 if (G_UNLIKELY (gst_buffer_get_size (buffer) != pool->priv->size))
1239 /* all memory should be exclusive to this buffer (and thus be writable) */
1240 if (G_UNLIKELY (!gst_buffer_is_all_memory_writable (buffer)))
1243 /* keep it around in our queue */
1244 gst_atomic_queue_push (pool->priv->queue, buffer);
1245 gst_poll_write_control (pool->priv->poll);
1251 GST_CAT_DEBUG_OBJECT (GST_CAT_PERFORMANCE, pool,
1252 "discarding buffer %p: memory tag set", buffer);
1257 GST_CAT_DEBUG_OBJECT (GST_CAT_PERFORMANCE, pool,
1258 "discarding buffer %p: size %" G_GSIZE_FORMAT " != %u",
1259 buffer, gst_buffer_get_size (buffer), pool->priv->size);
1264 GST_CAT_DEBUG_OBJECT (GST_CAT_PERFORMANCE, pool,
1265 "discarding buffer %p: memory not writable", buffer);
1270 do_free_buffer (pool, buffer);
1276 * gst_buffer_pool_release_buffer:
1277 * @pool: a #GstBufferPool
1278 * @buffer: (transfer full): a #GstBuffer
1280 * Release @buffer to @pool. @buffer should have previously been allocated from
1281 * @pool with gst_buffer_pool_acquire_buffer().
1283 * This function is usually called automatically when the last ref on @buffer
1287 gst_buffer_pool_release_buffer (GstBufferPool * pool, GstBuffer * buffer)
1289 GstBufferPoolClass *pclass;
1291 g_return_if_fail (GST_IS_BUFFER_POOL (pool));
1292 g_return_if_fail (buffer != NULL);
1294 /* check that the buffer is ours, all buffers returned to the pool have the
1295 * pool member set to NULL and the pool refcount decreased */
1296 if (!g_atomic_pointer_compare_and_exchange (&buffer->pool, pool, NULL))
1299 pclass = GST_BUFFER_POOL_GET_CLASS (pool);
1301 /* reset the buffer when needed */
1302 if (G_LIKELY (pclass->reset_buffer))
1303 pclass->reset_buffer (pool, buffer);
1305 if (G_LIKELY (pclass->release_buffer))
1306 pclass->release_buffer (pool, buffer);
1308 dec_outstanding (pool);
1310 /* decrease the refcount that the buffer had to us */
1311 gst_object_unref (pool);
1315 * gst_buffer_pool_set_flushing:
1316 * @pool: a #GstBufferPool
1317 * @flushing: whether to start or stop flushing
1319 * Enable or disable the flushing state of a @pool without freeing or
1320 * allocating buffers.
1325 gst_buffer_pool_set_flushing (GstBufferPool * pool, gboolean flushing)
1327 GstBufferPoolPrivate *priv;
1329 g_return_if_fail (GST_IS_BUFFER_POOL (pool));
1331 GST_LOG_OBJECT (pool, "flushing %d", flushing);
1335 GST_BUFFER_POOL_LOCK (pool);
1337 if (!priv->active) {
1338 GST_WARNING_OBJECT (pool, "can't change flushing state of inactive pool");
1342 do_set_flushing (pool, flushing);
1345 GST_BUFFER_POOL_UNLOCK (pool);