gstmemory.c 18.4 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
/* GStreamer
 * Copyright (C) 2011 Wim Taymans <wim.taymans@gmail.be>
 *
 * gstmemory.c: memory block handling
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */

Wim Taymans's avatar
Wim Taymans committed
22 23 24 25 26 27 28 29
/**
 * SECTION:gstmemory
 * @short_description: refcounted wrapper for memory blocks
 * @see_also: #GstBuffer
 *
 * GstMemory is a lightweight refcounted object that wraps a region of memory.
 * They are typically used to manage the data of a #GstBuffer.
 *
30
 * Memory is usually created by allocators with a gst_allocator_alloc()
31 32 33
 * method call. When NULL is used as the allocator, the default allocator will
 * be used.
 *
34
 * New allocators can be registered with gst_allocator_register().
35
 * Allocators are identified by name and can be retrieved with
36
 * gst_allocator_find().
37
 *
Wim Taymans's avatar
Wim Taymans committed
38
 * New memory can be created with gst_memory_new_wrapped() that wraps the memory
39
 * allocated elsewhere.
Wim Taymans's avatar
Wim Taymans committed
40 41 42 43 44 45 46 47 48 49 50 51 52 53 54
 *
 * Refcounting of the memory block is performed with gst_memory_ref() and
 * gst_memory_unref().
 *
 * The size of the memory can be retrieved and changed with
 * gst_memory_get_sizes() and gst_memory_resize() respectively.
 *
 * Getting access to the data of the memory is performed with gst_memory_map().
 * After the memory access is completed, gst_memory_unmap() should be called.
 *
 * Memory can be copied with gst_memory_copy(), which will returnn a writable
 * copy. gst_memory_share() will create a new memory block that shares the
 * memory with an existing memory block at a custom offset and with a custom
 * size.
 *
Wim Taymans's avatar
Wim Taymans committed
55
 * Memory can be efficiently merged when gst_memory_is_span() returns TRUE.
Wim Taymans's avatar
Wim Taymans committed
56
 *
57
 * Last reviewed on 2011-06-08 (0.11.0)
Wim Taymans's avatar
Wim Taymans committed
58
 */
59

Wim Taymans's avatar
Wim Taymans committed
60
#include "config.h"
61 62 63
#include "gst_private.h"
#include "gstmemory.h"

64 65
G_DEFINE_BOXED_TYPE (GstMemory, gst_memory, (GBoxedCopyFunc) gst_memory_ref,
    (GBoxedFreeFunc) gst_memory_unref);
Wim Taymans's avatar
Wim Taymans committed
66

Wim Taymans's avatar
Wim Taymans committed
67 68 69 70 71
/**
 * gst_memory_alignment:
 *
 * The default memory alignment in bytes - 1
 * an alignment of 7 would be the same as what malloc() guarantees.
72 73
 */
#if defined(MEMORY_ALIGNMENT_MALLOC)
Wim Taymans's avatar
Wim Taymans committed
74
size_t gst_memory_alignment = 7;
75
#elif defined(MEMORY_ALIGNMENT_PAGESIZE)
Wim Taymans's avatar
Wim Taymans committed
76
/* we fill this in in the _init method */
Wim Taymans's avatar
Wim Taymans committed
77
size_t gst_memory_alignment = 0;
78
#elif defined(MEMORY_ALIGNMENT)
Wim Taymans's avatar
Wim Taymans committed
79
size_t gst_memory_alignment = MEMORY_ALIGNMENT - 1;
80 81
#else
#error "No memory alignment configured"
Wim Taymans's avatar
Wim Taymans committed
82
size_t gst_memory_alignment = 0;
83 84
#endif

85
struct _GstAllocator
86 87 88 89 90 91
{
  GQuark name;

  GstMemoryInfo info;
};

