gstmemory.c 17.5 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"

Wim Taymans's avatar
Wim Taymans committed
64

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

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

  GstMemoryInfo info;
};

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

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

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

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

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

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

  return mem;
}
140

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

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

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

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

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

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

  return mem;
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  return sub;
260 261
}

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

  if (offset) {
    GstMemoryDefault *parent;

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

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

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

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

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

295
  gst_memory_unmap (mem, data, msize);
296

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

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

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

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

325
  allocators = g_hash_table_new (g_str_hash, g_str_equal);
326

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

333
  _default_mem_impl = gst_allocator_register (GST_ALLOCATOR_SYSMEM, &_mem_info);
334

335
  _default_allocator = _default_mem_impl;
336 337
}

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

Wim Taymans's avatar
Wim Taymans committed
357 358 359
  g_return_val_if_fail (data != NULL, NULL);
  g_return_val_if_fail (offset + size <= maxsize, NULL);

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

  if (g_atomic_int_dec_and_test (&mem->refcount))
397
    mem->allocator->info.free (mem);
398 399
}

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

415
  return mem->allocator->info.get_sizes (mem, offset, maxsize);
416 417
}

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

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

/**
 * 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.
 */
450 451 452 453 454
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
455 456
  g_return_val_if_fail (!(flags & GST_MAP_WRITE) ||
      GST_MEMORY_IS_WRITABLE (mem), NULL);
457

458
  return mem->allocator->info.map (mem, size, maxsize, flags);
459 460
}

Wim Taymans's avatar
Wim Taymans committed
461 462 463 464 465 466 467 468 469 470 471 472
/**
 * 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.
 */
473 474 475 476 477
gboolean
gst_memory_unmap (GstMemory * mem, gpointer data, gsize size)
{
  g_return_val_if_fail (mem != NULL, FALSE);

478
  return mem->allocator->info.unmap (mem, data, size);
479 480
}

Wim Taymans's avatar
Wim Taymans committed
481 482 483 484 485 486 487 488 489 490 491 492
/**
 * 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.
 */
493
GstMemory *
494
gst_memory_copy (GstMemory * mem, gssize offset, gsize size)
495 496 497
{
  g_return_val_if_fail (mem != NULL, NULL);

498
  return mem->allocator->info.copy (mem, offset, size);
499 500
}

Wim Taymans's avatar
Wim Taymans committed
501 502 503 504 505 506 507 508 509 510 511 512 513
/**
 * 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.
 */
514
GstMemory *
515
gst_memory_share (GstMemory * mem, gssize offset, gsize size)
516 517 518
{
  g_return_val_if_fail (mem != NULL, NULL);

519
  return mem->allocator->info.share (mem, offset, size);
520 521
}

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

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

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

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

  return TRUE;
Wim Taymans's avatar
Wim Taymans committed
556
}
557 558

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

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

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

  g_static_rw_lock_writer_lock (&lock);
602
  g_hash_table_insert (allocators, (gpointer) name, (gpointer) allocator);
603 604 605 606 607 608
  g_static_rw_lock_writer_unlock (&lock);

  return allocator;
}

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

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

  return allocator;
}

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

645
  g_static_rw_lock_writer_lock (&lock);
646
  _default_allocator = allocator;
647
  g_static_rw_lock_writer_unlock (&lock);
648 649 650
}

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

  if (allocator == NULL)
    allocator = _default_allocator;

674 675
  return allocator->info.alloc (allocator, maxsize, align,
      allocator->info.user_data);
676
}