138151a2f62c81de5270f9188ff211d53c59a745
[xonotic/netradiant.git] / plugins / image / jpeg.cpp
1 /*
2    Copyright (c) 2001, Loki software, inc.
3    All rights reserved.
4
5    Redistribution and use in source and binary forms, with or without modification,
6    are permitted provided that the following conditions are met:
7
8    Redistributions of source code must retain the above copyright notice, this list
9    of conditions and the following disclaimer.
10
11    Redistributions in binary form must reproduce the above copyright notice, this
12    list of conditions and the following disclaimer in the documentation and/or
13    other materials provided with the distribution.
14
15    Neither the name of Loki software nor the names of its contributors may be used
16    to endorse or promote products derived from this software without specific prior
17    written permission.
18
19    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
20    AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21    IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22    DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY
23    DIRECT,INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
24    (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25    LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
26    ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
28    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 //
32 // Functions to load JPEG files from a buffer, based on jdatasrc.c
33 //
34 // Leonardo Zide (leo@lokigames.com)
35 //
36
37 #include "jpeg.h"
38
39 #include <setjmp.h>
40 #include <stdlib.h>
41 #include <stdio.h>
42 #include <string.h>
43
44 extern "C" {
45 #include <jpeglib.h>
46 #include <jerror.h>
47 }
48
49 #include "ifilesystem.h"
50
51 #include "imagelib.h"
52
53 typedef unsigned char byte;
54
55 /* Expanded data source object for stdio input */
56
57 typedef struct {
58         struct jpeg_source_mgr pub; /* public fields */
59
60         int src_size;
61         JOCTET * src_buffer;
62
63         JOCTET * buffer;    /* start of buffer */
64         boolean start_of_file;  /* have we gotten any data yet? */
65 } my_source_mgr;
66
67 typedef my_source_mgr * my_src_ptr;
68
69 #define INPUT_BUF_SIZE  4096    /* choose an efficiently fread'able size */
70
71
72 /*
73  * Initialize source --- called by jpeg_read_header
74  * before any data is actually read.
75  */
76
77 static void my_init_source( j_decompress_ptr cinfo ){
78         my_src_ptr src = (my_src_ptr) cinfo->src;
79
80         /* We reset the empty-input-file flag for each image,
81          * but we don't clear the input buffer.
82          * This is correct behavior for reading a series of images from one source.
83          */
84         src->start_of_file = TRUE;
85 }
86
87
88 /*
89  * Fill the input buffer --- called whenever buffer is emptied.
90  *
91  * In typical applications, this should read fresh data into the buffer
92  * (ignoring the current state of next_input_byte & bytes_in_buffer),
93  * reset the pointer & count to the start of the buffer, and return TRUE
94  * indicating that the buffer has been reloaded.  It is not necessary to
95  * fill the buffer entirely, only to obtain at least one more byte.
96  *
97  * There is no such thing as an EOF return.  If the end of the file has been
98  * reached, the routine has a choice of ERREXIT() or inserting fake data into
99  * the buffer.  In most cases, generating a warning message and inserting a
100  * fake EOI marker is the best course of action --- this will allow the
101  * decompressor to output however much of the image is there.  However,
102  * the resulting error message is misleading if the real problem is an empty
103  * input file, so we handle that case specially.
104  *
105  * In applications that need to be able to suspend compression due to input
106  * not being available yet, a FALSE return indicates that no more data can be
107  * obtained right now, but more may be forthcoming later.  In this situation,
108  * the decompressor will return to its caller (with an indication of the
109  * number of scanlines it has read, if any).  The application should resume
110  * decompression after it has loaded more data into the input buffer.  Note
111  * that there are substantial restrictions on the use of suspension --- see
112  * the documentation.
113  *
114  * When suspending, the decompressor will back up to a convenient restart point
115  * (typically the start of the current MCU). next_input_byte & bytes_in_buffer
116  * indicate where the restart point will be if the current call returns FALSE.
117  * Data beyond this point must be rescanned after resumption, so move it to
118  * the front of the buffer rather than discarding it.
119  */
120
121 static boolean my_fill_input_buffer( j_decompress_ptr cinfo ){
122         my_src_ptr src = (my_src_ptr) cinfo->src;
123         size_t nbytes;
124
125         if ( src->src_size > INPUT_BUF_SIZE ) {
126                 nbytes = INPUT_BUF_SIZE;
127         }
128         else{
129                 nbytes = src->src_size;
130         }
131
132         memcpy( src->buffer, src->src_buffer, nbytes );
133         src->src_buffer += nbytes;
134         src->src_size -= nbytes;
135
136         if ( nbytes <= 0 ) {
137                 if ( src->start_of_file ) { /* Treat empty input file as fatal error */
138                         ERREXIT( cinfo, JERR_INPUT_EMPTY );
139                 }
140                 WARNMS( cinfo, JWRN_JPEG_EOF );
141                 /* Insert a fake EOI marker */
142                 src->buffer[0] = (JOCTET) 0xFF;
143                 src->buffer[1] = (JOCTET) JPEG_EOI;
144                 nbytes = 2;
145         }
146
147         src->pub.next_input_byte = src->buffer;
148         src->pub.bytes_in_buffer = nbytes;
149         src->start_of_file = FALSE;
150
151         return TRUE;
152 }
153
154
155 /*
156  * Skip data --- used to skip over a potentially large amount of
157  * uninteresting data (such as an APPn marker).
158  *
159  * Writers of suspendable-input applications must note that skip_input_data
160  * is not granted the right to give a suspension return.  If the skip extends
161  * beyond the data currently in the buffer, the buffer can be marked empty so
162  * that the next read will cause a fill_input_buffer call that can suspend.
163  * Arranging for additional bytes to be discarded before reloading the input
164  * buffer is the application writer's problem.
165  */
166
167 static void my_skip_input_data( j_decompress_ptr cinfo, long num_bytes ){
168         my_src_ptr src = (my_src_ptr) cinfo->src;
169
170         /* Just a dumb implementation for now.  Could use fseek() except
171          * it doesn't work on pipes.  Not clear that being smart is worth
172          * any trouble anyway --- large skips are infrequent.
173          */
174         if ( num_bytes > 0 ) {
175                 while ( num_bytes > (long) src->pub.bytes_in_buffer ) {
176                         num_bytes -= (long) src->pub.bytes_in_buffer;
177                         (void) my_fill_input_buffer( cinfo );
178                         /* note we assume that fill_input_buffer will never return FALSE,
179                          * so suspension need not be handled.
180                          */
181                 }
182                 src->pub.next_input_byte += (size_t) num_bytes;
183                 src->pub.bytes_in_buffer -= (size_t) num_bytes;
184         }
185 }
186
187
188 /*
189  * An additional method that can be provided by data source modules is the
190  * resync_to_restart method for error recovery in the presence of RST markers.
191  * For the moment, this source module just uses the default resync method
192  * provided by the JPEG library.  That method assumes that no backtracking
193  * is possible.
194  */
195
196
197 /*
198  * Terminate source --- called by jpeg_finish_decompress
199  * after all data has been read.  Often a no-op.
200  *
201  * NB: *not* called by jpeg_abort or jpeg_destroy; surrounding
202  * application must deal with any cleanup that should happen even
203  * for error exit.
204  */
205
206 static void my_term_source( j_decompress_ptr cinfo ){
207         /* no work necessary here */
208 }
209
210
211 /*
212  * Prepare for input from a stdio stream.
213  * The caller must have already opened the stream, and is responsible
214  * for closing it after finishing decompression.
215  */
216
217 static void jpeg_buffer_src( j_decompress_ptr cinfo, void* buffer, int bufsize ){
218         my_src_ptr src;
219
220         /* The source object and input buffer are made permanent so that a series
221          * of JPEG images can be read from the same file by calling jpeg_stdio_src
222          * only before the first one.  (If we discarded the buffer at the end of
223          * one image, we'd likely lose the start of the next one.)
224          * This makes it unsafe to use this manager and a different source
225          * manager serially with the same JPEG object.  Caveat programmer.
226          */
227         if ( cinfo->src == NULL ) { /* first time for this JPEG object? */
228                 cinfo->src = (struct jpeg_source_mgr *)
229                                          ( *cinfo->mem->alloc_small )( (j_common_ptr) cinfo, JPOOL_PERMANENT,
230                                                                                                    sizeof( my_source_mgr ) );
231                 src = (my_src_ptr) cinfo->src;
232                 src->buffer = (JOCTET *)
233                                           ( *cinfo->mem->alloc_small )( (j_common_ptr) cinfo, JPOOL_PERMANENT,
234                                                                                                         INPUT_BUF_SIZE * sizeof( JOCTET ) );
235         }
236
237         src = (my_src_ptr) cinfo->src;
238         src->pub.init_source = my_init_source;
239         src->pub.fill_input_buffer = my_fill_input_buffer;
240         src->pub.skip_input_data = my_skip_input_data;
241         src->pub.resync_to_restart = jpeg_resync_to_restart; /* use default method */
242         src->pub.term_source = my_term_source;
243         src->src_buffer = (JOCTET *)buffer;
244         src->src_size = bufsize;
245         src->pub.bytes_in_buffer = 0; /* forces fill_input_buffer on first read */
246         src->pub.next_input_byte = NULL; /* until buffer loaded */
247 }
248
249 // =============================================================================
250
251 static char errormsg[JMSG_LENGTH_MAX];
252
253 typedef struct my_jpeg_error_mgr
254 {
255         struct jpeg_error_mgr pub; // "public" fields
256         jmp_buf setjmp_buffer;    // for return to caller
257 } bt_jpeg_error_mgr;
258
259 static void my_jpeg_error_exit( j_common_ptr cinfo ){
260         my_jpeg_error_mgr* myerr = (bt_jpeg_error_mgr*) cinfo->err;
261
262         ( *cinfo->err->format_message )( cinfo, errormsg );
263
264         longjmp( myerr->setjmp_buffer, 1 );
265 }
266
267 // stash a scanline
268 static void j_putRGBScanline( unsigned char* jpegline, int widthPix, unsigned char* outBuf, int row ){
269         int offset = row * widthPix * 4;
270         int count;
271
272         for ( count = 0; count < widthPix; count++ )
273         {
274                 unsigned char iRed, iBlu, iGrn;
275                 unsigned char *oRed, *oBlu, *oGrn, *oAlp;
276
277                 iRed = *( jpegline + count * 3 + 0 );
278                 iGrn = *( jpegline + count * 3 + 1 );
279                 iBlu = *( jpegline + count * 3 + 2 );
280
281                 oRed = outBuf + offset + count * 4 + 0;
282                 oGrn = outBuf + offset + count * 4 + 1;
283                 oBlu = outBuf + offset + count * 4 + 2;
284                 oAlp = outBuf + offset + count * 4 + 3;
285
286                 *oRed = iRed;
287                 *oGrn = iGrn;
288                 *oBlu = iBlu;
289                 *oAlp = 255;
290         }
291 }
292
293 // stash a scanline
294 static void j_putRGBAScanline( unsigned char* jpegline, int widthPix, unsigned char* outBuf, int row ){
295         int offset = row * widthPix * 4;
296         int count;
297
298         for ( count = 0; count < widthPix; count++ )
299         {
300                 unsigned char iRed, iBlu, iGrn, iAlp;
301                 unsigned char *oRed, *oBlu, *oGrn, *oAlp;
302
303                 iRed = *( jpegline + count * 4 + 0 );
304                 iGrn = *( jpegline + count * 4 + 1 );
305                 iBlu = *( jpegline + count * 4 + 2 );
306                 iAlp = *( jpegline + count * 4 + 3 );
307
308                 oRed = outBuf + offset + count * 4 + 0;
309                 oGrn = outBuf + offset + count * 4 + 1;
310                 oBlu = outBuf + offset + count * 4 + 2;
311                 oAlp = outBuf + offset + count * 4 + 3;
312
313                 *oRed = iRed;
314                 *oGrn = iGrn;
315                 *oBlu = iBlu;
316
317                 //!\todo fix jpeglib, it leaves alpha channel uninitialised
318 #if 1
319                 *oAlp = 255;
320 #else
321                 *oAlp = iAlp;
322 #endif
323         }
324 }
325
326 // stash a gray scanline
327 static void j_putGrayScanlineToRGB( unsigned char* jpegline, int widthPix, unsigned char* outBuf, int row ){
328         int offset = row * widthPix * 4;
329         int count;
330
331         for ( count = 0; count < widthPix; count++ )
332         {
333                 unsigned char iGray;
334                 unsigned char *oRed, *oBlu, *oGrn, *oAlp;
335
336                 // get our grayscale value
337                 iGray = *( jpegline + count );
338
339                 oRed = outBuf + offset + count * 4;
340                 oGrn = outBuf + offset + count * 4 + 1;
341                 oBlu = outBuf + offset + count * 4 + 2;
342                 oAlp = outBuf + offset + count * 4 + 3;
343
344                 *oRed = iGray;
345                 *oGrn = iGray;
346                 *oBlu = iGray;
347                 *oAlp = 255;
348         }
349 }
350
351 static Image* LoadJPGBuff_( const void *src_buffer, int src_size ){
352         struct jpeg_decompress_struct cinfo;
353         struct my_jpeg_error_mgr jerr;
354
355         cinfo.err = jpeg_std_error( &jerr.pub );
356         jerr.pub.error_exit = my_jpeg_error_exit;
357
358         if ( setjmp( jerr.setjmp_buffer ) ) { //< TODO: use c++ exceptions instead of setjmp/longjmp to handle errors
359                 globalErrorStream() << "WARNING: JPEG library error: " << errormsg << "\n";
360                 jpeg_destroy_decompress( &cinfo );
361                 return 0;
362         }
363
364         jpeg_create_decompress( &cinfo );
365         jpeg_buffer_src( &cinfo, const_cast<void*>( src_buffer ), src_size );
366         jpeg_read_header( &cinfo, TRUE );
367         jpeg_start_decompress( &cinfo );
368
369         int row_stride = cinfo.output_width * cinfo.output_components;
370
371         RGBAImage* image = new RGBAImage( cinfo.output_width, cinfo.output_height );
372
373         JSAMPARRAY buffer = ( *cinfo.mem->alloc_sarray )( ( j_common_ptr ) & cinfo, JPOOL_IMAGE, row_stride, 1 );
374
375         while ( cinfo.output_scanline < cinfo.output_height )
376         {
377                 jpeg_read_scanlines( &cinfo, buffer, 1 );
378
379                 if ( cinfo.out_color_components == 4 ) {
380                         j_putRGBAScanline( buffer[0], cinfo.output_width, image->getRGBAPixels(), cinfo.output_scanline - 1 );
381                 }
382                 else if ( cinfo.out_color_components == 3 ) {
383                         j_putRGBScanline( buffer[0], cinfo.output_width, image->getRGBAPixels(), cinfo.output_scanline - 1 );
384                 }
385                 else if ( cinfo.out_color_components == 1 ) {
386                         j_putGrayScanlineToRGB( buffer[0], cinfo.output_width, image->getRGBAPixels(), cinfo.output_scanline - 1 );
387                 }
388         }
389
390         jpeg_finish_decompress( &cinfo );
391         jpeg_destroy_decompress( &cinfo );
392
393         return image;
394 }
395
396 Image* LoadJPG( ArchiveFile& file ){
397         ScopedArchiveBuffer buffer( file );
398         return LoadJPGBuff_( buffer.buffer, static_cast<int>( buffer.length ) );
399 }