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