Leviathan::SoundDevice Class Reference

Manages loading the audio library and provides some helpers. More...

#include <SoundDevice.h>

Public Member Functions
DLLEXPORT	SoundDevice ()
DLLEXPORT	~SoundDevice ()
DLLEXPORT bool	Init (bool simulatesound=false, bool noconsolelog=false)
DLLEXPORT void	Release ()
DLLEXPORT void	Tick (int PassedMs)
DLLEXPORT void	SetSoundListenerPosition (const Float3 &pos, const Float4 &orientation)
	Loads the file and plays the sound. More...
DLLEXPORT void	SetGlobalVolume (float vol)
DLLEXPORT void	Play2DSoundEffect (const std::string &filename)
	Plays a 2d sound without possibility of interrupting. More...
DLLEXPORT AudioSource::pointer	Play2DSound (const std::string &filename, bool looping, bool startpaused)
	Plays a 2d sound with options. More...
DLLEXPORT AudioSource::pointer	CreateProceduralSound (ProceduralSoundData::pointer data, const char *soundname)
	Opens an audio source from a procedural data stream. More...
DLLEXPORT void	BabysitAudio (AudioSource::pointer audio)
	This class holds the audio source until it has finished playing and then releases the reference. More...
DLLEXPORT cAudio::IAudioManager *	GetAudioManager ()

Static Public Member Functions
static DLLEXPORT std::vector< std::string >	GetAudioDevices (size_t *indexofdefault=nullptr)
	Returns a list of audio playback devices. More...

Detailed Description

Manages loading the audio library and provides some helpers.

Definition at line 20 of file SoundDevice.h.

Constructor & Destructor Documentation

SoundDevice()

SoundDevice::SoundDevice

(

)

Definition at line 20 of file SoundDevice.cpp.

{}

~SoundDevice()

SoundDevice::~SoundDevice

(

)

Definition at line 21 of file SoundDevice.cpp.

{
    Release();
}

Member Function Documentation

BabysitAudio()

DLLEXPORT void SoundDevice::BabysitAudio

(

AudioSource::pointer

audio

)

This class holds the audio source until it has finished playing and then releases the reference.

Definition at line 209 of file SoundDevice.cpp.

{
    Engine::Get()->AssertIfNotMainThread();

    HandledAudioSources.push_back(audio);
}

CreateProceduralSound()

DLLEXPORT AudioSource::pointer SoundDevice::CreateProceduralSound	(	ProceduralSoundData::pointer	data,
		const char *	soundname
	)

Opens an audio source from a procedural data stream.

Parameters

soundname

Name for this audio source. Should be at least somewhat unique

Definition at line 197 of file SoundDevice.cpp.

{
    if(!AudioManager || !data)
        return nullptr;

    return AudioSource::MakeShared<AudioSource>(
        AudioManager->createFromAudioDecoder(soundname, data->Properties.SourceName.c_str(),
            CAUDIO_NEW ProceduralSoundStream(data)),
        this);
}

GetAudioDevices()

DLLEXPORT std::vector< std::string > SoundDevice::GetAudioDevices ( size_t *  indexofdefault = nullptr )

static

Returns a list of audio playback devices.

Parameters

indexofdefault

Returns the index of the default device (if not null)

Definition at line 216 of file SoundDevice.cpp.

{
    std::vector<std::string> result;

    cAudio::IAudioDeviceList* devices = cAudio::createAudioDeviceList();

    if(!devices) {
        LOG_ERROR("SoundDevice: GetAudioDevices: failed to get audio device list");
        return {};
    }

    const auto deviceCount = devices->getDeviceCount();
    result.reserve(deviceCount);

    const auto defaultDeviceName = devices->getDefaultDeviceName();

    for(unsigned int i = 0; i < deviceCount; ++i) {

        const auto deviceName = devices->getDeviceName(i);

        if(deviceName.compare(defaultDeviceName) == 0 && indexofdefault) {

            *indexofdefault = i;
        }

        result.push_back(deviceName);
    }

    CAUDIO_DELETE devices;

    return result;
}

GetAudioManager()

DLLEXPORT cAudio::IAudioManager* Leviathan::SoundDevice::GetAudioManager ( )

inline

Definition at line 73 of file SoundDevice.h.

    {
        return AudioManager;
    }

Init()

bool SoundDevice::Init	(	bool	simulatesound = false,
		bool	noconsolelog = false
	)

Parameters

simulatenosound

If true the sound device isn't initialized to simulate not having a valid audio device (or if the user just doesn't want sound)

Definition at line 26 of file SoundDevice.cpp.

