GI.GstAudio.Callbacks

Signals

AudioBaseSinkCustomSlavingCallback

type AudioBaseSinkCustomSlavingCallback

Arguments

 = AudioBaseSink

sink: a AudioBaseSink

-> Word64

etime: external clock time

-> Word64

itime: internal clock time

-> Int64

requestedSkew: skew amount requested by the callback

-> AudioBaseSinkDiscontReason

discontReason: reason for discontinuity (if any)

-> IO ()

This function is set with audioBaseSinkSetCustomSlavingCallback and is called during playback. It receives the current time of external and internal clocks, which the callback can then use to apply any custom slaving/synchronization schemes.

The external clock is the sink's element clock, the internal one is the internal audio clock. The internal audio clock's calibration is applied to the timestamps before they are passed to the callback. The difference between etime and itime is the skew; how much internal and external clock lie apart from each other. A skew of 0 means both clocks are perfectly in sync. itime > etime means the external clock is going slower, while itime < etime means it is going faster than the internal clock. etime and itime are always valid timestamps, except for when a discontinuity happens.

requested_skew is an output value the callback can write to. It informs the sink of whether or not it should move the playout pointer, and if so, by how much. This pointer is only NULL if a discontinuity occurs; otherwise, it is safe to write to *requested_skew. The default skew is 0.

The sink may experience discontinuities. If one happens, discont is TRUE, itime, etime are set to GST_CLOCK_TIME_NONE, and requested_skew is NULL. This makes it possible to reset custom clock slaving algorithms when a discontinuity happens.

Since: 1.6

type AudioBaseSinkCustomSlavingCallback_WithClosures

Arguments

 = AudioBaseSink

sink: a AudioBaseSink

-> Word64

etime: external clock time

-> Word64

itime: internal clock time

-> Int64

requestedSkew: skew amount requested by the callback

-> AudioBaseSinkDiscontReason

discontReason: reason for discontinuity (if any)

-> Ptr ()

userData: user data

-> IO ()

This function is set with audioBaseSinkSetCustomSlavingCallback and is called during playback. It receives the current time of external and internal clocks, which the callback can then use to apply any custom slaving/synchronization schemes.

The external clock is the sink's element clock, the internal one is the internal audio clock. The internal audio clock's calibration is applied to the timestamps before they are passed to the callback. The difference between etime and itime is the skew; how much internal and external clock lie apart from each other. A skew of 0 means both clocks are perfectly in sync. itime > etime means the external clock is going slower, while itime < etime means it is going faster than the internal clock. etime and itime are always valid timestamps, except for when a discontinuity happens.

requested_skew is an output value the callback can write to. It informs the sink of whether or not it should move the playout pointer, and if so, by how much. This pointer is only NULL if a discontinuity occurs; otherwise, it is safe to write to *requested_skew. The default skew is 0.

The sink may experience discontinuities. If one happens, discont is TRUE, itime, etime are set to GST_CLOCK_TIME_NONE, and requested_skew is NULL. This makes it possible to reset custom clock slaving algorithms when a discontinuity happens.

Since: 1.6

type C_AudioBaseSinkCustomSlavingCallback = Ptr AudioBaseSink -> Word64 -> Word64 -> Int64 -> CUInt -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

drop_closures_AudioBaseSinkCustomSlavingCallback :: AudioBaseSinkCustomSlavingCallback -> AudioBaseSinkCustomSlavingCallback_WithClosures

A simple wrapper that ignores the closure arguments.

dynamic_AudioBaseSinkCustomSlavingCallback

Arguments

:: (HasCallStack, MonadIO m, IsAudioBaseSink a)

=> FunPtr C_AudioBaseSinkCustomSlavingCallback

-> a

sink: a AudioBaseSink

-> Word64

etime: external clock time

-> Word64

itime: internal clock time

-> Int64

requestedSkew: skew amount requested by the callback

-> AudioBaseSinkDiscontReason

discontReason: reason for discontinuity (if any)

-> Ptr ()

userData: user data

-> m ()

Given a pointer to a foreign C function, wrap it into a function callable from Haskell.

genClosure_AudioBaseSinkCustomSlavingCallback :: MonadIO m => AudioBaseSinkCustomSlavingCallback -> m (GClosure C_AudioBaseSinkCustomSlavingCallback)

Wrap the callback into a GClosure.

mk_AudioBaseSinkCustomSlavingCallback :: C_AudioBaseSinkCustomSlavingCallback -> IO (FunPtr C_AudioBaseSinkCustomSlavingCallback)

Generate a function pointer callable from C code, from a C_AudioBaseSinkCustomSlavingCallback.

noAudioBaseSinkCustomSlavingCallback :: Maybe AudioBaseSinkCustomSlavingCallback

A convenience synonym for Nothing :: Maybe AudioBaseSinkCustomSlavingCallback.

