jpegint.h
Go to the documentation of this file.
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 */
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) */
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) */
65  JMETHOD(void, start_pass, (j_compress_ptr cinfo, J_BUF_MODE pass_mode));
67  JSAMPARRAY input_buf,
68  JDIMENSION *in_row_ctr,
69  JDIMENSION in_rows_avail,
71  JDIMENSION *out_row_group_ctr,
72  JDIMENSION out_row_groups_avail));
73 };
74 
75 /* Coefficient buffer control */
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 */
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,
88 };
89 
90 /* Downsampling */
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,
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) */
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,
107  JSAMPARRAY sample_data, JBLOCKROW coef_blocks,
108  JDIMENSION start_row, JDIMENSION start_col,
110 };
111 
112 /* Entropy encoding */
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 */
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 */
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 */
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 */
147  JMETHOD(int, consume_input, (j_decompress_ptr cinfo));
149  JMETHOD(void, start_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) */
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 */
167  JMETHOD(void, start_input_pass, (j_decompress_ptr cinfo));
168  JMETHOD(int, consume_data, (j_decompress_ptr cinfo));
172  /* Pointer to array of coefficient virtual arrays, or NULL if none */
174 };
175 
176 /* Decompression postprocessing (color quantization buffer control) */
178  JMETHOD(void, start_pass, (j_decompress_ptr cinfo, J_BUF_MODE pass_mode));
179  JMETHOD(void, post_process_data, (j_decompress_ptr cinfo,
180  JSAMPIMAGE input_buf,
181  JDIMENSION *in_row_group_ctr,
182  JDIMENSION in_row_groups_avail,
184  JDIMENSION *out_row_ctr,
185  JDIMENSION out_rows_avail));
186 };
187 
188 /* Marker reading & parsing */
191  /* Read markers until SOS or EOI.
192  * Returns same codes as are defined for jpeg_consume_input:
193  * JPEG_SUSPENDED, JPEG_REACHED_SOS, or JPEG_REACHED_EOI.
194  */
195  JMETHOD(int, read_markers, (j_decompress_ptr cinfo));
196  /* Read a restart marker --- exported for use by entropy decoder only */
197  jpeg_marker_parser_method read_restart_marker;
198 
199  /* State of marker reader --- nominally internal, but applications
200  * supplying COM or APPn handlers might like to know the state.
201  */
202  boolean saw_SOI; /* found SOI? */
203  boolean saw_SOF; /* found SOF? */
204  int next_restart_num; /* next restart number expected (0-7) */
205  unsigned int discarded_bytes; /* # of bytes skipped looking for a marker */
206 };
207 
208 /* Entropy decoding */
210  JMETHOD(void, start_pass, (j_decompress_ptr cinfo));
211  JMETHOD(boolean, decode_mcu, (j_decompress_ptr cinfo,
212  JBLOCKROW *MCU_data));
213 
214  /* This is here to share code between baseline and progressive decoders; */
215  /* other modules probably should not use it */
216  boolean insufficient_data; /* set TRUE after emitting warning */
217 };
218 
219 /* Inverse DCT (also performs dequantization) */
220 typedef JMETHOD(void, inverse_DCT_method_ptr,
224 
226  JMETHOD(void, start_pass, (j_decompress_ptr cinfo));
227  /* It is useful to allow each component to have a separate IDCT method. */
228  inverse_DCT_method_ptr inverse_DCT[MAX_COMPONENTS];
229 };
230 
231 /* Upsampling (note that upsampler must also call color converter) */
233  JMETHOD(void, start_pass, (j_decompress_ptr cinfo));
234  JMETHOD(void, upsample, (j_decompress_ptr cinfo,
235  JSAMPIMAGE input_buf,
236  JDIMENSION *in_row_group_ctr,
237  JDIMENSION in_row_groups_avail,
239  JDIMENSION *out_row_ctr,
240  JDIMENSION out_rows_avail));
241 
242  boolean need_context_rows; /* TRUE if need rows above & below */
243 };
244 
245 /* Colorspace conversion */
247  JMETHOD(void, start_pass, (j_decompress_ptr cinfo));
248  JMETHOD(void, color_convert, (j_decompress_ptr cinfo,
249  JSAMPIMAGE input_buf, JDIMENSION input_row,
251 };
252 
253 /* Color quantization or color precision reduction */
255  JMETHOD(void, start_pass, (j_decompress_ptr cinfo, boolean is_pre_scan));
257  JSAMPARRAY input_buf, JSAMPARRAY output_buf,
258  int num_rows));
259  JMETHOD(void, finish_pass, (j_decompress_ptr cinfo));
260  JMETHOD(void, new_color_map, (j_decompress_ptr cinfo));
261 };
262 
263 
264 /* Miscellaneous useful macros */
265 
266 #undef MAX
267 #define MAX(a,b) ((a) > (b) ? (a) : (b))
268 #undef MIN
269 #define MIN(a,b) ((a) < (b) ? (a) : (b))
270 
271 
272 /* We assume that right shift corresponds to signed division by 2 with
273  * rounding towards minus infinity. This is correct for typical "arithmetic
274  * shift" instructions that shift in copies of the sign bit. But some
275  * C compilers implement >> with an unsigned shift. For these machines you
276  * must define RIGHT_SHIFT_IS_UNSIGNED.
277  * RIGHT_SHIFT provides a proper signed right shift of an INT32 quantity.
278  * It is only applied with constant shift counts. SHIFT_TEMPS must be
279  * included in the variables of any routine using RIGHT_SHIFT.
280  */
281 
282 #ifdef RIGHT_SHIFT_IS_UNSIGNED
283 #define SHIFT_TEMPS INT32 shift_temp;
284 #define RIGHT_SHIFT(x,shft) \
285  ((shift_temp = (x)) < 0 ? \
286  (shift_temp >> (shft)) | ((~((INT32) 0)) << (32-(shft))) : \
287  (shift_temp >> (shft)))
288 #else
289 #define SHIFT_TEMPS
290 #define RIGHT_SHIFT(x,shft) ((x) >> (shft))
291 #endif
292 
293 
294 /* Short forms of external names for systems with brain-damaged linkers. */
295 
296 #ifdef NEED_SHORT_EXTERNAL_NAMES
297 #define jinit_compress_master jICompress
298 #define jinit_c_master_control jICMaster
299 #define jinit_c_main_controller jICMainC
300 #define jinit_c_prep_controller jICPrepC
301 #define jinit_c_coef_controller jICCoefC
302 #define jinit_color_converter jICColor
303 #define jinit_downsampler jIDownsampler
304 #define jinit_forward_dct jIFDCT
305 #define jinit_huff_encoder jIHEncoder
306 #define jinit_phuff_encoder jIPHEncoder
307 #define jinit_marker_writer jIMWriter
308 #define jinit_master_decompress jIDMaster
309 #define jinit_d_main_controller jIDMainC
310 #define jinit_d_coef_controller jIDCoefC
311 #define jinit_d_post_controller jIDPostC
312 #define jinit_input_controller jIInCtlr
313 #define jinit_marker_reader jIMReader
314 #define jinit_huff_decoder jIHDecoder
315 #define jinit_phuff_decoder jIPHDecoder
316 #define jinit_inverse_dct jIIDCT
317 #define jinit_upsampler jIUpsampler
318 #define jinit_color_deconverter jIDColor
319 #define jinit_1pass_quantizer jI1Quant
320 #define jinit_2pass_quantizer jI2Quant
321 #define jinit_merged_upsampler jIMUpsampler
322 #define jinit_memory_mgr jIMemMgr
323 #define jdiv_round_up jDivRound
324 #define jround_up jRound
325 #define jcopy_sample_rows jCopySamples
326 #define jcopy_block_row jCopyBlocks
327 #define jzero_far jZeroFar
328 #define jpeg_zigzag_order jZIGTable
329 #define jpeg_natural_order jZAGTable
330 #endif /* NEED_SHORT_EXTERNAL_NAMES */
331 
332 
333 /* Compression module initialization routines */
336  boolean transcode_only));
338  boolean need_full_buffer));
340  boolean need_full_buffer));
342  boolean need_full_buffer));
349 /* Decompression module initialization routines */
352  boolean need_full_buffer));
354  boolean need_full_buffer));
356  boolean need_full_buffer));
367 /* Memory manager initialization */
368 EXTERN(void) jinit_memory_mgr JPP((j_common_ptr cinfo));
369 
370 /* Utility routines in jutils.c */
371 EXTERN(long) jdiv_round_up JPP((long a, long b));
372 EXTERN(long) jround_up JPP((long a, long b));
378 EXTERN(void) jzero_far JPP((void FAR * target, size_t bytestozero));
379 /* Constant tables in jutils.c */
380 #if 0 /* This table is not actually needed in v6a */
381 extern const int jpeg_zigzag_order[]; /* natural coef order to zigzag order */
382 #endif
383 extern const int jpeg_natural_order[]; /* zigzag coef order to natural order */
384 
385 /* Suppress undefined-structure complaints if necessary. */
386 
387 #ifdef INCOMPLETE_TYPES_BROKEN
388 #ifndef AM_MEMORY_MANAGER /* only jmemmgr.c defines these */
389 struct jvirt_sarray_control { long dummy; };
390 struct jvirt_barray_control { long dummy; };
391 #endif
392 #endif /* INCOMPLETE_TYPES_BROKEN */
JMETHOD(void, prepare_for_pass,(j_compress_ptr cinfo))
boolean has_multiple_scans
Definition: jpegint.h:153
write_file_header(j_compress_ptr cinfo)
Definition: jcmarker.c:469
start_input_pass(j_decompress_ptr cinfo)
Definition: jdcoefct.c:107
jinit_d_main_controller(j_decompress_ptr cinfo, boolean need_full_buffer)
Definition: jdmainct.c:476
write_scan_header(j_compress_ptr cinfo)
Definition: jcmarker.c:551
unsigned int discarded_bytes
Definition: jpegint.h:205
boolean is_dummy_pass
Definition: jpegint.h:142
jinit_c_main_controller(j_compress_ptr cinfo, boolean need_full_buffer)
Definition: jcmainct.c:245
jinit_input_controller(j_decompress_ptr cinfo)
Definition: jdinput.c:361
jpeg_component_info JCOEFPTR coef_block
Definition: jdct.h:102
const int jpeg_natural_order[]
Definition: jutils.c:53
compress_data(j_compress_ptr cinfo, JSAMPIMAGE input_buf)
Definition: jccoefct.c:143
jinit_d_coef_controller(j_decompress_ptr cinfo, boolean need_full_buffer)
Definition: jdcoefct.c:676
#define MAX_COMPONENTS
Definition: jmorecfg.h:35
forward_DCT(j_compress_ptr cinfo, jpeg_component_info *compptr, JSAMPARRAY sample_data, JBLOCKROW coef_blocks, JDIMENSION start_row, JDIMENSION start_col, JDIMENSION num_blocks)
Definition: jcdctmgr.c:180
Definition: jpegint.h:177
jvirt_barray_ptr * coef_arrays
Definition: jpegint.h:173
jinit_d_post_controller(j_decompress_ptr cinfo, boolean need_full_buffer)
Definition: jdpostct.c:250
int const JOCTET unsigned int datalen
Definition: jpeglib.h:950
jinit_upsampler(j_decompress_ptr cinfo)
Definition: jdsample.c:399
boolean need_full_buffer
Definition: jpegint.h:338
start_pass(j_decompress_ptr cinfo)
Definition: jddctmgr.c:89
jinit_color_deconverter(j_decompress_ptr cinfo)
Definition: jdcolor.c:304
write_file_trailer(j_compress_ptr cinfo)
Definition: jcmarker.c:602
boolean call_pass_startup
Definition: jpegint.h:51
jinit_forward_dct(j_compress_ptr cinfo)
Definition: jcdctmgr.c:345
jpeg_component_info * compptr
Definition: jdct.h:102
long b
Definition: jpegint.h:371
write_marker_byte(j_compress_ptr cinfo, int val)
Definition: jcmarker.c:450
boolean is_last_pass
Definition: jpegint.h:52
jround_up(long a, long b)
Definition: jutils.c:81
jpeg_component_info JCOEFPTR JSAMPARRAY JDIMENSION output_col
Definition: jdct.h:102
int JSAMPARRAY int dest_row
Definition: jpegint.h:373
int marker
Definition: jpeglib.h:950
color_quantize(j_decompress_ptr cinfo, JSAMPARRAY input_buf, JSAMPARRAY output_buf, int num_rows)
Definition: jquant1.c:459
finish_output_pass(j_decompress_ptr cinfo)
Definition: jdmaster.c:498
write_marker_header(j_compress_ptr cinfo, int marker, unsigned int datalen)
Definition: jcmarker.c:438
jinit_color_converter(j_compress_ptr cinfo)
Definition: jccolor.c:352
JBLOCKROW JDIMENSION num_blocks
Definition: jpegint.h:376
int JSAMPARRAY int int num_rows
Definition: jpegint.h:373
jinit_downsampler(j_compress_ptr cinfo)
Definition: jcsample.c:464
jinit_merged_upsampler(j_decompress_ptr cinfo)
Definition: jdmerge.c:370
start_output_pass(j_decompress_ptr cinfo)
Definition: jdcoefct.c:119
boolean saw_SOF
Definition: jpegint.h:203
int source_row
Definition: jpegint.h:373
jinit_memory_mgr(j_common_ptr cinfo)
Definition: jmemmgr.c:1028
decode_mcu(j_decompress_ptr cinfo, JBLOCKROW *MCU_data)
Definition: jdhuff.c:517
reset_input_controller(j_decompress_ptr cinfo)
Definition: jdinput.c:339
JBLOCKROW output_row
Definition: jpegint.h:376
jdiv_round_up(long a, long b)
Definition: jutils.c:72
JBLOCK FAR * JBLOCKROW
Definition: jpeglib.h:71
#define FAR
Definition: jmorecfg.h:215
size_t bytestozero
Definition: jpegint.h:378
jinit_phuff_encoder(j_compress_ptr cinfo)
Definition: jcphuff.c:814
int val
Definition: jpeglib.h:956
int JSAMPARRAY int int JDIMENSION num_cols
Definition: jpegint.h:373
jzero_far(void FAR *target, size_t bytestozero)
Definition: jutils.c:165
JCOEF FAR * JCOEFPTR
Definition: jpeglib.h:75
jinit_phuff_decoder(j_decompress_ptr cinfo)
Definition: jdphuff.c:641
jinit_master_decompress(j_decompress_ptr cinfo)
Definition: jdmaster.c:543
decompress_data(j_decompress_ptr cinfo, JSAMPIMAGE output_buf)
Definition: jdcoefct.c:315
#define JPP(arglist)
Definition: jpeglib.h:818
jinit_huff_encoder(j_compress_ptr cinfo)
Definition: jchuff.c:891
JSAMPARRAY * JSAMPIMAGE
Definition: jpeglib.h:68
jinit_1pass_quantizer(j_decompress_ptr cinfo)
Definition: jquant1.c:821
pass_startup(j_compress_ptr cinfo)
Definition: jcmaster.c:489
pre_process_data(j_compress_ptr cinfo, JSAMPARRAY input_buf, JDIMENSION *in_row_ctr, JDIMENSION in_rows_avail, JSAMPIMAGE output_buf, JDIMENSION *out_row_group_ctr, JDIMENSION out_row_groups_avail)
Definition: jcprepct.c:128
write_tables_only(j_compress_ptr cinfo)
Definition: jcmarker.c:616
finish_input_pass(j_decompress_ptr cinfo)
Definition: jdinput.c:271
JSAMPROW * JSAMPARRAY
Definition: jpeglib.h:67
reset_marker_reader(j_decompress_ptr cinfo)
Definition: jdmarker.c:1242
write_frame_header(j_compress_ptr cinfo)
Definition: jcmarker.c:494
jinit_marker_writer(j_compress_ptr cinfo)
Definition: jcmarker.c:645
J_BUF_MODE
Definition: jpegint.h:16
boolean need_context_rows
Definition: jpegint.h:242
read_markers(j_decompress_ptr cinfo)
Definition: jdmarker.c:952
jcopy_block_row(JBLOCKROW input_row, JBLOCKROW output_row, JDIMENSION num_blocks)
Definition: jutils.c:145
jinit_c_master_control(j_compress_ptr cinfo, boolean transcode_only)
Definition: jcmaster.c:543
jinit_marker_reader(j_decompress_ptr cinfo)
Definition: jdmarker.c:1262
jpeg_component_info JCOEFPTR JSAMPARRAY output_buf
Definition: jdct.h:102
unsigned int JDIMENSION
Definition: jmorecfg.h:171
jinit_inverse_dct(j_decompress_ptr cinfo)
Definition: jddctmgr.c:247
jinit_compress_master(j_compress_ptr cinfo)
Definition: jcinit.c:30
EXTERN(void) jinit_compress_master JPP((j_compress_ptr cinfo))
boolean insufficient_data
Definition: jpegint.h:216
prepare_for_output_pass(j_decompress_ptr cinfo)
Definition: jdmaster.c:438
consume_data(j_decompress_ptr cinfo)
Definition: jdcoefct.c:244
jpeg_marker_parser_method read_restart_marker
Definition: jpegint.h:197
jcopy_sample_rows(JSAMPARRAY input_array, int source_row, JSAMPARRAY output_array, int dest_row, int num_rows, JDIMENSION num_cols)
Definition: jutils.c:111
int JSAMPARRAY output_array
Definition: jpegint.h:373
jinit_c_coef_controller(j_compress_ptr cinfo, boolean need_full_buffer)
Definition: jccoefct.c:405
jinit_2pass_quantizer(j_decompress_ptr cinfo)
Definition: jquant2.c:1244
prepare_for_pass(j_compress_ptr cinfo)
Definition: jcmaster.c:401
jinit_c_prep_controller(j_compress_ptr cinfo, boolean need_full_buffer)
Definition: jcprepct.c:315
boolean saw_SOI
Definition: jpegint.h:202
boolean need_context_rows
Definition: jpegint.h:98
boolean transcode_only
Definition: jpegint.h:336
jinit_huff_decoder(j_decompress_ptr cinfo)
Definition: jdhuff.c:635


openhrp3
Author(s): AIST, General Robotix Inc., Nakamura Lab of Dept. of Mechano Informatics at University of Tokyo
autogenerated on Sat Apr 13 2019 02:14:23