Mixer.hh

/*
  libSDL2pp - C++ bindings/wrapper for SDL2
  Copyright (C) 2015-2016 Dmitry Marakasov <amdmi3@amdmi3.ru>
 
  This software is provided 'as-is', without any express or implied
  warranty.  In no event will the authors be held liable for any damages
  arising from the use of this software.
 
  Permission is granted to anyone to use this software for any purpose,
  including commercial applications, and to alter it and redistribute it
  freely, subject to the following restrictions:
 
  1. The origin of this software must not be misrepresented; you must not
     claim that you wrote the original software. If you use this software
     in a product, an acknowledgment in the product documentation would be
     appreciated but is not required.
  2. Altered source versions must be plainly marked as such, and must not be
     misrepresented as being the original software.
  3. This notice may not be removed or altered from any source distribution.
*/
 
#ifndef SDL2PP_MIXER_HH
#define SDL2PP_MIXER_HH
 
#include <functional>
#include <memory>
 
#include <SDL_stdinc.h>
#include <SDL_mixer.h>
 
#include <SDL2pp/Export.hh>
 
namespace SDL2pp {
 
class Chunk;
class Music;
 
class SDL2PP_EXPORT Mixer {
public:
    typedef void (*ChannelFinishedHandler)(int); 
    typedef void (*MusicFinishedHandler)();      
 
    typedef std::function<void(Uint8 *stream, int len)> MusicHook; 
 
private:
    bool open_;
    std::unique_ptr<MusicHook> current_music_hook_;
 
public:
 
 
    Mixer(int frequency, Uint16 format, int channels, int chunksize);
 
    ~Mixer();
 
 
 
    Mixer(Mixer&& other) noexcept;
 
    Mixer& operator=(Mixer&& other) noexcept;
 
    Mixer(const Mixer& other) = delete;
 
    Mixer& operator=(const Mixer& other) = delete;
 
 
 
    int AllocateChannels(int numchans);
 
    int GetNumChannels() const;
 
    int SetVolume(int channel, int volume);
 
    int GetVolume(int channel) const;
 
 
 
    int PlayChannel(int channel, const Chunk& chunk, int loops = 0);
 
    int PlayChannel(int channel, const Chunk& chunk, int loops, int ticks);
 
    int FadeInChannel(int channel, const Chunk& chunk, int loops, int ms);
 
    int FadeInChannel(int channel, const Chunk& chunk, int loops, int ms, int ticks);
 
 
 
    void PauseChannel(int channel = -1);
 
    void ResumeChannel(int channel = -1);
 
 
 
    void HaltChannel(int channel = -1);
 
    int ExpireChannel(int channel, int ticks);
 
    int FadeOutChannel(int channel, int ms);
 
    void SetChannelFinishedHandler(ChannelFinishedHandler channel_finished);
 
    void RemoveChannelFinishedHandler();
 
 
 
    int IsChannelPlaying(int channel) const;
 
    int IsChannelPaused(int channel) const;
 
    Mix_Fading GetChannelFading(int which) const;
 
 
 
    int ReserveChannels(int num);
 
    void GroupChannel(int which, int tag);
 
    void GroupChannels(int from, int to, int tag);
 
 
 
    int GetGroupNumChannels(int tag) const;
 
    int GetGroupAvailableChannel(int tag) const;
 
    int GetGroupOldestChannel(int tag) const;
 
    int GetGroupNewestChannel(int tag) const;
 
 
 
    int FadeOutGroup(int tag, int ms);
 
    void HaltGroup(int tag);
 
 
 
    void PlayMusic(const Music& music, int loops = -1);
 
    void FadeInMusic(const Music& music, int loops = -1, int ms = 0);
 
    void SetMusicHook(MusicHook&& hook);
 
 
 
    int SetMusicVolume(int volume);
 
    int GetMusicVolume() const;
 
    void PauseMusic();
 
    void ResumeMusic();
 
    void RewindMusic();
 
    void SetMusicPosition(double position);
 
 
 
    void HaltMusic();
 
    bool FadeOutMusic(int ms);
 
    void SetMusicFinishedHandler(MusicFinishedHandler music_finished);
 
    void RemoveMusicFinishedHandler();
 
 
 
    bool IsMusicPlaying() const;
 
    bool IsMusicPaused() const;
 
    Mix_Fading GetMusicFading() const;
 
 
 
    // TODO: custom effects
 
    void SetPanning(int channel, Uint8 left, Uint8 right);
 
    void UnsetPanning(int channel);
 
    void SetDistance(int channel, Uint8 distance);
 
    void UnsetDistance(int channel);
 
    void SetPosition(int channel, Sint16 angle, Uint8 distance);
 
    void UnsetPosition(int channel);
 
    void SetReverseStereo(int channel);
 
    void UnsetReverseStereo(int channel);
 
};
 
}
 
#endif