Wim Taymans's avatar
Wim Taymans committed
92
/* default memory implementation */
93 94 95
typedef struct
{
  GstMemory mem;
Wim Taymans's avatar
Wim Taymans committed
96
  gsize slice_size;
97 98 99 100 101 102 103
  guint8 *data;
  GFreeFunc free_func;
  gsize maxsize;
  gsize offset;
  gsize size;
} GstMemoryDefault;

104
/* the default allocator */
105
static const GstAllocator *_default_allocator;
106 107

/* our predefined allocators */
108
static const GstAllocator *_default_mem_impl;
Wim Taymans's avatar
Wim Taymans committed
109

Wim Taymans's avatar
Wim Taymans committed
110
/* initialize the fields */
Wim Taymans's avatar
Wim Taymans committed
111
static void
112 113 114
_default_mem_init (GstMemoryDefault * mem, GstMemoryFlags flags,
    GstMemory * parent, gsize slice_size, gpointer data,
    GFreeFunc free_func, gsize maxsize, gsize offset, gsize size)
Wim Taymans's avatar
Wim Taymans committed
115
{
116
  mem->mem.allocator = _default_mem_impl;
117
  mem->mem.flags = flags;
Wim Taymans's avatar
Wim Taymans committed
118
  mem->mem.refcount = 1;
Wim Taymans's avatar
Wim Taymans committed
119 120 121 122 123 124 125 126 127
  mem->mem.parent = parent ? gst_memory_ref (parent) : NULL;
  mem->slice_size = slice_size;
  mem->data = data;
  mem->free_func = free_func;
  mem->maxsize = maxsize;
  mem->offset = offset;
  mem->size = size;
}

Wim Taymans's avatar
Wim Taymans committed
128
/* create a new memory block that manages the given memory */
Wim Taymans's avatar
Wim Taymans committed
129
static GstMemoryDefault *
130
_default_mem_new (GstMemoryFlags flags, GstMemory * parent, gpointer data,
Wim Taymans's avatar
Wim Taymans committed
131 132 133
    GFreeFunc free_func, gsize maxsize, gsize offset, gsize size)
{
  GstMemoryDefault *mem;
Wim Taymans's avatar
Wim Taymans committed
134
  gsize slice_size;
Wim Taymans's avatar
Wim Taymans committed
135

Wim Taymans's avatar
Wim Taymans committed
136 137 138
  slice_size = sizeof (GstMemoryDefault);

  mem = g_slice_alloc (slice_size);
139
  _default_mem_init (mem, flags, parent, slice_size,
Wim Taymans's avatar
Wim Taymans committed
140 141 142 143
      data, free_func, maxsize, offset, size);

  return mem;
}
144

Wim Taymans's avatar
Wim Taymans committed
145
/* allocate the memory and structure in one block */
Wim Taymans's avatar
Wim Taymans committed
146 147 148 149 150 151 152
static GstMemoryDefault *
_default_mem_new_block (gsize maxsize, gsize align, gsize offset, gsize size)
{
  GstMemoryDefault *mem;
  gsize aoffset, slice_size;
  guint8 *data;

153
  /* ensure configured alignment */
Wim Taymans's avatar
Wim Taymans committed
154
  align |= gst_memory_alignment;
Wim Taymans's avatar
Wim Taymans committed
155 156
  /* allocate more to compensate for alignment */
  maxsize += align;
Wim Taymans's avatar
Wim Taymans committed
157
  /* alloc header and data in one block */
Wim Taymans's avatar
Wim Taymans committed
158
  slice_size = sizeof (GstMemoryDefault) + maxsize;
Wim Taymans's avatar
Wim Taymans committed
159 160 161 162 163 164 165 166

  mem = g_slice_alloc (slice_size);
  if (mem == NULL)
    return NULL;

  data = (guint8 *) mem + sizeof (GstMemoryDefault);

  if ((aoffset = ((guintptr) data & align)))
167
    aoffset = (align + 1) - aoffset;
Wim Taymans's avatar
Wim Taymans committed
168

Wim Taymans's avatar
Wim Taymans committed
169
  _default_mem_init (mem, 0, NULL, slice_size, data, NULL, maxsize,
Wim Taymans's avatar
Wim Taymans committed
170 171 172 173 174
      aoffset + offset, size);

  return mem;
}

