# 12. Glossary

## 12.1 2D vs 3D

A 3D sound source is a Channel that has a position and a velocity in space. When a 3D Channel is playing, its volume, speaker placement and pitch will be affected automatically based on the relation to the listener.

A listener is typically the location of the player or the game camera. It has a position and velocity like a sound source, but it also has an orientation.

3D Sound behaviour:

- Volume is affected by the relative distance of the listener and the source.
- Pitch is affected by the relative velocity of the listener and the source (This causes the doppler effect).
- Pan is affected by the relative orientation of the listener to the position of the source.

2D Sound behaviour:

- 3D listener and source positions, velocities and orientations are ignored and have no effect.
- 2D specific funcionality such as ChannelControl::setMixLevelsOutput, ChannelControl::setMixMatrix and ChannelControl::setPan will allow manual panning of audio.

Note: You can blend between a 3D mix and a 2D mix with ChannelControl::set3DLevel.

For a more detailed description of 3D sound behaviour, read the tutorial on the topic.

## 12.2 Audio channel

An audio channel is a monoaural signal generally associated with a particular speaker. For example, a stereo signal contains two channels, left and right. This is unrelated to the FMOD Channel class.

## 12.3 Automatic Parameter

An automatic parameter (also known in FMOD Studio as a built-in parameter) is any parameter whose value is automatically set based on the event instance's 3D attributes whenever the FMOD Studio system is updated.

Types of automatic parameter include:

- FMOD_STUDIO_PARAMETER_AUTOMATIC_DISTANCE
- FMOD_STUDIO_PARAMETER_AUTOMATIC_EVENT_CONE_ANGLE
- FMOD_STUDIO_PARAMETER_AUTOMATIC_EVENT_ORIENTATION
- FMOD_STUDIO_PARAMETER_AUTOMATIC_DIRECTION
- FMOD_STUDIO_PARAMETER_AUTOMATIC_ELEVATION
- FMOD_STUDIO_PARAMETER_AUTOMATIC_LISTENER_ORIENTATION
- FMOD_STUDIO_PARAMETER_AUTOMATIC_SPEED
- FMOD_STUDIO_PARAMETER_AUTOMATIC_SPEED_ABSOLUTE

For more information about these parameter types, see the FMOD_STUDIO_PARAMETER_TYPE section of the Studio API Reference chapter.

## 12.4 Callback Behavior

Only one callback is stored for each System/Studio::System/Studio::EventInstance/ChannelControl/DSP. Therefore, any registered callback should handle all required callback types and indicate those types via the callback type mask.

All calls to callbacks are issued per type. This means that if, for example, you use System::setCallback with FMOD_SYSTEM_CALLBACK_ALL, when the callback is called, only one type will be passed for the `type` argument. Multiple types will not be combined for a single call.

C/C++ behavior. Casting your own function type to an FMOD callback could cause a crash or corruption. For callback declaration always use the F_CALLBACK between the return type and the function name, and use the correct C types for all callback parameters.

## 12.5 Channel Group

A Channel Group allows attributes to be set on a group of Channels collectively. A Channel group also allows you to operate on a the final mixed signal of the output of its Channels and child Channel Groups. This is known as a 'sub mix'.

A Channel Group can be created with System::createChannelGroup which returns a ChannelGroup object.

The sub mix buffer can be processed with DSP effects (see ChannelControl::addDSP), saving CPU time compared to applying the same effect to multiple Channels individually.

The signal processing of a Channel Group will persist even when a Channel has stopped.

Note that a Channel Group can contain many children Channel Groups, but can only have one parent Channel Group. See ChannelGroup::addGroup and ChannelGroup::getParentGroup.

## 12.6 Channel

A Channel is a playing instance of a Sound. This is unrelated to an audio channel.

After loading or creating a Sound, it is playable via the System::playSound command which returns a Channel object for run-time manipulation of its properties.

FMOD automatically selects a Channel for the sound to play on, you do not have to manage your own Channels.

Set the maximum number of Channels playable with System::init. For more information on Channels and how they can be real or virtual, go to the Virtual Voices white paper.

## 12.7 Compressed Sample

Parent topic : Sound

