gstmemory.c 11.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 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37
/* 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.
 */

#include "config.h"

#include "gst_private.h"

#include "gstmemory.h"

struct _GstMemoryImpl
{
  GQuark name;

  GstMemoryInfo info;
};

typedef struct
{
  GstMemory mem;
Wim Taymans's avatar
Wim Taymans committed
38
  gsize slice_size;
39 40 41 42 43 44 45
  guint8 *data;
  GFreeFunc free_func;
  gsize maxsize;
  gsize offset;
  gsize size;
} GstMemoryDefault;

Wim Taymans's avatar
Wim Taymans committed
46 47 48 49
static const GstMemoryImpl *_default_mem_impl;
static const GstMemoryImpl *_default_sub_impl;

static void
50 51 52
_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
53 54
{
  mem->mem.impl = data ? _default_mem_impl : _default_sub_impl;
55
  mem->mem.flags = flags;
Wim Taymans's avatar
Wim Taymans committed
56
  mem->mem.refcount = 1;
Wim Taymans's avatar
Wim Taymans committed
57 58 59 60 61 62 63 64 65 66
  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;
}

static GstMemoryDefault *
67
_default_mem_new (GstMemoryFlags flags, GstMemory * parent, gpointer data,
Wim Taymans's avatar
Wim Taymans committed
68 69 70
    GFreeFunc free_func, gsize maxsize, gsize offset, gsize size)
{
  GstMemoryDefault *mem;
Wim Taymans's avatar
Wim Taymans committed
71
  gsize slice_size;
Wim Taymans's avatar
Wim Taymans committed
72

Wim Taymans's avatar
Wim Taymans committed
73 74 75
  slice_size = sizeof (GstMemoryDefault);

  mem = g_slice_alloc (slice_size);
76
  _default_mem_init (mem, flags, parent, slice_size,
Wim Taymans's avatar
Wim Taymans committed
77 78 79 80
      data, free_func, maxsize, offset, size);

  return mem;
}
81

Wim Taymans's avatar
Wim Taymans committed
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100
static GstMemoryDefault *
_default_mem_new_block (gsize maxsize, gsize align, gsize offset, gsize size)
{
  GstMemoryDefault *mem;
  gsize aoffset, slice_size;
  guint8 *data;

  /* alloc header and data in one block */
  slice_size = sizeof (GstMemoryDefault) + maxsize + align;

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

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

  if ((aoffset = ((guintptr) data & align)))
    aoffset = align - aoffset;

101
  _default_mem_init (mem, 0, NULL, slice_size, data, NULL, maxsize + align,
Wim Taymans's avatar
Wim Taymans committed
102 103 104 105 106
      aoffset + offset, size);

  return mem;
}

107
static gsize
Wim Taymans's avatar
Wim Taymans committed
108
_default_mem_get_sizes (GstMemoryDefault * mem, gsize * maxsize)
109
{
Wim Taymans's avatar
Wim Taymans committed
110 111
  if (maxsize)
    *maxsize = mem->maxsize;
112

Wim Taymans's avatar
Wim Taymans committed
113 114 115 116 117 118
  return mem->size;
}

static void
_default_mem_trim (GstMemoryDefault * mem, gsize offset, gsize size)
{
Wim Taymans's avatar
Wim Taymans committed
119
  g_return_if_fail (size + mem->offset + offset <= mem->maxsize);
Wim Taymans's avatar
Wim Taymans committed
120 121 122 123 124 125 126 127 128 129 130

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

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

Wim Taymans's avatar
Wim Taymans committed
134
  return mem->data + mem->offset;
135 136 137
}

static gpointer
Wim Taymans's avatar
Wim Taymans committed
138 139
_default_sub_map (GstMemoryDefault * mem, gsize * size, gsize * maxsize,
    GstMapFlags flags)
140
{
Wim Taymans's avatar
Wim Taymans committed
141 142 143
  guint8 *data;

  data = gst_memory_map (mem->mem.parent, size, maxsize, flags);
144 145

  if (size)
Wim Taymans's avatar
Wim Taymans committed
146
    *size = mem->size;
147
  if (maxsize)
Wim Taymans's avatar
Wim Taymans committed
148
    *maxsize -= mem->offset;
149

Wim Taymans's avatar
Wim Taymans committed
150
  return data + mem->offset;
151 152 153
}

