GI.Gst.Structs.Memory

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

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.

Exported types

newtype Memory

Constructors

Memory (ForeignPtr Memory)

Instances

BoxedObject Memory

(~) AttrOpTag tag AttrSet => Constructible Memory tag

((~) * signature (MapInfo -> m ()), MonadIO m) => MethodInfo * MemoryUnmapMethodInfo Memory signature

((~) * signature (Int64 -> Int64 -> m Memory), MonadIO m) => MethodInfo * MemoryShareMethodInfo Memory signature

((~) * signature (Int64 -> Word64 -> m ()), MonadIO m) => MethodInfo * MemoryResizeMethodInfo Memory signature

((~) * signature ([MapFlags] -> m (Bool, MapInfo)), MonadIO m) => MethodInfo * MemoryMapMethodInfo Memory signature

((~) * signature ([MapFlags] -> m (Maybe Memory, MapInfo)), MonadIO m) => MethodInfo * MemoryMakeMappedMethodInfo Memory signature

((~) * signature (Text -> m Bool), MonadIO m) => MethodInfo * MemoryIsTypeMethodInfo Memory signature

((~) * signature (Memory -> Word64 -> m Bool), MonadIO m) => MethodInfo * MemoryIsSpanMethodInfo Memory signature

((~) * signature (Word64 -> Word64 -> m Word64), MonadIO m) => MethodInfo * MemoryGetSizesMethodInfo Memory signature

((~) * signature (Int64 -> Int64 -> m Memory), MonadIO m) => MethodInfo * MemoryCopyMethodInfo Memory signature

((~) * info (ResolveMemoryMethod t Memory), MethodInfo * info Memory p) => IsLabelProxy t (Memory -> p)

type AttributeList Memory

newZeroMemory :: MonadIO m => m Memory

Construct a Memory struct initialized to zero.

noMemory :: Maybe Memory

Methods

memoryCopy

data MemoryCopyMethodInfo

Instances

((~) * signature (Int64 -> Int64 -> m Memory), MonadIO m) => MethodInfo * MemoryCopyMethodInfo Memory signature

memoryCopy :: MonadIO m => Memory -> Int64 -> Int64 -> m Memory

memoryGetSizes

data MemoryGetSizesMethodInfo

Instances

((~) * signature (Word64 -> Word64 -> m Word64), MonadIO m) => MethodInfo * MemoryGetSizesMethodInfo Memory signature

memoryGetSizes :: MonadIO m => Memory -> Word64 -> Word64 -> m Word64

memoryIsSpan

data MemoryIsSpanMethodInfo

Instances

((~) * signature (Memory -> Word64 -> m Bool), MonadIO m) => MethodInfo * MemoryIsSpanMethodInfo Memory signature

memoryIsSpan :: MonadIO m => Memory -> Memory -> Word64 -> m Bool

memoryIsType

data MemoryIsTypeMethodInfo

Instances

((~) * signature (Text -> m Bool), MonadIO m) => MethodInfo * MemoryIsTypeMethodInfo Memory signature

memoryIsType :: MonadIO m => Memory -> Text -> m Bool

memoryMakeMapped

data MemoryMakeMappedMethodInfo

Instances

((~) * signature ([MapFlags] -> m (Maybe Memory, MapInfo)), MonadIO m) => MethodInfo * MemoryMakeMappedMethodInfo Memory signature

memoryMakeMapped :: MonadIO m => Memory -> [MapFlags] -> m (Maybe Memory, MapInfo)

memoryMap

data MemoryMapMethodInfo

Instances

((~) * signature ([MapFlags] -> m (Bool, MapInfo)), MonadIO m) => MethodInfo * MemoryMapMethodInfo Memory signature

memoryMap :: MonadIO m => Memory -> [MapFlags] -> m (Bool, MapInfo)

memoryNewWrapped

memoryNewWrapped :: MonadIO m => [MemoryFlags] -> ByteString -> Word64 -> Word64 -> Maybe DestroyNotify -> m Memory

memoryResize

data MemoryResizeMethodInfo

Instances

((~) * signature (Int64 -> Word64 -> m ()), MonadIO m) => MethodInfo * MemoryResizeMethodInfo Memory signature

memoryResize :: MonadIO m => Memory -> Int64 -> Word64 -> m ()

memoryShare

data MemoryShareMethodInfo

Instances

((~) * signature (Int64 -> Int64 -> m Memory), MonadIO m) => MethodInfo * MemoryShareMethodInfo Memory signature

memoryShare :: MonadIO m => Memory -> Int64 -> Int64 -> m Memory

memoryUnmap

data MemoryUnmapMethodInfo

Instances

((~) * signature (MapInfo -> m ()), MonadIO m) => MethodInfo * MemoryUnmapMethodInfo Memory signature

memoryUnmap :: MonadIO m => Memory -> MapInfo -> m ()

Properties

Align

memoryAlign :: AttrLabelProxy "align"

memoryReadAlign :: MonadIO m => Memory -> m Word64

memoryWriteAlign :: MonadIO m => Memory -> Word64 -> m ()

Allocator

memoryAllocator :: AttrLabelProxy "allocator"

memoryClearAllocator :: MonadIO m => Memory -> m ()

memoryReadAllocator :: MonadIO m => Memory -> m (Maybe Allocator)

memoryWriteAllocator :: MonadIO m => Memory -> Ptr Allocator -> m ()

Maxsize

memoryMaxsize :: AttrLabelProxy "maxsize"

memoryReadMaxsize :: MonadIO m => Memory -> m Word64

memoryWriteMaxsize :: MonadIO m => Memory -> Word64 -> m ()

MiniObject

memoryClearMiniObject :: MonadIO m => Memory -> m ()

memoryMiniObject :: AttrLabelProxy "miniObject"

memoryReadMiniObject :: MonadIO m => Memory -> m (Maybe MiniObject)

memoryWriteMiniObject :: MonadIO m => Memory -> Ptr MiniObject -> m ()

Offset

memoryOffset :: AttrLabelProxy "offset"

memoryReadOffset :: MonadIO m => Memory -> m Word64

memoryWriteOffset :: MonadIO m => Memory -> Word64 -> m ()

Parent

memoryClearParent :: MonadIO m => Memory -> m ()

memoryParent :: AttrLabelProxy "parent"

memoryReadParent :: MonadIO m => Memory -> m (Maybe Memory)

memoryWriteParent :: MonadIO m => Memory -> Ptr Memory -> m ()

Size

memoryReadSize :: MonadIO m => Memory -> m Word64

memorySize :: AttrLabelProxy "size"

memoryWriteSize :: MonadIO m => Memory -> Word64 -> m ()