gstmemory.c 17.6 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

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

82
struct _GstAllocator
83 84 85 86 87 88
{
  GQuark name;

  GstMemoryInfo info;
};

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

101
/* the default allocator */
102
static const GstAllocator *_default_allocator;
103 104

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

Wim Taymans's avatar
Wim Taymans committed
107
/* initialize the fields */
Wim Taymans's avatar
Wim Taymans committed
108
static void
109 110 111
_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
112
{
113
  mem->mem.allocator = _default_mem_impl;
114
  mem->mem.flags = flags;
Wim Taymans's avatar
Wim Taymans committed
115
  mem->mem.refcount = 1;
Wim Taymans's avatar
Wim Taymans committed
116 117 118 119 120 121 122 123 124
  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
125
/* create a new memory block that manages the given memory */
Wim Taymans's avatar
Wim Taymans committed
126
static GstMemoryDefault *
127
_default_mem_new (GstMemoryFlags flags, GstMemory * parent, gpointer data,
Wim Taymans's avatar
Wim Taymans committed
128 129 130
    GFreeFunc free_func, gsize maxsize, gsize offset, gsize size)
{
  GstMemoryDefault *mem;
Wim Taymans's avatar
Wim Taymans committed
131
  gsize slice_size;
Wim Taymans's avatar
Wim Taymans committed
132

Wim Taymans's avatar
Wim Taymans committed
133 134 135
  slice_size = sizeof (GstMemoryDefault);

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

  return mem;
}
141

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

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

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

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

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

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

  return mem;
}

172
static GstMemory *
173
_default_mem_alloc (const GstAllocator * allocator, gsize maxsize, gsize align)
174 175 176 177
{
  return (GstMemory *) _default_mem_new_block (maxsize, align, 0, maxsize);
}

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

Wim Taymans's avatar
Wim Taymans committed
186 187 188 189
  return mem->size;
}

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

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

static gpointer
_default_mem_map (GstMemoryDefault * mem, gsize * size, gsize * maxsize,
    GstMapFlags flags)
{
  if (size)
    *size = mem->size;
204
  if (maxsize)
Wim Taymans's avatar
Wim Taymans committed
205
    *maxsize = mem->maxsize;
206

Wim Taymans's avatar
Wim Taymans committed
207
  return mem->data + mem->offset;
208 209 210
}

static gboolean
Wim Taymans's avatar
Wim Taymans committed
211
_default_mem_unmap (GstMemoryDefault * mem, gpointer data, gsize size)
212
{
Wim Taymans's avatar
Wim Taymans committed
213 214
  if (size != -1)
    mem->size = size;
Wim Taymans's avatar
Wim Taymans committed
215 216
  return TRUE;
}
217 218

static void
Wim Taymans's avatar
Wim Taymans committed
219
_default_mem_free (GstMemoryDefault * mem)
220
{
Wim Taymans's avatar
Wim Taymans committed
221 222 223 224 225
  if (mem->mem.parent)
    gst_memory_unref (mem->mem.parent);

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

Wim Taymans's avatar
Wim Taymans committed
227
  g_slice_free1 (mem->slice_size, mem);
228 229
}

Wim Taymans's avatar
Wim Taymans committed
230
static GstMemoryDefault *
231
_default_mem_copy (GstMemoryDefault * mem, gssize offset, gsize size)
232 233 234
{
  GstMemoryDefault *copy;

Wim Taymans's avatar
Wim Taymans committed
235 236
  if (size == -1)
    size = mem->size > offset ? mem->size - offset : 0;
Wim Taymans's avatar
Wim Taymans committed
237

238 239
  copy = _default_mem_new_block (mem->maxsize, 0, mem->offset + offset, size);
  memcpy (copy->data, mem->data, mem->maxsize);
240

Wim Taymans's avatar
Wim Taymans committed
241
  return copy;
242 243
}

Wim Taymans's avatar
Wim Taymans committed
244
static GstMemoryDefault *
245
_default_mem_share (GstMemoryDefault * mem, gssize offset, gsize size)
Wim Taymans's avatar
Wim Taymans committed
246 247 248 249 250 251 252 253
{
  GstMemoryDefault *sub;
  GstMemory *parent;

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

254 255 256
  if (size == -1)
    size = mem->size - offset;

257
  sub = _default_mem_new (parent->flags, parent, mem->data, NULL, mem->maxsize,
Wim Taymans's avatar
Wim Taymans committed
258 259 260
      mem->offset + offset, size);

  return sub;
261 262
}

