resource.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/>.
 *
 *
 * This file is dual-licensed.
 * In addition to the GPLv3 license mentioned above, MojoTouch has
 * exclusively licensed this code on March 23th, 2024, to be used in
 * closed-source products.
 * Therefore, any contributions (commits) to it will also be dual-licensed.
 *
 */

#ifndef TOON_RESOURCE_H
#define TOON_RESOURCE_H

#include "common/array.h"
#include "common/str.h"
#include "common/file.h"
#include "common/stream.h"

#define MAX_CACHE_SIZE  (4 * 1024 * 1024)

namespace Toon {

class PakFile {
public:
    PakFile();
    ~PakFile();

    void open(Common::SeekableReadStream *rs, const Common::Path &packName);
    uint8 *getFileData(const Common::Path &fileName, uint32 *fileSize);
    Common::Path getPackName() { return _packName; }
    Common::SeekableReadStream *createReadStream(const Common::Path &fileName);
    void close();

protected:
    struct File {
        char _name[13];
        int32 _offset;
        int32 _size;
    };
    Common::Path _packName;

    uint32 _numFiles;
    Common::Array<File> _files;
};

class ToonEngine;

class CacheEntry {
public:
    CacheEntry() : _age(0), _size(0), _data(0) {}
    ~CacheEntry() {
        free(_data);
    }

    Common::Path _packName;
    Common::Path _fileName;
    uint32 _age;
    uint32 _size;
    uint8 *_data;
};

class Resources {
public:
    Resources(ToonEngine *vm);
    ~Resources();
    bool openPackage(const Common::Path &file);
    void closePackage(const Common::Path &fileName);
    Common::SeekableReadStream *openFile(const Common::Path &file);
    uint8 *getFileData(const Common::Path &fileName, uint32 *fileSize); // this memory must be copied to your own structures!
    void purgeFileData();

protected:
    ToonEngine *_vm;
    Common::Array<uint8 *> _allocatedFileData;
    Common::Array<PakFile *> _pakFiles;
    uint32 _cacheSize;
    Common::Array<CacheEntry *> _resourceCache;

    void removePackageFromCache(const Common::Path &packName);
    bool getFromCache(const Common::Path &fileName, uint32 *fileSize, uint8 **fileData);
    void addToCache(const Common::Path &packName, const Common::Path &fileName, uint32 fileSize, uint8 *fileData);
};

} // End of namespace Toon
#endif