wb.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 FREESCAPE_WB_H
#define FREESCAPE_WB_H

#include "audio/audiostream.h"
#include "common/types.h"

#include "freescape/music.h"

namespace Freescape {

namespace WBCommon {

int8 decodeOrderTranspose(byte cmd);

byte decodeTickSpeed(byte cmd);

byte decodeDuration(byte cmd);

byte buildArpeggioTable(const byte intervals[8], byte mask, byte *outTable, byte maxLen, bool includeBase);

} // End of namespace WBCommon

struct WBTableOffsets {
    uint32 periodTable;       // 48 x uint16 BE
    uint32 samplePtrTable;    // numSamples x uint32 BE
    uint32 instrumentTable;   // numInstruments x 8 bytes
    uint32 arpeggioIntervals; // 8 bytes
    uint32 envelopeTable;     // numEnvelopes x 8 bytes
    uint32 songTable;         // 2 songs x 4 channels x uint32 BE
    uint32 patternPtrTable;   // up to 128 x uint32 BE
    int numSamples;
    int numInstruments;
    int numEnvelopes;
};

Audio::AudioStream *makeWallyBebenStream(const byte *data, uint32 dataSize,
                                         int songNum = 1, int rate = 44100,
                                         bool stereo = true,
                                         const WBTableOffsets *offsets = nullptr);

struct WBAtariTableOffsets {
    uint32 periodTable;       // 96 x uint16 BE
    uint32 arpeggioIntervals; // 8 bytes
    uint32 instrumentTable;   // numInstruments x 8 bytes
    uint32 songTable;         // 2 songs x 3 channels x uint32 BE
    uint32 patternPtrTable;   // up to 32 x uint32 BE
    int numInstruments;

    byte noiseSeed;           // noise period loaded by instrument flag bit 0
    bool noiseFollowsInstrument; // flag bit 1 takes the noise period from byte 5
    byte noiseDrift;          // subtracted while the noise counter runs

    // Frequency sweep, instrument flag bit 2
    int16 sweepStep;
    uint16 sweepMask;         // period wrap, 0 for none
    int8 sweepNoiseDelta;
};

extern const WBAtariTableOffsets kEclipseAtariOffsets;
extern const WBAtariTableOffsets kDarkSideAtariOffsets;

MusicPlayer *makeWallyBebenAtariPlayer(const byte *data, uint32 dataSize,
                                       const WBAtariTableOffsets &offsets,
                                       int songNum = 1);

} // End of namespace Freescape

#endif