cdjpeg.h

   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  * libjpeg-turbo Modifications:
   7  * Copyright (C) 2017, D. R. Commander.
   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
  27 typedef struct cjpeg_source_struct *cjpeg_source_ptr;
  28
  29 struct 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
  45 typedef struct djpeg_dest_struct *djpeg_dest_ptr;
  46
  47 struct 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   /* Re-calculate buffer dimensions based on output dimensions (for use with
  58      partial image decompression.)  If this is NULL, then the output format
  59      does not support partial image decompression (BMP and RLE, in particular,
  60      cannot support partial decompression because they use an inversion buffer
  61      to write the image in bottom-up order.) */
  62   void (*calc_buffer_dimensions) (j_decompress_ptr cinfo,
  63                                   djpeg_dest_ptr dinfo);
  64
  65
  66   /* Target file spec; filled in by djpeg.c after object is created. */
  67   FILE *output_file;
  68
  69   /* Output pixel-row buffer.  Created by module init or start_output.
  70    * Width is cinfo->output_width * cinfo->output_components;
  71    * height is buffer_height.
  72    */
  73   JSAMPARRAY buffer;
  74   JDIMENSION buffer_height;
  75 };
  76
  77
  78 /*
  79  * cjpeg/djpeg may need to perform extra passes to convert to or from
  80  * the source/destination file format.  The JPEG library does not know
  81  * about these passes, but we'd like them to be counted by the progress
  82  * monitor.  We use an expanded progress monitor object to hold the
  83  * additional pass count.
  84  */
  85
  86 struct cdjpeg_progress_mgr {
  87   struct jpeg_progress_mgr pub; /* fields known to JPEG library */
  88   int completed_extra_passes;   /* extra passes completed */
  89   int total_extra_passes;       /* total extra */
  90   /* last printed percentage stored here to avoid multiple printouts */
  91   int percent_done;
  92 };
  93
  94 typedef struct cdjpeg_progress_mgr *cd_progress_ptr;
  95
  96
  97 /* Module selection routines for I/O modules. */
  98
  99 EXTERN(cjpeg_source_ptr) jinit_read_bmp (j_compress_ptr cinfo);
 100 EXTERN(djpeg_dest_ptr) jinit_write_bmp (j_decompress_ptr cinfo,
 101                                         boolean is_os2);
 102 EXTERN(cjpeg_source_ptr) jinit_read_gif (j_compress_ptr cinfo);
 103 EXTERN(djpeg_dest_ptr) jinit_write_gif (j_decompress_ptr cinfo);
 104 EXTERN(cjpeg_source_ptr) jinit_read_ppm (j_compress_ptr cinfo);
 105 EXTERN(djpeg_dest_ptr) jinit_write_ppm (j_decompress_ptr cinfo);
 106 EXTERN(cjpeg_source_ptr) jinit_read_rle (j_compress_ptr cinfo);
 107 EXTERN(djpeg_dest_ptr) jinit_write_rle (j_decompress_ptr cinfo);
 108 EXTERN(cjpeg_source_ptr) jinit_read_targa (j_compress_ptr cinfo);
 109 EXTERN(djpeg_dest_ptr) jinit_write_targa (j_decompress_ptr cinfo);
 110
 111 /* cjpeg support routines (in rdswitch.c) */
 112
 113 EXTERN(boolean) read_quant_tables (j_compress_ptr cinfo, char *filename,
 114                                    boolean force_baseline);
 115 EXTERN(boolean) read_scan_script (j_compress_ptr cinfo, char *filename);
 116 EXTERN(boolean) set_quality_ratings (j_compress_ptr cinfo, char *arg,
 117                                      boolean force_baseline);
 118 EXTERN(boolean) set_quant_slots (j_compress_ptr cinfo, char *arg);
 119 EXTERN(boolean) set_sample_factors (j_compress_ptr cinfo, char *arg);
 120
 121 /* djpeg support routines (in rdcolmap.c) */
 122
 123 EXTERN(void) read_color_map (j_decompress_ptr cinfo, FILE *infile);
 124
 125 /* common support routines (in cdjpeg.c) */
 126
 127 EXTERN(void) enable_signal_catcher (j_common_ptr cinfo);
 128 EXTERN(void) start_progress_monitor (j_common_ptr cinfo,
 129                                      cd_progress_ptr progress);
 130 EXTERN(void) end_progress_monitor (j_common_ptr cinfo);
 131 EXTERN(boolean) keymatch (char *arg, const char *keyword, int minchars);
 132 EXTERN(FILE *) read_stdin (void);
 133 EXTERN(FILE *) write_stdout (void);
 134
 135 /* miscellaneous useful macros */
 136
 137 #ifdef DONT_USE_B_MODE          /* define mode parameters for fopen() */
 138 #define READ_BINARY     "r"
 139 #define WRITE_BINARY    "w"
 140 #else
 141 #define READ_BINARY     "rb"
 142 #define WRITE_BINARY    "wb"
 143 #endif
 144
 145 #ifndef EXIT_FAILURE            /* define exit() codes if not provided */
 146 #define EXIT_FAILURE  1
 147 #endif
 148 #ifndef EXIT_SUCCESS
 149 #define EXIT_SUCCESS  0
 150 #endif
 151 #ifndef EXIT_WARNING
 152 #define EXIT_WARNING  2
 153 #endif