OpenJPH
Open-source implementation of JPEG2000 Part-15
ojph_codestream.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.h
34// Author: Aous Naman
35// Date: 28 August 2019
36//***************************************************************************/
37
38
39#ifndef OJPH_CODESTREAM_H
40#define OJPH_CODESTREAM_H
41
42#include <cstdlib>
43
44#include "ojph_arch.h"
45#include "ojph_defs.h"
46
47namespace ojph {
48
50 //local prototyping
51 namespace local {
52 class codestream;
53 };
54
56 //defined elsewhere
57 class param_siz;
58 class param_cod;
59 class param_qcd;
60 class param_nlt;
61 class comment_exchange;
62 class mem_fixed_allocator;
63 struct point;
64 class line_buf;
65 class outfile_base;
66 class infile_base;
67
69
89 {
90 public:
98 codestream();
105 ~codestream();
106
121 void set_planar(bool planar);
122
134 void set_profile(const char* s);
135
156 void set_tilepart_divisions(bool at_resolutions, bool at_components);
157
165 bool is_tilepart_division_at_resolutions();
166
174 bool is_tilepart_division_at_components();
175
183 void request_tlm_marker(bool needed);
184
194 bool is_tlm_requested();
195
212 void write_headers(outfile_base *file,
213 const comment_exchange* comments = NULL,
214 ui32 num_comments = 0);
215
238 line_buf* exchange(line_buf* line, ui32& next_component);
239
247 void flush();
248
256 void enable_resilience(); // before read_headers
257
268 void read_headers(infile_base *file); // before resolution restrictions
269
288 void restrict_input_resolution(ui32 skipped_res_for_data,
289 ui32 skipped_res_for_recon); //before create
290
296 void create();
297
309 line_buf* pull(ui32 &comp_num);
310
316 void close();
317
325 param_siz access_siz();
326
335 param_cod access_cod();
336
344 param_qcd access_qcd();
345
353 param_nlt access_nlt();
354
362 bool is_planar() const;
363
364 private:
366 };
367
368}
369
370#endif // !OJPH_CODESTREAM_H
The object represent a codestream.
local::codestream * state
non-linearity point transformation object (implements NLT marker segment)
Definition: ojph_params.h:245
Quantization parameters object.
Definition: ojph_params.h:163
uint32_t ui32
Definition: ojph_defs.h:54
#define OJPH_EXPORT
Definition: ojph_arch.h:119
EMSCRIPTEN_KEEPALIVE void enable_resilience(j2k_struct *j2c)
EMSCRIPTEN_KEEPALIVE void restrict_input_resolution(j2k_struct *j2c, int skipped_res_for_read, int skipped_res_for_recon)