mirror of
https://gitea.wildfiregames.com/0ad/0ad.git
synced 2026-07-13 10:15:43 +00:00
janwas
75ab906315
archive: ArchiveEntry now a mememto and not exposed directly typedefs for boost::shared_ptr fixed up dir_util to new interface add "FileProvider" that does Load/Store and indicates Precedence vfs: structure has changed. one RealDirectory per OS dir; vfs_tree stores it; populate uses it to Add() stuff to vfs_tree; lookup does path traversal and calls populate This was SVN commit r5499.
73 lines
2.3 KiB
C
73 lines
2.3 KiB
C
/**
|
|
* =========================================================================
|
|
* File : codec.h
|
|
* Project : 0 A.D.
|
|
* Description :
|
|
* =========================================================================
|
|
*/
|
|
|
|
// license: GPL; see lib/license.txt
|
|
|
|
#ifndef INCLUDED_CODEC
|
|
#define INCLUDED_CODEC
|
|
|
|
// rationale: this layer allows for other compression methods/libraries
|
|
// besides ZLib. it also simplifies the interface for user code and
|
|
// does error checking, etc.
|
|
|
|
struct ICodec
|
|
{
|
|
public:
|
|
/**
|
|
* note: the implementation should not check whether any data remains -
|
|
* codecs are sometimes destroyed without completing a transfer.
|
|
**/
|
|
virtual ~ICodec();
|
|
|
|
/**
|
|
* @return an upper bound on the output size for the given amount of input.
|
|
* this is used when allocating a single buffer for the whole operation.
|
|
**/
|
|
virtual size_t MaxOutputSize(size_t inSize) const = 0;
|
|
|
|
/**
|
|
* clear all previous state and prepare for reuse.
|
|
*
|
|
* this is as if the object were destroyed and re-created, but more
|
|
* efficient since it avoids reallocating a considerable amount of
|
|
* memory (about 200KB for LZ).
|
|
**/
|
|
virtual LibError Reset() = 0;
|
|
|
|
/**
|
|
* process (i.e. compress or decompress) data.
|
|
*
|
|
* @param outSize bytes remaining in the output buffer; shall not be zero.
|
|
* @param inConsumed, outProduced how many bytes in the input and
|
|
* output buffers were used. either or both of these can be zero if
|
|
* the input size is small or there's not enough output space.
|
|
**/
|
|
virtual LibError Process(const u8* in, size_t inSize, u8* out, size_t outSize, size_t& inConsumed, size_t& outProduced) = 0;
|
|
|
|
/**
|
|
* flush buffers and make sure all output has been produced.
|
|
*
|
|
* @param checksum over all input data.
|
|
* @return error status for the entire operation.
|
|
**/
|
|
virtual LibError Finish(u32& checksum) = 0;
|
|
|
|
/**
|
|
* update a checksum to reflect the contents of a buffer.
|
|
*
|
|
* @param checksum the initial value (must be 0 on first call)
|
|
* @return the new checksum. note: after all data has been seen, this is
|
|
* identical to the what Finish would return.
|
|
**/
|
|
virtual u32 UpdateChecksum(u32 checksum, const u8* in, size_t inSize) const = 0;
|
|
};
|
|
|
|
typedef boost::shared_ptr<ICodec> PICodec;
|
|
|
|
#endif // #ifndef INCLUDED_CODEC
|