Grok  7.6.2
LengthMarkers.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2016-2020 Grok Image Compression Inc.
3  *
4  * This source code is free software: you can redistribute it and/or modify
5  * it under the terms of the GNU Affero General Public License, version 3,
6  * as published by the Free Software Foundation.
7  *
8  * This source code is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11  * GNU Affero General Public License for more details.
12  *
13  * You should have received a copy of the GNU Affero General Public License
14  * along with this program. If not, see <http://www.gnu.org/licenses/>.
15  */
16 
17 #pragma once
18 
19 namespace grk {
20 
21 // tile part length
22 struct grk_tl_info {
24  has_tile_number(false), tile_number(0), length(0) {
25  }
26  grk_tl_info(uint32_t len) :
27  has_tile_number(false), tile_number(0), length(len) {
28  }
29  grk_tl_info(uint16_t tileno, uint32_t len) :
30  has_tile_number(true), tile_number(tileno), length(len) {
31  }
33  uint16_t tile_number;
34  uint32_t length;
35 
36 };
37 
38 typedef std::vector<grk_tl_info> TL_INFO_VEC;
39 // map of (TLM marker id) => (tile part length vector)
40 typedef std::map<uint8_t, TL_INFO_VEC*> TL_MAP;
41 
46 
47  bool read(uint8_t *p_header_data, uint16_t header_size);
48  void getInit(void);
49  grk_tl_info getNext(void);
50 
51  bool write_begin(uint16_t totalTileParts);
52  void write_update(uint16_t tileIndex, uint32_t tile_part_size);
53  bool write_end(void);
62  static bool add_to_index(uint16_t tileno, grk_codestream_index *cstr_index,
63  uint32_t type, uint64_t pos, uint32_t len);
64 private:
65  void push(uint8_t i_TLM, grk_tl_info curr_vec);
67  uint8_t m_markerIndex;
68  uint8_t m_tilePartIndex;
72 
73 };
74 
75 // bytes available in PLT marker to store packet lengths
76 // (4 bytes are reserved for (marker + marker length), and 1 byte for index)
77 const uint32_t available_packet_len_bytes_per_plt = USHRT_MAX - 1 - 4;
78 
79 // minimum number of packet lengths that can be stored in a full
80 // length PLT marker
81 // (5 is maximum number of bytes for a single packet length)
83 
84 typedef std::vector<uint32_t> PL_INFO_VEC;
85 // map of (PLT/PLM marker id) => (packet length vector)
86 typedef std::map<uint8_t, PL_INFO_VEC*> PL_MAP;
87 
89  PacketLengthMarkers(void);
92 
93  // decompress packet lengths
94  bool readPLT(uint8_t *p_header_data, uint16_t header_size);
95  bool readPLM(uint8_t *p_header_data, uint16_t header_size);
96 
97  // get decompressed packet lengths
98  void getInit(void);
99  uint32_t getNext(void);
100 
101  // compress packet lengths
102  void writeInit(void);
103  void writeNext(uint32_t len);
104  // write marker to stream
105  uint32_t write();
106 
107 private:
109  uint8_t m_markerIndex;
112  uint32_t m_packet_len;
113 
114  void readInitIndex(uint8_t index);
115  void readNext(uint8_t Iplm);
116 
117  void write_marker_header(void);
118  void write_marker_length();
119  void write_increment(uint32_t bytes);
124 };
125 
126 }
127 
grk::PacketLengthMarkers::m_packetIndex
size_t m_packetIndex
Definition: LengthMarkers.h:111
grk::PacketLengthMarkers::m_markerIndex
uint8_t m_markerIndex
Definition: LengthMarkers.h:109
_grk_codestream_index
Code stream index info.
Definition: grok.h:1147
grk::TileLengthMarkers::m_tlm_start_stream_position
uint64_t m_tlm_start_stream_position
Definition: LengthMarkers.h:71
grk::PacketLengthMarkers::PacketLengthMarkers
PacketLengthMarkers(void)
Definition: LengthMarkers.cpp:253
grk::BufferedStream::write_byte
bool write_byte(uint8_t value)
Definition: BufferedStream.cpp:182
grk::PacketLengthMarkers::readNext
void readNext(uint8_t Iplm)
Definition: LengthMarkers.cpp:437
grk::BufferedStream::write_int
bool write_int(uint32_t value)
Definition: BufferedStream.cpp:191
grk::tlm_marker_start_bytes
const uint32_t tlm_marker_start_bytes
Definition: LengthMarkers.cpp:22
_grk_tile_index::marker
grk_marker_info * marker
list of markers
Definition: grok.h:1139
grk::TL_INFO_VEC
std::vector< grk_tl_info > TL_INFO_VEC
Definition: LengthMarkers.h:38
grk::tlm_len_per_tile_part
const uint32_t tlm_len_per_tile_part
Definition: CodeStream.h:37
grk::BufferedStream
Byte input-output stream.
Definition: BufferedStream.h:38
grk::BufferedStream::write_short
bool write_short(uint16_t value)
Definition: BufferedStream.cpp:185
grk::grk_tl_info::grk_tl_info
grk_tl_info(uint16_t tileno, uint32_t len)
Definition: LengthMarkers.h:29
grk::TileLengthMarkers::getNext
grk_tl_info getNext(void)
Definition: LengthMarkers.cpp:134
grk::PacketLengthMarkers::m_packet_len
uint32_t m_packet_len
Definition: LengthMarkers.h:112
grk::PacketLengthMarkers::getNext
uint32_t getNext(void)
Definition: LengthMarkers.cpp:464
grk::grk_free
void grk_free(void *ptr)
Deallocates or frees a memory block.
Definition: MemManager.cpp:141
grk::TileLengthMarkers::read
bool read(uint8_t *p_header_data, uint16_t header_size)
Definition: LengthMarkers.cpp:47
grk::PacketLengthMarkers::~PacketLengthMarkers
~PacketLengthMarkers(void)
Definition: LengthMarkers.cpp:271
grk::PacketLengthMarkers::m_markers
PL_MAP * m_markers
Definition: LengthMarkers.h:108
grk::grk_tl_info::tile_number
uint16_t tile_number
Definition: LengthMarkers.h:33
_grk_marker_info::type
uint16_t type
marker type
Definition: grok.h:958
grk::grk_tl_info
Definition: LengthMarkers.h:22
grk::PacketLengthMarkers::write_increment
void write_increment(uint32_t bytes)
Definition: LengthMarkers.cpp:290
grk::PacketLengthMarkers::writeInit
void writeInit(void)
Definition: LengthMarkers.cpp:279
grk::available_packet_len_bytes_per_plt
const uint32_t available_packet_len_bytes_per_plt
Definition: LengthMarkers.h:77
_grk_tile_index::current_tpsno
uint32_t current_tpsno
current tile-part index
Definition: grok.h:1133
grk::TileLengthMarkers::m_markers
TL_MAP * m_markers
Definition: LengthMarkers.h:66
_grk_marker_info::len
uint32_t len
length, marker value included
Definition: grok.h:962
grk::PacketLengthMarkers::m_marker_bytes_written
uint32_t m_marker_bytes_written
Definition: LengthMarkers.h:120
grk::PacketLengthMarkers::writeNext
void writeNext(uint32_t len)
Definition: LengthMarkers.cpp:286
grk::PacketLengthMarkers::write_marker_length
void write_marker_length()
Definition: LengthMarkers.cpp:294
grk::BufferedStream::tell
uint64_t tell(void)
Tells byte offset of stream (similar to ftell).
Definition: BufferedStream.cpp:330
grk::grk_tl_info::length
uint32_t length
Definition: LengthMarkers.h:34
grk::TileLengthMarkers::add_to_index
static bool add_to_index(uint16_t tileno, grk_codestream_index *cstr_index, uint32_t type, uint64_t pos, uint32_t len)
Add tile header marker information.
Definition: LengthMarkers.cpp:205
grk::PacketLengthMarkers::m_total_bytes_written
uint32_t m_total_bytes_written
Definition: LengthMarkers.h:121
grk::TileLengthMarkers::push
void push(uint8_t i_TLM, grk_tl_info curr_vec)
Definition: LengthMarkers.cpp:112
_grk_tile_index::marknum
uint32_t marknum
number of markers
Definition: grok.h:1137
grk::BufferedStream::skip
bool skip(int64_t p_size)
Skip bytes in stream.
Definition: BufferedStream.cpp:338
J2K_MS_SOT
#define J2K_MS_SOT
SOT marker value.
Definition: CodeStream.h:73
grk::PL_INFO_VEC
std::vector< uint32_t > PL_INFO_VEC
Definition: LengthMarkers.h:84
grk::TileLengthMarkers::m_tilePartIndex
uint8_t m_tilePartIndex
Definition: LengthMarkers.h:68
grk::PacketLengthMarkers::m_curr_vec
PL_INFO_VEC * m_curr_vec
Definition: LengthMarkers.h:110
_grk_tile_index::maxmarknum
uint32_t maxmarknum
actual size of markers array
Definition: grok.h:1141
grk::TileLengthMarkers::write_end
bool write_end(void)
Definition: LengthMarkers.cpp:183
J2K_MS_PLT
#define J2K_MS_PLT
PLT marker value.
Definition: CodeStream.h:86
grk::grk_tl_info::has_tile_number
bool has_tile_number
Definition: LengthMarkers.h:32
grk
Copyright (C) 2016-2020 Grok Image Compression Inc.
Definition: BitIO.cpp:23
grk::TileLengthMarkers::write_update
void write_update(uint16_t tileIndex, uint32_t tile_part_size)
Definition: LengthMarkers.cpp:178
grk::TileLengthMarkers::m_curr_vec
TL_INFO_VEC * m_curr_vec
Definition: LengthMarkers.h:69
grk::PacketLengthMarkers::getInit
void getInit(void)
Definition: LengthMarkers.cpp:450
grk::PacketLengthMarkers::readInitIndex
void readInitIndex(uint8_t index)
Definition: LengthMarkers.cpp:425
grk_includes.h
J2K_MS_TLM
#define J2K_MS_TLM
TLM marker value.
Definition: CodeStream.h:84
grk::TileLengthMarkers::~TileLengthMarkers
~TileLengthMarkers()
Definition: LengthMarkers.cpp:39
grk::PL_MAP
std::map< uint8_t, PL_INFO_VEC * > PL_MAP
Definition: LengthMarkers.h:86
grk::grk_tl_info::grk_tl_info
grk_tl_info(uint32_t len)
Definition: LengthMarkers.h:26
_grk_marker_info::pos
uint64_t pos
position in code stream
Definition: grok.h:960
grk::TileLengthMarkers::m_markerIndex
uint8_t m_markerIndex
Definition: LengthMarkers.h:67
grk::grk_realloc
void * grk_realloc(void *ptr, size_t new_size)
Reallocate memory blocks.
Definition: MemManager.cpp:135
grk::BufferedStream::seek
bool seek(uint64_t offset)
Seek bytes from the stream (absolute)
Definition: BufferedStream.cpp:409
_grk_marker_info
Marker info.
Definition: grok.h:956
grk::PacketLengthMarkers
Definition: LengthMarkers.h:88
grk::BufferedStream::write_bytes
size_t write_bytes(const uint8_t *p_buffer, size_t p_size)
Write bytes to stream (no correction for endian!).
Definition: BufferedStream.cpp:222
grk::TileLengthMarkers::m_stream
BufferedStream * m_stream
Definition: LengthMarkers.h:70
grk::PacketLengthMarkers::write
uint32_t write()
Definition: LengthMarkers.cpp:326
grk::TileLengthMarkers
Definition: LengthMarkers.h:42
grk::TileLengthMarkers::write_begin
bool write_begin(uint16_t totalTileParts)
Definition: LengthMarkers.cpp:153
grk::PacketLengthMarkers::readPLM
bool readPLM(uint8_t *p_header_data, uint16_t header_size)
Definition: LengthMarkers.cpp:371
grk::PacketLengthMarkers::m_stream
BufferedStream * m_stream
Definition: LengthMarkers.h:123
grk::TL_MAP
std::map< uint8_t, TL_INFO_VEC * > TL_MAP
Definition: LengthMarkers.h:40
grk::PacketLengthMarkers::write_marker_header
void write_marker_header(void)
Definition: LengthMarkers.cpp:308
grk::TileLengthMarkers::getInit
void getInit(void)
Definition: LengthMarkers.cpp:124
_grk_tile_index::tp_index
grk_tp_index * tp_index
information concerning tile parts
Definition: grok.h:1135
_grk_tp_index::start_pos
uint64_t start_pos
start position
Definition: grok.h:1115
grk::PacketLengthMarkers::readPLT
bool readPLT(uint8_t *p_header_data, uint16_t header_size)
Definition: LengthMarkers.cpp:401
grk::min_packets_per_full_plt
const uint32_t min_packets_per_full_plt
Definition: LengthMarkers.h:82
grk::GRK_ERROR
void GRK_ERROR(const char *fmt,...)
Definition: logger.cpp:57
grk::grk_tl_info::grk_tl_info
grk_tl_info()
Definition: LengthMarkers.h:23
ojph::info
message_info info
Definition: ojph_message.cpp:50
grk::PacketLengthMarkers::m_marker_len_cache
uint64_t m_marker_len_cache
Definition: LengthMarkers.h:122
grk::TileLengthMarkers::TileLengthMarkers
TileLengthMarkers()
Definition: LengthMarkers.cpp:24
_grk_codestream_index::tile_index
grk_tile_index * tile_index
Definition: grok.h:1161