gstmemory.c 12.3 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 50 51 52 53 54
static const GstMemoryImpl *_default_mem_impl;
static const GstMemoryImpl *_default_sub_impl;

static void
_default_mem_init (GstMemoryDefault * mem, GstMemory * parent,
    gsize slice_size, gpointer data, GFreeFunc free_func,
    gsize maxsize, gsize offset, gsize size)
{
  mem->mem.impl = data ? _default_mem_impl : _default_sub_impl;
Wim Taymans's avatar
Wim Taymans committed
55 56
  mem->mem.flags = 0;
  mem->mem.refcount = 1;
Wim Taymans's avatar
Wim Taymans committed
57 58 59 60 61 62 63 64 65 66 67 68 69 70
  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 *
_default_mem_new (GstMemory * parent, gpointer data,
    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 76
  slice_size = sizeof (GstMemoryDefault);

  mem = g_slice_alloc (slice_size);
  _default_mem_init (mem, 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 101 102 103 104 105 106
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;

  _default_mem_init (mem, NULL, slice_size, data, NULL, maxsize + align,
      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 119 120 121 122 123 124 125 126 127 128 129 130
  return mem->size;
}

static void
_default_mem_trim (GstMemoryDefault * mem, gsize offset, gsize size)
{
  g_return_if_fail (size + mem->offset + offset > mem->maxsize);

  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 187
static GstMemoryDefault *
_default_mem_copy (GstMemoryDefault * mem)
188 189 190
{
  GstMemoryDefault *copy;

Wim Taymans's avatar
Wim Taymans committed
191 192
  copy = _default_mem_new_block (mem->maxsize, 0, mem->offset, mem->size);
  memcpy (copy->data + copy->offset, 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 216 217 218 219
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;

  sub = _default_mem_new (parent, mem->data, NULL, mem->maxsize,
      mem->offset + offset, size);

  return sub;
220 221
}

Wim Taymans's avatar
Wim Taymans committed
222 223
static gboolean
_default_mem_is_span (GstMemoryDefault * mem1, GstMemoryDefault * mem2)
224
{
Wim Taymans's avatar
Wim Taymans committed
225 226 227 228 229 230 231
  /* need to have the same implementation */
  if (mem1->mem.impl != mem2->mem.impl)
    return FALSE;

  /* need to have the same parent */
  if (mem1->mem.parent == NULL || mem1->mem.parent != mem2->mem.parent)
    return FALSE;
232

Wim Taymans's avatar
Wim Taymans committed
233 234 235
  /* and memory is contiguous */
  if (mem1->data + mem1->offset + mem1->size != mem2->data + mem2->offset)
    return FALSE;
236

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

Wim Taymans's avatar
Wim Taymans committed
240 241 242
static GstMemoryDefault *
_default_mem_span (GstMemoryDefault * mem1, gsize offset,
    GstMemoryDefault * mem2, gsize size)
243
{
Wim Taymans's avatar
Wim Taymans committed
244
  GstMemoryDefault *span;
245

Wim Taymans's avatar
Wim Taymans committed
246 247
  if (_default_mem_is_span (mem1, mem2)) {
    GstMemoryDefault *parent = (GstMemoryDefault *) mem1->mem.parent;
248

Wim Taymans's avatar
Wim Taymans committed
249 250 251 252 253 254 255
    span =
        _default_mem_sub (parent, mem1->offset - parent->offset + offset, size);
  } else {
    gsize len1;

    len1 = mem1->size - offset;

Wim Taymans's avatar
Wim Taymans committed
256 257 258
    span = _default_mem_new_block (size, 0, 0, size);
    memcpy (span->data, mem1->data + mem1->offset + offset, len1);
    memcpy (span->data + len1, mem2->data + mem2->offset, size - len1);
Wim Taymans's avatar
Wim Taymans committed
259 260
  }
  return span;
261 262 263
}

static void
Wim Taymans's avatar
Wim Taymans committed
264
_fallback_extract (GstMemory * mem, gsize offset, gpointer dest, gsize size)
265 266 267 268 269 270 271 272 273 274 275 276
{
  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 *
_fallback_copy (GstMemory * mem)
{
Wim Taymans's avatar
Wim Taymans committed
277
  GstMemoryDefault *copy;
Wim Taymans's avatar
Wim Taymans committed
278
  gpointer data;
279 280 281
  gsize size;

  data = gst_memory_map (mem, &size, NULL, GST_MAP_READ);
Wim Taymans's avatar
Wim Taymans committed
282 283
  copy = _default_mem_new_block (size, 0, 0, size);
  memcpy (copy->data, data, size);
284 285
  gst_memory_unmap (mem, data, size);

Wim Taymans's avatar
Wim Taymans committed
286
  return (GstMemory *) copy;
287 288 289 290 291 292
}

static GstMemory *
_fallback_sub (GstMemory * mem, gsize offset, gsize size)
{
  GstMemoryDefault *sub;
Wim Taymans's avatar
Wim Taymans committed
293 294 295 296
  GstMemory *parent;

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

Wim Taymans's avatar
Wim Taymans committed
298
  sub = _default_mem_new (parent, NULL, NULL, size, offset, size);
299 300 301 302 303 304 305 306 307 308 309 310 311

  return (GstMemory *) sub;
}

static gboolean
_fallback_is_span (GstMemory * mem1, GstMemory * mem2)
{
  return FALSE;
}

static GstMemory *
_fallback_span (GstMemory * mem1, gsize offset, GstMemory * mem2, gsize size)
{
Wim Taymans's avatar
Wim Taymans committed
312
  GstMemoryDefault *span;
Wim Taymans's avatar
Wim Taymans committed
313
  guint8 *data;
Wim Taymans's avatar
Wim Taymans committed
314 315
  gsize ssize, len1;

Wim Taymans's avatar
Wim Taymans committed
316
  span = _default_mem_new_block (size, 0, 0, size);
Wim Taymans's avatar
Wim Taymans committed
317 318 319

  data = gst_memory_map (mem1, &ssize, NULL, GST_MAP_READ);
  len1 = ssize - offset;
Wim Taymans's avatar
Wim Taymans committed
320
  memcpy (span->data, data + offset, len1);
Wim Taymans's avatar
Wim Taymans committed
321 322 323
  gst_memory_unmap (mem1, data, size);

  data = gst_memory_map (mem2, &ssize, NULL, GST_MAP_READ);
Wim Taymans's avatar
Wim Taymans committed
324
  memcpy (span->data + len1, data, ssize - len1);
Wim Taymans's avatar
Wim Taymans committed
325 326 327
  gst_memory_unmap (mem2, data, size);

  return (GstMemory *) span;
328 329
}

330 331 332 333 334
const GstMemoryImpl *
gst_memory_register (const gchar * name, const GstMemoryInfo * info)
{
  GstMemoryImpl *impl;

335 336 337
#define INSTALL_FALLBACK(_t) \
  if (impl->info._t == NULL) impl->info._t = _fallback_ ##_t;

338 339
  g_return_val_if_fail (name != NULL, NULL);
  g_return_val_if_fail (info != NULL, NULL);
340 341 342 343 344
  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);
345 346 347 348

  impl = g_slice_new (GstMemoryImpl);
  impl->name = g_quark_from_string (name);
  impl->info = *info;
349
  INSTALL_FALLBACK (copy);
Wim Taymans's avatar
Wim Taymans committed
350
  INSTALL_FALLBACK (extract);
351 352 353
  INSTALL_FALLBACK (sub);
  INSTALL_FALLBACK (is_span);
  INSTALL_FALLBACK (span);
354 355 356 357 358 359 360 361

  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
362
#undef INSTALL_FALLBACK
363 364 365 366 367 368 369

  return impl;
}

void
_gst_memory_init (void)
{
Wim Taymans's avatar
Wim Taymans committed
370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392
  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,
    (GstMemorySpanFunction) _default_mem_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,
    NULL
393
  };
Wim Taymans's avatar
Wim Taymans committed
394 395 396

  _default_mem_impl = gst_memory_register ("GstMemoryDefault", &_mem_info);
  _default_sub_impl = gst_memory_register ("GstMemorySubbuffer", &_sub_info);
397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 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
}

GstMemory *
gst_memory_ref (GstMemory * mem)
{
  g_return_val_if_fail (mem != NULL, NULL);

  g_atomic_int_inc (&mem->refcount);

  return mem;
}

void
gst_memory_unref (GstMemory * mem)
{
  g_return_if_fail (mem != NULL);

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

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 *
gst_memory_copy (GstMemory * mem)
{
  g_return_val_if_fail (mem != NULL, NULL);

  return mem->impl->info.copy (mem);
}

451
void
Wim Taymans's avatar
Wim Taymans committed
452
gst_memory_extract (GstMemory * mem, gsize offset, gpointer dest, gsize size)
453 454 455 456
{
  g_return_if_fail (mem != NULL);
  g_return_if_fail (dest != NULL);

Wim Taymans's avatar
Wim Taymans committed
457
  return mem->impl->info.extract (mem, offset, dest, size);
458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475
}

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
476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493
gboolean
gst_memory_is_span (GstMemory * mem1, GstMemory * mem2)
{
  g_return_val_if_fail (mem1 != NULL, FALSE);
  g_return_val_if_fail (mem2 != NULL, FALSE);

  return mem1->impl->info.is_span (mem1, mem2);
}

GstMemory *
gst_memory_span (GstMemory * mem1, gsize offset, GstMemory * mem2, gsize size)
{
  g_return_val_if_fail (mem1 != NULL, NULL);
  g_return_val_if_fail (mem2 != NULL, NULL);

  return mem1->impl->info.span (mem1, offset, mem2, size);
}

494 495 496 497 498 499
GstMemory *
gst_memory_new_wrapped (gpointer data, GFreeFunc free_func,
    gsize maxsize, gsize offset, gsize size)
{
  GstMemoryDefault *mem;

Wim Taymans's avatar
Wim Taymans committed
500
  mem = _default_mem_new (NULL, data, free_func, maxsize, offset, size);
501 502 503 504 505 506 507

  return (GstMemory *) mem;
}

GstMemory *
gst_memory_new_alloc (gsize maxsize, gsize align)
{
Wim Taymans's avatar
Wim Taymans committed
508 509
  GstMemoryDefault *mem;

Wim Taymans's avatar
Wim Taymans committed
510
  mem = _default_mem_new_block (maxsize, align, 0, 0);
511

Wim Taymans's avatar
Wim Taymans committed
512 513
  return (GstMemory *) mem;
}
Wim Taymans's avatar
Wim Taymans committed
514

Wim Taymans's avatar
Wim Taymans committed
515 516 517 518 519
GstMemory *
gst_memory_new_copy (gsize maxsize, gsize align, gpointer data,
    gsize offset, gsize size)
{
  GstMemoryDefault *mem;
520

Wim Taymans's avatar
Wim Taymans committed
521 522
  mem = _default_mem_new_block (maxsize, align, offset, size);
  memcpy (mem->data, data, maxsize);
523

Wim Taymans's avatar
Wim Taymans committed
524
  return (GstMemory *) mem;
525
}