TOPIO/BigWhoop
TOPIO/BigWhoop
4
1
Fork 0
Code Issues 26 Pull requests 1 Projects 6 Releases Packages Wiki Activity
BigWhoop/include/library/private/libbwc.h

163 lines
14 KiB
C
Raw Normal View History

Ported Header files to new coding standard.
2024-02-22 10:27:40 +00:00
/*================================================================================================*\
|| ||
|| /$$$$$$$ /$$ /$$ /$$ /$$ ||
|| | $$__ $$|__/ | $$ /$ | $$| $$ ||
|| | $$ \ $$ /$$ /$$$$$$ | $$ /$$$| $$| $$$$$$$ /$$$$$$ /$$$$$$ /$$$$$$ ||
|| | $$$$$$$ | $$ /$$__ $$ | $$/$$ $$ $$| $$__ $$ /$$__ $$ /$$__ $$ /$$__ $$ ||
|| | $$__ $$| $$| $$ \ $$ | $$$$_ $$$$| $$ \ $$| $$ \ $$| $$ \ $$| $$ \ $$ ||
|| | $$ \ $$| $$| $$ | $$ | $$$/ \ $$$| $$ | $$| $$ | $$| $$ | $$| $$ | $$ ||
|| | $$$$$$$/| $$| $$$$$$$ | $$/ \ $$| $$ | $$| $$$$$$/| $$$$$$/| $$$$$$$/ ||
|| |_______/ |__/ \____ $$ |__/ \__/|__/ |__/ \______/ \______/ | $$____/ ||
|| /$$ \ $$ | $$ ||
|| | $$$$$$/ | $$ ||
|| \______/ |__/ ||
|| ||
|| DESCRIPTION: ||
|| ------------ ||
|| ||
|| Big Whoop is a compression codec for the lossy compression of IEEE 754 floating ||
|| point arrays defined on curvelinear compute grids. ||
|| ||
|| -------------------------------------------------------------------------------------------- ||
|| Copyright (c) 2023, High Performance Computing Center - University of Stuttgart ||
|| ||
|| Redistribution and use in source and binary forms, with or without modification, are ||
|| permitted provided that the following conditions are met: ||
|| ||
|| (1) Redistributions of source code must retain the above copyright notice, this list of ||
|| conditions and the following disclaimer. ||
|| ||
|| (2) Redistributions in binary form must reproduce the above copyright notice, this list ||
|| of conditions and the following disclaimer in the documentation and/or other ||
|| materials provided with the distribution. ||
|| ||
|| THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS ||
|| OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF ||
|| MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE ||
|| COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, ||
|| EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF ||
|| SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) ||
|| HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR ||
|| TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, ||
|| EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ||
|| ||
\*================================================================================================*/
#ifndef LIBBWC_H
#define LIBBWC_H
/************************************************************************************************\
|| _ _ _ ____ _ _ _ ___ ____ ||
|| | |\ | | | | | | \ |___ ||
|| | | \| |___ |___ |__| |__/ |___ ||
|| ||
\************************************************************************************************/
#include "bitstream.h"
#include "codestream.h"
#include "constants.h"
#include "macros.h"
#include "mq_types.h"
#include "types.h"
/************************************************************************************************\
|| ___ _ _ ___ _ _ ____ ____ _ _ _ _ ____ ___ _ ____ _ _ ____ ||
|| |__] | | |__] | | | |___ | | |\ | | | | | | |\ | [__ ||
|| | |__| |__] |___ | |___ | |__| | \| |___ | | |__| | \| ___] ||
|| ||
\************************************************************************************************/
//==========|==========================|======================|======|=======|====================
Symmetrize API for compression and decompression to follow - allocate codec - initialize stream (using input data/codestream and output buffer from user) - create (de-)compression - run (de-)compression
2024-06-28 14:37:19 +00:00
bwc_stream* bwc_init_stream (void *const inpbuf,
void *const outbuf,
bwc_mode const mode);
Ported Header files to new coding standard.
2024-02-22 10:27:40 +00:00
//==========|==========================|======================|======|=======|====================
Symmetrize API for compression and decompression to follow - allocate codec - initialize stream (using input data/codestream and output buffer from user) - create (de-)compression - run (de-)compression
2024-06-28 14:37:19 +00:00
uchar bwc_set_com (bwc_stream *const stream,
Combined the assemble_main_header and codestream_write_header function and added the codestreamSize value as a length identifier to the Start of Code-Stream (SOC) marker to allow for proper decompression without the user having to supply the codestreamSize through an API call. Functions to append com and aux header blocks have been removed and functionality is now provided by codestream_write_header function.
2024-06-25 18:54:44 +00:00
char const *const com,
uint16 const size);
//==========|==========================|======================|======|=======|====================
Symmetrize API for compression and decompression to follow - allocate codec - initialize stream (using input data/codestream and output buffer from user) - create (de-)compression - run (de-)compression
2024-06-28 14:37:19 +00:00
uchar bwc_set_aux (bwc_stream *const stream,
Combined the assemble_main_header and codestream_write_header function and added the codestreamSize value as a length identifier to the Start of Code-Stream (SOC) marker to allow for proper decompression without the user having to supply the codestreamSize through an API call. Functions to append com and aux header blocks have been removed and functionality is now provided by codestream_write_header function.
2024-06-25 18:54:44 +00:00
char const *const aux,
uint32 const size);
//==========|==========================|======================|======|=======|====================
rename field->codec for bwc_codec variables
2024-10-09 09:49:22 +00:00
uchar create_codec (bwc_codec *const codec);
Ported Header files to new coding standard.
2024-02-22 10:27:40 +00:00
//==========|==========================|======================|======|=======|====================
Symmetrize API for compression and decompression to follow - allocate codec - initialize stream (using input data/codestream and output buffer from user) - create (de-)compression - run (de-)compression
2024-06-28 14:37:19 +00:00
bwc_codec* configure_codec (bwc_codec *const codec,
Reorganize bwc_field and bwc_data to split codec settings and data stream semantically into data structures `bwc_codec` and `bwc_stream`. Cleaning up by removal of redundant information like parameter linked list, file extension, and file pointer including associated functionality. Start constructing an API taking void pointers to the original data for compression.
2024-03-27 16:25:05 +00:00
uint64 const nX,
uint64 const nY,
uint64 const nZ,
uint64 for number of time steps parameter
2024-08-28 10:00:14 +00:00
uint64 const nTS,
Symmetrize API for compression and decompression to follow - allocate codec - initialize stream (using input data/codestream and output buffer from user) - create (de-)compression - run (de-)compression
2024-06-28 14:37:19 +00:00
uint8 const nPar,
bwc_precision const prec);
//==========|==========================|======================|======|=======|====================
bwc_codec* bwc_alloc_coder (uint64 const nX,
uint64 const nY,
uint64 const nZ,
uint64 for number of time steps parameter
2024-08-28 10:00:14 +00:00
uint64 const nTS,
Symmetrize API for compression and decompression to follow - allocate codec - initialize stream (using input data/codestream and output buffer from user) - create (de-)compression - run (de-)compression
2024-06-28 14:37:19 +00:00
uint8 const nPar,
bwc_precision const prec);
//==========|==========================|======================|======|=======|====================
bwc_codec* bwc_alloc_decoder ();
//==========|==========================|======================|======|=======|====================
void bwc_free_codec (bwc_codec *const codec);
Ported Header files to new coding standard.
2024-02-22 10:27:40 +00:00
//==========|==========================|======================|======|=======|====================
rename field->codec for bwc_codec variables
2024-10-09 09:49:22 +00:00
void bwc_set_error_resilience (bwc_codec *const codec);
Ported Header files to new coding standard.
2024-02-22 10:27:40 +00:00
//==========|==========================|======================|======|=======|====================
rename field->codec for bwc_codec variables
2024-10-09 09:49:22 +00:00
void set_quant_style (bwc_codec *const codec,
Ported Header files to new coding standard.
2024-02-22 10:27:40 +00:00
bwc_quant_st const quantization_style);
//==========|==========================|======================|======|=======|====================
rename field->codec for bwc_codec variables
2024-10-09 09:49:22 +00:00
void set_quant_step_size (bwc_codec *const codec,
Ported Header files to new coding standard.
2024-02-22 10:27:40 +00:00
double const delta);
//==========|==========================|======================|======|=======|====================
rename field->codec for bwc_codec variables
2024-10-09 09:49:22 +00:00
void set_progression (bwc_codec *const codec,
Ported Header files to new coding standard.
2024-02-22 10:27:40 +00:00
bwc_prog_ord const progression);
//==========|==========================|======================|======|=======|====================
rename field->codec for bwc_codec variables
2024-10-09 09:49:22 +00:00
void set_kernels (bwc_codec *const codec,
Ported Header files to new coding standard.
2024-02-22 10:27:40 +00:00
bwc_dwt_filter const KernelX,
bwc_dwt_filter const KernelY,
bwc_dwt_filter const KernelZ,
bwc_dwt_filter const KernelTS);
//==========|==========================|======================|======|=======|====================
rename field->codec for bwc_codec variables
2024-10-09 09:49:22 +00:00
void bwc_set_decomp (bwc_codec *const codec,
Ported Header files to new coding standard.
2024-02-22 10:27:40 +00:00
uint8 const decompX,
uint8 const decompY,
uint8 const decompZ,
uint8 const decompTS);
//==========|==========================|======================|======|=======|====================
rename field->codec for bwc_codec variables
2024-10-09 09:49:22 +00:00
void bwc_set_precincts (bwc_codec *const codec,
Ported Header files to new coding standard.
2024-02-22 10:27:40 +00:00
uint8 const pX,
uint8 const pY,
uint8 const pZ,
uint8 const pTS);
//==========|==========================|======================|======|=======|====================
rename field->codec for bwc_codec variables
2024-10-09 09:49:22 +00:00
void bwc_set_codeblocks (bwc_codec *const codec,
Ported Header files to new coding standard.
2024-02-22 10:27:40 +00:00
uint8 const cbX,
uint8 const cbY,
uint8 const cbZ,
uint8 const cbTS);
//==========|==========================|======================|======|=======|====================
rename field->codec for bwc_codec variables
2024-10-09 09:49:22 +00:00
void bwc_set_qm (bwc_codec *const codec,
Ported Header files to new coding standard.
2024-02-22 10:27:40 +00:00
uint8 const Qm);
//==========|==========================|======================|======|=======|====================
rename field->codec for bwc_codec variables
2024-10-09 09:49:22 +00:00
void bwc_set_tiles (bwc_codec *const codec,
Ported Header files to new coding standard.
2024-02-22 10:27:40 +00:00
uint64 const tilesX,
uint64 const tilesY,
uint64 const tilesZ,
uint64 const tilesTS,
bwc_tile_instr const instr);
//==========|==========================|======================|======|=======|====================
open and close header with new header structure
2024-11-04 12:57:33 +00:00
bwc_header* bwc_open_header (void *const inpbuf);
//==========|==========================|======================|======|=======|====================
void bwc_close_header (bwc_header *const header);
//==========|==========================|======================|======|=======|====================
Reorganize bwc_field and bwc_data to split codec settings and data stream semantically into data structures `bwc_codec` and `bwc_stream`. Cleaning up by removal of redundant information like parameter linked list, file extension, and file pointer including associated functionality. Start constructing an API taking void pointers to the original data for compression.
2024-03-27 16:25:05 +00:00
uchar bwc_create_compression (bwc_codec *const codec,
bwc_stream *const data,
Ported Header files to new coding standard.
2024-02-22 10:27:40 +00:00
char *const rate_control);
//==========|==========================|======================|======|=======|====================
rename field->codec for bwc_codec variables
2024-10-09 09:49:22 +00:00
size_t bwc_compress (bwc_codec *const codec,
Reorganize bwc_field and bwc_data to split codec settings and data stream semantically into data structures `bwc_codec` and `bwc_stream`. Cleaning up by removal of redundant information like parameter linked list, file extension, and file pointer including associated functionality. Start constructing an API taking void pointers to the original data for compression.
2024-03-27 16:25:05 +00:00
bwc_stream *const data);
Ported Header files to new coding standard.
2024-02-22 10:27:40 +00:00
//==========|==========================|======================|======|=======|====================
Symmetrize API for compression and decompression to follow - allocate codec - initialize stream (using input data/codestream and output buffer from user) - create (de-)compression - run (de-)compression
2024-06-28 14:37:19 +00:00
uchar bwc_create_decompression (bwc_codec *const codec,
bwc_stream *const stream,
Ported Header files to new coding standard.
2024-02-22 10:27:40 +00:00
uint8 const layer);
//==========|==========================|======================|======|=======|====================
Symmetrize API for compression and decompression to follow - allocate codec - initialize stream (using input data/codestream and output buffer from user) - create (de-)compression - run (de-)compression
2024-06-28 14:37:19 +00:00
uchar bwc_decompress (bwc_codec *const codec,
bwc_stream *const stream);
uint64 for number of time steps parameter
2024-08-28 10:00:14 +00:00
#endif
Reference in a new issue Copy permalink