gst/gstmemory.c

   1 /* GStreamer
   2  * Copyright (C) 2011 Wim Taymans <wim.taymans@gmail.be>
   3  *
   4  * gstmemory.c: memory block handling
   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:gstmemory
  24  * @short_description: refcounted wrapper for memory blocks
  25  * @see_also: #GstBuffer
  26  *
  27  * GstMemory is a lightweight refcounted object that wraps a region of memory.
  28  * They are typically used to manage the data of a #GstBuffer.
  29  *
  30  * A GstMemory object has an allocated region of memory of maxsize. The maximum
  31  * size does not change during the lifetime of the memory object. The memory
  32  * also has an offset and size property that specifies the valid range of memory
  33  * in the allocated region.
  34  *
  35  * Memory is usually created by allocators with a gst_allocator_alloc()
  36  * method call. When NULL is used as the allocator, the default allocator will
  37  * be used.
  38  *
  39  * New allocators can be registered with gst_allocator_register().
  40  * Allocators are identified by name and can be retrieved with
  41  * gst_allocator_find().
  42  *
  43  * New memory can be created with gst_memory_new_wrapped() that wraps the memory
  44  * allocated elsewhere.
  45  *
  46  * Refcounting of the memory block is performed with gst_memory_ref() and
  47  * gst_memory_unref().
  48  *
  49  * The size of the memory can be retrieved and changed with
  50  * gst_memory_get_sizes() and gst_memory_resize() respectively.
  51  *
  52  * Getting access to the data of the memory is performed with gst_memory_map().
  53  * The call will return a pointer to offset bytes into the region of memory.
  54  * After the memory access is completed, gst_memory_unmap() should be called.
  55  *
  56  * Memory can be copied with gst_memory_copy(), which will returnn a writable
  57  * copy. gst_memory_share() will create a new memory block that shares the
  58  * memory with an existing memory block at a custom offset and with a custom
  59  * size.
  60  *
  61  * Memory can be efficiently merged when gst_memory_is_span() returns TRUE.
  62  *
  63  * Last reviewed on 2011-06-08 (0.11.0)
  64  */
  65
  66 #ifdef HAVE_CONFIG_H
  67 #include "config.h"
  68 #endif
  69
  70 #include "gst_private.h"
  71 #include "gstmemory.h"
  72
  73 #ifndef GST_DISABLE_TRACE
  74 #include "gsttrace.h"
  75 static GstAllocTrace *_gst_memory_trace;
  76 static GstAllocTrace *_gst_allocator_trace;
  77 #endif
  78
  79 G_DEFINE_BOXED_TYPE (GstMemory, gst_memory, (GBoxedCopyFunc) gst_memory_ref,
  80     (GBoxedFreeFunc) gst_memory_unref);
  81
  82 G_DEFINE_BOXED_TYPE (GstAllocator, gst_allocator,
  83     (GBoxedCopyFunc) gst_allocator_ref, (GBoxedFreeFunc) gst_allocator_unref);
  84
  85 /**
  86  * gst_memory_alignment:
  87  *
  88  * The default memory alignment in bytes - 1
  89  * an alignment of 7 would be the same as what malloc() guarantees.
  90  */
  91 #if defined(MEMORY_ALIGNMENT_MALLOC)
  92 size_t gst_memory_alignment = 7;
  93 #elif defined(MEMORY_ALIGNMENT_PAGESIZE)
  94 /* we fill this in in the _init method */
  95 size_t gst_memory_alignment = 0;
  96 #elif defined(MEMORY_ALIGNMENT)
  97 size_t gst_memory_alignment = MEMORY_ALIGNMENT - 1;
  98 #else
  99 #error "No memory alignment configured"
 100 size_t gst_memory_alignment = 0;
 101 #endif
 102
 103 struct _GstAllocator
 104 {
 105   gint refcount;
 106
 107   GstMemoryInfo info;
 108
 109   gpointer user_data;
 110   GDestroyNotify notify;
 111 };
 112
 113 /* default memory implementation */
 114 typedef struct
 115 {
 116   GstMemory mem;
 117   gsize slice_size;
 118   guint8 *data;
 119   GFreeFunc free_func;
 120 } GstMemoryDefault;
 121
 122 /* the default allocator */
 123 static GstAllocator *_default_allocator;
 124
 125 /* our predefined allocators */
 126 static GstAllocator *_default_mem_impl;
 127
 128 /* initialize the fields */
 129 static void
 130 _default_mem_init (GstMemoryDefault * mem, GstMemoryFlags flags,
 131     GstMemory * parent, gsize slice_size, gpointer data,
 132     GFreeFunc free_func, gsize maxsize, gsize offset, gsize size)
 133 {
 134   mem->mem.allocator = _default_mem_impl;
 135   mem->mem.flags = flags;
 136   mem->mem.refcount = 1;
 137   mem->mem.parent = parent ? gst_memory_ref (parent) : NULL;
 138   mem->mem.state = (flags & GST_MEMORY_FLAG_READONLY ? 0x5 : 0);
 139   mem->mem.maxsize = maxsize;
 140   mem->mem.offset = offset;
 141   mem->mem.size = size;
 142   mem->slice_size = slice_size;
 143   mem->data = data;
 144   mem->free_func = free_func;
 145
 146   GST_CAT_DEBUG (GST_CAT_MEMORY, "new memory %p", mem);
 147 }
 148
 149 /* create a new memory block that manages the given memory */
 150 static GstMemoryDefault *
 151 _default_mem_new (GstMemoryFlags flags, GstMemory * parent, gpointer data,
 152     GFreeFunc free_func, gsize maxsize, gsize offset, gsize size)
 153 {
 154   GstMemoryDefault *mem;
 155   gsize slice_size;
 156
 157   slice_size = sizeof (GstMemoryDefault);
 158
 159   mem = g_slice_alloc (slice_size);
 160   _default_mem_init (mem, flags, parent, slice_size,
 161       data, free_func, maxsize, offset, size);
 162
 163   return mem;
 164 }
 165
 166 /* allocate the memory and structure in one block */
 167 static GstMemoryDefault *
 168 _default_mem_new_block (gsize maxsize, gsize align, gsize offset, gsize size)
 169 {
 170   GstMemoryDefault *mem;
 171   gsize aoffset, slice_size;
 172   guint8 *data;
 173
 174   /* ensure configured alignment */
 175   align |= gst_memory_alignment;
 176   /* allocate more to compensate for alignment */
 177   maxsize += align;
 178   /* alloc header and data in one block */
 179   slice_size = sizeof (GstMemoryDefault) + maxsize;
 180
 181   mem = g_slice_alloc (slice_size);
 182   if (mem == NULL)
 183     return NULL;
 184
 185   data = (guint8 *) mem + sizeof (GstMemoryDefault);
 186
 187   if ((aoffset = ((guintptr) data & align)))
 188     aoffset = (align + 1) - aoffset;
 189
 190   _default_mem_init (mem, 0, NULL, slice_size, data, NULL, maxsize,
 191       aoffset + offset, size);
 192
 193   return mem;
 194 }
 195
 196 static GstMemory *
 197 _default_alloc_alloc (GstAllocator * allocator, gsize maxsize, gsize align,
 198     gpointer user_data)
 199 {
 200   return (GstMemory *) _default_mem_new_block (maxsize, align, 0, maxsize);
 201 }
 202
 203 static gpointer
 204 _default_mem_map (GstMemoryDefault * mem, GstMapFlags flags)
 205 {
 206   return mem->data;
 207 }
 208
 209 static gboolean
 210 _default_mem_unmap (GstMemoryDefault * mem)
 211 {
 212   return TRUE;
 213 }
 214
 215 static void
 216 _default_mem_free (GstMemoryDefault * mem)
 217 {
 218   GST_CAT_DEBUG (GST_CAT_MEMORY, "free memory %p", mem);
 219
 220   if (mem->mem.parent)
 221     gst_memory_unref (mem->mem.parent);
 222
 223   if (mem->free_func)
 224     mem->free_func (mem->data);
 225
 226   g_slice_free1 (mem->slice_size, mem);
 227 }
 228
 229 static GstMemoryDefault *
 230 _default_mem_copy (GstMemoryDefault * mem, gssize offset, gsize size)
 231 {
 232   GstMemoryDefault *copy;
 233
 234   if (size == -1)
 235     size = mem->mem.size > offset ? mem->mem.size - offset : 0;
 236
 237   copy =
 238       _default_mem_new_block (mem->mem.maxsize, 0, mem->mem.offset + offset,
 239       size);
 240   memcpy (copy->data, mem->data, mem->mem.maxsize);
 241   GST_CAT_DEBUG (GST_CAT_PERFORMANCE, "copy memory %p -> %p", mem, copy);
 242
 243   return copy;
 244 }
 245
 246 static GstMemoryDefault *
 247 _default_mem_share (GstMemoryDefault * mem, gssize offset, gsize size)
 248 {
 249   GstMemoryDefault *sub;
 250   GstMemory *parent;
 251
 252   /* find the real parent */
 253   if ((parent = mem->mem.parent) == NULL)
 254     parent = (GstMemory *) mem;
 255
 256   if (size == -1)
 257     size = mem->mem.size - offset;
 258
 259   sub =
 260       _default_mem_new (parent->flags, parent, mem->data, NULL,
 261       mem->mem.maxsize, mem->mem.offset + offset, size);
 262
 263   return sub;
 264 }
 265
 266 static gboolean
 267 _default_mem_is_span (GstMemoryDefault * mem1, GstMemoryDefault * mem2,
 268     gsize * offset)
 269 {
 270
 271   if (offset) {
 272     GstMemoryDefault *parent;
 273
 274     parent = (GstMemoryDefault *) mem1->mem.parent;
 275
 276     *offset = mem1->mem.offset - parent->mem.offset;
 277   }
 278
 279   /* and memory is contiguous */
 280   return mem1->data + mem1->mem.offset + mem1->mem.size ==
 281       mem2->data + mem2->mem.offset;
 282 }
 283
 284 static GstMemory *
 285 _fallback_mem_copy (GstMemory * mem, gssize offset, gssize size)
 286 {
 287   GstMemory *copy;
 288   GstMapInfo sinfo, dinfo;
 289
 290   if (!gst_memory_map (mem, &sinfo, GST_MAP_READ))
 291     return NULL;
 292
 293   if (size == -1)
 294     size = sinfo.size > offset ? sinfo.size - offset : 0;
 295
 296   /* use the same allocator as the memory we copy  */
 297   copy = gst_allocator_alloc (mem->allocator, size, mem->align);
 298   if (!gst_memory_map (copy, &dinfo, GST_MAP_WRITE)) {
 299     GST_CAT_WARNING (GST_CAT_MEMORY, "could not write map memory %p", copy);
 300     gst_memory_unmap (mem, &sinfo);
 301     return NULL;
 302   }
 303
 304   memcpy (dinfo.data, sinfo.data + offset, size);
 305   GST_CAT_DEBUG (GST_CAT_PERFORMANCE, "copy memory %p -> %p", mem, copy);
 306   gst_memory_unmap (copy, &dinfo);
 307   gst_memory_unmap (mem, &sinfo);
 308
 309   return copy;
 310 }
 311
 312 static gboolean
 313 _fallback_mem_is_span (GstMemory * mem1, GstMemory * mem2, gsize * offset)
 314 {
 315   return FALSE;
 316 }
 317
 318 static GRWLock lock;
 319 static GHashTable *allocators;
 320
 321 static void
 322 _priv_sysmem_notify (gpointer user_data)
 323 {
 324   g_warning ("The default memory allocator was freed!");
 325 }
 326
 327 void
 328 _priv_gst_memory_initialize (void)
 329 {
 330   static const GstMemoryInfo _mem_info = {
 331     GST_ALLOCATOR_SYSMEM,
 332     (GstAllocatorAllocFunction) _default_alloc_alloc,
 333     (GstMemoryMapFunction) _default_mem_map,
 334     (GstMemoryUnmapFunction) _default_mem_unmap,
 335     (GstMemoryFreeFunction) _default_mem_free,
 336     (GstMemoryCopyFunction) _default_mem_copy,
 337     (GstMemoryShareFunction) _default_mem_share,
 338     (GstMemoryIsSpanFunction) _default_mem_is_span,
 339   };
 340
 341 #ifndef GST_DISABLE_TRACE
 342   _gst_memory_trace = _gst_alloc_trace_register ("GstMemory", -1);
 343   _gst_allocator_trace = _gst_alloc_trace_register ("GstAllocator", -1);
 344 #endif
 345
 346   g_rw_lock_init (&lock);
 347   allocators = g_hash_table_new (g_str_hash, g_str_equal);
 348
 349 #ifdef HAVE_GETPAGESIZE
 350 #ifdef MEMORY_ALIGNMENT_PAGESIZE
 351   gst_memory_alignment = getpagesize () - 1;
 352 #endif
 353 #endif
 354
 355   GST_CAT_DEBUG (GST_CAT_MEMORY, "memory alignment: %" G_GSIZE_FORMAT,
 356       gst_memory_alignment);
 357
 358   _default_mem_impl = gst_allocator_new (&_mem_info, NULL, _priv_sysmem_notify);
 359
 360   _default_allocator = gst_allocator_ref (_default_mem_impl);
 361   gst_allocator_register (GST_ALLOCATOR_SYSMEM,
 362       gst_allocator_ref (_default_mem_impl));
 363 }
 364
 365 /**
 366  * gst_memory_new_wrapped:
 367  * @flags: #GstMemoryFlags
 368  * @data: data to wrap
 369  * @free_func: function to free @data
 370  * @maxsize: allocated size of @data
 371  * @offset: offset in @data
 372  * @size: size of valid data
 373  *
 374  * Allocate a new memory block that wraps the given @data.
 375  *
 376  * Returns: a new #GstMemory.
 377  */
 378 GstMemory *
 379 gst_memory_new_wrapped (GstMemoryFlags flags, gpointer data,
 380     GFreeFunc free_func, gsize maxsize, gsize offset, gsize size)
 381 {
 382   GstMemoryDefault *mem;
 383
 384   g_return_val_if_fail (data != NULL, NULL);
 385   g_return_val_if_fail (offset + size <= maxsize, NULL);
 386
 387   mem = _default_mem_new (flags, NULL, data, free_func, maxsize, offset, size);
 388
 389 #ifndef GST_DISABLE_TRACE
 390   _gst_alloc_trace_new (_gst_memory_trace, mem);
 391 #endif
 392
 393   return (GstMemory *) mem;
 394 }
 395
 396 /**
 397  * gst_memory_ref:
 398  * @mem: a #GstMemory
 399  *
 400  * Increases the refcount of @mem.
 401  *
 402  * Returns: @mem with increased refcount
 403  */
 404 GstMemory *
 405 gst_memory_ref (GstMemory * mem)
 406 {
 407   g_return_val_if_fail (mem != NULL, NULL);
 408
 409   GST_CAT_TRACE (GST_CAT_MEMORY, "memory %p, %d->%d", mem, mem->refcount,
 410       mem->refcount + 1);
 411
 412   g_atomic_int_inc (&mem->refcount);
 413
 414   return mem;
 415 }
 416
 417 /**
 418  * gst_memory_unref:
 419  * @mem: a #GstMemory
 420  *
 421  * Decreases the refcount of @mem. When the refcount reaches 0, the free
 422  * function of @mem will be called.
 423  */
 424 void
 425 gst_memory_unref (GstMemory * mem)
 426 {
 427   g_return_if_fail (mem != NULL);
 428   g_return_if_fail (mem->allocator != NULL);
 429
 430   GST_CAT_TRACE (GST_CAT_MEMORY, "memory %p, %d->%d", mem, mem->refcount,
 431       mem->refcount - 1);
 432
 433   if (g_atomic_int_dec_and_test (&mem->refcount)) {
 434 #ifndef GST_DISABLE_TRACE
 435     _gst_alloc_trace_free (_gst_memory_trace, mem);
 436 #endif
 437     mem->allocator->info.mem_free (mem);
 438   }
 439 }
 440
 441 /**
 442  * gst_memory_get_sizes:
 443  * @mem: a #GstMemory
 444  * @offset: pointer to offset
 445  * @maxsize: pointer to maxsize
 446  *
 447  * Get the current @size, @offset and @maxsize of @mem.
 448  *
 449  * Returns: the current sizes of @mem
 450  */
 451 gsize
 452 gst_memory_get_sizes (GstMemory * mem, gsize * offset, gsize * maxsize)
 453 {
 454   g_return_val_if_fail (mem != NULL, 0);
 455
 456   if (offset)
 457     *offset = mem->offset;
 458   if (maxsize)
 459     *maxsize = mem->maxsize;
 460
 461   return mem->size;
 462 }
 463
 464 /**
 465  * gst_memory_resize:
 466  * @mem: a #GstMemory
 467  * @offset: a new offset
 468  * @size: a new size
 469  *
 470  * Resize the memory region. @mem should be writable and offset + size should be
 471  * less than the maxsize of @mem.
 472  */
 473 void
 474 gst_memory_resize (GstMemory * mem, gssize offset, gsize size)
 475 {
 476   g_return_if_fail (mem != NULL);
 477   g_return_if_fail (gst_memory_is_writable (mem));
 478   g_return_if_fail (offset >= 0 || mem->offset >= -offset);
 479   g_return_if_fail (size + mem->offset + offset <= mem->maxsize);
 480
 481   mem->offset += offset;
 482   mem->size = size;
 483 }
 484
 485 /**
 486  * gst_memory_is_writable:
 487  * @mem: a #GstMemory
 488  *
 489  * Check if @mem is writable.
 490  *
 491  * Returns: %TRUE is @mem is writable.
 492  */
 493 gboolean
 494 gst_memory_is_writable (GstMemory * mem)
 495 {
 496   g_return_val_if_fail (mem != NULL, FALSE);
 497
 498   return (mem->refcount == 1) &&
 499       ((mem->parent == NULL) || (mem->parent->refcount == 1)) &&
 500       ((mem->flags & GST_MEMORY_FLAG_READONLY) == 0);
 501 }
 502
 503 static gboolean
 504 gst_memory_lock (GstMemory * mem, GstMapFlags flags)
 505 {
 506   gint access_mode, state, newstate;
 507
 508   access_mode = flags & 3;
 509
 510   do {
 511     state = g_atomic_int_get (&mem->state);
 512     if (state == 0) {
 513       /* nothing mapped, set access_mode and refcount */
 514       newstate = 4 | access_mode;
 515     } else {
 516       /* access_mode must match */
 517       if ((state & access_mode) != access_mode)
 518         goto lock_failed;
 519       /* increase refcount */
 520       newstate = state + 4;
 521     }
 522   } while (!g_atomic_int_compare_and_exchange (&mem->state, state, newstate));
 523
 524   return TRUE;
 525
 526 lock_failed:
 527   {
 528     GST_CAT_DEBUG (GST_CAT_MEMORY, "lock failed %p: state %d, access_mode %d",
 529         mem, state, access_mode);
 530     return FALSE;
 531   }
 532 }
 533
 534 static void
 535 gst_memory_unlock (GstMemory * mem)
 536 {
 537   gint state, newstate;
 538
 539   do {
 540     state = g_atomic_int_get (&mem->state);
 541     /* decrease the refcount */
 542     newstate = state - 4;
 543     /* last refcount, unset access_mode */
 544     if (newstate < 4)
 545       newstate = 0;
 546   } while (!g_atomic_int_compare_and_exchange (&mem->state, state, newstate));
 547 }
 548
 549
 550 /**
 551  * gst_memory_make_mapped:
 552  * @mem: (transfer full): a #GstMemory
 553  * @info: (out): pointer for info
 554  * @flags: mapping flags
 555  *
 556  * Create a #GstMemory object that is mapped with @flags. If @mem is mappable
 557  * with @flags, this function returns the mapped @mem directly. Otherwise a
 558  * mapped copy of @mem is returned.
 559  *
 560  * This function takes ownership of old @mem and returns a reference to a new
 561  * #GstMemory.
 562  *
 563  * Returns: (transfer full): a #GstMemory object mapped with @flags or NULL when
 564  * a mapping is not possible.
 565  */
 566 GstMemory *
 567 gst_memory_make_mapped (GstMemory * mem, GstMapInfo * info, GstMapFlags flags)
 568 {
 569   GstMemory *result;
 570
 571   if (gst_memory_map (mem, info, flags)) {
 572     result = mem;
 573   } else {
 574     result = gst_memory_copy (mem, 0, -1);
 575     gst_memory_unref (mem);
 576
 577     if (result == NULL)
 578       goto cannot_copy;
 579
 580     if (!gst_memory_map (result, info, flags))
 581       goto cannot_map;
 582   }
 583   return result;
 584
 585   /* ERRORS */
 586 cannot_copy:
 587   {
 588     GST_CAT_DEBUG (GST_CAT_MEMORY, "cannot copy memory %p", mem);
 589     return NULL;
 590   }
 591 cannot_map:
 592   {
 593     GST_CAT_DEBUG (GST_CAT_MEMORY, "cannot map memory %p with flags %d", mem,
 594         flags);
 595     gst_memory_unref (result);
 596     return NULL;
 597   }
 598 }
 599
 600 /**
 601  * gst_memory_map:
 602  * @mem: a #GstMemory
 603  * @info: (out): pointer for info
 604  * @flags: mapping flags
 605  *
 606  * Fill @info with the pointer and sizes of the memory in @mem that can be
 607  * accessed according to @flags.
 608  *
 609  * This function can return %FALSE for various reasons:
 610  * - the memory backed by @mem is not accessible with the given @flags.
 611  * - the memory was already mapped with a different mapping.
 612  *
 613  * @info and its contents remains valid for as long as @mem is alive and until
 614  * gst_memory_unmap() is called.
 615  *
 616  * For each gst_memory_map() call, a corresponding gst_memory_unmap() call
 617  * should be done.
 618  *
 619  * Returns: %TRUE if the map operation was successful.
 620  */
 621 gboolean
 622 gst_memory_map (GstMemory * mem, GstMapInfo * info, GstMapFlags flags)
 623 {
 624   g_return_val_if_fail (mem != NULL, FALSE);
 625   g_return_val_if_fail (info != NULL, FALSE);
 626
 627   if (!gst_memory_lock (mem, flags))
 628     goto lock_failed;
 629
 630   info->data = mem->allocator->info.mem_map (mem, mem->maxsize, flags);
 631
 632   if (G_UNLIKELY (info->data == NULL))
 633     goto error;
 634
 635   info->memory = mem;
 636   info->flags = flags;
 637   info->size = mem->size;
 638   info->maxsize = mem->maxsize - mem->offset;
 639   info->data = info->data + mem->offset;
 640
 641   return TRUE;
 642
 643   /* ERRORS */
 644 lock_failed:
 645   {
 646     GST_CAT_DEBUG (GST_CAT_MEMORY, "mem %p: lock %d failed", mem, flags);
 647     return FALSE;
 648   }
 649 error:
 650   {
 651     /* something went wrong, restore the orginal state again */
 652     GST_CAT_ERROR (GST_CAT_MEMORY, "mem %p: map failed", mem);
 653     gst_memory_unlock (mem);
 654     return FALSE;
 655   }
 656 }
 657
 658 /**
 659  * gst_memory_unmap:
 660  * @mem: a #GstMemory
 661  * @info: a #GstMapInfo
 662  *
 663  * Release the memory obtained with gst_memory_map()
 664  */
 665 void
 666 gst_memory_unmap (GstMemory * mem, GstMapInfo * info)
 667 {
 668   g_return_if_fail (mem != NULL);
 669   g_return_if_fail (info != NULL);
 670   g_return_if_fail (info->memory == mem);
 671   /* there must be a ref */
 672   g_return_if_fail (g_atomic_int_get (&mem->state) >= 4);
 673
 674   mem->allocator->info.mem_unmap (mem);
 675   gst_memory_unlock (mem);
 676 }
 677
 678 /**
 679  * gst_memory_copy:
 680  * @mem: a #GstMemory
 681  * @offset: an offset to copy
 682  * @size: size to copy or -1 to copy all bytes from offset
 683  *
 684  * Return a copy of @size bytes from @mem starting from @offset. This copy is
 685  * guaranteed to be writable. @size can be set to -1 to return a copy all bytes
 686  * from @offset.
 687  *
 688  * Returns: a new #GstMemory.
 689  */
 690 GstMemory *
 691 gst_memory_copy (GstMemory * mem, gssize offset, gssize size)
 692 {
 693   GstMemory *copy;
 694
 695   g_return_val_if_fail (mem != NULL, NULL);
 696
 697   copy = mem->allocator->info.mem_copy (mem, offset, size);
 698
 699 #ifndef GST_DISABLE_TRACE
 700   _gst_alloc_trace_new (_gst_memory_trace, copy);
 701 #endif
 702
 703   return copy;
 704 }
 705
 706 /**
 707  * gst_memory_share:
 708  * @mem: a #GstMemory
 709  * @offset: an offset to share
 710  * @size: size to share or -1 to share bytes from offset
 711  *
 712  * Return a shared copy of @size bytes from @mem starting from @offset. No
 713  * memory copy is performed and the memory region is simply shared. The result
 714  * is guaranteed to be not-writable. @size can be set to -1 to return a share
 715  * all bytes from @offset.
 716  *
 717  * Returns: a new #GstMemory.
 718  */
 719 GstMemory *
 720 gst_memory_share (GstMemory * mem, gssize offset, gssize size)
 721 {
 722   GstMemory *shared;
 723
 724   g_return_val_if_fail (mem != NULL, NULL);
 725
 726   shared = mem->allocator->info.mem_share (mem, offset, size);
 727
 728 #ifndef GST_DISABLE_TRACE
 729   _gst_alloc_trace_new (_gst_memory_trace, shared);
 730 #endif
 731
 732   return shared;
 733 }
 734
 735 /**
 736  * gst_memory_is_span:
 737  * @mem1: a #GstMemory
 738  * @mem2: a #GstMemory
 739  * @offset: a pointer to a result offset
 740  *
 741  * Check if @mem1 and mem2 share the memory with a common parent memory object
 742  * and that the memory is contiguous.
 743  *
 744  * If this is the case, the memory of @mem1 and @mem2 can be merged
 745  * efficiently by performing gst_memory_share() on the parent object from
 746  * the returned @offset.
 747  *
 748  * Returns: %TRUE if the memory is contiguous and of a common parent.
 749  */
 750 gboolean
 751 gst_memory_is_span (GstMemory * mem1, GstMemory * mem2, gsize * offset)
 752 {
 753   g_return_val_if_fail (mem1 != NULL, FALSE);
 754   g_return_val_if_fail (mem2 != NULL, FALSE);
 755
 756   /* need to have the same allocators */
 757   if (mem1->allocator != mem2->allocator)
 758     return FALSE;
 759
 760   /* need to have the same parent */
 761   if (mem1->parent == NULL || mem1->parent != mem2->parent)
 762     return FALSE;
 763
 764   /* and memory is contiguous */
 765   if (!mem1->allocator->info.mem_is_span (mem1, mem2, offset))
 766     return FALSE;
 767
 768   return TRUE;
 769 }
 770
 771 /**
 772  * gst_allocator_register:
 773  * @info: a #GstMemoryInfo
 774  * @user_data: user data
 775  * @notify: a #GDestroyNotify for @user_data
 776  *
 777  * Create a new memory allocator with @info and @user_data.
 778  *
 779  * All functions in @info are mandatory exept the copy and is_span
 780  * functions, which will have a default implementation when left NULL.
 781  *
 782  * The @user_data will be passed to all calls of the alloc function and the
 783  * @notify function.
 784  *
 785  * Returns: a new #GstAllocator.
 786  */
 787 GstAllocator *
 788 gst_allocator_new (const GstMemoryInfo * info, gpointer user_data,
 789     GDestroyNotify notify)
 790 {
 791   GstAllocator *allocator;
 792
 793 #define INSTALL_FALLBACK(_t) \
 794   if (allocator->info._t == NULL) allocator->info._t = _fallback_ ##_t;
 795
 796   g_return_val_if_fail (info != NULL, NULL);
 797   g_return_val_if_fail (info->alloc != NULL, NULL);
 798   g_return_val_if_fail (info->mem_map != NULL, NULL);
 799   g_return_val_if_fail (info->mem_unmap != NULL, NULL);
 800   g_return_val_if_fail (info->mem_free != NULL, NULL);
 801   g_return_val_if_fail (info->mem_share != NULL, NULL);
 802
 803   allocator = g_slice_new (GstAllocator);
 804   allocator->refcount = 1;
 805   allocator->info = *info;
 806   allocator->user_data = user_data;
 807   allocator->notify = notify;
 808   INSTALL_FALLBACK (mem_copy);
 809   INSTALL_FALLBACK (mem_is_span);
 810 #undef INSTALL_FALLBACK
 811
 812   GST_CAT_DEBUG (GST_CAT_MEMORY, "new allocator %p", allocator);
 813
 814 #ifndef GST_DISABLE_TRACE
 815   _gst_alloc_trace_new (_gst_allocator_trace, allocator);
 816 #endif
 817
 818   return allocator;
 819 }
 820
 821 /**
 822  * gst_alocator_get_memory_type:
 823  * @allocator: a #GstAllocator
 824  *
 825  * Get the memory type allocated by this allocator
 826  *
 827  * Returns: @allocator with increased refcount
 828  */
 829 const gchar *
 830 gst_allocator_get_memory_type (GstAllocator * allocator)
 831 {
 832   g_return_val_if_fail (allocator != NULL, NULL);
 833
 834   return allocator->info.mem_type;
 835 }
 836
 837 /**
 838  * gst_alocator_ref:
 839  * @allocator: a #GstAllocator
 840  *
 841  * Increases the refcount of @allocator.
 842  *
 843  * Returns: @allocator with increased refcount
 844  */
 845 GstAllocator *
 846 gst_allocator_ref (GstAllocator * allocator)
 847 {
 848   g_return_val_if_fail (allocator != NULL, NULL);
 849
 850   GST_CAT_TRACE (GST_CAT_MEMORY, "alocator %p, %d->%d", allocator,
 851       allocator->refcount, allocator->refcount + 1);
 852
 853   g_atomic_int_inc (&allocator->refcount);
 854
 855   return allocator;
 856 }
 857
 858 /**
 859  * gst_allocator_unref:
 860  * @allocator: a #GstAllocator
 861  *
 862  * Decreases the refcount of @allocator. When the refcount reaches 0, the free
 863  * function of @allocator will be called.
 864  */
 865 void
 866 gst_allocator_unref (GstAllocator * allocator)
 867 {
 868   g_return_if_fail (allocator != NULL);
 869
 870   GST_CAT_TRACE (GST_CAT_MEMORY, "allocator %p, %d->%d", allocator,
 871       allocator->refcount, allocator->refcount - 1);
 872
 873   if (g_atomic_int_dec_and_test (&allocator->refcount)) {
 874     if (allocator->notify)
 875       allocator->notify (allocator->user_data);
 876 #ifndef GST_DISABLE_TRACE
 877     _gst_alloc_trace_free (_gst_allocator_trace, allocator);
 878 #endif
 879     g_slice_free1 (sizeof (GstAllocator), allocator);
 880   }
 881 }
 882
 883 /**
 884  * gst_allocator_register:
 885  * @name: the name of the allocator
 886  * @allocator: (transfer full): #GstAllocator
 887  *
 888  * Registers the memory @allocator with @name. This function takes ownership of
 889  * @allocator.
 890  */
 891 void
 892 gst_allocator_register (const gchar * name, GstAllocator * allocator)
 893 {
 894   g_return_if_fail (name != NULL);
 895   g_return_if_fail (allocator != NULL);
 896
 897   GST_CAT_DEBUG (GST_CAT_MEMORY, "registering allocator %p with name \"%s\"",
 898       allocator, name);
 899
 900   g_rw_lock_writer_lock (&lock);
 901   g_hash_table_insert (allocators, (gpointer) name, (gpointer) allocator);
 902   g_rw_lock_writer_unlock (&lock);
 903 }
 904
 905 /**
 906  * gst_allocator_find:
 907  * @name: the name of the allocator
 908  *
 909  * Find a previously registered allocator with @name. When @name is NULL, the
 910  * default allocator will be returned.
 911  *
 912  * Returns: (transfer full): a #GstAllocator or NULL when the allocator with @name was not
 913  * registered. Use gst_allocator_unref() to release the allocator after usage.
 914  */
 915 GstAllocator *
 916 gst_allocator_find (const gchar * name)
 917 {
 918   GstAllocator *allocator;
 919
 920   g_rw_lock_reader_lock (&lock);
 921   if (name) {
 922     allocator = g_hash_table_lookup (allocators, (gconstpointer) name);
 923   } else {
 924     allocator = _default_allocator;
 925   }
 926   if (allocator)
 927     gst_allocator_ref (allocator);
 928   g_rw_lock_reader_unlock (&lock);
 929
 930   return allocator;
 931 }
 932
 933 /**
 934  * gst_allocator_set_default:
 935  * @allocator: (transfer full): a #GstAllocator
 936  *
 937  * Set the default allocator. This function takes ownership of @allocator.
 938  */
 939 void
 940 gst_allocator_set_default (GstAllocator * allocator)
 941 {
 942   GstAllocator *old;
 943   g_return_if_fail (allocator != NULL);
 944
 945   g_rw_lock_writer_lock (&lock);
 946   old = _default_allocator;
 947   _default_allocator = allocator;
 948   g_rw_lock_writer_unlock (&lock);
 949
 950   if (old)
 951     gst_allocator_unref (old);
 952 }
 953
 954 /**
 955  * gst_allocator_alloc:
 956  * @allocator: (transfer none) (allow-none): a #GstAllocator to use
 957  * @maxsize: allocated size of @data
 958  * @align: alignment for the data
 959  *
 960  * Use @allocator to allocate a new memory block with memory that is at least
 961  * @maxsize big and has the given alignment.
 962  *
 963  * When @allocator is NULL, the default allocator will be used.
 964  *
 965  * @align is given as a bitmask so that @align + 1 equals the amount of bytes to
 966  * align to. For example, to align to 8 bytes, use an alignment of 7.
 967  *
 968  * Returns: (transfer full): a new #GstMemory.
 969  */
 970 GstMemory *
 971 gst_allocator_alloc (GstAllocator * allocator, gsize maxsize, gsize align)
 972 {
 973   GstMemory *mem;
 974
 975   g_return_val_if_fail (((align + 1) & align) == 0, NULL);
 976
 977   if (allocator == NULL)
 978     allocator = _default_allocator;
 979
 980   mem = allocator->info.alloc (allocator, maxsize, align, allocator->user_data);
 981 #ifndef GST_DISABLE_TRACE
 982   _gst_alloc_trace_new (_gst_memory_trace, mem);
 983 #endif
 984   return mem;
 985 }