-/*\r
-\r
- * jpegint.h\r
-\r
- *\r
-\r
- * Copyright (C) 1991-1995, Thomas G. Lane.\r
-\r
- * This file is part of the Independent JPEG Group's software.\r
-\r
- * For conditions of distribution and use, see the accompanying README file.\r
-\r
- *\r
-\r
- * This file provides common declarations for the various JPEG modules.\r
-\r
- * These declarations are considered internal to the JPEG library; most\r
-\r
- * applications using the library shouldn't need to include this file.\r
-\r
- */\r
-\r
-\r
-\r
-\r
-\r
-/* Declarations for both compression & decompression */\r
-\r
-\r
-\r
-typedef enum { /* Operating modes for buffer controllers */\r
-\r
- JBUF_PASS_THRU, /* Plain stripwise operation */\r
-\r
- /* Remaining modes require a full-image buffer to have been created */\r
-\r
- JBUF_SAVE_SOURCE, /* Run source subobject only, save output */\r
-\r
- JBUF_CRANK_DEST, /* Run dest subobject only, using saved data */\r
-\r
- JBUF_SAVE_AND_PASS /* Run both subobjects, save output */\r
-\r
-} J_BUF_MODE;\r
-\r
-\r
-\r
-/* Values of global_state field (jdapi.c has some dependencies on ordering!) */\r
-\r
-#define CSTATE_START 100 /* after create_compress */\r
-\r
-#define CSTATE_SCANNING 101 /* start_compress done, write_scanlines OK */\r
-\r
-#define CSTATE_RAW_OK 102 /* start_compress done, write_raw_data OK */\r
-\r
-#define CSTATE_WRCOEFS 103 /* jpeg_write_coefficients done */\r
-\r
-#define DSTATE_START 200 /* after create_decompress */\r
-\r
-#define DSTATE_INHEADER 201 /* reading header markers, no SOS yet */\r
-\r
-#define DSTATE_READY 202 /* found SOS, ready for start_decompress */\r
-\r
-#define DSTATE_PRELOAD 203 /* reading multiscan file in start_decompress*/\r
-\r
-#define DSTATE_PRESCAN 204 /* performing dummy pass for 2-pass quant */\r
-\r
-#define DSTATE_SCANNING 205 /* start_decompress done, read_scanlines OK */\r
-\r
-#define DSTATE_RAW_OK 206 /* start_decompress done, read_raw_data OK */\r
-\r
-#define DSTATE_BUFIMAGE 207 /* expecting jpeg_start_output */\r
-\r
-#define DSTATE_BUFPOST 208 /* looking for SOS/EOI in jpeg_finish_output */\r
-\r
-#define DSTATE_RDCOEFS 209 /* reading file in jpeg_read_coefficients */\r
-\r
-#define DSTATE_STOPPING 210 /* looking for EOI in jpeg_finish_decompress */\r
-\r
-\r
-\r
-\r
-\r
-/* Declarations for compression modules */\r
-\r
-\r
-\r
-/* Master control module */\r
-\r
-struct jpeg_comp_master {\r
-\r
- JMETHOD(void, prepare_for_pass, (j_compress_ptr cinfo));\r
-\r
- JMETHOD(void, pass_startup, (j_compress_ptr cinfo));\r
-\r
- JMETHOD(void, finish_pass, (j_compress_ptr cinfo));\r
-\r
-\r
-\r
- /* State variables made visible to other modules */\r
-\r
- boolean call_pass_startup; /* True if pass_startup must be called */\r
-\r
- boolean is_last_pass; /* True during last pass */\r
-\r
-};\r
-\r
-\r
-\r
-/* Main buffer control (downsampled-data buffer) */\r
-\r
-struct jpeg_c_main_controller {\r
-\r
- JMETHOD(void, start_pass, (j_compress_ptr cinfo, J_BUF_MODE pass_mode));\r
-\r
- JMETHOD(void, process_data, (j_compress_ptr cinfo,\r
-\r
- JSAMPARRAY input_buf, JDIMENSION *in_row_ctr,\r
-\r
- JDIMENSION in_rows_avail));\r
-\r
-};\r
-\r
-\r
-\r
-/* Compression preprocessing (downsampling input buffer control) */\r
-\r
-struct jpeg_c_prep_controller {\r
-\r
- JMETHOD(void, start_pass, (j_compress_ptr cinfo, J_BUF_MODE pass_mode));\r
-\r
- JMETHOD(void, pre_process_data, (j_compress_ptr cinfo,\r
-\r
- JSAMPARRAY input_buf,\r
-\r
- JDIMENSION *in_row_ctr,\r
-\r
- JDIMENSION in_rows_avail,\r
-\r
- JSAMPIMAGE output_buf,\r
-\r
- JDIMENSION *out_row_group_ctr,\r
-\r
- JDIMENSION out_row_groups_avail));\r
-\r
-};\r
-\r
-\r
-\r
-/* Coefficient buffer control */\r
-\r
-struct jpeg_c_coef_controller {\r
-\r
- JMETHOD(void, start_pass, (j_compress_ptr cinfo, J_BUF_MODE pass_mode));\r
-\r
- JMETHOD(boolean, compress_data, (j_compress_ptr cinfo,\r
-\r
- JSAMPIMAGE input_buf));\r
-\r
-};\r
-\r
-\r
-\r
-/* Colorspace conversion */\r
-\r
-struct jpeg_color_converter {\r
-\r
- JMETHOD(void, start_pass, (j_compress_ptr cinfo));\r
-\r
- JMETHOD(void, color_convert, (j_compress_ptr cinfo,\r
-\r
- JSAMPARRAY input_buf, JSAMPIMAGE output_buf,\r
-\r
- JDIMENSION output_row, int num_rows));\r
-\r
-};\r
-\r
-\r
-\r
-/* Downsampling */\r
-\r
-struct jpeg_downsampler {\r
-\r
- JMETHOD(void, start_pass, (j_compress_ptr cinfo));\r
-\r
- JMETHOD(void, downsample, (j_compress_ptr cinfo,\r
-\r
- JSAMPIMAGE input_buf, JDIMENSION in_row_index,\r
-\r
- JSAMPIMAGE output_buf,\r
-\r
- JDIMENSION out_row_group_index));\r
-\r
-\r
-\r
- boolean need_context_rows; /* TRUE if need rows above & below */\r
-\r
-};\r
-\r
-\r
-\r
-/* Forward DCT (also controls coefficient quantization) */\r
-\r
-struct jpeg_forward_dct {\r
-\r
- JMETHOD(void, start_pass, (j_compress_ptr cinfo));\r
-\r
- /* perhaps this should be an array??? */\r
-\r
- JMETHOD(void, forward_DCT, (j_compress_ptr cinfo,\r
-\r
- jpeg_component_info * compptr,\r
-\r
- JSAMPARRAY sample_data, JBLOCKROW coef_blocks,\r
-\r
- JDIMENSION start_row, JDIMENSION start_col,\r
-\r
- JDIMENSION num_blocks));\r
-\r
-};\r
-\r
-\r
-\r
-/* Entropy encoding */\r
-\r
-struct jpeg_entropy_encoder {\r
-\r
- JMETHOD(void, start_pass, (j_compress_ptr cinfo, boolean gather_statistics));\r
-\r
- JMETHOD(boolean, encode_mcu, (j_compress_ptr cinfo, JBLOCKROW *MCU_data));\r
-\r
- JMETHOD(void, finish_pass, (j_compress_ptr cinfo));\r
-\r
-};\r
-\r
-\r
-\r
-/* Marker writing */\r
-\r
-struct jpeg_marker_writer {\r
-\r
- /* write_any_marker is exported for use by applications */\r
-\r
- /* Probably only COM and APPn markers should be written */\r
-\r
- JMETHOD(void, write_any_marker, (j_compress_ptr cinfo, int marker,\r
-\r
- const JOCTET *dataptr, unsigned int datalen));\r
-\r
- JMETHOD(void, write_file_header, (j_compress_ptr cinfo));\r
-\r
- JMETHOD(void, write_frame_header, (j_compress_ptr cinfo));\r
-\r
- JMETHOD(void, write_scan_header, (j_compress_ptr cinfo));\r
-\r
- JMETHOD(void, write_file_trailer, (j_compress_ptr cinfo));\r
-\r
- JMETHOD(void, write_tables_only, (j_compress_ptr cinfo));\r
-\r
-};\r
-\r
-\r
-\r
-\r
-\r
-/* Declarations for decompression modules */\r
-\r
-\r
-\r
-/* Master control module */\r
-\r
-struct jpeg_decomp_master {\r
-\r
- JMETHOD(void, prepare_for_output_pass, (j_decompress_ptr cinfo));\r
-\r
- JMETHOD(void, finish_output_pass, (j_decompress_ptr cinfo));\r
-\r
-\r
-\r
- /* State variables made visible to other modules */\r
-\r
- boolean is_dummy_pass; /* True during 1st pass for 2-pass quant */\r
-\r
-};\r
-\r
-\r
-\r
-/* Input control module */\r
-\r
-struct jpeg_input_controller {\r
-\r
- JMETHOD(int, consume_input, (j_decompress_ptr cinfo));\r
-\r
- JMETHOD(void, reset_input_controller, (j_decompress_ptr cinfo));\r
-\r
- JMETHOD(void, start_input_pass, (j_decompress_ptr cinfo));\r
-\r
- JMETHOD(void, finish_input_pass, (j_decompress_ptr cinfo));\r
-\r
-\r
-\r
- /* State variables made visible to other modules */\r
-\r
- boolean has_multiple_scans; /* True if file has multiple scans */\r
-\r
- boolean eoi_reached; /* True when EOI has been consumed */\r
-\r
-};\r
-\r
-\r
-\r
-/* Main buffer control (downsampled-data buffer) */\r
-\r
-struct jpeg_d_main_controller {\r
-\r
- JMETHOD(void, start_pass, (j_decompress_ptr cinfo, J_BUF_MODE pass_mode));\r
-\r
- JMETHOD(void, process_data, (j_decompress_ptr cinfo,\r
-\r
- JSAMPARRAY output_buf, JDIMENSION *out_row_ctr,\r
-\r
- JDIMENSION out_rows_avail));\r
-\r
-};\r
-\r
-\r
-\r
-/* Coefficient buffer control */\r
-\r
-struct jpeg_d_coef_controller {\r
-\r
- JMETHOD(void, start_input_pass, (j_decompress_ptr cinfo));\r
-\r
- JMETHOD(int, consume_data, (j_decompress_ptr cinfo));\r
-\r
- JMETHOD(void, start_output_pass, (j_decompress_ptr cinfo));\r
-\r
- JMETHOD(int, decompress_data, (j_decompress_ptr cinfo,\r
-\r
- JSAMPIMAGE output_buf));\r
-\r
- /* Pointer to array of coefficient virtual arrays, or NULL if none */\r
-\r
- jvirt_barray_ptr *coef_arrays;\r
-\r
-};\r
-\r
-\r
-\r
-/* Decompression postprocessing (color quantization buffer control) */\r
-\r
-struct jpeg_d_post_controller {\r
-\r
- JMETHOD(void, start_pass, (j_decompress_ptr cinfo, J_BUF_MODE pass_mode));\r
-\r
- JMETHOD(void, post_process_data, (j_decompress_ptr cinfo,\r
-\r
- JSAMPIMAGE input_buf,\r
-\r
- JDIMENSION *in_row_group_ctr,\r
-\r
- JDIMENSION in_row_groups_avail,\r
-\r
- JSAMPARRAY output_buf,\r
-\r
- JDIMENSION *out_row_ctr,\r
-\r
- JDIMENSION out_rows_avail));\r
-\r
-};\r
-\r
-\r
-\r
-/* Marker reading & parsing */\r
-\r
-struct jpeg_marker_reader {\r
-\r
- JMETHOD(void, reset_marker_reader, (j_decompress_ptr cinfo));\r
-\r
- /* Read markers until SOS or EOI.\r
-\r
- * Returns same codes as are defined for jpeg_consume_input:\r
-\r
- * JPEG_SUSPENDED, JPEG_REACHED_SOS, or JPEG_REACHED_EOI.\r
-\r
- */\r
-\r
- JMETHOD(int, read_markers, (j_decompress_ptr cinfo));\r
-\r
- /* Read a restart marker --- exported for use by entropy decoder only */\r
-\r
- jpeg_marker_parser_method read_restart_marker;\r
-\r
- /* Application-overridable marker processing methods */\r
-\r
- jpeg_marker_parser_method process_COM;\r
-\r
- jpeg_marker_parser_method process_APPn[16];\r
-\r
-\r
-\r
- /* State of marker reader --- nominally internal, but applications\r
-\r
- * supplying COM or APPn handlers might like to know the state.\r
-\r
- */\r
-\r
- boolean saw_SOI; /* found SOI? */\r
-\r
- boolean saw_SOF; /* found SOF? */\r
-\r
- int next_restart_num; /* next restart number expected (0-7) */\r
-\r
- unsigned int discarded_bytes; /* # of bytes skipped looking for a marker */\r
-\r
-};\r
-\r
-\r
-\r
-/* Entropy decoding */\r
-\r
-struct jpeg_entropy_decoder {\r
-\r
- JMETHOD(void, start_pass, (j_decompress_ptr cinfo));\r
-\r
- JMETHOD(boolean, decode_mcu, (j_decompress_ptr cinfo,\r
-\r
- JBLOCKROW *MCU_data));\r
-\r
-};\r
-\r
-\r
-\r
-/* Inverse DCT (also performs dequantization) */\r
-\r
-typedef JMETHOD(void, inverse_DCT_method_ptr,\r
-\r
- (j_decompress_ptr cinfo, jpeg_component_info * compptr,\r
-\r
- JCOEFPTR coef_block,\r
-\r
- JSAMPARRAY output_buf, JDIMENSION output_col));\r
-\r
-\r
-\r
-struct jpeg_inverse_dct {\r
-\r
- JMETHOD(void, start_pass, (j_decompress_ptr cinfo));\r
-\r
- /* It is useful to allow each component to have a separate IDCT method. */\r
-\r
- inverse_DCT_method_ptr inverse_DCT[MAX_COMPONENTS];\r
-\r
-};\r
-\r
-\r
-\r
-/* Upsampling (note that upsampler must also call color converter) */\r
-\r
-struct jpeg_upsampler {\r
-\r
- JMETHOD(void, start_pass, (j_decompress_ptr cinfo));\r
-\r
- JMETHOD(void, upsample, (j_decompress_ptr cinfo,\r
-\r
- JSAMPIMAGE input_buf,\r
-\r
- JDIMENSION *in_row_group_ctr,\r
-\r
- JDIMENSION in_row_groups_avail,\r
-\r
- JSAMPARRAY output_buf,\r
-\r
- JDIMENSION *out_row_ctr,\r
-\r
- JDIMENSION out_rows_avail));\r
-\r
-\r
-\r
- boolean need_context_rows; /* TRUE if need rows above & below */\r
-\r
-};\r
-\r
-\r
-\r
-/* Colorspace conversion */\r
-\r
-struct jpeg_color_deconverter {\r
-\r
- JMETHOD(void, start_pass, (j_decompress_ptr cinfo));\r
-\r
- JMETHOD(void, color_convert, (j_decompress_ptr cinfo,\r
-\r
- JSAMPIMAGE input_buf, JDIMENSION input_row,\r
-\r
- JSAMPARRAY output_buf, int num_rows));\r
-\r
-};\r
-\r
-\r
-\r
-/* Color quantization or color precision reduction */\r
-\r
-struct jpeg_color_quantizer {\r
-\r
- JMETHOD(void, start_pass, (j_decompress_ptr cinfo, boolean is_pre_scan));\r
-\r
- JMETHOD(void, color_quantize, (j_decompress_ptr cinfo,\r
-\r
- JSAMPARRAY input_buf, JSAMPARRAY output_buf,\r
-\r
- int num_rows));\r
-\r
- JMETHOD(void, finish_pass, (j_decompress_ptr cinfo));\r
-\r
- JMETHOD(void, new_color_map, (j_decompress_ptr cinfo));\r
-\r
-};\r
-\r
-\r
-\r
-\r
-\r
-/* Miscellaneous useful macros */\r
-\r
-\r
-\r
-#undef MAX\r
-\r
-#define MAX(a,b) ((a) > (b) ? (a) : (b))\r
-\r
-#undef MIN\r
-\r
-#define MIN(a,b) ((a) < (b) ? (a) : (b))\r
-\r
-\r
-\r
-\r
-\r
-/* We assume that right shift corresponds to signed division by 2 with\r
-\r
- * rounding towards minus infinity. This is correct for typical "arithmetic\r
-\r
- * shift" instructions that shift in copies of the sign bit. But some\r
-\r
- * C compilers implement >> with an unsigned shift. For these machines you\r
-\r
- * must define RIGHT_SHIFT_IS_UNSIGNED.\r
-\r
- * RIGHT_SHIFT provides a proper signed right shift of an INT32 quantity.\r
-\r
- * It is only applied with constant shift counts. SHIFT_TEMPS must be\r
-\r
- * included in the variables of any routine using RIGHT_SHIFT.\r
-\r
- */\r
-\r
-\r
-\r
-#ifdef RIGHT_SHIFT_IS_UNSIGNED\r
-\r
-#define SHIFT_TEMPS INT32 shift_temp;\r
-\r
-#define RIGHT_SHIFT(x,shft) \\r
-\r
- ((shift_temp = (x)) < 0 ? \\r
-\r
- (shift_temp >> (shft)) | ((~((INT32) 0)) << (32-(shft))) : \\r
-\r
- (shift_temp >> (shft)))\r
-\r
-#else\r
-\r
-#define SHIFT_TEMPS\r
-\r
-#define RIGHT_SHIFT(x,shft) ((x) >> (shft))\r
-\r
-#endif\r
-\r
-\r
-\r
-\r
-\r
-/* Short forms of external names for systems with brain-damaged linkers. */\r
-\r
-\r
-\r
-#ifdef NEED_SHORT_EXTERNAL_NAMES\r
-\r
-#define jinit_compress_master jICompress\r
-\r
-#define jinit_c_master_control jICMaster\r
-\r
-#define jinit_c_main_controller jICMainC\r
-\r
-#define jinit_c_prep_controller jICPrepC\r
-\r
-#define jinit_c_coef_controller jICCoefC\r
-\r
-#define jinit_color_converter jICColor\r
-\r
-#define jinit_downsampler jIDownsampler\r
-\r
-#define jinit_forward_dct jIFDCT\r
-\r
-#define jinit_huff_encoder jIHEncoder\r
-\r
-#define jinit_phuff_encoder jIPHEncoder\r
-\r
-#define jinit_marker_writer jIMWriter\r
-\r
-#define jinit_master_decompress jIDMaster\r
-\r
-#define jinit_d_main_controller jIDMainC\r
-\r
-#define jinit_d_coef_controller jIDCoefC\r
-\r
-#define jinit_d_post_controller jIDPostC\r
-\r
-#define jinit_input_controller jIInCtlr\r
-\r
-#define jinit_marker_reader jIMReader\r
-\r
-#define jinit_huff_decoder jIHDecoder\r
-\r
-#define jinit_phuff_decoder jIPHDecoder\r
-\r
-#define jinit_inverse_dct jIIDCT\r
-\r
-#define jinit_upsampler jIUpsampler\r
-\r
-#define jinit_color_deconverter jIDColor\r
-\r
-#define jinit_1pass_quantizer jI1Quant\r
-\r
-#define jinit_2pass_quantizer jI2Quant\r
-\r
-#define jinit_merged_upsampler jIMUpsampler\r
-\r
-#define jinit_memory_mgr jIMemMgr\r
-\r
-#define jdiv_round_up jDivRound\r
-\r
-#define jround_up jRound\r
-\r
-#define jcopy_sample_rows jCopySamples\r
-\r
-#define jcopy_block_row jCopyBlocks\r
-\r
-#define jzero_far jZeroFar\r
-\r
-#define jpeg_zigzag_order jZIGTable\r
-\r
-#define jpeg_natural_order jZAGTable\r
-\r
-#endif /* NEED_SHORT_EXTERNAL_NAMES */\r
-\r
-\r
-\r
-\r
-\r
-/* Compression module initialization routines */\r
-\r
-EXTERN void jinit_compress_master JPP((j_compress_ptr cinfo));\r
-\r
-EXTERN void jinit_c_master_control JPP((j_compress_ptr cinfo,\r
-\r
- boolean transcode_only));\r
-\r
-EXTERN void jinit_c_main_controller JPP((j_compress_ptr cinfo,\r
-\r
- boolean need_full_buffer));\r
-\r
-EXTERN void jinit_c_prep_controller JPP((j_compress_ptr cinfo,\r
-\r
- boolean need_full_buffer));\r
-\r
-EXTERN void jinit_c_coef_controller JPP((j_compress_ptr cinfo,\r
-\r
- boolean need_full_buffer));\r
-\r
-EXTERN void jinit_color_converter JPP((j_compress_ptr cinfo));\r
-\r
-EXTERN void jinit_downsampler JPP((j_compress_ptr cinfo));\r
-\r
-EXTERN void jinit_forward_dct JPP((j_compress_ptr cinfo));\r
-\r
-EXTERN void jinit_huff_encoder JPP((j_compress_ptr cinfo));\r
-\r
-EXTERN void jinit_phuff_encoder JPP((j_compress_ptr cinfo));\r
-\r
-EXTERN void jinit_marker_writer JPP((j_compress_ptr cinfo));\r
-\r
-/* Decompression module initialization routines */\r
-\r
-EXTERN void jinit_master_decompress JPP((j_decompress_ptr cinfo));\r
-\r
-EXTERN void jinit_d_main_controller JPP((j_decompress_ptr cinfo,\r
-\r
- boolean need_full_buffer));\r
-\r
-EXTERN void jinit_d_coef_controller JPP((j_decompress_ptr cinfo,\r
-\r
- boolean need_full_buffer));\r
-\r
-EXTERN void jinit_d_post_controller JPP((j_decompress_ptr cinfo,\r
-\r
- boolean need_full_buffer));\r
-\r
-EXTERN void jinit_input_controller JPP((j_decompress_ptr cinfo));\r
-\r
-EXTERN void jinit_marker_reader JPP((j_decompress_ptr cinfo));\r
-\r
-EXTERN void jinit_huff_decoder JPP((j_decompress_ptr cinfo));\r
-\r
-EXTERN void jinit_phuff_decoder JPP((j_decompress_ptr cinfo));\r
-\r
-EXTERN void jinit_inverse_dct JPP((j_decompress_ptr cinfo));\r
-\r
-EXTERN void jinit_upsampler JPP((j_decompress_ptr cinfo));\r
-\r
-EXTERN void jinit_color_deconverter JPP((j_decompress_ptr cinfo));\r
-\r
-EXTERN void jinit_1pass_quantizer JPP((j_decompress_ptr cinfo));\r
-\r
-EXTERN void jinit_2pass_quantizer JPP((j_decompress_ptr cinfo));\r
-\r
-EXTERN void jinit_merged_upsampler JPP((j_decompress_ptr cinfo));\r
-\r
-/* Memory manager initialization */\r
-\r
-EXTERN void jinit_memory_mgr JPP((j_common_ptr cinfo));\r
-\r
-\r
-\r
-/* Utility routines in jutils.c */\r
-\r
-EXTERN long jdiv_round_up JPP((long a, long b));\r
-\r
-EXTERN long jround_up JPP((long a, long b));\r
-\r
-EXTERN void jcopy_sample_rows JPP((JSAMPARRAY input_array, int source_row,\r
-\r
- JSAMPARRAY output_array, int dest_row,\r
-\r
- int num_rows, JDIMENSION num_cols));\r
-\r
-EXTERN void jcopy_block_row JPP((JBLOCKROW input_row, JBLOCKROW output_row,\r
-\r
- JDIMENSION num_blocks));\r
-\r
-EXTERN void jzero_far JPP((void FAR * target, size_t bytestozero));\r
-\r
-/* Constant tables in jutils.c */\r
-\r
-extern const int jpeg_zigzag_order[]; /* natural coef order to zigzag order */\r
-\r
-extern const int jpeg_natural_order[]; /* zigzag coef order to natural order */\r
-\r
-\r
-\r
-/* Suppress undefined-structure complaints if necessary. */\r
-\r
-\r
-\r
-#ifdef INCOMPLETE_TYPES_BROKEN\r
-\r
-#ifndef AM_MEMORY_MANAGER /* only jmemmgr.c defines these */\r
-\r
-struct jvirt_sarray_control { long dummy; };\r
-\r
-struct jvirt_barray_control { long dummy; };\r
-\r
-#endif\r
-\r
-#endif /* INCOMPLETE_TYPES_BROKEN */\r
-\r
+/*
+
+ * jpegint.h
+
+ *
+
+ * Copyright (C) 1991-1995, Thomas G. Lane.
+
+ * This file is part of the Independent JPEG Group's software.
+
+ * For conditions of distribution and use, see the accompanying README file.
+
+ *
+
+ * This file provides common declarations for the various JPEG modules.
+
+ * These declarations are considered internal to the JPEG library; most
+
+ * applications using the library shouldn't need to include this file.
+
+ */
+
+
+
+
+
+/* Declarations for both compression & decompression */
+
+
+
+typedef enum { /* Operating modes for buffer controllers */
+
+ JBUF_PASS_THRU, /* Plain stripwise operation */
+
+ /* Remaining modes require a full-image buffer to have been created */
+
+ JBUF_SAVE_SOURCE, /* Run source subobject only, save output */
+
+ JBUF_CRANK_DEST, /* Run dest subobject only, using saved data */
+
+ JBUF_SAVE_AND_PASS /* Run both subobjects, save output */
+
+} J_BUF_MODE;
+
+
+
+/* Values of global_state field (jdapi.c has some dependencies on ordering!) */
+
+#define CSTATE_START 100 /* after create_compress */
+
+#define CSTATE_SCANNING 101 /* start_compress done, write_scanlines OK */
+
+#define CSTATE_RAW_OK 102 /* start_compress done, write_raw_data OK */
+
+#define CSTATE_WRCOEFS 103 /* jpeg_write_coefficients done */
+
+#define DSTATE_START 200 /* after create_decompress */
+
+#define DSTATE_INHEADER 201 /* reading header markers, no SOS yet */
+
+#define DSTATE_READY 202 /* found SOS, ready for start_decompress */
+
+#define DSTATE_PRELOAD 203 /* reading multiscan file in start_decompress*/
+
+#define DSTATE_PRESCAN 204 /* performing dummy pass for 2-pass quant */
+
+#define DSTATE_SCANNING 205 /* start_decompress done, read_scanlines OK */
+
+#define DSTATE_RAW_OK 206 /* start_decompress done, read_raw_data OK */
+
+#define DSTATE_BUFIMAGE 207 /* expecting jpeg_start_output */
+
+#define DSTATE_BUFPOST 208 /* looking for SOS/EOI in jpeg_finish_output */
+
+#define DSTATE_RDCOEFS 209 /* reading file in jpeg_read_coefficients */
+
+#define DSTATE_STOPPING 210 /* looking for EOI in jpeg_finish_decompress */
+
+
+
+
+
+/* Declarations for compression modules */
+
+
+
+/* Master control module */
+
+struct jpeg_comp_master {
+
+ JMETHOD(void, prepare_for_pass, (j_compress_ptr cinfo));
+
+ JMETHOD(void, pass_startup, (j_compress_ptr cinfo));
+
+ JMETHOD(void, finish_pass, (j_compress_ptr cinfo));
+
+
+
+ /* State variables made visible to other modules */
+
+ boolean call_pass_startup; /* True if pass_startup must be called */
+
+ boolean is_last_pass; /* True during last pass */
+
+};
+
+
+
+/* Main buffer control (downsampled-data buffer) */
+
+struct jpeg_c_main_controller {
+
+ JMETHOD(void, start_pass, (j_compress_ptr cinfo, J_BUF_MODE pass_mode));
+
+ JMETHOD(void, process_data, (j_compress_ptr cinfo,
+
+ JSAMPARRAY input_buf, JDIMENSION *in_row_ctr,
+
+ JDIMENSION in_rows_avail));
+
+};
+
+
+
+/* Compression preprocessing (downsampling input buffer control) */
+
+struct jpeg_c_prep_controller {
+
+ JMETHOD(void, start_pass, (j_compress_ptr cinfo, J_BUF_MODE pass_mode));
+
+ JMETHOD(void, 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));
+
+};
+
+
+
+/* Coefficient buffer control */
+
+struct jpeg_c_coef_controller {
+
+ JMETHOD(void, start_pass, (j_compress_ptr cinfo, J_BUF_MODE pass_mode));
+
+ JMETHOD(boolean, compress_data, (j_compress_ptr cinfo,
+
+ JSAMPIMAGE input_buf));
+
+};
+
+
+
+/* Colorspace conversion */
+
+struct jpeg_color_converter {
+
+ JMETHOD(void, start_pass, (j_compress_ptr cinfo));
+
+ JMETHOD(void, color_convert, (j_compress_ptr cinfo,
+
+ JSAMPARRAY input_buf, JSAMPIMAGE output_buf,
+
+ JDIMENSION output_row, int num_rows));
+
+};
+
+
+
+/* Downsampling */
+
+struct jpeg_downsampler {
+
+ JMETHOD(void, start_pass, (j_compress_ptr cinfo));
+
+ JMETHOD(void, downsample, (j_compress_ptr cinfo,
+
+ JSAMPIMAGE input_buf, JDIMENSION in_row_index,
+
+ JSAMPIMAGE output_buf,
+
+ JDIMENSION out_row_group_index));
+
+
+
+ boolean need_context_rows; /* TRUE if need rows above & below */
+
+};
+
+
+
+/* Forward DCT (also controls coefficient quantization) */
+
+struct jpeg_forward_dct {
+
+ JMETHOD(void, start_pass, (j_compress_ptr cinfo));
+
+ /* perhaps this should be an array??? */
+
+ JMETHOD(void, 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));
+
+};
+
+
+
+/* Entropy encoding */
+
+struct jpeg_entropy_encoder {
+
+ JMETHOD(void, start_pass, (j_compress_ptr cinfo, boolean gather_statistics));
+
+ JMETHOD(boolean, encode_mcu, (j_compress_ptr cinfo, JBLOCKROW *MCU_data));
+
+ JMETHOD(void, finish_pass, (j_compress_ptr cinfo));
+
+};
+
+
+
+/* Marker writing */
+
+struct jpeg_marker_writer {
+
+ /* write_any_marker is exported for use by applications */
+
+ /* Probably only COM and APPn markers should be written */
+
+ JMETHOD(void, write_any_marker, (j_compress_ptr cinfo, int marker,
+
+ const JOCTET *dataptr, unsigned int datalen));
+
+ JMETHOD(void, write_file_header, (j_compress_ptr cinfo));
+
+ JMETHOD(void, write_frame_header, (j_compress_ptr cinfo));
+
+ JMETHOD(void, write_scan_header, (j_compress_ptr cinfo));
+
+ JMETHOD(void, write_file_trailer, (j_compress_ptr cinfo));
+
+ JMETHOD(void, write_tables_only, (j_compress_ptr cinfo));
+
+};
+
+
+
+
+
+/* Declarations for decompression modules */
+
+
+
+/* Master control module */
+
+struct jpeg_decomp_master {
+
+ JMETHOD(void, prepare_for_output_pass, (j_decompress_ptr cinfo));
+
+ JMETHOD(void, finish_output_pass, (j_decompress_ptr cinfo));
+
+
+
+ /* State variables made visible to other modules */
+
+ boolean is_dummy_pass; /* True during 1st pass for 2-pass quant */
+
+};
+
+
+
+/* Input control module */
+
+struct jpeg_input_controller {
+
+ JMETHOD(int, consume_input, (j_decompress_ptr cinfo));
+
+ JMETHOD(void, reset_input_controller, (j_decompress_ptr cinfo));
+
+ JMETHOD(void, start_input_pass, (j_decompress_ptr cinfo));
+
+ JMETHOD(void, finish_input_pass, (j_decompress_ptr cinfo));
+
+
+
+ /* State variables made visible to other modules */
+
+ boolean has_multiple_scans; /* True if file has multiple scans */
+
+ boolean eoi_reached; /* True when EOI has been consumed */
+
+};
+
+
+
+/* Main buffer control (downsampled-data buffer) */
+
+struct jpeg_d_main_controller {
+
+ JMETHOD(void, start_pass, (j_decompress_ptr cinfo, J_BUF_MODE pass_mode));
+
+ JMETHOD(void, process_data, (j_decompress_ptr cinfo,
+
+ JSAMPARRAY output_buf, JDIMENSION *out_row_ctr,
+
+ JDIMENSION out_rows_avail));
+
+};
+
+
+
+/* Coefficient buffer control */
+
+struct jpeg_d_coef_controller {
+
+ JMETHOD(void, start_input_pass, (j_decompress_ptr cinfo));
+
+ JMETHOD(int, consume_data, (j_decompress_ptr cinfo));
+
+ JMETHOD(void, start_output_pass, (j_decompress_ptr cinfo));
+
+ JMETHOD(int, decompress_data, (j_decompress_ptr cinfo,
+
+ JSAMPIMAGE output_buf));
+
+ /* Pointer to array of coefficient virtual arrays, or NULL if none */
+
+ jvirt_barray_ptr *coef_arrays;
+
+};
+
+
+
+/* Decompression postprocessing (color quantization buffer control) */
+
+struct jpeg_d_post_controller {
+
+ JMETHOD(void, start_pass, (j_decompress_ptr cinfo, J_BUF_MODE pass_mode));
+
+ JMETHOD(void, post_process_data, (j_decompress_ptr cinfo,
+
+ JSAMPIMAGE input_buf,
+
+ JDIMENSION *in_row_group_ctr,
+
+ JDIMENSION in_row_groups_avail,
+
+ JSAMPARRAY output_buf,
+
+ JDIMENSION *out_row_ctr,
+
+ JDIMENSION out_rows_avail));
+
+};
+
+
+
+/* Marker reading & parsing */
+
+struct jpeg_marker_reader {
+
+ JMETHOD(void, reset_marker_reader, (j_decompress_ptr cinfo));
+
+ /* Read markers until SOS or EOI.
+
+ * Returns same codes as are defined for jpeg_consume_input:
+
+ * JPEG_SUSPENDED, JPEG_REACHED_SOS, or JPEG_REACHED_EOI.
+
+ */
+
+ JMETHOD(int, read_markers, (j_decompress_ptr cinfo));
+
+ /* Read a restart marker --- exported for use by entropy decoder only */
+
+ jpeg_marker_parser_method read_restart_marker;
+
+ /* Application-overridable marker processing methods */
+
+ jpeg_marker_parser_method process_COM;
+
+ jpeg_marker_parser_method process_APPn[16];
+
+
+
+ /* State of marker reader --- nominally internal, but applications
+
+ * supplying COM or APPn handlers might like to know the state.
+
+ */
+
+ boolean saw_SOI; /* found SOI? */
+
+ boolean saw_SOF; /* found SOF? */
+
+ int next_restart_num; /* next restart number expected (0-7) */
+
+ unsigned int discarded_bytes; /* # of bytes skipped looking for a marker */
+
+};
+
+
+
+/* Entropy decoding */
+
+struct jpeg_entropy_decoder {
+
+ JMETHOD(void, start_pass, (j_decompress_ptr cinfo));
+
+ JMETHOD(boolean, decode_mcu, (j_decompress_ptr cinfo,
+
+ JBLOCKROW *MCU_data));
+
+};
+
+
+
+/* Inverse DCT (also performs dequantization) */
+
+typedef JMETHOD(void, inverse_DCT_method_ptr,
+
+ (j_decompress_ptr cinfo, jpeg_component_info * compptr,
+
+ JCOEFPTR coef_block,
+
+ JSAMPARRAY output_buf, JDIMENSION output_col));
+
+
+
+struct jpeg_inverse_dct {
+
+ JMETHOD(void, start_pass, (j_decompress_ptr cinfo));
+
+ /* It is useful to allow each component to have a separate IDCT method. */
+
+ inverse_DCT_method_ptr inverse_DCT[MAX_COMPONENTS];
+
+};
+
+
+
+/* Upsampling (note that upsampler must also call color converter) */
+
+struct jpeg_upsampler {
+
+ JMETHOD(void, start_pass, (j_decompress_ptr cinfo));
+
+ JMETHOD(void, upsample, (j_decompress_ptr cinfo,
+
+ JSAMPIMAGE input_buf,
+
+ JDIMENSION *in_row_group_ctr,
+
+ JDIMENSION in_row_groups_avail,
+
+ JSAMPARRAY output_buf,
+
+ JDIMENSION *out_row_ctr,
+
+ JDIMENSION out_rows_avail));
+
+
+
+ boolean need_context_rows; /* TRUE if need rows above & below */
+
+};
+
+
+
+/* Colorspace conversion */
+
+struct jpeg_color_deconverter {
+
+ JMETHOD(void, start_pass, (j_decompress_ptr cinfo));
+
+ JMETHOD(void, color_convert, (j_decompress_ptr cinfo,
+
+ JSAMPIMAGE input_buf, JDIMENSION input_row,
+
+ JSAMPARRAY output_buf, int num_rows));
+
+};
+
+
+
+/* Color quantization or color precision reduction */
+
+struct jpeg_color_quantizer {
+
+ JMETHOD(void, start_pass, (j_decompress_ptr cinfo, boolean is_pre_scan));
+
+ JMETHOD(void, color_quantize, (j_decompress_ptr cinfo,
+
+ JSAMPARRAY input_buf, JSAMPARRAY output_buf,
+
+ int num_rows));
+
+ JMETHOD(void, finish_pass, (j_decompress_ptr cinfo));
+
+ JMETHOD(void, new_color_map, (j_decompress_ptr cinfo));
+
+};
+
+
+
+
+
+/* Miscellaneous useful macros */
+
+
+
+#undef MAX
+
+#define MAX(a,b) ((a) > (b) ? (a) : (b))
+
+#undef MIN
+
+#define MIN(a,b) ((a) < (b) ? (a) : (b))
+
+
+
+
+
+/* We assume that right shift corresponds to signed division by 2 with
+
+ * rounding towards minus infinity. This is correct for typical "arithmetic
+
+ * shift" instructions that shift in copies of the sign bit. But some
+
+ * C compilers implement >> with an unsigned shift. For these machines you
+
+ * must define RIGHT_SHIFT_IS_UNSIGNED.
+
+ * RIGHT_SHIFT provides a proper signed right shift of an INT32 quantity.
+
+ * It is only applied with constant shift counts. SHIFT_TEMPS must be
+
+ * included in the variables of any routine using RIGHT_SHIFT.
+
+ */
+
+
+
+#ifdef RIGHT_SHIFT_IS_UNSIGNED
+
+#define SHIFT_TEMPS INT32 shift_temp;
+
+#define RIGHT_SHIFT(x,shft) \
+
+ ((shift_temp = (x)) < 0 ? \
+
+ (shift_temp >> (shft)) | ((~((INT32) 0)) << (32-(shft))) : \
+
+ (shift_temp >> (shft)))
+
+#else
+
+#define SHIFT_TEMPS
+
+#define RIGHT_SHIFT(x,shft) ((x) >> (shft))
+
+#endif
+
+
+
+
+
+/* Short forms of external names for systems with brain-damaged linkers. */
+
+
+
+#ifdef NEED_SHORT_EXTERNAL_NAMES
+
+#define jinit_compress_master jICompress
+
+#define jinit_c_master_control jICMaster
+
+#define jinit_c_main_controller jICMainC
+
+#define jinit_c_prep_controller jICPrepC
+
+#define jinit_c_coef_controller jICCoefC
+
+#define jinit_color_converter jICColor
+
+#define jinit_downsampler jIDownsampler
+
+#define jinit_forward_dct jIFDCT
+
+#define jinit_huff_encoder jIHEncoder
+
+#define jinit_phuff_encoder jIPHEncoder
+
+#define jinit_marker_writer jIMWriter
+
+#define jinit_master_decompress jIDMaster
+
+#define jinit_d_main_controller jIDMainC
+
+#define jinit_d_coef_controller jIDCoefC
+
+#define jinit_d_post_controller jIDPostC
+
+#define jinit_input_controller jIInCtlr
+
+#define jinit_marker_reader jIMReader
+
+#define jinit_huff_decoder jIHDecoder
+
+#define jinit_phuff_decoder jIPHDecoder
+
+#define jinit_inverse_dct jIIDCT
+
+#define jinit_upsampler jIUpsampler
+
+#define jinit_color_deconverter jIDColor
+
+#define jinit_1pass_quantizer jI1Quant
+
+#define jinit_2pass_quantizer jI2Quant
+
+#define jinit_merged_upsampler jIMUpsampler
+
+#define jinit_memory_mgr jIMemMgr
+
+#define jdiv_round_up jDivRound
+
+#define jround_up jRound
+
+#define jcopy_sample_rows jCopySamples
+
+#define jcopy_block_row jCopyBlocks
+
+#define jzero_far jZeroFar
+
+#define jpeg_zigzag_order jZIGTable
+
+#define jpeg_natural_order jZAGTable
+
+#endif /* NEED_SHORT_EXTERNAL_NAMES */
+
+
+
+
+
+/* Compression module initialization routines */
+
+EXTERN void jinit_compress_master JPP((j_compress_ptr cinfo));
+
+EXTERN void jinit_c_master_control JPP((j_compress_ptr cinfo,
+
+ boolean transcode_only));
+
+EXTERN void jinit_c_main_controller JPP((j_compress_ptr cinfo,
+
+ boolean need_full_buffer));
+
+EXTERN void jinit_c_prep_controller JPP((j_compress_ptr cinfo,
+
+ boolean need_full_buffer));
+
+EXTERN void jinit_c_coef_controller JPP((j_compress_ptr cinfo,
+
+ boolean need_full_buffer));
+
+EXTERN void jinit_color_converter JPP((j_compress_ptr cinfo));
+
+EXTERN void jinit_downsampler JPP((j_compress_ptr cinfo));
+
+EXTERN void jinit_forward_dct JPP((j_compress_ptr cinfo));
+
+EXTERN void jinit_huff_encoder JPP((j_compress_ptr cinfo));
+
+EXTERN void jinit_phuff_encoder JPP((j_compress_ptr cinfo));
+
+EXTERN void jinit_marker_writer JPP((j_compress_ptr cinfo));
+
+/* Decompression module initialization routines */
+
+EXTERN void jinit_master_decompress JPP((j_decompress_ptr cinfo));
+
+EXTERN void jinit_d_main_controller JPP((j_decompress_ptr cinfo,
+
+ boolean need_full_buffer));
+
+EXTERN void jinit_d_coef_controller JPP((j_decompress_ptr cinfo,
+
+ boolean need_full_buffer));
+
+EXTERN void jinit_d_post_controller JPP((j_decompress_ptr cinfo,
+
+ boolean need_full_buffer));
+
+EXTERN void jinit_input_controller JPP((j_decompress_ptr cinfo));
+
+EXTERN void jinit_marker_reader JPP((j_decompress_ptr cinfo));
+
+EXTERN void jinit_huff_decoder JPP((j_decompress_ptr cinfo));
+
+EXTERN void jinit_phuff_decoder JPP((j_decompress_ptr cinfo));
+
+EXTERN void jinit_inverse_dct JPP((j_decompress_ptr cinfo));
+
+EXTERN void jinit_upsampler JPP((j_decompress_ptr cinfo));
+
+EXTERN void jinit_color_deconverter JPP((j_decompress_ptr cinfo));
+
+EXTERN void jinit_1pass_quantizer JPP((j_decompress_ptr cinfo));
+
+EXTERN void jinit_2pass_quantizer JPP((j_decompress_ptr cinfo));
+
+EXTERN void jinit_merged_upsampler JPP((j_decompress_ptr cinfo));
+
+/* Memory manager initialization */
+
+EXTERN void jinit_memory_mgr JPP((j_common_ptr cinfo));
+
+
+
+/* Utility routines in jutils.c */
+
+EXTERN long jdiv_round_up JPP((long a, long b));
+
+EXTERN long jround_up JPP((long a, long b));
+
+EXTERN void jcopy_sample_rows JPP((JSAMPARRAY input_array, int source_row,
+
+ JSAMPARRAY output_array, int dest_row,
+
+ int num_rows, JDIMENSION num_cols));
+
+EXTERN void jcopy_block_row JPP((JBLOCKROW input_row, JBLOCKROW output_row,
+
+ JDIMENSION num_blocks));
+
+EXTERN void jzero_far JPP((void FAR * target, size_t bytestozero));
+
+/* Constant tables in jutils.c */
+
+extern const int jpeg_zigzag_order[]; /* natural coef order to zigzag order */
+
+extern const int jpeg_natural_order[]; /* zigzag coef order to natural order */
+
+
+
+/* Suppress undefined-structure complaints if necessary. */
+
+
+
+#ifdef INCOMPLETE_TYPES_BROKEN
+
+#ifndef AM_MEMORY_MANAGER /* only jmemmgr.c defines these */
+
+struct jvirt_sarray_control { long dummy; };
+
+struct jvirt_barray_control { long dummy; };
+
+#endif
+
+#endif /* INCOMPLETE_TYPES_BROKEN */
+