Merge branch '0.10'
[platform/upstream/gstreamer.git] / gst / gstmemory.c
index 22b35f5..5a7f289 100644 (file)
@@ -38,7 +38,8 @@
  *
  * New allocators can be registered with gst_allocator_register().
  * Allocators are identified by name and can be retrieved with
- * gst_allocator_find().
+ * gst_allocator_find(). gst_allocator_set_default() can be used to change the
+ * default allocator.
  *
  * New memory can be created with gst_memory_new_wrapped() that wraps the memory
  * allocated elsewhere.
@@ -60,7 +61,7 @@
  *
  * Memory can be efficiently merged when gst_memory_is_span() returns TRUE.
  *
- * Last reviewed on 2011-06-08 (0.11.0)
+ * Last reviewed on 2012-03-28 (0.11.3)
  */
 
 #ifdef HAVE_CONFIG_H
@@ -82,12 +83,10 @@ G_DEFINE_BOXED_TYPE (GstMemory, gst_memory, (GBoxedCopyFunc) gst_memory_ref,
 G_DEFINE_BOXED_TYPE (GstAllocator, gst_allocator,
     (GBoxedCopyFunc) gst_allocator_ref, (GBoxedFreeFunc) gst_allocator_unref);
 
-/**
- * gst_memory_alignment:
- *
- * The default memory alignment in bytes - 1
- * an alignment of 7 would be the same as what malloc() guarantees.
- */
+G_DEFINE_BOXED_TYPE (GstAllocationParams, gst_allocation_params,
+    (GBoxedCopyFunc) gst_allocation_params_copy,
+    (GBoxedFreeFunc) gst_allocation_params_free);
+
 #if defined(MEMORY_ALIGNMENT_MALLOC)
 size_t gst_memory_alignment = 7;
 #elif defined(MEMORY_ALIGNMENT_PAGESIZE)
@@ -130,8 +129,8 @@ static GstAllocator *_default_mem_impl;
 static void
 _default_mem_init (GstMemoryDefault * mem, GstMemoryFlags flags,
     GstMemory * parent, gsize slice_size, gpointer data,
-    gsize maxsize, gsize offset, gsize size, gpointer user_data,
-    GDestroyNotify notify)
+    gsize maxsize, gsize offset, gsize size, gsize align,
+    gpointer user_data, GDestroyNotify notify)
 {
   mem->mem.allocator = _default_mem_impl;
   mem->mem.flags = flags;
@@ -139,6 +138,7 @@ _default_mem_init (GstMemoryDefault * mem, GstMemoryFlags flags,
   mem->mem.parent = parent ? gst_memory_ref (parent) : NULL;
   mem->mem.state = (flags & GST_MEMORY_FLAG_READONLY ? 0x1 : 0);
   mem->mem.maxsize = maxsize;
+  mem->mem.align = align;
   mem->mem.offset = offset;
   mem->mem.size = size;
   mem->slice_size = slice_size;
@@ -154,7 +154,7 @@ _default_mem_init (GstMemoryDefault * mem, GstMemoryFlags flags,
 /* create a new memory block that manages the given memory */
 static GstMemoryDefault *
 _default_mem_new (GstMemoryFlags flags, GstMemory * parent, gpointer data,
-    gsize maxsize, gsize offset, gsize size, gpointer user_data,
+    gsize maxsize, gsize offset, gsize size, gsize align, gpointer user_data,
     GDestroyNotify notify)
 {
   GstMemoryDefault *mem;
@@ -164,7 +164,7 @@ _default_mem_new (GstMemoryFlags flags, GstMemory * parent, gpointer data,
 
   mem = g_slice_alloc (slice_size);
   _default_mem_init (mem, flags, parent, slice_size,
-      data, maxsize, offset, size, user_data, notify);
+      data, maxsize, offset, size, align, user_data, notify);
 
   return mem;
 }
@@ -191,6 +191,7 @@ _default_mem_new_block (GstMemoryFlags flags, gsize maxsize, gsize align,
 
   data = (guint8 *) mem + sizeof (GstMemoryDefault);
 
+  /* do alignment */
   if ((aoffset = ((guintptr) data & align))) {
     aoffset = (align + 1) - aoffset;
     data += aoffset;
@@ -205,17 +206,19 @@ _default_mem_new_block (GstMemoryFlags flags, gsize maxsize, gsize align,
     memset (data + offset + size, 0, padding);
 
   _default_mem_init (mem, flags, NULL, slice_size, data, maxsize,
-      offset, size, NULL, NULL);
+      offset, size, align, NULL, NULL);
 
   return mem;
 }
 
 static GstMemory *
-_default_alloc_alloc (GstAllocator * allocator, GstMemoryFlags flags,
-    gsize maxsize, gsize offset, gsize size, gsize align, gpointer user_data)
+_default_alloc_alloc (GstAllocator * allocator, gsize size,
+    GstAllocationParams * params, gpointer user_data)
 {
-  return (GstMemory *) _default_mem_new_block (flags, maxsize, align, offset,
-      size);
+  gsize maxsize = size + params->prefix + params->padding;
+
+  return (GstMemory *) _default_mem_new_block (params->flags,
+      maxsize, params->align, params->prefix, size);
 }
 
 static gpointer
@@ -276,7 +279,8 @@ _default_mem_share (GstMemoryDefault * mem, gssize offset, gsize size)
 
   sub =
       _default_mem_new (parent->flags, parent, mem->data,
-      mem->mem.maxsize, mem->mem.offset + offset, size, NULL, NULL);
+      mem->mem.maxsize, mem->mem.offset + offset, size, mem->mem.align, NULL,
+      NULL);
 
   return sub;
 }
@@ -304,6 +308,7 @@ _fallback_mem_copy (GstMemory * mem, gssize offset, gssize size)
 {
   GstMemory *copy;
   GstMapInfo sinfo, dinfo;
+  GstAllocationParams params = { 0, 0, 0, mem->align, };
 
   if (!gst_memory_map (mem, &sinfo, GST_MAP_READ))
     return NULL;
@@ -312,7 +317,7 @@ _fallback_mem_copy (GstMemory * mem, gssize offset, gssize size)
     size = sinfo.size > offset ? sinfo.size - offset : 0;
 
   /* use the same allocator as the memory we copy  */
-  copy = gst_allocator_alloc (mem->allocator, 0, size, 0, size, mem->align);
+  copy = gst_allocator_alloc (mem->allocator, size, &params);
   if (!gst_memory_map (copy, &dinfo, GST_MAP_WRITE)) {
     GST_CAT_WARNING (GST_CAT_MEMORY, "could not write map memory %p", copy);
     gst_memory_unmap (mem, &sinfo);
@@ -408,7 +413,7 @@ gst_memory_new_wrapped (GstMemoryFlags flags, gpointer data,
   g_return_val_if_fail (offset + size <= maxsize, NULL);
 
   mem =
-      _default_mem_new (flags, NULL, data, maxsize, offset, size, user_data,
+      _default_mem_new (flags, NULL, data, maxsize, offset, size, 0, user_data,
       notify);
 
 #ifndef GST_DISABLE_TRACE
@@ -805,7 +810,7 @@ gst_memory_is_span (GstMemory * mem1, GstMemory * mem2, gsize * offset)
 }
 
 /**
- * gst_allocator_register:
+ * gst_allocator_new:
  * @info: a #GstMemoryInfo
  * @user_data: user data
  * @notify: a #GDestroyNotify for @user_data
@@ -855,7 +860,7 @@ gst_allocator_new (const GstMemoryInfo * info, gpointer user_data,
 }
 
 /**
- * gst_alocator_get_memory_type:
+ * gst_allocator_get_memory_type:
  * @allocator: a #GstAllocator
  *
  * Get the memory type allocated by this allocator
@@ -871,7 +876,7 @@ gst_allocator_get_memory_type (GstAllocator * allocator)
 }
 
 /**
- * gst_alocator_ref:
+ * gst_allocator_ref:
  * @allocator: a #GstAllocator
  *
  * Increases the refcount of @allocator.
@@ -883,7 +888,7 @@ gst_allocator_ref (GstAllocator * allocator)
 {
   g_return_val_if_fail (allocator != NULL, NULL);
 
-  GST_CAT_TRACE (GST_CAT_MEMORY, "alocator %p, %d->%d", allocator,
+  GST_CAT_TRACE (GST_CAT_MEMORY, "allocator %p, %d->%d", allocator,
       allocator->refcount, allocator->refcount + 1);
 
   g_atomic_int_inc (&allocator->refcount);
@@ -988,42 +993,97 @@ gst_allocator_set_default (GstAllocator * allocator)
 }
 
 /**
+ * gst_allocation_params_init:
+ * @params: a #GstAllocationParams
+ *
+ * Initialize @params to its default values
+ */
+void
+gst_allocation_params_init (GstAllocationParams * params)
+{
+  g_return_if_fail (params != NULL);
+
+  memset (params, 0, sizeof (GstAllocationParams));
+}
+
+/**
+ * gst_allocation_params_copy:
+ * @params: (transfer none): a #GstAllocationParams
+ *
+ * Create a copy of @params.
+ *
+ * Free-function: gst_allocation_params_free
+ *
+ * Returns: (transfer full): a new ##GstAllocationParams, free with
+ * gst_allocation_params_free().
+ */
+GstAllocationParams *
+gst_allocation_params_copy (const GstAllocationParams * params)
+{
+  GstAllocationParams *result = NULL;
+
+  if (params) {
+    result =
+        (GstAllocationParams *) g_slice_copy (sizeof (GstAllocationParams),
+        params);
+  }
+  return result;
+}
+
+/**
+ * gst_allocation_params_free:
+ * @params: (in) (transfer full): a #GstAllocationParams
+ *
+ * Free @params
+ */
+void
+gst_allocation_params_free (GstAllocationParams * params)
+{
+  g_slice_free (GstAllocationParams, params);
+}
+
+/**
  * gst_allocator_alloc:
  * @allocator: (transfer none) (allow-none): a #GstAllocator to use
- * @flags: the flags
- * @maxsize: allocated size of @data
- * @offset: offset in allocated memory
- * @size: size of visible
- * @align: alignment for the data
+ * @size: size of the visible memory area
+ * @params: (transfer none) (allow-none): optional parameters
  *
  * Use @allocator to allocate a new memory block with memory that is at least
- * @maxsize big and has the given alignment.
+ * @size big.
  *
- * @offset and @size describe the start and size of the accessible memory.
+ * The optional @params can specify the prefix and padding for the memory. If
+ * NULL is passed, no flags, no extra prefix/padding and a default alignment is
+ * used.
  *
- * The prefix/padding will be filled with 0 if @flags contains
+ * The prefix/padding will be filled with 0 if flags contains
  * #GST_MEMORY_FLAG_ZERO_PREFIXED and #GST_MEMORY_FLAG_ZERO_PADDED respectively.
  *
  * When @allocator is NULL, the default allocator will be used.
  *
- * @align is given as a bitmask so that @align + 1 equals the amount of bytes to
- * align to. For example, to align to 8 bytes, use an alignment of 7.
+ * The alignment in @params is given as a bitmask so that @align + 1 equals
+ * the amount of bytes to align to. For example, to align to 8 bytes,
+ * use an alignment of 7.
  *
  * Returns: (transfer full): a new #GstMemory.
  */
 GstMemory *
-gst_allocator_alloc (GstAllocator * allocator, GstMemoryFlags flags,
-    gsize maxsize, gsize offset, gsize size, gsize align)
+gst_allocator_alloc (GstAllocator * allocator, gsize size,
+    GstAllocationParams * params)
 {
   GstMemory *mem;
+  static GstAllocationParams defparams = { 0, 0, 0, 0, };
 
-  g_return_val_if_fail (((align + 1) & align) == 0, NULL);
+  if (params) {
+    g_return_val_if_fail (((params->align + 1) & params->align) == 0, NULL);
+  } else {
+    params = &defparams;
+  }
 
   if (allocator == NULL)
     allocator = _default_allocator;
 
-  mem = allocator->info.alloc (allocator, flags, maxsize, offset, size,
-      align, allocator->user_data);
+  mem = allocator->info.alloc (allocator, size, params, allocator->user_data);
+
 #ifndef GST_DISABLE_TRACE
   _gst_alloc_trace_new (_gst_memory_trace, mem);
 #endif