Wim Taymans's avatar
Wim Taymans committed
263
static gboolean
Wim Taymans's avatar
Wim Taymans committed
264 265
_default_mem_is_span (GstMemoryDefault * mem1, GstMemoryDefault * mem2,
    gsize * offset)
266
{
Wim Taymans's avatar
Wim Taymans committed
267 268 269 270 271 272 273 274

  if (offset) {
    GstMemoryDefault *parent;

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

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

Wim Taymans's avatar
Wim Taymans committed
276
  /* and memory is contiguous */
Wim Taymans's avatar
Wim Taymans committed
277
  return mem1->data + mem1->offset + mem1->size == mem2->data + mem2->offset;
278 279 280
}

static GstMemory *
281
_fallback_copy (GstMemory * mem, gssize offset, gsize size)
282
{
283 284
  GstMemory *copy;
  guint8 *data, *dest;
285
  gsize msize;
286

287
  data = gst_memory_map (mem, &msize, NULL, GST_MAP_READ);
Wim Taymans's avatar
Wim Taymans committed
288 289
  if (size == -1)
    size = msize > offset ? msize - offset : 0;
290
  /* use the same allocator as the memory we copy, FIXME, alignment?  */
Wim Taymans's avatar
Wim Taymans committed
291
  copy = gst_allocator_alloc (mem->allocator, size, 0);
292 293 294 295
  dest = gst_memory_map (copy, NULL, NULL, GST_MAP_WRITE);
  memcpy (dest, data + offset, size);
  gst_memory_unmap (copy, dest, size);

296
  gst_memory_unmap (mem, data, msize);
297

Wim Taymans's avatar
Wim Taymans committed
298
  return (GstMemory *) copy;
299 300 301
}

static gboolean
Wim Taymans's avatar
Wim Taymans committed
302
_fallback_is_span (GstMemory * mem1, GstMemory * mem2, gsize * offset)
303 304 305 306
{
  return FALSE;
}

307
static GStaticRWLock lock = G_STATIC_RW_LOCK_INIT;
308
static GHashTable *allocators;
309

Wim Taymans's avatar
Wim Taymans committed
310
void
Wim Taymans's avatar
Wim Taymans committed
311
_priv_gst_memory_initialize (void)
Wim Taymans's avatar
Wim Taymans committed
312 313
{
  static const GstMemoryInfo _mem_info = {
314
    (GstMemoryAllocFunction) _default_mem_alloc,
Wim Taymans's avatar
Wim Taymans committed
315
    (GstMemoryGetSizesFunction) _default_mem_get_sizes,
Wim Taymans's avatar
Wim Taymans committed
316
    (GstMemoryResizeFunction) _default_mem_resize,
Wim Taymans's avatar
Wim Taymans committed
317 318 319 320
    (GstMemoryMapFunction) _default_mem_map,
    (GstMemoryUnmapFunction) _default_mem_unmap,
    (GstMemoryFreeFunction) _default_mem_free,
    (GstMemoryCopyFunction) _default_mem_copy,
Wim Taymans's avatar
Wim Taymans committed
321
    (GstMemoryShareFunction) _default_mem_share,
322 323
    (GstMemoryIsSpanFunction) _default_mem_is_span,
    NULL
Wim Taymans's avatar
Wim Taymans committed
324 325
  };

326
  allocators = g_hash_table_new (g_str_hash, g_str_equal);
327

328 329
#ifdef HAVE_GETPAGESIZE
#ifdef MEMORY_ALIGNMENT_PAGESIZE
Wim Taymans's avatar
Wim Taymans committed
330
  gst_memory_alignment = getpagesize () - 1;
331 332 333
#endif
#endif

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

336
  _default_mem_impl = gst_allocator_register (GST_ALLOCATOR_SYSMEM, &_mem_info);
337

338
  _default_allocator = _default_mem_impl;
339 340
}

Wim Taymans's avatar
Wim Taymans committed
341 342 343 344 345 346 347 348 349 350 351 352 353
/**
 * 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
354 355 356
GstMemory *
gst_memory_new_wrapped (GstMemoryFlags flags, gpointer data,
    GFreeFunc free_func, gsize maxsize, gsize offset, gsize size)
357
{
Wim Taymans's avatar
Wim Taymans committed
358
  GstMemoryDefault *mem;
Wim Taymans's avatar
Wim Taymans committed
359

Wim Taymans's avatar
Wim Taymans committed
360 361 362
  g_return_val_if_fail (data != NULL, NULL);
  g_return_val_if_fail (offset + size <= maxsize, NULL);

Wim Taymans's avatar
Wim Taymans committed
363 364 365 366 367 368 369 370 371
  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
372 373
 * Increases the refcount of @mem.
 *
Wim Taymans's avatar
Wim Taymans committed
374 375
 * Returns: @mem with increased refcount
 */
376 377 378 379 380 381 382 383 384 385
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
386 387 388
/**
 * gst_memory_unref:
 * @mem: a #GstMemory
Wim Taymans's avatar
Wim Taymans committed
389 390 391
 *
 * 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
392
 */
393 394 395 396
void
gst_memory_unref (GstMemory * mem)
{
  g_return_if_fail (mem != NULL);
397
  g_return_if_fail (mem->allocator != NULL);
398 399

  if (g_atomic_int_dec_and_test (&mem->refcount))
400
    mem->allocator->info.free (mem);
401 402
}

Wim Taymans's avatar
Wim Taymans committed
403 404 405
/**
 * gst_memory_get_sizes:
 * @mem: a #GstMemory
406
 * @offset: pointer to offset
Wim Taymans's avatar
Wim Taymans committed
407 408
 * @maxsize: pointer to maxsize
 *
409
 * Get the current @size, @offset and @maxsize of @mem.
Wim Taymans's avatar
Wim Taymans committed
410 411
 *
 * Returns: the current sizes of @mem
Wim Taymans's avatar
Wim Taymans committed
412
 */
413
gsize
414
gst_memory_get_sizes (GstMemory * mem, gsize * offset, gsize * maxsize)
415 416 417
{
  g_return_val_if_fail (mem != NULL, 0);

418
  return mem->allocator->info.get_sizes (mem, offset, maxsize);
419 420
}

Wim Taymans's avatar
Wim Taymans committed
421 422 423 424 425 426 427 428 429 430
/**
 * 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
431
gst_memory_resize (GstMemory * mem, gssize offset, gsize size)
Wim Taymans's avatar
Wim Taymans committed
432 433 434 435
{
  g_return_if_fail (mem != NULL);
  g_return_if_fail (GST_MEMORY_IS_WRITABLE (mem));

436
  mem->allocator->info.resize (mem, offset, size);
Wim Taymans's avatar
Wim Taymans committed
437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452
}

/**
 * gst_memory_map:
 * @mem: a #GstMemory
 * @size: pointer for size
 * @maxsize: pointer for maxsize
 * @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.
 *
 * Returns: a pointer to the memory of @mem.
 */
453 454 455 456 457
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
458 459
  g_return_val_if_fail (!(flags & GST_MAP_WRITE) ||
      GST_MEMORY_IS_WRITABLE (mem), NULL);
460

461
  return mem->allocator->info.map (mem, size, maxsize, flags);
462 463
}

