pure_jpeg 0.4.0 → 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 81f59b74746cbb7c575aa22e250667b8b126a542613833f2e45b57685fed02c0
4
- data.tar.gz: 87fb8c2b6dd5035d93c4326a37fac8e43ade2af88f92a3dd1f7761960f675126
3
+ metadata.gz: a7cba14f204519502a426b6280fa399e807bd00c8fa076c3575ef2d6eeb6063a
4
+ data.tar.gz: d2c2034fdc8d6e80cb9e457d851844647ef22ac4df0ea9cf627f360138af8efb
5
5
  SHA512:
6
- metadata.gz: 930f8db2b6ab86080c115e77f56e0918853e455dbcd18129daa5aaca77715df198a502010ae218275799e8b364f115232e11139ffcb42ca981c57478ef12b45b
7
- data.tar.gz: 54c50b3a2316c6fa0b9db38fcabdd589bcc17d2edfeff653a28ec4054a72c2b5615eef5fd9f123fb31ce56448864495f49942bf63c4536d00c21fd4e7a6eb4f2
6
+ metadata.gz: 1a8da9b85c8360ff8511491b6142b0973512e771174efac2656490d446a1551bb761cce4f470bfb52bc2718cc118a2a9eb11cff8d9b114e8b2d1045718098279
7
+ data.tar.gz: b9cb05d197d502c918fb13e7d021a00093e5156b249eb81aa1be5702e8e52d5d8dc2fa9b051135bc5c049975d1391dda4f19641b958015a9a73455ebe3b1a229
data/CHANGELOG.md CHANGED
@@ -1,5 +1,46 @@
1
1
  # Changelog
2
2
 
3
+ ## 0.5.0 (The big memory usage reduction release)
4
+
5
+ Big release for memory usage! An 8 megapixel JPEG was using nearly half a gig to decode 😂 The progressive decoder was hanging on to every block's DCT coefficients while it put together the full image, but it can now finish a row of blocks and reuse that space for the next row. Baseline JPEGs get the same treatment.
6
+
7
+ One thing to watch when upgrading from 0.4.1. The default decode limit is now 8,000,000 pixels, so a 4000×3000 photo will raise `PureJPEG::DecodeError`. If you meant to read a photo that big, pass the limit on that call, as so:
8
+
9
+ ```ruby
10
+ PureJPEG.read("photo.jpg", max_pixels: 12_000_000)
11
+ ```
12
+
13
+ `Decoder.new` and `Decoder.decode` take `max_pixels:` as well. A 8192 pixel limit on width and height still applies. If all you need is the size, `PureJPEG.info(path)` works above the pixel limit and now stops reading the file when it reaches the first scan marker.
14
+
15
+ ## 0.4.1
16
+
17
+ This is a robustness and compatibility release. It makes decoding more reliable
18
+ across valid JPEG variants, improves handling of malformed input, and strengthens
19
+ Spinel support while preserving the existing public API and encoder output.
20
+
21
+ Fixes:
22
+
23
+ - Decode progressive images correctly when component edges require padded blocks
24
+ - Preserve each scan's restart interval and each component's original quantization table
25
+ - Decode baseline images with separate component scans and handle subsampled luminance
26
+ - Handle JPEG marker fill bytes correctly between scans and at restart boundaries
27
+ - Validate restart markers without recursion; reject malformed frame/scan parameters,
28
+ invalid Huffman tables, excessive coefficient runs, and incomplete scan data with `DecodeError`
29
+ - Reject unsupported precision and RGB/Adobe color transforms explicitly
30
+ - Read ICC headers after the frame header in `PureJPEG.info`; ignore incomplete or
31
+ inconsistent multipart profiles instead of returning partial profile bytes
32
+ - Treat binary garbage containing null bytes as data rather than a filesystem path
33
+ - Avoid a Spinel compiler bug in conditional hash assignment during decoding
34
+
35
+ Testing and packaging:
36
+
37
+ - Add small libjpeg-turbo fixtures with trusted decoded-pixel hashes and malformed-input regressions
38
+ - Add Spinel pixel-parity checks for the decoder fixes; all four package checks and
39
+ all eight selected RawSource tests pass on Spinel revision `2406a5649`
40
+ - Keep all existing tests, public API signatures, source-adapter behavior, and encoder output unchanged
41
+ - Run CI on pushes to `main` and smoke-test the built, installed gem without development dependencies
42
+ - Include creative-options documentation and IJG notices in the gem; correct the DCT algorithm attribution
43
+
3
44
  ## 0.4.0
4
45
 
5
46
  Performance:
data/CREATIVE.md ADDED
@@ -0,0 +1,100 @@
1
+ # Creative encoding with PureJPEG
2
+
3
+ PureJPEG exposes access to several 'knobs' to manipulate the JPEG encoding pipeline. These produce a range of aesthetic effects by controlling how the DCT frequency coefficients are quantized.
4
+
5
+ All examples assume:
6
+
7
+ ```ruby
8
+ require "chunky_png"
9
+ require_relative "lib/pure_jpeg"
10
+
11
+ image = ChunkyPNG::Image.from_file("input.png")
12
+ source = PureJPEG::Source::ChunkyPNGSource.new(image)
13
+ ```
14
+
15
+ ## Scrambled quantization ("early digicam" look)
16
+
17
+ The JPEG spec stores quantization tables in zigzag order. Enabling `scramble_quantization` writes them in raster order instead, which means any standard viewer applies the wrong quantization values to the wrong frequency coefficients. The result is a chaotic, crunchy artifact pattern reminiscent of early 2000s digital cameras (what I really wanted in the first place).
18
+
19
+ ```ruby
20
+ PureJPEG.encode(source, quality: 20, scramble_quantization: true).write("scrambled.jpg")
21
+ ```
22
+
23
+ Lower quality values amplify the effect.
24
+
25
+ ## Chroma crush (sharp detail, broken color)
26
+
27
+ Set high luminance quality but aggressively compress the chrominance channels. Detail and edges stay sharp but the color information collapses into large blocky patches with hue shifts.
28
+
29
+ ```ruby
30
+ PureJPEG.encode(source, quality: 90, chroma_quality: 5).write("chromacrush.jpg")
31
+ ```
32
+
33
+ ## Luma crush (soft image, faithful color)
34
+
35
+ The opposite: crush the luminance channel while preserving chrominance. Produces a soft, almost oil-painting quality where the image is blocky and low-detail but the colors remain surprisingly accurate.
36
+
37
+ ```ruby
38
+ PureJPEG.encode(source, quality: 10, chroma_quality: 95).write("lumacrush.jpg")
39
+ ```
40
+
41
+ ## DC-only (8x8 mosaic)
42
+
43
+ A custom quantization table that preserves only the DC coefficient (the average brightness of each 8x8 block) and kills all 63 AC coefficients. Every block becomes a single flat color, producing a hard mosaic effect.
44
+
45
+ ```ruby
46
+ dc_only = [1] + [255] * 63
47
+ PureJPEG.encode(source, luminance_table: dc_only, chrominance_table: dc_only).write("dconly.jpg")
48
+ ```
49
+
50
+ You can soften the mosaic by letting a few low-frequency AC coefficients through:
51
+
52
+ ```ruby
53
+ # Keep DC and the first few AC coefficients
54
+ gentle_mosaic = [1, 1, 1, 2, 4, 8] + [255] * 58
55
+ PureJPEG.encode(source, luminance_table: gentle_mosaic, chrominance_table: gentle_mosaic).write("gentle_mosaic.jpg")
56
+ ```
57
+
58
+ ## Inverted frequency emphasis
59
+
60
+ Normally JPEG preserves low frequencies (smooth gradients) and discards high frequencies (fine detail). This modifier inverts that, preserving edges and texture while crushing smooth areas. The result is an embossed or etched look.
61
+
62
+ ```ruby
63
+ inverter = ->(table, _channel) {
64
+ max = table.max
65
+ table.map { |v| [max + 1 - v, 1].max }
66
+ }
67
+ PureJPEG.encode(source, quality: 30, quantization_modifier: inverter).write("inverted.jpg")
68
+ ```
69
+
70
+ ## Combining effects
71
+
72
+ The `quantization_modifier` proc receives the table and a channel identifier (`:luminance` or `:chrominance`), so you can apply different transformations per channel:
73
+
74
+ ```ruby
75
+ modifier = ->(table, channel) {
76
+ case channel
77
+ when :luminance
78
+ # Sharpen luma by halving quantization values
79
+ table.map { |v| [v / 2, 1].max }
80
+ when :chrominance
81
+ # Posterize color by doubling quantization values
82
+ table.map { |v| [v * 2, 255].min }
83
+ end
84
+ }
85
+ PureJPEG.encode(source, quality: 50, quantization_modifier: modifier).write("combined.jpg")
86
+ ```
87
+
88
+ ## Full option reference
89
+
90
+ ```ruby
91
+ PureJPEG.encode(source,
92
+ quality: 85, # 1-100, overall compression level
93
+ grayscale: false, # encode as single-channel grayscale
94
+ chroma_quality: nil, # 1-100, independent Cb/Cr quality (defaults to quality)
95
+ luminance_table: nil, # custom 64-element quantization table for Y (raster order)
96
+ chrominance_table: nil, # custom 64-element quantization table for Cb/Cr (raster order)
97
+ quantization_modifier: nil, # proc(table, :luminance/:chrominance) -> modified table
98
+ scramble_quantization: false # write quant tables in wrong order (digicam effect)
99
+ )
100
+ ```
data/LICENSE CHANGED
@@ -19,3 +19,10 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
19
  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