static gboolean
Wim Taymans's avatar
Wim Taymans committed
154
_default_mem_unmap (GstMemoryDefault * mem, gpointer data, gsize size)
155
{
Wim Taymans's avatar
Wim Taymans committed
156 157 158
  mem->size = size;
  return TRUE;
}
159

Wim Taymans's avatar
Wim Taymans committed
160 161 162 163 164
static gboolean
_default_sub_unmap (GstMemoryDefault * mem, gpointer data, gsize size)
{
  gboolean res;
  guint8 *ptr = data;
165

Wim Taymans's avatar
Wim Taymans committed
166 167 168 169 170 171
  mem->size = size;

  res =
      gst_memory_unmap (mem->mem.parent, ptr - mem->offset, size + mem->offset);

  return res;
172 173 174
}

static void
Wim Taymans's avatar
Wim Taymans committed
175
_default_mem_free (GstMemoryDefault * mem)
176
{
Wim Taymans's avatar
Wim Taymans committed
177 178 179 180 181
  if (mem->mem.parent)
    gst_memory_unref (mem->mem.parent);

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

Wim Taymans's avatar
Wim Taymans committed
183
  g_slice_free1 (mem->slice_size, mem);
184 185
}

Wim Taymans's avatar
Wim Taymans committed
186
static GstMemoryDefault *
187
_default_mem_copy (GstMemoryDefault * mem, gsize offset, gsize size)
188 189 190
{
  GstMemoryDefault *copy;

191 192
  copy = _default_mem_new_block (mem->maxsize, 0, mem->offset + offset, size);
  memcpy (copy->data, mem->data, mem->maxsize);
193

Wim Taymans's avatar
Wim Taymans committed
194
  return copy;
195 196
}

197
static void
Wim Taymans's avatar
Wim Taymans committed
198 199
_default_mem_extract (GstMemoryDefault * mem, gsize offset, gpointer dest,
    gsize size)
200
{
Wim Taymans's avatar
Wim Taymans committed
201
  g_return_if_fail (size + mem->offset + offset <= mem->maxsize);
202

Wim Taymans's avatar
Wim Taymans committed
203 204
  memcpy (dest, mem->data + mem->offset + offset, size);
}
205

Wim Taymans's avatar
Wim Taymans committed
206 207 208 209 210 211 212 213 214 215
static GstMemoryDefault *
_default_mem_sub (GstMemoryDefault * mem, gsize offset, gsize size)
{
  GstMemoryDefault *sub;
  GstMemory *parent;

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

216 217 218
  if (size == -1)
    size = mem->size - offset;

219
  sub = _default_mem_new (parent->flags, parent, mem->data, NULL, mem->maxsize,
Wim Taymans's avatar
Wim Taymans committed
220 221 222
      mem->offset + offset, size);

  return sub;
223 224
}

Wim Taymans's avatar
Wim Taymans committed
225
static gboolean
Wim Taymans's avatar
Wim Taymans committed
226 227
_default_mem_is_span (GstMemoryDefault * mem1, GstMemoryDefault * mem2,
    gsize * offset)
228
{
Wim Taymans's avatar
Wim Taymans committed
229 230
  if (offset)
    *offset = mem1->offset;
231

Wim Taymans's avatar
Wim Taymans committed
232
  /* and memory is contiguous */
Wim Taymans's avatar
Wim Taymans committed
233
  return mem1->data + mem1->offset + mem1->size == mem2->data + mem2->offset;
234 235 236
}

static void
Wim Taymans's avatar
Wim Taymans committed
237
_fallback_extract (GstMemory * mem, gsize offset, gpointer dest, gsize size)
238 239 240 241 242 243 244 245 246 247
{
  guint8 *data;
  gsize msize;

  data = gst_memory_map (mem, &msize, NULL, GST_MAP_READ);
  memcpy (dest, data + offset, size);
  gst_memory_unmap (mem, data, msize);
}

static GstMemory *
248
_fallback_copy (GstMemory * mem, gsize offset, gsize size)
249
{
Wim Taymans's avatar
Wim Taymans committed
250
  GstMemoryDefault *copy;
251 252
  guint8 *data;
  gsize msize;
253

254
  data = gst_memory_map (mem, &msize, NULL, GST_MAP_READ);
Wim Taymans's avatar
Wim Taymans committed
255
  copy = _default_mem_new_block (size, 0, 0, size);
256 257
  memcpy (copy->data, data + offset, size);
  gst_memory_unmap (mem, data, msize);
258

Wim Taymans's avatar
Wim Taymans committed
259
  return (GstMemory *) copy;
260 261 262 263 264 265
}

