nn::snd::CTR Namespace

Description

Sound (SND) namespace.
(This can also be written with "CTR" omitted.）

Classes

nn::snd::CTR::Bcwav Definition of a class that handles BCWAV files.
nn::snd::CTR::Voice A class used to control Voice objects.

Structures

nn::snd::CTR::AdpcmParam A structure that stores ADPCM coefficients.
nn::snd::CTR::AdpcmContext A structure that stores an ADPCM context.
nn::snd::CTR::MonoFilterCoefficients Structure that stores one-pole filter coefficients.
nn::snd::CTR::BiquadFilterCoefficients Structure that stores biquad filter coefficients.
nn::snd::CTR::MixParam A structure that stores the gain for each channel.
nn::snd::CTR::WaveBuffer Structure that stores information about a buffer storing sample data.
nn::snd::CTR::AuxBusData Typedef for functions containing the code that processes Aux bus data in each sound frame.

Enumerated Types

ChannelIndex An enumerated type representing channel positions.
OutputMode Enumerated type representing a mixer's output mode.
ClippingMode Enumerated type that represents the clipping mode.
SurroundSpeakerPosition Enumerated type indicating the virtual speaker position for 3D surround sound.
InterpolationType An enumerated type representing the interpolation method.
FilterType Enumerated type representing the filter type.
AuxBusId The enumerated type representing the Aux bus ID.
SampleFormat An enumerated type representing sample formats.

typedef Definitions

AuxCallback Typedef for the Aux callback function pointer.
VoiceDropCallbackFunc Typedef for the callback function to invoke when the library frees a voice.

Constants

S VOICE_PRIORITY_NODROP This is the highest possible priority and is also given special treatment.
S NN_SND_DSP_MAXIMUM_CYCLES Maximum number of DSP cycles per sound frame.

Functions

Initialize/Finalize
Initialize Initializes the sound library.
Finalize Finalizes the sound library.
InitializeWaveBuffer Initializes a buffer information structure.
Cache Operations
FlushDataCache Writes data for the specified cache range back into memory and invalidates the cache.
InvalidateDataCache Invalidates the specified cache range.
Synchronous Processing
WaitForDspSync Receives the result of DSP processing.
SendParameterToDsp Applies the configured parameters to the DSP.
3D Surround Sound
SetSoundOutputMode Sets the sound output mode.
GetSoundOutputMode Gets the sound output mode.
SetClippingMode Sets the clipping mode.
GetClippingMode Gets the clipping mode.
SetSurroundDepth Sets the surround sound depth.
SetSurroundSpeakerPosition Sets the virtual speaker position for 3D surround sound.
Dropped Processing Detection
GetDroppedSoundFrameCount Gets the number of dropped sound frames.
ClearDroppedSoundFrameCount Initializes the number of dropped sound frames.
DSP-ADPCM-Related
EncodeAdpcmData Encodes 16-bit PCM data into DSP-ADPCM format.
DecodeAdpcmData Decodes DSP-ADPCM data.
GetAdpcmOutputBufferSize Returns the size of the output buffer that is required during encoding.
ConvertAdpcmPos2Nib Converts the sample position to a number of nibbles.
ConvertAdpcmNib2Pos Converts the number of nibbles to a sample position.
Other
GetSampleLength Gets the sample length.
SetMasterVolume This function sets the master volume.
SetAuxReturnVolume Sets the Aux bus volume.
SetAuxReturnVolume Gets the Aux bus volume.
RegisterAuxCallback Sets the Aux bus callback function.
GetAuxCallback Gets the Aux bus callback function.
ClearAuxCallback Clears the Aux bus callback function.
SetAuxFrontBypass Configures whether to bypass the front channels of an Aux bus.
GetMixedBusData Copies the Mix bus data to the specified buffer.
SetMaximumDspCycles Sets the number of DSP cycles that sound can use.
GetMaximumDspCycles Gets the number of DSP cycles allocated to sound.
GetDspCycles Gets the number of cycles consumed by the DSP to create the last audio frame.
GetHeadphoneStatus Gets whether headphones are plugged in.
UpdateHeadphoneStatus Updates and gets the headphone state (whether they are inserted or not).
AllocVoice Gets a voice.
FreeVoice Frees a voice.

Revision History

2010/02/09
Initial version.

CONFIDENTIAL