175
static GstMemory *
176
_default_mem_alloc (const GstAllocator * allocator, gsize maxsize, gsize align)
177 178 179 180
{
  return (GstMemory *) _default_mem_new_block (maxsize, align, 0, maxsize);
}

181
static gsize
182
_default_mem_get_sizes (GstMemoryDefault * mem, gsize * offset, gsize * maxsize)
183
{
184 185
  if (offset)
    *offset = mem->offset;
Wim Taymans's avatar
Wim Taymans committed
186 187
  if (maxsize)
    *maxsize = mem->maxsize;
188

Wim Taymans's avatar
Wim Taymans committed
189 190 191 192
  return mem->size;
}

static void
193
_default_mem_resize (GstMemoryDefault * mem, gssize offset, gsize size)
Wim Taymans's avatar
Wim Taymans committed
194
{
195
  g_return_if_fail (offset >= 0 || mem->offset >= -offset);
Wim Taymans's avatar
Wim Taymans committed
196
  g_return_if_fail (size + mem->offset + offset <= mem->maxsize);
Wim Taymans's avatar
Wim Taymans committed
197 198 199 200 201 202 203 204 205 206 207

  mem->offset += offset;
  mem->size = size;
}

static gpointer
_default_mem_map (GstMemoryDefault * mem, gsize * size, gsize * maxsize,
    GstMapFlags flags)
{
  if (size)
    *size = mem->size;
208
  if (maxsize)
Wim Taymans's avatar
Wim Taymans committed
209
    *maxsize = mem->maxsize - mem->offset;
210

Wim Taymans's avatar
Wim Taymans committed
211
  return mem->data + mem->offset;
212 213 214
}

static gboolean
Wim Taymans's avatar
Wim Taymans committed
215
_default_mem_unmap (GstMemoryDefault * mem, gpointer data, gsize size)
216
{
Wim Taymans's avatar
Wim Taymans committed
217 218 219
  g_return_val_if_fail ((guint8 *) data >= mem->data
      && (guint8 *) data < mem->data + mem->maxsize, FALSE);

Wim Taymans's avatar
Wim Taymans committed
220 221 222 223 224 225
  if (mem->data + mem->offset != data) {
    gsize newoffset = (guint8 *) data - mem->data;
    if (size == -1)
      size = mem->offset + mem->size - newoffset;
    mem->offset = newoffset;
  }
Wim Taymans's avatar
Wim Taymans committed
226

227
  if (size != -1) {
Wim Taymans's avatar
Wim Taymans committed
228
    g_return_val_if_fail (mem->offset + size <= mem->maxsize, FALSE);
Wim Taymans's avatar
Wim Taymans committed
229
    mem->size = size;
230
  }
Wim Taymans's avatar
Wim Taymans committed
231

Wim Taymans's avatar
Wim Taymans committed
232 233
  return TRUE;
}
234 235

static void
Wim Taymans's avatar
Wim Taymans committed
236
_default_mem_free (GstMemoryDefault * mem)
237
{
Wim Taymans's avatar
Wim Taymans committed
238 239 240 241 242
  if (mem->mem.parent)
    gst_memory_unref (mem->mem.parent);

  if (mem->free_func)
    mem->free_func (mem->data);
243

Wim Taymans's avatar
Wim Taymans committed
244
  g_slice_free1 (mem->slice_size, mem);
245 246
}

