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