miniobjects: pass copy, dispose and free function to gst_mini_object_init()
[platform/upstream/gstreamer.git] / gst / gstmemory.c
index 8cda557..efcb73c 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
 #include "gst_private.h"
 #include "gstmemory.h"
 
-#ifndef GST_DISABLE_TRACE
-#include "gsttrace.h"
-static GstAllocTrace *_gst_memory_trace;
-static GstAllocTrace *_gst_allocator_trace;
-#endif
+GST_DEFINE_MINI_OBJECT_TYPE (GstMemory, gst_memory);
 
-G_DEFINE_BOXED_TYPE (GstMemory, gst_memory, (GBoxedCopyFunc) gst_memory_ref,
-    (GBoxedFreeFunc) gst_memory_unref);
+GST_DEFINE_MINI_OBJECT_TYPE (GstAllocator, gst_allocator);
 
-G_DEFINE_BOXED_TYPE (GstAllocator, gst_allocator,
-    (GBoxedCopyFunc) gst_allocator_ref, (GBoxedFreeFunc) gst_allocator_unref);
+G_DEFINE_BOXED_TYPE (GstAllocationParams, gst_allocation_params,
+    (GBoxedCopyFunc) gst_allocation_params_copy,
+    (GBoxedFreeFunc) gst_allocation_params_free);
 
-/**
- * gst_memory_alignment:
- *
- * The default memory alignment in bytes - 1
- * an alignment of 7 would be the same as what malloc() guarantees.
- */
 #if defined(MEMORY_ALIGNMENT_MALLOC)
 size_t gst_memory_alignment = 7;
 #elif defined(MEMORY_ALIGNMENT_PAGESIZE)
@@ -102,7 +93,7 @@ size_t gst_memory_alignment = 0;
 
 struct _GstAllocator
 {
-  gint refcount;
+  GstMiniObject mini_object;
 
   GstMemoryInfo info;
 
@@ -126,19 +117,38 @@ static GstAllocator *_default_allocator;
 /* our predefined allocators */
 static GstAllocator *_default_mem_impl;
 
+static GstMemory *
+_gst_memory_copy (GstMemory * mem)
+{
+  return gst_memory_copy (mem, 0, -1);
+}
+
+static void
+_gst_memory_free (GstMemory * mem)
+{
+  /* there should be no outstanding mappings */
+  g_return_if_fail (g_atomic_int_get (&mem->state) < 4);
+  mem->allocator->info.mem_free (mem);
+}
+
 /* initialize the fields */
 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)
 {
+  gst_mini_object_init (GST_MINI_OBJECT_CAST (mem), GST_TYPE_MEMORY,
+      (GstMiniObjectCopyFunction) _gst_memory_copy, NULL,
+      (GstMiniObjectFreeFunction) _gst_memory_free);
+
+  mem->mem.mini_object.flags = flags;
+
   mem->mem.allocator = _default_mem_impl;
-  mem->mem.flags = flags;
-  mem->mem.refcount = 1;
   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;
@@ -146,13 +156,15 @@ _default_mem_init (GstMemoryDefault * mem, GstMemoryFlags flags,
   mem->user_data = user_data;
   mem->notify = notify;
 
-  GST_CAT_DEBUG (GST_CAT_MEMORY, "new memory %p", mem);
+  GST_CAT_DEBUG (GST_CAT_MEMORY, "new memory %p, maxsize:%" G_GSIZE_FORMAT
+      " offset:%" G_GSIZE_FORMAT " size:%" G_GSIZE_FORMAT, mem, maxsize,
+      offset, size);
 }
 
 /* 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;
@@ -162,17 +174,18 @@ _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;
 }
 
 /* allocate the memory and structure in one block */
 static GstMemoryDefault *
-_default_mem_new_block (gsize maxsize, gsize align, gsize offset, gsize size)
+_default_mem_new_block (GstMemoryFlags flags, gsize maxsize, gsize align,
+    gsize offset, gsize size)
 {
   GstMemoryDefault *mem;
-  gsize aoffset, slice_size;
+  gsize aoffset, slice_size, padding;
   guint8 *data;
 
   /* ensure configured alignment */
@@ -188,24 +201,38 @@ _default_mem_new_block (gsize maxsize, gsize align, gsize offset, gsize size)
 
   data = (guint8 *) mem + sizeof (GstMemoryDefault);
 
-  if ((aoffset = ((guintptr) data & align)))
+  /* do alignment */
+  if ((aoffset = ((guintptr) data & align))) {
     aoffset = (align + 1) - aoffset;
+    data += aoffset;
+    maxsize -= aoffset;
+  }
 
-  _default_mem_init (mem, 0, NULL, slice_size, data, maxsize,
-      aoffset + offset, size, NULL, NULL);
+  if (offset && (flags & GST_MEMORY_FLAG_ZERO_PREFIXED))
+    memset (data, 0, offset);
+
+  padding = maxsize - (offset + size);
+  if (padding && (flags & GST_MEMORY_FLAG_ZERO_PADDED))
+    memset (data + offset + size, 0, padding);
+
+  _default_mem_init (mem, flags, NULL, slice_size, data, maxsize,
+      offset, size, align, NULL, NULL);
 
   return mem;
 }
 
 static GstMemory *
-_default_alloc_alloc (GstAllocator * allocator, gsize maxsize, gsize align,
-    gpointer user_data)
+_default_alloc_alloc (GstAllocator * allocator, gsize size,
+    GstAllocationParams * params, gpointer user_data)
 {
-  return (GstMemory *) _default_mem_new_block (maxsize, align, 0, maxsize);
+  gsize maxsize = size + params->prefix + params->padding;
+
+  return (GstMemory *) _default_mem_new_block (params->flags,
+      maxsize, params->align, params->prefix, size);
 }
 
 static gpointer
-_default_mem_map (GstMemoryDefault * mem, GstMapFlags flags)
+_default_mem_map (GstMemoryDefault * mem, gsize maxsize, GstMapFlags flags)
 {
   return mem->data;
 }
@@ -239,10 +266,12 @@ _default_mem_copy (GstMemoryDefault * mem, gssize offset, gsize size)
     size = mem->mem.size > offset ? mem->mem.size - offset : 0;
 
   copy =
-      _default_mem_new_block (mem->mem.maxsize, 0, mem->mem.offset + offset,
+      _default_mem_new_block (0, mem->mem.maxsize, 0, mem->mem.offset + offset,
       size);
+  GST_CAT_DEBUG (GST_CAT_PERFORMANCE,
+      "memcpy %" G_GSIZE_FORMAT " memory %p -> %p", mem->mem.maxsize, mem,
+      copy);
   memcpy (copy->data, mem->data, mem->mem.maxsize);
-  GST_CAT_DEBUG (GST_CAT_PERFORMANCE, "copy memory %p -> %p", mem, copy);
 
   return copy;
 }
@@ -261,8 +290,9 @@ _default_mem_share (GstMemoryDefault * mem, gssize offset, gsize size)
     size = mem->mem.size - offset;
 
   sub =
-      _default_mem_new (parent->flags, parent, mem->data,
-      mem->mem.maxsize, mem->mem.offset + offset, size, NULL, NULL);
+      _default_mem_new (GST_MINI_OBJECT_FLAGS (parent), parent, mem->data,
+      mem->mem.maxsize, mem->mem.offset + offset, size, mem->mem.align, NULL,
+      NULL);
 
   return sub;
 }