static GstMemory *
_fallback_sub (GstMemory * mem, gsize offset, gsize size)
{
  GstMemoryDefault *sub;
Wim Taymans's avatar
Wim Taymans committed
266 267 268 269
  GstMemory *parent;

  /* find the real parent */
  parent = mem->parent ? mem->parent : mem;
270

271
  sub = _default_mem_new (0, parent, NULL, NULL, size, offset, size);
272 273 274 275 276

  return (GstMemory *) sub;
}

static gboolean
Wim Taymans's avatar
Wim Taymans committed
277
_fallback_is_span (GstMemory * mem1, GstMemory * mem2, gsize * offset)
278 279 280 281
{
  return FALSE;
}

Wim Taymans's avatar
Wim Taymans committed
282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318
void
_gst_memory_init (void)
{
  static const GstMemoryInfo _mem_info = {
    (GstMemoryGetSizesFunction) _default_mem_get_sizes,
    (GstMemoryTrimFunction) _default_mem_trim,
    (GstMemoryMapFunction) _default_mem_map,
    (GstMemoryUnmapFunction) _default_mem_unmap,
    (GstMemoryFreeFunction) _default_mem_free,
    (GstMemoryCopyFunction) _default_mem_copy,
    (GstMemoryExtractFunction) _default_mem_extract,
    (GstMemorySubFunction) _default_mem_sub,
    (GstMemoryIsSpanFunction) _default_mem_is_span
  };
  static const GstMemoryInfo _sub_info = {
    (GstMemoryGetSizesFunction) _default_mem_get_sizes,
    (GstMemoryTrimFunction) _default_mem_trim,
    (GstMemoryMapFunction) _default_sub_map,
    (GstMemoryUnmapFunction) _default_sub_unmap,
    (GstMemoryFreeFunction) _default_mem_free,
    NULL,
    NULL,
    NULL,
    NULL
  };

  _default_mem_impl = gst_memory_register ("GstMemoryDefault", &_mem_info);
  _default_sub_impl = gst_memory_register ("GstMemorySubbuffer", &_sub_info);
}

/**
 * gst_memory_register:
 * @name:
 * @info:
 *
 * Returns:
 */
319 320 321 322 323
const GstMemoryImpl *
gst_memory_register (const gchar * name, const GstMemoryInfo * info)
{
  GstMemoryImpl *impl;

324 325 326
#define INSTALL_FALLBACK(_t) \
  if (impl->info._t == NULL) impl->info._t = _fallback_ ##_t;

327 328
  g_return_val_if_fail (name != NULL, NULL);
  g_return_val_if_fail (info != NULL, NULL);
329 330 331 332 333
  g_return_val_if_fail (info->get_sizes != NULL, NULL);
  g_return_val_if_fail (info->trim != 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);
334 335 336 337

  impl = g_slice_new (GstMemoryImpl);
  impl->name = g_quark_from_string (name);
  impl->info = *info;
338
  INSTALL_FALLBACK (copy);
Wim Taymans's avatar
Wim Taymans committed
339
  INSTALL_FALLBACK (extract);
340 341
  INSTALL_FALLBACK (sub);
  INSTALL_FALLBACK (is_span);
342 343 344 345 346 347 348 349

  GST_DEBUG ("register \"%s\" of size %" G_GSIZE_FORMAT, name);

#if 0
  g_static_rw_lock_writer_lock (&lock);
  g_hash_table_insert (memoryimpl, (gpointer) name, (gpointer) impl);
  g_static_rw_lock_writer_unlock (&lock);
#endif
350
#undef INSTALL_FALLBACK
351 352 353 354

  return impl;
}

Wim Taymans's avatar
Wim Taymans committed
355 356 357
GstMemory *
gst_memory_new_wrapped (GstMemoryFlags flags, gpointer data,
    GFreeFunc free_func, gsize maxsize, gsize offset, gsize size)
358
{
Wim Taymans's avatar
Wim Taymans committed
359
  GstMemoryDefault *mem;
Wim Taymans's avatar
Wim Taymans committed
360

Wim Taymans's avatar
Wim Taymans committed
361 362 363 364 365 366 367 368 369 370 371 372 373
  mem = _default_mem_new (flags, NULL, data, free_func, maxsize, offset, size);

  return (GstMemory *) mem;
}