Wim Taymans's avatar
Wim Taymans committed
247
static GstMemoryDefault *
248
_default_mem_copy (GstMemoryDefault * mem, gssize offset, gsize size)
249 250 251
{
  GstMemoryDefault *copy;

Wim Taymans's avatar
Wim Taymans committed
252 253
  if (size == -1)
    size = mem->size > offset ? mem->size - offset : 0;
Wim Taymans's avatar
Wim Taymans committed
254

255 256
  copy = _default_mem_new_block (mem->maxsize, 0, mem->offset + offset, size);
  memcpy (copy->data, mem->data, mem->maxsize);
257

Wim Taymans's avatar
Wim Taymans committed
258
  return copy;
259 260
}

Wim Taymans's avatar
Wim Taymans committed
261
static GstMemoryDefault *
262
_default_mem_share (GstMemoryDefault * mem, gssize offset, gsize size)
Wim Taymans's avatar
Wim Taymans committed
263 264 265 266 267 268 269 270
{
  GstMemoryDefault *sub;
  GstMemory *parent;

  /* find the real parent */
  if ((parent = mem->mem.parent) == NULL)
    parent = (GstMemory *) mem;

271 272 273
  if (size == -1)
    size = mem->size - offset;

274
  sub = _default_mem_new (parent->flags, parent, mem->data, NULL, mem->maxsize,
Wim Taymans's avatar
Wim Taymans committed
275 276 277
      mem->offset + offset, size);

  return sub;
278 279
}

Wim Taymans's avatar
Wim Taymans committed
280
static gboolean
Wim Taymans's avatar
Wim Taymans committed
281 282
_default_mem_is_span (GstMemoryDefault * mem1, GstMemoryDefault * mem2,
    gsize * offset)
283
{
Wim Taymans's avatar
Wim Taymans committed
284 285 286 287 288 289 290 291

  if (offset) {
    GstMemoryDefault *parent;

    parent = (GstMemoryDefault *) mem1->mem.parent;

    *offset = mem1->offset - parent->offset;
  }
292

Wim Taymans's avatar
Wim Taymans committed
293
  /* and memory is contiguous */
Wim Taymans's avatar
Wim Taymans committed
294
  return mem1->data + mem1->offset + mem1->size == mem2->data + mem2->offset;
295 296 297
}

static GstMemory *
298
_fallback_copy (GstMemory * mem, gssize offset, gssize size)
299
{
300 301
  GstMemory *copy;
  guint8 *data, *dest;
302
  gsize msize;
303

304
  data = gst_memory_map (mem, &msize, NULL, GST_MAP_READ);
Wim Taymans's avatar
Wim Taymans committed
305 306
  if (size == -1)
    size = msize > offset ? msize - offset : 0;
307
  /* use the same allocator as the memory we copy, FIXME, alignment?  */
Wim Taymans's avatar
Wim Taymans committed
308
  copy = gst_allocator_alloc (mem->allocator, size, 0);
309 310 311 312
  dest = gst_memory_map (copy, NULL, NULL, GST_MAP_WRITE);
  memcpy (dest, data + offset, size);
  gst_memory_unmap (copy, dest, size);

313
  gst_memory_unmap (mem, data, msize);
314

Wim Taymans's avatar
Wim Taymans committed
315
  return (GstMemory *) copy;
316 317 318
}

static gboolean
Wim Taymans's avatar
Wim Taymans committed
319
_fallback_is_span (GstMemory * mem1, GstMemory * mem2, gsize * offset)
320 321 322 323
{
  return FALSE;
}

324
static GStaticRWLock lock = G_STATIC_RW_LOCK_INIT;
325
static GHashTable *allocators;
326

