gstmemory.c 11.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 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 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76
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.refcount = 1;
  mem->mem.impl = data ? _default_mem_impl : _default_sub_impl;
  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;

  mem = g_slice_new (GstMemoryDefault);
  _default_mem_init (mem, parent, sizeof (GstMemoryDefault),
      data, free_func, maxsize, offset, size);

  return mem;
}
77 78

static gsize
Wim Taymans's avatar
Wim Taymans committed
79
_default_mem_get_sizes (GstMemoryDefault * mem, gsize * maxsize)
80
{
Wim Taymans's avatar
Wim Taymans committed
81 82
  if (maxsize)
    *maxsize = mem->maxsize;
83

Wim Taymans's avatar
Wim Taymans committed
84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101
  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;
102
  if (maxsize)
Wim Taymans's avatar
Wim Taymans committed
103
    *maxsize = mem->maxsize;
104

Wim Taymans's avatar
Wim Taymans committed
105
  return mem->data + mem->offset;
106 107 108
}

static gpointer
Wim Taymans's avatar
Wim Taymans committed
109 110
_default_sub_map (GstMemoryDefault * mem, gsize * size, gsize * maxsize,
    GstMapFlags flags)
111
{
Wim Taymans's avatar
Wim Taymans committed
112 113 114
  guint8 *data;

  data = gst_memory_map (mem->mem.parent, size, maxsize, flags);
115 116

  if (size)
Wim Taymans's avatar
Wim Taymans committed
117
    *size = mem->size;
118
  if (maxsize)
Wim Taymans's avatar
Wim Taymans committed
119
    *maxsize -= mem->offset;
120

Wim Taymans's avatar
Wim Taymans committed
121
  return data + mem->offset;
122 123 124
}

static gboolean
Wim Taymans's avatar
Wim Taymans committed
125
_default_mem_unmap (GstMemoryDefault * mem, gpointer data, gsize size)
126
{
Wim Taymans's avatar
Wim Taymans committed
127 128 129
  mem->size = size;
  return TRUE;
}
130

Wim Taymans's avatar
Wim Taymans committed
131 132 133 134 135
static gboolean
_default_sub_unmap (GstMemoryDefault * mem, gpointer data, gsize size)
{
  gboolean res;
  guint8 *ptr = data;
136

Wim Taymans's avatar
Wim Taymans committed
137 138 139 140 141 142
  mem->size = size;

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

  return res;
143 144 145
}

static void
Wim Taymans's avatar
Wim Taymans committed
146
_default_mem_free (GstMemoryDefault * mem)
147
{
Wim Taymans's avatar
Wim Taymans committed
148 149 150 151 152
  if (mem->mem.parent)
    gst_memory_unref (mem->mem.parent);

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

Wim Taymans's avatar
Wim Taymans committed
154
  g_slice_free1 (mem->slice_size, mem);
155 156
}

Wim Taymans's avatar
Wim Taymans committed
157 158
static GstMemoryDefault *
_default_mem_copy (GstMemoryDefault * mem)
159 160
{
  GstMemoryDefault *copy;
Wim Taymans's avatar
Wim Taymans committed
161
  gpointer data;
162

Wim Taymans's avatar
Wim Taymans committed
163 164 165
  data = g_memdup (mem->data, mem->maxsize);
  copy = _default_mem_new (NULL, data, g_free, mem->maxsize,
      mem->offset, mem->size);
166

Wim Taymans's avatar
Wim Taymans committed
167
  return copy;
168 169
}

170
static void
Wim Taymans's avatar
Wim Taymans committed
171 172
_default_mem_extract (GstMemoryDefault * mem, gsize offset, gpointer dest,
    gsize size)
173
{
Wim Taymans's avatar
Wim Taymans committed
174
  g_return_if_fail (size + mem->offset + offset > mem->maxsize);
175

Wim Taymans's avatar
Wim Taymans committed
176 177
  memcpy (dest, mem->data + mem->offset + offset, size);
}
178

Wim Taymans's avatar
Wim Taymans committed
179 180 181 182 183 184 185 186 187 188 189 190 191 192
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;
193 194
}

Wim Taymans's avatar
Wim Taymans committed
195 196
static gboolean
_default_mem_is_span (GstMemoryDefault * mem1, GstMemoryDefault * mem2)
197
{
Wim Taymans's avatar
Wim Taymans committed
198 199 200 201 202 203 204
  /* 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;
205

Wim Taymans's avatar
Wim Taymans committed
206 207 208
  /* and memory is contiguous */
  if (mem1->data + mem1->offset + mem1->size != mem2->data + mem2->offset)
    return FALSE;
209

Wim Taymans's avatar
Wim Taymans committed
210
  return TRUE;
211 212
}

Wim Taymans's avatar
Wim Taymans committed
213 214 215
static GstMemoryDefault *
_default_mem_span (GstMemoryDefault * mem1, gsize offset,
    GstMemoryDefault * mem2, gsize size)
