FadeAudioGainBy.hpp

/******************************************************************************
 
  nomlib - C++11 cross-platform game engine
 
Copyright (c) 2013, 2014, 2015, 2016 Jeffrey Carpenter <i8degrees@gmail.com> Carpenter <i8degrees@gmail.com>
All rights reserved.
 
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
 
1. Redistributions of source code must retain the above copyright notice, this
   list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.
 
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
******************************************************************************/
#ifndef NOMLIB_ACTIONS_FADE_AUDIO_GAIN_BY_HPP
#define NOMLIB_ACTIONS_FADE_AUDIO_GAIN_BY_HPP
 
#include <memory>
 
#include "nomlib/config.hpp"
#include "nomlib/actions/IActionObject.hpp"
 
namespace nom {
namespace audio {
 
// Forward declarations
class IOAudioEngine;
struct SoundBuffer;
 
} // namespace audio

// TODO: Update comments!
class FadeAudioGainBy: public virtual IActionObject
{
  public:
    friend class ActionTest;
 
    typedef FadeAudioGainBy self_type;

    FadeAudioGainBy(audio::IOAudioEngine* dev, const char* filename,
                    real32 delta, real32 duration);

    FadeAudioGainBy(audio::IOAudioEngine* dev, audio::SoundBuffer* buffer,
                    real32 delta, real32 duration);

    virtual ~FadeAudioGainBy();
 
    virtual std::unique_ptr<IActionObject> clone() const override;
 
    virtual IActionObject::FrameState next_frame(real32 delta_time) override;
 
    virtual IActionObject::FrameState prev_frame(real32 delta_time) override;
 
    virtual void pause(real32 delta_time) override;

    virtual void resume(real32 delta_time) override;
 
    virtual void rewind(real32 delta_time) override;
 
    virtual void release() override;
 
  private:
    static const char* DEBUG_CLASS_NAME;

    IActionObject::FrameState update(real32 t, uint8 b, int16 c, real32 d);
 
    void first_frame(real32 delta_time);
    void last_frame(real32 delta_time);

    real32 initial_volume_;

    const real32 total_displacement_;
 
    audio::IOAudioEngine* impl_ = nullptr;

    audio::SoundBuffer* audible_ = nullptr;
};
 
} // namespace nom
 
#endif // include guard defined