Wim Taymans's avatar
Wim Taymans committed
327
void
Wim Taymans's avatar
Wim Taymans committed
328
_priv_gst_memory_initialize (void)
Wim Taymans's avatar
Wim Taymans committed
329 330
{
  static const GstMemoryInfo _mem_info = {
331
    (GstMemoryAllocFunction) _default_mem_alloc,
Wim Taymans's avatar
Wim Taymans committed
332
    (GstMemoryGetSizesFunction) _default_mem_get_sizes,
Wim Taymans's avatar
Wim Taymans committed
333
    (GstMemoryResizeFunction) _default_mem_resize,
Wim Taymans's avatar
Wim Taymans committed
334 335 336 337
    (GstMemoryMapFunction) _default_mem_map,
    (GstMemoryUnmapFunction) _default_mem_unmap,
    (GstMemoryFreeFunction) _default_mem_free,
    (GstMemoryCopyFunction) _default_mem_copy,
Wim Taymans's avatar
Wim Taymans committed
338
    (GstMemoryShareFunction) _default_mem_share,
339 340
    (GstMemoryIsSpanFunction) _default_mem_is_span,
    NULL
Wim Taymans's avatar
Wim Taymans committed
341 342
  };

343
  allocators = g_hash_table_new (g_str_hash, g_str_equal);
344

345 346
#ifdef HAVE_GETPAGESIZE
#ifdef MEMORY_ALIGNMENT_PAGESIZE
Wim Taymans's avatar
Wim Taymans committed
347
  gst_memory_alignment = getpagesize () - 1;
348 349 350
#endif
#endif

Wim Taymans's avatar
Wim Taymans committed
351 352
  GST_DEBUG ("memory alignment: %" G_GSIZE_FORMAT, gst_memory_alignment);

353
  _default_mem_impl = gst_allocator_register (GST_ALLOCATOR_SYSMEM, &_mem_info);
354

355
  _default_allocator = _default_mem_impl;
356 357
}

Wim Taymans's avatar
Wim Taymans committed
358 359 360 361 362 363 364 365 366 367 368 369 370
/**
 * gst_memory_new_wrapped:
 * @flags: #GstMemoryFlags
 * @data: data to wrap
 * @free_func: function to free @data
 * @maxsize: allocated size of @data
 * @offset: offset in @data
 * @size: size of valid data
 *
 * Allocate a new memory block that wraps the given @data.
 *
 * Returns: a new #GstMemory.
 */
Wim Taymans's avatar
Wim Taymans committed
371 372 373
GstMemory *
gst_memory_new_wrapped (GstMemoryFlags flags, gpointer data,
    GFreeFunc free_func, gsize maxsize, gsize offset, gsize size)
374
{
Wim Taymans's avatar
Wim Taymans committed
375
  GstMemoryDefault *mem;
Wim Taymans's avatar
Wim Taymans committed
376

Wim Taymans's avatar
Wim Taymans committed
377 378 379
  g_return_val_if_fail (data != NULL, NULL);
  g_return_val_if_fail (offset + size <= maxsize, NULL);

Wim Taymans's avatar
Wim Taymans committed
380 381 382 383 384 385 386 387 388
  mem = _default_mem_new (flags, NULL, data, free_func, maxsize, offset, size);

  return (GstMemory *) mem;
}

/**
 * gst_memory_ref:
 * @mem: a #GstMemory
 *
Wim Taymans's avatar
Wim Taymans committed
389 390
 * Increases the refcount of @mem.
 *
Wim Taymans's avatar
Wim Taymans committed
391 392
 * Returns: @mem with increased refcount
 */
393 394 395 396 397 398 399 400 401 402
GstMemory *
gst_memory_ref (GstMemory * mem)
{
  g_return_val_if_fail (mem != NULL, NULL);

  g_atomic_int_inc (&mem->refcount);

  return mem;
}

Wim Taymans's avatar
Wim Taymans committed
403 404 405
/**
 * gst_memory_unref:
 * @mem: a #GstMemory
Wim Taymans's avatar
Wim Taymans committed
406 407 408
 *
 * Decreases the refcount of @mem. When the refcount reaches 0, the free
 * function of @mem will be called.
Wim Taymans's avatar
Wim Taymans committed
409
 */
410 411 412 413
void
gst_memory_unref (GstMemory * mem)
{
  g_return_if_fail (mem != NULL);
414
  g_return_if_fail (mem->allocator != NULL);
415 416

  if (g_atomic_int_dec_and_test (&mem->refcount))
417
    mem->allocator->info.free (mem);
418 419
}

