SoundManager.h

Go to the documentation of this file.

#pragma once
#include "DLLInfo.h"
#include <NDEVR/SoftwareService.h>
#include <NDEVR/ApplicationOptions.h>
#include <NDEVR/Buffer.h>
#include <NDEVR/String.h>
#include <NDEVR/TranslatedString.h>
#ifdef PlaySound
    #undef PlaySound//somewhere in a windows include?
#endif
namespace NDEVR
{
    /**--------------------------------------------------------------------------------------------------
    \brief Contains the definition for a sound resource.
    **/
    struct Sound
    {
        TranslatedString title;
        String resource;
    };
    /**--------------------------------------------------------------------------------------------------
    \brief Allows the user to make a request for text-to-speech. If the speech cannot be produced, the
        backup sound is played.
    **/
    struct TextToSpeechRequest
    {
        String text_to_speech;
        String backup_sound;
    };
    /**--------------------------------------------------------------------------------------------------
    \brief Produces sound on the host Device, if possible. Can also create speech from given text.
    **/
    class SoundFactory : public SoftwareService
    {
    public:
        virtual bool textToSpeech(const TextToSpeechRequest& s) = 0;
        virtual bool supportsTextToSpeech() const = 0;
        virtual void enableTextToSpeech(bool enable) = 0;
        virtual Buffer<Sound> availableSounds() = 0;
        virtual bool playSound(const String& s) = 0;
        virtual bool textToSpeechEnabled() const = 0;
    };
    /**--------------------------------------------------------------------------------------------------
    \brief Handles iterating through sound factories until one is able to produce sound given the
        input sound resource.
    **/
    class NDEVR_WIDGETS_API SoundManager : public SoftwareServiceManager
    {
    public:
        static bool TextToSpeech(const TextToSpeechRequest& s);
        static bool SupportsTextToSpeech();
        static void EnableTextToSpeech(bool enable);
        static Buffer<Sound> AvailableSounds();
        static bool PlaySound(const String& s);
        static void AddSoundFactory(SoundFactory* factory);
        static ApplicationOption<bool> enable_sound;
        static ApplicationOption<bool> enable_text_to_speech;
        static ApplicationOption<bool> grab_volume_keys;
    protected:
        static Buffer<SoundFactory*> s_sound_factories;
    };
}