PGFtypes.h man page

PGFtypes.h — PGF definitions.  

Synopsis

#include 'PGFplatform.h'

Classes

struct PGFMagicVersion
PGF identification and version.
struct PGFPreHeader
PGF pre-header.
struct PGFHeader
PGF header.
struct PGFPostHeader
Optional PGF post-header.
union ROIBlockHeader
Block header used with ROI coding scheme.
struct ROIBlockHeader::RBH
Named ROI block header (part of the union)
struct IOException
PGF exception.
struct PGFRect
Rectangle.

Macros

#define PGFCodecVersion   '6.14.12'
Minor number: Year (2) Week (2)
#define PGFCodecVersionID   0x061412
Codec version ID to use for API check in client implementation.
#define PGFMagic   'PGF'
PGF identification.
#define MaxLevel   30
maximum number of transform levels
#define NSubbands   4
number of subbands per level
#define MaxChannels   8
maximum number of (color) channels
#define DownsampleThreshold   3
if quality is larger than this threshold than downsampling is used
#define ColorTableLen   256
size of color lookup table (clut)
#define Version2   2
data structure PGFHeader of major version 2
#define PGF32   4
32 bit values are used -> allows at maximum 31 bits, otherwise 16 bit values are used -> allows at maximum 15 bits
#define PGFROI   8
supports Regions Of Interest
#define Version5   16
new coding scheme since major version 5
#define Version6   32
new HeaderSize: 32 bits instead of 16 bits
#define PGFVersion   (Version2 | PGF32 | Version5 | Version6)
current standard version
#define BufferSize   16384
must be a multiple of WordWidth
#define RLblockSizeLen   15
block size length (< 16): ld(BufferSize) < RLblockSizeLen <= 2*ld(BufferSize)
#define LinBlockSize   8
side length of a coefficient block in a HH or LL subband
#define InterBlockSize   4
side length of a coefficient block in a HL or LH subband
#define MaxBitPlanes   31
maximum number of bit planes of m_value: 32 minus sign bit
#define MaxBitPlanesLog   5
number of bits to code the maximum number of bit planes (in 32 or 16 bit mode)
#define MaxQuality   MaxBitPlanes
maximum quality
#define MagicVersionSize   sizeof(PGFMagicVersion)
#define PreHeaderSize   sizeof(PGFPreHeader)
#define HeaderSize   sizeof(PGFHeader)
#define ColorTableSize   ColorTableLen*sizeof(RGBQUAD)
#define DataTSize   sizeof(DataT)

Typedefs

typedef INT32 DataT
typedef void(* RefreshCB) (void *p)

Enumerations

enum Orientation { LL =0, HL =1, LH =2, HH =3 }

Detailed Description

PGF definitions.

Author:

C. Stamm

Definition in file PGFtypes.h.

Macro Definition Documentation

#define BufferSize   16384

must be a multiple of WordWidth

Definition at line 77 of file PGFtypes.h.

#define ColorTableLen   256

size of color lookup table (clut)

Definition at line 60 of file PGFtypes.h.

#define ColorTableSize   ColorTableLen*sizeof(RGBQUAD)

Definition at line 232 of file PGFtypes.h.

#define DataTSize   sizeof(DataT)

Definition at line 233 of file PGFtypes.h.

#define DownsampleThreshold   3

if quality is larger than this threshold than downsampling is used

Definition at line 59 of file PGFtypes.h.

#define HeaderSize   sizeof(PGFHeader)

Definition at line 231 of file PGFtypes.h.

#define InterBlockSize   4

side length of a coefficient block in a HL or LH subband

Definition at line 80 of file PGFtypes.h.

#define LinBlockSize   8

side length of a coefficient block in a HH or LL subband

Definition at line 79 of file PGFtypes.h.

#define MagicVersionSize   sizeof(PGFMagicVersion)

Definition at line 229 of file PGFtypes.h.

#define MaxBitPlanes   31

maximum number of bit planes of m_value: 32 minus sign bit

Definition at line 82 of file PGFtypes.h.

#define MaxBitPlanesLog   5

number of bits to code the maximum number of bit planes (in 32 or 16 bit mode)

Definition at line 86 of file PGFtypes.h.

#define MaxChannels   8

maximum number of (color) channels

Definition at line 58 of file PGFtypes.h.

#define MaxLevel   30

maximum number of transform levels

Definition at line 56 of file PGFtypes.h.

#define MaxQuality   MaxBitPlanes

maximum quality

Definition at line 87 of file PGFtypes.h.

#define NSubbands   4

number of subbands per level

Definition at line 57 of file PGFtypes.h.

#define PGF32   4

32 bit values are used -> allows at maximum 31 bits, otherwise 16 bit values are used -> allows at maximum 15 bits

Definition at line 63 of file PGFtypes.h.

#define PGFCodecVersion   '6.14.12'

Minor number: Year (2) Week (2) Major number

Definition at line 48 of file PGFtypes.h.

#define PGFCodecVersionID   0x061412

Codec version ID to use for API check in client implementation.

Definition at line 50 of file PGFtypes.h.

#define PGFMagic   'PGF'

PGF identification.

Definition at line 55 of file PGFtypes.h.

#define PGFROI   8

supports Regions Of Interest

Definition at line 64 of file PGFtypes.h.

#define PGFVersion   (Version2 | PGF32 | Version5 | Version6)

current standard version

Definition at line 69 of file PGFtypes.h.

#define PreHeaderSize   sizeof(PGFPreHeader)

Definition at line 230 of file PGFtypes.h.

#define RLblockSizeLen   15

block size length (< 16): ld(BufferSize) < RLblockSizeLen <= 2*ld(BufferSize)

Definition at line 78 of file PGFtypes.h.

#define Version2   2

data structure PGFHeader of major version 2

Definition at line 62 of file PGFtypes.h.

#define Version5   16

new coding scheme since major version 5

Definition at line 65 of file PGFtypes.h.

#define Version6   32

new HeaderSize: 32 bits instead of 16 bits

Definition at line 66 of file PGFtypes.h.

Typedef Documentation

typedef INT32 DataT

Definition at line 219 of file PGFtypes.h.

typedef void(* RefreshCB) (void *p)

Definition at line 224 of file PGFtypes.h.

Enumeration Type Documentation

enum Orientation

Enumerator

LL

HL

LH

HH

Definition at line 92 of file PGFtypes.h.

92 { LL=0, HL=1, LH=2, HH=3 };

Author

Generated automatically by Doxygen for libpgf from the source code.

Info

Thu Aug 3 2017 Version 6.14.12 libpgf