qd_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_QDCORE_QD_SOUND_H
#define QDENGINE_QDCORE_QD_SOUND_H

#include "qdengine/parser/xml_fwd.h"
#include "qdengine/qdcore/qd_named_object.h"
#include "qdengine/qdcore/qd_resource.h"
#include "qdengine/qdcore/qd_sound_handle.h"

#include "qdengine/system/sound/wav_sound.h"

namespace QDEngine {

class qdSound : public qdNamedObject, public qdResource {
public:
    qdSound();
    ~qdSound();

    int named_object_type() const {
        return QD_NAMED_OBJECT_SOUND;
    }

    void load_script(const xml::tag *p);
    bool save_script(Common::WriteStream &fh, int indent = 0) const;

    bool load_resource();
    bool free_resource();
    void set_resource_file(const Common::Path file_name) {
        set_file_name(file_name);
    }
    const Common::Path resource_file() const {
        return file_name();
    }
#ifdef __QD_DEBUG_ENABLE__
    uint32 resource_data_size() const {
        return _sound.data_length();
    }
#endif

    const Common::Path file_name() const {
        return _file_name;
    }
    void set_file_name(const Common::Path fname) {
        _file_name = fname;
    }


    bool play(const qdSoundHandle *handle = NULL, bool loop = false) const;

    bool stop(const qdSoundHandle *handle = NULL) const;

    bool set_frequency(const qdSoundHandle *handle, float frequency_coeff) const;

    float length() const {
        return _sound.length();
    }

    bool is_stopped(const qdSoundHandle *handle = NULL) const;

    int volume() const {
        return _volume;
    }
    void set_volume(int vol) {
        _volume = vol;
    }

private:

    Common::Path _file_name;
    int _volume;
    wavSound _sound;
};

typedef Std::list<qdSound *> qdSoundList;

} // namespace QDEngine

#endif // QDENGINE_QDCORE_QD_SOUND_H