Compressed Samples are suited for small sounds that need to be played more than once at a time, for example sound effects.

Only certain file formats are supported with this type of sound. File formats such as .MP2, .MP3, and .FSB (using FADPCM, Vorbis, AT9 and XMA codecs).
This type of sound is stored in memory in its native compressed format, and decodes in real-time while playing.

Use FMOD_CREATECOMPRESSEDSAMPLE to create a Sound object in this mode.

Compressed Sample attributes | Comparison
--- | ---
Keeps sound compressed into memory. | Can use less memory than a sample, large sounds can use more than a stream.
Higher CPU overhead during playback. | Uses more CPU than a sample, slightly less than a stream.
Fast to load. | Faster than a sample, possibly slower than a stream with very large sounds.
Can play more than 1 at a time. | Better polyphony than a stream.

Note: Compressed samples have a context allocated for each instance of playback. This requires a fixed start up memory overhead. See FMOD_ADVANCEDSETTINGS to control codec maximums.

## 12.8 Documentation Conventions

### 12.8.1 Parameter Tokens

Token | Meaning
--- | ---
Out | The API function will fill in information in this parameter.
Opt | This parameter is optional, specify null or zero to ignore.
R/O | This token applies to members of various structures which FMOD passes to user callbacks. User callbacks must not modify the values of these members. Modifying the values of these members will cause undefined behavior.
C# | This is only available in C#.
JS | This is only available in Javascript.

## 12.9 Distance Units

The unit of measurement for distances for 3D calculations. By default 1 disance unit is equivalent to 1 meter. To use your game's distance units specify the scale of your game's distance units to meters using System::set3DSettings.

## 12.10 Down Mixing

When the source signal channel count is higher than the destination, it will distribute its higher channel information into the lower speaker mode's channels.
This example is a table of the speakers in a stereo output with the input speakers of a 7.1 signal. Values in table represent attenuation. 0dB = full volume, - = silence.

Output speaker | Front left in | Front right in | Center in | LFE in | Surround left in | Surround right in | Back left in | Back right in
--- | --- | --- | --- | --- | --- | --- | --- | ---
Left | 0dB | - | -3dB | - | -3dB | - | -6dB | -
Right | - | 0dB | -3dB | - | - | -3dB | - | -6dB

Example of a higher 7.1 speaker mode signal being down mixed to a stereo output. When more than one input channel contributes to the output speaker, the inputs are summed/mixed together.

## 12.11 DSP Chain

A DSP chain is a collection of DSP units that connect together in a linear fashion. Each Channel and ChannelGroup contain a DSP chain.

A DSP is capable of multiple inputs, but in a DSP chain each DSP is connected to the next with one input, all the way from the head to the tail. See FMOD_CHANNELCONTROL_DSP_INDEX for special named offsets for 'head' and 'tail' and 'fader' units.

A typical Channel represented above with a 'head' (of type FMOD_DSP_TYPE_FADER to allow volume control and panning), which is fed by an echo effect (of type FMOD_DSP_TYPE_ECHO) which is in turn fed by a PCM wavetable unit (of type that is internal to FMOD).
The signal feeds from right to left to the DSP chain's head, before continuing to the next connected DSP (not pictured).

## 12.12 DSP

DSP stands for "Digital Signal Processing", and usually relates to processing raw PCM samples to alter the sound.

FMOD provides a suite of DSP effects that can alter the sound in interesting ways to simulate real life or exaggerate a sound.
Examples of this are echo, reverb, lowpass filtering, flange and chorus.

Effects can easily be added to an FMOD Channel, or a sub mix, or ChannelGroup with the ChannelControl::addDSP function.

You also have the option of writing your own effects with System::createDSP. See the DSP Architecture and Usage tutorial for more.

## 12.13 Handedness

Handedness is an innate property of 3D cartesian coordinate systems. The handedness of the coordinate system specifies the direction of the Z axis along the line perpendicular to the X and Y axes, and the direction of positive rotations.

For 3D spatialization to behave intuitively it is important that FMOD is configured to use the same orientation as your game's coordinate system.

By default FMOD uses a left-handed coordinate system. The positive Y axis points up, the positive X axis points to the right, and the positive Z axis points away from the listener. Positive rotations are clockwise around the axis of rotation when viewed so that the axis points towards the listener.

