Audio.hpp

Go to the documentation of this file.

// REDESIGN: Rename all changeXXX() member functions to setXXX().
// REDESIGN: Don't require window argument, is this possible?

#ifndef GOSU_AUDIO_HPP
#define GOSU_AUDIO_HPP

#ifdef WIN32
#include <windows.h>
#endif
#include <Gosu/Fwd.hpp>
#include <Gosu/Platform.hpp>
#include <boost/scoped_ptr.hpp>
#include <boost/utility.hpp>
#include <string>

namespace Gosu
{
    class Audio : boost::noncopyable
    {
    public:
#ifdef GOSU_IS_WIN
        explicit Audio(HWND window);
#else
        Audio();
#endif
        ~Audio();
    };

    class SampleInstance
    {
        int handle, extra;
        
    public:
        SampleInstance(int handle, int extra);

        bool playing() const;
        void stop();

        void changeVolume(double volume);
        void changePan(double pan);
        void changeSpeed(double speed);
    };

    class Sample
    {
        struct SampleData;
        boost::scoped_ptr<SampleData> data;

    public:
        Sample(Audio& audio, const std::wstring& filename);
        
        Sample(Audio& audio, Reader reader);
        
        ~Sample();

        SampleInstance play(double volume = 1, double speed = 1) const;

        SampleInstance playPan(double pan, double volume = 1, double speed = 1) const;
    };

    class Song
    {
        class BaseData;
        class ModuleData;
        class StreamData;
        boost::scoped_ptr<BaseData> data;

    public:
        enum Type
        {
            stStream,
            stModule
        };

        Song(Audio&, const std::wstring& filename);
        
        Song(Audio&, Type type, Reader reader);
        
        ~Song();

        void play();
        void stop();
        bool playing() const;
        double volume() const;
        void changeVolume(double volume);
    };
}

#endif

---