voc.h

Go to the documentation of this file.

/* 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 AUDIO_VOC_H
#define AUDIO_VOC_H

#include "audio/audiostream.h"

#include "common/list.h"
#include "common/scummsys.h"
#include "common/types.h"

namespace Common {
class ReadStream;
class SeekableReadStream;
}

namespace Audio {

class AudioStream;
class SeekableAudioStream;


#include "common/pack-start.h"  // START STRUCT PACKING

struct VocFileHeader {
    uint8 desc[20];
    uint16 datablock_offset;
    uint16 version;
    uint16 id;
} PACKED_STRUCT;

struct VocBlockHeader {
    uint8 blocktype;
    uint8 size[3];
    uint8 sr;
    uint8 pack;
} PACKED_STRUCT;

#include "common/pack-end.h"    // END STRUCT PACKING

class VocStream : public SeekableAudioStream {
public:
    VocStream(Common::SeekableReadStream *stream, bool isUnsigned, DisposeAfterUse::Flag disposeAfterUse);
    virtual ~VocStream();

    int readBuffer(int16 *buffer, const int numSamples) override;

    bool isStereo() const override { return false; }

    int getRate() const override { return _rate; }

    bool endOfData() const override { return (_curBlock == _blocks.end()) && (_blockLeft == 0); }

    bool seek(const Timestamp &where) override;

    Timestamp getLength() const override { return _length; }

protected:
    void preProcess();

    Common::SeekableReadStream *const _stream;
    const DisposeAfterUse::Flag _disposeAfterUse;

    const bool _isUnsigned;

    int _rate;
    Timestamp _length;

    struct Block {
        uint8 code;
        uint32 length;

        union {
            struct {
                uint32 offset;
                int rate;
                int samples;
            } sampleBlock;

            struct {
                int count;
            } loopBlock;
        };
    };

    typedef Common::List<Block> BlockList;
    BlockList _blocks;

    BlockList::const_iterator _curBlock;
    uint32 _blockLeft;

    void updateBlockIfNeeded();

    // Do some internal buffering for systems with really slow slow disk i/o
    enum {
        kSampleBufferLength = 2048
    };
    byte _buffer[kSampleBufferLength];

    int fillBuffer(int maxSamples);
};

extern int getSampleRateFromVOCRate(int vocSR);

SeekableAudioStream *makeVOCStream(Common::SeekableReadStream *stream, byte flags, DisposeAfterUse::Flag disposeAfterUse = DisposeAfterUse::NO);

} // End of namespace Audio

#endif