FMOD may also be configured to use a right-handed coordinate system by passing FMOD_INIT_3D_RIGHTHANDED to System::init. When configured for a right-handed coordinate system the positive Y axis points up, the positive X axis points to the right, and the positive Z axis points towards the listener. Positive rotations are counter-clockwise around the axis of rotation when viewed so that the axis points towards the listener.

## 12.14 Reading Sound Data

The following shows how to read sound data to a buffer using Sound::readData.

C
C++
C#
JS

    FMOD::Sound *sound;
    unsigned int length;
    char *buffer;

    system->createSound("drumloop.wav", FMOD_DEFAULT | FMOD_OPENONLY, nullptr, &sound);
    sound->getLength(&length, FMOD_TIMEUNIT_RAWBYTES);

    buffer = new char[length];
    sound->readData(buffer, length, nullptr);

    delete[] buffer;

    FMOD_SOUND *sound;
    unsigned int length;
    char *buffer;

    FMOD_System_CreateSound(system, "drumloop.wav", FMOD_DEFAULT | FMOD_OPENONLY, 0, &sound);
    FMOD_Sound_GetLength(sound, &length, FMOD_TIMEUNIT_RAWBYTES);

    buffer = (char *)malloc(length);
    FMOD_Sound_ReadData(sound, (void *)buffer, length, 0);

    free(buffer);

    FMOD.Sound sound;
    uint length;
    byte[] buffer;

    system.createSound("drumloop.wav", FMOD.MODE.DEFAULT | FMOD.MODE.OPENONLY, out sound);
    sound.getLength(out length, FMOD.TIMEUNIT.RAWBYTES);

    buffer = new byte[(int)length];
    sound.readData(buffer);

    var sound = {};
    var length = {};
    var buffer = {};

    system.createSound("drumloop.wav", FMOD.DEFAULT | FMOD.OPENONLY, null, sound);
    sound = sound.val;

    sound.getLength(length, FMOD.TIMEUNIT_RAWBYTES);
    length = length.val;

    sound.readData(buffer, length, null);
    buffer = buffer.val;

See Also: FMOD_TIMEUNIT, FMOD_MODE, Sound::getLength, System::createSound

## 12.15 Sample Data

Sample data is raw (PCM) or a compressed audio signal, stored as a sound. Multi-channel PCM sample data (stereo and above) is interleaved, so a 5.1 signal for example has 6 values stored together per sample.

### 12.15.1 Endianness

When accessing raw data in a sound, it will be in the native endianness of the platform. See Sound::lock, Sound::unlock.
When a sound file is loaded, FMOD will convert the endian to match the native endian of the platform.

### 12.15.2 Sample Formats

Sample data can come in a variety of PCM bit depths (8,16,24,32) and types (integer, float), or as a compressed bitstream. See FMOD_SOUND_FORMAT.

### 12.15.3 Samples vs Bytes vs Milliseconds

Within FMOD functions you will see references to PCM samples, bytes and milliseconds.

To understand what the difference is a diagram has been provided to show how raw PCM sample data is stored in FMOD buffers.

In this diagram you will see that a stereo sound has its left/right data interleaved one after the other.
A left/right pair (a sound with 2 channels) is called a sample.
Because this is made up of 16bit data, 1 sample = 4 bytes.
If the sample rate, or playback rate is 44.1khz, or 44100 samples per second, then 1 sample is 1/44100th of a second, or 1/44th of a millisecond. Therefore 44100 samples = 1 second or 1000ms worth of data.
To convert between the different terminologies, the following formulas can be used:

- ms = samples * 1000 / samplerate.
- samples = ms * samplerate / 1000.
- samplerate = samples * 1000 / ms.
- bytes = samples * bits * channels / 8.
- samples = bytes * 8 / bits / channels.

Some functions like Sound::getLength provide the length in milliseconds, bytes and samples to avoid needing to do these calculations.

## 12.16 Sample

Parent topic : Sound

Samples (also referred to as 'decompress into memory' type sounds), are suited for small sounds that need to be played more than once at a time, for example sound effects.

