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