1IJG JPEG LIBRARY: FILE LIST 2 3Copyright (C) 1994-1998, Thomas G. Lane. 4This file is part of the Independent JPEG Group's software. 5For conditions of distribution and use, see the accompanying README file. 6 7 8Here is a road map to the files in the IJG JPEG distribution. The 9distribution includes the JPEG library proper, plus two application 10programs ("cjpeg" and "djpeg") which use the library to convert JPEG 11files to and from some other popular image formats. A third application 12"jpegtran" uses the library to do lossless conversion between different 13variants of JPEG. There are also two stand-alone applications, 14"rdjpgcom" and "wrjpgcom". 15 16 17THE JPEG LIBRARY 18================ 19 20Include files: 21 22jpeglib.h JPEG library's exported data and function declarations. 23jconfig.h Configuration declarations. Note: this file is not present 24 in the distribution; it is generated during installation. 25jmorecfg.h Additional configuration declarations; need not be changed 26 for a standard installation. 27jerror.h Declares JPEG library's error and trace message codes. 28jinclude.h Central include file used by all IJG .c files to reference 29 system include files. 30jpegint.h JPEG library's internal data structures. 31jchuff.h Private declarations for Huffman encoder modules. 32jdhuff.h Private declarations for Huffman decoder modules. 33jdct.h Private declarations for forward & reverse DCT subsystems. 34jmemsys.h Private declarations for memory management subsystem. 35jversion.h Version information. 36 37Applications using the library should include jpeglib.h (which in turn 38includes jconfig.h and jmorecfg.h). Optionally, jerror.h may be included 39if the application needs to reference individual JPEG error codes. The 40other include files are intended for internal use and would not normally 41be included by an application program. (cjpeg/djpeg/etc do use jinclude.h, 42since its function is to improve portability of the whole IJG distribution. 43Most other applications will directly include the system include files they 44want, and hence won't need jinclude.h.) 45 46 47C source code files: 48 49These files contain most of the functions intended to be called directly by 50an application program: 51 52jcapimin.c Application program interface: core routines for compression. 53jcapistd.c Application program interface: standard compression. 54jdapimin.c Application program interface: core routines for decompression. 55jdapistd.c Application program interface: standard decompression. 56jcomapi.c Application program interface routines common to compression 57 and decompression. 58jcparam.c Compression parameter setting helper routines. 59jctrans.c API and library routines for transcoding compression. 60jdtrans.c API and library routines for transcoding decompression. 61 62Compression side of the library: 63 64jcinit.c Initialization: determines which other modules to use. 65jcmaster.c Master control: setup and inter-pass sequencing logic. 66jcmainct.c Main buffer controller (preprocessor => JPEG compressor). 67jcprepct.c Preprocessor buffer controller. 68jccoefct.c Buffer controller for DCT coefficient buffer. 69jccolor.c Color space conversion. 70jcsample.c Downsampling. 71jcdctmgr.c DCT manager (DCT implementation selection & control). 72jfdctint.c Forward DCT using slow-but-accurate integer method. 73jfdctfst.c Forward DCT using faster, less accurate integer method. 74jfdctflt.c Forward DCT using floating-point arithmetic. 75jchuff.c Huffman entropy coding for sequential JPEG. 76jcphuff.c Huffman entropy coding for progressive JPEG. 77jcmarker.c JPEG marker writing. 78jdatadst.c Data destination manager for stdio output. 79 80Decompression side of the library: 81 82jdmaster.c Master control: determines which other modules to use. 83jdinput.c Input controller: controls input processing modules. 84jdmainct.c Main buffer controller (JPEG decompressor => postprocessor). 85jdcoefct.c Buffer controller for DCT coefficient buffer. 86jdpostct.c Postprocessor buffer controller. 87jdmarker.c JPEG marker reading. 88jdhuff.c Huffman entropy decoding for sequential JPEG. 89jdphuff.c Huffman entropy decoding for progressive JPEG. 90jddctmgr.c IDCT manager (IDCT implementation selection & control). 91jidctint.c Inverse DCT using slow-but-accurate integer method. 92jidctfst.c Inverse DCT using faster, less accurate integer method. 93jidctflt.c Inverse DCT using floating-point arithmetic. 94jidctred.c Inverse DCTs with reduced-size outputs. 95jdsample.c Upsampling. 96jdcolor.c Color space conversion. 97jdmerge.c Merged upsampling/color conversion (faster, lower quality). 98jquant1.c One-pass color quantization using a fixed-spacing colormap. 99jquant2.c Two-pass color quantization using a custom-generated colormap. 100 Also handles one-pass quantization to an externally given map. 101jdatasrc.c Data source manager for stdio input. 102 103Support files for both compression and decompression: 104 105jerror.c Standard error handling routines (application replaceable). 106jmemmgr.c System-independent (more or less) memory management code. 107jutils.c Miscellaneous utility routines. 108 109jmemmgr.c relies on a system-dependent memory management module. The IJG 110distribution includes the following implementations of the system-dependent 111module: 112 113jmemnobs.c "No backing store": assumes adequate virtual memory exists. 114jmemansi.c Makes temporary files with ANSI-standard routine tmpfile(). 115jmemname.c Makes temporary files with program-generated file names. 116jmemdos.c Custom implementation for MS-DOS (16-bit environment only): 117 can use extended and expanded memory as well as temp files. 118jmemmac.c Custom implementation for Apple Macintosh. 119 120Exactly one of the system-dependent modules should be configured into an 121installed JPEG library (see install.doc for hints about which one to use). 122On unusual systems you may find it worthwhile to make a special 123system-dependent memory manager. 124 125 126Non-C source code files: 127 128jmemdosa.asm 80x86 assembly code support for jmemdos.c; used only in 129 MS-DOS-specific configurations of the JPEG library. 130 131 132CJPEG/DJPEG/JPEGTRAN 133==================== 134 135Include files: 136 137cdjpeg.h Declarations shared by cjpeg/djpeg/jpegtran modules. 138cderror.h Additional error and trace message codes for cjpeg et al. 139transupp.h Declarations for jpegtran support routines in transupp.c. 140 141C source code files: 142 143cjpeg.c Main program for cjpeg. 144djpeg.c Main program for djpeg. 145jpegtran.c Main program for jpegtran. 146cdjpeg.c Utility routines used by all three programs. 147rdcolmap.c Code to read a colormap file for djpeg's "-map" switch. 148rdswitch.c Code to process some of cjpeg's more complex switches. 149 Also used by jpegtran. 150transupp.c Support code for jpegtran: lossless image manipulations. 151 152Image file reader modules for cjpeg: 153 154rdbmp.c BMP file input. 155rdgif.c GIF file input (now just a stub). 156rdppm.c PPM/PGM file input. 157rdrle.c Utah RLE file input. 158rdtarga.c Targa file input. 159 160Image file writer modules for djpeg: 161 162wrbmp.c BMP file output. 163wrgif.c GIF file output (a mere shadow of its former self). 164wrppm.c PPM/PGM file output. 165wrrle.c Utah RLE file output. 166wrtarga.c Targa file output. 167 168 169RDJPGCOM/WRJPGCOM 170================= 171 172C source code files: 173 174rdjpgcom.c Stand-alone rdjpgcom application. 175wrjpgcom.c Stand-alone wrjpgcom application. 176 177These programs do not depend on the IJG library. They do use 178jconfig.h and jinclude.h, only to improve portability. 179 180 181ADDITIONAL FILES 182================ 183 184Documentation (see README for a guide to the documentation files): 185 186README Master documentation file. 187*.doc Other documentation files. 188*.1 Documentation in Unix man page format. 189change.log Version-to-version change highlights. 190example.c Sample code for calling JPEG library. 191 192Configuration/installation files and programs (see install.doc for more info): 193 194configure Unix shell script to perform automatic configuration. 195ltconfig Support scripts for configure (from GNU libtool). 196ltmain.sh 197config.guess 198config.sub 199install-sh Install shell script for those Unix systems lacking one. 200ckconfig.c Program to generate jconfig.h on non-Unix systems. 201jconfig.doc Template for making jconfig.h by hand. 202makefile.* Sample makefiles for particular systems. 203jconfig.* Sample jconfig.h for particular systems. 204ansi2knr.c De-ANSIfier for pre-ANSI C compilers (courtesy of 205 L. Peter Deutsch and Aladdin Enterprises). 206 207Test files (see install.doc for test procedure): 208 209test*.* Source and comparison files for confidence test. 210 These are binary image files, NOT text files. 211