zstd_seekable.h File Reference

#include <stdio.h>
#include "zstd.h"

Go to the source code of this file.

Data Structures
struct	ZSTD_seekable_customFile

Macros
#define	ZSTD_seekTableFooterSize   9
#define	ZSTD_SEEKABLE_MAGICNUMBER   0x8F92EAB1
#define	ZSTD_SEEKABLE_MAXFRAMES   0x8000000U
#define	ZSTD_SEEKABLE_MAX_FRAME_DECOMPRESSED_SIZE   0x40000000U
#define	ZSTD_SEEKABLE_FRAMEINDEX_TOOLARGE   (0ULL-2)

Functions
ZSTDLIB_API ZSTD_seekable_CStream *	ZSTD_seekable_createCStream (void)
ZSTDLIB_API size_t	ZSTD_seekable_freeCStream (ZSTD_seekable_CStream *zcs)
ZSTDLIB_API size_t	ZSTD_seekable_initCStream (ZSTD_seekable_CStream *zcs, int compressionLevel, int checksumFlag, unsigned maxFrameSize)
ZSTDLIB_API size_t	ZSTD_seekable_compressStream (ZSTD_seekable_CStream *zcs, ZSTD_outBuffer *output, ZSTD_inBuffer *input)
ZSTDLIB_API size_t	ZSTD_seekable_endFrame (ZSTD_seekable_CStream *zcs, ZSTD_outBuffer *output)
ZSTDLIB_API size_t	ZSTD_seekable_endStream (ZSTD_seekable_CStream *zcs, ZSTD_outBuffer *output)
ZSTDLIB_API ZSTD_frameLog *	ZSTD_seekable_createFrameLog (int checksumFlag)
ZSTDLIB_API size_t	ZSTD_seekable_freeFrameLog (ZSTD_frameLog *fl)
ZSTDLIB_API size_t	ZSTD_seekable_logFrame (ZSTD_frameLog *fl, unsigned compressedSize, unsigned decompressedSize, unsigned checksum)
ZSTDLIB_API size_t	ZSTD_seekable_writeSeekTable (ZSTD_frameLog *fl, ZSTD_outBuffer *output)
ZSTDLIB_API ZSTD_seekable *	ZSTD_seekable_create (void)
ZSTDLIB_API size_t	ZSTD_seekable_free (ZSTD_seekable *zs)
ZSTDLIB_API size_t	ZSTD_seekable_initBuff (ZSTD_seekable *zs, const void *src, size_t srcSize)
ZSTDLIB_API size_t	ZSTD_seekable_initFile (ZSTD_seekable *zs, FILE *src)
ZSTDLIB_API size_t	ZSTD_seekable_decompress (ZSTD_seekable *zs, void *dst, size_t dstSize, unsigned long long offset)
ZSTDLIB_API size_t	ZSTD_seekable_decompressFrame (ZSTD_seekable *zs, void *dst, size_t dstSize, unsigned frameIndex)
ZSTDLIB_API unsigned	ZSTD_seekable_getNumFrames (const ZSTD_seekable *zs)
ZSTDLIB_API unsigned long long	ZSTD_seekable_getFrameCompressedOffset (const ZSTD_seekable *zs, unsigned frameIndex)
ZSTDLIB_API unsigned long long	ZSTD_seekable_getFrameDecompressedOffset (const ZSTD_seekable *zs, unsigned frameIndex)
ZSTDLIB_API size_t	ZSTD_seekable_getFrameCompressedSize (const ZSTD_seekable *zs, unsigned frameIndex)
ZSTDLIB_API size_t	ZSTD_seekable_getFrameDecompressedSize (const ZSTD_seekable *zs, unsigned frameIndex)
ZSTDLIB_API unsigned	ZSTD_seekable_offsetToFrameIndex (const ZSTD_seekable *zs, unsigned long long offset)
ZSTDLIB_API ZSTD_seekTable *	ZSTD_seekTable_create_fromSeekable (const ZSTD_seekable *zs)
ZSTDLIB_API size_t	ZSTD_seekTable_free (ZSTD_seekTable *st)
ZSTDLIB_API unsigned	ZSTD_seekTable_getNumFrames (const ZSTD_seekTable *st)
ZSTDLIB_API unsigned long long	ZSTD_seekTable_getFrameCompressedOffset (const ZSTD_seekTable *st, unsigned frameIndex)
ZSTDLIB_API unsigned long long	ZSTD_seekTable_getFrameDecompressedOffset (const ZSTD_seekTable *st, unsigned frameIndex)
ZSTDLIB_API size_t	ZSTD_seekTable_getFrameCompressedSize (const ZSTD_seekTable *st, unsigned frameIndex)
ZSTDLIB_API size_t	ZSTD_seekTable_getFrameDecompressedSize (const ZSTD_seekTable *st, unsigned frameIndex)
ZSTDLIB_API unsigned	ZSTD_seekTable_offsetToFrameIndex (const ZSTD_seekTable *st, unsigned long long offset)
ZSTDLIB_API size_t	ZSTD_seekable_initAdvanced (ZSTD_seekable *zs, ZSTD_seekable_customFile src)

