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