NDPluginCodec.h File Reference

#include "NDPluginDriver.h"

Go to the source code of this file.

Classes
class	NDPluginCodec

Macros
#define	NDCodecModeString   "MODE" /* (NDCodecMode_t r/w) Mode: Compress/Decompress */
#define	NDCodecCompressorString   "COMPRESSOR" /* (NDCodecCompressor_t r/w) Which codec to use */
#define	NDCodecCompFactorString   "COMP_FACTOR" /* (double r/o) Compression percentage (0 = no compression) */
#define	NDCodecCodecStatusString   "CODEC_STATUS" /* (int r/o) Compression status: success or failure */
#define	NDCodecCodecErrorString   "CODEC_ERROR" /* (string r/o) Error message if compression fails */
#define	NDCodecJPEGQualityString   "JPEG_QUALITY" /* (int r/w) JPEG Compression quality */
#define	NDCodecBloscCompressorString   "BLOSC_COMPRESSOR" /* (NDCodecBloscComp_t r/w) Which Blosc compressor to use */
#define	NDCodecBloscCLevelString   "BLOSC_CLEVEL" /* (int r/w) Blosc compression level */
#define	NDCodecBloscShuffleString   "BLOSC_SHUFFLE" /* (bool r/w) Should Blosc apply shuffling? */
#define	NDCodecBloscNumThreadsString   "BLOSC_NUMTHREADS" /* (int r/w) Number of threads to be used by Blosc */
#define	FIRST_NDCODEC_PARAM   NDCodecMode

Enumerations
enum	NDCodecMode_t { NDCODEC_COMPRESS, NDCODEC_DECOMPRESS }
	Compress/decompress NDArrays according to available codecs. More...
enum	NDCodecBloscComp_t {   NDCODEC_BLOSC_BLOSCLZ, NDCODEC_BLOSC_LZ4, NDCODEC_BLOSC_LZ4HC, NDCODEC_BLOSC_SNAPPY,   NDCODEC_BLOSC_ZLIB, NDCODEC_BLOSC_ZSTD }
enum	NDCodecStatus_t { NDCODEC_SUCCESS, NDCODEC_WARNING, NDCODEC_ERROR }

Functions
NDArray *	compressJPEG (NDArray *input, int quality, NDCodecStatus_t *status, char *errorMessage)
NDArray *	decompressJPEG (NDArray *input, NDCodecStatus_t *status, char *errorMessage)
NDArray *	compressBlosc (NDArray *input, int clevel, int shuffle, NDCodecBloscComp_t compressor, int numThreads, NDCodecStatus_t *status, char *errorMessage)
NDArray *	decompressBlosc (NDArray *input, int numThreads, NDCodecStatus_t *status, char *errorMessage)
NDArray *	compressLZ4 (NDArray *input, NDCodecStatus_t *status, char *errorMessage)
NDArray *	decompressLZ4 (NDArray *input, NDCodecStatus_t *status, char *errorMessage)
NDArray *	compressBSLZ4 (NDArray *input, NDCodecStatus_t *status, char *errorMessage)
NDArray *	decompressBSLZ4 (NDArray *input, NDCodecStatus_t *status, char *errorMessage)

Macro Definition Documentation

#define FIRST_NDCODEC_PARAM   NDCodecMode

#define NDCodecBloscCLevelString   "BLOSC_CLEVEL" /* (int r/w) Blosc compression level */

#define NDCodecBloscCompressorString   "BLOSC_COMPRESSOR" /* (NDCodecBloscComp_t r/w) Which Blosc compressor to use */

#define NDCodecBloscNumThreadsString   "BLOSC_NUMTHREADS" /* (int r/w) Number of threads to be used by Blosc */

#define NDCodecBloscShuffleString   "BLOSC_SHUFFLE" /* (bool r/w) Should Blosc apply shuffling? */

#define NDCodecCodecErrorString   "CODEC_ERROR" /* (string r/o) Error message if compression fails */

#define NDCodecCodecStatusString   "CODEC_STATUS" /* (int r/o) Compression status: success or failure */

#define NDCodecCompFactorString   "COMP_FACTOR" /* (double r/o) Compression percentage (0 = no compression) */

#define NDCodecCompressorString   "COMPRESSOR" /* (NDCodecCompressor_t r/w) Which codec to use */

#define NDCodecJPEGQualityString   "JPEG_QUALITY" /* (int r/w) JPEG Compression quality */

#define NDCodecModeString   "MODE" /* (NDCodecMode_t r/w) Mode: Compress/Decompress */

Enumeration Type Documentation

enum NDCodecBloscComp_t

Enumerator
NDCODEC_BLOSC_BLOSCLZ
NDCODEC_BLOSC_LZ4
NDCODEC_BLOSC_LZ4HC
NDCODEC_BLOSC_SNAPPY
NDCODEC_BLOSC_ZLIB
NDCODEC_BLOSC_ZSTD

enum NDCodecMode_t

Compress/decompress NDArrays according to available codecs.

This plugin is a source of NDArray callbacks, passing the (possibly compressed/decompressed) NDArray data to clients that register for callbacks. The plugin currently supports the following codecs (if available at compile time):

• JPEG
• Blosc

Enumerator
NDCODEC_COMPRESS
NDCODEC_DECOMPRESS

enum NDCodecStatus_t

Enumerator
NDCODEC_SUCCESS
NDCODEC_WARNING
NDCODEC_ERROR

Function Documentation

NDArray* compressBlosc	(	NDArray *	input,
		int	clevel,
		int	shuffle,
		NDCodecBloscComp_t	compressor,
		int	numThreads,
		NDCodecStatus_t *	status,
		char *	errorMessage
	)

NDArray* compressBSLZ4	(	NDArray *	input,
		NDCodecStatus_t *	status,
		char *	errorMessage
	)

NDArray* compressJPEG	(	NDArray *	input,
		int	quality,
		NDCodecStatus_t *	status,
		char *	errorMessage
	)

NDArray* compressLZ4	(	NDArray *	input,
		NDCodecStatus_t *	status,
		char *	errorMessage
	)

NDArray* decompressBlosc	(	NDArray *	input,
		int	numThreads,
		NDCodecStatus_t *	status,
		char *	errorMessage
	)

NDArray* decompressBSLZ4	(	NDArray *	input,
		NDCodecStatus_t *	status,
		char *	errorMessage
	)

NDArray* decompressJPEG	(	NDArray *	input,
		NDCodecStatus_t *	status,
		char *	errorMessage
	)

NDArray* decompressLZ4	(	NDArray *	input,
		NDCodecStatus_t *	status,
		char *	errorMessage
	)