Cleanup of constant and macro definitions.

This commit is contained in:
Patrick Vogler 2024-02-22 17:20:38 +01:00
parent eae976b9ba
commit e3dcc28902
Signed by: Patrick Vogler
GPG key ID: 5536B08CE82E8509
4 changed files with 120 additions and 263 deletions

View file

@ -48,252 +48,59 @@
! DESCRIPTION: ! ! DESCRIPTION: !
! ------------ ! ! ------------ !
! ! ! !
! These constants are used to identify the spatial and temporal dimensions. ! ! These constants are used to signal spatial or temporal the wavelet filter. !
! ! ! !
\*----------------------------------------------------------------------------------------------*/ \*----------------------------------------------------------------------------------------------*/
#define DIM_X 1 // 1st Spatial Dimension. typedef enum
#define DIM_Y 2 // 2nd Spatial Dimension. {
#define DIM_Z 4 // 3rd Spatial Dimension. bwc_dwt_9_7, // Cohen Daubechies Feauveau 9/7 Wavelet
#define DIM_TS 8 // Temporal Dimension. bwc_dwt_5_3, // LeGall 5/3 Wavelet
#define DIM_ALL 15 // All Dimensions. bwc_dwt_haar // Haar Wavelet
/*----------------------------------------------------------------------------------------------------------*\
! DESCRIPTION: !
! ------------ !
! !
! These constants describe the maximum allowable wavelet decompositions for the spatial and !
! temporal dimensions and the maximum allowable subbands. !
! !
! DEVELOPMENT HISTORY: !
! -------------------- !
! !
! Date Author Change Id Release Description Of Change !
! ---- ------ --------- ------- --------------------- !
! 01.12.2017 Patrick Vogler B87D120 V 0.1.0 Constants created !
\*----------------------------------------------------------------------------------------------------------*/
#define MAXIMUM_NUMBER_OF_SPATIAL_DECOMP 64
#define MAXIMUM_NUMBER_OF_TEMPORAL_DECOMP 32
#define MAXIMUM_NUMBER_OF_SUBBANDS (1+(15*(64-32))) + (1+(7*32))
/*----------------------------------------------------------------------------------------------------------*\
! DESCRIPTION: !
! ------------ !
! !
! These Constants describe the codestream markers used to create the embedded codestream. !
! !
! CONSTANTS: !
! ----------- !
! Constant Description !
! -------- ----------- !
! SOC - Start of code-stream !
! SGI - Global data-set information !
! SGC - Global control parameters !
! SAX - Auxiliary data-set information !
! TLM - Packet lengths: main header !
! PLM - Packet lengths: tile-part !
! PPM - Quantization default !
! COM - Comment !
! EOH - End of header !
! PLT - Packed packet headers: main header !
! PPT - Packed packet headers: tile-part !
! SOT - Start of tile !
! SOP - Start of packet !
! EPH - End of packet header !
! SOD - Start of data !
! EOC - End of code-stream !
! !
! DEVELOPMENT HISTORY: !
! -------------------- !
! !
! Date Author Change Id Release Description Of Change !
! ---- ------ --------- ------- --------------------- !
! 01.12.2017 Patrick Vogler B87D120 V 0.1.0 Constants created !
\*----------------------------------------------------------------------------------------------------------*/
#define SOC 0xFF50
#define SGI 0xFF51
#define SGC 0xFF52
#define SAX 0xFF53
#define TLM 0xFF54
#define PLM 0xFF55
#define PPM 0xFF56
#define COM 0xFF57
#define EOH 0xFF58
#define PLT 0xFF60
#define PPT 0xFF61
#define SOT 0xFF90
#define SOP 0xFF91
#define EPH 0xFF92
#define SOD 0xFF93
#define EOC 0xFFFF
/*----------------------------------------------------------------------------------------------------------*\
! DESCRIPTION: !
! ------------ !
! !
! These Constants are used for codestream parsing. !
! !
! CONSTANTS: !
! ----------- !
! Constant Description !
! -------- ----------- !
! CODESTREAM_OK No errors detectet in Codestream !
! CODESTREAM_ERROR Error detectet in Codestream !
! CODESTREAM_SGI_READ Global data-set information read !
! CODESTREAM_SGC_READ Global control parameters read !
! !
! DEVELOPMENT HISTORY: !
! -------------------- !
! !
! Date Author Change Id Release Description Of Change !
! ---- ------ --------- ------- --------------------- !
! 01.08.2019 Patrick Vogler B87D120 V 0.1.0 Constants created !
\*----------------------------------------------------------------------------------------------------------*/
#define CODESTREAM_OK 0x00
#define CODESTREAM_ERROR 0x80
#define CODESTREAM_SGI_READ 0x01
#define CODESTREAM_SGC_READ 0x02
#define CODESTREAM_SAX_READ 0x04
#define CODESTREAM_COM_READ 0x08
/*----------------------------------------------------------------------------------------------------------*\
! ENUM NAME: bwc_dwt_filter !
! ----------- !
! !
! DESCRIPTION: !
! ------------ !
! !
! These constants describe the wavelet filter used during the transform stage. !
! !
! PARAMETERS: !
! ----------- !
! Constant Description !
! -------- ----------- !
! bwc_dwt_9_7 - Cohen Daubechies Feauveau 9/7 Wavelet !
! bwc_dwt_5_3 - LeGall 5/3 Wavelet !
! bwc_dwt_haar - Haar Wavelet !
! !
! DEVELOPMENT HISTORY: !
! -------------------- !
! !
! Date Author Change Id Release Description Of Change !
! ---- ------ --------- ------- --------------------- !
! 07.12.2017 Patrick Vogler B87D120 V 0.1.0 Enum created !
! !
\*----------------------------------------------------------------------------------------------------------*/
typedef enum{
bwc_dwt_9_7,
bwc_dwt_5_3,
bwc_dwt_haar
} bwc_dwt_filter; } bwc_dwt_filter;
/*----------------------------------------------------------------------------------------------------------*\ /*----------------------------------------------------------------------------------------------*\
! ENUM NAME: bwc_prog_ord !
! ----------- !
! ! ! !
! DESCRIPTION: ! ! DESCRIPTION: !
! ------------ ! ! ------------ !
! ! ! !
! These constants describe the progression order used to pack the codestream. ! ! These constants are used to signal the packing order of the codestream. !
! The organisation of the codesstream is carried out according to the following 5 cases. !
! ! ! !
! LRCP: RLCP: ! \*----------------------------------------------------------------------------------------------*/
! ----- for each Quality Layer: ----- for each Resolution: ! typedef enum
! for each Resolution: for each Quality Layer: ! {
! for each Parameter: for each Parameter: ! bwc_prog_LRCP, // Layer / Resolution / Parameter / Packet
! for each Precinct: for each Precinct: ! bwc_prog_RLCP, // Resolution / Layer / Parameter / Packet
! include Packet include Packet ! bwc_prog_RPCL, // Resolution / Packet / Parameter / Layer
! ! bwc_prog_PCRL, // Packet / Parameter / Resolution / Layer
! RPCL: PCRL: ! bwc_prog_CPRL // Parameter / Packet / Resolution / Layer
! ----- for each Resolution: ----- for each Precinct: !
! for each Precinct: for each Parameter: !
! for each Parameter: for each Resolution: !
! for each Quality Layer: for each Quality Layer: !
! include Packet include Packet !
! !
! CPRL: !
! ----- for each Quality Layer: !
! for each Resolution: !
! for each Parameter: !
! for each Precinct: !
! include Packet !
! !
! PARAMETERS: !
! ----------- !
! Constant Description !
! -------- ----------- !
! bwc_prog_LRCP - LRCP progression order !
! bwc_prog_RLCP - RLCP progression order !
! bwc_prog_RPCL - RPCL progression order !
! bwc_prog_PCRL - PCRL progression order !
! bwc_prog_CPRL - CPRL progression order !
! !
! DEVELOPMENT HISTORY: !
! -------------------- !
! !
! Date Author Change Id Release Description Of Change !
! ---- ------ --------- ------- --------------------- !
! 07.12.2017 Patrick Vogler B87D120 V 0.1.0 Enum created !
! !
\*----------------------------------------------------------------------------------------------------------*/
typedef enum{
bwc_prog_LRCP,
bwc_prog_RLCP,
bwc_prog_RPCL,
bwc_prog_PCRL,
bwc_prog_CPRL
} bwc_prog_ord; } bwc_prog_ord;
/*----------------------------------------------------------------------------------------------------------*\ /*----------------------------------------------------------------------------------------------*\
! ENUM NAME: bwc_quant_st !
! ----------- !
! ! ! !
! DESCRIPTION: ! ! DESCRIPTION: !
! ------------ ! ! ------------ !
! DESCRIPTION NEEDED !
! ! ! !
! PARAMETERS: ! ! These constants are used to signal the quantisation style during !
! ----------- ! ! (de)coompression. !
! Constant Description !
! -------- ----------- !
! - - !
! ! ! !
! DEVELOPMENT HISTORY: ! \*----------------------------------------------------------------------------------------------*/
! -------------------- ! typedef enum
! ! {
! Date Author Change Id Release Description Of Change ! bwc_qt_none, // No quantization
! ---- ------ --------- ------- --------------------- ! bwc_qt_derived, // Derrived according to Taubman/Marcellin
! 07.12.2017 Patrick Vogler B87D120 V 0.1.0 Enum created !
! !
\*----------------------------------------------------------------------------------------------------------*/
typedef enum{
bwc_qt_none,
bwc_qt_derived,
} bwc_quant_st; } bwc_quant_st;
/*----------------------------------------------------------------------------------------------------------*\ /*----------------------------------------------------------------------------------------------*\
! ENUM NAME: bwc_tile_instr !
! ----------- !
! ! ! !
! DESCRIPTION: ! ! DESCRIPTION: !
! ------------ ! ! ------------ !
! DESCRIPTION NEEDED !
! ! ! !
! PARAMETERS: ! ! These constants are used to signal dataset tiling by the function caller. !
! ----------- !
! Constant Description !
! -------- ----------- !
! - - !
! ! ! !
! DEVELOPMENT HISTORY: ! \*----------------------------------------------------------------------------------------------*/
! -------------------- ! typedef enum
! ! {
! Date Author Change Id Release Description Of Change ! bwc_tile_sizeof, // Tiling defined by size of one tile
! ---- ------ --------- ------- --------------------- ! bwc_tile_numbof, // Tiling defined by the number of tiles
! 17.04.2019 Patrick Vogler B87D120 V 0.1.0 Enum created !
! !
\*----------------------------------------------------------------------------------------------------------*/
typedef enum{
bwc_tile_sizeof,
bwc_tile_numbof,
} bwc_tile_instr; } bwc_tile_instr;
#endif #endif

