OpenJPH
Open-source implementation of JPEG2000 Part-15
ojph_codeblock_fun.h
Go to the documentation of this file.
1//***************************************************************************/
2// This software is released under the 2-Clause BSD license, included
3// below.
4//
5// Copyright (c) 2019, Aous Naman
6// Copyright (c) 2019, Kakadu Software Pty Ltd, Australia
7// Copyright (c) 2019, The University of New South Wales, Australia
8//
9// Redistribution and use in source and binary forms, with or without
10// modification, are permitted provided that the following conditions are
11// met:
12//
13// 1. Redistributions of source code must retain the above copyright
14// notice, this list of conditions and the following disclaimer.
15//
16// 2. Redistributions in binary form must reproduce the above copyright
17// notice, this list of conditions and the following disclaimer in the
18// documentation and/or other materials provided with the distribution.
19//
20// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
21// IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
23// PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24// HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
26// TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
27// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
28// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
29// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
30// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31//***************************************************************************/
32// This file is part of the OpenJPH software implementation.
33// File: ojph_codeblock_fun.h
34// Author: Aous Naman
35// Date: 28 August 2019
36//***************************************************************************/
37
38
39#ifndef OJPH_CODEBLOCK_FUN_H
40#define OJPH_CODEBLOCK_FUN_H
41
42#include "ojph_defs.h"
43#include "ojph_file.h"
44#include "ojph_params_local.h"
45
46namespace ojph {
47
48 namespace local {
49
50 // define function signature simple memory clearing
51 typedef void (*mem_clear_fun)(void* addr, size_t count);
52
53 // define function signature for max value finding
54 typedef ui32 (*find_max_val_fun)(ui32* addr);
55
56 // define line transfer function signature from subbands to codeblocks
57 typedef void (*tx_to_cb_fun)(const void *sp, ui32 *dp, ui32 K_max,
58 float delta_inv, ui32 count, ui32* max_val);
59
60 // define line transfer function signature from codeblock to subband
61 typedef void (*tx_from_cb_fun)(const ui32 *sp, void *dp, ui32 K_max,
62 float delta, ui32 count);
63
64 // define the block decoder function signature
65 typedef bool (*cb_decoder_fun)(ui8* coded_data, ui32* decoded_data,
66 ui32 missing_msbs, ui32 num_passes, ui32 lengths1, ui32 lengths2,
67 ui32 width, ui32 height, ui32 stride, bool stripe_causal);
68
69 // define the block encoder function signature
70 typedef void (*cb_encoder_fun)(ui32* buf, ui32 missing_msbs,
71 ui32 num_passes, ui32 width, ui32 height, ui32 stride,
72 ui32* lengths, ojph::mem_elastic_allocator* elastic,
73 ojph::coded_lists*& coded);
74
77
78 void init(bool reversible);
79
80 // a pointer to the max value finding function
82
83 // a pointer to the max value finding function
85
86 // a pointer to function transferring samples from subbands to codeblocks
88
89 // a pointer to function transferring samples from codeblocks to subbands
91
92 // a pointer to the decoder function
94
95 // a pointer to the encoder function
97 };
98
99 }
100}
101#endif // !OJPH_CODEBLOCK_FUN_H
void(* cb_encoder_fun)(ui32 *buf, ui32 missing_msbs, ui32 num_passes, ui32 width, ui32 height, ui32 stride, ui32 *lengths, ojph::mem_elastic_allocator *elastic, ojph::coded_lists *&coded)
void(* tx_from_cb_fun)(const ui32 *sp, void *dp, ui32 K_max, float delta, ui32 count)
bool(* cb_decoder_fun)(ui8 *coded_data, ui32 *decoded_data, ui32 missing_msbs, ui32 num_passes, ui32 lengths1, ui32 lengths2, ui32 width, ui32 height, ui32 stride, bool stripe_causal)
void(* tx_to_cb_fun)(const void *sp, ui32 *dp, ui32 K_max, float delta_inv, ui32 count, ui32 *max_val)
ui32(* find_max_val_fun)(ui32 *addr)
void(* mem_clear_fun)(void *addr, size_t count)
uint32_t ui32
Definition: ojph_defs.h:54
uint8_t ui8
Definition: ojph_defs.h:50