gstmemory.c 18.8 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.
 *
Wim Taymans's avatar
Wim Taymans committed
30 31 32 33 34
 * A GstMemory object has an allocated region of memory of maxsize. The maximum
 * size does not change during the lifetime of the memory object. The memory
 * also has an offset and size property that specifies the valid range of memory
 * in the allocated region.
 *
35
 * Memory is usually created by allocators with a gst_allocator_alloc()
36 37 38
 * method call. When NULL is used as the allocator, the default allocator will
 * be used.
 *
39
 * New allocators can be registered with gst_allocator_register().
40
 * Allocators are identified by name and can be retrieved with
41
 * gst_allocator_find().
42
 *
Wim Taymans's avatar
Wim Taymans committed
43
 * New memory can be created with gst_memory_new_wrapped() that wraps the memory
44
 * allocated elsewhere.
Wim Taymans's avatar
Wim Taymans committed
45 46 47 48 49 50 51 52
 *
 * 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().
Wim Taymans's avatar
Wim Taymans committed
53
 * The call will return a pointer to offset bytes into the region of memory.
Wim Taymans's avatar
Wim Taymans committed
54 55 56 57 58 59 60
 * 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
61
 * Memory can be efficiently merged when gst_memory_is_span() returns TRUE.
Wim Taymans's avatar
Wim Taymans committed
62
 *
63
 * Last reviewed on 2011-06-08 (0.11.0)
Wim Taymans's avatar
Wim Taymans committed
64
 */
65

Wim Taymans's avatar
Wim Taymans committed
66
#include "config.h"
67 68 69
#include "gst_private.h"
#include "gstmemory.h"

70 71
G_DEFINE_BOXED_TYPE (GstMemory, gst_memory, (GBoxedCopyFunc) gst_memory_ref,
    (GBoxedFreeFunc) gst_memory_unref);
Wim Taymans's avatar
Wim Taymans committed
72

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

91
struct _GstAllocator
92 93 94 95 96 97
{
  GQuark name;

  GstMemoryInfo info;
};

Wim Taymans's avatar
Wim Taymans committed
98
/* default memory implementation */
99 100 101
typedef struct
{
  GstMemory mem;
Wim Taymans's avatar
Wim Taymans committed
102
  gsize slice_size;
103 104 105 106 107 108 109
  guint8 *data;
  GFreeFunc free_func;
  gsize maxsize;
  gsize offset;
  gsize size;
} GstMemoryDefault;

110
/* the default allocator */
111
static const GstAllocator *_default_allocator;
112 113

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

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

Wim Taymans's avatar
Wim Taymans committed
142 143 144
  slice_size = sizeof (GstMemoryDefault);

  mem = g_slice_alloc (slice_size);
145
  _default_mem_init (mem, flags, parent, slice_size,
Wim Taymans's avatar
Wim Taymans committed
146 147 148 149
      data, free_func, maxsize, offset, size);

  return mem;
}
150

Wim Taymans's avatar
Wim Taymans committed
151
/* allocate the memory and structure in one block */
Wim Taymans's avatar
Wim Taymans committed
152 153 154 155 156 157 158
static GstMemoryDefault *
_default_mem_new_block (gsize maxsize, gsize align, gsize offset, gsize size)
{
  GstMemoryDefault *mem;
  gsize aoffset, slice_size;
  guint8 *data;

159
  /* ensure configured alignment */
Wim Taymans's avatar
Wim Taymans committed
160
  align |= gst_memory_alignment;
Wim Taymans's avatar
Wim Taymans committed
161 162
  /* allocate more to compensate for alignment */
  maxsize += align;
Wim Taymans's avatar
Wim Taymans committed
163
  /* alloc header and data in one block */
Wim Taymans's avatar
Wim Taymans committed
164
  slice_size = sizeof (GstMemoryDefault) + maxsize;
Wim Taymans's avatar
Wim Taymans committed
165 166 167 168 169 170 171 172

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

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

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

Wim Taymans's avatar
Wim Taymans committed
175
  _default_mem_init (mem, 0, NULL, slice_size, data, NULL, maxsize,
Wim Taymans's avatar
Wim Taymans committed
176 177 178 179 180
      aoffset + offset, size);

  return mem;
}

