gstmemory.c 12.9 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 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
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
  sub = _default_mem_new (parent->flags, parent, mem->data, NULL, mem->maxsize,
Wim Taymans's avatar
Wim Taymans committed
217 218 219
      mem->offset + offset, size);

  return sub;
220 221
}

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

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

static void
Wim Taymans's avatar
Wim Taymans committed
234
_fallback_extract (GstMemory * mem, gsize offset, gpointer dest, gsize size)
235 236 237 238 239 240 241 242 243 244
{
  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 *
245
_fallback_copy (GstMemory * mem, gsize offset, gsize size)
246
{
Wim Taymans's avatar
Wim Taymans committed
247
  GstMemoryDefault *copy;
248 249
  guint8 *data;
  gsize msize;
250

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

Wim Taymans's avatar
Wim Taymans committed
256
  return (GstMemory *) copy;
257 258 259 260 261 262
}

static GstMemory *
_fallback_sub (GstMemory * mem, gsize offset, gsize size)
{
  GstMemoryDefault *sub;
Wim Taymans's avatar
Wim Taymans committed
263 264 265 266
  GstMemory *parent;

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

268
  sub = _default_mem_new (0, parent, NULL, NULL, size, offset, size);
269 270 271 272 273

  return (GstMemory *) sub;
}

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

279 280 281 282 283
const GstMemoryImpl *
gst_memory_register (const gchar * name, const GstMemoryInfo * info)
{
  GstMemoryImpl *impl;

284 285 286
#define INSTALL_FALLBACK(_t) \
  if (impl->info._t == NULL) impl->info._t = _fallback_ ##_t;

287 288
  g_return_val_if_fail (name != NULL, NULL);
  g_return_val_if_fail (info != NULL, NULL);
289 290 291 292 293
  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);
294 295 296 297

  impl = g_slice_new (GstMemoryImpl);
  impl->name = g_quark_from_string (name);
  impl->info = *info;
298
  INSTALL_FALLBACK (copy);
Wim Taymans's avatar
Wim Taymans committed
299
  INSTALL_FALLBACK (extract);
300 301
  INSTALL_FALLBACK (sub);
  INSTALL_FALLBACK (is_span);
302 303 304 305 306 307 308 309

  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
310
#undef INSTALL_FALLBACK
311 312 313 314 315 316 317

  return impl;
}

void
_gst_memory_init (void)
{
Wim Taymans's avatar
Wim Taymans committed
318 319 320 321 322 323 324 325 326
  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,
Wim Taymans's avatar
Wim Taymans committed
327
    (GstMemoryIsSpanFunction) _default_mem_is_span
Wim Taymans's avatar
Wim Taymans committed
328 329 330 331 332 333 334 335 336 337 338
  };
  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
339
  };
Wim Taymans's avatar
Wim Taymans committed
340 341 342

  _default_mem_impl = gst_memory_register ("GstMemoryDefault", &_mem_info);
  _default_sub_impl = gst_memory_register ("GstMemorySubbuffer", &_sub_info);
343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358
}

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);
359
  g_return_if_fail (mem->impl != NULL);
360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390

  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 *
391
gst_memory_copy (GstMemory * mem, gsize offset, gsize size)
392 393 394
{
  g_return_val_if_fail (mem != NULL, NULL);

395
  return mem->impl->info.copy (mem, offset, size);
396 397
}

398
void
Wim Taymans's avatar
Wim Taymans committed
399
gst_memory_extract (GstMemory * mem, gsize offset, gpointer dest, gsize size)
400 401 402 403
{
  g_return_if_fail (mem != NULL);
  g_return_if_fail (dest != NULL);

Wim Taymans's avatar
Wim Taymans committed
404
  return mem->impl->info.extract (mem, offset, dest, size);
405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422
}

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
423
gboolean
Wim Taymans's avatar
Wim Taymans committed
424 425
gst_memory_is_span (GstMemory ** mem1, gsize len1, GstMemory ** mem2,
    gsize len2, GstMemory ** parent, gsize * offset)
