GI.GstAudio.Structs.DsdPlaneOffsetMeta

Buffer metadata describing planar DSD contents in the buffer. This is not needed for interleaved DSD data, and is required for non-interleaved (= planar) data.

The different channels in offsets are always in the GStreamer channel order. Zero-copy channel reordering can be implemented by swapping the values in offsets.

It is not allowed for channels to overlap in memory, i.e. for each i in [0, channels), the range [offsets[i], offsets[i] + numBytesPerChannel) must not overlap with any other such range.

It is, however, allowed to have parts of the buffer memory unused, by using offsets and numBytesPerChannel in such a way that leave gaps on it. This is used to implement zero-copy clipping in non-interleaved buffers.

Obviously, due to the above, it is not safe to infer the number of valid bytes from the size of the buffer. You should always use the numBytesPerChannel variable of this metadata.

Since: 1.24

Exported types

newtype DsdPlaneOffsetMeta

Memory-managed wrapper type.

Constructors

DsdPlaneOffsetMeta (ManagedPtr DsdPlaneOffsetMeta)

Instances

Eq DsdPlaneOffsetMeta

Defined in GI.GstAudio.Structs.DsdPlaneOffsetMeta

Methods

(==) :: DsdPlaneOffsetMeta -> DsdPlaneOffsetMeta -> Bool

(/=) :: DsdPlaneOffsetMeta -> DsdPlaneOffsetMeta -> Bool

BoxedPtr DsdPlaneOffsetMeta

Defined in GI.GstAudio.Structs.DsdPlaneOffsetMeta

Methods

boxedPtrCopy :: DsdPlaneOffsetMeta -> IO DsdPlaneOffsetMeta

boxedPtrFree :: DsdPlaneOffsetMeta -> IO ()

CallocPtr DsdPlaneOffsetMeta

Defined in GI.GstAudio.Structs.DsdPlaneOffsetMeta

Methods

boxedPtrCalloc :: IO (Ptr DsdPlaneOffsetMeta)

ManagedPtrNewtype DsdPlaneOffsetMeta

Defined in GI.GstAudio.Structs.DsdPlaneOffsetMeta

Methods

toManagedPtr :: DsdPlaneOffsetMeta -> ManagedPtr DsdPlaneOffsetMeta

tag ~ 'AttrSet => Constructible DsdPlaneOffsetMeta tag

Defined in GI.GstAudio.Structs.DsdPlaneOffsetMeta

Methods

new :: MonadIO m => (ManagedPtr DsdPlaneOffsetMeta -> DsdPlaneOffsetMeta) -> [AttrOp DsdPlaneOffsetMeta tag] -> m DsdPlaneOffsetMeta

newZeroDsdPlaneOffsetMeta :: MonadIO m => m DsdPlaneOffsetMeta

Construct a DsdPlaneOffsetMeta struct initialized to zero.

Methods

getInfo

dsdPlaneOffsetMetaGetInfo :: (HasCallStack, MonadIO m) => m MetaInfo

No description available in the introspection data.

Properties

meta

parent Meta

getDsdPlaneOffsetMetaMeta :: MonadIO m => DsdPlaneOffsetMeta -> m Meta

Get the value of the “meta” field. When overloading is enabled, this is equivalent to

get dsdPlaneOffsetMeta #meta

numBytesPerChannel

the number of valid bytes per channel in the buffer

getDsdPlaneOffsetMetaNumBytesPerChannel :: MonadIO m => DsdPlaneOffsetMeta -> m CSize

Get the value of the “num_bytes_per_channel” field. When overloading is enabled, this is equivalent to

get dsdPlaneOffsetMeta #numBytesPerChannel

setDsdPlaneOffsetMetaNumBytesPerChannel :: MonadIO m => DsdPlaneOffsetMeta -> CSize -> m ()

Set the value of the “num_bytes_per_channel” field. When overloading is enabled, this is equivalent to

set dsdPlaneOffsetMeta [ #numBytesPerChannel := value ]

numChannels

number of channels in the DSD data

getDsdPlaneOffsetMetaNumChannels :: MonadIO m => DsdPlaneOffsetMeta -> m Int32

Get the value of the “num_channels” field. When overloading is enabled, this is equivalent to

get dsdPlaneOffsetMeta #numChannels

setDsdPlaneOffsetMetaNumChannels :: MonadIO m => DsdPlaneOffsetMeta -> Int32 -> m ()

Set the value of the “num_channels” field. When overloading is enabled, this is equivalent to

set dsdPlaneOffsetMeta [ #numChannels := value ]

offsets

the offsets (in bytes) where each channel plane starts in the buffer

getDsdPlaneOffsetMetaOffsets :: MonadIO m => DsdPlaneOffsetMeta -> m CSize

Get the value of the “offsets” field. When overloading is enabled, this is equivalent to

get dsdPlaneOffsetMeta #offsets

setDsdPlaneOffsetMetaOffsets :: MonadIO m => DsdPlaneOffsetMeta -> CSize -> m ()

Set the value of the “offsets” field. When overloading is enabled, this is equivalent to

set dsdPlaneOffsetMeta [ #offsets := value ]