181
static GstMemory *
182
_default_mem_alloc (const GstAllocator * allocator, gsize maxsize, gsize align)
183 184 185 186
{
  return (GstMemory *) _default_mem_new_block (maxsize, align, 0, maxsize);
}

187
static gsize
188
_default_mem_get_sizes (GstMemoryDefault * mem, gsize * offset, gsize * maxsize)
189
{
190 191
  if (offset)
    *offset = mem->offset;
Wim Taymans's avatar
Wim Taymans committed
192 193
  if (maxsize)
    *maxsize = mem->maxsize;
194

Wim Taymans's avatar
Wim Taymans committed
195 196 197 198
  return mem->size;
}

static void
199
_default_mem_resize (GstMemoryDefault * mem, gssize offset, gsize size)
Wim Taymans's avatar
Wim Taymans committed
200
{
201
  g_return_if_fail (offset >= 0 || mem->offset >= -offset);
Wim Taymans's avatar
Wim Taymans committed
202
  g_return_if_fail (size + mem->offset + offset <= mem->maxsize);
Wim Taymans's avatar
Wim Taymans committed
203 204 205 206 207 208 209 210 211 212 213

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

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

Wim Taymans's avatar
Wim Taymans committed
217
  return mem->data + mem->offset;
218 219 220
}

static gboolean
Wim Taymans's avatar
Wim Taymans committed
221
_default_mem_unmap (GstMemoryDefault * mem, gpointer data, gsize size)
222
{
Wim Taymans's avatar
Wim Taymans committed
223 224 225
  g_return_val_if_fail ((guint8 *) data >= mem->data
      && (guint8 *) data < mem->data + mem->maxsize, FALSE);

Wim Taymans's avatar
Wim Taymans committed
226 227 228 229 230 231
  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
232

233
  if (size != -1) {
Wim Taymans's avatar
Wim Taymans committed
234
    g_return_val_if_fail (mem->offset + size <= mem->maxsize, FALSE);
Wim Taymans's avatar
Wim Taymans committed
235
    mem->size = size;
236
  }
Wim Taymans's avatar
Wim Taymans committed
237

Wim Taymans's avatar
Wim Taymans committed
238 239
  return TRUE;
}
240 241

static void
Wim Taymans's avatar
Wim Taymans committed
242
_default_mem_free (GstMemoryDefault * mem)
243
{
Wim Taymans's avatar
Wim Taymans committed
244 245 246 247 248
  if (mem->mem.parent)
    gst_memory_unref (mem->mem.parent);

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

Wim Taymans's avatar
Wim Taymans committed
250
  g_slice_free1 (mem->slice_size, mem);
251 252
}

Wim Taymans's avatar
Wim Taymans committed
253
static GstMemoryDefault *
254
_default_mem_copy (GstMemoryDefault * mem, gssize offset, gsize size)
255 256 257
{
  GstMemoryDefault *copy;

Wim Taymans's avatar
Wim Taymans committed
258 259
  if (size == -1)
    size = mem->size > offset ? mem->size - offset : 0;
Wim Taymans's avatar
Wim Taymans committed
260

261 262
  copy = _default_mem_new_block (mem->maxsize, 0, mem->offset + offset, size);
  memcpy (copy->data, mem->data, mem->maxsize);
263

Wim Taymans's avatar
Wim Taymans committed
264
  return copy;
265 266
}

