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