Sound.h

// Copyright (c) 2016-2018 Kiwano - Nomango
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
 
#pragma once
#include <kiwano/core/Resource.h>
#include <kiwano-audio/AudioData.h>
 
namespace kiwano
{
namespace audio
{
class Module;
class Sound;
class SoundPlayer;
 
class KGE_API SoundCallback : public NativeObject
{
public:
    static RefPtr<SoundCallback> OnStart(const Function<void(Sound* sound)>& cb);
 
    static RefPtr<SoundCallback> OnLoopEnd(const Function<void(Sound* sound)>& cb);
 
    static RefPtr<SoundCallback> OnEnd(const Function<void(Sound* sound)>& cb);
 
    static RefPtr<SoundCallback> OnVolumeChanged(const Function<float(Sound* sound, float volume)>& cb);
 
    virtual inline void OnStart(Sound* sound) {}
 
    virtual inline void OnLoopEnd(Sound* sound) {}
 
    virtual inline void OnEnd(Sound* sound) {}
 
    virtual inline float OnVolumeChanged(Sound* sound, float volume)
    {
        return volume;
    }
};
 
class KGE_API Sound : public NativeObject
{
    friend class Module;
    friend class SoundPlayer;
 
public:
    Sound(StringView file_path);
 
    Sound(const Resource& res, StringView ext = "");
 
    Sound(RefPtr<AudioData> data);
 
    Sound();
 
    virtual ~Sound();
 
    void Play(int loop_count = 0);
 
    void Pause();
 
    void Resume();
 
    void Stop();
 
    void Close();
 
    bool IsPlaying() const;
 
    float GetVolume() const;
 
    void SetVolume(float volume);
 
    void AddCallback(RefPtr<SoundCallback> callback);
 
    List<RefPtr<SoundCallback>>& GetCallbacks();
 
    const List<RefPtr<SoundCallback>>& GetCallbacks() const;
 
protected:
    bool Load(RefPtr<AudioData> data);
 
    RefPtr<SoundCallback> GetCallbackChain();
 
    void ResetVolume();
 
private:
    bool              opened_;
    bool              playing_;
    float             volume_;
    RefPtr<AudioData> data_;
 
    RefPtr<SoundCallback>       callback_chain_;
    List<RefPtr<SoundCallback>> callbacks_;
};
 
inline List<RefPtr<SoundCallback>>& kiwano::audio::Sound::GetCallbacks()
{
    return callbacks_;
}
 
inline const List<RefPtr<SoundCallback>>& kiwano::audio::Sound::GetCallbacks() const
{
    return callbacks_;
}
 
inline void kiwano::audio::Sound::AddCallback(RefPtr<SoundCallback> callback)
{
    callbacks_.push_back(callback);
}
 
}  // namespace audio
}  // namespace kiwano