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