Blender V5.3
blendthumb_png.cc
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2008 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
11
12#include <cstring>
13#include <optional>
14#include <zlib.h>
15
16#include "blendthumb.hh"
17
18#include "BLI_endian_defines.hh"
19#include "BLI_endian_switch.hh"
20#include "BLI_vector.hh"
21
22namespace blender {
23
25{
26 /* NOTE: this is endianness-sensitive. */
27 /* PNG is big-endian, its values need to be switched on little-endian systems. */
29 output.extend_unchecked(Span(reinterpret_cast<uint8_t *>(&data), 4));
30}
31
33#define PNG_CHUNK_EXTRA 12
34
36 const uint32_t tag,
37 const Vector<uint8_t> &data)
38{
39 uint32_t crc = crc32(0, nullptr, 0);
40 crc = crc32(crc, reinterpret_cast<uint8_t *>(const_cast<uint32_t *>(&tag)), sizeof(tag));
41 crc = crc32(crc, const_cast<uint8_t *>(data.data()), data.size());
42
44 output.extend_unchecked(
45 Span(reinterpret_cast<uint8_t *>(const_cast<uint32_t *>(&tag)), sizeof(tag)));
46 output.extend_unchecked(data);
48}
49
51{
52 /* In the image data sent to the compression step, each scan-line is preceded by a filter type
53 * byte containing the numeric code of the filter algorithm used for that scan-line. */
54 const size_t line_size = thumb->width * 4;
55 Vector<uint8_t> filtered;
56 size_t final_size = thumb->height * (line_size + 1);
57 filtered.reserve(final_size);
58 for (int i = 0; i < thumb->height; i++) {
59 filtered.append_unchecked(0x00);
60 filtered.extend_unchecked(Span(&thumb->data[i * line_size], line_size));
61 }
62 BLI_assert(final_size == filtered.size());
63 return filtered;
64}
65
66static std::optional<Vector<uint8_t>> zlib_compress(const Vector<uint8_t> &data)
67{
68 ulong uncompressed_size = data.size();
69 uLongf compressed_size = compressBound(uncompressed_size);
70
71 Vector<uint8_t> compressed(compressed_size, 0x00);
72
73 int return_value = compress2(static_cast<uchar *>(compressed.data()),
74 &compressed_size,
75 const_cast<uchar *>(data.data()),
76 uncompressed_size,
77 Z_NO_COMPRESSION);
78 if (return_value != Z_OK) {
79 /* Something went wrong with compression of data. */
80 return std::nullopt;
81 }
82 compressed.resize(compressed_size);
83 return compressed;
84}
85
86std::optional<Vector<uint8_t>> blendthumb_create_png_data_from_thumb(const Thumbnail *thumb)
87{
88 if (thumb->data.is_empty()) {
89 return std::nullopt;
90 }
91
92 /* Create `IDAT` chunk data. */
93 Vector<uint8_t> image_data;
94 {
95 auto image_data_opt = zlib_compress(filtered_rows_from_thumb(thumb));
96 if (image_data_opt == std::nullopt) {
97 return std::nullopt;
98 }
99 image_data = *image_data_opt;
100 }
101
102 /* Create the IHDR chunk data. */
103 Vector<uint8_t> ihdr_data;
104 {
105 const size_t ihdr_data_final_size = 4 + 4 + 5;
106 ihdr_data.reserve(ihdr_data_final_size);
107 png_extend_native_int32(ihdr_data, thumb->width);
108 png_extend_native_int32(ihdr_data, thumb->height);
109 ihdr_data.extend_unchecked({
110 0x08, /* Bit Depth. */
111 0x06, /* Color Type. */
112 0x00, /* Compression method. */
113 0x00, /* Filter method. */
114 0x00, /* Interlace method. */
115 });
116 BLI_assert(size_t(ihdr_data.size()) == ihdr_data_final_size);
117 }
118
119 /* Join it all together to create a PNG image. */
120 Vector<uint8_t> png_buf;
121 {
122 const size_t png_buf_final_size = (
123 /* Header. */
124 8 +
125 /* `IHDR` chunk. */
126 (ihdr_data.size() + PNG_CHUNK_EXTRA) +
127 /* `IDAT` chunk. */
128 (image_data.size() + PNG_CHUNK_EXTRA) +
129 /* `IEND` chunk. */
131
132 png_buf.reserve(png_buf_final_size);
133
134 /* This is the standard PNG file header. Every PNG file starts with it. */
135 png_buf.extend_unchecked({0x89, 0x50, 0x4E, 0x47, 0x0D, 0x0A, 0x1A, 0x0A});
136
137 png_chunk_create(png_buf, MAKE_ID('I', 'H', 'D', 'R'), ihdr_data);
138 png_chunk_create(png_buf, MAKE_ID('I', 'D', 'A', 'T'), image_data);
139 png_chunk_create(png_buf, MAKE_ID('I', 'E', 'N', 'D'), {});
140
141 BLI_assert(size_t(png_buf.size()) == png_buf_final_size);
142 }
143
144 return png_buf;
145}
146
147} // namespace blender
#define MAKE_ID(a, b, c, d)
Definition blendthumb.hh:50
#define PNG_CHUNK_EXTRA
#define output
bool is_empty() const
Definition BLI_array.hh:275
constexpr Span()=default
int64_t size() const
void resize(const int64_t new_size)
void extend_unchecked(Span< T > array)
void append_unchecked(const T &value)
void reserve(const int64_t min_capacity)
BMesh Iterators.
BLI_assert(slot->slot_subtype.map==BMO_OP_SLOT_SUBTYPE_MAP_FLT)
static std::optional< Vector< uint8_t > > zlib_compress(const Vector< uint8_t > &data)
unsigned long ulong
Definition BKE_text.h:57
unsigned int uint32_t
Definition BKE_text.h:81
unsigned char uchar
Definition BKE_text.h:58
BMesh const char void * data
unsigned char uint8_t
Definition BKE_text.h:79
static Vector< uint8_t > filtered_rows_from_thumb(const Thumbnail *thumb)
static void png_chunk_create(Vector< uint8_t > &output, const uint32_t tag, const Vector< uint8_t > &data)
BLI_INLINE void BLI_endian_switch_int32(int *val) ATTR_NONNULL(1)
signed int int32_t
Definition BKE_text.h:78
static void png_extend_native_int32(Vector< uint8_t > &output, int32_t data)
std::optional< Vector< uint8_t > > blendthumb_create_png_data_from_thumb(const Thumbnail *thumb)
Array< uint8_t > data
Definition blendthumb.hh:25