audiostream.h

Go to the documentation of this file.

/* xoreos - A reimplementation of BioWare's Aurora engine
 *
 * xoreos is the legal property of its developers, whose names
 * can be found in the AUTHORS file distributed with this source
 * distribution.
 *
 * xoreos 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.
 *
 * xoreos 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 xoreos. If not, see <http://www.gnu.org/licenses/>.
 */

/* Based on ScummVM (<http://scummvm.org>) code, which is released
 * under the terms of version 2 or later of the GNU General Public
 * License.
 *
 * The original copyright note in ScummVM reads as follows:
 *
 * 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 2
 * 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, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 */

#ifndef SOUND_AUDIOSTREAM_H
#define SOUND_AUDIOSTREAM_H

#include <boost/noncopyable.hpp>

#include "src/common/util.h"
#include "src/common/types.h"
#include "src/common/disposableptr.h"
#include "src/common/scopedptr.h"

namespace Common {
class SeekableReadStream;
}

namespace Sound {

class AudioStream : boost::noncopyable {
public:
    static const size_t kSizeInvalid = SIZE_MAX;

    virtual ~AudioStream() {}

    virtual size_t readBuffer(int16 *buffer, const size_t numSamples) = 0;

    virtual int getChannels() const = 0;

    virtual int getRate() const = 0;

    virtual bool endOfData() const = 0;

    virtual bool endOfStream() const { return endOfData(); }
};

class RewindableAudioStream : public AudioStream {
public:
    static const uint64 kInvalidLength = UINT64_C(0xFFFFFFFFFFFFFFFF);

    virtual bool rewind() = 0;

    virtual uint64 getLength() const { return kInvalidLength; }

    virtual uint64 getDuration() const {
        if ((getLength() == kInvalidLength) || (getRate() <= 0))
            return kInvalidLength;

        return (getLength() * 1000) / getRate();
    }
};

class EmptyAudioStream : public RewindableAudioStream {
public:
    EmptyAudioStream() { }

    size_t readBuffer(int16 *UNUSED(buffer), const size_t UNUSED(numSamples)) { return 0; }

    int getChannels() const { return 1; }

    int getRate() const { return 44100; }

    bool endOfData() const { return true; }
    bool rewind() { return true; }

    uint64 getLength() const { return 0; }
};

class LoopingAudioStream : public AudioStream {
public:
    LoopingAudioStream(RewindableAudioStream *stream, size_t loops, bool disposeAfterUse = true);
    ~LoopingAudioStream();

    size_t readBuffer(int16 *buffer, const size_t numSamples);
    bool endOfData() const;

    int getChannels() const { return _parent->getChannels(); }
    int getRate() const { return _parent->getRate(); }

    size_t getCompleteIterations() const { return _completeIterations; }

    bool rewind();

    uint64 getLength() const;
    uint64 getDuration() const;

    uint64 getLengthOnce() const;
    uint64 getDurationOnce() const;

private:
    Common::DisposablePtr<RewindableAudioStream> _parent;

    size_t _loops;
    size_t _completeIterations;
};

AudioStream *makeLoopingAudioStream(RewindableAudioStream *stream, size_t loops);

class QueuingAudioStream : public AudioStream {
public:

    virtual void queueAudioStream(AudioStream *audStream, bool disposeAfterUse = true) = 0;

    virtual void finish() = 0;

    virtual bool isFinished() const = 0;

    virtual size_t numQueuedStreams() const = 0;
};

QueuingAudioStream *makeQueuingAudioStream(int rate, int channels);

class PacketizedAudioStream : public virtual AudioStream {
public:
    virtual ~PacketizedAudioStream() {}

    virtual void queuePacket(Common::SeekableReadStream *data) = 0;

    virtual void finish() = 0;

    virtual bool isFinished() const = 0;
};

class StatelessPacketizedAudioStream : public PacketizedAudioStream {
public:
    StatelessPacketizedAudioStream(int rate, int channels) :
        _rate(rate), _channels(channels), _stream(makeQueuingAudioStream(rate, channels)) {}
    virtual ~StatelessPacketizedAudioStream() {}

    // AudioStream API
    int getChannels() const { return _channels; }
    int getRate() const { return _rate; }
    size_t readBuffer(int16 *data, const size_t numSamples) { return _stream->readBuffer(data, numSamples); }
    bool endOfData() const { return _stream->endOfData(); }
    bool endOfStream() const { return _stream->endOfStream(); }

    // PacketizedAudioStream API
    void queuePacket(Common::SeekableReadStream *data) { _stream->queueAudioStream(makeStream(data)); }
    void finish() { _stream->finish(); }
    bool isFinished() const { return _stream->isFinished(); }

protected:
    virtual AudioStream *makeStream(Common::SeekableReadStream *data) = 0;

private:
    int _rate;
    int _channels;
    Common::ScopedPtr<QueuingAudioStream> _stream;
};

} // End of namespace Sound

#endif // SOUND_AUDIOSTREAM_H