soundclip.h

/***************************************************************************
 *   Copyright (C) 2005-2011 by the FIFE team                              *
 *   http://www.fifengine.net                                              *
 *   This file is part of FIFE.                                            *
 *                                                                         *
 *   FIFE is free software; you can redistribute it and/or                 *
 *   modify it under the terms of the GNU Lesser General Public            *
 *   License as published by the Free Software Foundation; either          *
 *   version 2.1 of the License, or (at your option) any later version.    *
 *                                                                         *
 *   This library 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     *
 *   Lesser General Public License for more details.                       *
 *                                                                         *
 *   You should have received a copy of the GNU Lesser General Public      *
 *   License along with this library; if not, write to the                 *
 *   Free Software Foundation, Inc.,                                       *
 *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA          *
 ***************************************************************************/

#ifndef FIFE_SOUNDCLIP_H_
#define FIFE_SOUNDCLIP_H_

// Standard C++ library includes
#include <vector>

// Platform specific includes

// 3rd party library includes

// FIFE includes
// These includes are split up in two parts, separated by one empty line
// First block: files included from the FIFE root src directory
// Second block: files included from the same folder
#include "util/resource/resource.h"

#include "sounddecoder.h"

namespace FIFE {

    enum SoundPositionType {
        SD_SAMPLE_POS,
        SD_TIME_POS,
        SD_BYTE_POS
    };

    struct SoundBufferEntry {
        ALuint buffers[BUFFER_NUM];
        uint32_t usedbufs;
        uint64_t deccursor;
    };

    class SoundClip : public IResource {
    public:

        SoundClip(IResourceLoader* loader = 0);
        SoundClip(const std::string& name, IResourceLoader* loader = 0);

        ~SoundClip();

        bool isStream() const {
            return m_isstream;
        }

        uint32_t countBuffers() const {
            return m_buffervec.at(0)->usedbufs;
        }

        ALuint* getBuffers(uint32_t streamid = 0) const {
            return m_buffervec.at(streamid)->buffers;
        }

        uint32_t beginStreaming();

        void acquireStream(uint32_t streamid);

        bool setStreamPos(uint32_t streamid, SoundPositionType type, float value);

        float getStreamPos(uint32_t streamid, SoundPositionType type) const;

        bool getStream(uint32_t streamid, ALuint buffer);

        void quitStreaming(uint32_t streamid);

        void adobtDecoder(SoundDecoder* decoder) { m_decoder = decoder; m_deletedecoder = true; }

        void setDecoder(SoundDecoder* decoder) { m_decoder = decoder; m_deletedecoder = false; }

        SoundDecoder* getDecoder() const {
            return m_decoder;
        }

        virtual size_t getSize() { return 0; }

        virtual void load();
        virtual void free();

    private:
        bool                        m_isstream;         // is stream?
        SoundDecoder*       m_decoder;          // attached decoder
        bool                        m_deletedecoder;    // when loadFromDecoder-method is used, decoder shouldn't be deleted
        std::vector<SoundBufferEntry*> m_buffervec;

        std::string createUniqueClipName();
    };

    typedef SharedPtr<SoundClip> SoundClipPtr;
}

#endif