]>
Commit | Line | Data |
---|---|---|
e1929140 RR |
1 | /* |
2 | * jpegint.h | |
3 | * | |
4 | * Copyright (C) 1991-1997, Thomas G. Lane. | |
5 | * This file is part of the Independent JPEG Group's software. | |
6 | * For conditions of distribution and use, see the accompanying README file. | |
7 | * | |
8 | * This file provides common declarations for the various JPEG modules. | |
9 | * These declarations are considered internal to the JPEG library; most | |
10 | * applications using the library shouldn't need to include this file. | |
11 | */ | |
12 | ||
13 | ||
14 | /* Declarations for both compression & decompression */ | |
15 | ||
16 | typedef enum { /* Operating modes for buffer controllers */ | |
17 | JBUF_PASS_THRU, /* Plain stripwise operation */ | |
18 | /* Remaining modes require a full-image buffer to have been created */ | |
19 | JBUF_SAVE_SOURCE, /* Run source subobject only, save output */ | |
20 | JBUF_CRANK_DEST, /* Run dest subobject only, using saved data */ | |
21 | JBUF_SAVE_AND_PASS /* Run both subobjects, save output */ | |
22 | } J_BUF_MODE; | |
23 | ||
24 | /* Values of global_state field (jdapi.c has some dependencies on ordering!) */ | |
25 | #define CSTATE_START 100 /* after create_compress */ | |
26 | #define CSTATE_SCANNING 101 /* start_compress done, write_scanlines OK */ | |
27 | #define CSTATE_RAW_OK 102 /* start_compress done, write_raw_data OK */ | |
28 | #define CSTATE_WRCOEFS 103 /* jpeg_write_coefficients done */ | |
29 | #define DSTATE_START 200 /* after create_decompress */ | |
30 | #define DSTATE_INHEADER 201 /* reading header markers, no SOS yet */ | |
31 | #define DSTATE_READY 202 /* found SOS, ready for start_decompress */ | |
32 | #define DSTATE_PRELOAD 203 /* reading multiscan file in start_decompress*/ | |
33 | #define DSTATE_PRESCAN 204 /* performing dummy pass for 2-pass quant */ | |
34 | #define DSTATE_SCANNING 205 /* start_decompress done, read_scanlines OK */ | |
35 | #define DSTATE_RAW_OK 206 /* start_decompress done, read_raw_data OK */ | |
36 | #define DSTATE_BUFIMAGE 207 /* expecting jpeg_start_output */ | |
37 | #define DSTATE_BUFPOST 208 /* looking for SOS/EOI in jpeg_finish_output */ | |
38 | #define DSTATE_RDCOEFS 209 /* reading file in jpeg_read_coefficients */ | |
39 | #define DSTATE_STOPPING 210 /* looking for EOI in jpeg_finish_decompress */ | |
40 | ||
41 | ||
42 | /* Declarations for compression modules */ | |
43 | ||
44 | /* Master control module */ | |
45 | struct jpeg_comp_master { | |
46 | JMETHOD(void, prepare_for_pass, (j_compress_ptr cinfo)); | |
47 | JMETHOD(void, pass_startup, (j_compress_ptr cinfo)); | |
48 | JMETHOD(void, finish_pass, (j_compress_ptr cinfo)); | |
49 | ||
50 | /* State variables made visible to other modules */ | |
51 | boolean call_pass_startup; /* True if pass_startup must be called */ | |
52 | boolean is_last_pass; /* True during last pass */ | |
53 | }; | |
54 | ||
55 | /* Main buffer control (downsampled-data buffer) */ | |
56 | struct jpeg_c_main_controller { | |
57 | JMETHOD(void, start_pass, (j_compress_ptr cinfo, J_BUF_MODE pass_mode)); | |
58 | JMETHOD(void, process_data, (j_compress_ptr cinfo, | |
59 | JSAMPARRAY input_buf, JDIMENSION *in_row_ctr, | |
60 | JDIMENSION in_rows_avail)); | |
61 | }; | |
62 | ||
63 | /* Compression preprocessing (downsampling input buffer control) */ | |
64 | struct jpeg_c_prep_controller { | |
65 | JMETHOD(void, start_pass, (j_compress_ptr cinfo, J_BUF_MODE pass_mode)); | |
66 | JMETHOD(void, pre_process_data, (j_compress_ptr cinfo, | |
67 | JSAMPARRAY input_buf, | |
68 | JDIMENSION *in_row_ctr, | |
69 | JDIMENSION in_rows_avail, | |
70 | JSAMPIMAGE output_buf, | |
71 | JDIMENSION *out_row_group_ctr, | |
72 | JDIMENSION out_row_groups_avail)); | |
73 | }; | |
74 | ||
75 | /* Coefficient buffer control */ | |
76 | struct jpeg_c_coef_controller { | |
77 | JMETHOD(void, start_pass, (j_compress_ptr cinfo, J_BUF_MODE pass_mode)); | |
78 | JMETHOD(boolean, compress_data, (j_compress_ptr cinfo, | |
79 | JSAMPIMAGE input_buf)); | |
80 | }; | |
81 | ||
82 | /* Colorspace conversion */ | |
83 | struct jpeg_color_converter { | |
84 | JMETHOD(void, start_pass, (j_compress_ptr cinfo)); | |
85 | JMETHOD(void, color_convert, (j_compress_ptr cinfo, | |
86 | JSAMPARRAY input_buf, JSAMPIMAGE output_buf, | |
87 | JDIMENSION output_row, int num_rows)); | |
88 | }; | |
89 | ||
90 | /* Downsampling */ | |
91 | struct jpeg_downsampler { | |
92 | JMETHOD(void, start_pass, (j_compress_ptr cinfo)); | |
93 | JMETHOD(void, downsample, (j_compress_ptr cinfo, | |
94 | JSAMPIMAGE input_buf, JDIMENSION in_row_index, | |
95 | JSAMPIMAGE output_buf, | |
96 | JDIMENSION out_row_group_index)); | |
97 | ||
98 | boolean need_context_rows; /* TRUE if need rows above & below */ | |
99 | }; | |
100 | ||
101 | /* Forward DCT (also controls coefficient quantization) */ | |
102 | struct jpeg_forward_dct { | |
103 | JMETHOD(void, start_pass, (j_compress_ptr cinfo)); | |
104 | /* perhaps this should be an array??? */ | |
105 | JMETHOD(void, forward_DCT, (j_compress_ptr cinfo, | |
106 | jpeg_component_info * compptr, | |
107 | JSAMPARRAY sample_data, JBLOCKROW coef_blocks, | |
108 | JDIMENSION start_row, JDIMENSION start_col, | |
109 | JDIMENSION num_blocks)); | |
110 | }; | |
111 | ||
112 | /* Entropy encoding */ | |
113 | struct jpeg_entropy_encoder { | |
114 | JMETHOD(void, start_pass, (j_compress_ptr cinfo, boolean gather_statistics)); | |
115 | JMETHOD(boolean, encode_mcu, (j_compress_ptr cinfo, JBLOCKROW *MCU_data)); | |
116 | JMETHOD(void, finish_pass, (j_compress_ptr cinfo)); | |
117 | }; | |
118 | ||
119 | /* Marker writing */ | |
120 | struct jpeg_marker_writer { | |
121 | JMETHOD(void, write_file_header, (j_compress_ptr cinfo)); | |
122 | JMETHOD(void, write_frame_header, (j_compress_ptr cinfo)); | |
123 | JMETHOD(void, write_scan_header, (j_compress_ptr cinfo)); | |
124 | JMETHOD(void, write_file_trailer, (j_compress_ptr cinfo)); | |
125 | JMETHOD(void, write_tables_only, (j_compress_ptr cinfo)); | |
126 | /* These routines are exported to allow insertion of extra markers */ | |
127 | /* Probably only COM and APPn markers should be written this way */ | |
128 | JMETHOD(void, write_marker_header, (j_compress_ptr cinfo, int marker, | |
129 | unsigned int datalen)); | |
130 | JMETHOD(void, write_marker_byte, (j_compress_ptr cinfo, int val)); | |
131 | }; | |
132 | ||
133 | ||
134 | /* Declarations for decompression modules */ | |
135 | ||
136 | /* Master control module */ | |
137 | struct jpeg_decomp_master { | |
138 | JMETHOD(void, prepare_for_output_pass, (j_decompress_ptr cinfo)); | |
139 | JMETHOD(void, finish_output_pass, (j_decompress_ptr cinfo)); | |
140 | ||
141 | /* State variables made visible to other modules */ | |
142 | boolean is_dummy_pass; /* True during 1st pass for 2-pass quant */ | |
143 | }; | |
144 | ||
145 | /* Input control module */ | |
146 | struct jpeg_input_controller { | |
147 | JMETHOD(int, consume_input, (j_decompress_ptr cinfo)); | |
148 | JMETHOD(void, reset_input_controller, (j_decompress_ptr cinfo)); | |
149 | JMETHOD(void, start_input_pass, (j_decompress_ptr cinfo)); | |
150 | JMETHOD(void, finish_input_pass, (j_decompress_ptr cinfo)); | |
151 | ||
152 | /* State variables made visible to other modules */ | |
153 | boolean has_multiple_scans; /* True if file has multiple scans */ | |
154 | boolean eoi_reached; /* True when EOI has been consumed */ | |
155 | }; | |
156 | ||
157 | /* Main buffer control (downsampled-data buffer) */ | |
158 | struct jpeg_d_main_controller { | |
159 | JMETHOD(void, start_pass, (j_decompress_ptr cinfo, J_BUF_MODE pass_mode)); | |
160 | JMETHOD(void, process_data, (j_decompress_ptr cinfo, | |
161 | JSAMPARRAY output_buf, JDIMENSION *out_row_ctr, | |
162 | JDIMENSION out_rows_avail)); | |
163 | }; | |
164 | ||
165 | /* Coefficient buffer control */ | |
166 | struct jpeg_d_coef_controller { | |
2b5f62a0 VZ |
167 | #if defined(__VISAGECPP__) |
168 | /* the start input pass in jdcoeft must have a different name than the | |
169 | // one in jdtrans under VisualAge or else we get a dup symbol error | |
170 | */ | |
171 | JMETHOD(void, start_input_pass2, (j_decompress_ptr cinfo)); | |
172 | #else | |
e1929140 | 173 | JMETHOD(void, start_input_pass, (j_decompress_ptr cinfo)); |
2b5f62a0 VZ |
174 | #endif |
175 | ||
e1929140 RR |
176 | JMETHOD(int, consume_data, (j_decompress_ptr cinfo)); |
177 | JMETHOD(void, start_output_pass, (j_decompress_ptr cinfo)); | |
178 | JMETHOD(int, decompress_data, (j_decompress_ptr cinfo, | |
179 | JSAMPIMAGE output_buf)); | |
180 | /* Pointer to array of coefficient virtual arrays, or NULL if none */ | |
181 | jvirt_barray_ptr *coef_arrays; | |
182 | }; | |
183 | ||
184 | /* Decompression postprocessing (color quantization buffer control) */ | |
185 | struct jpeg_d_post_controller { | |
186 | JMETHOD(void, start_pass, (j_decompress_ptr cinfo, J_BUF_MODE pass_mode)); | |
187 | JMETHOD(void, post_process_data, (j_decompress_ptr cinfo, | |
188 | JSAMPIMAGE input_buf, | |
189 | JDIMENSION *in_row_group_ctr, | |
190 | JDIMENSION in_row_groups_avail, | |
191 | JSAMPARRAY output_buf, | |
192 | JDIMENSION *out_row_ctr, | |
193 | JDIMENSION out_rows_avail)); | |
194 | }; | |
195 | ||
196 | /* Marker reading & parsing */ | |
197 | struct jpeg_marker_reader { | |
198 | JMETHOD(void, reset_marker_reader, (j_decompress_ptr cinfo)); | |
199 | /* Read markers until SOS or EOI. | |
200 | * Returns same codes as are defined for jpeg_consume_input: | |
201 | * JPEG_SUSPENDED, JPEG_REACHED_SOS, or JPEG_REACHED_EOI. | |
202 | */ | |
203 | JMETHOD(int, read_markers, (j_decompress_ptr cinfo)); | |
204 | /* Read a restart marker --- exported for use by entropy decoder only */ | |
205 | jpeg_marker_parser_method read_restart_marker; | |
206 | ||
207 | /* State of marker reader --- nominally internal, but applications | |
208 | * supplying COM or APPn handlers might like to know the state. | |
209 | */ | |
210 | boolean saw_SOI; /* found SOI? */ | |
211 | boolean saw_SOF; /* found SOF? */ | |
212 | int next_restart_num; /* next restart number expected (0-7) */ | |
213 | unsigned int discarded_bytes; /* # of bytes skipped looking for a marker */ | |
214 | }; | |
215 | ||
216 | /* Entropy decoding */ | |
217 | struct jpeg_entropy_decoder { | |
218 | JMETHOD(void, start_pass, (j_decompress_ptr cinfo)); | |
219 | JMETHOD(boolean, decode_mcu, (j_decompress_ptr cinfo, | |
220 | JBLOCKROW *MCU_data)); | |
221 | ||
222 | /* This is here to share code between baseline and progressive decoders; */ | |
223 | /* other modules probably should not use it */ | |
224 | boolean insufficient_data; /* set TRUE after emitting warning */ | |
225 | }; | |
226 | ||
227 | /* Inverse DCT (also performs dequantization) */ | |
228 | typedef JMETHOD(void, inverse_DCT_method_ptr, | |
229 | (j_decompress_ptr cinfo, jpeg_component_info * compptr, | |
230 | JCOEFPTR coef_block, | |
231 | JSAMPARRAY output_buf, JDIMENSION output_col)); | |
232 | ||
233 | struct jpeg_inverse_dct { | |
234 | JMETHOD(void, start_pass, (j_decompress_ptr cinfo)); | |
235 | /* It is useful to allow each component to have a separate IDCT method. */ | |
236 | inverse_DCT_method_ptr inverse_DCT[MAX_COMPONENTS]; | |
237 | }; | |
238 | ||
239 | /* Upsampling (note that upsampler must also call color converter) */ | |
240 | struct jpeg_upsampler { | |
241 | JMETHOD(void, start_pass, (j_decompress_ptr cinfo)); | |
242 | JMETHOD(void, upsample, (j_decompress_ptr cinfo, | |
243 | JSAMPIMAGE input_buf, | |
244 | JDIMENSION *in_row_group_ctr, | |
245 | JDIMENSION in_row_groups_avail, | |
246 | JSAMPARRAY output_buf, | |
247 | JDIMENSION *out_row_ctr, | |
248 | JDIMENSION out_rows_avail)); | |
249 | ||
250 | boolean need_context_rows; /* TRUE if need rows above & below */ | |
251 | }; | |
252 | ||
253 | /* Colorspace conversion */ | |
254 | struct jpeg_color_deconverter { | |
255 | JMETHOD(void, start_pass, (j_decompress_ptr cinfo)); | |
256 | JMETHOD(void, color_convert, (j_decompress_ptr cinfo, | |
257 | JSAMPIMAGE input_buf, JDIMENSION input_row, | |
258 | JSAMPARRAY output_buf, int num_rows)); | |
259 | }; | |
260 | ||
261 | /* Color quantization or color precision reduction */ | |
262 | struct jpeg_color_quantizer { | |
263 | JMETHOD(void, start_pass, (j_decompress_ptr cinfo, boolean is_pre_scan)); | |
264 | JMETHOD(void, color_quantize, (j_decompress_ptr cinfo, | |
265 | JSAMPARRAY input_buf, JSAMPARRAY output_buf, | |
266 | int num_rows)); | |
267 | JMETHOD(void, finish_pass, (j_decompress_ptr cinfo)); | |
268 | JMETHOD(void, new_color_map, (j_decompress_ptr cinfo)); | |
269 | }; | |
270 | ||
271 | ||
272 | /* Miscellaneous useful macros */ | |
273 | ||
274 | #undef MAX | |
275 | #define MAX(a,b) ((a) > (b) ? (a) : (b)) | |
276 | #undef MIN | |
277 | #define MIN(a,b) ((a) < (b) ? (a) : (b)) | |
278 | ||
279 | ||
280 | /* We assume that right shift corresponds to signed division by 2 with | |
281 | * rounding towards minus infinity. This is correct for typical "arithmetic | |
282 | * shift" instructions that shift in copies of the sign bit. But some | |
283 | * C compilers implement >> with an unsigned shift. For these machines you | |
284 | * must define RIGHT_SHIFT_IS_UNSIGNED. | |
285 | * RIGHT_SHIFT provides a proper signed right shift of an INT32 quantity. | |
286 | * It is only applied with constant shift counts. SHIFT_TEMPS must be | |
287 | * included in the variables of any routine using RIGHT_SHIFT. | |
288 | */ | |
289 | ||
290 | #ifdef RIGHT_SHIFT_IS_UNSIGNED | |
39c2d6bd | 291 | #define SHIFT_TEMPS JPEG_INT32 shift_temp; |
e1929140 RR |
292 | #define RIGHT_SHIFT(x,shft) \ |
293 | ((shift_temp = (x)) < 0 ? \ | |
39c2d6bd | 294 | (shift_temp >> (shft)) | ((~((JPEG_INT32) 0)) << (32-(shft))) : \ |
e1929140 RR |
295 | (shift_temp >> (shft))) |
296 | #else | |
297 | #define SHIFT_TEMPS | |
298 | #define RIGHT_SHIFT(x,shft) ((x) >> (shft)) | |
299 | #endif | |
300 | ||
301 | ||
302 | /* Short forms of external names for systems with brain-damaged linkers. */ | |
303 | ||
304 | #ifdef NEED_SHORT_EXTERNAL_NAMES | |
305 | #define jinit_compress_master jICompress | |
306 | #define jinit_c_master_control jICMaster | |
307 | #define jinit_c_main_controller jICMainC | |
308 | #define jinit_c_prep_controller jICPrepC | |
309 | #define jinit_c_coef_controller jICCoefC | |
310 | #define jinit_color_converter jICColor | |
311 | #define jinit_downsampler jIDownsampler | |
312 | #define jinit_forward_dct jIFDCT | |
313 | #define jinit_huff_encoder jIHEncoder | |
314 | #define jinit_phuff_encoder jIPHEncoder | |
315 | #define jinit_marker_writer jIMWriter | |
316 | #define jinit_master_decompress jIDMaster | |
317 | #define jinit_d_main_controller jIDMainC | |
318 | #define jinit_d_coef_controller jIDCoefC | |
319 | #define jinit_d_post_controller jIDPostC | |
320 | #define jinit_input_controller jIInCtlr | |
321 | #define jinit_marker_reader jIMReader | |
322 | #define jinit_huff_decoder jIHDecoder | |
323 | #define jinit_phuff_decoder jIPHDecoder | |
324 | #define jinit_inverse_dct jIIDCT | |
325 | #define jinit_upsampler jIUpsampler | |
326 | #define jinit_color_deconverter jIDColor | |
327 | #define jinit_1pass_quantizer jI1Quant | |
328 | #define jinit_2pass_quantizer jI2Quant | |
329 | #define jinit_merged_upsampler jIMUpsampler | |
330 | #define jinit_memory_mgr jIMemMgr | |
331 | #define jdiv_round_up jDivRound | |
332 | #define jround_up jRound | |
333 | #define jcopy_sample_rows jCopySamples | |
334 | #define jcopy_block_row jCopyBlocks | |
335 | #define jzero_far jZeroFar | |
336 | #define jpeg_zigzag_order jZIGTable | |
337 | #define jpeg_natural_order jZAGTable | |
338 | #endif /* NEED_SHORT_EXTERNAL_NAMES */ | |
339 | ||
340 | ||
341 | /* Compression module initialization routines */ | |
342 | EXTERN(void) jinit_compress_master JPP((j_compress_ptr cinfo)); | |
343 | EXTERN(void) jinit_c_master_control JPP((j_compress_ptr cinfo, | |
344 | boolean transcode_only)); | |
345 | EXTERN(void) jinit_c_main_controller JPP((j_compress_ptr cinfo, | |
346 | boolean need_full_buffer)); | |
347 | EXTERN(void) jinit_c_prep_controller JPP((j_compress_ptr cinfo, | |
348 | boolean need_full_buffer)); | |
349 | EXTERN(void) jinit_c_coef_controller JPP((j_compress_ptr cinfo, | |
350 | boolean need_full_buffer)); | |
351 | EXTERN(void) jinit_color_converter JPP((j_compress_ptr cinfo)); | |
352 | EXTERN(void) jinit_downsampler JPP((j_compress_ptr cinfo)); | |
353 | EXTERN(void) jinit_forward_dct JPP((j_compress_ptr cinfo)); | |
354 | EXTERN(void) jinit_huff_encoder JPP((j_compress_ptr cinfo)); | |
355 | EXTERN(void) jinit_phuff_encoder JPP((j_compress_ptr cinfo)); | |
356 | EXTERN(void) jinit_marker_writer JPP((j_compress_ptr cinfo)); | |
357 | /* Decompression module initialization routines */ | |
358 | EXTERN(void) jinit_master_decompress JPP((j_decompress_ptr cinfo)); | |
359 | EXTERN(void) jinit_d_main_controller JPP((j_decompress_ptr cinfo, | |
360 | boolean need_full_buffer)); | |
361 | EXTERN(void) jinit_d_coef_controller JPP((j_decompress_ptr cinfo, | |
362 | boolean need_full_buffer)); | |
363 | EXTERN(void) jinit_d_post_controller JPP((j_decompress_ptr cinfo, | |
364 | boolean need_full_buffer)); | |
365 | EXTERN(void) jinit_input_controller JPP((j_decompress_ptr cinfo)); | |
366 | EXTERN(void) jinit_marker_reader JPP((j_decompress_ptr cinfo)); | |
367 | EXTERN(void) jinit_huff_decoder JPP((j_decompress_ptr cinfo)); | |
368 | EXTERN(void) jinit_phuff_decoder JPP((j_decompress_ptr cinfo)); | |
369 | EXTERN(void) jinit_inverse_dct JPP((j_decompress_ptr cinfo)); | |
370 | EXTERN(void) jinit_upsampler JPP((j_decompress_ptr cinfo)); | |
371 | EXTERN(void) jinit_color_deconverter JPP((j_decompress_ptr cinfo)); | |
372 | EXTERN(void) jinit_1pass_quantizer JPP((j_decompress_ptr cinfo)); | |
373 | EXTERN(void) jinit_2pass_quantizer JPP((j_decompress_ptr cinfo)); | |
374 | EXTERN(void) jinit_merged_upsampler JPP((j_decompress_ptr cinfo)); | |
375 | /* Memory manager initialization */ | |
376 | EXTERN(void) jinit_memory_mgr JPP((j_common_ptr cinfo)); | |
377 | ||
378 | /* Utility routines in jutils.c */ | |
379 | EXTERN(long) jdiv_round_up JPP((long a, long b)); | |
380 | EXTERN(long) jround_up JPP((long a, long b)); | |
381 | EXTERN(void) jcopy_sample_rows JPP((JSAMPARRAY input_array, int source_row, | |
382 | JSAMPARRAY output_array, int dest_row, | |
383 | int num_rows, JDIMENSION num_cols)); | |
384 | EXTERN(void) jcopy_block_row JPP((JBLOCKROW input_row, JBLOCKROW output_row, | |
385 | JDIMENSION num_blocks)); | |
386 | EXTERN(void) jzero_far JPP((void FAR * target, size_t bytestozero)); | |
387 | /* Constant tables in jutils.c */ | |
388 | #if 0 /* This table is not actually needed in v6a */ | |
389 | extern const int jpeg_zigzag_order[]; /* natural coef order to zigzag order */ | |
390 | #endif | |
391 | extern const int jpeg_natural_order[]; /* zigzag coef order to natural order */ | |
392 | ||
393 | /* Suppress undefined-structure complaints if necessary. */ | |
394 | ||
395 | #ifdef INCOMPLETE_TYPES_BROKEN | |
396 | #ifndef AM_MEMORY_MANAGER /* only jmemmgr.c defines these */ | |
397 | struct jvirt_sarray_control { long dummy; }; | |
398 | struct jvirt_barray_control { long dummy; }; | |
399 | #endif | |
400 | #endif /* INCOMPLETE_TYPES_BROKEN */ |