Wim Taymans's avatar
Wim Taymans committed
267
static GstMemoryDefault *
268
_default_mem_share (GstMemoryDefault * mem, gssize offset, gsize size)
Wim Taymans's avatar
Wim Taymans committed
269 270 271 272 273 274 275 276
{
  GstMemoryDefault *sub;
  GstMemory *parent;

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

277 278 279
  if (size == -1)
    size = mem->size - offset;

280
  sub = _default_mem_new (parent->flags, parent, mem->data, NULL, mem->maxsize,
Wim Taymans's avatar
Wim Taymans committed
281 282 283
      mem->offset + offset, size);

  return sub;
284 285
}

Wim Taymans's avatar
Wim Taymans committed
286
static gboolean
Wim Taymans's avatar
Wim Taymans committed
287 288
_default_mem_is_span (GstMemoryDefault * mem1, GstMemoryDefault * mem2,
    gsize * offset)
289
{
Wim Taymans's avatar
Wim Taymans committed
290 291 292 293 294 295 296 297

  if (offset) {
    GstMemoryDefault *parent;

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

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

Wim Taymans's avatar
Wim Taymans committed
299
  /* and memory is contiguous */
Wim Taymans's avatar
Wim Taymans committed
300
  return mem1->data + mem1->offset + mem1->size == mem2->data + mem2->offset;
301 302 303
}

static GstMemory *
304
_fallback_copy (GstMemory * mem, gssize offset, gssize size)
305
{
306 307
  GstMemory *copy;
  guint8 *data, *dest;
308
  gsize msize;
309

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

319
  gst_memory_unmap (mem, data, msize);
320

Wim Taymans's avatar
Wim Taymans committed
321
  return (GstMemory *) copy;
322 323 324
}

static gboolean
Wim Taymans's avatar
Wim Taymans committed
325
_fallback_is_span (GstMemory * mem1, GstMemory * mem2, gsize * offset)
326 327 328 329
{
  return FALSE;
}

330
static GStaticRWLock lock = G_STATIC_RW_LOCK_INIT;
331
static GHashTable *allocators;
332

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

349
  allocators = g_hash_table_new (g_str_hash, g_str_equal);
350

351 352
#ifdef HAVE_GETPAGESIZE
#ifdef MEMORY_ALIGNMENT_PAGESIZE
Wim Taymans's avatar
Wim Taymans committed
353
  gst_memory_alignment = getpagesize () - 1;
354 355 356
#endif
#endif

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

359
  _default_mem_impl = gst_allocator_register (GST_ALLOCATOR_SYSMEM, &_mem_info);
360

361
  _default_allocator = _default_mem_impl;
362 363
}

Wim Taymans's avatar
Wim Taymans committed
364 365 366 367 368 369 370 371 372 373 374 375 376
/**
 * 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
377 378 379
GstMemory *
gst_memory_new_wrapped (GstMemoryFlags flags, gpointer data,
    GFreeFunc free_func, gsize maxsize, gsize offset, gsize size)
380
{
Wim Taymans's avatar
Wim Taymans committed
381
  GstMemoryDefault *mem;
Wim Taymans's avatar
Wim Taymans committed
382

Wim Taymans's avatar
Wim Taymans committed
383 384 385
  g_return_val_if_fail (data != NULL, NULL);
  g_return_val_if_fail (offset + size <= maxsize, NULL);

Wim Taymans's avatar
Wim Taymans committed
386 387 388 389 390 391 392 393 394
  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
395 396
 * Increases the refcount of @mem.
 *
Wim Taymans's avatar
Wim Taymans committed
397 398
 * Returns: @mem with increased refcount
 */
399 400 401 402 403 404 405 406 407 408
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
409 410 411
/**
 * gst_memory_unref:
 * @mem: a #GstMemory
Wim Taymans's avatar
Wim Taymans committed
412 413 414
 *
 * 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
415
 */
416 417 418 419
void
gst_memory_unref (GstMemory * mem)
{
  g_return_if_fail (mem != NULL);
420
  g_return_if_fail (mem->allocator != NULL);
421 422

  if (g_atomic_int_dec_and_test (&mem->refcount))
423
    mem->allocator->info.free (mem);
424 425
}

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

