unpack.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 CINE_UNPACK_H
#define CINE_UNPACK_H


#include "common/scummsys.h"

namespace Cine {

class CineUnpacker {
public:
    bool unpack(const byte *src, uint srcLen, byte *dst, uint dstLen);
private:
    uint32 readSource();

    uint rcr(bool inputCarry);

    uint nextBit();

    uint getBits(uint numBits);

    void unpackRawBytes(uint numBytes);

    void copyRelocatedBytes(uint offset, uint numBytes);
private:
    uint32 _crc;      
    uint32 _chunk32b; 
    byte *_dst;       
    const byte *_src; 

    // These are used for detecting errors (e.g. out of bounds issues) during unpacking
    bool _error;           
    const byte *_srcBegin; 
    const byte *_srcEnd;   
    byte *_dstBegin;       
    byte *_dstEnd;         
};

} // End of namespace Cine

#endif