Grok 15.1.0
TileProcessor.h
Go to the documentation of this file.
1/*
2 * Copyright (C) 2016-2025 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 * This source code incorporates work covered by the BSD 2-clause license.
18 * Please see the LICENSE file in the root directory for details.
19 *
20 */
21
22#pragma once
23#include "grk_includes.h"
24#include <queue>
25#include <mutex>
26
27namespace grk
28{
29/*
30 * Tile structure.
31 *
32 * Tile bounds are in canvas coordinates, and are equal to the
33 * full, non-windowed, unreduced tile dimensions,
34 * while the component dimensions are reduced
35 * if there is a resolution reduction.
36 *
37 */
38struct Tile : public grk_rect32
39{
40 Tile();
41 explicit Tile(uint16_t numcomps);
42 virtual ~Tile();
43 uint16_t numcomps_;
45 double distortion;
47};
48
50{
53 void init(uint32_t numcomps, uint32_t numres, uint64_t numprec, uint32_t numlayers);
54 void clear(void);
55 void packet_encoded(uint32_t comps, uint32_t res, uint64_t prec, uint32_t layer);
56 bool is_packet_encoded(uint32_t comps, uint32_t res, uint64_t prec, uint32_t layer);
57
58private:
59 uint8_t* bits;
60
61 uint32_t numcomps_;
62 uint32_t numres_;
63 uint64_t numprec_;
64 uint32_t numlayers_;
65
66 uint64_t get_buffer_len(uint32_t numcomps, uint32_t numres, uint64_t numprec, uint32_t numlayers);
67 uint64_t index(uint32_t comps, uint32_t res, uint64_t prec, uint32_t layer);
68};
69
73
74class mct;
75
77{
78 explicit TileProcessor(uint16_t index, CodeStream* codeStream, BufferedStream* stream,
79 bool isCompressor);
81 bool init(void);
82 bool createWindowBuffers(const GrkImage* outputImage);
83 void deallocBuffers();
84 bool preCompressTile(void);
85 bool canWritePocMarker(void);
86 bool writeTilePartT2(uint32_t* tileBytesWritten);
87 bool doCompress(void);
88 bool decompressT2T1(GrkImage* outputImage);
89 bool ingestUncompressedData(uint8_t* p_src, uint64_t src_length);
90 bool needsRateControl();
91 void ingestImage();
93 void generateImage(GrkImage* src_image, Tile* src_tile);
94 GrkImage* getImage(void);
95 void release(uint32_t strategy);
96 void setCorruptPacket(void);
100 uint8_t getMaxNumDecompressResolutions(void);
102 uint32_t getPreCalculatedTileLen(void);
103 bool canPreCalculateTileLen(void);
104 uint16_t getIndex(void) const;
105 void incrementIndex(void);
106 Tile* getTile(void);
107 Scheduler* getScheduler(void);
108 bool isCompressor(void);
109
120 uint32_t pino;
125 uint64_t getTilePartDataLength(void);
126 bool subtractMarkerSegmentLength(uint16_t markerLen);
127 bool setTilePartDataLength(uint16_t tilePart, uint32_t tilePartLength,
128 bool lastTilePartInCodeStream);
129 uint64_t getNumProcessedPackets(void);
130 void incNumProcessedPackets(void);
131 void incNumProcessedPackets(uint64_t numPackets);
132 uint64_t getNumDecompressedPackets(void);
133 void incNumDecompressedPackets(void);
134
135private:
136 bool isWholeTileDecompress(uint16_t compno);
137 bool needsMctDecompress(uint16_t compno);
138 bool needsMctDecompress(void);
139 bool mctDecompress(FlowComponent* flow);
141 bool mct_encode();
142 bool dwt_encode();
143 void t1_encode();
144 bool encodeT2(uint32_t* packet_bytes_written);
145 bool rateAllocate(uint32_t* allPacketBytes, bool disableRateControl);
146 bool layerNeedsRateControl(uint32_t layno);
148 void makeLayerFinal(uint32_t layno);
149 bool pcrdBisectSimple(uint32_t* p_data_written, bool disableRateControl);
150 void makeLayerSimple(uint32_t layno, double thresh, bool finalAttempt);
151
155 std::atomic<uint64_t> numDecompressedPackets;
156 // Decompressing Only
159 uint16_t tileIndex_;
160 // Compressing only - track which packets have already been written
161 // to the code stream
167 // coding/decoding parameters for this tile
175};
176
177} // namespace grk
Definition FlowComponent.h:21
Definition CodeStreamDecompress.h:38
Definition CodeStream.h:133
Definition GrkImage.h:24
Definition PLCache.h:26
Definition Scheduler.h:22
Definition mct.h:51
Copyright (C) 2016-2025 Grok Image Compression Inc.
Definition ICacheable.h:20
const uint16_t maxCompressLayersGRK
Definition CodeStreamLimits.h:43
grk_rect< uint32_t > grk_rect32
Definition geometry.h:61
Definition BufferedStream.h:35
Coding parameters.
Definition CodingParams.h:245
Definition TileProcessor.h:50
uint8_t * bits
Definition TileProcessor.h:59
void init(uint32_t numcomps, uint32_t numres, uint64_t numprec, uint32_t numlayers)
Definition TileProcessor.cpp:1501
uint32_t numres_
Definition TileProcessor.h:62
bool is_packet_encoded(uint32_t comps, uint32_t res, uint64_t prec, uint32_t layer)
Definition TileProcessor.cpp:1546
PacketTracker()
Definition TileProcessor.cpp:1495
uint64_t get_buffer_len(uint32_t numcomps, uint32_t numres, uint64_t numprec, uint32_t numlayers)
Definition TileProcessor.cpp:1528
void clear(void)
Definition TileProcessor.cpp:1523
uint64_t index(uint32_t comps, uint32_t res, uint64_t prec, uint32_t layer)
Definition TileProcessor.cpp:1557
uint64_t numprec_
Definition TileProcessor.h:63
uint32_t numcomps_
Definition TileProcessor.h:61
void packet_encoded(uint32_t comps, uint32_t res, uint64_t prec, uint32_t layer)
Definition TileProcessor.cpp:1535
~PacketTracker()
Definition TileProcessor.cpp:1497
uint32_t numlayers_
Definition TileProcessor.h:64
Tile coding parameters : this structure is used to store coding/decoding parameters common to all til...
Definition CodingParams.h:122
Definition TileComponent.h:28
Definition TileProcessor.h:39
Tile()
Definition TileProcessor.cpp:1479
virtual ~Tile()
Definition TileProcessor.cpp:1491
TileComponent * comps
Definition TileProcessor.h:44
double layerDistoration[maxCompressLayersGRK]
Definition TileProcessor.h:46
uint16_t numcomps_
Definition TileProcessor.h:43
double distortion
Definition TileProcessor.h:45
bool rateAllocate(uint32_t *allPacketBytes, bool disableRateControl)
Definition TileProcessor.cpp:1132
~TileProcessor()
Definition TileProcessor.cpp:36
GrkImage * getImage(void)
Definition TileProcessor.cpp:158
GrkImage * image_
Definition TileProcessor.h:170
uint32_t getPreCalculatedTileLen(void)
Definition TileProcessor.cpp:123
bool corrupt_packet_
Definition TileProcessor.h:164
void t1_encode()
Definition TileProcessor.cpp:802
bool mct_encode()
Definition TileProcessor.cpp:759
bool pcrdBisectSimple(uint32_t *p_data_written, bool disableRateControl)
Definition TileProcessor.cpp:1167
void release(uint32_t strategy)
Definition TileProcessor.cpp:162
uint64_t getNumDecompressedPackets(void)
Definition TileProcessor.cpp:111
PacketTracker packetTracker_
Definition TileProcessor.h:162
TileProcessor(uint16_t index, CodeStream *codeStream, BufferedStream *stream, bool isCompressor)
Definition TileProcessor.cpp:24
bool needsRateControl()
Definition TileProcessor.cpp:1142
Tile * tile
Definition TileProcessor.h:152
TileCodingParams * getTileCodingParams(void)
Definition TileProcessor.cpp:180
bool first_poc_tile_part_
Compression Only true for first POC tile part, otherwise false.
Definition TileProcessor.h:112
void makeLayerSimple(uint32_t layno, double thresh, bool finalAttempt)
Definition TileProcessor.cpp:1333
PacketTracker * getPacketTracker(void)
Definition TileProcessor.cpp:176
GrkImage * headerImage
Definition TileProcessor.h:121
bool dcLevelShiftCompress()
Definition TileProcessor.cpp:716
uint32_t pino
Compression Only Current packet iterator number.
Definition TileProcessor.h:120
bool isWholeTileDecompress(uint16_t compno)
Returns whether a tile component should be fully decompressed, taking into account win_* members.
Definition TileProcessor.cpp:415
Scheduler * getScheduler(void)
Definition TileProcessor.cpp:144
bool truncated
Definition TileProcessor.h:169
void makeLayerFinal(uint32_t layno)
Definition TileProcessor.cpp:1424
bool setTilePartDataLength(uint16_t tilePart, uint32_t tilePartLength, bool lastTilePartInCodeStream)
Definition TileProcessor.cpp:62
void generateImage(GrkImage *src_image, Tile *src_tile)
Definition TileProcessor.cpp:152
void incNumProcessedPackets(void)
Definition TileProcessor.cpp:103
BufferedStream * stream_
Definition TileProcessor.h:163
bool preCompressTile(void)
Definition TileProcessor.cpp:926
bool subtractMarkerSegmentLength(uint16_t markerLen)
Definition TileProcessor.cpp:46
uint16_t getIndex(void) const
Definition TileProcessor.cpp:132
void deallocBuffers()
Definition TileProcessor.cpp:300
uint8_t tilePartCounter_
Compressing Only index of tile part being currently coding.
Definition TileProcessor.h:117
bool canWritePocMarker(void)
Definition TileProcessor.cpp:384
uint32_t preCalculatedTileLen
Definition TileProcessor.h:173
uint64_t getNumProcessedPackets(void)
Definition TileProcessor.cpp:99
Tile * getTile(void)
Definition TileProcessor.cpp:140
bool isCompressor_
Definition TileProcessor.h:171
bool createWindowBuffers(const GrkImage *outputImage)
Definition TileProcessor.cpp:266
Scheduler * scheduler_
Definition TileProcessor.h:153
void setCorruptPacket(void)
bool mctDecompress(FlowComponent *flow)
Definition TileProcessor.cpp:690
bool encodeT2(uint32_t *packet_bytes_written)
Definition TileProcessor.cpp:826
bool doCompress(void)
Definition TileProcessor.cpp:308
uint64_t getTilePartDataLength(void)
Definition TileProcessor.cpp:42
grk_rect32 getUnreducedTileWindow(void)
Definition TileProcessor.cpp:295
bool isCompressor(void)
Definition TileProcessor.cpp:148
uint8_t getMaxNumDecompressResolutions(void)
Definition TileProcessor.cpp:184
bool layerNeedsRateControl(uint32_t layno)
Definition TileProcessor.cpp:1136
mct * mct_
Definition TileProcessor.h:174
bool ingestUncompressedData(uint8_t *p_src, uint64_t src_length)
Definition TileProcessor.cpp:978
std::atomic< uint64_t > numDecompressedPackets
Definition TileProcessor.h:155
bool init(void)
Definition TileProcessor.cpp:201
grk_plugin_tile * current_plugin_tile
Definition TileProcessor.h:122
bool dwt_encode()
Definition TileProcessor.cpp:786
bool writeTilePartT2(uint32_t *tileBytesWritten)
Definition TileProcessor.cpp:391
uint64_t tilePartDataLength
Definition TileProcessor.h:157
bool makeSingleLosslessLayer()
Definition TileProcessor.cpp:1153
TileCodingParams * tcp_
Definition TileProcessor.h:168
grk_rect32 unreducedImageWindow
Definition TileProcessor.h:172
bool cacheTilePartPackets(CodeStreamDecompress *codeStream)
Definition TileProcessor.cpp:1036
bool decompressT2T1(GrkImage *outputImage)
Definition TileProcessor.cpp:431
uint16_t tileIndex_
index of tile being currently compressed/decompressed
Definition TileProcessor.h:159
void incrementIndex(void)
Definition TileProcessor.cpp:136
uint64_t numProcessedPackets
Definition TileProcessor.h:154
BufferedStream * getStream(void)
Definition TileProcessor.cpp:119
void ingestImage()
Definition TileProcessor.cpp:642
bool needsMctDecompress(void)
Definition TileProcessor.cpp:664
CodingParams * cp_
Definition TileProcessor.h:123
bool canPreCalculateTileLen(void)
Definition TileProcessor.cpp:127
PLCache packetLengthCache
Definition TileProcessor.h:124
uint32_t newTilePartProgressionPosition
position of the tile part flag in progression order
Definition TileProcessor.h:166
void incNumDecompressedPackets(void)
Definition TileProcessor.cpp:115
Plugin tile.