1/*
2 * cdjpeg.h
3 *
4 * This file was part of the Independent JPEG Group's software:
5 * Copyright (C) 1994-1997, Thomas G. Lane.
6 * It was modified by The libjpeg-turbo Project to include only code relevant
7 * to libjpeg-turbo.
8 * For conditions of distribution and use, see the accompanying README.ijg
9 * file.
10 *
11 * This file contains common declarations for the sample applications
12 * cjpeg and djpeg.  It is NOT used by the core JPEG library.
13 */
14
15#define JPEG_CJPEG_DJPEG        /* define proper options in jconfig.h */
16#define JPEG_INTERNAL_OPTIONS   /* cjpeg.c,djpeg.c need to see xxx_SUPPORTED */
17#include "jinclude.h"
18#include "jpeglib.h"
19#include "jerror.h"             /* get library error codes too */
20#include "cderror.h"            /* get application-specific error codes */
21
22
23/*
24 * Object interface for cjpeg's source file decoding modules
25 */
26
27typedef struct cjpeg_source_struct *cjpeg_source_ptr;
28
29struct cjpeg_source_struct {
30  void (*start_input) (j_compress_ptr cinfo, cjpeg_source_ptr sinfo);
31  JDIMENSION (*get_pixel_rows) (j_compress_ptr cinfo, cjpeg_source_ptr sinfo);
32  void (*finish_input) (j_compress_ptr cinfo, cjpeg_source_ptr sinfo);
33
34  FILE *input_file;
35
36  JSAMPARRAY buffer;
37  JDIMENSION buffer_height;
38};
39
40
41/*
42 * Object interface for djpeg's output file encoding modules
43 */
44
45typedef struct djpeg_dest_struct *djpeg_dest_ptr;
46
47struct djpeg_dest_struct {
48  /* start_output is called after jpeg_start_decompress finishes.
49   * The color map will be ready at this time, if one is needed.
50   */
51  void (*start_output) (j_decompress_ptr cinfo, djpeg_dest_ptr dinfo);
52  /* Emit the specified number of pixel rows from the buffer. */
53  void (*put_pixel_rows) (j_decompress_ptr cinfo, djpeg_dest_ptr dinfo,
54                          JDIMENSION rows_supplied);
55  /* Finish up at the end of the image. */
56  void (*finish_output) (j_decompress_ptr cinfo, djpeg_dest_ptr dinfo);
57
58  /* Target file spec; filled in by djpeg.c after object is created. */
59  FILE *output_file;
60
61  /* Output pixel-row buffer.  Created by module init or start_output.
62   * Width is cinfo->output_width * cinfo->output_components;
63   * height is buffer_height.
64   */
65  JSAMPARRAY buffer;
66  JDIMENSION buffer_height;
67};
68
69
70/*
71 * cjpeg/djpeg may need to perform extra passes to convert to or from
72 * the source/destination file format.  The JPEG library does not know
73 * about these passes, but we'd like them to be counted by the progress
74 * monitor.  We use an expanded progress monitor object to hold the
75 * additional pass count.
76 */
77
78struct cdjpeg_progress_mgr {
79  struct jpeg_progress_mgr pub; /* fields known to JPEG library */
80  int completed_extra_passes;   /* extra passes completed */
81  int total_extra_passes;       /* total extra */
82  /* last printed percentage stored here to avoid multiple printouts */
83  int percent_done;
84};
85
86typedef struct cdjpeg_progress_mgr *cd_progress_ptr;
87
88
89/* Module selection routines for I/O modules. */
90
91EXTERN(cjpeg_source_ptr) jinit_read_bmp (j_compress_ptr cinfo);
92EXTERN(djpeg_dest_ptr) jinit_write_bmp (j_decompress_ptr cinfo,
93                                        boolean is_os2);
94EXTERN(cjpeg_source_ptr) jinit_read_gif (j_compress_ptr cinfo);
95EXTERN(djpeg_dest_ptr) jinit_write_gif (j_decompress_ptr cinfo);
96EXTERN(cjpeg_source_ptr) jinit_read_ppm (j_compress_ptr cinfo);
97EXTERN(djpeg_dest_ptr) jinit_write_ppm (j_decompress_ptr cinfo);
98EXTERN(cjpeg_source_ptr) jinit_read_rle (j_compress_ptr cinfo);
99EXTERN(djpeg_dest_ptr) jinit_write_rle (j_decompress_ptr cinfo);
100EXTERN(cjpeg_source_ptr) jinit_read_targa (j_compress_ptr cinfo);
101EXTERN(djpeg_dest_ptr) jinit_write_targa (j_decompress_ptr cinfo);
102
103/* cjpeg support routines (in rdswitch.c) */
104
105EXTERN(boolean) read_quant_tables (j_compress_ptr cinfo, char *filename,
106                                   boolean force_baseline);
107EXTERN(boolean) read_scan_script (j_compress_ptr cinfo, char *filename);
108EXTERN(boolean) set_quality_ratings (j_compress_ptr cinfo, char *arg,
109                                     boolean force_baseline);
110EXTERN(boolean) set_quant_slots (j_compress_ptr cinfo, char *arg);
111EXTERN(boolean) set_sample_factors (j_compress_ptr cinfo, char *arg);
112
113/* djpeg support routines (in rdcolmap.c) */
114
115EXTERN(void) read_color_map (j_decompress_ptr cinfo, FILE *infile);
116
117/* common support routines (in cdjpeg.c) */
118
119EXTERN(void) enable_signal_catcher (j_common_ptr cinfo);
120EXTERN(void) start_progress_monitor (j_common_ptr cinfo,
121                                     cd_progress_ptr progress);
122EXTERN(void) end_progress_monitor (j_common_ptr cinfo);
123EXTERN(boolean) keymatch (char *arg, const char *keyword, int minchars);
124EXTERN(FILE *) read_stdin (void);
125EXTERN(FILE *) write_stdout (void);
126
127/* miscellaneous useful macros */
128
129#ifdef DONT_USE_B_MODE          /* define mode parameters for fopen() */
130#define READ_BINARY     "r"
131#define WRITE_BINARY    "w"
132#else
133#define READ_BINARY     "rb"
134#define WRITE_BINARY    "wb"
135#endif
136
137#ifndef EXIT_FAILURE            /* define exit() codes if not provided */
138#define EXIT_FAILURE  1
139#endif
140#ifndef EXIT_SUCCESS
141#define EXIT_SUCCESS  0
142#endif
143#ifndef EXIT_WARNING
144#define EXIT_WARNING  2
145#endif
146