GI.GstAudio.Structs.AudioResampler

AudioResampler is a structure which holds the information required to perform various kinds of resampling filtering.

Exported types

newtype AudioResampler

Memory-managed wrapper type.

Constructors

AudioResampler (ManagedPtr AudioResampler)

Instances

Eq AudioResampler

Defined in GI.GstAudio.Structs.AudioResampler

Methods

(==) :: AudioResampler -> AudioResampler -> Bool

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

BoxedPtr AudioResampler

Defined in GI.GstAudio.Structs.AudioResampler

Methods

boxedPtrCopy :: AudioResampler -> IO AudioResampler

boxedPtrFree :: AudioResampler -> IO ()

ManagedPtrNewtype AudioResampler

Defined in GI.GstAudio.Structs.AudioResampler

Methods

toManagedPtr :: AudioResampler -> ManagedPtr AudioResampler

Methods

Overloaded methods

free

audioResamplerFree

Arguments

:: (HasCallStack, MonadIO m)

=> AudioResampler

resampler: a AudioResampler

-> m ()

Free a previously allocated AudioResampler resampler.

Since: 1.6

getInFrames

audioResamplerGetInFrames

Arguments

:: (HasCallStack, MonadIO m)

=> AudioResampler

resampler: a AudioResampler

-> Word64

outFrames: number of input frames

-> m Word64

Returns: The number of input frames needed for producing outFrames of data from resampler.

Get the number of input frames that would currently be needed to produce outFrames from resampler.

getMaxLatency

audioResamplerGetMaxLatency

Arguments

:: (HasCallStack, MonadIO m)

=> AudioResampler

resampler: a AudioResampler

-> m Word64

Returns: the latency of resampler as expressed in the number of frames.

Get the maximum number of input samples that the resampler would need before producing output.

getOutFrames

audioResamplerGetOutFrames

Arguments

:: (HasCallStack, MonadIO m)

=> AudioResampler

resampler: a AudioResampler

-> Word64

inFrames: number of input frames

-> m Word64

Returns: The number of frames that would be availabe after giving inFrames as input to resampler.

Get the number of output frames that would be currently available when inFrames are given to resampler.

new

audioResamplerNew

Arguments

:: (HasCallStack, MonadIO m)

=> AudioResamplerMethod

method: a AudioResamplerMethod

-> [AudioResamplerFlags]

flags: AudioResamplerFlags

-> AudioFormat

format: the AudioFormat

-> Int32

channels: the number of channels

-> Int32

inRate: input rate

-> Int32

outRate: output rate

-> Structure

options: extra options

-> m ()

Make a new resampler.

optionsSetQuality

audioResamplerOptionsSetQuality

Arguments

:: (HasCallStack, MonadIO m)

=> AudioResamplerMethod

method: a AudioResamplerMethod

-> Word32

quality: the quality

-> Int32

inRate: the input rate

-> Int32

outRate: the output rate

-> Structure

options: a Structure

-> m ()

Set the parameters for resampling from inRate to outRate using method for quality in options.

resample

audioResamplerResample

Arguments

:: (HasCallStack, MonadIO m)

=> AudioResampler

resampler: a AudioResampler

-> Ptr ()

in: input samples

-> Word64

inFrames: number of input frames

-> Ptr ()

out: output samples

-> Word64

outFrames: number of output frames

-> m ()

Perform resampling on inFrames frames in in and write outFrames to out.

In case the samples are interleaved, in and out must point to an array with a single element pointing to a block of interleaved samples.

If non-interleaved samples are used, in and out must point to an array with pointers to memory blocks, one for each channel.

in may be Nothing, in which case inFrames of silence samples are pushed into the resampler.

This function always produces outFrames of output and consumes inFrames of input. Use audioResamplerGetOutFrames and audioResamplerGetInFrames to make sure inFrames and outFrames are matching and in and out point to enough memory.

reset

audioResamplerReset

Arguments

:: (HasCallStack, MonadIO m)

=> AudioResampler

resampler: a AudioResampler

-> m ()

Reset resampler to the state it was when it was first created, discarding all sample history.

update

audioResamplerUpdate

Arguments

:: (HasCallStack, MonadIO m)

=> AudioResampler

resampler: a AudioResampler

-> Int32

inRate: new input rate

-> Int32

outRate: new output rate

-> Structure

options: new options or Nothing

-> m Bool

Returns: True if the new parameters could be set

Update the resampler parameters for resampler. This function should not be called concurrently with any other function on resampler.

When inRate or outRate is 0, its value is unchanged.

When options is Nothing, the previously configured options are reused.