441
  return mem->allocator->info.get_sizes (mem, offset, maxsize);
442 443
}

Wim Taymans's avatar
Wim Taymans committed
444 445 446 447 448 449 450 451 452 453
/**
 * 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
454
gst_memory_resize (GstMemory * mem, gssize offset, gsize size)
Wim Taymans's avatar
Wim Taymans committed
455 456 457 458
{
  g_return_if_fail (mem != NULL);
  g_return_if_fail (GST_MEMORY_IS_WRITABLE (mem));

459
  mem->allocator->info.resize (mem, offset, size);
Wim Taymans's avatar
Wim Taymans committed
460 461 462 463 464
}

/**
 * gst_memory_map:
 * @mem: a #GstMemory
465 466
 * @size: (out) (allow-none): pointer for size
 * @maxsize: (out) (allow-none): pointer for maxsize
Wim Taymans's avatar
Wim Taymans committed
467 468 469 470 471 472 473
 * @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.
 *
474
 * Returns: (transfer none): a pointer to the memory of @mem.
Wim Taymans's avatar
Wim Taymans committed
475
 */
476 477 478 479 480
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
481 482
  g_return_val_if_fail (!(flags & GST_MAP_WRITE) ||
      GST_MEMORY_IS_WRITABLE (mem), NULL);
483

484
  return mem->allocator->info.map (mem, size, maxsize, flags);
485 486
}

Wim Taymans's avatar
Wim Taymans committed
487 488 489 490
/**
 * gst_memory_unmap:
 * @mem: a #GstMemory
 * @data: data to unmap
491
 * @size: new size of @mem, or -1
Wim Taymans's avatar
Wim Taymans committed
492 493 494 495 496
 *
 * 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.
 *
497 498 499
 * 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
500 501
 * Returns: TRUE when the memory was release successfully.
 */
502
gboolean
503
gst_memory_unmap (GstMemory * mem, gpointer data, gssize size)
504 505 506
{
  g_return_val_if_fail (mem != NULL, FALSE);

507
  return mem->allocator->info.unmap (mem, data, size);
508 509
}

Wim Taymans's avatar
Wim Taymans committed
510 511 512 513
/**
 * gst_memory_copy:
 * @mem: a #GstMemory
 * @offset: an offset to copy
514
 * @size: size to copy or -1 to copy all bytes from offset
Wim Taymans's avatar
Wim Taymans committed
515 516 517 518 519 520 521
 *
 * 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.
 */
522
GstMemory *
523
gst_memory_copy (GstMemory * mem, gssize offset, gssize size)
524 525 526
{
  g_return_val_if_fail (mem != NULL, NULL);

527
  return mem->allocator->info.copy (mem, offset, size);
528 529
}

Wim Taymans's avatar
Wim Taymans committed
530 531 532 533
/**
 * gst_memory_share:
 * @mem: a #GstMemory
 * @offset: an offset to share
534
 * @size: size to share or -1 to share bytes from offset
Wim Taymans's avatar
Wim Taymans committed
535
 *
536 537 538 539
 * 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
540 541 542
 *
 * Returns: a new #GstMemory.
 */
543
GstMemory *
544
gst_memory_share (GstMemory * mem, gssize offset, gssize size)
545 546 547
{
  g_return_val_if_fail (mem != NULL, NULL);

548
  return mem->allocator->info.share (mem, offset, size);
549 550
}

Wim Taymans's avatar
Wim Taymans committed
551 552 553 554 555 556 557 558 559 560 561 562 563 564 565
/**
 * 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
566
gboolean
567
gst_memory_is_span (GstMemory * mem1, GstMemory * mem2, gsize * offset)
Wim Taymans's avatar
Wim Taymans committed
568 569 570 571
{
  g_return_val_if_fail (mem1 != NULL, FALSE);
  g_return_val_if_fail (mem2 != NULL, FALSE);

572 573
  /* need to have the same allocators */
  if (mem1->allocator != mem2->allocator)
