Grok 12.0.1
SparseCanvas.h
Go to the documentation of this file.
1/*
2 * Copyright (C) 2016-2024 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#pragma once
17
18#include <cstdint>
19#include <algorithm>
20
21// SparseCanvas stores blocks in the canvas coordinate system. It covers the active sub-bands for
22// all (reduced) resolutions
23
24/***
25 *
26 * SparseCanvas stores blocks of size LBW x LBH in canvase coordinate system (with offset)
27 * Blocks are only allocated for active sub-bands for reduced resolutions
28 *
29 * Data is pass in and out in a linear array, chunked either along the y axis
30 * or along the x axis, depending on whether we are working with a horizontal strip
31 * or a vertical strip of data.
32 *
33 *
34 */
35
36namespace grk
37{
39{
40 public:
41 virtual ~ISparseCanvas() = default;
46 const uint32_t destChunkX) = 0;
50 virtual bool write(uint8_t resno, grk_rect32 window, const int32_t* src,
51 const uint32_t srcChunkY, const uint32_t srcChunkX) = 0;
52
53 virtual bool alloc(grk_rect32 window, bool zeroOutBuffer) = 0;
54};
56{
59 {
60 delete[] data;
61 }
63 {
64 data = new int32_t[block_area];
66 memset(data, 0, block_area * sizeof(int32_t));
67 }
69};
70template<uint32_t LBW, uint32_t LBH>
72{
73 public:
76 {
77 if(!bounds.width() || !bounds.height() || !LBW || !LBH)
78 throw std::runtime_error("invalid window for sparse canvas");
80 auto blockCount = grid.area();
81 blocks = new SparseBlock*[blockCount];
82 for(uint64_t i = 0; i < blockCount; ++i)
83 blocks[i] = nullptr;
84 }
85 SparseCanvas(uint32_t width, uint32_t height) : SparseCanvas(grk_rect32(0, 0, width, height)) {}
87 {
88 if(blocks)
89 {
90 for(uint64_t i = 0; i < (uint64_t)grid.width() * grid.height(); i++)
91 {
92 delete(blocks[i]);
93 blocks[i] = nullptr;
94 }
95 delete[] blocks;
96 }
97 }
99 const uint32_t destChunkX)
100 {
101 return readWrite(resno, window, dest, destChunkY, destChunkX, true);
102 }
104 const uint32_t srcChunkX)
105 {
106 return readWrite(resno, window, (int32_t*)src, srcChunkY, srcChunkX, false);
107 }
109 {
111 return true;
113 uint32_t gridY = win.y0 >> LBH;
114 for(uint32_t y = win.y0; y < win.y1; gridY++, y += blockWinHeight)
115 {
116 blockWinHeight = (y == win.y0) ? blockHeight - (win.y0 & (blockHeight - 1)) : blockHeight;
117 blockWinHeight = (std::min<uint32_t>)(blockWinHeight, win.y1 - y);
118 uint32_t gridX = win.x0 >> LBW;
120 for(uint32_t x = win.x0; x < win.x1; gridX++, x += blockWinWidth)
121 {
122 blockWinWidth = (x == win.x0) ? blockWidth - (win.x0 & (blockWidth - 1)) : blockWidth;
123 blockWinWidth = (std::min<uint32_t>)(blockWinWidth, win.x1 - x);
124 if(!grid.contains(gridX, gridY))
125 {
127 "sparse canvas : attempt to allocate a block (%u,%u) outside block "
128 "grid bounds (%u,%u,%u,%u)",
130 return false;
131 }
132 auto srcBlock = getBlock(gridX, gridY);
133 if(!srcBlock)
134 {
135 auto b = new SparseBlock();
138 assert(b->data);
140 blocks[blockInd] = b;
141 }
142 }
143 }
144 return true;
145 }
146
147 private:
149 {
150 uint64_t index = (uint64_t)(block_y - grid.y0) * grid.width() + (block_x - grid.x0);
151 return blocks[index];
152 }
154 {
155 return !(win.x0 >= bounds.x1 || win.x1 <= win.x0 || win.x1 > bounds.x1 ||
156 win.y0 >= bounds.y1 || win.y1 <= win.y0 || win.y1 > bounds.y1);
157 }
160 {
161 if(!win.valid())
162 return false;
163 assert(!isReadOperation || buf);
164
165 if(!isWindowValid(win))
166 {
168 "Sparse canvas @ res %u, attempt to read/write invalid window (%u,%u,%u,%u) "
169 "for bounds (%u,%u,%u,%u).",
170 resno, win.x0, win.y0, win.x1, win.y1, bounds.x0, bounds.y0, bounds.x1, bounds.y1);
171 return false;
172 }
173 assert(spacingY != 0 || win.height() == 1);
174 assert((spacingY <= 1 && spacingX >= 1) || (spacingY >= 1 && spacingX == 1));
175
176 uint32_t gridY = win.y0 >> LBH;
178 for(uint32_t y = win.y0; y < win.y1; gridY++, y += blockWinHeight)
179 {
180 blockWinHeight = (y == win.y0) ? blockHeight - (win.y0 & (blockHeight - 1)) : blockHeight;
182 blockWinHeight = (std::min<uint32_t>)(blockWinHeight, win.y1 - y);
183 uint32_t gridX = win.x0 >> LBW;
185 for(uint32_t x = win.x0; x < win.x1; gridX++, x += blockWinWidth)
186 {
187 blockWinWidth = (x == win.x0) ? blockWidth - (win.x0 & (blockWidth - 1)) : blockWidth;
189 blockWinWidth = (std::min<uint32_t>)(blockWinWidth, win.x1 - x);
190 if(!grid.contains(gridX, gridY))
191 {
193 "sparse canvas @ resno %u, Attempt to access a block (%u,%u) outside "
194 "block grid bounds",
195 resno, gridX, gridY);
196 return false;
197 }
198 auto srcBlock = getBlock(gridX, gridY);
199 if(!srcBlock)
200 {
202 "sparse canvas @ resno %u, %s op: missing block (%u,%u,%u,%u) for %s "
203 "(%u,%u,%u,%u). Skipping.",
204 resno, isReadOperation ? "read" : "write", bounds.x0 + gridX * blockWidth,
206 bounds.y0 + (gridY + 1) * blockHeight, isReadOperation ? "read" : "write",
207 win.x0, win.y0, win.x1, win.y1);
208 continue;
209 }
211 {
212 auto src = srcBlock->data + ((uint64_t)blockOffsetY << LBW) + blockOffsetX;
213 auto dest = buf + (y - win.y0) * spacingY + (x - win.x0) * spacingX;
215 {
216 uint64_t destInd = 0;
218 {
219#ifdef GRK_DEBUG_VALGRIND
220 size_t val = grk_memcheck<int32_t>(src + blockX, 1);
221 if(val != grk_mem_ok)
222 Logger::logger_.error("sparse canvas @resno %u, read block(%u,%u) : "
223 "uninitialized at location (%u,%u)",
224 resno, gridX, gridY, x + blockX, y_);
225#endif
227 destInd += spacingX;
228 }
229 dest += spacingY;
230 src += blockWidth;
231 }
232 }
233 else
234 {
235 const int32_t* src = nullptr;
236 if(buf)
237 src = buf + (y - win.y0) * spacingY + (x - win.x0) * spacingX;
238 auto dest = srcBlock->data + ((uint64_t)blockOffsetY << LBW) + blockOffsetX;
240 {
241 uint64_t srcInd = 0;
243 {
244#ifdef GRK_DEBUG_VALGRIND
245 if(src)
246 {
247 grk_pt32 pt((uint32_t)(x + blockX), y_);
248 size_t val = grk_memcheck<int32_t>(src + srcInd, 1);
249 if(val != grk_mem_ok)
250 Logger::logger_.error("sparse canvas @ resno %u, write block(%u,%u): "
251 "uninitialized at location (%u,%u)",
252 resno, gridX, gridY, x + blockX, y_);
253 }
254#endif
255 dest[blockX] = src ? src[srcInd] : 0;
256 srcInd += spacingX;
257 }
258 if(src)
259 src += spacingY;
260 dest += blockWidth;
261 }
262 }
263 }
264 }
265 return true;
266 }
267
268 private:
272 grk_rect32 bounds; // canvas bounds
273 grk_rect32 grid; // block grid bounds
274};
275
276} // namespace grk
Definition SparseCanvas.h:39
virtual ~ISparseCanvas()=default
virtual bool alloc(grk_rect32 window, bool zeroOutBuffer)=0
virtual bool read(uint8_t resno, grk_rect32 window, int32_t *dest, const uint32_t destChunkY, const uint32_t destChunkX)=0
Read window of data into dest buffer.
virtual bool write(uint8_t resno, grk_rect32 window, const int32_t *src, const uint32_t srcChunkY, const uint32_t srcChunkX)=0
Write window of data from src buffer.
Definition SparseCanvas.h:72
SparseBlock * getBlock(uint32_t block_x, uint32_t block_y)
Definition SparseCanvas.h:148
grk_rect32 bounds
Definition SparseCanvas.h:272
SparseCanvas(uint32_t width, uint32_t height)
Definition SparseCanvas.h:85
const uint32_t blockWidth
Definition SparseCanvas.h:269
bool alloc(grk_rect32 win, bool zeroOutBuffer)
Definition SparseCanvas.h:108
SparseBlock ** blocks
Definition SparseCanvas.h:271
bool readWrite(uint8_t resno, grk_rect32 win, int32_t *buf, const uint32_t spacingX, const uint32_t spacingY, bool isReadOperation)
Definition SparseCanvas.h:158
~SparseCanvas()
Definition SparseCanvas.h:86
bool read(uint8_t resno, grk_rect32 window, int32_t *dest, const uint32_t destChunkY, const uint32_t destChunkX)
Read window of data into dest buffer.
Definition SparseCanvas.h:98
SparseCanvas(grk_rect32 bds)
Definition SparseCanvas.h:74
bool write(uint8_t resno, grk_rect32 window, const int32_t *src, const uint32_t srcChunkY, const uint32_t srcChunkX)
Write window of data from src buffer.
Definition SparseCanvas.h:103
const uint32_t blockHeight
Definition SparseCanvas.h:270
grk_rect32 grid
Definition SparseCanvas.h:273
bool isWindowValid(grk_rect32 win)
Definition SparseCanvas.h:153
Copyright (C) 2016-2024 Grok Image Compression Inc.
Definition ICacheable.h:20
void grk_read(const uint8_t *buffer, TYPE *value, uint32_t numBytes)
Definition BufferedStream.h:239
void warn(const char *fmt,...) override
Definition Logger.h:44
void error(const char *fmt,...) override
Definition Logger.h:53
static Logger logger_
Definition Logger.h:70
Definition SparseCanvas.h:56
SparseBlock(void)
Definition SparseCanvas.h:57
void alloc(uint32_t block_area, bool zeroOutBuffer)
Definition SparseCanvas.h:62
int32_t * data
Definition SparseCanvas.h:68
~SparseBlock()
Definition SparseCanvas.h:58
uint64_t area(void) const
Definition geometry.h:331
T width() const
Definition geometry.h:335
T y1
Definition geometry.h:124
T x0
Definition geometry.h:124
T x1
Definition geometry.h:124
T height() const
Definition geometry.h:339
bool contains(grk_pt< T > pt)
Definition geometry.h:193
T y0
Definition geometry.h:124
grk_rect< T > scaleDownPow2(uint32_t powx, uint32_t powy) const
Definition geometry.h:252