216
{
Wim Taymans's avatar
Wim Taymans committed
217
  GstMemoryDefault *span;
218

Wim Taymans's avatar
Wim Taymans committed
219 220
  if (_default_mem_is_span (mem1, mem2)) {
    GstMemoryDefault *parent = (GstMemoryDefault *) mem1->mem.parent;
221

Wim Taymans's avatar
Wim Taymans committed
222 223 224 225 226 227 228 229 230 231 232 233 234 235 236
    span =
        _default_mem_sub (parent, mem1->offset - parent->offset + offset, size);
  } else {
    guint8 *data;
    gsize len1;

    data = g_malloc (size);
    len1 = mem1->size - offset;

    memcpy (data, mem1->data + mem1->offset + offset, len1);
    memcpy (data + len1, mem2->data + mem2->offset, size - len1);

    span = _default_mem_new (NULL, data, g_free, size, 0, size);
  }
  return span;
237 238 239
}

static void
Wim Taymans's avatar
Wim Taymans committed
240
_fallback_extract (GstMemory * mem, gsize offset, gpointer dest, gsize size)
241 242 243 244 245 246 247 248 249 250 251 252
{
  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
253
  GstMemoryDefault *copy;
254 255 256 257 258 259 260
  gpointer data, cdata;
  gsize size;

  data = gst_memory_map (mem, &size, NULL, GST_MAP_READ);
  cdata = g_memdup (data, size);
  gst_memory_unmap (mem, data, size);

Wim Taymans's avatar
Wim Taymans committed
261
  copy = _default_mem_new (NULL, cdata, g_free, size, 0, size);
262

Wim Taymans's avatar
Wim Taymans committed
263
  return (GstMemory *) copy;
264 265 266 267 268 269
}

static GstMemory *
_fallback_sub (GstMemory * mem, gsize offset, gsize size)
{
  GstMemoryDefault *sub;
Wim Taymans's avatar
Wim Taymans committed
270 271 272 273
  GstMemory *parent;

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

Wim Taymans's avatar
Wim Taymans committed
275
  sub = _default_mem_new (parent, NULL, NULL, size, offset, size);
276 277 278 279 280 281 282 283 284 285 286 287 288

  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
289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306
  GstMemoryDefault *span;
  guint8 *data, *dest;
  gsize ssize, len1;

  dest = g_malloc (size);

  data = gst_memory_map (mem1, &ssize, NULL, GST_MAP_READ);
  len1 = ssize - offset;
  memcpy (dest, data + offset, len1);
  gst_memory_unmap (mem1, data, size);

  data = gst_memory_map (mem2, &ssize, NULL, GST_MAP_READ);
  memcpy (dest + len1, data, ssize - len1);
  gst_memory_unmap (mem2, data, size);

  span = _default_mem_new (NULL, dest, g_free, size, 0, size);

  return (GstMemory *) span;
307 308
}

309 310 311 312 313
const GstMemoryImpl *
gst_memory_register (const gchar * name, const GstMemoryInfo * info)
{
  GstMemoryImpl *impl;

314 315 316
#define INSTALL_FALLBACK(_t) \
  if (impl->info._t == NULL) impl->info._t = _fallback_ ##_t;

317 318
  g_return_val_if_fail (name != NULL, NULL);
  g_return_val_if_fail (info != NULL, NULL);
319 320 321 322 323
  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);
324 325 326 327

  impl = g_slice_new (GstMemoryImpl);
  impl->name = g_quark_from_string (name);
  impl->info = *info;
328
  INSTALL_FALLBACK (copy);
Wim Taymans's avatar
Wim Taymans committed
329
  INSTALL_FALLBACK (extract);
330 331 332
  INSTALL_FALLBACK (sub);
  INSTALL_FALLBACK (is_span);
  INSTALL_FALLBACK (span);
333 334 335 336 337 338 339 340

  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
341
#undef INSTALL_FALLBACK
342 343 344 345 346 347 348

  return impl;
}

void
_gst_memory_init (void)
{
Wim Taymans's avatar
Wim Taymans committed
349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371
  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
372
  };
Wim Taymans's avatar
Wim Taymans committed
373 374 375

  _default_mem_impl = gst_memory_register ("GstMemoryDefault", &_mem_info);
  _default_sub_impl = gst_memory_register ("GstMemorySubbuffer", &_sub_info);
376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 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
}

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);
}

430
void
Wim Taymans's avatar
Wim Taymans committed
431
gst_memory_extract (GstMemory * mem, gsize offset, gpointer dest, gsize size)
432 433 434 435
{
  g_return_if_fail (mem != NULL);
  g_return_if_fail (dest != NULL);

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

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
455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472
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);
}

473 474 475 476 477 478
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
479
  mem = _default_mem_new (NULL, data, free_func, maxsize, offset, size);
480 481 482 483 484 485 486

  return (GstMemory *) mem;
}

GstMemory *
gst_memory_new_alloc (gsize maxsize, gsize align)
{
Wim Taymans's avatar
Wim Taymans committed
487 488 489 490 491 492
  GstMemoryDefault *mem;
  guint8 *data;
  gsize offset, size;

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

Wim Taymans's avatar
Wim Taymans committed
494 495
  mem = g_slice_alloc (size);
  if (mem == NULL)
496 497
    return NULL;

Wim Taymans's avatar
Wim Taymans committed
498 499
  data = (guint8 *) mem + sizeof (GstMemoryDefault);

500 501 502
  if ((offset = ((guintptr) data & align)))
    offset = align - offset;

Wim Taymans's avatar
Wim Taymans committed
503 504
  _default_mem_init (mem, NULL, size, data, NULL, maxsize + align, offset,
      maxsize);
505

Wim Taymans's avatar
Wim Taymans committed
506
  return (GstMemory *) mem;
507
}