Use FMOD_CREATESAMPLE to create a Sound object in this mode.

Sample attributes | Comparison
--- | ---
Decompresses whole sound into memory. | Can use more memory than a compressed sample or stream.
Low CPU overhead during playback. | Uses less CPU than a compressed sample or stream.
Slower to load. | Can take longer to load on large sounds than a compressed sample or stream.
Can play more than 1 at a time. | Better polyphony than a stream.

Mobile Developers: A common use for this format is to store files compressed on disk (for faster download speed), then decompress into memory at load time, for lower cpu overhead at run-time.

## 12.17 Sound

A sound is an instance of sample data which can be loaded from media, or created from memory.

When a sound is loaded, it is either decompressed as a static sample into memory as PCM (sample), loaded into memory in its native format and decompressed at runtime (compressed sample), or streamed and decoded in realtime (in chunks) from an external media such as a disk or internet (stream).

For more detail see:

- Sample
- Stream
- Compressed Sample

A sound can be created with System::createSound or System::createStream which returns a Sound object. A Sound object can be played with System::playSound.

## 12.18 Stream

Parent topic : Sound

A stream is good for a sound that is too large to fit into memory. A stream reads from disk or other media like the internet as it plays.

Typically suited to larger sounds like music, long ambiences, or voice.

Use FMOD_CREATESTREAM to create a Sound object in this mode.

'Stream' attributes | Comparison
--- | ---
Uses a small buffer in memory. | Uses less memory than a sample or compressed sample on large sounds.
Higher CPU overhead during playback. | Uses more CPU than sample, slightly more than a compressed sample due to simultaneous reading from medium.
Fast to load. | Faster than a sample on large sounds, possibly faster than a compressed sample with very large sounds.
Can only be played once at a time. | Worse polyphony than a sample or compressed sample.

Note: A very small sound may use more memory than a sample or compressed sample when created as a stream, due to the stream file/decode buffer overhead being bigger than the size of the sound.

### 12.18.1 Streaming Issues

Bandwidth

Streaming audio from a medium should be kept to a limited number of instances, to avoid starvation of data leading to skipping / stuttering audio.

Increasing stream memory buffer sizes can help to mitigate this problem. See System::setStreamBufferSize and FMOD_ADVANCEDSETTINGS::defaultDecodeBufferSize.

Speed of commands using streams

System::createStream, Channel::setPosition and Sound::getSubSound when using a stream can take longer than an in memory sample, as they have to initialize internal buffers and flush them from disk.

Use FMOD_NONBLOCKING command to remove the cost from the main thread and put the overhead into a background thread.

Setting loop counts or points of a playing stream

Issues with looping streaming sounds may arise when changing the loop count or loop points of a playing stream.

Sounds created with System::createStream or FMOD_CREATESTREAM may have executed loop logic and buffered sample data before API calls to change their looping properties. If issues occur after changing loop properties you may need to call Channel::setPosition to force a flush of the stream buffer.

Note this will usually only happen if you have sounds or loop regions which are smaller than the stream decode buffer. See FMOD_CREATESOUNDEXINFO.

## 12.19 String Format

All FMOD Public APIs and structures use UTF-8 strings.

As C# uses UTF-16 strings by default, the FMOD C# api function parameters will automatically convert between UTF-16 and UTF-8 strings in any api using the C# "string" type or FMOD's "StringWrapper" type. However, any API that uses strings via an IntPtr will not automatically convert from UTF-16, and will instead expect a UTF-8 string to be used.

## 12.20 Studio GUIDs and Paths

Many functions in the FMOD Studio API allow you to identify an object within an FMOD Studio project by the object's globally unique identifier, or GUID. These API functions will accept the GUID in binary format (mostly useful when an object's GUID has been looked up programmatically by name), or as a string formatted as 32 digits separated by hyphens and enclosed in braces: `{00000000-0000-0000-0000-000000000000}`.

Many functions in the FMOD Studio API allow you to identify an object within an FMOD Studio project by the object's path. Objects can only be identified by path if the project's strings bank is loaded.

See the FMOD Studio Documentation for more information.

## 12.21 Studio Strings Bank

