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 static GstMemory *
  77 _gst_memory_copy (GstMemory * mem)
  78 {
  79   GST_CAT_DEBUG (GST_CAT_MEMORY, "copy memory %p", mem);
  80   return gst_memory_copy (mem, 0, -1);
  81 }
  82
  83 static void
  84 _gst_memory_free (GstMemory * mem)
  85 {
  86   GST_CAT_DEBUG (GST_CAT_MEMORY, "free memory %p", mem);
  87
  88   if (mem->parent) {
  89     gst_memory_unlock (mem->parent, GST_LOCK_FLAG_EXCLUSIVE);
  90     gst_memory_unref (mem->parent);
  91   }
  92
  93   gst_allocator_free (mem->allocator, mem);
  94 }
  95
  96 /**
  97  * gst_memory_init: (skip)
  98  * @mem: a #GstMemory
  99  * @flags: #GstMemoryFlags
 100  * @allocator: the #GstAllocator
 101  * @parent: the parent of @mem
 102  * @maxsize: the total size of the memory
 103  * @align: the alignment of the memory
 104  * @offset: The offset in the memory
 105  * @size: the size of valid data in the memory
 106
 107  * Initializes a newly allocated @mem with the given parameters. This function
 108  * will call gst_mini_object_init() with the default memory parameters.
 109  */
 110 void
 111 gst_memory_init (GstMemory * mem, GstMemoryFlags flags,
 112     GstAllocator * allocator, GstMemory * parent, gsize maxsize, gsize align,
 113     gsize offset, gsize size)
 114 {
 115   gst_mini_object_init (GST_MINI_OBJECT_CAST (mem),
 116       flags | GST_MINI_OBJECT_FLAG_LOCKABLE, GST_TYPE_MEMORY,
 117       (GstMiniObjectCopyFunction) _gst_memory_copy, NULL,
 118       (GstMiniObjectFreeFunction) _gst_memory_free);
 119
 120   mem->allocator = allocator;
 121   if (parent) {
 122     gst_memory_lock (parent, GST_LOCK_FLAG_EXCLUSIVE);
 123     gst_memory_ref (parent);
 124   }
 125   mem->parent = parent;
 126   mem->maxsize = maxsize;
 127   mem->align = align;
 128   mem->offset = offset;
 129   mem->size = size;
 130
 131   GST_CAT_DEBUG (GST_CAT_MEMORY, "new memory %p, maxsize:%" G_GSIZE_FORMAT
 132       " offset:%" G_GSIZE_FORMAT " size:%" G_GSIZE_FORMAT, mem, maxsize,
 133       offset, size);
 134 }
 135
 136 /**
 137  * gst_memory_get_sizes:
 138  * @mem: a #GstMemory
 139  * @offset: pointer to offset
 140  * @maxsize: pointer to maxsize
 141  *
 142  * Get the current @size, @offset and @maxsize of @mem.
 143  *
 144  * Returns: the current sizes of @mem
 145  */
 146 gsize
 147 gst_memory_get_sizes (GstMemory * mem, gsize * offset, gsize * maxsize)
 148 {
 149   g_return_val_if_fail (mem != NULL, 0);
 150
 151   if (offset)
 152     *offset = mem->offset;
 153   if (maxsize)
 154     *maxsize = mem->maxsize;
 155
 156   return mem->size;
 157 }
 158
 159 /**
 160  * gst_memory_resize:
 161  * @mem: a #GstMemory
 162  * @offset: a new offset
 163  * @size: a new size
 164  *
 165  * Resize the memory region. @mem should be writable and offset + size should be
 166  * less than the maxsize of @mem.
 167  *
 168  * #GST_MEMORY_FLAG_ZERO_PREFIXED and #GST_MEMORY_FLAG_ZERO_PADDED will be
 169  * cleared when offset or padding is increased respectively.
 170  */
 171 void
 172 gst_memory_resize (GstMemory * mem, gssize offset, gsize size)
 173 {
 174   g_return_if_fail (mem != NULL);
 175   g_return_if_fail (offset >= 0 || mem->offset >= -offset);
 176   g_return_if_fail (size + mem->offset + offset <= mem->maxsize);
 177
 178   /* if we increase the prefix, we can't guarantee it is still 0 filled */
 179   if ((offset > 0) && GST_MEMORY_IS_ZERO_PREFIXED (mem))
 180     GST_MEMORY_FLAG_UNSET (mem, GST_MEMORY_FLAG_ZERO_PREFIXED);
 181
 182   /* if we increase the padding, we can't guarantee it is still 0 filled */
 183   if ((offset + size < mem->size) && GST_MEMORY_IS_ZERO_PADDED (mem))
 184     GST_MEMORY_FLAG_UNSET (mem, GST_MEMORY_FLAG_ZERO_PADDED);
 185
 186   mem->offset += offset;
 187   mem->size = size;
 188 }
 189
 190 /**
 191  * gst_memory_make_mapped:
 192  * @mem: (transfer full): a #GstMemory
 193  * @info: (out): pointer for info
 194  * @flags: mapping flags
 195  *
 196  * Create a #GstMemory object that is mapped with @flags. If @mem is mappable
 197  * with @flags, this function returns the mapped @mem directly. Otherwise a
 198  * mapped copy of @mem is returned.
 199  *
 200  * This function takes ownership of old @mem and returns a reference to a new
 201  * #GstMemory.
 202  *
 203  * Returns: (transfer full): a #GstMemory object mapped with @flags or NULL when
 204  * a mapping is not possible.
 205  */
 206 GstMemory *
 207 gst_memory_make_mapped (GstMemory * mem, GstMapInfo * info, GstMapFlags flags)
 208 {
 209   GstMemory *result;
 210
 211   if (gst_memory_map (mem, info, flags)) {
 212     result = mem;
 213   } else {
 214     result = gst_memory_copy (mem, 0, -1);
 215     gst_memory_unref (mem);
 216
 217     if (result == NULL)
 218       goto cannot_copy;
 219
 220     if (!gst_memory_map (result, info, flags))
 221       goto cannot_map;
 222   }
 223   return result;
 224
 225   /* ERRORS */
 226 cannot_copy:
 227   {
 228     GST_CAT_DEBUG (GST_CAT_MEMORY, "cannot copy memory %p", mem);
 229     return NULL;
 230   }
 231 cannot_map:
 232   {
 233     GST_CAT_DEBUG (GST_CAT_MEMORY, "cannot map memory %p with flags %d", mem,
 234         flags);
 235     gst_memory_unref (result);
 236     return NULL;
 237   }
 238 }
 239
 240 /**
 241  * gst_memory_map:
 242  * @mem: a #GstMemory
 243  * @info: (out): pointer for info
 244  * @flags: mapping flags
 245  *
 246  * Fill @info with the pointer and sizes of the memory in @mem that can be
 247  * accessed according to @flags.
 248  *
 249  * This function can return %FALSE for various reasons:
 250  * - the memory backed by @mem is not accessible with the given @flags.
 251  * - the memory was already mapped with a different mapping.
 252  *
 253  * @info and its contents remain valid for as long as @mem is valid and
 254  * until gst_memory_unmap() is called.
 255  *
 256  * For each gst_memory_map() call, a corresponding gst_memory_unmap() call
 257  * should be done.
 258  *
 259  * Returns: %TRUE if the map operation was successful.
 260  */
 261 gboolean
 262 gst_memory_map (GstMemory * mem, GstMapInfo * info, GstMapFlags flags)
 263 {
 264   g_return_val_if_fail (mem != NULL, FALSE);
 265   g_return_val_if_fail (info != NULL, FALSE);
 266
 267   if (!gst_memory_lock (mem, flags))
 268     goto lock_failed;
 269
 270   info->data = mem->allocator->mem_map (mem, mem->maxsize, flags);
 271
 272   if (G_UNLIKELY (info->data == NULL))
 273     goto error;
 274
 275   info->memory = mem;
 276   info->flags = flags;
 277   info->size = mem->size;
 278   info->maxsize = mem->maxsize - mem->offset;
 279   info->data = info->data + mem->offset;
 280
 281   return TRUE;
 282
 283   /* ERRORS */
 284 lock_failed:
 285   {
 286     GST_CAT_DEBUG (GST_CAT_MEMORY, "mem %p: lock %d failed", mem, flags);
 287     return FALSE;
 288   }
 289 error:
 290   {
 291     /* something went wrong, restore the orginal state again */
 292     GST_CAT_ERROR (GST_CAT_MEMORY, "mem %p: subclass map failed", mem);
 293     gst_memory_unlock (mem, flags);
 294     return FALSE;
 295   }
 296 }
 297
 298 /**
 299  * gst_memory_unmap:
 300  * @mem: a #GstMemory
 301  * @info: a #GstMapInfo
 302  *
 303  * Release the memory obtained with gst_memory_map()
 304  */
 305 void
 306 gst_memory_unmap (GstMemory * mem, GstMapInfo * info)
 307 {
 308   g_return_if_fail (mem != NULL);
 309   g_return_if_fail (info != NULL);
 310   g_return_if_fail (info->memory == mem);
 311
 312   mem->allocator->mem_unmap (mem);
 313   gst_memory_unlock (mem, info->flags);
 314 }
 315
 316 /**
 317  * gst_memory_copy:
 318  * @mem: a #GstMemory
 319  * @offset: an offset to copy
 320  * @size: size to copy or -1 to copy all bytes from offset
 321  *
 322  * Return a copy of @size bytes from @mem starting from @offset. This copy is
 323  * guaranteed to be writable. @size can be set to -1 to return a copy all bytes
 324  * from @offset.
 325  *
 326  * Returns: a new #GstMemory.
 327  */
 328 GstMemory *
 329 gst_memory_copy (GstMemory * mem, gssize offset, gssize size)
 330 {
 331   GstMemory *copy;
 332
 333   g_return_val_if_fail (mem != NULL, NULL);
 334
 335   copy = mem->allocator->mem_copy (mem, offset, size);
 336
 337   return copy;
 338 }
 339
 340 /**
 341  * gst_memory_share:
 342  * @mem: a #GstMemory
 343  * @offset: an offset to share
 344  * @size: size to share or -1 to share bytes from offset
 345  *
 346  * Return a shared copy of @size bytes from @mem starting from @offset. No
 347  * memory copy is performed and the memory region is simply shared. The result
 348  * is guaranteed to be not-writable. @size can be set to -1 to return a share
 349  * all bytes from @offset.
 350  *
 351  * Returns: a new #GstMemory.
 352  */
 353 GstMemory *
 354 gst_memory_share (GstMemory * mem, gssize offset, gssize size)
 355 {
 356   GstMemory *shared;
 357
 358   g_return_val_if_fail (mem != NULL, NULL);
 359   g_return_val_if_fail (!GST_MEMORY_FLAG_IS_SET (mem, GST_MEMORY_FLAG_NO_SHARE),
 360       NULL);
 361
 362   shared = mem->allocator->mem_share (mem, offset, size);
 363
 364   return shared;
 365 }
 366
 367 /**
 368  * gst_memory_is_span:
 369  * @mem1: a #GstMemory
 370  * @mem2: a #GstMemory
 371  * @offset: a pointer to a result offset
 372  *
 373  * Check if @mem1 and mem2 share the memory with a common parent memory object
 374  * and that the memory is contiguous.
 375  *
 376  * If this is the case, the memory of @mem1 and @mem2 can be merged
 377  * efficiently by performing gst_memory_share() on the parent object from
 378  * the returned @offset.
 379  *
 380  * Returns: %TRUE if the memory is contiguous and of a common parent.
 381  */
 382 gboolean
 383 gst_memory_is_span (GstMemory * mem1, GstMemory * mem2, gsize * offset)
 384 {
 385   g_return_val_if_fail (mem1 != NULL, FALSE);
 386   g_return_val_if_fail (mem2 != NULL, FALSE);
 387
 388   /* need to have the same allocators */
 389   if (mem1->allocator != mem2->allocator)
 390     return FALSE;
 391
 392   /* need to have the same parent */
 393   if (mem1->parent == NULL || mem1->parent != mem2->parent)
 394     return FALSE;
 395
 396   /* and memory is contiguous */
 397   if (!mem1->allocator->mem_is_span (mem1, mem2, offset))
 398     return FALSE;
 399
 400   return TRUE;
 401 }