@@ -290,6 +320,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;
@@ -298,15 +329,16 @@ _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, 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);
     return NULL;
   }
 
+  GST_CAT_DEBUG (GST_CAT_PERFORMANCE,
+      "memcpy %" G_GSSIZE_FORMAT " memory %p -> %p", size, mem, copy);
   memcpy (dinfo.data, sinfo.data + offset, size);
-  GST_CAT_DEBUG (GST_CAT_PERFORMANCE, "copy memory %p -> %p", mem, copy);
   gst_memory_unmap (copy, &dinfo);
   gst_memory_unmap (mem, &sinfo);
 
@@ -342,11 +374,6 @@ _priv_gst_memory_initialize (void)
     (GstMemoryIsSpanFunction) _default_mem_is_span,
   };
 
-#ifndef GST_DISABLE_TRACE
-  _gst_memory_trace = _gst_alloc_trace_register ("GstMemory", -1);
-  _gst_allocator_trace = _gst_alloc_trace_register ("GstAllocator", -1);
-#endif
-
   g_rw_lock_init (&lock);
   allocators = g_hash_table_new (g_str_hash, g_str_equal);
 
@@ -378,6 +405,9 @@ _priv_gst_memory_initialize (void)
  *
  * Allocate a new memory block that wraps the given @data.
  *
+ * The prefix/padding must be filled with 0 if @flags contains
+ * #GST_MEMORY_FLAG_ZERO_PREFIXED and #GST_MEMORY_FLAG_ZERO_PADDED respectively.
+ *
  * Returns: a new #GstMemory.
  */
 GstMemory *