Macro Definition Documentation

ZSTD_SEEKABLE_FRAMEINDEX_TOOLARGE

#define ZSTD_SEEKABLE_FRAMEINDEX_TOOLARGE   (0ULL-2)

ZSTD_SEEKABLE_MAGICNUMBER

#define ZSTD_SEEKABLE_MAGICNUMBER   0x8F92EAB1

ZSTD_SEEKABLE_MAX_FRAME_DECOMPRESSED_SIZE

#define ZSTD_SEEKABLE_MAX_FRAME_DECOMPRESSED_SIZE   0x40000000U

ZSTD_SEEKABLE_MAXFRAMES

#define ZSTD_SEEKABLE_MAXFRAMES   0x8000000U

ZSTD_seekTableFooterSize

#define ZSTD_seekTableFooterSize   9

Function Documentation

ZSTD_seekable_compressStream()

ZSTDLIB_API size_t ZSTD_seekable_compressStream	(	ZSTD_seekable_CStream *	zcs,
		ZSTD_outBuffer *	output,
		ZSTD_inBuffer *	input )

ZSTD_seekable_create()

ZSTDLIB_API ZSTD_seekable * ZSTD_seekable_create

(

void

)

ZSTD_seekable_createCStream()

ZSTDLIB_API ZSTD_seekable_CStream * ZSTD_seekable_createCStream

(

void

)

ZSTD_seekable_createFrameLog()

ZSTDLIB_API ZSTD_frameLog * ZSTD_seekable_createFrameLog

(

int

checksumFlag

)

ZSTD_seekable_decompress()

ZSTDLIB_API size_t ZSTD_seekable_decompress	(	ZSTD_seekable *	zs,
		void *	dst,
		size_t	dstSize,
		unsigned long long	offset )

ZSTD_seekable_decompressFrame()

ZSTDLIB_API size_t ZSTD_seekable_decompressFrame	(	ZSTD_seekable *	zs,
		void *	dst,
		size_t	dstSize,
		unsigned	frameIndex )

ZSTD_seekable_endFrame()

ZSTDLIB_API size_t ZSTD_seekable_endFrame	(	ZSTD_seekable_CStream *	zcs,
		ZSTD_outBuffer *	output )

ZSTD_seekable_endStream()

ZSTDLIB_API size_t ZSTD_seekable_endStream	(	ZSTD_seekable_CStream *	zcs,
		ZSTD_outBuffer *	output )

ZSTD_seekable_free()

ZSTDLIB_API size_t ZSTD_seekable_free

(

ZSTD_seekable *

zs

)

ZSTD_seekable_freeCStream()

ZSTDLIB_API size_t ZSTD_seekable_freeCStream

(

ZSTD_seekable_CStream *

zcs

)

ZSTD_seekable_freeFrameLog()

ZSTDLIB_API size_t ZSTD_seekable_freeFrameLog

(

ZSTD_frameLog *

fl

)

ZSTD_seekable_getFrameCompressedOffset()

ZSTDLIB_API unsigned long long ZSTD_seekable_getFrameCompressedOffset	(	const ZSTD_seekable *	zs,
		unsigned	frameIndex )

ZSTD_seekable_getFrameCompressedSize()