noAudioBaseSinkCustomSlavingCallback_WithClosures :: Maybe AudioBaseSinkCustomSlavingCallback_WithClosures

A convenience synonym for Nothing :: Maybe AudioBaseSinkCustomSlavingCallback_WithClosures.

wrap_AudioBaseSinkCustomSlavingCallback :: Maybe (Ptr (FunPtr C_AudioBaseSinkCustomSlavingCallback)) -> AudioBaseSinkCustomSlavingCallback_WithClosures -> C_AudioBaseSinkCustomSlavingCallback

Wrap a AudioBaseSinkCustomSlavingCallback into a C_AudioBaseSinkCustomSlavingCallback.

AudioClockGetTimeFunc

type AudioClockGetTimeFunc

Arguments

 = Clock

clock: the AudioClock

-> IO Word64

Returns: the current time or CLOCK_TIME_NONE if the previous time should be used.

This function will be called whenever the current clock time needs to be calculated. If this function returns CLOCK_TIME_NONE, the last reported time will be returned by the clock.

type AudioClockGetTimeFunc_WithClosures

Arguments

 = Clock

clock: the AudioClock

-> Ptr ()

userData: user data

-> IO Word64

Returns: the current time or CLOCK_TIME_NONE if the previous time should be used.

This function will be called whenever the current clock time needs to be calculated. If this function returns CLOCK_TIME_NONE, the last reported time will be returned by the clock.

type C_AudioClockGetTimeFunc = Ptr Clock -> Ptr () -> IO Word64

Type for the callback on the (unwrapped) C side.

drop_closures_AudioClockGetTimeFunc :: AudioClockGetTimeFunc -> AudioClockGetTimeFunc_WithClosures

A simple wrapper that ignores the closure arguments.

dynamic_AudioClockGetTimeFunc

Arguments

:: (HasCallStack, MonadIO m, IsClock a)

=> FunPtr C_AudioClockGetTimeFunc

-> a

clock: the AudioClock

-> Ptr ()

userData: user data

-> m Word64

Returns: the current time or CLOCK_TIME_NONE if the previous time should be used.

Given a pointer to a foreign C function, wrap it into a function callable from Haskell.

genClosure_AudioClockGetTimeFunc :: MonadIO m => AudioClockGetTimeFunc -> m (GClosure C_AudioClockGetTimeFunc)

Wrap the callback into a GClosure.

mk_AudioClockGetTimeFunc :: C_AudioClockGetTimeFunc -> IO (FunPtr C_AudioClockGetTimeFunc)

Generate a function pointer callable from C code, from a C_AudioClockGetTimeFunc.

noAudioClockGetTimeFunc :: Maybe AudioClockGetTimeFunc

A convenience synonym for Nothing :: Maybe AudioClockGetTimeFunc.

noAudioClockGetTimeFunc_WithClosures :: Maybe AudioClockGetTimeFunc_WithClosures

A convenience synonym for Nothing :: Maybe AudioClockGetTimeFunc_WithClosures.

wrap_AudioClockGetTimeFunc :: Maybe (Ptr (FunPtr C_AudioClockGetTimeFunc)) -> AudioClockGetTimeFunc_WithClosures -> C_AudioClockGetTimeFunc

Wrap a AudioClockGetTimeFunc into a C_AudioClockGetTimeFunc.

AudioFormatPack

type AudioFormatPack

Arguments

 = AudioFormatInfo

info: a AudioFormatInfo

-> [AudioPackFlags]

flags: AudioPackFlags

-> Ptr Word8

src: a source array

-> Ptr Word8

data: pointer to the destination data

-> Int32

length: the amount of samples to pack.

-> IO ()

Packs length samples from src to the data array in format info. The samples from source have each channel interleaved and will be packed into data.

type C_AudioFormatPack = Ptr AudioFormatInfo -> CUInt -> Ptr Word8 -> Ptr Word8 -> Int32 -> IO ()

Type for the callback on the (unwrapped) C side.

dynamic_AudioFormatPack

Arguments

:: (HasCallStack, MonadIO m)

=> FunPtr C_AudioFormatPack

-> AudioFormatInfo

info: a AudioFormatInfo

-> [AudioPackFlags]

flags: AudioPackFlags

-> Ptr Word8

src: a source array

-> Ptr Word8

data: pointer to the destination data

-> Int32

length: the amount of samples to pack.

-> m ()

Given a pointer to a foreign C function, wrap it into a function callable from Haskell.

genClosure_AudioFormatPack :: MonadIO m => AudioFormatPack -> m (GClosure C_AudioFormatPack)

Wrap the callback into a GClosure.

mk_AudioFormatPack :: C_AudioFormatPack -> IO (FunPtr C_AudioFormatPack)

Generate a function pointer callable from C code, from a C_AudioFormatPack.