@@ -391,64 +421,13 @@ 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
-  _gst_alloc_trace_new (_gst_memory_trace, mem);
-#endif
-
   return (GstMemory *) mem;
 }
 
 /**
- * gst_memory_ref:
- * @mem: a #GstMemory
- *
- * Increases the refcount of @mem.
- *
- * Returns: @mem with increased refcount
- */
-GstMemory *
-gst_memory_ref (GstMemory * mem)
-{
-  g_return_val_if_fail (mem != NULL, NULL);
-
-  GST_CAT_TRACE (GST_CAT_MEMORY, "memory %p, %d->%d", mem, mem->refcount,
-      mem->refcount + 1);
-
-  g_atomic_int_inc (&mem->refcount);
-
-  return mem;
-}
-
-/**
- * gst_memory_unref:
- * @mem: a #GstMemory
- *
- * Decreases the refcount of @mem. When the refcount reaches 0, the free
- * function of @mem will be called.
- */
-void
-gst_memory_unref (GstMemory * mem)
-{
-  g_return_if_fail (mem != NULL);
-  g_return_if_fail (mem->allocator != NULL);
-
-  GST_CAT_TRACE (GST_CAT_MEMORY, "memory %p, %d->%d", mem, mem->refcount,
-      mem->refcount - 1);
-
-  if (g_atomic_int_dec_and_test (&mem->refcount)) {
-    /* there should be no outstanding mappings */
-    g_return_if_fail (g_atomic_int_get (&mem->state) < 4);
-#ifndef GST_DISABLE_TRACE
-    _gst_alloc_trace_free (_gst_memory_trace, mem);
-#endif
-    mem->allocator->info.mem_free (mem);
-  }
-}
-
-/**
  * gst_memory_is_exclusive:
  * @mem: a #GstMemory
  *
@@ -460,7 +439,7 @@ gst_memory_is_exclusive (GstMemory * mem)
 {
   g_return_val_if_fail (mem != NULL, FALSE);
 
-  return (g_atomic_int_get (&mem->refcount) == 1);
+  return GST_MINI_OBJECT_REFCOUNT_VALUE (mem) == 1;
 }
 
 /**
@@ -494,6 +473,9 @@ gst_memory_get_sizes (GstMemory * mem, gsize * offset, gsize * maxsize)
  *
  * Resize the memory region. @mem should be writable and offset + size should be
  * less than the maxsize of @mem.
+ *
+ * #GST_MEMORY_FLAG_ZERO_PREFIXED and #GST_MEMORY_FLAG_ZERO_PADDED will be
+ * cleared when offset or padding is increased respectively.
  */
 void
 gst_memory_resize (GstMemory * mem, gssize offset, gsize size)
@@ -502,6 +484,14 @@ gst_memory_resize (GstMemory * mem, gssize offset, gsize size)
   g_return_if_fail (offset >= 0 || mem->offset >= -offset);
   g_return_if_fail (size + mem->offset + offset <= mem->maxsize);
 
+  /* if we increase the prefix, we can't guarantee it is still 0 filled */
+  if ((offset > 0) && GST_MEMORY_IS_ZERO_PREFIXED (mem))
+    GST_MEMORY_FLAG_UNSET (mem, GST_MEMORY_FLAG_ZERO_PREFIXED);
+
+  /* if we increase the padding, we can't guarantee it is still 0 filled */
+  if ((offset + size < mem->size) && GST_MEMORY_IS_ZERO_PADDED (mem))
+    GST_MEMORY_FLAG_UNSET (mem, GST_MEMORY_FLAG_ZERO_PADDED);
+
   mem->offset += offset;
   mem->size = size;
 }
@@ -702,10 +692,6 @@ gst_memory_copy (GstMemory * mem, gssize offset, gssize size)
 
   copy = mem->allocator->info.mem_copy (mem, offset, size);
 
-#ifndef GST_DISABLE_TRACE
-  _gst_alloc_trace_new (_gst_memory_trace, copy);
-#endif
-
   return copy;
 }
 
@@ -733,10 +719,6 @@ gst_memory_share (GstMemory * mem, gssize offset, gssize size)
 
   shared = mem->allocator->info.mem_share (mem, offset, size);
 
-#ifndef GST_DISABLE_TRACE
-  _gst_alloc_trace_new (_gst_memory_trace, shared);
-#endif
-
   return shared;
 }
 
@@ -776,8 +758,23 @@ gst_memory_is_span (GstMemory * mem1, GstMemory * mem2, gsize * offset)
   return TRUE;
 }
 