Wim Taymans's avatar
Wim Taymans committed
426
{
Wim Taymans's avatar
Wim Taymans committed
427 428 429 430 431
  GstMemory *m1, *m2, **arr;
  gsize len, i;
  guint count;
  gboolean have_offset = FALSE;

Wim Taymans's avatar
Wim Taymans committed
432 433 434
  g_return_val_if_fail (mem1 != NULL, FALSE);
  g_return_val_if_fail (mem2 != NULL, FALSE);

Wim Taymans's avatar
Wim Taymans committed
435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460
  arr = mem1;
  len = len1;
  m1 = m2 = NULL;

  for (count = 0; count < 2; count++) {
    gsize offs;

    for (i = 0; i < len; i++) {
      if (m2)
        m1 = m2;
      m2 = arr[i];

      if (m1 && m2) {
        /* need to have the same implementation */
        if (m1->impl != m2->impl)
          return FALSE;

        /* need to have the same parent */
        if (m1->parent == NULL || m1->parent != m2->parent)
          return FALSE;

        /* and memory is contiguous */
        if (!m1->impl->info.is_span (m1, m2, &offs))
          return FALSE;

        if (!have_offset) {
461 462 463 464 465
          if (offset)
            *offset = offs;
          if (parent)
            *parent = m1->parent;

Wim Taymans's avatar
Wim Taymans committed
466 467 468 469 470 471 472 473 474 475 476
          have_offset = TRUE;
        }
      }
    }
    arr = mem2;
    len = len2;
  }
  if (!have_offset)
    return FALSE;

  return TRUE;
Wim Taymans's avatar
Wim Taymans committed
477 478 479
}

GstMemory *
Wim Taymans's avatar
Wim Taymans committed
480 481
gst_memory_span (GstMemory ** mem1, gsize len1, gsize offset, GstMemory ** mem2,
    gsize len2, gsize size)
Wim Taymans's avatar
Wim Taymans committed
482
{
Wim Taymans's avatar
Wim Taymans committed
483 484 485 486
  GstMemory *span, **mem, *parent;
  guint8 *data, *dest;
  gsize count, ssize, tocopy, len, poffset, i;

Wim Taymans's avatar
Wim Taymans committed
487 488 489
  g_return_val_if_fail (mem1 != NULL, NULL);
  g_return_val_if_fail (mem2 != NULL, NULL);

Wim Taymans's avatar
Wim Taymans committed
490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520
  if (gst_memory_is_span (mem1, len1, mem2, len2, &parent, &poffset)) {
    span = gst_memory_sub (parent, offset + poffset, size);
  } else {
    GstMemoryDefault *tspan;

    tspan = _default_mem_new_block (size, 0, 0, size);
    dest = tspan->data;

    mem = mem1;
    len = len1;

    for (count = 0; count < 2; count++) {
      for (i = 0; i < len && size > 0; i++) {
        data = gst_memory_map (mem[i], &ssize, NULL, GST_MAP_READ);
        tocopy = MIN (ssize, size);
        if (tocopy > offset) {
          memcpy (dest, data + offset, tocopy - offset);
          size -= tocopy;
          dest += tocopy;
          offset = 0;
        } else {
          offset -= tocopy;
        }
        gst_memory_unmap (mem[i], data, ssize);
      }
      mem = mem2;
      len = len2;
    }
    span = (GstMemory *) tspan;
  }
  return span;
Wim Taymans's avatar
Wim Taymans committed
521 522
}

523
GstMemory *
524 525
gst_memory_new_wrapped (GstMemoryFlags flags, gpointer data,
    GFreeFunc free_func, gsize maxsize, gsize offset, gsize size)
526 527 528
{
  GstMemoryDefault *mem;

529
  mem = _default_mem_new (flags, NULL, data, free_func, maxsize, offset, size);
530 531 532 533 534 535 536

  return (GstMemory *) mem;
}

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

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

Wim Taymans's avatar
Wim Taymans committed
541 542
  return (GstMemory *) mem;
}
Wim Taymans's avatar
Wim Taymans committed
543

Wim Taymans's avatar
Wim Taymans committed
544 545 546 547 548
GstMemory *
gst_memory_new_copy (gsize maxsize, gsize align, gpointer data,
    gsize offset, gsize size)
{
  GstMemoryDefault *mem;
549

Wim Taymans's avatar
Wim Taymans committed
550 551
  mem = _default_mem_new_block (maxsize, align, offset, size);
  memcpy (mem->data, data, maxsize);
552

Wim Taymans's avatar
Wim Taymans committed
553
  return (GstMemory *) mem;
554
}