Wim Taymans's avatar
Wim Taymans committed
420 421 422
/**
 * gst_memory_get_sizes:
 * @mem: a #GstMemory
423
 * @offset: pointer to offset
Wim Taymans's avatar
Wim Taymans committed
424 425
 * @maxsize: pointer to maxsize
 *
426
 * Get the current @size, @offset and @maxsize of @mem.
Wim Taymans's avatar
Wim Taymans committed
427 428
 *
 * Returns: the current sizes of @mem
Wim Taymans's avatar
Wim Taymans committed
429
 */
430
gsize
431
gst_memory_get_sizes (GstMemory * mem, gsize * offset, gsize * maxsize)
432 433 434
{
  g_return_val_if_fail (mem != NULL, 0);

435
  return mem->allocator->info.get_sizes (mem, offset, maxsize);
436 437
}

Wim Taymans's avatar
Wim Taymans committed
438 439 440 441 442 443 444 445 446 447
/**
 * gst_memory_resize:
 * @mem: a #GstMemory
 * @offset: a new offset
 * @size: a new size
 *
 * Resize the memory region. @mem should be writable and offset + size should be
 * less than the maxsize of @mem.
 */
void
448
gst_memory_resize (GstMemory * mem, gssize offset, gsize size)
Wim Taymans's avatar
Wim Taymans committed
449 450 451 452
{
  g_return_if_fail (mem != NULL);
  g_return_if_fail (GST_MEMORY_IS_WRITABLE (mem));

453
  mem->allocator->info.resize (mem, offset, size);
Wim Taymans's avatar
Wim Taymans committed
454 455 456 457 458
}

/**
 * gst_memory_map:
 * @mem: a #GstMemory
459 460
 * @size: (out) (allow-none): pointer for size
 * @maxsize: (out) (allow-none): pointer for maxsize
Wim Taymans's avatar
Wim Taymans committed
461 462 463 464 465 466 467
 * @flags: mapping flags
 *
 * Get a pointer to the memory of @mem that can be accessed according to @flags.
 *
 * @size and @maxsize will contain the size of the memory and the maximum
 * allocated memory of @mem respectively. They can be set to NULL.
 *
468
 * Returns: (transfer none): a pointer to the memory of @mem.
Wim Taymans's avatar
Wim Taymans committed
469
 */
470 471 472 473 474
gpointer
gst_memory_map (GstMemory * mem, gsize * size, gsize * maxsize,
    GstMapFlags flags)
{
  g_return_val_if_fail (mem != NULL, NULL);
Wim Taymans's avatar
Wim Taymans committed
475 476
  g_return_val_if_fail (!(flags & GST_MAP_WRITE) ||
      GST_MEMORY_IS_WRITABLE (mem), NULL);
477

478
  return mem->allocator->info.map (mem, size, maxsize, flags);
479 480
}

Wim Taymans's avatar
Wim Taymans committed
481 482 483 484
/**
 * gst_memory_unmap:
 * @mem: a #GstMemory
 * @data: data to unmap
485
 * @size: new size of @mem, or -1
Wim Taymans's avatar
Wim Taymans committed
486 487 488 489 490
 *
 * Release the memory pointer obtained with gst_memory_map() and set the size of
 * the memory to @size. @size can be set to -1 when the size should not be
 * updated.
 *
491 492 493
 * It is possible to pass a different @data than that obtained from
 * gst_memory_map() in which case the offset of @mem will be updated.
 *
Wim Taymans's avatar
Wim Taymans committed
494 495
 * Returns: TRUE when the memory was release successfully.
 */
496
gboolean
497
gst_memory_unmap (GstMemory * mem, gpointer data, gssize size)
498 499 500
{
  g_return_val_if_fail (mem != NULL, FALSE);

501
  return mem->allocator->info.unmap (mem, data, size);
502 503
}