+static void
+_gst_allocator_free (GstAllocator * allocator)
+{
+  if (allocator->notify)
+    allocator->notify (allocator->user_data);
+
+  g_slice_free1 (sizeof (GstAllocator), allocator);
+}
+
+static GstAllocator *
+_gst_allocator_copy (GstAllocator * allocator)
+{
+  return gst_allocator_ref (allocator);
+}
+
 /**
- * gst_allocator_register:
+ * gst_allocator_new:
  * @info: a #GstMemoryInfo
  * @user_data: user data
  * @notify: a #GDestroyNotify for @user_data
@@ -798,9 +795,6 @@ gst_allocator_new (const GstMemoryInfo * info, gpointer user_data,
 {
   GstAllocator *allocator;
 
-#define INSTALL_FALLBACK(_t) \
-  if (allocator->info._t == NULL) allocator->info._t = _fallback_ ##_t;
-
   g_return_val_if_fail (info != NULL, NULL);
   g_return_val_if_fail (info->alloc != NULL, NULL);
   g_return_val_if_fail (info->mem_map != NULL, NULL);
@@ -808,26 +802,29 @@ gst_allocator_new (const GstMemoryInfo * info, gpointer user_data,
   g_return_val_if_fail (info->mem_free != NULL, NULL);
   g_return_val_if_fail (info->mem_share != NULL, NULL);
 
-  allocator = g_slice_new (GstAllocator);
-  allocator->refcount = 1;
+  allocator = g_slice_new0 (GstAllocator);
+
+  gst_mini_object_init (GST_MINI_OBJECT_CAST (allocator), GST_TYPE_ALLOCATOR,
+      (GstMiniObjectCopyFunction) _gst_allocator_copy, NULL,
+      (GstMiniObjectFreeFunction) _gst_allocator_free);
+
   allocator->info = *info;
   allocator->user_data = user_data;
   allocator->notify = notify;
+
+#define INSTALL_FALLBACK(_t) \
+  if (allocator->info._t == NULL) allocator->info._t = _fallback_ ##_t;
   INSTALL_FALLBACK (mem_copy);
   INSTALL_FALLBACK (mem_is_span);
 #undef INSTALL_FALLBACK
 
   GST_CAT_DEBUG (GST_CAT_MEMORY, "new allocator %p", allocator);
 
-#ifndef GST_DISABLE_TRACE
-  _gst_alloc_trace_new (_gst_allocator_trace, allocator);
-#endif
-
   return allocator;
 }
 
 /**
- * gst_alocator_get_memory_type:
+ * gst_allocator_get_memory_type:
  * @allocator: a #GstAllocator
  *
  * Get the memory type allocated by this allocator
@@ -843,52 +840,6 @@ gst_allocator_get_memory_type (GstAllocator * allocator)
 }
 
 /**
- * gst_alocator_ref:
- * @allocator: a #GstAllocator
- *
- * Increases the refcount of @allocator.
- *
- * Returns: @allocator with increased refcount
- */
-GstAllocator *
-gst_allocator_ref (GstAllocator * allocator)
-{
-  g_return_val_if_fail (allocator != NULL, NULL);
-
-  GST_CAT_TRACE (GST_CAT_MEMORY, "alocator %p, %d->%d", allocator,
-      allocator->refcount, allocator->refcount + 1);
-
-  g_atomic_int_inc (&allocator->refcount);
-
-  return allocator;
-}
-
-/**
- * gst_allocator_unref:
- * @allocator: a #GstAllocator
- *
- * Decreases the refcount of @allocator. When the refcount reaches 0, the notify
- * function of @allocator will be called and the allocator will be freed.
- */
-void
-gst_allocator_unref (GstAllocator * allocator)
-{
-  g_return_if_fail (allocator != NULL);
-
-  GST_CAT_TRACE (GST_CAT_MEMORY, "allocator %p, %d->%d", allocator,
-      allocator->refcount, allocator->refcount - 1);
-
-  if (g_atomic_int_dec_and_test (&allocator->refcount)) {
-    if (allocator->notify)
-      allocator->notify (allocator->user_data);
-#ifndef GST_DISABLE_TRACE
-    _gst_alloc_trace_free (_gst_allocator_trace, allocator);
-#endif
-    g_slice_free1 (sizeof (GstAllocator), allocator);
-  }
-}
-
-/**
  * gst_allocator_register:
  * @name: the name of the allocator
  * @allocator: (transfer full): #GstAllocator
@@ -960,34 +911,96 @@ 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
- * @maxsize: allocated size of @data
- * @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.
+ *
+ * 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
+ * #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, gsize maxsize, 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, maxsize, align, allocator->user_data);
-#ifndef GST_DISABLE_TRACE
-  _gst_alloc_trace_new (_gst_memory_trace, mem);
-#endif
+  mem = allocator->info.alloc (allocator, size, params, allocator->user_data);
+
   return mem;
 }