Wim Taymans's avatar
Wim Taymans committed
464 465 466 467 468 469 470 471 472 473 474 475
/**
 * gst_memory_unmap:
 * @mem: a #GstMemory
 * @data: data to unmap
 * @size: new size of @mem
 *
 * 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.
 *
 * Returns: TRUE when the memory was release successfully.
 */
476 477 478 479 480
gboolean
gst_memory_unmap (GstMemory * mem, gpointer data, gsize size)
{
  g_return_val_if_fail (mem != NULL, FALSE);

481
  return mem->allocator->info.unmap (mem, data, size);
482 483
}

Wim Taymans's avatar
Wim Taymans committed
484 485 486 487 488 489 490 491 492 493 494 495
/**
 * gst_memory_copy:
 * @mem: a #GstMemory
 * @offset: an offset to copy
 * @size: size to copy
 *
 * 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.
 */
496
GstMemory *
497
gst_memory_copy (GstMemory * mem, gssize offset, gsize size)
498 499 500
{
  g_return_val_if_fail (mem != NULL, NULL);

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

Wim Taymans's avatar
Wim Taymans committed
504 505 506 507 508 509 510 511 512 513 514 515 516
/**
 * gst_memory_share:
 * @mem: a #GstMemory
 * @offset: an offset to share
 * @size: size to share
 *
 * 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.
 *
 * Returns: a new #GstMemory.
 */
517
GstMemory *
518
gst_memory_share (GstMemory * mem, gssize offset, gsize size)
519 520 521
{
  g_return_val_if_fail (mem != NULL, NULL);

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

Wim Taymans's avatar
Wim Taymans committed
525 526 527 528 529 530 531 532 533 534 535 536 537 538 539
/**
 * 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
540
gboolean
541
gst_memory_is_span (GstMemory * mem1, GstMemory * mem2, gsize * offset)
Wim Taymans's avatar
Wim Taymans committed
542 543 544 545
{
  g_return_val_if_fail (mem1 != NULL, FALSE);
  g_return_val_if_fail (mem2 != NULL, FALSE);

546 547
  /* need to have the same allocators */
  if (mem1->allocator != mem2->allocator)
Wim Taymans's avatar
Wim Taymans committed
548 549
    return FALSE;

550 551 552
  /* need to have the same parent */
  if (mem1->parent == NULL || mem1->parent != mem2->parent)
    return FALSE;
Wim Taymans's avatar
Wim Taymans committed
553

554
  /* and memory is contiguous */
555
  if (!mem1->allocator->info.is_span (mem1, mem2, offset))
556 557 558
    return FALSE;

  return TRUE;
Wim Taymans's avatar
Wim Taymans committed
559
}
560 561

/**
562
 * gst_allocator_register:
563 564 565 566 567 568
 * @name: the name of the allocator
 * @info: #GstMemoryInfo
 *
 * Registers the memory allocator with @name and implementation functions
 * @info.
 *
569
 * All functions in @info are mandatory exept the copy and is_span
570 571 572 573 574
 * 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.
 *
575
 * Returns: a new #GstAllocator.
576
 */
577 578
const GstAllocator *
gst_allocator_register (const gchar * name, const GstMemoryInfo * info)
579
{
580
  GstAllocator *allocator;
581 582 583 584 585 586

#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);
587
  g_return_val_if_fail (info->alloc != NULL, NULL);
588 589 590 591 592
  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);
593
  g_return_val_if_fail (info->share != NULL, NULL);
594

595
  allocator = g_slice_new (GstAllocator);
596 597 598 599 600 601
  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
602
  GST_DEBUG ("registering allocator \"%s\"", name);
603 604

  g_static_rw_lock_writer_lock (&lock);
605
  g_hash_table_insert (allocators, (gpointer) name, (gpointer) allocator);
606 607 608 609 610 611
  g_static_rw_lock_writer_unlock (&lock);

  return allocator;
}