GstMemory *
gst_memory_new_alloc (gsize maxsize, gsize align)
{
  GstMemoryDefault *mem;

  mem = _default_mem_new_block (maxsize, align, 0, maxsize);

  return (GstMemory *) mem;
374 375
}

Wim Taymans's avatar
Wim Taymans committed
376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393
GstMemory *
gst_memory_new_copy (gsize maxsize, gsize align, gpointer data,
    gsize offset, gsize size)
{
  GstMemoryDefault *mem;

  mem = _default_mem_new_block (maxsize, align, offset, size);
  memcpy (mem->data, data, maxsize);

  return (GstMemory *) mem;
}

/**
 * gst_memory_ref:
 * @mem: a #GstMemory
 *
 * Returns: @mem with increased refcount
 */
394 395 396 397 398 399 400 401 402 403
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
404 405 406 407
/**
 * gst_memory_unref:
 * @mem: a #GstMemory
 */
408 409 410 411
void
gst_memory_unref (GstMemory * mem)
{
  g_return_if_fail (mem != NULL);
412
  g_return_if_fail (mem->impl != NULL);
413 414 415 416 417

  if (g_atomic_int_dec_and_test (&mem->refcount))
    mem->impl->info.free (mem);
}

Wim Taymans's avatar
Wim Taymans committed
418 419 420 421 422 423 424
/**
 * gst_memory_get_sizes:
 * @mem: a #GstMemory
 * @maxsize: pointer to maxsize
 *
 * Returns: the current size of @mem
 */
425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450
gsize
gst_memory_get_sizes (GstMemory * mem, gsize * maxsize)
{
  g_return_val_if_fail (mem != NULL, 0);

  return mem->impl->info.get_sizes (mem, maxsize);
}

gpointer
gst_memory_map (GstMemory * mem, gsize * size, gsize * maxsize,
    GstMapFlags flags)
{
  g_return_val_if_fail (mem != NULL, NULL);

  return mem->impl->info.map (mem, size, maxsize, flags);
}

gboolean
gst_memory_unmap (GstMemory * mem, gpointer data, gsize size)
{
  g_return_val_if_fail (mem != NULL, FALSE);

  return mem->impl->info.unmap (mem, data, size);
}

GstMemory *
451
gst_memory_copy (GstMemory * mem, gsize offset, gsize size)
452 453 454
{
  g_return_val_if_fail (mem != NULL, NULL);

455
  return mem->impl->info.copy (mem, offset, size);
456 457
}

458
void
Wim Taymans's avatar
Wim Taymans committed
459
gst_memory_extract (GstMemory * mem, gsize offset, gpointer dest, gsize size)
460 461 462 463
{
  g_return_if_fail (mem != NULL);
  g_return_if_fail (dest != NULL);

Wim Taymans's avatar
Wim Taymans committed
464
  return mem->impl->info.extract (mem, offset, dest, size);
465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482
}

void
gst_memory_trim (GstMemory * mem, gsize offset, gsize size)
{
  g_return_if_fail (mem != NULL);

  mem->impl->info.trim (mem, offset, size);
}

GstMemory *
gst_memory_sub (GstMemory * mem, gsize offset, gsize size)
{
  g_return_val_if_fail (mem != NULL, NULL);

  return mem->impl->info.sub (mem, offset, size);
}

Wim Taymans's avatar
Wim Taymans committed
483
gboolean
484
gst_memory_is_span (GstMemory * mem1, GstMemory * mem2, gsize * offset)
Wim Taymans's avatar
Wim Taymans committed
485 486 487 488
{
  g_return_val_if_fail (mem1 != NULL, FALSE);
  g_return_val_if_fail (mem2 != NULL, FALSE);

489 490
  /* need to have the same implementation */
  if (mem1->impl != mem2->impl)
Wim Taymans's avatar
Wim Taymans committed
491 492
    return FALSE;

493 494 495
  /* need to have the same parent */
  if (mem1->parent == NULL || mem1->parent != mem2->parent)
    return FALSE;
Wim Taymans's avatar
Wim Taymans committed
496

497 498 499 500 501
  /* and memory is contiguous */
  if (!mem1->impl->info.is_span (mem1, mem2, offset))
    return FALSE;

  return TRUE;
Wim Taymans's avatar
Wim Taymans committed
502
}