gst/gstmemory.h

   1 /* GStreamer
   2  * Copyright (C) 2009 Wim Taymans <wim.taymans@gmail.be>
   3  *
   4  * gstmemory.h: Header for memory blocks
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Library General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Library General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Library General Public
  17  * License along with this library; if not, write to the
  18  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  19  * Boston, MA 02111-1307, USA.
  20  */
  21
  22
  23 #ifndef __GST_MEMORY_H__
  24 #define __GST_MEMORY_H__
  25
  26 #include <gst/gstconfig.h>
  27
  28 #include <glib-object.h>
  29
  30 G_BEGIN_DECLS
  31
  32 #define GST_TYPE_MEMORY (gst_memory_get_type())
  33 GType gst_memory_get_type(void);
  34
  35 #define GST_TYPE_ALLOCATOR (gst_allocator_get_type())
  36 GType gst_allocator_get_type(void);
  37
  38 #define GST_TYPE_ALLOCATION_PARAMS (gst_allocation_params_get_type())
  39 GType gst_allocation_params_get_type(void);
  40
  41 typedef struct _GstMemory GstMemory;
  42 typedef struct _GstMemoryInfo GstMemoryInfo;
  43 typedef struct _GstAllocator GstAllocator;
  44 typedef struct _GstAllocationParams GstAllocationParams;
  45
  46 /**
  47  * gst_memory_alignment:
  48  *
  49  * The default memory alignment in bytes - 1
  50  * an alignment of 7 would be the same as what malloc() guarantees.
  51  */
  52 GST_EXPORT gsize gst_memory_alignment;
  53
  54 #define GST_MEMORY_CAST(mem)   ((GstMemory *)(mem))
  55
  56 /**
  57  * GstMemoryFlags:
  58  * @GST_MEMORY_FLAG_READONLY: memory is readonly. It is not allowed to map the
  59  * memory with #GST_MAP_WRITE.
  60  * @GST_MEMORY_FLAG_NO_SHARE: memory must not be shared. Copies will have to be
  61  * made when this memory needs to be shared between buffers.
  62  * @GST_MEMORY_FLAG_ZERO_PREFIXED: the memory prefix is filled with 0 bytes
  63  * @GST_MEMORY_FLAG_ZERO_PADDED: the memory padding is filled with 0 bytes
  64  * @GST_MEMORY_FLAG_LAST: first flag that can be used for custom purposes
  65  *
  66  * Flags for wrapped memory.
  67  */
  68 typedef enum {
  69   GST_MEMORY_FLAG_READONLY      = (GST_MINI_OBJECT_FLAG_LAST << 0),
  70   GST_MEMORY_FLAG_NO_SHARE      = (GST_MINI_OBJECT_FLAG_LAST << 1),
  71   GST_MEMORY_FLAG_ZERO_PREFIXED = (GST_MINI_OBJECT_FLAG_LAST << 2),
  72   GST_MEMORY_FLAG_ZERO_PADDED   = (GST_MINI_OBJECT_FLAG_LAST << 3),
  73
  74   GST_MEMORY_FLAG_LAST          = (GST_MINI_OBJECT_FLAG_LAST << 16)
  75 } GstMemoryFlags;
  76
  77 /**
  78  * GST_MEMORY_FLAGS:
  79  * @mem: a #GstMemory.
  80  *
  81  * A flags word containing #GstMemoryFlags flags set on @mem
  82  */
  83 #define GST_MEMORY_FLAGS(mem)  GST_MINI_OBJECT_FLAGS (mem)
  84 /**
  85  * GST_MEMORY_FLAG_IS_SET:
  86  * @mem: a #GstMemory.
  87  * @flag: the #GstMemoryFlags to check.
  88  *
  89  * Gives the status of a specific flag on a @mem.
  90  */
  91 #define GST_MEMORY_FLAG_IS_SET(mem,flag)   GST_MINI_OBJECT_FLAG_IS_SET (mem,flag)
  92 /**
  93  * GST_MEMORY_FLAG_UNSET:
  94  * @mem: a #GstMemory.
  95  * @flag: the #GstMemoryFlags to clear.
  96  *
  97  * Clear a specific flag on a @mem.
  98  */
  99 #define GST_MEMORY_FLAG_UNSET(mem,flag)   GST_MINI_OBJECT_FLAG_UNSET (mem, flag)
 100
 101 /**
 102  * GST_MEMORY_IS_READONLY:
 103  * @mem: a #GstMemory.
 104  *
 105  * Check if @mem is readonly.
 106  */
 107 #define GST_MEMORY_IS_READONLY(mem)        GST_MEMORY_FLAG_IS_SET(mem,GST_MEMORY_FLAG_READONLY)
 108 /**
 109  * GST_MEMORY_IS_NO_SHARE:
 110  * @mem: a #GstMemory.
 111  *
 112  * Check if @mem cannot be shared between buffers
 113  */
 114 #define GST_MEMORY_IS_NO_SHARE(mem)        GST_MEMORY_FLAG_IS_SET(mem,GST_MEMORY_FLAG_NO_SHARE)
 115 /**
 116  * GST_MEMORY_IS_ZERO_PREFIXED:
 117  * @mem: a #GstMemory.
 118  *
 119  * Check if the prefix in @mem is 0 filled.
 120  */
 121 #define GST_MEMORY_IS_ZERO_PREFIXED(mem)   GST_MEMORY_FLAG_IS_SET(mem,GST_MEMORY_FLAG_ZERO_PREFIXED)
 122 /**
 123  * GST_MEMORY_IS_ZERO_PADDED:
 124  * @mem: a #GstMemory.
 125  *
 126  * Check if the padding in @mem is 0 filled.
 127  */
 128 #define GST_MEMORY_IS_ZERO_PADDED(mem)     GST_MEMORY_FLAG_IS_SET(mem,GST_MEMORY_FLAG_ZERO_PADDED)
 129
 130
 131 /**
 132  * GstMemory:
 133  * @mini_object: parent structure
 134  * @allocator: pointer to the #GstAllocator
 135  * @parent: parent memory block
 136  * @state: private state
 137  * @maxsize: the maximum size allocated
 138  * @align: the alignment of the memory
 139  * @offset: the offset where valid data starts
 140  * @size: the size of valid data
 141  *
 142  * Base structure for memory implementations. Custom memory will put this structure
 143  * as the first member of their structure.
 144  */
 145 struct _GstMemory {
 146   GstMiniObject   mini_object;
 147
 148   GstAllocator   *allocator;
 149
 150   GstMemory      *parent;
 151   volatile gint   state;
 152   gsize           maxsize;
 153   gsize           align;
 154   gsize           offset;
 155   gsize           size;
 156 };
 157
 158 /**
 159  * GstMapFlags:
 160  * @GST_MAP_READ: map for read access
 161  * @GST_MAP_WRITE: map for write access
 162  * @GST_MAP_FLAG_LAST: first flag that can be used for custom purposes
 163  *
 164  * Flags used when mapping memory
 165  */
 166 typedef enum {
 167   GST_MAP_READ      = (1 << 0),
 168   GST_MAP_WRITE     = (1 << 1),
 169
 170   GST_MAP_FLAG_LAST = (1 << 16)
 171 } GstMapFlags;
 172
 173 /**
 174  * GstMapInfo:
 175  * @memory: a pointer to the mapped memory
 176  * @flags: flags used when mapping the memory
 177  * @data: (array length=size): a pointer to the mapped data
 178  * @size: the valid size in @data
 179  * @maxsize: the maximum bytes in @data
 180  * @user_data: extra private user_data that the implementation of the memory
 181  *             can use to store extra info.
 182  *
 183  * A structure containing the result of a map operation such as
 184  * gst_memory_map(). It contains the data and size.
 185  */
 186 typedef struct {
 187   GstMemory *memory;
 188   GstMapFlags flags;
 189   guint8 *data;
 190   gsize size;
 191   gsize maxsize;
 192   /*< private >*/
 193   gpointer user_data[4];
 194 } GstMapInfo;
 195
 196 /**
 197  * GST_MAP_INFO_INIT:
 198  *
 199  * Initializer for #GstMapInfo
 200  */
 201 #define GST_MAP_INFO_INIT { NULL, 0, NULL, 0, 0, }
 202
 203 /**
 204  * GST_MAP_READWRITE:
 205  *
 206  * Map for readwrite access
 207  */
 208 #define GST_MAP_READWRITE      (GST_MAP_READ | GST_MAP_WRITE)
 209
 210 /**
 211  * GST_ALLOCATOR_SYSMEM:
 212  *
 213  * The allocator name for the default system memory allocator
 214  */
 215 #define GST_ALLOCATOR_SYSMEM   "SystemMemory"
 216
 217 /**
 218  * GstAllocationParams:
 219  * @flags: flags to control allocation
 220  * @align: the desired alignment of the memory
 221  * @prefix: the desired prefix
 222  * @padding: the desired padding
 223  *
 224  * Parameters to control the allocation of memory
 225  */
 226 struct _GstAllocationParams {
 227   GstMemoryFlags flags;
 228   gsize          align;
 229   gsize          prefix;
 230   gsize          padding;
 231
 232   /*< private >*/
 233   gpointer _gst_reserved[GST_PADDING];
 234 };
 235
 236 /**
 237  * GstAllocatorAllocFunction:
 238  * @allocator: a #GstAllocator
 239  * @size: the size
 240  * @params: allocator params
 241  * @user_data: user data
 242  *
 243  * Allocate a new #GstMemory from @allocator that can hold at least @size
 244  * bytes (+ padding) and is aligned to (@align + 1) bytes.
 245  *
 246  * The offset and size of the memory should be set and the prefix/padding must
 247  * be filled with 0 if @params flags contains #GST_MEMORY_FLAG_ZERO_PREFIXED and
 248  * #GST_MEMORY_FLAG_ZERO_PADDED respectively.
 249  *
 250  * @user_data is extra data passed to this function. The default
 251  * gst_allocator_alloc() passes the user_data that was used when creating
 252  * @allocator.
 253  *
 254  * Returns: a newly allocated #GstMemory. Free with gst_memory_unref()
 255  */
 256 typedef GstMemory *  (*GstAllocatorAllocFunction)  (GstAllocator *allocator,
 257                                                     gsize size, GstAllocationParams *params,
 258                                                     gpointer user_data);
 259
 260 /**
 261  * GstMemoryMapFunction:
 262  * @mem: a #GstMemory
 263  * @maxsize: size to map
 264  * @flags: access mode for the memory
 265  *
 266  * Get the memory of @mem that can be accessed according to the mode specified
 267  * in @flags. The function should return a pointer that contains at least
 268  * @maxsize bytes.
 269  *
 270  * Returns: a pointer to memory of which at least @maxsize bytes can be
 271  * accessed according to the access pattern in @flags.
 272  */
 273 typedef gpointer    (*GstMemoryMapFunction)       (GstMemory *mem, gsize maxsize, GstMapFlags flags);
 274
 275 /**
 276  * GstMemoryUnmapFunction:
 277  * @mem: a #GstMemory
 278  *
 279  * Return the pointer previously retrieved with gst_memory_map().
 280  *
 281  * Returns: %TRUE on success.
 282  */
 283 typedef void        (*GstMemoryUnmapFunction)     (GstMemory *mem);
 284
 285 /**
 286  * GstMemoryFreeFunction:
 287  * @mem: a #GstMemory
 288  *
 289  * Free the memory used by @mem. This function is usually called when the
 290  * refcount of the @mem has reached 0.
 291  */
 292 typedef void        (*GstMemoryFreeFunction)      (GstMemory *mem);
 293
 294 /**
 295  * GstMemoryCopyFunction:
 296  * @mem: a #GstMemory
 297  * @offset: an offset
 298  * @size: a size or -1
 299  *
 300  * Copy @size bytes from @mem starting at @offset and return them wrapped in a
 301  * new GstMemory object.
 302  * If @size is set to -1, all bytes starting at @offset are copied.
 303  *
 304  * Returns: a new #GstMemory object wrapping a copy of the requested region in
 305  * @mem.
 306  */
 307 typedef GstMemory * (*GstMemoryCopyFunction)      (GstMemory *mem, gssize offset, gssize size);
 308
 309 /**
 310  * GstMemoryShareFunction:
 311  * @mem: a #GstMemory
 312  * @offset: an offset
 313  * @size: a size or -1
 314  *
 315  * Share @size bytes from @mem starting at @offset and return them wrapped in a
 316  * new GstMemory object. If @size is set to -1, all bytes starting at @offset are
 317  * shared. This function does not make a copy of the bytes in @mem.
 318  *
 319  * Returns: a new #GstMemory object sharing the requested region in @mem.
 320  */
 321 typedef GstMemory * (*GstMemoryShareFunction)     (GstMemory *mem, gssize offset, gssize size);
 322
 323 /**
 324  * GstMemoryIsSpanFunction:
 325  * @mem1: a #GstMemory
 326  * @mem2: a #GstMemory
 327  * @offset: a result offset
 328  *
 329  * Check if @mem1 and @mem2 occupy contiguous memory and return the offset of
 330  * @mem1 in the parent buffer in @offset.
 331  *
 332  * Returns: %TRUE if @mem1 and @mem2 are in contiguous memory.
 333  */
 334 typedef gboolean    (*GstMemoryIsSpanFunction)    (GstMemory *mem1, GstMemory *mem2, gsize *offset);
 335
 336 /**
 337  * GstMemoryInfo:
 338  * @mem_type: the memory type this allocator provides
 339  * @alloc: the implementation of the GstAllocatorAllocFunction
 340  * @mem_map: the implementation of the GstMemoryMapFunction
 341  * @mem_unmap: the implementation of the GstMemoryUnmapFunction
 342  * @mem_free: the implementation of the GstMemoryFreeFunction
 343  * @mem_copy: the implementation of the GstMemoryCopyFunction
 344  * @mem_share: the implementation of the GstMemoryShareFunction
 345  * @mem_is_span: the implementation of the GstMemoryIsSpanFunction
 346  *
 347  * The #GstMemoryInfo is used to register new memory allocators and contain
 348  * the implementations for various memory operations.
 349  */
 350 struct _GstMemoryInfo {
 351   const gchar              *mem_type;
 352
 353   GstAllocatorAllocFunction alloc;
 354
 355   GstMemoryMapFunction      mem_map;
 356   GstMemoryUnmapFunction    mem_unmap;
 357   GstMemoryFreeFunction     mem_free;
 358
 359   GstMemoryCopyFunction     mem_copy;
 360   GstMemoryShareFunction    mem_share;
 361   GstMemoryIsSpanFunction   mem_is_span;
 362
 363   /*< private >*/
 364   gpointer _gst_reserved[GST_PADDING];
 365 };
 366
 367 /**
 368  * GstAllocator:
 369  *
 370  * An opaque type returned from gst_allocator_new() or gst_allocator_find()
 371  * that can be used to allocator memory.
 372  */
 373
 374 /* allocators */
 375 GstAllocator * gst_allocator_new             (const GstMemoryInfo * info,
 376                                               gpointer user_data, GDestroyNotify notify);
 377 const gchar *  gst_allocator_get_memory_type (GstAllocator * allocator);
 378
 379 /**
 380  * gst_allocator_ref:
 381  * @allocator: The allocator to refcount
 382  *
 383  * Increase the refcount of this allocator.
 384  *
 385  * Returns: (transfer full): @allocator (for convenience when doing assignments)
 386  */
 387 #ifdef _FOOL_GTK_DOC_
 388 G_INLINE_FUNC GstAllocator * gst_allocator_ref (GstAllocator * allocator);
 389 #endif
 390
 391 static inline GstAllocator *
 392 gst_allocator_ref (GstAllocator * allocator)
 393 {
 394   return (GstAllocator *) gst_mini_object_ref (GST_MINI_OBJECT_CAST (allocator));
 395 }
 396
 397 /**
 398  * gst_allocator_unref:
 399  * @allocator: (transfer full): the allocator to refcount
 400  *
 401  * Decrease the refcount of an allocator, freeing it if the refcount reaches 0.
 402  */
 403 #ifdef _FOOL_GTK_DOC_
 404 G_INLINE_FUNC void gst_allocator_unref (GstAllocator * allocator);
 405 #endif
 406
 407 static inline void
 408 gst_allocator_unref (GstAllocator * allocator)
 409 {
 410   gst_mini_object_unref (GST_MINI_OBJECT_CAST (allocator));
 411 }
 412
 413 void           gst_allocator_register        (const gchar *name, GstAllocator *allocator);
 414 GstAllocator * gst_allocator_find            (const gchar *name);
 415
 416 void           gst_allocator_set_default     (GstAllocator * allocator);
 417
 418 /* allocating memory blocks */
 419 void           gst_allocation_params_init     (GstAllocationParams *params);
 420 GstAllocationParams *
 421                gst_allocation_params_copy     (const GstAllocationParams *params) G_GNUC_MALLOC;
 422 void           gst_allocation_params_free     (GstAllocationParams *params);
 423
 424 GstMemory *    gst_allocator_alloc           (GstAllocator * allocator, gsize size,
 425                                               GstAllocationParams *params);
 426
 427 GstMemory *    gst_memory_new_wrapped  (GstMemoryFlags flags, gpointer data, gsize maxsize,
 428                                         gsize offset, gsize size, gpointer user_data,
 429                                         GDestroyNotify notify);
 430
 431 /* refcounting */
 432 /**
 433  * gst_memory_ref:
 434  * @memory: The memory to refcount
 435  *
 436  * Increase the refcount of this memory.
 437  *
 438  * Returns: (transfer full): @memory (for convenience when doing assignments)
 439  */
 440 #ifdef _FOOL_GTK_DOC_
 441 G_INLINE_FUNC GstMemory * gst_memory_ref (GstMemory * memory);
 442 #endif
 443
 444 static inline GstMemory *
 445 gst_memory_ref (GstMemory * memory)
 446 {
 447   return (GstMemory *) gst_mini_object_ref (GST_MINI_OBJECT_CAST (memory));
 448 }
 449
 450 /**
 451  * gst_memory_unref:
 452  * @memory: (transfer full): the memory to refcount
 453  *
 454  * Decrease the refcount of an memory, freeing it if the refcount reaches 0.
 455  */
 456 #ifdef _FOOL_GTK_DOC_
 457 G_INLINE_FUNC void gst_memory_unref (GstMemory * memory);
 458 #endif
 459
 460 static inline void
 461 gst_memory_unref (GstMemory * memory)
 462 {
 463   gst_mini_object_unref (GST_MINI_OBJECT_CAST (memory));
 464 }
 465
 466 gboolean       gst_memory_is_exclusive (GstMemory *mem);
 467
 468 /* getting/setting memory properties */
 469 gsize          gst_memory_get_sizes    (GstMemory *mem, gsize *offset, gsize *maxsize);
 470 void           gst_memory_resize       (GstMemory *mem, gssize offset, gsize size);
 471
 472 /* retrieving data */
 473 GstMemory *    gst_memory_make_mapped  (GstMemory *mem, GstMapInfo *info, GstMapFlags flags);
 474 gboolean       gst_memory_map          (GstMemory *mem, GstMapInfo *info, GstMapFlags flags);
 475 void           gst_memory_unmap        (GstMemory *mem, GstMapInfo *info);
 476
 477 /* copy and subregions */
 478 GstMemory *    gst_memory_copy         (GstMemory *mem, gssize offset, gssize size);
 479 GstMemory *    gst_memory_share        (GstMemory *mem, gssize offset, gssize size);
 480
 481 /* span memory */
 482 gboolean       gst_memory_is_span      (GstMemory *mem1, GstMemory *mem2, gsize *offset);
 483
 484 G_END_DECLS
 485
 486 #endif /* __GST_MEMORY_H__ */