snd_sound.h

/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */


#ifndef QDENGINE_SYSTEM_SOUND_SND_SOUND_H
#define QDENGINE_SYSTEM_SOUND_SND_SOUND_H

#include "audio/mixer.h"

namespace QDEngine {

class wavSound;
class qdNamedObject;

class sndHandle {
public:
    sndHandle() { };
    virtual ~sndHandle() { };
};

class sndSound {
public:
    explicit sndSound(const wavSound *snd, const sndHandle *h = NULL) : _sound(snd), _handle(h), _flags(0) {}
    ~sndSound();

    enum status_t {
        SOUND_STOPPED,
        SOUND_PAUSED,
        SOUND_PLAYING
    };

    status_t status() const;

    const wavSound *sound() const {
        return _sound;
    }
    const sndHandle *handle() const {
        return _handle;
    }

    bool play();
    bool stop(bool rewind = true);
    void pause();
    void resume();
    bool is_paused() const {
        if (_flags & SOUND_FLAG_PAUSED) return true;
        else return false;
    }

    bool is_stopped() const;


    bool set_volume(int vol);

    bool change_frequency(float coeff = 1.0f);

    bool create_sound_buffer();
    bool release_sound_buffer();

    void toggle_looping() {
        _flags ^= SOUND_FLAG_LOOPING;
    }

private:
    const wavSound *_sound;
    const sndHandle *_handle;

    enum {
        SOUND_FLAG_LOOPING  = 0x01,
        SOUND_FLAG_PAUSED   = 0x02
    };

    int _flags;

    Audio::SoundHandle _audHandle;

    bool _isStopped = false;
};

} // namespace QDEngine

#endif // QDENGINE_SYSTEM_SOUND_SND_SOUND_H