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