gst/gstbufferpool.c

   1 /* GStreamer
   2  * Copyright (C) 2010 Wim Taymans <wim.taymans@gmail.com>
   3  *
   4  * gstbufferpool.c: GstBufferPool baseclass
   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., 51 Franklin St, Fifth Floor,
  19  * Boston, MA 02110-1301, USA.
  20  */
  21
  22 /**
  23  * SECTION:gstbufferpool
  24  * @short_description: Pool for buffers
  25  * @see_also: #GstBuffer
  26  *
  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.
  29  *
  30  * A #GstBufferPool is created with gst_buffer_pool_new().
  31  *
  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.
  38  *
  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.
  43  *
  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.
  47  *
  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
  50  * in the pool.
  51  *
  52  * When the pool is active, gst_buffer_pool_acquire_buffer() can be used to
  53  * retrieve a buffer from the pool.
  54  *
  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.
  57  *
  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.
  61  *
  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.
  64  */
  65
  66 #include "gst_private.h"
  67 #include "glib-compat-private.h"
  68
  69 #include <errno.h>
  70 #ifdef HAVE_UNISTD_H
  71 #  include <unistd.h>
  72 #endif
  73 #include <sys/types.h>
  74
  75 #include "gstatomicqueue.h"
  76 #include "gstpoll.h"
  77 #include "gstinfo.h"
  78 #include "gstquark.h"
  79 #include "gstvalue.h"
  80
  81 #include "gstbufferpool.h"
  82
  83 GST_DEBUG_CATEGORY_STATIC (gst_buffer_pool_debug);
  84 #define GST_CAT_DEFAULT gst_buffer_pool_debug
  85
  86 #define GST_BUFFER_POOL_GET_PRIVATE(obj)  \
  87    (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GST_TYPE_BUFFER_POOL, GstBufferPoolPrivate))
  88
  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))
  91
  92 struct _GstBufferPoolPrivate
  93 {
  94   GstAtomicQueue *queue;
  95   GstPoll *poll;
  96
  97   GRecMutex rec_lock;
  98
  99   gboolean started;
 100   gboolean active;
 101   gint outstanding;             /* number of buffers that are in use */
 102
 103   gboolean configured;
 104   GstStructure *config;
 105
 106   guint size;
 107   guint min_buffers;
 108   guint max_buffers;
 109   guint cur_buffers;
 110   GstAllocator *allocator;
 111   GstAllocationParams params;
 112 };
 113
 114 static void gst_buffer_pool_finalize (GObject * object);
 115
 116 G_DEFINE_TYPE (GstBufferPool, gst_buffer_pool, GST_TYPE_OBJECT);
 117
 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);
 129
 130 static void
 131 gst_buffer_pool_class_init (GstBufferPoolClass * klass)
 132 {
 133   GObjectClass *gobject_class = (GObjectClass *) klass;
 134
 135   g_type_class_add_private (klass, sizeof (GstBufferPoolPrivate));
 136
 137   gobject_class->finalize = gst_buffer_pool_finalize;
 138
 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;
 147
 148   GST_DEBUG_CATEGORY_INIT (gst_buffer_pool_debug, "bufferpool", 0,
 149       "bufferpool debug");
 150 }
 151
 152 static void
 153 gst_buffer_pool_init (GstBufferPool * pool)
 154 {
 155   GstBufferPoolPrivate *priv;
 156
 157   priv = pool->priv = GST_BUFFER_POOL_GET_PRIVATE (pool);
 158
 159   g_rec_mutex_init (&priv->rec_lock);
 160
 161   priv->poll = gst_poll_new_timer ();
 162   priv->queue = gst_atomic_queue_new (16);
 163   pool->flushing = 1;
 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,
 172       &priv->params);
 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);
 177
 178   GST_DEBUG_OBJECT (pool, "created");
 179 }
 180
 181 static void
 182 gst_buffer_pool_finalize (GObject * object)
 183 {
 184   GstBufferPool *pool;
 185   GstBufferPoolPrivate *priv;
 186
 187   pool = GST_BUFFER_POOL_CAST (object);
 188   priv = pool->priv;
 189
 190   GST_DEBUG_OBJECT (pool, "finalize");
 191
 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);
 197   if (priv->allocator)
 198     gst_object_unref (priv->allocator);
 199
 200   G_OBJECT_CLASS (gst_buffer_pool_parent_class)->finalize (object);
 201 }
 202
 203 /**
 204  * gst_buffer_pool_new:
 205  *
 206  * Creates a new #GstBufferPool instance.
 207  *
 208  * Returns: (transfer floating): a new #GstBufferPool instance
 209  */
 210 GstBufferPool *
 211 gst_buffer_pool_new (void)
 212 {
 213   GstBufferPool *result;
 214
 215   result = g_object_newv (GST_TYPE_BUFFER_POOL, 0, NULL);
 216   GST_DEBUG_OBJECT (result, "created new buffer pool");
 217
 218   return result;
 219 }
 220
 221 static GstFlowReturn
 222 default_alloc_buffer (GstBufferPool * pool, GstBuffer ** buffer,
 223     GstBufferPoolAcquireParams * params)
 224 {
 225   GstBufferPoolPrivate *priv = pool->priv;
 226
 227   *buffer =
 228       gst_buffer_new_allocate (priv->allocator, priv->size, &priv->params);
 229
 230   return GST_FLOW_OK;
 231 }
 232
 233 static gboolean
 234 mark_meta_pooled (GstBuffer * buffer, GstMeta ** meta, gpointer user_data)
 235 {
 236   GstBufferPool *pool = user_data;
 237
 238   GST_DEBUG_OBJECT (pool, "marking meta %p as POOLED in buffer %p", *meta,
 239       buffer);
 240   GST_META_FLAG_SET (*meta, GST_META_FLAG_POOLED);
 241   GST_META_FLAG_SET (*meta, GST_META_FLAG_LOCKED);
 242
 243   return TRUE;
 244 }
 245
 246 static GstFlowReturn
 247 do_alloc_buffer (GstBufferPool * pool, GstBuffer ** buffer,
 248     GstBufferPoolAcquireParams * params)
 249 {
 250   GstBufferPoolPrivate *priv = pool->priv;
 251   GstFlowReturn result;
 252   gint cur_buffers, max_buffers;
 253   GstBufferPoolClass *pclass;
 254
 255   pclass = GST_BUFFER_POOL_GET_CLASS (pool);
 256
 257   if (G_UNLIKELY (!pclass->alloc_buffer))
 258     goto no_function;
 259
 260   max_buffers = priv->max_buffers;
 261
 262   /* increment the allocation counter */
 263   cur_buffers = g_atomic_int_add (&priv->cur_buffers, 1);
 264   if (max_buffers && cur_buffers >= max_buffers)
 265     goto max_reached;
 266
 267   result = pclass->alloc_buffer (pool, buffer, params);
 268   if (G_UNLIKELY (result != GST_FLOW_OK))
 269     goto alloc_failed;
 270
 271   /* lock all metadata and mark as pooled, we want this to remain on
 272    * the buffer and we want to remove any other metadata that gets added
 273    * later */
 274   gst_buffer_foreach_meta (*buffer, mark_meta_pooled, pool);
 275
 276   /* un-tag memory, this is how we expect the buffer when it is
 277    * released again */
 278   GST_BUFFER_FLAG_UNSET (*buffer, GST_BUFFER_FLAG_TAG_MEMORY);
 279
 280   GST_LOG_OBJECT (pool, "allocated buffer %d/%d, %p", cur_buffers,
 281       max_buffers, *buffer);
 282
 283   return result;
 284
 285   /* ERRORS */
 286 no_function:
 287   {
 288     GST_ERROR_OBJECT (pool, "no alloc function");
 289     return GST_FLOW_NOT_SUPPORTED;
 290   }
 291 max_reached:
 292   {
 293     GST_DEBUG_OBJECT (pool, "max buffers reached");
 294     g_atomic_int_add (&priv->cur_buffers, -1);
 295     return GST_FLOW_EOS;
 296   }
 297 alloc_failed:
 298   {
 299     GST_WARNING_OBJECT (pool, "alloc function failed");
 300     g_atomic_int_add (&priv->cur_buffers, -1);
 301     return result;
 302   }
 303 }
 304
 305 /* the default implementation for preallocating the buffers in the pool */
 306 static gboolean
 307 default_start (GstBufferPool * pool)
 308 {
 309   guint i;
 310   GstBufferPoolPrivate *priv = pool->priv;
 311   GstBufferPoolClass *pclass;
 312
 313   pclass = GST_BUFFER_POOL_GET_CLASS (pool);
 314
 315   /* we need to prealloc buffers */
 316   for (i = 0; i < priv->min_buffers; i++) {
 317     GstBuffer *buffer;
 318
 319     if (do_alloc_buffer (pool, &buffer, NULL) != GST_FLOW_OK)
 320       goto alloc_failed;
 321
 322     /* release to the queue, we call the vmethod directly, we don't need to do
 323      * the other refcount handling right now. */
 324     if (G_LIKELY (pclass->release_buffer))
 325       pclass->release_buffer (pool, buffer);
 326   }
 327   return TRUE;
 328
 329   /* ERRORS */
 330 alloc_failed:
 331   {
 332     GST_WARNING_OBJECT (pool, "failed to allocate buffer");
 333     return FALSE;
 334   }
 335 }
 336
 337 /* must be called with the lock */
 338 static gboolean
 339 do_start (GstBufferPool * pool)
 340 {
 341   GstBufferPoolPrivate *priv = pool->priv;
 342
 343   if (!priv->started) {
 344     GstBufferPoolClass *pclass;
 345
 346     pclass = GST_BUFFER_POOL_GET_CLASS (pool);
 347
 348     GST_LOG_OBJECT (pool, "starting");
 349     /* start the pool, subclasses should allocate buffers and put them
 350      * in the queue */
 351     if (G_LIKELY (pclass->start)) {
 352       if (!pclass->start (pool))
 353         return FALSE;
 354     }
 355     priv->started = TRUE;
 356   }
 357   return TRUE;
 358 }
 359
 360 static void
 361 default_free_buffer (GstBufferPool * pool, GstBuffer * buffer)
 362 {
 363   gst_buffer_unref (buffer);
 364 }
 365
 366 static void
 367 do_free_buffer (GstBufferPool * pool, GstBuffer * buffer)
 368 {
 369   GstBufferPoolPrivate *priv;
 370   GstBufferPoolClass *pclass;
 371
 372   priv = pool->priv;
 373   pclass = GST_BUFFER_POOL_GET_CLASS (pool);
 374
 375   g_atomic_int_add (&priv->cur_buffers, -1);
 376   GST_LOG_OBJECT (pool, "freeing buffer %p (%u left)", buffer,
 377       priv->cur_buffers);
 378
 379   if (G_LIKELY (pclass->free_buffer))
 380     pclass->free_buffer (pool, buffer);
 381 }
 382
 383 /* must be called with the lock */
 384 static gboolean
 385 default_stop (GstBufferPool * pool)
 386 {
 387   GstBufferPoolPrivate *priv = pool->priv;
 388   GstBuffer *buffer;
 389
 390   /* clear the pool */
 391   while ((buffer = gst_atomic_queue_pop (priv->queue))) {
 392     gst_poll_read_control (priv->poll);
 393     do_free_buffer (pool, buffer);
 394   }
 395   return priv->cur_buffers == 0;
 396 }
 397
 398 /* must be called with the lock */
 399 static gboolean
 400 do_stop (GstBufferPool * pool)
 401 {
 402   GstBufferPoolPrivate *priv = pool->priv;
 403
 404   if (priv->started) {
 405     GstBufferPoolClass *pclass;
 406
 407     pclass = GST_BUFFER_POOL_GET_CLASS (pool);
 408
 409     GST_LOG_OBJECT (pool, "stopping");
 410     if (G_LIKELY (pclass->stop)) {
 411       if (!pclass->stop (pool))
 412         return FALSE;
 413     }
 414     priv->started = FALSE;
 415   }
 416   return TRUE;
 417 }
 418
 419 /* must be called with the lock */
 420 static void
 421 do_set_flushing (GstBufferPool * pool, gboolean flushing)
 422 {
 423   GstBufferPoolPrivate *priv = pool->priv;
 424   GstBufferPoolClass *pclass;
 425
 426   pclass = GST_BUFFER_POOL_GET_CLASS (pool);
 427
 428   if (GST_BUFFER_POOL_IS_FLUSHING (pool) == flushing)
 429     return;
 430
 431   if (flushing) {
 432     g_atomic_int_set (&pool->flushing, 1);
 433     gst_poll_write_control (priv->poll);
 434
 435     if (pclass->flush_start)
 436       pclass->flush_start (pool);
 437   } else {
 438     if (pclass->flush_stop)
 439       pclass->flush_stop (pool);
 440
 441     gst_poll_read_control (priv->poll);
 442     g_atomic_int_set (&pool->flushing, 0);
 443   }
 444 }
 445
 446 /**
 447  * gst_buffer_pool_set_active:
 448  * @pool: a #GstBufferPool
 449  * @active: the new active state
 450  *
 451  * Control the active state of @pool. When the pool is inactive, new calls to
 452  * gst_buffer_pool_acquire_buffer() will return with %GST_FLOW_FLUSHING.
 453  *
 454  * Activating the bufferpool will preallocate all resources in the pool based on
 455  * the configuration of the pool.
 456  *
 457  * Deactivating will free the resources again when there are no outstanding
 458  * buffers. When there are outstanding buffers, they will be freed as soon as
 459  * they are all returned to the pool.
 460  *
 461  * Returns: %FALSE when the pool was not configured or when preallocation of the
 462  * buffers failed.
 463  */
 464 gboolean
 465 gst_buffer_pool_set_active (GstBufferPool * pool, gboolean active)
 466 {
 467   gboolean res = TRUE;
 468   GstBufferPoolPrivate *priv;
 469
 470   g_return_val_if_fail (GST_IS_BUFFER_POOL (pool), FALSE);
 471
 472   GST_LOG_OBJECT (pool, "active %d", active);
 473
 474   priv = pool->priv;
 475
 476   GST_BUFFER_POOL_LOCK (pool);
 477   /* just return if we are already in the right state */
 478   if (priv->active == active)
 479     goto was_ok;
 480
 481   /* we need to be configured */
 482   if (!priv->configured)
 483     goto not_configured;
 484
 485   if (active) {
 486     if (!do_start (pool))
 487       goto start_failed;
 488
 489     /* flush_stop my release buffers, setting to active to avoid running
 490      * do_stop while activating the pool */
 491     priv->active = TRUE;
 492
 493     /* unset the flushing state now */
 494     do_set_flushing (pool, FALSE);
 495   } else {
 496     gint outstanding;
 497
 498     /* set to flushing first */
 499     do_set_flushing (pool, TRUE);
 500
 501     /* when all buffers are in the pool, free them. Else they will be
 502      * freed when they are released */
 503     outstanding = g_atomic_int_get (&priv->outstanding);
 504     GST_LOG_OBJECT (pool, "outstanding buffers %d", outstanding);
 505     if (outstanding == 0) {
 506       if (!do_stop (pool))
 507         goto stop_failed;
 508     }
 509
 510     priv->active = FALSE;
 511   }
 512   GST_BUFFER_POOL_UNLOCK (pool);
 513
 514   return res;
 515
 516 was_ok:
 517   {
 518     GST_DEBUG_OBJECT (pool, "pool was in the right state");
 519     GST_BUFFER_POOL_UNLOCK (pool);
 520     return TRUE;
 521   }
 522 not_configured:
 523   {
 524     GST_ERROR_OBJECT (pool, "pool was not configured");
 525     GST_BUFFER_POOL_UNLOCK (pool);
 526     return FALSE;
 527   }
 528 start_failed:
 529   {
 530     GST_ERROR_OBJECT (pool, "start failed");
 531     GST_BUFFER_POOL_UNLOCK (pool);
 532     return FALSE;
 533   }
 534 stop_failed:
 535   {
 536     GST_WARNING_OBJECT (pool, "stop failed");
 537     GST_BUFFER_POOL_UNLOCK (pool);
 538     return FALSE;
 539   }
 540 }
 541
 542 /**
 543  * gst_buffer_pool_is_active:
 544  * @pool: a #GstBufferPool
 545  *
 546  * Check if @pool is active. A pool can be activated with the
 547  * gst_buffer_pool_set_active() call.
 548  *
 549  * Returns: %TRUE when the pool is active.
 550  */
 551 gboolean
 552 gst_buffer_pool_is_active (GstBufferPool * pool)
 553 {
 554   gboolean res;
 555
 556   GST_BUFFER_POOL_LOCK (pool);
 557   res = pool->priv->active;
 558   GST_BUFFER_POOL_UNLOCK (pool);
 559
 560   return res;
 561 }
 562
 563 static gboolean
 564 default_set_config (GstBufferPool * pool, GstStructure * config)
 565 {
 566   GstBufferPoolPrivate *priv = pool->priv;
 567   GstCaps *caps;
 568   guint size, min_buffers, max_buffers;
 569   GstAllocator *allocator;
 570   GstAllocationParams params;
 571
 572   /* parse the config and keep around */
 573   if (!gst_buffer_pool_config_get_params (config, &caps, &size, &min_buffers,
 574           &max_buffers))
 575     goto wrong_config;
 576
 577   if (!gst_buffer_pool_config_get_allocator (config, &allocator, &params))
 578     goto wrong_config;
 579
 580   GST_DEBUG_OBJECT (pool, "config %" GST_PTR_FORMAT, config);
 581
 582   priv->size = size;
 583   priv->min_buffers = min_buffers;
 584   priv->max_buffers = max_buffers;
 585   priv->cur_buffers = 0;
 586
 587   if (priv->allocator)
 588     gst_object_unref (priv->allocator);
 589   if ((priv->allocator = allocator))
 590     gst_object_ref (allocator);
 591   priv->params = params;
 592
 593   return TRUE;
 594
 595 wrong_config:
 596   {
 597     GST_WARNING_OBJECT (pool, "invalid config %" GST_PTR_FORMAT, config);
 598     return FALSE;
 599   }
 600 }
 601
 602 /**
 603  * gst_buffer_pool_set_config:
 604  * @pool: a #GstBufferPool
 605  * @config: (transfer full): a #GstStructure
 606  *
 607  * Set the configuration of the pool. If the pool is already configured, and
 608  * the configuration haven't change, this function will return %TRUE. If the
 609  * pool is active, this function will try deactivating it. Buffers allocated
 610  * form this pool must be returned or else this function will do nothing and
 611  * return %FALSE.
 612  *
 613  * @config is a #GstStructure that contains the configuration parameters for
 614  * the pool. A default and mandatory set of parameters can be configured with
 615  * gst_buffer_pool_config_set_params(), gst_buffer_pool_config_set_allocator()
 616  * and gst_buffer_pool_config_add_option().
 617  *
 618  * If the parameters in @config can not be set exactly, this function returns
 619  * %FALSE and will try to update as much state as possible. The new state can
 620  * then be retrieved and refined with gst_buffer_pool_get_config().
 621  *
 622  * This function takes ownership of @config.
 623  *
 624  * Returns: %TRUE when the configuration could be set.
 625  */
 626 gboolean
 627 gst_buffer_pool_set_config (GstBufferPool * pool, GstStructure * config)
 628 {
 629   gboolean result;
 630   GstBufferPoolClass *pclass;
 631   GstBufferPoolPrivate *priv;
 632
 633   g_return_val_if_fail (GST_IS_BUFFER_POOL (pool), FALSE);
 634   g_return_val_if_fail (config != NULL, FALSE);
 635
 636   priv = pool->priv;
 637
 638   GST_BUFFER_POOL_LOCK (pool);
 639
 640   /* nothing to do if config is unchanged */
 641   if (priv->configured && gst_structure_is_equal (config, priv->config))
 642     goto config_unchanged;
 643
 644   /* can't change the settings when active */
 645   if (priv->active) {
 646     GST_BUFFER_POOL_UNLOCK (pool);
 647     if (!gst_buffer_pool_set_active (pool, FALSE)) {
 648       GST_BUFFER_POOL_LOCK (pool);
 649       goto was_active;
 650     }
 651     GST_BUFFER_POOL_LOCK (pool);
 652
 653     /* not likely but as we released the lock */
 654     if (priv->active)
 655       goto was_active;
 656   }
 657
 658   /* we can't change when outstanding buffers */
 659   if (g_atomic_int_get (&priv->outstanding) != 0)
 660     goto have_outstanding;
 661
 662   pclass = GST_BUFFER_POOL_GET_CLASS (pool);
 663
 664   /* set the new config */
 665   if (G_LIKELY (pclass->set_config))
 666     result = pclass->set_config (pool, config);
 667   else
 668     result = FALSE;
 669
 670   /* save the config regardless of the result so user can read back the
 671    * modified config and evaluate if the changes are acceptable */
 672   if (priv->config)
 673     gst_structure_free (priv->config);
 674   priv->config = config;
 675
 676   if (result) {
 677     /* now we are configured */
 678     priv->configured = TRUE;
 679   }
 680   GST_BUFFER_POOL_UNLOCK (pool);
 681
 682   return result;
 683
 684 config_unchanged:
 685   {
 686     gst_structure_free (config);
 687     GST_BUFFER_POOL_UNLOCK (pool);
 688     return TRUE;
 689   }
 690   /* ERRORS */
 691 was_active:
 692   {
 693     gst_structure_free (config);
 694     GST_WARNING_OBJECT (pool, "can't change config, we are active");
 695     GST_BUFFER_POOL_UNLOCK (pool);
 696     return FALSE;
 697   }
 698 have_outstanding:
 699   {
 700     gst_structure_free (config);
 701     GST_WARNING_OBJECT (pool, "can't change config, have outstanding buffers");
 702     GST_BUFFER_POOL_UNLOCK (pool);
 703     return FALSE;
 704   }
 705 }
 706
 707 /**
 708  * gst_buffer_pool_get_config:
 709  * @pool: a #GstBufferPool
 710  *
 711  * Get a copy of the current configuration of the pool. This configuration
 712  * can either be modified and used for the gst_buffer_pool_set_config() call
 713  * or it must be freed after usage.
 714  *
 715  * Returns: (transfer full): a copy of the current configuration of @pool. use
 716  * gst_structure_free() after usage or gst_buffer_pool_set_config().
 717  */
 718 GstStructure *
 719 gst_buffer_pool_get_config (GstBufferPool * pool)
 720 {
 721   GstStructure *result;
 722
 723   g_return_val_if_fail (GST_IS_BUFFER_POOL (pool), NULL);
 724
 725   GST_BUFFER_POOL_LOCK (pool);
 726   result = gst_structure_copy (pool->priv->config);
 727   GST_BUFFER_POOL_UNLOCK (pool);
 728
 729   return result;
 730 }
 731
 732 static const gchar *empty_option[] = { NULL };
 733
 734 /**
 735  * gst_buffer_pool_get_options:
 736  * @pool: a #GstBufferPool
 737  *
 738  * Get a %NULL terminated array of string with supported bufferpool options for
 739  * @pool. An option would typically be enabled with
 740  * gst_buffer_pool_config_add_option().
 741  *
 742  * Returns: (array zero-terminated=1) (transfer none): a %NULL terminated array
 743  *          of strings.
 744  */
 745 const gchar **
 746 gst_buffer_pool_get_options (GstBufferPool * pool)
 747 {
 748   GstBufferPoolClass *pclass;
 749   const gchar **result;
 750
 751   g_return_val_if_fail (GST_IS_BUFFER_POOL (pool), NULL);
 752
 753   pclass = GST_BUFFER_POOL_GET_CLASS (pool);
 754
 755   if (G_LIKELY (pclass->get_options)) {
 756     if ((result = pclass->get_options (pool)) == NULL)
 757       goto invalid_result;
 758   } else
 759     result = empty_option;
 760
 761   return result;
 762
 763   /* ERROR */
 764 invalid_result:
 765   {
 766     g_warning ("bufferpool subclass returned NULL options");
 767     return empty_option;
 768   }
 769 }
 770
 771 /**
 772  * gst_buffer_pool_has_option:
 773  * @pool: a #GstBufferPool
 774  * @option: an option
 775  *
 776  * Check if the bufferpool supports @option.
 777  *
 778  * Returns: %TRUE if the buffer pool contains @option.
 779  */
 780 gboolean
 781 gst_buffer_pool_has_option (GstBufferPool * pool, const gchar * option)
 782 {
 783   guint i;
 784   const gchar **options;
 785
 786   g_return_val_if_fail (GST_IS_BUFFER_POOL (pool), FALSE);
 787   g_return_val_if_fail (option != NULL, FALSE);
 788
 789   options = gst_buffer_pool_get_options (pool);
 790
 791   for (i = 0; options[i]; i++) {
 792     if (g_str_equal (options[i], option))
 793       return TRUE;
 794   }
 795   return FALSE;
 796 }
 797
 798 /**
 799  * gst_buffer_pool_config_set_params:
 800  * @config: a #GstBufferPool configuration
 801  * @caps: caps for the buffers
 802  * @size: the size of each buffer, not including prefix and padding
 803  * @min_buffers: the minimum amount of buffers to allocate.
 804  * @max_buffers: the maximum amount of buffers to allocate or 0 for unlimited.
 805  *
 806  * Configure @config with the given parameters.
 807  */
 808 void
 809 gst_buffer_pool_config_set_params (GstStructure * config, GstCaps * caps,
 810     guint size, guint min_buffers, guint max_buffers)
 811 {
 812   g_return_if_fail (config != NULL);
 813   g_return_if_fail (max_buffers == 0 || min_buffers <= max_buffers);
 814   g_return_if_fail (caps == NULL || gst_caps_is_fixed (caps));
 815
 816   gst_structure_id_set (config,
 817       GST_QUARK (CAPS), GST_TYPE_CAPS, caps,
 818       GST_QUARK (SIZE), G_TYPE_UINT, size,
 819       GST_QUARK (MIN_BUFFERS), G_TYPE_UINT, min_buffers,
 820       GST_QUARK (MAX_BUFFERS), G_TYPE_UINT, max_buffers, NULL);
 821 }
 822
 823 /**
 824  * gst_buffer_pool_config_set_allocator:
 825  * @config: a #GstBufferPool configuration
 826  * @allocator: a #GstAllocator
 827  * @params: #GstAllocationParams
 828  *
 829  * Set the @allocator and @params on @config.
 830  *
 831  * One of @allocator and @params can be %NULL, but not both. When @allocator
 832  * is %NULL, the default allocator of the pool will use the values in @param
 833  * to perform its allocation. When @param is %NULL, the pool will use the
 834  * provided @allocator with its default #GstAllocationParams.
 835  *
 836  * A call to gst_buffer_pool_set_config() can update the allocator and params
 837  * with the values that it is able to do. Some pools are, for example, not able
 838  * to operate with different allocators or cannot allocate with the values
 839  * specified in @params. Use gst_buffer_pool_get_config() to get the currently
 840  * used values.
 841  */
 842 void
 843 gst_buffer_pool_config_set_allocator (GstStructure * config,
 844     GstAllocator * allocator, const GstAllocationParams * params)
 845 {
 846   g_return_if_fail (config != NULL);
 847   g_return_if_fail (allocator != NULL || params != NULL);
 848
 849   gst_structure_id_set (config,
 850       GST_QUARK (ALLOCATOR), GST_TYPE_ALLOCATOR, allocator,
 851       GST_QUARK (PARAMS), GST_TYPE_ALLOCATION_PARAMS, params, NULL);
 852 }
 853
 854 /**
 855  * gst_buffer_pool_config_add_option:
 856  * @config: a #GstBufferPool configuration
 857  * @option: an option to add
 858  *
 859  * Enabled the option in @config. This will instruct the @bufferpool to enable
 860  * the specified option on the buffers that it allocates.
 861  *
 862  * The supported options by @pool can be retrieved with gst_buffer_pool_get_options().
 863  */
 864 void
 865 gst_buffer_pool_config_add_option (GstStructure * config, const gchar * option)
 866 {
 867   const GValue *value;
 868   GValue option_value = { 0, };
 869   guint i, len;
 870
 871   g_return_if_fail (config != NULL);
 872
 873   value = gst_structure_id_get_value (config, GST_QUARK (OPTIONS));
 874   if (value) {
 875     len = gst_value_array_get_size (value);
 876     for (i = 0; i < len; ++i) {
 877       const GValue *nth_val = gst_value_array_get_value (value, i);
 878
 879       if (g_str_equal (option, g_value_get_string (nth_val)))
 880         return;
 881     }
 882   } else {
 883     GValue new_array_val = { 0, };
 884
 885     g_value_init (&new_array_val, GST_TYPE_ARRAY);
 886     gst_structure_id_take_value (config, GST_QUARK (OPTIONS), &new_array_val);
 887     value = gst_structure_id_get_value (config, GST_QUARK (OPTIONS));
 888   }
 889   g_value_init (&option_value, G_TYPE_STRING);
 890   g_value_set_string (&option_value, option);
 891   gst_value_array_append_and_take_value ((GValue *) value, &option_value);
 892 }
 893
 894 /**
 895  * gst_buffer_pool_config_n_options:
 896  * @config: a #GstBufferPool configuration
 897  *
 898  * Retrieve the number of values currently stored in the options array of the
 899  * @config structure.
 900  *
 901  * Returns: the options array size as a #guint.
 902  */
 903 guint
 904 gst_buffer_pool_config_n_options (GstStructure * config)
 905 {
 906   const GValue *value;
 907   guint size = 0;
 908
 909   g_return_val_if_fail (config != NULL, 0);
 910
 911   value = gst_structure_id_get_value (config, GST_QUARK (OPTIONS));
 912   if (value) {
 913     size = gst_value_array_get_size (value);
 914   }
 915   return size;
 916 }
 917
 918 /**
 919  * gst_buffer_pool_config_get_option:
 920  * @config: a #GstBufferPool configuration
 921  * @index: position in the option array to read
 922  *
 923  * Parse an available @config and get the option at @index of the options API
 924  * array.
 925  *
 926  * Returns: a #gchar of the option at @index.
 927  */
 928 const gchar *
 929 gst_buffer_pool_config_get_option (GstStructure * config, guint index)
 930 {
 931   const GValue *value;
 932   const gchar *ret = NULL;
 933
 934   g_return_val_if_fail (config != NULL, 0);
 935
 936   value = gst_structure_id_get_value (config, GST_QUARK (OPTIONS));
 937   if (value) {
 938     const GValue *option_value;
 939
 940     option_value = gst_value_array_get_value (value, index);
 941     if (option_value)
 942       ret = g_value_get_string (option_value);
 943   }
 944   return ret;
 945 }
 946
 947 /**
 948  * gst_buffer_pool_config_has_option:
 949  * @config: a #GstBufferPool configuration
 950  * @option: an option
 951  *
 952  * Check if @config contains @option.
 953  *
 954  * Returns: %TRUE if the options array contains @option.
 955  */
 956 gboolean
 957 gst_buffer_pool_config_has_option (GstStructure * config, const gchar * option)
 958 {
 959   const GValue *value;
 960   guint i, len;
 961
 962   g_return_val_if_fail (config != NULL, 0);
 963
 964   value = gst_structure_id_get_value (config, GST_QUARK (OPTIONS));
 965   if (value) {
 966     len = gst_value_array_get_size (value);
 967     for (i = 0; i < len; ++i) {
 968       const GValue *nth_val = gst_value_array_get_value (value, i);
 969
 970       if (g_str_equal (option, g_value_get_string (nth_val)))
 971         return TRUE;
 972     }
 973   }
 974   return FALSE;
 975 }
 976
 977 /**
 978  * gst_buffer_pool_config_get_params:
 979  * @config: (transfer none): a #GstBufferPool configuration
 980  * @caps: (out) (transfer none) (allow-none): the caps of buffers
 981  * @size: (out) (allow-none): the size of each buffer, not including prefix and padding
 982  * @min_buffers: (out) (allow-none): the minimum amount of buffers to allocate.
 983  * @max_buffers: (out) (allow-none): the maximum amount of buffers to allocate or 0 for unlimited.
 984  *
 985  * Get the configuration values from @config.
 986  *
 987  * Returns: %TRUE if all parameters could be fetched.
 988  */
 989 gboolean
 990 gst_buffer_pool_config_get_params (GstStructure * config, GstCaps ** caps,
 991     guint * size, guint * min_buffers, guint * max_buffers)
 992 {
 993   g_return_val_if_fail (config != NULL, FALSE);
 994
 995   if (caps) {
 996     *caps = g_value_get_boxed (gst_structure_id_get_value (config,
 997             GST_QUARK (CAPS)));
 998   }
 999   return gst_structure_id_get (config,
1000       GST_QUARK (SIZE), G_TYPE_UINT, size,
1001       GST_QUARK (MIN_BUFFERS), G_TYPE_UINT, min_buffers,
1002       GST_QUARK (MAX_BUFFERS), G_TYPE_UINT, max_buffers, NULL);
1003 }
1004
1005 /**
1006  * gst_buffer_pool_config_get_allocator:
1007  * @config: (transfer none): a #GstBufferPool configuration
1008  * @allocator: (transfer none): a #GstAllocator
1009  * @params: #GstAllocationParams
1010  *
1011  * Get the @allocator and @params from @config.
1012  *
1013  * Returns: %TRUE, if the values are set.
1014  */
1015 gboolean
1016 gst_buffer_pool_config_get_allocator (GstStructure * config,
1017     GstAllocator ** allocator, GstAllocationParams * params)
1018 {
1019   g_return_val_if_fail (config != NULL, FALSE);
1020
1021   if (allocator)
1022     *allocator = g_value_get_object (gst_structure_id_get_value (config,
1023             GST_QUARK (ALLOCATOR)));
1024   if (params) {
1025     GstAllocationParams *p;
1026
1027     p = g_value_get_boxed (gst_structure_id_get_value (config,
1028             GST_QUARK (PARAMS)));
1029     if (p) {
1030       *params = *p;
1031     } else {
1032       gst_allocation_params_init (params);
1033     }
1034   }
1035   return TRUE;
1036 }
1037
1038 /**
1039  * gst_buffer_pool_config_validate_params:
1040  * @config: (transfer none): a #GstBufferPool configuration
1041  * @caps: (transfer none): the excepted caps of buffers
1042  * @size: the expected size of each buffer, not including prefix and padding
1043  * @min_buffers: the expected minimum amount of buffers to allocate.
1044  * @max_buffers: the expect maximum amount of buffers to allocate or 0 for unlimited.
1045  *
1046  * Validate that changes made to @config are still valid in the context of the
1047  * expected parameters. This function is a helper that can be used to validate
1048  * changes made by a pool to a config when gst_buffer_pool_set_config()
1049  * returns %FALSE. This expects that @caps and @size haven't changed, and that
1050  * @min_buffers aren't lower then what we initially expected. This does not check
1051  * if options or allocator parameters.
1052  *
1053  * Since: 1.4
1054  *
1055  * Returns: %TRUE, if the parameters are valid in this context.
1056  */
1057 gboolean
1058 gst_buffer_pool_config_validate_params (GstStructure * config, GstCaps * caps,
1059     guint size, guint min_buffers, G_GNUC_UNUSED guint max_buffers)
1060 {
1061   GstCaps *newcaps;
1062   guint newsize, newmin;
1063   gboolean ret = FALSE;
1064
1065   g_return_val_if_fail (config != NULL, FALSE);
1066
1067   gst_buffer_pool_config_get_params (config, &newcaps, &newsize, &newmin, NULL);
1068
1069   if (gst_caps_is_equal (caps, newcaps) && (size == newsize)
1070       && (newmin >= min_buffers))
1071     ret = TRUE;
1072
1073   return ret;
1074 }
1075
1076 static GstFlowReturn
1077 default_acquire_buffer (GstBufferPool * pool, GstBuffer ** buffer,
1078     GstBufferPoolAcquireParams * params)
1079 {
1080   GstFlowReturn result;
1081   GstBufferPoolPrivate *priv = pool->priv;
1082
1083   while (TRUE) {
1084     if (G_UNLIKELY (GST_BUFFER_POOL_IS_FLUSHING (pool)))
1085       goto flushing;
1086
1087     /* try to get a buffer from the queue */
1088     *buffer = gst_atomic_queue_pop (priv->queue);
1089     if (G_LIKELY (*buffer)) {
1090       gst_poll_read_control (priv->poll);
1091       result = GST_FLOW_OK;
1092       GST_LOG_OBJECT (pool, "acquired buffer %p", *buffer);
1093       break;
1094     }
1095
1096     /* no buffer, try to allocate some more */
1097     GST_LOG_OBJECT (pool, "no buffer, trying to allocate");
1098     result = do_alloc_buffer (pool, buffer, NULL);
1099     if (G_LIKELY (result == GST_FLOW_OK))
1100       /* we have a buffer, return it */
1101       break;
1102
1103     if (G_UNLIKELY (result != GST_FLOW_EOS))
1104       /* something went wrong, return error */
1105       break;
1106
1107     /* check if we need to wait */
1108     if (params && (params->flags & GST_BUFFER_POOL_ACQUIRE_FLAG_DONTWAIT)) {
1109       GST_LOG_OBJECT (pool, "no more buffers");
1110       break;
1111     }
1112
1113     /* now we release the control socket, we wait for a buffer release or
1114      * flushing */
1115     gst_poll_read_control (pool->priv->poll);
1116     GST_LOG_OBJECT (pool, "waiting for free buffers or flushing");
1117     gst_poll_wait (priv->poll, GST_CLOCK_TIME_NONE);
1118     gst_poll_write_control (pool->priv->poll);
1119   }
1120
1121   return result;
1122
1123   /* ERRORS */
1124 flushing:
1125   {
1126     GST_DEBUG_OBJECT (pool, "we are flushing");
1127     return GST_FLOW_FLUSHING;
1128   }
1129 }
1130
1131 static inline void
1132 dec_outstanding (GstBufferPool * pool)
1133 {
1134   if (g_atomic_int_dec_and_test (&pool->priv->outstanding)) {
1135     /* all buffers are returned to the pool, see if we need to free them */
1136     if (GST_BUFFER_POOL_IS_FLUSHING (pool)) {
1137       /* take the lock so that set_active is not run concurrently */
1138       GST_BUFFER_POOL_LOCK (pool);
1139       /* now that we have the lock, check if we have been de-activated with
1140        * outstanding buffers */
1141       if (!pool->priv->active)
1142         do_stop (pool);
1143
1144       GST_BUFFER_POOL_UNLOCK (pool);
1145     }
1146   }
1147 }
1148
1149 static gboolean
1150 remove_meta_unpooled (GstBuffer * buffer, GstMeta ** meta, gpointer user_data)
1151 {
1152   if (!GST_META_FLAG_IS_SET (*meta, GST_META_FLAG_POOLED)) {
1153     GST_META_FLAG_UNSET (*meta, GST_META_FLAG_LOCKED);
1154     *meta = NULL;
1155   }
1156   return TRUE;
1157 }
1158
1159 static void
1160 default_reset_buffer (GstBufferPool * pool, GstBuffer * buffer)
1161 {
1162   GST_BUFFER_FLAGS (buffer) &= GST_BUFFER_FLAG_TAG_MEMORY;
1163
1164   GST_BUFFER_PTS (buffer) = GST_CLOCK_TIME_NONE;
1165   GST_BUFFER_DTS (buffer) = GST_CLOCK_TIME_NONE;
1166   GST_BUFFER_DURATION (buffer) = GST_CLOCK_TIME_NONE;
1167   GST_BUFFER_OFFSET (buffer) = GST_BUFFER_OFFSET_NONE;
1168   GST_BUFFER_OFFSET_END (buffer) = GST_BUFFER_OFFSET_NONE;
1169
1170   /* remove all metadata without the POOLED flag */
1171   gst_buffer_foreach_meta (buffer, remove_meta_unpooled, pool);
1172 }
1173
1174 /**
1175  * gst_buffer_pool_acquire_buffer:
1176  * @pool: a #GstBufferPool
1177  * @buffer: (out): a location for a #GstBuffer
1178  * @params: (transfer none) (allow-none): parameters.
1179  *
1180  * Acquire a buffer from @pool. @buffer should point to a memory location that
1181  * can hold a pointer to the new buffer.
1182  *
1183  * @params can be %NULL or contain optional parameters to influence the
1184  * allocation.
1185  *
1186  * Returns: a #GstFlowReturn such as %GST_FLOW_FLUSHING when the pool is
1187  * inactive.
1188  */
1189 GstFlowReturn
1190 gst_buffer_pool_acquire_buffer (GstBufferPool * pool, GstBuffer ** buffer,
1191     GstBufferPoolAcquireParams * params)
1192 {
1193   GstBufferPoolClass *pclass;
1194   GstFlowReturn result;
1195
1196   g_return_val_if_fail (GST_IS_BUFFER_POOL (pool), GST_FLOW_ERROR);
1197   g_return_val_if_fail (buffer != NULL, GST_FLOW_ERROR);
1198
1199   pclass = GST_BUFFER_POOL_GET_CLASS (pool);
1200
1201   /* assume we'll have one more outstanding buffer we need to do that so
1202    * that concurrent set_active doesn't clear the buffers */
1203   g_atomic_int_inc (&pool->priv->outstanding);
1204
1205   if (G_LIKELY (pclass->acquire_buffer))
1206     result = pclass->acquire_buffer (pool, buffer, params);
1207   else
1208     result = GST_FLOW_NOT_SUPPORTED;
1209
1210   if (G_LIKELY (result == GST_FLOW_OK)) {
1211     /* all buffers from the pool point to the pool and have the refcount of the
1212      * pool incremented */
1213     (*buffer)->pool = gst_object_ref (pool);
1214   } else {
1215     dec_outstanding (pool);
1216   }
1217
1218   return result;
1219 }
1220
1221 static void
1222 default_release_buffer (GstBufferPool * pool, GstBuffer * buffer)
1223 {
1224   GST_LOG_OBJECT (pool, "released buffer %p %d", buffer,
1225       GST_MINI_OBJECT_FLAGS (buffer));
1226
1227   /* memory should be untouched */
1228   if (GST_BUFFER_FLAG_IS_SET (buffer, GST_BUFFER_FLAG_TAG_MEMORY))
1229     goto discard;
1230
1231   /* size should have been reset. This is not a catch all, pool with
1232    * size requirement per memory should do their own check. */
1233   if (gst_buffer_get_size (buffer) != pool->priv->size)
1234     goto discard;
1235
1236   /* all memory should be exclusive to this buffer (and thus be writable) */
1237   if (!gst_buffer_is_all_memory_writable (buffer))
1238     goto discard;
1239
1240   /* keep it around in our queue */
1241   gst_atomic_queue_push (pool->priv->queue, buffer);
1242   gst_poll_write_control (pool->priv->poll);
1243
1244   return;
1245
1246 discard:
1247   {
1248     do_free_buffer (pool, buffer);
1249     return;
1250   }
1251 }
1252
1253 /**
1254  * gst_buffer_pool_release_buffer:
1255  * @pool: a #GstBufferPool
1256  * @buffer: (transfer full): a #GstBuffer
1257  *
1258  * Release @buffer to @pool. @buffer should have previously been allocated from
1259  * @pool with gst_buffer_pool_acquire_buffer().
1260  *
1261  * This function is usually called automatically when the last ref on @buffer
1262  * disappears.
1263  */
1264 void
1265 gst_buffer_pool_release_buffer (GstBufferPool * pool, GstBuffer * buffer)
1266 {
1267   GstBufferPoolClass *pclass;
1268
1269   g_return_if_fail (GST_IS_BUFFER_POOL (pool));
1270   g_return_if_fail (buffer != NULL);
1271
1272   /* check that the buffer is ours, all buffers returned to the pool have the
1273    * pool member set to NULL and the pool refcount decreased */
1274   if (!g_atomic_pointer_compare_and_exchange (&buffer->pool, pool, NULL))
1275     return;
1276
1277   pclass = GST_BUFFER_POOL_GET_CLASS (pool);
1278
1279   /* reset the buffer when needed */
1280   if (G_LIKELY (pclass->reset_buffer))
1281     pclass->reset_buffer (pool, buffer);
1282
1283   if (G_LIKELY (pclass->release_buffer))
1284     pclass->release_buffer (pool, buffer);
1285
1286   dec_outstanding (pool);
1287
1288   /* decrease the refcount that the buffer had to us */
1289   gst_object_unref (pool);
1290 }
1291
1292 /**
1293  * gst_buffer_pool_set_flushing:
1294  * @pool: a #GstBufferPool
1295  * @flushing: whether to start or stop flushing
1296  *
1297  * Enabled or disable the flushing state of a @pool without freeing or
1298  * allocating buffers.
1299  *
1300  * Since: 1.4
1301  */
1302 void
1303 gst_buffer_pool_set_flushing (GstBufferPool * pool, gboolean flushing)
1304 {
1305   GstBufferPoolPrivate *priv;
1306
1307   g_return_if_fail (GST_IS_BUFFER_POOL (pool));
1308
1309   GST_LOG_OBJECT (pool, "flushing %d", flushing);
1310
1311   priv = pool->priv;
1312
1313   GST_BUFFER_POOL_LOCK (pool);
1314
1315   if (!priv->active) {
1316     GST_WARNING_OBJECT (pool, "can't change flushing state of inactive pool");
1317     goto done;
1318   }
1319
1320   do_set_flushing (pool, flushing);
1321
1322 done:
1323   GST_BUFFER_POOL_UNLOCK (pool);
1324 }