OpenJPH: /build/openjph/src/OpenJPH/src/core/codestream/ojph_codeblock_fun.h Source File

OpenJPH Open-source implementation of JPEG2000 Part-15

Loading...
Searching...
No Matches
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_fun32)(ui32* addr);
55
56 typedef ui64 (*find_max_val_fun64)(ui64* addr);
57
58 // define line transfer function signature from subbands to codeblocks
59 typedef void (*tx_to_cb_fun32)(const void *sp, ui32 *dp, ui32 K_max,
60 float delta_inv, ui32 count, ui32* max_val);
61
62 typedef void (*tx_to_cb_fun64)(const void *sp, ui64 *dp, ui32 K_max,
63 float delta_inv, ui32 count, ui64* max_val);
64
65 // define line transfer function signature from codeblock to subband
66 typedef void (*tx_from_cb_fun32)(const ui32 *sp, void *dp, ui32 K_max,
67 float delta, ui32 count);
68
69 typedef void (*tx_from_cb_fun64)(const ui64 *sp, void *dp, ui32 K_max,
70 float delta, ui32 count);
71
72 // define the block decoder function signature
73 typedef bool (*cb_decoder_fun32)(ui8* coded_data, ui32* decoded_data,
74 ui32 missing_msbs, ui32 num_passes, ui32 lengths1, ui32 lengths2,
75 ui32 width, ui32 height, ui32 stride, bool stripe_causal);
76
77 typedef bool (*cb_decoder_fun64)(ui8* coded_data, ui64* decoded_data,
78 ui32 missing_msbs, ui32 num_passes, ui32 lengths1, ui32 lengths2,
79 ui32 width, ui32 height, ui32 stride, bool stripe_causal);
80
81 // define the block encoder function signature
82 typedef void (*cb_encoder_fun32)(ui32* buf, ui32 missing_msbs,
83 ui32 num_passes, ui32 width, ui32 height, ui32 stride,
84 ui32* lengths, ojph::mem_elastic_allocator* elastic,
85 ojph::coded_lists*& coded);
86
87 typedef void (*cb_encoder_fun64)(ui64* buf, ui32 missing_msbs,
88 ui32 num_passes, ui32 width, ui32 height, ui32 stride,
89 ui32* lengths, ojph::mem_elastic_allocator* elastic,
90 ojph::coded_lists*& coded);
91
93 struct codeblock_fun {
94
95 void init(bool reversible);
96
97 // a pointer to the max value finding function
98 mem_clear_fun mem_clear;
99
100 // a pointer to the max value finding function
101 find_max_val_fun32 find_max_val32;
102 find_max_val_fun64 find_max_val64;
103
104 // a pointer to function transferring samples from subbands to codeblocks
105 tx_to_cb_fun32 tx_to_cb32;
106 tx_to_cb_fun64 tx_to_cb64;
107
108 // a pointer to function transferring samples from codeblocks to subbands
109 tx_from_cb_fun32 tx_from_cb32;
110 tx_from_cb_fun64 tx_from_cb64;
111
112 // a pointer to the decoder function
113 cb_decoder_fun32 decode_cb32;
114 cb_decoder_fun64 decode_cb64;
115
116 // a pointer to the encoder function
117 cb_encoder_fun32 encode_cb32;
118 cb_encoder_fun64 encode_cb64;
119 };
120
121 }
122}
123#endif // !OJPH_CODEBLOCK_FUN_H
ojph::mem_elastic_allocator
Definition ojph_mem.h:218
ojph::local
Definition ojph_bitbuffer_read.h:52
ojph::local::tx_to_cb_fun64
void(* tx_to_cb_fun64)(const void *sp, ui64 *dp, ui32 K_max, float delta_inv, ui32 count, ui64 *max_val)
Definition ojph_codeblock_fun.h:62
ojph::local::tx_from_cb_fun32
void(* tx_from_cb_fun32)(const ui32 *sp, void *dp, ui32 K_max, float delta, ui32 count)
Definition ojph_codeblock_fun.h:66
ojph::local::find_max_val_fun64
ui64(* find_max_val_fun64)(ui64 *addr)
Definition ojph_codeblock_fun.h:56
ojph::local::cb_encoder_fun64
void(* cb_encoder_fun64)(ui64 *buf, ui32 missing_msbs, ui32 num_passes, ui32 width, ui32 height, ui32 stride, ui32 *lengths, ojph::mem_elastic_allocator *elastic, ojph::coded_lists *&coded)
Definition ojph_codeblock_fun.h:87
ojph::local::find_max_val_fun32
ui32(* find_max_val_fun32)(ui32 *addr)
Definition ojph_codeblock_fun.h:54
ojph::local::tx_to_cb_fun32
void(* tx_to_cb_fun32)(const void *sp, ui32 *dp, ui32 K_max, float delta_inv, ui32 count, ui32 *max_val)
Definition ojph_codeblock_fun.h:59
ojph::local::cb_encoder_fun32
void(* cb_encoder_fun32)(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)
Definition ojph_codeblock_fun.h:82
ojph::local::tx_from_cb_fun64
void(* tx_from_cb_fun64)(const ui64 *sp, void *dp, ui32 K_max, float delta, ui32 count)
Definition ojph_codeblock_fun.h:69
ojph::local::mem_clear_fun
void(* mem_clear_fun)(void *addr, size_t count)
Definition ojph_codeblock_fun.h:51
ojph::local::cb_decoder_fun64
bool(* cb_decoder_fun64)(ui8 *coded_data, ui64 *decoded_data, ui32 missing_msbs, ui32 num_passes, ui32 lengths1, ui32 lengths2, ui32 width, ui32 height, ui32 stride, bool stripe_causal)
Definition ojph_codeblock_fun.h:77
ojph::local::cb_decoder_fun32
bool(* cb_decoder_fun32)(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)
Definition ojph_codeblock_fun.h:73
ojph
Definition ojph_img_io.h:52
ojph::ui64
uint64_t ui64
Definition ojph_defs.h:56
ojph::ui32
uint32_t ui32
Definition ojph_defs.h:54
ojph::ui8
uint8_t ui8
Definition ojph_defs.h:50
ojph_defs.h
ojph_file.h
ojph_params_local.h
ojph::coded_lists
Definition ojph_mem.h:202
ojph::local::codeblock_fun
Definition ojph_codeblock_fun.h:93
ojph::local::codeblock_fun::tx_to_cb64
tx_to_cb_fun64 tx_to_cb64
Definition ojph_codeblock_fun.h:106
ojph::local::codeblock_fun::encode_cb64
cb_encoder_fun64 encode_cb64
Definition ojph_codeblock_fun.h:118
ojph::local::codeblock_fun::init
void init(bool reversible)
Definition ojph_codeblock_fun.cpp:130
ojph::local::codeblock_fun::find_max_val32
find_max_val_fun32 find_max_val32
Definition ojph_codeblock_fun.h:101
ojph::local::codeblock_fun::tx_from_cb32
tx_from_cb_fun32 tx_from_cb32
Definition ojph_codeblock_fun.h:109
ojph::local::codeblock_fun::tx_to_cb32
tx_to_cb_fun32 tx_to_cb32
Definition ojph_codeblock_fun.h:105
ojph::local::codeblock_fun::find_max_val64
find_max_val_fun64 find_max_val64
Definition ojph_codeblock_fun.h:102
ojph::local::codeblock_fun::decode_cb32
cb_decoder_fun32 decode_cb32
Definition ojph_codeblock_fun.h:113
ojph::local::codeblock_fun::encode_cb32
cb_encoder_fun32 encode_cb32
Definition ojph_codeblock_fun.h:117
ojph::local::codeblock_fun::mem_clear
mem_clear_fun mem_clear
Definition ojph_codeblock_fun.h:98
ojph::local::codeblock_fun::decode_cb64
cb_decoder_fun64 decode_cb64
Definition ojph_codeblock_fun.h:114
ojph::local::codeblock_fun::tx_from_cb64
tx_from_cb_fun64 tx_from_cb64
Definition ojph_codeblock_fun.h:110