20
  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
21
  SOFTWARE.
22
+
23
+ The integer DCT implementation in lib/pure_jpeg/dct.rb is adapted from the
24
+ Independent JPEG Group's jfdctint.c and jidctint.c. Its upstream copyright,
25
+ disclaimer, and distribution terms are included in LICENSE-IJG. PureJPEG's
26
+ adaptation ports the transforms to Ruby arrays, removes the C integration
27
+ and scaled-output variants, and normalizes forward coefficients before
28
+ quantization. The IJG-derived portions remain subject to those terms.
data/LICENSE-IJG ADDED
@@ -0,0 +1,260 @@
1
+ libjpeg-turbo note: This file has been modified by The libjpeg-turbo Project
2
+ to include only information relevant to libjpeg-turbo, to wordsmith certain
3
+ sections, and to remove impolitic language that existed in the libjpeg v8
4
+ README. It is included only for reference. Please see README.md for
5
+ information specific to libjpeg-turbo.
6
+
7
+
8
+ The Independent JPEG Group's JPEG software
9
+ ==========================================
10
+
11
+ This distribution contains a release of the Independent JPEG Group's free JPEG
12
+ software. You are welcome to redistribute this software and to use it for any
13
+ purpose, subject to the conditions under LEGAL ISSUES, below.
14
+
15
+ This software is the work of Tom Lane, Guido Vollbeding, Philip Gladstone,
16
+ Bill Allombert, Jim Boucher, Lee Crocker, Bob Friesenhahn, Ben Jackson,
17
+ Julian Minguillon, Luis Ortiz, George Phillips, Davide Rossi, Ge' Weijers,
18
+ and other members of the Independent JPEG Group.
19
+
20
+ IJG is not affiliated with the ISO/IEC JTC1/SC29/WG1 standards committee
21
+ (also known as JPEG, together with ITU-T SG16).
22
+
23
+
24
+ DOCUMENTATION ROADMAP
25
+ =====================
26
+
27
+ This file contains the following sections:
28
+
29
+ OVERVIEW General description of JPEG and the IJG software.
30
+ LEGAL ISSUES Copyright, lack of warranty, terms of distribution.
31
+ REFERENCES Where to learn more about JPEG.
32
+ ARCHIVE LOCATIONS Where to find newer versions of this software.
33
+ FILE FORMAT WARS Software *not* to get.
34
+ TO DO Plans for future IJG releases.
35
+
36
+ Other documentation files in the distribution are:
37
+
38
+ User documentation:
39
+ doc/usage.txt Usage instructions for cjpeg, djpeg, jpegtran,
40
+ rdjpgcom, and wrjpgcom.
41
+ doc/*.1 Unix-style man pages for programs (same info as
42
+ usage.txt).
43
+ doc/wizard.txt Advanced usage instructions for JPEG wizards only.
44
+ doc/change.log Version-to-version change highlights.
45
+ Programmer and internal documentation:
46
+ doc/libjpeg.txt How to use the JPEG library in your own programs.
47
+ src/example.c Sample code for calling the JPEG library.
48
+ doc/structure.txt Overview of the JPEG library's internal structure.
49
+ doc/coderules.txt Coding style rules --- please read if you contribute
50
+ code.
51
+
52
+ Please read at least usage.txt. Some information can also be found in the JPEG
53
+ FAQ (Frequently Asked Questions) article. See ARCHIVE LOCATIONS below to find
54
+ out where to obtain the FAQ article.
55
+
56
+ If you want to understand how the JPEG code works, we suggest reading one or
57
+ more of the REFERENCES, then looking at the documentation files (in roughly
58
+ the order listed) before diving into the code.
59
+
60
+
61
+ OVERVIEW
62
+ ========
63
+
64
+ This package contains C software to implement JPEG image encoding, decoding,
65
+ and transcoding. JPEG (pronounced "jay-peg") is a standardized compression
66
+ method for full-color and grayscale images. JPEG's strong suit is compressing
67
+ photographic images or other types of images that have smooth color and
68
+ brightness transitions between neighboring pixels. Images with sharp lines or
69
+ other abrupt features may not compress well with JPEG, and a higher JPEG
70
+ quality may have to be used to avoid visible compression artifacts with such
71
+ images.
72
+
73
+ JPEG is normally lossy, meaning that the output pixels are not necessarily
74
+ identical to the input pixels. However, on photographic content and other
75
+ "smooth" images, very good compression ratios can be obtained with no visible
76
+ compression artifacts, and extremely high compression ratios are possible if
77
+ you are willing to sacrifice image quality (by reducing the "quality" setting
78
+ in the compressor.)
79
+
80
+ This software implements JPEG baseline, extended-sequential, progressive, and
81
+ lossless compression processes. Provision is made for supporting all variants
82
+ of these processes, although some uncommon parameter settings aren't
83
+ implemented yet. We have made no provision for supporting the hierarchical
84
+ processes defined in the standard.
85
+
86
+ We provide a set of library routines for reading and writing JPEG image files,
87
+ plus two sample applications "cjpeg" and "djpeg", which use the library to
88
+ perform conversion between JPEG and some other popular image file formats.
89
+ The library is intended to be reused in other applications.
90
+
91
+ In order to support file conversion and viewing software, we have included
92
+ considerable functionality beyond the bare JPEG coding/decoding capability;
93
+ for example, the color quantization modules are not strictly part of JPEG
94
+ decoding, but they are essential for output to colormapped file formats. These
95
+ extra functions can be compiled out of the library if not required for a
96
+ particular application.
97
+
98
+ We have also included "jpegtran", a utility for lossless transcoding between
99
+ different JPEG processes, and "rdjpgcom" and "wrjpgcom", two simple
100
+ applications for inserting and extracting textual comments in JFIF files.
101
+
102
+ The emphasis in designing this software has been on achieving portability and
103
+ flexibility, while also making it fast enough to be useful. In particular,
104
+ the software is not intended to be read as a tutorial on JPEG. (See the
105
+ REFERENCES section for introductory material.) Rather, it is intended to
106
+ be reliable, portable, industrial-strength code. We do not claim to have
107
+ achieved that goal in every aspect of the software, but we strive for it.
108
+
109
+ We welcome the use of this software as a component of commercial products.
110
+ No royalty is required, but we do ask for an acknowledgement in product
111
+ documentation, as described under LEGAL ISSUES.
112
+
113
+
114
+ LEGAL ISSUES
115
+ ============
116
+
117
+ In plain English:
118
+
119
+ 1. We don't promise that this software works. (But if you find any bugs,
120
+ please let us know!)
121
+ 2. You can use this software for whatever you want. You don't have to pay us.
122
+ 3. You may not pretend that you wrote this software. If you use it in a
123
+ program, you must acknowledge somewhere in your documentation that
124
+ you've used the IJG code.
125
+
126
+ In legalese:
127
+
128
+ The authors make NO WARRANTY or representation, either express or implied,
129
+ with respect to this software, its quality, accuracy, merchantability, or
130
+ fitness for a particular purpose. This software is provided "AS IS", and you,
131
+ its user, assume the entire risk as to its quality and accuracy.
132
+
133
+ This software is copyright (C) 1991-2020, Thomas G. Lane, Guido Vollbeding.
134
+ All Rights Reserved except as specified below.
135
+
136
+ Permission is hereby granted to use, copy, modify, and distribute this
137
+ software (or portions thereof) for any purpose, without fee, subject to these
138
+ conditions:
139
+ (1) If any part of the source code for this software is distributed, then this
140
+ README file must be included, with this copyright and no-warranty notice
141
+ unaltered; and any additions, deletions, or changes to the original files
142
+ must be clearly indicated in accompanying documentation.
143
+ (2) If only executable code is distributed, then the accompanying
144
+ documentation must state that "this software is based in part on the work of
145
+ the Independent JPEG Group".
146
+ (3) Permission for use of this software is granted only if the user accepts
147
+ full responsibility for any undesirable consequences; the authors accept
148
+ NO LIABILITY for damages of any kind.
149
+
150
+ These conditions apply to any software derived from or based on the IJG code,
151
+ not just to the unmodified library. If you use our work, you ought to
152
+ acknowledge us.
153
+
154
+ Permission is NOT granted for the use of any IJG author's name or company name
155
+ in advertising or publicity relating to this software or products derived from
156
+ it. This software may be referred to only as "the Independent JPEG Group's
157
+ software".
158
+
159
+ We specifically permit and encourage the use of this software as the basis of
160
+ commercial products, provided that all warranty or liability claims are
161
+ assumed by the product vendor.
162
+
163
+
164
+ REFERENCES
165
+ ==========
166
+
167
+ We recommend reading one or more of these references before trying to
168
+ understand the innards of the JPEG software.
169
+
170
+ The best short technical introduction to the JPEG compression algorithm is
171
+ Wallace, Gregory K. "The JPEG Still Picture Compression Standard",
172
+ Communications of the ACM, April 1991 (vol. 34 no. 4), pp. 30-44.
173
+ (Adjacent articles in that issue discuss MPEG motion picture compression,
174
+ applications of JPEG, and related topics.) If you don't have the CACM issue
175
+ handy, a PDF file containing a revised version of Wallace's article is
176
+ available at http://www.ijg.org/files/Wallace.JPEG.pdf. The file (actually
177
+ a preprint for an article that appeared in IEEE Trans. Consumer Electronics)
178
+ omits the sample images that appeared in CACM, but it includes corrections
179
+ and some added material. Note: the Wallace article is copyright ACM and IEEE,
180
+ and it may not be used for commercial purposes.
181
+
182
+ A somewhat less technical, more leisurely introduction to JPEG can be found in
183
+ "The Data Compression Book" by Mark Nelson and Jean-loup Gailly, published by
184
+ M&T Books (New York), 2nd ed. 1996, ISBN 1-55851-434-1. This book provides
185
+ good explanations and example C code for a multitude of compression methods
186
+ including JPEG. It is an excellent source if you are comfortable reading C
187
+ code but don't know much about data compression in general. The book's JPEG
188
+ sample code is far from industrial-strength, but when you are ready to look
189
+ at a full implementation, you've got one here...
190
+
191
+ The best currently available description of JPEG is the textbook "JPEG Still
192
+ Image Data Compression Standard" by William B. Pennebaker and Joan L.
193
+ Mitchell, published by Van Nostrand Reinhold, 1993, ISBN 0-442-01272-1.
194
+ Price US$59.95, 638 pp. The book includes the complete text of the ISO JPEG
195
+ standards (DIS 10918-1 and draft DIS 10918-2).
196
+
197
+ The original JPEG standard is divided into two parts, Part 1 being the actual
198
+ specification, while Part 2 covers compliance testing methods. Part 1 is
199
+ titled "Digital Compression and Coding of Continuous-tone Still Images,
200
+ Part 1: Requirements and guidelines" and has document numbers ISO/IEC IS
201
+ 10918-1, ITU-T T.81. Part 2 is titled "Digital Compression and Coding of
202
+ Continuous-tone Still Images, Part 2: Compliance testing" and has document
203
+ numbers ISO/IEC IS 10918-2, ITU-T T.83.
204
+
205
+ The JPEG standard does not specify all details of an interchangeable file
206
+ format. For the omitted details, we follow the "JFIF" conventions, revision
207
+ 1.02. JFIF version 1 has been adopted as ISO/IEC 10918-5 (05/2013) and
208
+ Recommendation ITU-T T.871 (05/2011): Information technology - Digital
209
+ compression and coding of continuous-tone still images: JPEG File Interchange
210
+ Format (JFIF). It is available as a free download in PDF file format from
211
+ https://www.iso.org/standard/54989.html and http://www.itu.int/rec/T-REC-T.871.
212
+ A PDF file of the older JFIF 1.02 specification is available at
213
+ http://www.w3.org/Graphics/JPEG/jfif3.pdf.
214
+
215
+ The TIFF 6.0 file format specification can be obtained from
216
+ http://mirrors.ctan.org/graphics/tiff/TIFF6.ps.gz. The JPEG incorporation
217
+ scheme found in the TIFF 6.0 spec of 3-June-92 has a number of serious
218
+ problems. IJG does not recommend use of the TIFF 6.0 design (TIFF Compression
219
+ tag 6). Instead, we recommend the JPEG design proposed by TIFF Technical Note
220
+ #2 (Compression tag 7). Copies of this Note can be obtained from
221
+ http://www.ijg.org/files/. It is expected that the next revision
222
+ of the TIFF spec will replace the 6.0 JPEG design with the Note's design.
223
+ Although IJG's own code does not support TIFF/JPEG, the free libtiff library
224
+ uses our library to implement TIFF/JPEG per the Note.
225
+
226
+
227
+ ARCHIVE LOCATIONS
228
+ =================
229
+
230
+ The "official" archive site for this software is www.ijg.org.
231
+ The most recent released version can always be found there in
232
+ directory "files".
233
+
234
+ The JPEG FAQ (Frequently Asked Questions) article is a source of some
235
+ general information about JPEG. It is available at
236
+ http://www.faqs.org/faqs/jpeg-faq.
237
+
238
+
239
+ FILE FORMAT COMPATIBILITY
240
+ =========================
241
+
242
+ This software implements ITU T.81 | ISO/IEC 10918 with some extensions from
243
+ ITU T.871 | ISO/IEC 10918-5 (JPEG File Interchange Format-- see REFERENCES).
244
+ Informally, the term "JPEG image" or "JPEG file" most often refers to JFIF or
245
+ a subset thereof, but there are other formats containing the name "JPEG" that
246
+ are incompatible with the original JPEG standard or with JFIF (for instance,
247
+ JPEG 2000 and JPEG XR). This software therefore does not support these
248
+ formats. Indeed, one of the original reasons for developing this free software
249
+ was to help force convergence on a common, interoperable format standard for
250
+ JPEG files.
251
+
252
+ JFIF is a minimal or "low end" representation. TIFF/JPEG (TIFF revision 6.0 as
253
+ modified by TIFF Technical Note #2) can be used for "high end" applications
254
+ that need to record a lot of additional data about an image.
255
+
256
+
257
+ TO DO
258
+ =====
259
+
260
+ Please send bug reports, offers of help, etc. to jpeg-info@jpegclub.org.
data/README.md CHANGED
@@ -6,7 +6,7 @@
6
6
 
7
7
  Convert PNG or other pixel data to JPEG. Or the other way! Implements baseline JPEG encoding (DCT, Huffman, 4:2:0 chroma subsampling) and decodes both baseline and progressive JPEGs. Exposes a variety of encoding options to adjust parts of the JPEG pipeline not normally available (I needed this to recreate the JPEG compression styles of older digital cameras - don't ask..)
8
8
 
9
- It works on CRuby 3.0+, TruffleRuby 33.0, JRuby 10.0, and [Spinel](https://github.com/matz/spinel) (tested at `7f08abd9`). There's *almost* 100% test coverage - I need to find some "broken" JPEGs to do the rest (hit me up if you have any sources..)
9
+ It works on CRuby 3.0+, TruffleRuby 33.0, JRuby 10.0, and [Spinel](https://github.com/matz/spinel) (tested at `7f08abd9`). Tests include external JPEG fixtures with pixel expectations generated by libjpeg-turbo, alongside round-trip and malformed-input checks.
10
10
 
11
11
  > [!NOTE]
12
12
  > Rubyists might find the [AI Disclosure](#ai-disclosure) section below of interest.
@@ -23,6 +23,15 @@ gem "pure_jpeg"
23
23
  gem install pure_jpeg
24
24
  ```
25
25
 
26
+ > [!NOTE]
27
+ > Using [Spinel](https://github.com/matz/spinel)? Add PureJPEG from your Spin project directory:
28
+ >
29
+ > ```sh
30
+ > spin add pure_jpeg --git https://github.com/peterc/pure_jpeg
31
+ > ```
32
+ >
33
+ > Then use `require "pure_jpeg"` in your code as usual.
34
+
26
35
  There are no runtime dependencies. [ChunkyPNG](https://github.com/wvanbergen/chunky_png) is optional (though quite useful) if you want to use `from_chunky_png`.
27
36
 
28
37
  `examples/` contains some useful example scripts for basic JPEG to PNG and PNG to JPEG conversion if you want to do some quick tests without writing code.
@@ -143,6 +152,23 @@ pixel.b # => 97
143
152
  image = PureJPEG.read(jpeg_bytes)
144
153
  ```
145
154
 
155
+ ### Decode size limit
156
+
157
+ Starting in 0.5.0, decoding defaults to a maximum of **8,000,000 pixels** (`width * height`).
158
+ Larger images raise `PureJPEG::DecodeError` as soon as their dimensions are read,
159
+ before scan data is collected or image buffers are allocated. Set a positive
160
+ integer `max_pixels:` to lower or raise the limit for an individual decode:
161
+
162
+ ```ruby
163
+ image = PureJPEG.read("photo.jpg", max_pixels: 20_000_000)
164
+ image = PureJPEG.read(jpeg_bytes, max_pixels: 1_000_000)
165
+ ```
166
+
167
+ `PureJPEG::Decoder.decode` and `PureJPEG::Decoder.new` accept the same option.
168
+ The 8192-pixel limit on each axis still applies. Raising `max_pixels:` permits
169
+ higher memory use; the pixel limit is not a hard process-memory limit.
170
+ `PureJPEG.info` can inspect larger images without decoding their pixels.
171
+
146
172
  ### Read dimensions and metadata only
147
173
 
148
174
  ```ruby
@@ -151,8 +177,13 @@ info.width # => 1024
151
177
  info.height # => 768
152
178
  info.component_count # => 3
153
179
  info.progressive # => false
180
+ info.icc_profile # => binary profile bytes, or nil
154
181
  ```
155
182
 
183
+ Metadata queries read headers through the first scan marker, without decoding
184
+ pixels. Incomplete or inconsistent multipart ICC profiles are ignored and
185
+ reported as `nil`. ICC extraction does not perform color-profile conversion.
186
+
156
187
  ### Iterating pixels
157
188
 
158
189
  ```ruby
@@ -198,8 +229,20 @@ Decoding:
198
229
  - 1-component (grayscale) and 3-component (YCbCr) images
199
230
  - Any chroma subsampling factor (4:4:4, 4:2:2, 4:2:0, etc.)
200
231
  - Restart markers (DRI/RST)
232
+ - Separate component scans in baseline JPEGs
201
233
 
202
- Not supported: arithmetic coding, 12-bit precision, EXIF/ICC profile preservation, adding a default background for transparent sources (see what happens above!). Largely because I don't need these, but they are all do-able, especially with how loosely coupled this library is internally. Raise an issue if you really care about them!
234
+ Encoding and decoding allow dimensions up to 8192 pixels on each axis. Decoding
235
+ also limits image area to 8,000,000 pixels by default, configurable with
236
+ `max_pixels:`. The decoder keeps the compressed scans and the final packed
237
+ RGB image in memory. It reuses one MCU row of sample and coefficient buffers
238
+ across the image, including for progressive JPEGs. `PureJPEG.info` can inspect
239
+ dimensions without allocating pixel buffers and does not apply the decode pixel limit.
240
+ Invalid or unsupported JPEG data raises `PureJPEG::DecodeError`.
241
+
242
+ Not supported: arithmetic coding, 12-bit precision, RGB/CMYK JPEG color spaces,
243
+ or EXIF/ICC profile preservation when re-encoding. Transparent PNG sources can
244
+ be composited with the explicit `background:` option above. Raise an issue if
245
+ you need one of the unsupported formats!
203
246
 
204
247
  Possible future improvements: ICC profile rendering/conversion.
205
248
 
@@ -215,7 +258,7 @@ On the bundled 1024x1024 images (Apple M5, median of 15 runs after 20 seconds of
215
258
 
216
259
  Inputs were loaded before timing, and encoded output was returned in memory; file I/O and PNG loading are excluded. Runtimes were benchmarked sequentially. JRuby used its default JIT on OpenJDK 21.0.10. Spinel was measured separately with the same inputs and timing protocol, using a portable harness with PNG pixels preloaded; its encoded JPEG and decoded pixels matched CRuby byte-for-byte. Results vary with image content, garbage collection, and JIT warmup.
217
260
 
218
- The encoder and decoder use an integer-scaled AAN (Arai-Agui-Nakajima) DCT with fixed-point arithmetic throughout — no Float operations in the hot path. Color space conversion uses fixed-point integer math, and pixel data is stored as packed integers to avoid per-pixel object allocation. TruffleRuby's Graal JIT compiler can optimize these tight integer loops particularly well once warmed up.
261
+ The encoder and decoder use the IJG accurate integer DCT, based on the Loeffler factorization, with fixed-point arithmetic throughout — no Float operations in the hot path. Color space conversion uses fixed-point integer math, and pixel data is stored as packed integers to avoid per-pixel object allocation. TruffleRuby's Graal JIT compiler can optimize these tight integer loops particularly well once warmed up.
219
262
 
220
263
  ## Example scripts
221
264
 
@@ -266,6 +309,19 @@ rake benchmark # basic benchmark of encoding and decoding (5 runs after warmup
266
309
  rake profile # CPU profile with StackProf (requires the stackprof gem)
267
310
  ```
268
311
 
312
+ The Minitest suite lives in `test/minitest/`; `rake` and `rake test` run it
313
+ with SimpleCov as before. To run one file:
314
+
315
+ ```sh
316
+ bundle exec rake test TEST=test/minitest/test_raw_source.rb
317
+ ```
318
+
319
+ With Spinel and Spin installed, `spin test` runs the standalone package checks
320
+ in `test/*.rb`, comparing their output with CRuby. These cover color/grayscale
321
+ round trips, metadata, and invalid input; they supplement the full Minitest
322
+ suite. See [test/SPINEL.md](test/SPINEL.md) for details and the existing
323
+ `rake test:spinel` runner.
324
+
269
325
  ## Full benchmark script
270
326
 
271
327
  `benchmark/run.rb` is a more thorough benchmark that exercises the encode and decode paths in several ways. It auto-enables YJIT, warms up before measuring, and reports object allocations, throughput (iterations/second via `benchmark-ips`), best-of-N wall-clock times, and a sustained mixed workload across encode (q85, q95 optimized, grayscale) and decode (baseline and progressive).
@@ -278,6 +334,14 @@ ruby benchmark/run.rb --profile # CPU profile with Vernier (writes JSON t
278
334
  ruby benchmark/run.rb --profile-alloc # retained-object profile with Vernier
279
335
  ```
280
336
 
337
+ To measure decoder peak resident memory on macOS or Linux with GNU time,
338
+ run the following command. Each JPEG gets a fresh Ruby process. Omit the
339
+ paths to measure the bundled baseline and progressive images.
340
+
341
+ ```sh
342
+ ruby benchmark/decode_memory.rb photo.jpg progressive.jpg
343
+ ```
344
+
281
345
  ## AI Disclosure
282
346
 
283
347
  **Claude Code did the majority of the work.** The math of JPEG encoding/decoding is beyond me, except 'getting it' at a high level. I understand it like I understand the engine in my car :-) *Later update: OpenAI Codex is also reviewing and adding features now. It feels stronger in many areas.*
@@ -301,4 +365,6 @@ ruby benchmark/run.rb --profile-alloc # retained-object profile with Vernier
301
365
 
302
366
  ## License
303
367
 
304
- MIT
368
+ MIT, with IJG terms for the adapted integer DCT implementation. This software
369
+ is based in part on the work of the Independent JPEG Group. See [LICENSE](LICENSE)
370
+ and [LICENSE-IJG](LICENSE-IJG) for the notices and adaptation details.
@@ -35,6 +35,26 @@ module PureJPEG
35
35
  @buffer = 0
36
36
  end
37
37
 
38
+ # Consume exactly the restart expected at an MCU boundary. Marker fill
39
+ # bytes are allowed; entropy bytes and out-of-sequence restarts are not.
40
+ def read_restart(expected)
41
+ reset
42
+ unless @data.getbyte(@pos) == 0xFF
43
+ raise DecodeError, "Missing JPEG restart marker"
44
+ end
45
+ @pos += 1 while @pos < @length && @data.getbyte(@pos) == 0xFF
46
+ unless @data.getbyte(@pos) == 0xD0 + expected
47
+ raise DecodeError, "Unexpected JPEG restart marker (expected RST#{expected})"
48
+ end
49
+ @pos += 1
50
+ end
51
+
52
+ def finish_scan!
53
+ # Remaining bits in the last byte are padding, but whole unread bytes
54
+ # indicate extra entropy data or an unexpected trailing restart marker.
55
+ raise DecodeError, "Extra data after JPEG scan" unless @pos == @length
56
+ end
57
+
38
58
  # Read additional bits and sign-extend per JPEG spec (receive/extend).
39
59
  def receive_extend(size)
40
60
  return 0 if size == 0
@@ -56,10 +76,7 @@ module PureJPEG
56
76
  raise PureJPEG::DecodeError, "Unexpected end of scan data" if @pos >= @length
57
77
  next_byte = @data.getbyte(@pos)
58
78
  @pos += 1
59
- # 0xFF 0x00 is a stuffed 0xFF byte
60
- # Skip restart markers (0xD0-0xD7)
61
- return fill_buffer if next_byte != 0x00 && next_byte >= 0xD0 && next_byte <= 0xD7
62
- # For 0x00, the byte is 0xFF (stuffing removed)
79
+ raise DecodeError, "Unexpected marker in JPEG entropy data" unless next_byte == 0x00
63
80
  end
64
81
  @buffer = byte
65
82
  @bits_in_buffer = 8
data/lib/pure_jpeg/dct.rb CHANGED
@@ -2,8 +2,10 @@
2
2
 
3
3
  module PureJPEG
4
4
  # Integer-scaled DCT based on the IJG (Independent JPEG Group) reference
5
- # implementation (jfdctint.c / jidctint.c). Uses the Arai-Agui-Nakajima
6
- # factorization with 13-bit fixed-point constants.
5
+ # implementation (jfdctint.c / jidctint.c). Uses the Loeffler-based accurate
6
+ # integer factorization with 13-bit fixed-point constants. The upstream
7
+ # copyright and distribution terms are included in LICENSE-IJG; adaptation
8
+ # details are recorded in LICENSE.
7
9
  #
8
10
  # All arithmetic is pure Integer (additions, shifts, multiplies) — no Float
9
11
  # operations. This is ~3x faster than the matrix-multiply float DCT under