OpenJPH
Open-source implementation of JPEG2000 Part-15
ojph_codestream_local.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_codestream_local.h
34// Author: Aous Naman
35// Date: 28 August 2019
36//***************************************************************************/
37
38
39#ifndef OJPH_CODESTREAM_LOCAL_H
40#define OJPH_CODESTREAM_LOCAL_H
41
42#include "ojph_defs.h"
43#include "ojph_params_local.h"
44
45namespace ojph {
46
48 //defined elsewhere
49 struct line_buf;
50 class mem_fixed_allocator;
51 class mem_elastic_allocator;
52 class codestream;
53
54 namespace local {
55
57 static inline
59 {
60 return (ui16)((t << 8) | (t >> 8));
61 }
62
64 //defined elsewhere
65 class tile;
66
69 {
70 friend ::ojph::codestream;
71
72 public:
73 codestream();
75
76 void pre_alloc();
77 void finalize_alloc();
78
79 ojph::param_siz access_siz() //return externally wrapped siz
80 { return ojph::param_siz(&siz); }
81 const param_siz* get_siz() //return internal siz
82 { return &siz; }
83 ojph::param_cod access_cod() //return externally wrapped cod
84 { return ojph::param_cod(&cod); }
85 const param_cod* get_cod() //return internal code
86 { return &cod; }
88 {
89 if (used_qcc_fields > 0)
90 for (int v = 0; v < used_qcc_fields; ++v)
91 if (qcc[v].get_comp_num() == comp_num)
92 return qcc + v;
93 return &qcd;
94 }
98
99 line_buf* exchange(line_buf* line, ui32& next_component);
100 void write_headers(outfile_base *file, const comment_exchange* comments,
101 ui32 num_comments);
102 void enable_resilience();
103 bool is_resilient() { return resilient; }
104 void read_headers(infile_base *file);
105 void restrict_input_resolution(ui32 skipped_res_for_data,
107 void read();
108 void set_planar(int planar);
109 void set_profile(const char *s);
110 void set_tilepart_divisions(ui32 value);
111 void request_tlm_marker(bool needed);
112 line_buf* pull(ui32 &comp_num);
113 void flush();
114 void close();
115
116 bool is_planar() const { return planar != 0; }
117 si32 get_profile() const { return profile; };
118 ui32 get_tilepart_div() const { return tilepart_div; };
119 bool is_tlm_needed() const { return need_tlm; };
120
121 void check_imf_validity();
123
126 { return skipped_res_for_recon; }
128 { return skipped_res_for_read; }
129
130 private:
133
134 private:
140
141 private:
146 size *comp_size; //stores full resolution no. of lines and width
147 size *recon_comp_size; //stores number of lines and width of each comp
151 ui32 tilepart_div; // tilepart division value
152 bool need_tlm; // true if tlm markers are needed
153
154 private:
160
161 private: // this is to handle qcc
163 param_qcc qcc_store[4], *qcc; // we allocate 4,
164 // if not enough, we allocate more
165
166 private:
171 };
172
173 }
174}
175
176#endif // !OJPH_CODESTREAM_LOCAL_H
param_qcd * access_qcd(ui32 comp_num)
mem_elastic_allocator * get_elastic_alloc()
line_buf * exchange(line_buf *line, ui32 &next_component)
const param_siz * get_siz()
mem_fixed_allocator * get_allocator()
void restrict_input_resolution(ui32 skipped_res_for_data, ui32 skipped_res_for_recon)
mem_elastic_allocator * elastic_alloc
const param_cod * get_cod()
mem_fixed_allocator * allocator
void write_headers(outfile_base *file, const comment_exchange *comments, ui32 num_comments)
void read_headers(infile_base *file)
line_buf * pull(ui32 &comp_num)
static ui16 swap_byte(ui16 t)
uint16_t ui16
Definition: ojph_defs.h:52
int32_t si32
Definition: ojph_defs.h:55
uint32_t ui32
Definition: ojph_defs.h:54
uint8_t ui8
Definition: ojph_defs.h:50