Wim Taymans's avatar
Wim Taymans committed
504 505 506 507
/**
 * gst_memory_copy:
 * @mem: a #GstMemory
 * @offset: an offset to copy
508
 * @size: size to copy or -1 to copy all bytes from offset
Wim Taymans's avatar
Wim Taymans committed
509 510 511 512 513 514 515
 *
 * Return a copy of @size bytes from @mem starting from @offset. This copy is
 * guaranteed to be writable. @size can be set to -1 to return a copy all bytes
 * from @offset.
 *
 * Returns: a new #GstMemory.
 */
516
GstMemory *
517
gst_memory_copy (GstMemory * mem, gssize offset, gssize size)
518 519 520
{
  g_return_val_if_fail (mem != NULL, NULL);

521
  return mem->allocator->info.copy (mem, offset, size);
522 523
}

Wim Taymans's avatar
Wim Taymans committed
524 525 526 527
/**
 * gst_memory_share:
 * @mem: a #GstMemory
 * @offset: an offset to share
528
 * @size: size to share or -1 to share bytes from offset
Wim Taymans's avatar
Wim Taymans committed
529
 *
530 531 532 533
 * Return a shared copy of @size bytes from @mem starting from @offset. No
 * memory copy is performed and the memory region is simply shared. The result
 * is guaranteed to be not-writable. @size can be set to -1 to return a share
 * all bytes from @offset.
Wim Taymans's avatar
Wim Taymans committed
534 535 536
 *
 * Returns: a new #GstMemory.
 */
537
GstMemory *
538
gst_memory_share (GstMemory * mem, gssize offset, gssize size)
539 540 541
{
  g_return_val_if_fail (mem != NULL, NULL);

542
  return mem->allocator->info.share (mem, offset, size);
543 544
}

Wim Taymans's avatar
Wim Taymans committed
545 546 547 548 549 550 551 552 553 554 555 556 557 558 559
/**
 * gst_memory_is_span:
 * @mem1: a #GstMemory
 * @mem2: a #GstMemory
 * @offset: a pointer to a result offset
 *
 * Check if @mem1 and mem2 share the memory with a common parent memory object
 * and that the memory is contiguous.
 *
 * If this is the case, the memory of @mem1 and @mem2 can be merged
 * efficiently by performing gst_memory_share() on the parent object from
 * the returned @offset.
 *
 * Returns: %TRUE if the memory is contiguous and of a common parent.
 */
Wim Taymans's avatar
Wim Taymans committed
560
gboolean
561
gst_memory_is_span (GstMemory * mem1, GstMemory * mem2, gsize * offset)
Wim Taymans's avatar
Wim Taymans committed
562 563 564 565
{
  g_return_val_if_fail (mem1 != NULL, FALSE);
  g_return_val_if_fail (mem2 != NULL, FALSE);

566 567
  /* need to have the same allocators */
  if (mem1->allocator != mem2->allocator)
Wim Taymans's avatar
Wim Taymans committed
568 569
    return FALSE;

570 571 572
  /* need to have the same parent */
  if (mem1->parent == NULL || mem1->parent != mem2->parent)
    return FALSE;
Wim Taymans's avatar
Wim Taymans committed
573

574
  /* and memory is contiguous */
575
  if (!mem1->allocator->info.is_span (mem1, mem2, offset))
576 577 578
    return FALSE;

  return TRUE;
Wim Taymans's avatar
Wim Taymans committed
579
}
580 581

/**
582
 * gst_allocator_register:
583 584 585 586 587 588
 * @name: the name of the allocator
 * @info: #GstMemoryInfo
 *
 * Registers the memory allocator with @name and implementation functions
 * @info.
 *
589
 * All functions in @info are mandatory exept the copy and is_span
590 591 592 593 594
 * functions, which will have a default implementation when left NULL.
 *
 * The user_data field in @info will be passed to all calls of the alloc
 * function.
 *
595
 * Returns: a new #GstAllocator.
596
 */