/**
612
 * gst_allocator_find:
613 614
 * @name: the name of the allocator
 *
615 616
 * Find a previously registered allocator with @name. When @name is NULL, the
 * default allocator will be returned.
617
 *
618
 * Returns: a #GstAllocator or NULL when the allocator with @name was not
619 620
 * registered.
 */
621 622
const GstAllocator *
gst_allocator_find (const gchar * name)
623
{
624
  const GstAllocator *allocator;
625

626 627
  g_static_rw_lock_reader_lock (&lock);
  if (name) {
628
    allocator = g_hash_table_lookup (allocators, (gconstpointer) name);
629 630 631 632
  } else {
    allocator = _default_allocator;
  }
  g_static_rw_lock_reader_unlock (&lock);
633 634 635 636 637

  return allocator;
}

/**
638 639
 * gst_allocator_set_default:
 * @allocator: a #GstAllocator
640 641 642 643
 *
 * Set the default allocator.
 */
void
644
gst_allocator_set_default (const GstAllocator * allocator)
645 646 647
{
  g_return_if_fail (allocator != NULL);

648
  g_static_rw_lock_writer_lock (&lock);
649
  _default_allocator = allocator;
650
  g_static_rw_lock_writer_unlock (&lock);
651 652 653
}

/**
654 655
 * gst_allocator_alloc:
 * @allocator: a #GstAllocator to use
656 657 658 659 660 661
 * @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.
 *
662 663
 * When @allocator is NULL, the default allocator will be used.
 *
664 665 666 667 668 669
 * @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.
 *
 * Returns: a new #GstMemory.
 */
GstMemory *
670
gst_allocator_alloc (const GstAllocator * allocator, gsize maxsize, gsize align)
671 672 673 674 675 676
{
  g_return_val_if_fail (((align + 1) & align) == 0, NULL);

  if (allocator == NULL)
    allocator = _default_allocator;

677 678
  return allocator->info.alloc (allocator, maxsize, align,
      allocator->info.user_data);
679
}