{
    AudioLogPath = StringOperations::RemoveExtension(Logger::Get()->GetLogFile(), false) +
                   "cAudioLog.html";

    AudioManager = cAudio::createAudioManager(
        // No default init, we want to select the device
        false,
        // And write to a program specific log file
        AudioLogPath.c_str(), noconsolelog);

    LEVIATHAN_ASSERT(AudioManager, "Failed to create cAudio manager");

    size_t defaultDevice = 0;
    const auto devices = GetAudioDevices(&defaultDevice);

    if(simulatesound == true) {

        LOG_WARNING("SoundDevice: simulating not having a playing device");
        return true;
    }

    if(devices.empty() || defaultDevice >= devices.size()) {

        LOG_ERROR("SoundDevice: no sound devices detected");
        return false;
    }

    if(std::find(devices.begin(), devices.end(), devices[defaultDevice]) == devices.end()) {
        // I have no clue how it would ever get here, but you never know
        LOG_ERROR("SoundDevice: Default device doesn't exist. The code should not have "
                  "been able to get here.");
    }

    LOG_INFO("Detected audio devices: ");

    for(const auto& dev : devices)
        LOG_INFO("> " + dev);

    LOG_INFO("End of devices");

    std::string selectedDevice;
    // There's no print error here if missing to make tests run
    ObjectFileProcessor::LoadValueFromNamedVars<std::string>(
        Engine::Get()->GetDefinition()->GetValues(), "AudioDevice", selectedDevice, "default");

    if(selectedDevice == "default") {

        selectedDevice = devices[defaultDevice];

    } else if(std::find(devices.begin(), devices.end(), selectedDevice) == devices.end()) {
        LOG_ERROR("SoundDevice: selected audio device \"" + selectedDevice +
                  "\" doesn't exists. Using default");
        selectedDevice = devices[defaultDevice];
    }

    LOG_INFO("SoundDevice: Initializing sound with device: " + selectedDevice);

    if(!AudioManager->initialize(selectedDevice.c_str())) {

        LOG_ERROR("SoundDevice: initializing failed");
        return false;
    }

    ListeningPosition = AudioManager->getListener();

    // setup global volume //
    SetGlobalVolume(1.f);

    ListeningPosition->setUpVector(cAudio::cVector3(0, 1, 0));

    return true;
}

Play2DSound()

DLLEXPORT AudioSource::pointer SoundDevice::Play2DSound	(	const std::string &	filename,
		bool	looping,
		bool	startpaused
	)

Plays a 2d sound with options.

Note

If both looping and startpaused are false then this is the same as Play2DSoundEffect and returns null

Returns

The audio source that is playing the sound (this must be held onto until it is done playing, can be passed to BabysitAudio if not manually wanted to be managed or use the SoundEffect variant of this method) is null if looping and startpaused are false

Definition at line 170 of file SoundDevice.cpp.

{
    if(!AudioManager)
        return nullptr;

    if(!looping && !startpaused)
        LOG_WARNING("SoundDevice: Play2DSound: called with same settings that "
                    "Play2DSoundEffect uses. looping or startpaused must be true to return an "
                    "AudioSource.");

    cAudio::IAudioSource* source =
        AudioManager->play2D(filename.c_str(), looping, startpaused);

    if(!source) {
        LOG_ERROR(
            "SoundDevice: Play2DSound: failed to create IAudioSource from file: " + filename);

        if(!boost::filesystem::is_regular(filename))
            LOG_INFO("SoundDevice: file '" + filename + "' doesn't exist");

        return nullptr;
    }

    return AudioSource::MakeShared<AudioSource>(source, this);
}

Play2DSoundEffect()

DLLEXPORT void SoundDevice::Play2DSoundEffect

(

const std::string &

filename

)

Plays a 2d sound without possibility of interrupting.

Definition at line 153 of file SoundDevice.cpp.

{
    if(!AudioManager)
        return;

    cAudio::IAudioSource* source = AudioManager->play2D(filename.c_str(), false, false);

    if(source) {

        LOG_ERROR("SoundDevice: Play2DSoundEffect: shouldn't return a source but it did. "
                  "Babysitting it");

        Engine::Get()->RunOnMainThread(
            [=]() { this->BabysitAudio(AudioSource::MakeShared<AudioSource>(source, this)); });
    }
}

Release()

void SoundDevice::Release

(

)

Definition at line 99 of file SoundDevice.cpp.

{
    HandledAudioSources.clear();

    if(AudioManager) {

        cAudio::destroyAudioManager(AudioManager);
        AudioManager = nullptr;
    }
}

SetGlobalVolume()

DLLEXPORT void SoundDevice::SetGlobalVolume

(

float

vol

)

Parameters

vol	The volume [0.f, 1.f]

Definition at line 143 of file SoundDevice.cpp.

{
    if(!AudioManager)
        return;

    vol = std::clamp(vol, 0.f, 1.f);

    AudioManager->setMasterVolume(vol);
}

SetSoundListenerPosition()

DLLEXPORT void SoundDevice::SetSoundListenerPosition	(	const Float3 &	pos,
		const Float4 &	orientation
	)

Loads the file and plays the sound.

This creates a temporary SoundEffect on a background thread that is loaded from the file and destroyed once it finishes

Returns

False if the file doesn't exist or the sound couldn't be played for some other reason

Definition at line 121 of file SoundDevice.cpp.

{
    // we need to create a vector from the angles //
    // Float3 vec = Float3(-sin(pitchyawroll.X*DEGREES_TO_RADIANS),
    //     sin(pitchyawroll.Y*DEGREES_TO_RADIANS), -cos(pitchyawroll.X*DEGREES_TO_RADIANS));

    if(!ListeningPosition)
        return;

    ListeningPosition->move(cAudio::cVector3(pos.X, pos.Y, pos.Z));

    Ogre::Quaternion quaternion(orientation);

    Ogre::Radian angle;
    Ogre::Vector3 direction;

    quaternion.ToAngleAxis(angle, direction);

    ListeningPosition->setDirection(cAudio::cVector3(direction.x, direction.y, direction.z));
}

Tick()

void SoundDevice::Tick

(

int

PassedMs

)

Definition at line 110 of file SoundDevice.cpp.

{
    for(auto iter = HandledAudioSources.begin(); iter != HandledAudioSources.end(); ++iter) {

        if(!(*iter)->Get()->isPlaying()) {

            iter = HandledAudioSources.erase(iter);
        }
    }
}

---

The documentation for this class was generated from the following files:

• SoundDevice.h
• SoundDevice.cpp