When building a master bank FMOD Studio will also write out a strings bank for the project. The strings bank contains a string table which the FMOD Studio API can use to resolve GUIDs from paths. FMOD Studio API functions which accept paths require the project's strings bank to be loaded in order to function correctly.

## 12.22 Studio Update Thread

A thread created by the FMOD Studio System to perform asynchronous processing of API commands and manage scheduling and playback logic for events. This thread is triggered from the Core Mixer thread at the period specified in the FMOD_STUDIO_ADVANCEDSETTINGS. If the Studio System is initialized with FMOD_STUDIO_INIT_SYNCHRONOUS_UPDATE then no Studio Update thread is created.

## 12.23 Sync Points

A sync point can be used to trigger a callback during playback. See FMOD_CHANNELCONTROL_CALLBACK_SYNCPOINT.
These points can be user generated via the API or can come from a .wav file with embedded markers.

Markers can be added to a wave file in a sound editor usually by clicking on a waveform or timeline and inserting a 'marker' or 'region'.

Any RIFF based format will support sync points.

Sync points can be manipulated with:

- Sound::addSyncPoint
- Sound::deleteSyncPoint
- Sound::getNumSyncPoints
- Sound::getSyncPoint
- Sound::getSyncPointInfo

## 12.24 Up Mixing

When the source signal channel count is lower than the destination, it will distribute its lower channel information into the higher speaker mode's channels.
This example is a table of the different source signal speaker modes, mapping to a 7.1 output. Values in table represent attenuation. 0dB = full volume, - = silence.

    Key: M = Mono, L = Left, R = Right, FL = Front Left, FR = Front Right, C = Center, LFE = Low Frequency Emitter, SL = Surround Left, SR = Surround Right, BL = Back Left, BR = Back Right

Output Speaker | Mono source | Stereo source | Quad source | 5.0 source | 5.1 source | 7.1 source
--- | --- | --- | --- | --- | --- | ---
Front left | M = -3dB | L = 0dB | FL = 0dB | FL = 0dB | FL = 0dB | FL = 0dB
Front right | M = -3dB | R = 0dB | FR = 0dB | FR = 0dB | FR = 0dB | FR = 0dB
Center | - | - | - | C = 0dB | C = 0dB | C = 0dB
LFE | - | - | - | - | LFE = 0dB | LFE = 0dB
Surround left | - | - | SL = 0dB | SL = 0dB | SL = 0dB | SL = 0dB
Surround right | - | - | SR = 0dB | SR = 0dB | SR = 0dB | SR = 0dB
Back left | - | - | - | - | - | BL = 0dB
Back right | - | - | - | - | - | BR = 0dB

Example of lower and equal speaker modes up mixing to a target speaker mode = 7.1

## 12.25 User Data

User data is arbitrary data that can be attached to various FMOD objects. User data is stored without a type, in the form of a `void *` in C/C++, `IntPtr` in C# or an object in javascript. User data can then be retrieved and cast back to the original type. The following shows how to set and get user data on a Sound, but can be likewise applied to any object with a `getUserData` or `setUserData` method.

C
C++
C#
JS

    {
        const char *userData = "Hello User Data!";
        void *pointer = (void *)userData;
        sound->setUserData(pointer);
    }
    {
        void *pointer;
        sound->getUserData(&pointer);
        const char *userData = (const char *)pointer;
    }

    {
        const char *userData = "Hello User Data!";
        void *pointer = (void *)userData;
        FMOD_Sound_SetUserData(object, pointer);
    }
    {
        void *pointer;
        FMOD_Sound_GetUserData(object, &pointer);
        const char *userData = (const char *)pointer;
    }

    {
        string userData = "Hello User Data!";
        GCHandle handle = GCHandle.Alloc(userData);
        IntPtr pointer = GCHandle.ToIntPtr(handle);
        sound.setUserData(pointer);
    }
    {
        IntPtr pointer;
        sound.getUserData(out pointer);
        GCHandle handle = GCHandle.FromIntPtr(pointer);
        string userData = handle.Target as string;
    }

    {
        var userData = "Hello User Data!";
        sound.setUserData(userData);
    }
    {
        var outval = {};
        sound.getUserData(outval);
        var userData = outval.val;
    }