OpenTTD Source  1.11.2
mixer.h File Reference

Go to the source code of this file.

Typedefs

typedef void(* MxStreamCallback) (int16 *buffer, size_t samples)
 Type of callback functions for supplying PCM music. More...
 

Functions

bool MxInitialize (uint rate)
 
void MxMixSamples (void *buffer, uint samples)
 
MixerChannelMxAllocateChannel ()
 
void MxSetChannelRawSrc (MixerChannel *mc, int8 *mem, size_t size, uint rate, bool is16bit)
 
void MxSetChannelVolume (MixerChannel *mc, uint volume, float pan)
 Set volume and pan parameters for a sound. More...
 
void MxActivateChannel (MixerChannel *)
 
uint32 MxSetMusicSource (MxStreamCallback music_callback)
 Set source of PCM music. More...
 

Detailed Description

Functions to mix sound samples.

Definition in file mixer.h.

Typedef Documentation

◆ MxStreamCallback

typedef void(* MxStreamCallback) (int16 *buffer, size_t samples)

Type of callback functions for supplying PCM music.

A music decoder/renderer implements this function and installs it with MxSetMusicSource, which also returns the sample rate used.

Parameters
bufferPointer to interleaved 2-channel signed 16 bit PCM data buffer, guaranteed to be 0-initialized.
samplesnumber of samples that must be filled into buffer.

Definition at line 21 of file mixer.h.

Function Documentation

◆ MxSetChannelVolume()

void MxSetChannelVolume ( MixerChannel mc,
uint  volume,
float  pan 
)

Set volume and pan parameters for a sound.

Parameters
mcMixerChannel to set
volumeVolume level for sound, range is 0..16384
panPan position for sound, range is 0..1

Definition at line 218 of file mixer.cpp.

◆ MxSetMusicSource()

uint32 MxSetMusicSource ( MxStreamCallback  music_callback)

Set source of PCM music.

Parameters
music_callbackFunction that will be called to fill sample buffers with music data.
Returns
Sample rate of mixer, which the buffers supplied to the callback must be rendered at.

Definition at line 237 of file mixer.cpp.

Referenced by MusicDriver_FluidSynth::Start(), and MusicDriver_FluidSynth::Stop().