noAudioFormatPack :: Maybe AudioFormatPack

A convenience synonym for Nothing :: Maybe AudioFormatPack.

wrap_AudioFormatPack :: Maybe (Ptr (FunPtr C_AudioFormatPack)) -> AudioFormatPack -> C_AudioFormatPack

Wrap a AudioFormatPack into a C_AudioFormatPack.

AudioFormatUnpack

type AudioFormatUnpack

Arguments

 = AudioFormatInfo

info: a AudioFormatInfo

-> [AudioPackFlags]

flags: AudioPackFlags

-> Ptr Word8

dest: a destination array

-> Ptr Word8

data: pointer to the audio data

-> Int32

length: the amount of samples to unpack.

-> IO ()

Unpacks length samples from the given data of format info. The samples will be unpacked into dest which each channel interleaved. dest should at least be big enough to hold length * channels * size(unpack_format) bytes.

type C_AudioFormatUnpack = Ptr AudioFormatInfo -> CUInt -> Ptr Word8 -> Ptr Word8 -> Int32 -> IO ()

Type for the callback on the (unwrapped) C side.

dynamic_AudioFormatUnpack

Arguments

:: (HasCallStack, MonadIO m)

=> FunPtr C_AudioFormatUnpack

-> AudioFormatInfo

info: a AudioFormatInfo

-> [AudioPackFlags]

flags: AudioPackFlags

-> Ptr Word8

dest: a destination array

-> Ptr Word8

data: pointer to the audio data

-> Int32

length: the amount of samples to unpack.

-> m ()

Given a pointer to a foreign C function, wrap it into a function callable from Haskell.

genClosure_AudioFormatUnpack :: MonadIO m => AudioFormatUnpack -> m (GClosure C_AudioFormatUnpack)

Wrap the callback into a GClosure.

mk_AudioFormatUnpack :: C_AudioFormatUnpack -> IO (FunPtr C_AudioFormatUnpack)

Generate a function pointer callable from C code, from a C_AudioFormatUnpack.

noAudioFormatUnpack :: Maybe AudioFormatUnpack

A convenience synonym for Nothing :: Maybe AudioFormatUnpack.

wrap_AudioFormatUnpack :: Maybe (Ptr (FunPtr C_AudioFormatUnpack)) -> AudioFormatUnpack -> C_AudioFormatUnpack

Wrap a AudioFormatUnpack into a C_AudioFormatUnpack.

AudioRingBufferCallback

type AudioRingBufferCallback

Arguments

 = AudioRingBuffer

rbuf: a AudioRingBuffer

-> ByteString

data: target to fill

-> IO ()

This function is set with gst_audio_ring_buffer_set_callback() and is called to fill the memory at data with len bytes of samples.

type AudioRingBufferCallback_WithClosures

Arguments

 = AudioRingBuffer

rbuf: a AudioRingBuffer

-> ByteString

data: target to fill

-> Ptr ()

userData: user data

-> IO ()

This function is set with gst_audio_ring_buffer_set_callback() and is called to fill the memory at data with len bytes of samples.

type C_AudioRingBufferCallback = Ptr AudioRingBuffer -> Ptr Word8 -> Word32 -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

drop_closures_AudioRingBufferCallback :: AudioRingBufferCallback -> AudioRingBufferCallback_WithClosures

A simple wrapper that ignores the closure arguments.

dynamic_AudioRingBufferCallback

Arguments

:: (HasCallStack, MonadIO m, IsAudioRingBuffer a)

=> FunPtr C_AudioRingBufferCallback

-> a

rbuf: a AudioRingBuffer

-> ByteString

data: target to fill

-> Ptr ()

userData: user data

-> m ()

Given a pointer to a foreign C function, wrap it into a function callable from Haskell.

genClosure_AudioRingBufferCallback :: MonadIO m => AudioRingBufferCallback -> m (GClosure C_AudioRingBufferCallback)

Wrap the callback into a GClosure.

mk_AudioRingBufferCallback :: C_AudioRingBufferCallback -> IO (FunPtr C_AudioRingBufferCallback)

Generate a function pointer callable from C code, from a C_AudioRingBufferCallback.

noAudioRingBufferCallback :: Maybe AudioRingBufferCallback

A convenience synonym for Nothing :: Maybe AudioRingBufferCallback.

noAudioRingBufferCallback_WithClosures :: Maybe AudioRingBufferCallback_WithClosures

A convenience synonym for Nothing :: Maybe AudioRingBufferCallback_WithClosures.

wrap_AudioRingBufferCallback :: Maybe (Ptr (FunPtr C_AudioRingBufferCallback)) -> AudioRingBufferCallback_WithClosures -> C_AudioRingBufferCallback

Wrap a AudioRingBufferCallback into a C_AudioRingBufferCallback.