597 598
const GstAllocator *
gst_allocator_register (const gchar * name, const GstMemoryInfo * info)
599
{
600
  GstAllocator *allocator;
601 602 603 604 605 606

#define INSTALL_FALLBACK(_t) \
  if (allocator->info._t == NULL) allocator->info._t = _fallback_ ##_t;

  g_return_val_if_fail (name != NULL, NULL);
  g_return_val_if_fail (info != NULL, NULL);
607
  g_return_val_if_fail (info->alloc != NULL, NULL);
608 609 610 611 612
  g_return_val_if_fail (info->get_sizes != NULL, NULL);
  g_return_val_if_fail (info->resize != NULL, NULL);
  g_return_val_if_fail (info->map != NULL, NULL);
  g_return_val_if_fail (info->unmap != NULL, NULL);
  g_return_val_if_fail (info->free != NULL, NULL);
613
  g_return_val_if_fail (info->share != NULL, NULL);
614

615
  allocator = g_slice_new (GstAllocator);
616 617 618 619 620 621
  allocator->name = g_quark_from_string (name);
  allocator->info = *info;
  INSTALL_FALLBACK (copy);
  INSTALL_FALLBACK (is_span);
#undef INSTALL_FALLBACK

Josep Torra's avatar
Josep Torra committed
622
  GST_DEBUG ("registering allocator \"%s\"", name);
623 624

  g_static_rw_lock_writer_lock (&lock);
625
  g_hash_table_insert (allocators, (gpointer) name, (gpointer) allocator);
626 627 628 629 630 631
  g_static_rw_lock_writer_unlock (&lock);

  return allocator;
}

/**
632
 * gst_allocator_find:
633 634
 * @name: the name of the allocator
 *
635 636
 * Find a previously registered allocator with @name. When @name is NULL, the
 * default allocator will be returned.
637
 *
638
 * Returns: a #GstAllocator or NULL when the allocator with @name was not
639 640
 * registered.
 */
641 642
const GstAllocator *
gst_allocator_find (const gchar * name)
643
{
644
  const GstAllocator *allocator;
645

646 647
  g_static_rw_lock_reader_lock (&lock);
  if (name) {
648
    allocator = g_hash_table_lookup (allocators, (gconstpointer) name);
649 650 651 652
  } else {
    allocator = _default_allocator;
  }
  g_static_rw_lock_reader_unlock (&lock);
653 654 655 656 657

  return allocator;
}

/**
658 659
 * gst_allocator_set_default:
 * @allocator: a #GstAllocator
660 661 662 663
 *
 * Set the default allocator.
 */
void
664
gst_allocator_set_default (const GstAllocator * allocator)
665 666 667
{
  g_return_if_fail (allocator != NULL);

668
  g_static_rw_lock_writer_lock (&lock);
669
  _default_allocator = allocator;
670
  g_static_rw_lock_writer_unlock (&lock);
671 672 673
}

/**
674
 * gst_allocator_alloc:
675
 * @allocator: (transfer none) (allow-none): a #GstAllocator to use
676 677 678 679 680 681
 * @maxsize: allocated size of @data
 * @align: alignment for the data
 *
 * Use @allocator to allocate a new memory block with memory that is at least
 * @maxsize big and has the given alignment.
 *
682 683
 * When @allocator is NULL, the default allocator will be used.
 *
684 685 686
 * @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.
 *
687
 * Returns: (transfer full): a new #GstMemory.
688 689
 */
GstMemory *
690
gst_allocator_alloc (const GstAllocator * allocator, gsize maxsize, gsize align)
691 692 693 694 695 696
{
  g_return_val_if_fail (((align + 1) & align) == 0, NULL);

  if (allocator == NULL)
    allocator = _default_allocator;

697 698
  return allocator->info.alloc (allocator, maxsize, align,
      allocator->info.user_data);
699
}