View file

@ -43,6 +43,61 @@
\*================================================================================================*/ \*================================================================================================*/
#ifndef BWC_MACROSS_H #ifndef BWC_MACROSS_H
#define BWC_MACROSS_H #define BWC_MACROSS_H
/*----------------------------------------------------------------------------------------------*\
! !
! DESCRIPTION: !
! ------------ !
! !
! These constants are used to identify the spatial and temporal dimensions. !
! !
\*----------------------------------------------------------------------------------------------*/
#define DIM_X 1 // 1st. spacial direction
#define DIM_Y 2 // 2nd. spacial direction
#define DIM_Z 4 // 3rd. spacial direction
#define DIM_TS 8 // temporal direction
#define DIM_ALL 15 // all dimensions
/*----------------------------------------------------------------------------------------------*\
! !
! DESCRIPTION: !
! ------------ !
! !
! These Constants define codestream markers used to create the embedded codestream. !
! !
\*----------------------------------------------------------------------------------------------*/
#define SOC 0xFF50 // Start of codestream
#define SGI 0xFF51 // Global data-set information
#define SGC 0xFF52 // Global control parameters
#define SAX 0xFF53 // Auxiliary data-set information
#define TLM 0xFF54 // Packet lengths: main header
#define PLM 0xFF55 // Packet lengths: tile-part
#define PPM 0xFF56 // Quantization default
#define COM 0xFF57 // Comment
#define EOH 0xFF58 // End of header
#define PLT 0xFF60 // Packed packet headers: main header
#define PPT 0xFF61 // Packed packet headers: tile-part
#define SOT 0xFF90 // Start of tile
#define SOP 0xFF91 // Start of packet
#define EPH 0xFF92 // End of packet header
#define SOD 0xFF93 // Start of data
#define EOC 0xFFFF // End of code-stream
/*----------------------------------------------------------------------------------------------*\
! !
! DESCRIPTION: !
! ------------ !
! !
! These macros define flags used for codestream parsing. !
! !
\*----------------------------------------------------------------------------------------------*/
#define CODESTREAM_OK 0x00 // No errors detected in Codestream
#define CODESTREAM_ERROR 0x80 // Error detexted in Codestream
#define CODESTREAM_SGI_READ 0x01 // Global data-set information read
#define CODESTREAM_SGC_READ 0x02 // Global control parameters read
#define CODESTREAM_SAX_READ 0x08 // Auxiliary information block read
#define CODESTREAM_COM_READ 0x10 // Comment block read
/*----------------------------------------------------------------------------------------------*\ /*----------------------------------------------------------------------------------------------*\
! ! ! !
! DESCRIPTION: ! ! DESCRIPTION: !

View file

@ -150,24 +150,19 @@
uchar *compressed; // Compressed data chunck. uchar *compressed; // Compressed data chunck.
} bwc_coder; } bwc_coder;
/************************************************************************************************************\ /************************************************************************************************\
|| ___ _ _ ___ _ _ ____ ____ _ _ _ _ ____ ___ _ ____ _ _ ____ || || ___ _ _ ___ _ _ ____ ____ _ _ _ _ ____ ___ _ ____ _ _ ____ ||
|| |__] | | |__] | | | |___ | | |\ | | | | | | |\ | [__ || || |__] | | |__] | | | |___ | | |\ | | | | | | |\ | [__ ||
|| | |__| |__] |___ | |___ | |__| | \| |___ | | |__| | \| ___] || || | |__| |__] |___ | |___ | |__| | \| |___ | | |__| | \| ___] ||
|| || || ||
\************************************************************************************************************/ \************************************************************************************************/
/*----------------------------------------------------------------------------------------------------------*\ uchar t1_encode (bwc_field *const field,
! TYPE NAME: Template ! bwc_tile *const tile,
! ----------- ! bwc_parameter *const parameter);
! ! //==========|==========================|======================|======|=======|====================
! DESCRIPTION: ! uchar t1_decode (bwc_field *const field,
! ------------ ! bwc_tile *const tile,
! DESCRIPTION NEEDED ! bwc_parameter *const parameter);
! !
\*----------------------------------------------------------------------------------------------------------*/
uchar
t1_encode(bwc_field *const field, bwc_tile *const tile, bwc_parameter *const parameter);
uchar
t1_decode(bwc_field *const field, bwc_tile *const tile, bwc_parameter *const parameter);
#endif #endif

View file

@ -330,7 +330,7 @@ public_header.write("\n" + ubox + tab + sbox + lspaces * " " + "___ _ _ ___ _
tab + sbox + (text_width - 2*len(sbox) - len(tab)) * " " + "||\n" + lbox) tab + sbox + (text_width - 2*len(sbox) - len(tab)) * " " + "||\n" + lbox)
public_header.write(tab + "#ifdef __cplusplus\n" + public_header.write(tab + "#ifdef __cplusplus\n" +
tab + "extern \"C\" {\n" + tab + tab + "extern \"C\" {\n" +
tab + "#endif\n\n") tab + "#endif\n\n")
files = os.listdir("include/library/private") files = os.listdir("include/library/private")
@ -369,7 +369,7 @@ for file in files:
f.close f.close
public_header.write("\n" + tab + "#ifdef __cplusplus\n" + public_header.write("\n" + tab + "#ifdef __cplusplus\n" +
tab + "}\n" + tab + tab + "}\n" +
tab + "#endif\n") tab + "#endif\n")
public_header.write("#endif") public_header.write("#endif")