Class (GI Struct)

Gst-1.0GstMemory

GstMemory is a lightweight refcounted object that wraps a region of memory. They are typically used to manage the data of a Gst.Buffer.

A GstMemory object has an allocated region of memory of maxsize. The maximum size does not change during the lifetime of the memory object. The memory also has an offset and size property that specifies the valid range of memory in the allocated region.

Memory is usually created by allocators with a gst_allocator_alloc() method call. When null is used as the allocator, the default allocator will be used.

New allocators can be registered with gst_allocator_register(). Allocators are identified by name and can be retrieved with gst_allocator_find(). gst_allocator_set_default() can be used to change the default allocator.

New memory can be created with gst_memory_new_wrapped() that wraps the memory allocated elsewhere.

Refcounting of the memory block is performed with gst_memory_ref() and gst_memory_unref().

The size of the memory can be retrieved and changed with gst_memory_get_sizes() and gst_memory_resize() respectively.

Getting access to the data of the memory is performed with gst_memory_map(). The call will return a pointer to offset bytes into the region of memory. After the memory access is completed, gst_memory_unmap() should be called.

Memory can be copied with gst_memory_copy(), which will return a writable copy. gst_memory_share() will create a new memory block that shares the memory with an existing memory block at a custom offset and with a custom size.

Memory can be efficiently merged when gst_memory_is_span() returns true.

Index

Constructors

Properties

align: number
allocator: Gst.Allocator
maxsize: number
offset: number
size: number
$gtype: GType<Memory>

Methods

  • Return a copy of size bytes from mem starting from offset. This copy is guaranteed to be writable. size can be set to -1 to return a copy from offset to the end of the memory region.

    Parameters

    • offset: number

      offset to copy from

    • size: number

      size to copy, or -1 to copy to the end of the memory region

    Returns Memory

    a new copy of mem if the copy succeeded, null otherwise.

  • Get the current size, offset and maxsize of mem.

    Returns [number, number, number]

    the current size of mem

  • Check if mem1 and mem2 share the memory with a common parent memory object and that the memory is contiguous.

    If this is the case, the memory of mem1 and mem2 can be merged efficiently by performing gst_memory_share() on the parent object from the returned offset.

    Parameters

    Returns [boolean, number]

    true if the memory is contiguous and of a common parent.

  • Check if mem if allocated with an allocator for mem_type.

    Parameters

    • mem_type: string

      a memory type

    Returns boolean

    true if mem was allocated from an allocator for mem_type.

  • Fill info with the pointer and sizes of the memory in mem that can be accessed according to flags.

    This function can return false for various reasons:

    • the memory backed by mem is not accessible with the given flags.
    • the memory was already mapped with a different mapping.

    info and its contents remain valid for as long as mem is valid and until gst_memory_unmap() is called.

    For each gst_memory_map() call, a corresponding gst_memory_unmap() call should be done.

    Parameters

    Returns [boolean, MapInfo]

    true if the map operation was successful.

  • Resize the memory region. mem should be writable and offset + size should be less than the maxsize of mem.

    #GST_MEMORY_FLAG_ZERO_PREFIXED and #GST_MEMORY_FLAG_ZERO_PADDED will be cleared when offset or padding is increased respectively.

    Parameters

    • offset: number

      a new offset

    • size: number

      a new size

    Returns void

  • Return a shared copy of size bytes from mem starting from offset. No memory copy is performed and the memory region is simply shared. The result is guaranteed to be non-writable. size can be set to -1 to return a shared copy from offset to the end of the memory region.

    Parameters

    • offset: number

      offset to share from

    • size: number

      size to share, or -1 to share to the end of the memory region

    Returns Memory

    a new Gst.Memory.