Wim Taymans's avatar
Wim Taymans committed
574 575
    return FALSE;

576 577 578
  /* need to have the same parent */
  if (mem1->parent == NULL || mem1->parent != mem2->parent)
    return FALSE;
Wim Taymans's avatar
Wim Taymans committed
579

580
  /* and memory is contiguous */
581
  if (!mem1->allocator->info.is_span (mem1, mem2, offset))
582 583 584
    return FALSE;

  return TRUE;
Wim Taymans's avatar
Wim Taymans committed
585
}
586 587

/**
588
 * gst_allocator_register:
589 590 591 592 593 594
 * @name: the name of the allocator
 * @info: #GstMemoryInfo
 *
 * Registers the memory allocator with @name and implementation functions
 * @info.
 *
595
 * All functions in @info are mandatory exept the copy and is_span
596 597 598 599 600
 * 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.
 *
601
 * Returns: a new #GstAllocator.
602
 */
603 604
const GstAllocator *
gst_allocator_register (const gchar * name, const GstMemoryInfo * info)
605
{
606
  GstAllocator *allocator;
607 608 609 610 611 612

#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);
613
  g_return_val_if_fail (info->alloc != NULL, NULL);
614 615 616 617 618
  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);
619
  g_return_val_if_fail (info->share != NULL, NULL);
620

621
  allocator = g_slice_new (GstAllocator);
622 623 624 625 626 627
  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
628
  GST_DEBUG ("registering allocator \"%s\"", name);
629 630

  g_static_rw_lock_writer_lock (&lock);
631
  g_hash_table_insert (allocators, (gpointer) name, (gpointer) allocator);
632 633 634 635 636 637
  g_static_rw_lock_writer_unlock (&lock);

  return allocator;
}

/**
638
 * gst_allocator_find:
639 640
 * @name: the name of the allocator
 *
641 642
 * Find a previously registered allocator with @name. When @name is NULL, the
 * default allocator will be returned.
643
 *
644
 * Returns: a #GstAllocator or NULL when the allocator with @name was not
645 646
 * registered.
 */
647 648
const GstAllocator *
gst_allocator_find (const gchar * name)
649
{
650
  const GstAllocator *allocator;
651

652 653
  g_static_rw_lock_reader_lock (&lock);
  if (name) {
654
    allocator = g_hash_table_lookup (allocators, (gconstpointer) name);
655 656 657 658
  } else {
    allocator = _default_allocator;
  }
  g_static_rw_lock_reader_unlock (&lock);
659 660 661 662 663

  return allocator;
}

/**
664 665
 * gst_allocator_set_default:
 * @allocator: a #GstAllocator
666 667 668 669
 *
 * Set the default allocator.
 */
void
670
gst_allocator_set_default (const GstAllocator * allocator)
671 672 673
{
  g_return_if_fail (allocator != NULL);

674
  g_static_rw_lock_writer_lock (&lock);
675
  _default_allocator = allocator;
676
  g_static_rw_lock_writer_unlock (&lock);
677 678 679
}

/**
680
 * gst_allocator_alloc:
681
 * @allocator: (transfer none) (allow-none): a #GstAllocator to use
682 683 684 685 686 687
 * @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.
 *
688 689
 * When @allocator is NULL, the default allocator will be used.
 *
690 691 692
 * @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.
 *
693
 * Returns: (transfer full): a new #GstMemory.
694 695
 */
GstMemory *
696
gst_allocator_alloc (const GstAllocator * allocator, gsize maxsize, gsize align)
697 698 699 700 701 702
{
  g_return_val_if_fail (((align + 1) & align) == 0, NULL);

  if (allocator == NULL)
    allocator = _default_allocator;

703 704
  return allocator->info.alloc (allocator, maxsize, align,
      allocator->info.user_data);
705
}