do not generate vertexposition/vertexmesh arrays in
[divverent/darkplaces.git] / jpeg.c
1 /*
2         Copyright (C) 2002  Mathieu Olivier
3
4         This program is free software; you can redistribute it and/or
5         modify it under the terms of the GNU General Public License
6         as published by the Free Software Foundation; either version 2
7         of the License, or (at your option) any later version.
8
9         This program is distributed in the hope that it will be useful,
10         but WITHOUT ANY WARRANTY; without even the implied warranty of
11         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
12
13         See the GNU General Public License for more details.
14
15         You should have received a copy of the GNU General Public License
16         along with this program; if not, write to:
17
18                 Free Software Foundation, Inc.
19                 59 Temple Place - Suite 330
20                 Boston, MA  02111-1307, USA
21
22 */
23
24
25 #include "quakedef.h"
26 #include "image.h"
27 #include "jpeg.h"
28 #include "image_png.h"
29
30 cvar_t sv_writepicture_quality = {CVAR_SAVE, "sv_writepicture_quality", "10", "WritePicture quality offset (higher means better quality, but slower)"};
31 cvar_t r_texture_jpeg_fastpicmip = {CVAR_SAVE, "r_texture_jpeg_fastpicmip", "1", "perform gl_picmip during decompression for JPEG files (faster)"};
32
33 // jboolean is unsigned char instead of int on Win32
34 #ifdef WIN32
35 typedef unsigned char jboolean;
36 #else
37 typedef int jboolean;
38 #endif
39
40 #ifdef LINK_TO_LIBJPEG
41 #include <jpeglib.h>
42 #define qjpeg_create_compress jpeg_create_compress
43 #define qjpeg_create_decompress jpeg_create_decompress
44 #define qjpeg_destroy_compress jpeg_destroy_compress
45 #define qjpeg_destroy_decompress jpeg_destroy_decompress
46 #define qjpeg_finish_compress jpeg_finish_compress
47 #define qjpeg_finish_decompress jpeg_finish_decompress
48 #define qjpeg_resync_to_restart jpeg_resync_to_restart
49 #define qjpeg_read_header jpeg_read_header
50 #define qjpeg_read_scanlines jpeg_read_scanlines
51 #define qjpeg_set_defaults jpeg_set_defaults
52 #define qjpeg_set_quality jpeg_set_quality
53 #define qjpeg_start_compress jpeg_start_compress
54 #define qjpeg_start_decompress jpeg_start_decompress
55 #define qjpeg_std_error jpeg_std_error
56 #define qjpeg_write_scanlines jpeg_write_scanlines
57 #define qjpeg_simple_progression jpeg_simple_progression
58 #define jpeg_dll true
59 #else
60 /*
61 =================================================================
62
63   Minimal set of definitions from the JPEG lib
64
65   WARNING: for a matter of simplicity, several pointer types are
66   casted to "void*", and most enumerated values are not included
67
68 =================================================================
69 */
70
71 typedef void *j_common_ptr;
72 typedef struct jpeg_compress_struct *j_compress_ptr;
73 typedef struct jpeg_decompress_struct *j_decompress_ptr;
74
75 #define JPEG_LIB_VERSION  62  // Version 6b
76
77 typedef enum
78 {
79         JCS_UNKNOWN,
80         JCS_GRAYSCALE,
81         JCS_RGB,
82         JCS_YCbCr,
83         JCS_CMYK,
84         JCS_YCCK
85 } J_COLOR_SPACE;
86 typedef enum {JPEG_DUMMY1} J_DCT_METHOD;
87 typedef enum {JPEG_DUMMY2} J_DITHER_MODE;
88 typedef unsigned int JDIMENSION;
89
90 #define JPOOL_PERMANENT 0       // lasts until master record is destroyed
91 #define JPOOL_IMAGE             1       // lasts until done with image/datastream
92
93 #define JPEG_EOI        0xD9  // EOI marker code
94
95 #define JMSG_STR_PARM_MAX  80
96
97 #define DCTSIZE2 64
98 #define NUM_QUANT_TBLS 4
99 #define NUM_HUFF_TBLS 4
100 #define NUM_ARITH_TBLS 16
101 #define MAX_COMPS_IN_SCAN 4
102 #define C_MAX_BLOCKS_IN_MCU 10
103 #define D_MAX_BLOCKS_IN_MCU 10
104
105 struct jpeg_memory_mgr
106 {
107   void* (*alloc_small) (j_common_ptr cinfo, int pool_id, size_t sizeofobject);
108   void (*_reserve_space_for_alloc_large) (void *dummy, ...);
109   void (*_reserve_space_for_alloc_sarray) (void *dummy, ...);
110   void (*_reserve_space_for_alloc_barray) (void *dummy, ...);
111   void (*_reserve_space_for_request_virt_sarray) (void *dummy, ...);
112   void (*_reserve_space_for_request_virt_barray) (void *dummy, ...);
113   void (*_reserve_space_for_realize_virt_arrays) (void *dummy, ...);
114   void (*_reserve_space_for_access_virt_sarray) (void *dummy, ...);
115   void (*_reserve_space_for_access_virt_barray) (void *dummy, ...);
116   void (*_reserve_space_for_free_pool) (void *dummy, ...);
117   void (*_reserve_space_for_self_destruct) (void *dummy, ...);
118
119   long max_memory_to_use;
120   long max_alloc_chunk;
121 };
122
123 struct jpeg_error_mgr
124 {
125         void (*error_exit) (j_common_ptr cinfo);
126         void (*emit_message) (j_common_ptr cinfo, int msg_level);
127         void (*output_message) (j_common_ptr cinfo);
128         void (*format_message) (j_common_ptr cinfo, char * buffer);
129         void (*reset_error_mgr) (j_common_ptr cinfo);
130         int msg_code;
131         union {
132                 int i[8];
133                 char s[JMSG_STR_PARM_MAX];
134         } msg_parm;
135         int trace_level;
136         long num_warnings;
137         const char * const * jpeg_message_table;
138         int last_jpeg_message;
139         const char * const * addon_message_table;
140         int first_addon_message;
141         int last_addon_message;
142 };
143
144 struct jpeg_source_mgr
145 {
146         const unsigned char *next_input_byte;
147         size_t bytes_in_buffer;
148
149         void (*init_source) (j_decompress_ptr cinfo);
150         jboolean (*fill_input_buffer) (j_decompress_ptr cinfo);
151         void (*skip_input_data) (j_decompress_ptr cinfo, long num_bytes);
152         jboolean (*resync_to_restart) (j_decompress_ptr cinfo, int desired);
153         void (*term_source) (j_decompress_ptr cinfo);
154 };
155
156 typedef struct {
157   /* These values are fixed over the whole image. */
158   /* For compression, they must be supplied by parameter setup; */
159   /* for decompression, they are read from the SOF marker. */
160   int component_id;             /* identifier for this component (0..255) */
161   int component_index;          /* its index in SOF or cinfo->comp_info[] */
162   int h_samp_factor;            /* horizontal sampling factor (1..4) */
163   int v_samp_factor;            /* vertical sampling factor (1..4) */
164   int quant_tbl_no;             /* quantization table selector (0..3) */
165   /* These values may vary between scans. */
166   /* For compression, they must be supplied by parameter setup; */
167   /* for decompression, they are read from the SOS marker. */
168   /* The decompressor output side may not use these variables. */
169   int dc_tbl_no;                /* DC entropy table selector (0..3) */
170   int ac_tbl_no;                /* AC entropy table selector (0..3) */
171   
172   /* Remaining fields should be treated as private by applications. */
173   
174   /* These values are computed during compression or decompression startup: */
175   /* Component's size in DCT blocks.
176    * Any dummy blocks added to complete an MCU are not counted; therefore
177    * these values do not depend on whether a scan is interleaved or not.
178    */
179   JDIMENSION width_in_blocks;
180   JDIMENSION height_in_blocks;
181   /* Size of a DCT block in samples.  Always DCTSIZE for compression.
182    * For decompression this is the size of the output from one DCT block,
183    * reflecting any scaling we choose to apply during the IDCT step.
184    * Values of 1,2,4,8 are likely to be supported.  Note that different
185    * components may receive different IDCT scalings.
186    */
187   int DCT_scaled_size;
188   /* The downsampled dimensions are the component's actual, unpadded number
189    * of samples at the main buffer (preprocessing/compression interface), thus
190    * downsampled_width = ceil(image_width * Hi/Hmax)
191    * and similarly for height.  For decompression, IDCT scaling is included, so
192    * downsampled_width = ceil(image_width * Hi/Hmax * DCT_scaled_size/DCTSIZE)
193    */
194   JDIMENSION downsampled_width;  /* actual width in samples */
195   JDIMENSION downsampled_height; /* actual height in samples */
196   /* This flag is used only for decompression.  In cases where some of the
197    * components will be ignored (eg grayscale output from YCbCr image),
198    * we can skip most computations for the unused components.
199    */
200   jboolean component_needed;     /* do we need the value of this component? */
201
202   /* These values are computed before starting a scan of the component. */
203   /* The decompressor output side may not use these variables. */
204   int MCU_width;                /* number of blocks per MCU, horizontally */
205   int MCU_height;               /* number of blocks per MCU, vertically */
206   int MCU_blocks;               /* MCU_width * MCU_height */
207   int MCU_sample_width;         /* MCU width in samples, MCU_width*DCT_scaled_size */
208   int last_col_width;           /* # of non-dummy blocks across in last MCU */
209   int last_row_height;          /* # of non-dummy blocks down in last MCU */
210
211   /* Saved quantization table for component; NULL if none yet saved.
212    * See jdinput.c comments about the need for this information.
213    * This field is currently used only for decompression.
214    */
215   void *quant_table;
216
217   /* Private per-component storage for DCT or IDCT subsystem. */
218   void * dct_table;
219 } jpeg_component_info;
220
221 struct jpeg_decompress_struct
222 {
223         struct jpeg_error_mgr *err;             // USED
224         struct jpeg_memory_mgr *mem;    // USED
225
226         void *progress;
227         void *client_data;
228         jboolean is_decompressor;
229         int global_state;
230
231         struct jpeg_source_mgr *src;    // USED
232         JDIMENSION image_width;                 // USED
233         JDIMENSION image_height;                // USED
234
235         int num_components;
236         J_COLOR_SPACE jpeg_color_space;
237         J_COLOR_SPACE out_color_space;
238         unsigned int scale_num, scale_denom;
239         double output_gamma;
240         jboolean buffered_image;
241         jboolean raw_data_out;
242         J_DCT_METHOD dct_method;
243         jboolean do_fancy_upsampling;
244         jboolean do_block_smoothing;
245         jboolean quantize_colors;
246         J_DITHER_MODE dither_mode;
247         jboolean two_pass_quantize;
248         int desired_number_of_colors;
249         jboolean enable_1pass_quant;
250         jboolean enable_external_quant;
251         jboolean enable_2pass_quant;
252         JDIMENSION output_width;
253
254         JDIMENSION output_height;       // USED
255
256         int out_color_components;
257
258         int output_components;          // USED
259
260         int rec_outbuf_height;
261         int actual_number_of_colors;
262         void *colormap;
263
264         JDIMENSION output_scanline;     // USED
265
266         int input_scan_number;
267         JDIMENSION input_iMCU_row;
268         int output_scan_number;
269         JDIMENSION output_iMCU_row;
270         int (*coef_bits)[DCTSIZE2];
271         void *quant_tbl_ptrs[NUM_QUANT_TBLS];
272         void *dc_huff_tbl_ptrs[NUM_HUFF_TBLS];
273         void *ac_huff_tbl_ptrs[NUM_HUFF_TBLS];
274         int data_precision;
275         jpeg_component_info *comp_info;
276         jboolean progressive_mode;
277         jboolean arith_code;
278         unsigned char arith_dc_L[NUM_ARITH_TBLS];
279         unsigned char arith_dc_U[NUM_ARITH_TBLS];
280         unsigned char arith_ac_K[NUM_ARITH_TBLS];
281         unsigned int restart_interval;
282         jboolean saw_JFIF_marker;
283         unsigned char JFIF_major_version;
284         unsigned char JFIF_minor_version;
285         unsigned char density_unit;
286         unsigned short X_density;
287         unsigned short Y_density;
288         jboolean saw_Adobe_marker;
289         unsigned char Adobe_transform;
290         jboolean CCIR601_sampling;
291         void *marker_list;
292         int max_h_samp_factor;
293         int max_v_samp_factor;
294         int min_DCT_scaled_size;
295         JDIMENSION total_iMCU_rows;
296         void *sample_range_limit;
297         int comps_in_scan;
298         jpeg_component_info *cur_comp_info[MAX_COMPS_IN_SCAN];
299         JDIMENSION MCUs_per_row;
300         JDIMENSION MCU_rows_in_scan;
301         int blocks_in_MCU;
302         int MCU_membership[D_MAX_BLOCKS_IN_MCU];
303         int Ss, Se, Ah, Al;
304         int unread_marker;
305         void *master;
306         void *main;
307         void *coef;
308         void *post;
309         void *inputctl;
310         void *marker;
311         void *entropy;
312         void *idct;
313         void *upsample;
314         void *cconvert;
315         void *cquantize;
316 };
317
318
319 struct jpeg_compress_struct
320 {
321         struct jpeg_error_mgr *err;
322         struct jpeg_memory_mgr *mem;
323         void *progress;
324         void *client_data;
325         jboolean is_decompressor;
326         int global_state;
327
328         void *dest;
329         JDIMENSION image_width;
330         JDIMENSION image_height;
331         int input_components;
332         J_COLOR_SPACE in_color_space;
333         double input_gamma;
334         int data_precision;
335
336         int num_components;
337         J_COLOR_SPACE jpeg_color_space;
338         jpeg_component_info *comp_info;
339         void *quant_tbl_ptrs[NUM_QUANT_TBLS];
340         void *dc_huff_tbl_ptrs[NUM_HUFF_TBLS];
341         void *ac_huff_tbl_ptrs[NUM_HUFF_TBLS];
342         unsigned char arith_dc_L[NUM_ARITH_TBLS];
343         unsigned char arith_dc_U[NUM_ARITH_TBLS];
344         unsigned char arith_ac_K[NUM_ARITH_TBLS];
345
346         int num_scans;
347         const void *scan_info;
348         jboolean raw_data_in;
349         jboolean arith_code;
350         jboolean optimize_coding;
351         jboolean CCIR601_sampling;
352         int smoothing_factor;
353         J_DCT_METHOD dct_method;
354
355         unsigned int restart_interval;
356         int restart_in_rows;
357
358         jboolean write_JFIF_header;
359         unsigned char JFIF_major_version;
360         unsigned char JFIF_minor_version;
361         unsigned char density_unit;
362         unsigned short X_density;
363         unsigned short Y_density;
364         jboolean write_Adobe_marker;
365         JDIMENSION next_scanline;
366
367         jboolean progressive_mode;
368         int max_h_samp_factor;
369         int max_v_samp_factor;
370         JDIMENSION total_iMCU_rows;
371         int comps_in_scan;
372         jpeg_component_info *cur_comp_info[MAX_COMPS_IN_SCAN];
373         JDIMENSION MCUs_per_row;
374         JDIMENSION MCU_rows_in_scan;
375         int blocks_in_MCU;
376         int MCU_membership[C_MAX_BLOCKS_IN_MCU];
377         int Ss, Se, Ah, Al;
378
379         void *master;
380         void *main;
381         void *prep;
382         void *coef;
383         void *marker;
384         void *cconvert;
385         void *downsample;
386         void *fdct;
387         void *entropy;
388         void *script_space;
389         int script_space_size;
390 };
391
392 struct jpeg_destination_mgr
393 {
394         unsigned char* next_output_byte;
395         size_t free_in_buffer;
396
397         void (*init_destination) (j_compress_ptr cinfo);
398         jboolean (*empty_output_buffer) (j_compress_ptr cinfo);
399         void (*term_destination) (j_compress_ptr cinfo);
400 };
401
402
403 /*
404 =================================================================
405
406   DarkPlaces definitions
407
408 =================================================================
409 */
410
411 // Functions exported from libjpeg
412 #define qjpeg_create_compress(cinfo) \
413         qjpeg_CreateCompress((cinfo), JPEG_LIB_VERSION, (size_t) sizeof(struct jpeg_compress_struct))
414 #define qjpeg_create_decompress(cinfo) \
415         qjpeg_CreateDecompress((cinfo), JPEG_LIB_VERSION, (size_t) sizeof(struct jpeg_decompress_struct))
416
417 static void (*qjpeg_CreateCompress) (j_compress_ptr cinfo, int version, size_t structsize);
418 static void (*qjpeg_CreateDecompress) (j_decompress_ptr cinfo, int version, size_t structsize);
419 static void (*qjpeg_destroy_compress) (j_compress_ptr cinfo);
420 static void (*qjpeg_destroy_decompress) (j_decompress_ptr cinfo);
421 static void (*qjpeg_finish_compress) (j_compress_ptr cinfo);
422 static jboolean (*qjpeg_finish_decompress) (j_decompress_ptr cinfo);
423 static jboolean (*qjpeg_resync_to_restart) (j_decompress_ptr cinfo, int desired);
424 static int (*qjpeg_read_header) (j_decompress_ptr cinfo, jboolean require_image);
425 static JDIMENSION (*qjpeg_read_scanlines) (j_decompress_ptr cinfo, unsigned char** scanlines, JDIMENSION max_lines);
426 static void (*qjpeg_set_defaults) (j_compress_ptr cinfo);
427 static void (*qjpeg_set_quality) (j_compress_ptr cinfo, int quality, jboolean force_baseline);
428 static jboolean (*qjpeg_start_compress) (j_compress_ptr cinfo, jboolean write_all_tables);
429 static jboolean (*qjpeg_start_decompress) (j_decompress_ptr cinfo);
430 static struct jpeg_error_mgr* (*qjpeg_std_error) (struct jpeg_error_mgr *err);
431 static JDIMENSION (*qjpeg_write_scanlines) (j_compress_ptr cinfo, unsigned char** scanlines, JDIMENSION num_lines);
432 static void (*qjpeg_simple_progression) (j_compress_ptr cinfo);
433
434 static dllfunction_t jpegfuncs[] =
435 {
436         {"jpeg_CreateCompress",         (void **) &qjpeg_CreateCompress},
437         {"jpeg_CreateDecompress",       (void **) &qjpeg_CreateDecompress},
438         {"jpeg_destroy_compress",       (void **) &qjpeg_destroy_compress},
439         {"jpeg_destroy_decompress",     (void **) &qjpeg_destroy_decompress},
440         {"jpeg_finish_compress",        (void **) &qjpeg_finish_compress},
441         {"jpeg_finish_decompress",      (void **) &qjpeg_finish_decompress},
442         {"jpeg_resync_to_restart",      (void **) &qjpeg_resync_to_restart},
443         {"jpeg_read_header",            (void **) &qjpeg_read_header},
444         {"jpeg_read_scanlines",         (void **) &qjpeg_read_scanlines},
445         {"jpeg_set_defaults",           (void **) &qjpeg_set_defaults},
446         {"jpeg_set_quality",            (void **) &qjpeg_set_quality},
447         {"jpeg_start_compress",         (void **) &qjpeg_start_compress},
448         {"jpeg_start_decompress",       (void **) &qjpeg_start_decompress},
449         {"jpeg_std_error",                      (void **) &qjpeg_std_error},
450         {"jpeg_write_scanlines",        (void **) &qjpeg_write_scanlines},
451         {"jpeg_simple_progression",     (void **) &qjpeg_simple_progression},
452         {NULL, NULL}
453 };
454
455 // Handle for JPEG DLL
456 dllhandle_t jpeg_dll = NULL;
457 qboolean jpeg_tried_loading = 0;
458 #endif
459
460 static unsigned char jpeg_eoi_marker [2] = {0xFF, JPEG_EOI};
461 static jmp_buf error_in_jpeg;
462 static qboolean jpeg_toolarge;
463
464 // Our own output manager for JPEG compression
465 typedef struct
466 {
467         struct jpeg_destination_mgr pub;
468
469         qfile_t* outfile;
470         unsigned char* buffer;
471         size_t bufsize; // used if outfile is NULL
472 } my_destination_mgr;
473 typedef my_destination_mgr* my_dest_ptr;
474
475
476 /*
477 =================================================================
478
479   DLL load & unload
480
481 =================================================================
482 */
483
484 /*
485 ====================
486 JPEG_OpenLibrary
487
488 Try to load the JPEG DLL
489 ====================
490 */
491 qboolean JPEG_OpenLibrary (void)
492 {
493 #ifdef LINK_TO_LIBJPEG
494         return true;
495 #else
496         const char* dllnames [] =
497         {
498 #if defined(WIN32)
499                 "libjpeg.dll",
500 #elif defined(MACOSX)
501                 "libjpeg.62.dylib",
502 #else
503                 "libjpeg.so.62",
504                 "libjpeg.so",
505 #endif
506                 NULL
507         };
508
509         // Already loaded?
510         if (jpeg_dll)
511                 return true;
512
513         if (jpeg_tried_loading) // only try once
514                 return false;
515
516         jpeg_tried_loading = true;
517
518         // Load the DLL
519         return Sys_LoadLibrary (dllnames, &jpeg_dll, jpegfuncs);
520 #endif
521 }
522
523
524 /*
525 ====================
526 JPEG_CloseLibrary
527
528 Unload the JPEG DLL
529 ====================
530 */
531 void JPEG_CloseLibrary (void)
532 {
533 #ifndef LINK_TO_LIBJPEG
534         Sys_UnloadLibrary (&jpeg_dll);
535         jpeg_tried_loading = false; // allow retry
536 #endif
537 }
538
539
540 /*
541 =================================================================
542
543         JPEG decompression
544
545 =================================================================
546 */
547
548 static void JPEG_Noop (j_decompress_ptr cinfo) {}
549
550 static jboolean JPEG_FillInputBuffer (j_decompress_ptr cinfo)
551 {
552     // Insert a fake EOI marker
553     cinfo->src->next_input_byte = jpeg_eoi_marker;
554     cinfo->src->bytes_in_buffer = 2;
555
556         return TRUE;
557 }
558
559 static void JPEG_SkipInputData (j_decompress_ptr cinfo, long num_bytes)
560 {
561     if (cinfo->src->bytes_in_buffer <= (unsigned long)num_bytes)
562         {
563                 cinfo->src->bytes_in_buffer = 0;
564                 return;
565         }
566
567     cinfo->src->next_input_byte += num_bytes;
568     cinfo->src->bytes_in_buffer -= num_bytes;
569 }
570
571 static void JPEG_MemSrc (j_decompress_ptr cinfo, const unsigned char *buffer, size_t filesize)
572 {
573         cinfo->src = (struct jpeg_source_mgr *)cinfo->mem->alloc_small ((j_common_ptr) cinfo, JPOOL_PERMANENT, sizeof (struct jpeg_source_mgr));
574
575         cinfo->src->next_input_byte = buffer;
576         cinfo->src->bytes_in_buffer = filesize;
577
578         cinfo->src->init_source = JPEG_Noop;
579         cinfo->src->fill_input_buffer = JPEG_FillInputBuffer;
580         cinfo->src->skip_input_data = JPEG_SkipInputData;
581         cinfo->src->resync_to_restart = qjpeg_resync_to_restart; // use the default method
582         cinfo->src->term_source = JPEG_Noop;
583 }
584
585 static void JPEG_ErrorExit (j_common_ptr cinfo)
586 {
587         ((struct jpeg_decompress_struct*)cinfo)->err->output_message (cinfo);
588         longjmp(error_in_jpeg, 1);
589 }
590
591
592 /*
593 ====================
594 JPEG_LoadImage
595
596 Load a JPEG image into a BGRA buffer
597 ====================
598 */
599 unsigned char* JPEG_LoadImage_BGRA (const unsigned char *f, int filesize, int *miplevel)
600 {
601         struct jpeg_decompress_struct cinfo;
602         struct jpeg_error_mgr jerr;
603         unsigned char *image_buffer = NULL, *scanline = NULL;
604         unsigned int line;
605         int submip = 0;
606
607         // No DLL = no JPEGs
608         if (!jpeg_dll)
609                 return NULL;
610
611         if(miplevel && r_texture_jpeg_fastpicmip.integer)
612                 submip = bound(0, *miplevel, 3);
613
614         cinfo.err = qjpeg_std_error (&jerr);
615         qjpeg_create_decompress (&cinfo);
616         if(setjmp(error_in_jpeg))
617                 goto error_caught;
618         cinfo.err = qjpeg_std_error (&jerr);
619         cinfo.err->error_exit = JPEG_ErrorExit;
620         JPEG_MemSrc (&cinfo, f, filesize);
621         qjpeg_read_header (&cinfo, TRUE);
622         cinfo.scale_num = 1;
623         cinfo.scale_denom = (1 << submip);
624         qjpeg_start_decompress (&cinfo);
625
626         image_width = cinfo.output_width;
627         image_height = cinfo.output_height;
628
629         if (image_width > 32768 || image_height > 32768 || image_width <= 0 || image_height <= 0)
630         {
631                 Con_Printf("JPEG_LoadImage: invalid image size %ix%i\n", image_width, image_height);
632                 return NULL;
633         }
634
635         image_buffer = (unsigned char *)Mem_Alloc(tempmempool, image_width * image_height * 4);
636         scanline = (unsigned char *)Mem_Alloc(tempmempool, image_width * cinfo.output_components);
637         if (!image_buffer || !scanline)
638         {
639                 if (image_buffer)
640                         Mem_Free (image_buffer);
641                 if (scanline)
642                         Mem_Free (scanline);
643
644                 Con_Printf("JPEG_LoadImage: not enough memory for %i by %i image\n", image_width, image_height);
645                 qjpeg_finish_decompress (&cinfo);
646                 qjpeg_destroy_decompress (&cinfo);
647                 return NULL;
648         }
649
650         // Decompress the image, line by line
651         line = 0;
652         while (cinfo.output_scanline < cinfo.output_height)
653         {
654                 unsigned char *buffer_ptr;
655                 int ind;
656
657                 qjpeg_read_scanlines (&cinfo, &scanline, 1);
658
659                 // Convert the image to BGRA
660                 switch (cinfo.output_components)
661                 {
662                         // RGB images
663                         case 3:
664                                 buffer_ptr = &image_buffer[image_width * line * 4];
665                                 for (ind = 0; ind < image_width * 3; ind += 3, buffer_ptr += 4)
666                                 {
667                                         buffer_ptr[2] = scanline[ind];
668                                         buffer_ptr[1] = scanline[ind + 1];
669                                         buffer_ptr[0] = scanline[ind + 2];
670                                         buffer_ptr[3] = 255;
671                                 }
672                                 break;
673
674                         // Greyscale images (default to it, just in case)
675                         case 1:
676                         default:
677                                 buffer_ptr = &image_buffer[image_width * line * 4];
678                                 for (ind = 0; ind < image_width; ind++, buffer_ptr += 4)
679                                 {
680                                         buffer_ptr[0] = scanline[ind];
681                                         buffer_ptr[1] = scanline[ind];
682                                         buffer_ptr[2] = scanline[ind];
683                                         buffer_ptr[3] = 255;
684                                 }
685                 }
686
687                 line++;
688         }
689         Mem_Free (scanline); scanline = NULL;
690
691         qjpeg_finish_decompress (&cinfo);
692         qjpeg_destroy_decompress (&cinfo);
693
694         if(miplevel)
695                 *miplevel -= submip;
696
697         return image_buffer;
698
699 error_caught:
700         if(scanline)
701                 Mem_Free (scanline);
702         if(image_buffer)
703                 Mem_Free (image_buffer);
704         qjpeg_destroy_decompress (&cinfo);
705         return NULL;
706 }
707
708
709 /*
710 =================================================================
711
712   JPEG compression
713
714 =================================================================
715 */
716
717 #define JPEG_OUTPUT_BUF_SIZE 4096
718 static void JPEG_InitDestination (j_compress_ptr cinfo)
719 {
720         my_dest_ptr dest = (my_dest_ptr)cinfo->dest;
721         dest->buffer = (unsigned char*)cinfo->mem->alloc_small ((j_common_ptr) cinfo, JPOOL_IMAGE, JPEG_OUTPUT_BUF_SIZE * sizeof(unsigned char));
722         dest->pub.next_output_byte = dest->buffer;
723         dest->pub.free_in_buffer = JPEG_OUTPUT_BUF_SIZE;
724 }
725
726 static jboolean JPEG_EmptyOutputBuffer (j_compress_ptr cinfo)
727 {
728         my_dest_ptr dest = (my_dest_ptr)cinfo->dest;
729
730         if (FS_Write (dest->outfile, dest->buffer, JPEG_OUTPUT_BUF_SIZE) != (size_t) JPEG_OUTPUT_BUF_SIZE)
731                 longjmp(error_in_jpeg, 1);
732
733         dest->pub.next_output_byte = dest->buffer;
734         dest->pub.free_in_buffer = JPEG_OUTPUT_BUF_SIZE;
735         return true;
736 }
737
738 static void JPEG_TermDestination (j_compress_ptr cinfo)
739 {
740         my_dest_ptr dest = (my_dest_ptr)cinfo->dest;
741         size_t datacount = JPEG_OUTPUT_BUF_SIZE - dest->pub.free_in_buffer;
742
743         // Write any data remaining in the buffer
744         if (datacount > 0)
745                 if (FS_Write (dest->outfile, dest->buffer, datacount) != (fs_offset_t)datacount)
746                         longjmp(error_in_jpeg, 1);
747 }
748
749 static void JPEG_FileDest (j_compress_ptr cinfo, qfile_t* outfile)
750 {
751         my_dest_ptr dest;
752
753         // First time for this JPEG object?
754         if (cinfo->dest == NULL)
755                 cinfo->dest = (struct jpeg_destination_mgr *)(*cinfo->mem->alloc_small) ((j_common_ptr) cinfo, JPOOL_PERMANENT, sizeof(my_destination_mgr));
756
757         dest = (my_dest_ptr)cinfo->dest;
758         dest->pub.init_destination = JPEG_InitDestination;
759         dest->pub.empty_output_buffer = JPEG_EmptyOutputBuffer;
760         dest->pub.term_destination = JPEG_TermDestination;
761         dest->outfile = outfile;
762 }
763
764 static void JPEG_Mem_InitDestination (j_compress_ptr cinfo)
765 {
766         my_dest_ptr dest = (my_dest_ptr)cinfo->dest;
767         dest->pub.next_output_byte = dest->buffer;
768         dest->pub.free_in_buffer = dest->bufsize;
769 }
770
771 static jboolean JPEG_Mem_EmptyOutputBuffer (j_compress_ptr cinfo)
772 {
773         my_dest_ptr dest = (my_dest_ptr)cinfo->dest;
774         jpeg_toolarge = true;
775         dest->pub.next_output_byte = dest->buffer;
776         dest->pub.free_in_buffer = dest->bufsize;
777         return true;
778 }
779
780 static void JPEG_Mem_TermDestination (j_compress_ptr cinfo)
781 {
782         my_dest_ptr dest = (my_dest_ptr)cinfo->dest;
783         dest->bufsize = dest->pub.next_output_byte - dest->buffer;
784 }
785 static void JPEG_MemDest (j_compress_ptr cinfo, void* buf, size_t bufsize)
786 {
787         my_dest_ptr dest;
788
789         // First time for this JPEG object?
790         if (cinfo->dest == NULL)
791                 cinfo->dest = (struct jpeg_destination_mgr *)(*cinfo->mem->alloc_small) ((j_common_ptr) cinfo, JPOOL_PERMANENT, sizeof(my_destination_mgr));
792
793         dest = (my_dest_ptr)cinfo->dest;
794         dest->pub.init_destination = JPEG_Mem_InitDestination;
795         dest->pub.empty_output_buffer = JPEG_Mem_EmptyOutputBuffer;
796         dest->pub.term_destination = JPEG_Mem_TermDestination;
797         dest->outfile = NULL;
798
799         dest->buffer = (unsigned char *) buf;
800         dest->bufsize = bufsize;
801 }
802
803
804 /*
805 ====================
806 JPEG_SaveImage_preflipped
807
808 Save a preflipped JPEG image to a file
809 ====================
810 */
811 qboolean JPEG_SaveImage_preflipped (const char *filename, int width, int height, unsigned char *data)
812 {
813         struct jpeg_compress_struct cinfo;
814         struct jpeg_error_mgr jerr;
815         unsigned char *scanline;
816         unsigned int offset, linesize;
817         qfile_t* file;
818
819         // No DLL = no JPEGs
820         if (!jpeg_dll)
821         {
822                 Con_Print("You need the libjpeg library to save JPEG images\n");
823                 return false;
824         }
825
826         // Open the file
827         file = FS_OpenRealFile(filename, "wb", true);
828         if (!file)
829                 return false;
830
831         if(setjmp(error_in_jpeg))
832                 goto error_caught;
833         cinfo.err = qjpeg_std_error (&jerr);
834         cinfo.err->error_exit = JPEG_ErrorExit;
835
836         qjpeg_create_compress (&cinfo);
837         JPEG_FileDest (&cinfo, file);
838
839         // Set the parameters for compression
840         cinfo.image_width = width;
841         cinfo.image_height = height;
842         cinfo.in_color_space = JCS_RGB;
843         cinfo.input_components = 3;
844         qjpeg_set_defaults (&cinfo);
845         qjpeg_set_quality (&cinfo, (int)(scr_screenshot_jpeg_quality.value * 100), TRUE);
846         qjpeg_simple_progression (&cinfo);
847
848         // turn off subsampling (to make text look better)
849         cinfo.optimize_coding = 1;
850         cinfo.comp_info[0].h_samp_factor = 1;
851         cinfo.comp_info[0].v_samp_factor = 1;
852         cinfo.comp_info[1].h_samp_factor = 1;
853         cinfo.comp_info[1].v_samp_factor = 1;
854         cinfo.comp_info[2].h_samp_factor = 1;
855         cinfo.comp_info[2].v_samp_factor = 1;
856
857         qjpeg_start_compress (&cinfo, true);
858
859         // Compress each scanline
860         linesize = cinfo.image_width * 3;
861         offset = linesize * (cinfo.image_height - 1);
862         while (cinfo.next_scanline < cinfo.image_height)
863         {
864                 scanline = &data[offset - cinfo.next_scanline * linesize];
865
866                 qjpeg_write_scanlines (&cinfo, &scanline, 1);
867         }
868
869         qjpeg_finish_compress (&cinfo);
870         qjpeg_destroy_compress (&cinfo);
871
872         FS_Close (file);
873         return true;
874
875 error_caught:
876         qjpeg_destroy_compress (&cinfo);
877         FS_Close (file);
878         return false;
879 }
880
881 static size_t JPEG_try_SaveImage_to_Buffer (struct jpeg_compress_struct *cinfo, char *jpegbuf, size_t jpegsize, int quality, int width, int height, unsigned char *data)
882 {
883         unsigned char *scanline;
884         unsigned int linesize;
885
886         jpeg_toolarge = false;
887         JPEG_MemDest (cinfo, jpegbuf, jpegsize);
888
889         // Set the parameters for compression
890         cinfo->image_width = width;
891         cinfo->image_height = height;
892         cinfo->in_color_space = JCS_RGB;
893         cinfo->input_components = 3;
894         qjpeg_set_defaults (cinfo);
895         qjpeg_set_quality (cinfo, quality, FALSE);
896
897         cinfo->comp_info[0].h_samp_factor = 2;
898         cinfo->comp_info[0].v_samp_factor = 2;
899         cinfo->comp_info[1].h_samp_factor = 1;
900         cinfo->comp_info[1].v_samp_factor = 1;
901         cinfo->comp_info[2].h_samp_factor = 1;
902         cinfo->comp_info[2].v_samp_factor = 1;
903         cinfo->optimize_coding = 1;
904
905         qjpeg_start_compress (cinfo, true);
906
907         // Compress each scanline
908         linesize = width * 3;
909         while (cinfo->next_scanline < cinfo->image_height)
910         {
911                 scanline = &data[cinfo->next_scanline * linesize];
912
913                 qjpeg_write_scanlines (cinfo, &scanline, 1);
914         }
915
916         qjpeg_finish_compress (cinfo);
917
918         if(jpeg_toolarge)
919                 return 0;
920
921         return ((my_dest_ptr) cinfo->dest)->bufsize;
922 }
923
924 size_t JPEG_SaveImage_to_Buffer (char *jpegbuf, size_t jpegsize, int width, int height, unsigned char *data)
925 {
926         struct jpeg_compress_struct cinfo;
927         struct jpeg_error_mgr jerr;
928
929         int quality;
930         int quality_guess;
931         size_t result;
932
933         // No DLL = no JPEGs
934         if (!jpeg_dll)
935         {
936                 Con_Print("You need the libjpeg library to save JPEG images\n");
937                 return false;
938         }
939
940         if(setjmp(error_in_jpeg))
941                 goto error_caught;
942         cinfo.err = qjpeg_std_error (&jerr);
943         cinfo.err->error_exit = JPEG_ErrorExit;
944
945         qjpeg_create_compress (&cinfo);
946
947 #if 0
948         // used to get the formula below
949         {
950                 char buf[1048576];
951                 unsigned char *img;
952                 int i;
953
954                 img = Mem_Alloc(tempmempool, width * height * 3);
955                 for(i = 0; i < width * height * 3; ++i)
956                         img[i] = rand() & 0xFF;
957
958                 for(i = 0; i <= 100; ++i)
959                 {
960                         Con_Printf("! %d %d %d %d\n", width, height, i, (int) JPEG_try_SaveImage_to_Buffer(&cinfo, buf, sizeof(buf), i, width, height, img));
961                 }
962
963                 Mem_Free(img);
964         }
965 #endif
966
967         //quality_guess = (100 * jpegsize - 41000) / (width*height) + 2; // fits random data
968         quality_guess   = (256 * jpegsize - 81920) / (width*height) - 8; // fits Nexuiz's/Xonotic's map pictures
969
970         quality_guess = bound(0, quality_guess, 100);
971         quality = bound(0, quality_guess + sv_writepicture_quality.integer, 100); // assume it can do 10 failed attempts
972
973         while(!(result = JPEG_try_SaveImage_to_Buffer(&cinfo, jpegbuf, jpegsize, quality, width, height, data)))
974         {
975                 --quality;
976                 if(quality < 0)
977                 {
978                         Con_Printf("couldn't write image at all, probably too big\n");
979                         return 0;
980                 }
981         }
982         qjpeg_destroy_compress (&cinfo);
983         Con_DPrintf("JPEG_SaveImage_to_Buffer: guessed quality/size %d/%d, actually got %d/%d\n", quality_guess, (int)jpegsize, quality, (int)result);
984
985         return result;
986
987 error_caught:
988         qjpeg_destroy_compress (&cinfo);
989         return 0;
990 }
991
992 typedef struct CompressedImageCacheItem
993 {
994         char imagename[MAX_QPATH];
995         size_t maxsize;
996         void *compressed;
997         size_t compressed_size;
998         struct CompressedImageCacheItem *next;
999 }
1000 CompressedImageCacheItem;
1001 #define COMPRESSEDIMAGECACHE_SIZE 4096
1002 static CompressedImageCacheItem *CompressedImageCache[COMPRESSEDIMAGECACHE_SIZE];
1003
1004 static void CompressedImageCache_Add(const char *imagename, size_t maxsize, void *compressed, size_t compressed_size)
1005 {
1006         const char *hashkey = va("%s:%d", imagename, (int) maxsize);
1007         int hashindex = CRC_Block((unsigned char *) hashkey, strlen(hashkey)) % COMPRESSEDIMAGECACHE_SIZE;
1008         CompressedImageCacheItem *i;
1009
1010         if(strlen(imagename) >= MAX_QPATH)
1011                 return; // can't add this
1012         
1013         i = (CompressedImageCacheItem*) Z_Malloc(sizeof(CompressedImageCacheItem));
1014         strlcpy(i->imagename, imagename, sizeof(i->imagename));
1015         i->maxsize = maxsize;
1016         i->compressed = compressed;
1017         i->compressed_size = compressed_size;
1018         i->next = CompressedImageCache[hashindex];
1019         CompressedImageCache[hashindex] = i;
1020 }
1021
1022 static CompressedImageCacheItem *CompressedImageCache_Find(const char *imagename, size_t maxsize)
1023 {
1024         const char *hashkey = va("%s:%d", imagename, (int) maxsize);
1025         int hashindex = CRC_Block((unsigned char *) hashkey, strlen(hashkey)) % COMPRESSEDIMAGECACHE_SIZE;
1026         CompressedImageCacheItem *i = CompressedImageCache[hashindex];
1027
1028         while(i)
1029         {
1030                 if(i->maxsize == maxsize)
1031                         if(!strcmp(i->imagename, imagename))
1032                                 return i;
1033                 i = i->next;
1034         }
1035         return NULL;
1036 }
1037
1038 qboolean Image_Compress(const char *imagename, size_t maxsize, void **buf, size_t *size)
1039 {
1040         unsigned char *imagedata, *newimagedata;
1041         int maxPixelCount;
1042         int components[3] = {2, 1, 0};
1043         CompressedImageCacheItem *i;
1044
1045         JPEG_OpenLibrary (); // for now; LH had the idea of replacing this by a better format
1046         PNG_OpenLibrary (); // for loading
1047
1048         // No DLL = no JPEGs
1049         if (!jpeg_dll)
1050         {
1051                 Con_Print("You need the libjpeg library to save JPEG images\n");
1052                 return false;
1053         }
1054
1055         i = CompressedImageCache_Find(imagename, maxsize);
1056         if(i)
1057         {
1058                 *size = i->compressed_size;
1059                 *buf = i->compressed;
1060         }
1061
1062         // load the image
1063         imagedata = loadimagepixelsbgra(imagename, true, false, false, NULL);
1064         if(!imagedata)
1065                 return false;
1066
1067         // find an appropriate size for somewhat okay compression
1068         if(maxsize <= 768)
1069                 maxPixelCount = 32 * 32;
1070         else if(maxsize <= 1024)
1071                 maxPixelCount = 64 * 64;
1072         else if(maxsize <= 4096)
1073                 maxPixelCount = 128 * 128;
1074         else
1075                 maxPixelCount = 256 * 256;
1076
1077         while(image_width * image_height > maxPixelCount)
1078         {
1079                 int one = 1;
1080                 Image_MipReduce32(imagedata, imagedata, &image_width, &image_height, &one, image_width/2, image_height/2, 1);
1081         }
1082
1083         newimagedata = (unsigned char *) Mem_Alloc(tempmempool, image_width * image_height * 3);
1084
1085         // convert the image from BGRA to RGB
1086         Image_CopyMux(newimagedata, imagedata, image_width, image_height, false, false, false, 3, 4, components);
1087         Mem_Free(imagedata);
1088
1089         // try to compress it to JPEG
1090         *buf = Z_Malloc(maxsize);
1091         *size = JPEG_SaveImage_to_Buffer((char *) *buf, maxsize, image_width, image_height, newimagedata);
1092         Mem_Free(newimagedata);
1093
1094         if(!*size)
1095         {
1096                 Z_Free(*buf);
1097                 *buf = NULL;
1098                 Con_Printf("could not compress image %s to %d bytes\n", imagename, (int)maxsize);
1099                 // return false;
1100                 // also cache failures!
1101         }
1102
1103         // store it in the cache
1104         CompressedImageCache_Add(imagename, maxsize, *buf, *size);
1105         return (*buf != NULL);
1106 }