ZSTDLIB_API size_t ZSTD_seekable_getFrameCompressedSize	(	const ZSTD_seekable *	zs,
		unsigned	frameIndex )

ZSTD_seekable_getFrameDecompressedOffset()

ZSTDLIB_API unsigned long long ZSTD_seekable_getFrameDecompressedOffset	(	const ZSTD_seekable *	zs,
		unsigned	frameIndex )

ZSTD_seekable_getFrameDecompressedSize()

ZSTDLIB_API size_t ZSTD_seekable_getFrameDecompressedSize	(	const ZSTD_seekable *	zs,
		unsigned	frameIndex )

ZSTD_seekable_getNumFrames()

ZSTDLIB_API unsigned ZSTD_seekable_getNumFrames

(

const ZSTD_seekable *

zs

)

ZSTD_seekable_initAdvanced()

ZSTDLIB_API size_t ZSTD_seekable_initAdvanced	(	ZSTD_seekable *	zs,
		ZSTD_seekable_customFile	src )

ZSTD_seekable_initBuff()

ZSTDLIB_API size_t ZSTD_seekable_initBuff	(	ZSTD_seekable *	zs,
		const void *	src,
		size_t	srcSize )

ZSTD_seekable_initCStream()

ZSTDLIB_API size_t ZSTD_seekable_initCStream	(	ZSTD_seekable_CStream *	zcs,
		int	compressionLevel,
		int	checksumFlag,
		unsigned	maxFrameSize )

ZSTD_seekable_initFile()

ZSTDLIB_API size_t ZSTD_seekable_initFile	(	ZSTD_seekable *	zs,
		FILE *	src )

ZSTD_seekable_logFrame()

ZSTDLIB_API size_t ZSTD_seekable_logFrame	(	ZSTD_frameLog *	fl,
		unsigned	compressedSize,
		unsigned	decompressedSize,
		unsigned	checksum )

ZSTD_seekable_offsetToFrameIndex()

ZSTDLIB_API unsigned ZSTD_seekable_offsetToFrameIndex	(	const ZSTD_seekable *	zs,
		unsigned long long	pos )

ZSTD_seekable_offsetToFrameIndex() : Performs a binary search to find the last frame with a decompressed offset <= pos

Returns

: the frame's index

ZSTD_seekable_writeSeekTable()

ZSTDLIB_API size_t ZSTD_seekable_writeSeekTable	(	ZSTD_frameLog *	fl,
		ZSTD_outBuffer *	output )

ZSTD_seekTable_create_fromSeekable()

ZSTDLIB_API ZSTD_seekTable * ZSTD_seekTable_create_fromSeekable

(

const ZSTD_seekable *

zs

)

ZSTD_seekTable_free()

ZSTDLIB_API size_t ZSTD_seekTable_free

(

ZSTD_seekTable *

st

)

ZSTD_seekTable_getFrameCompressedOffset()

ZSTDLIB_API unsigned long long ZSTD_seekTable_getFrameCompressedOffset	(	const ZSTD_seekTable *	st,
		unsigned	frameIndex )

ZSTD_seekTable_getFrameCompressedSize()

ZSTDLIB_API size_t ZSTD_seekTable_getFrameCompressedSize	(	const ZSTD_seekTable *	st,
		unsigned	frameIndex )

ZSTD_seekTable_getFrameDecompressedOffset()

ZSTDLIB_API unsigned long long ZSTD_seekTable_getFrameDecompressedOffset	(	const ZSTD_seekTable *	st,
		unsigned	frameIndex )

ZSTD_seekTable_getFrameDecompressedSize()

ZSTDLIB_API size_t ZSTD_seekTable_getFrameDecompressedSize	(	const ZSTD_seekTable *	st,
		unsigned	frameIndex )

ZSTD_seekTable_getNumFrames()

ZSTDLIB_API unsigned ZSTD_seekTable_getNumFrames

(

const ZSTD_seekTable *

st

)

ZSTD_seekTable_offsetToFrameIndex()

ZSTDLIB_API unsigned ZSTD_seekTable_offsetToFrameIndex	(	const ZSTD_seekTable *	st,
		unsigned long long	offset )