Home | History | Annotate | Download | only in libjpeg
      1 #if !defined(_FX_JPEG_TURBO_)
      2 /*
      3  * jcapimin.c
      4  *
      5  * Copyright (C) 1994-1998, Thomas G. Lane.
      6  * This file is part of the Independent JPEG Group's software.
      7  * For conditions of distribution and use, see the accompanying README file.
      8  *
      9  * This file contains application interface code for the compression half
     10  * of the JPEG library.  These are the "minimum" API routines that may be
     11  * needed in either the normal full-compression case or the transcoding-only
     12  * case.
     13  *
     14  * Most of the routines intended to be called directly by an application
     15  * are in this file or in jcapistd.c.  But also see jcparam.c for
     16  * parameter-setup helper routines, jcomapi.c for routines shared by
     17  * compression and decompression, and jctrans.c for the transcoding case.
     18  */
     19 
     20 #define JPEG_INTERNALS
     21 #include "jinclude.h"
     22 #include "jpeglib.h"
     23 
     24 
     25 /*
     26  * Initialization of a JPEG compression object.
     27  * The error manager must already be set up (in case memory manager fails).
     28  */
     29 
     30 GLOBAL(void)
     31 jpeg_CreateCompress (j_compress_ptr cinfo, int version, size_t structsize)
     32 {
     33   int i;
     34 
     35   /* Guard against version mismatches between library and caller. */
     36   cinfo->mem = NULL;		/* so jpeg_destroy knows mem mgr not called */
     37   if (version != JPEG_LIB_VERSION)
     38     ERREXIT2(cinfo, JERR_BAD_LIB_VERSION, JPEG_LIB_VERSION, version);
     39   if (structsize != SIZEOF(struct jpeg_compress_struct))
     40     ERREXIT2(cinfo, JERR_BAD_STRUCT_SIZE,
     41 	     (int) SIZEOF(struct jpeg_compress_struct), (int) structsize);
     42 
     43   /* For debugging purposes, we zero the whole master structure.
     44    * But the application has already set the err pointer, and may have set
     45    * client_data, so we have to save and restore those fields.
     46    * Note: if application hasn't set client_data, tools like Purify may
     47    * complain here.
     48    */
     49   {
     50     struct jpeg_error_mgr * err = cinfo->err;
     51     void * client_data = cinfo->client_data; /* ignore Purify complaint here */
     52     MEMZERO(cinfo, SIZEOF(struct jpeg_compress_struct));
     53     cinfo->err = err;
     54     cinfo->client_data = client_data;
     55   }
     56   cinfo->is_decompressor = FALSE;
     57 
     58   /* Initialize a memory manager instance for this object */
     59   jinit_memory_mgr((j_common_ptr) cinfo);
     60 
     61   /* Zero out pointers to permanent structures. */
     62   cinfo->progress = NULL;
     63   cinfo->dest = NULL;
     64 
     65   cinfo->comp_info = NULL;
     66 
     67   for (i = 0; i < NUM_QUANT_TBLS; i++)
     68     cinfo->quant_tbl_ptrs[i] = NULL;
     69 
     70   for (i = 0; i < NUM_HUFF_TBLS; i++) {
     71     cinfo->dc_huff_tbl_ptrs[i] = NULL;
     72     cinfo->ac_huff_tbl_ptrs[i] = NULL;
     73   }
     74 
     75   cinfo->script_space = NULL;
     76 
     77   cinfo->input_gamma = 1.0;	/* in case application forgets */
     78 
     79   /* OK, I'm ready */
     80   cinfo->global_state = CSTATE_START;
     81 }
     82 
     83 
     84 /*
     85  * Destruction of a JPEG compression object
     86  */
     87 
     88 GLOBAL(void)
     89 jpeg_destroy_compress (j_compress_ptr cinfo)
     90 {
     91   jpeg_destroy((j_common_ptr) cinfo); /* use common routine */
     92 }
     93 
     94 
     95 /*
     96  * Abort processing of a JPEG compression operation,
     97  * but don't destroy the object itself.
     98  */
     99 
    100 GLOBAL(void)
    101 jpeg_abort_compress (j_compress_ptr cinfo)
    102 {
    103   jpeg_abort((j_common_ptr) cinfo); /* use common routine */
    104 }
    105 
    106 
    107 /*
    108  * Forcibly suppress or un-suppress all quantization and Huffman tables.
    109  * Marks all currently defined tables as already written (if suppress)
    110  * or not written (if !suppress).  This will control whether they get emitted
    111  * by a subsequent jpeg_start_compress call.
    112  *
    113  * This routine is exported for use by applications that want to produce
    114  * abbreviated JPEG datastreams.  It logically belongs in jcparam.c, but
    115  * since it is called by jpeg_start_compress, we put it here --- otherwise
    116  * jcparam.o would be linked whether the application used it or not.
    117  */
    118 
    119 GLOBAL(void)
    120 jpeg_suppress_tables (j_compress_ptr cinfo, boolean suppress)
    121 {
    122   int i;
    123   JQUANT_TBL * qtbl;
    124   JHUFF_TBL * htbl;
    125 
    126   for (i = 0; i < NUM_QUANT_TBLS; i++) {
    127     if ((qtbl = cinfo->quant_tbl_ptrs[i]) != NULL)
    128       qtbl->sent_table = suppress;
    129   }
    130 
    131   for (i = 0; i < NUM_HUFF_TBLS; i++) {
    132     if ((htbl = cinfo->dc_huff_tbl_ptrs[i]) != NULL)
    133       htbl->sent_table = suppress;
    134     if ((htbl = cinfo->ac_huff_tbl_ptrs[i]) != NULL)
    135       htbl->sent_table = suppress;
    136   }
    137 }
    138 
    139 
    140 /*
    141  * Finish JPEG compression.
    142  *
    143  * If a multipass operating mode was selected, this may do a great deal of
    144  * work including most of the actual output.
    145  */
    146 
    147 GLOBAL(void)
    148 jpeg_finish_compress (j_compress_ptr cinfo)
    149 {
    150   JDIMENSION iMCU_row;
    151 
    152   if (cinfo->global_state == CSTATE_SCANNING ||
    153       cinfo->global_state == CSTATE_RAW_OK) {
    154     /* Terminate first pass */
    155     if (cinfo->next_scanline < cinfo->image_height)
    156       ERREXIT(cinfo, JERR_TOO_LITTLE_DATA);
    157     (*cinfo->master->finish_pass) (cinfo);
    158   } else if (cinfo->global_state != CSTATE_WRCOEFS)
    159     ERREXIT1(cinfo, JERR_BAD_STATE, cinfo->global_state);
    160   /* Perform any remaining passes */
    161   while (! cinfo->master->is_last_pass) {
    162     (*cinfo->master->prepare_for_pass) (cinfo);
    163     for (iMCU_row = 0; iMCU_row < cinfo->total_iMCU_rows; iMCU_row++) {
    164       if (cinfo->progress != NULL) {
    165 	cinfo->progress->pass_counter = (long) iMCU_row;
    166 	cinfo->progress->pass_limit = (long) cinfo->total_iMCU_rows;
    167 	(*cinfo->progress->progress_monitor) ((j_common_ptr) cinfo);
    168       }
    169       /* We bypass the main controller and invoke coef controller directly;
    170        * all work is being done from the coefficient buffer.
    171        */
    172       if (! (*cinfo->coef->compress_data) (cinfo, (JSAMPIMAGE) NULL))
    173 	ERREXIT(cinfo, JERR_CANT_SUSPEND);
    174     }
    175     (*cinfo->master->finish_pass) (cinfo);
    176   }
    177   /* Write EOI, do final cleanup */
    178   (*cinfo->marker->write_file_trailer) (cinfo);
    179   (*cinfo->dest->term_destination) (cinfo);
    180   /* We can use jpeg_abort to release memory and reset global_state */
    181   jpeg_abort((j_common_ptr) cinfo);
    182 }
    183 
    184 
    185 /*
    186  * Write a special marker.
    187  * This is only recommended for writing COM or APPn markers.
    188  * Must be called after jpeg_start_compress() and before
    189  * first call to jpeg_write_scanlines() or jpeg_write_raw_data().
    190  */
    191 
    192 GLOBAL(void)
    193 jpeg_write_marker (j_compress_ptr cinfo, int marker,
    194 		   const JOCTET *dataptr, unsigned int datalen)
    195 {
    196   JMETHOD(void, write_marker_byte, (j_compress_ptr info, int val));
    197 
    198   if (cinfo->next_scanline != 0 ||
    199       (cinfo->global_state != CSTATE_SCANNING &&
    200        cinfo->global_state != CSTATE_RAW_OK &&
    201        cinfo->global_state != CSTATE_WRCOEFS))
    202     ERREXIT1(cinfo, JERR_BAD_STATE, cinfo->global_state);
    203 
    204   (*cinfo->marker->write_marker_header) (cinfo, marker, datalen);
    205   write_marker_byte = cinfo->marker->write_marker_byte;	/* copy for speed */
    206   while (datalen--) {
    207     (*write_marker_byte) (cinfo, *dataptr);
    208     dataptr++;
    209   }
    210 }
    211 
    212 /* Same, but piecemeal. */
    213 
    214 GLOBAL(void)
    215 jpeg_write_m_header (j_compress_ptr cinfo, int marker, unsigned int datalen)
    216 {
    217   if (cinfo->next_scanline != 0 ||
    218       (cinfo->global_state != CSTATE_SCANNING &&
    219        cinfo->global_state != CSTATE_RAW_OK &&
    220        cinfo->global_state != CSTATE_WRCOEFS))
    221     ERREXIT1(cinfo, JERR_BAD_STATE, cinfo->global_state);
    222 
    223   (*cinfo->marker->write_marker_header) (cinfo, marker, datalen);
    224 }
    225 
    226 GLOBAL(void)
    227 jpeg_write_m_byte (j_compress_ptr cinfo, int val)
    228 {
    229   (*cinfo->marker->write_marker_byte) (cinfo, val);
    230 }
    231 
    232 
    233 /*
    234  * Alternate compression function: just write an abbreviated table file.
    235  * Before calling this, all parameters and a data destination must be set up.
    236  *
    237  * To produce a pair of files containing abbreviated tables and abbreviated
    238  * image data, one would proceed as follows:
    239  *
    240  *		initialize JPEG object
    241  *		set JPEG parameters
    242  *		set destination to table file
    243  *		jpeg_write_tables(cinfo);
    244  *		set destination to image file
    245  *		jpeg_start_compress(cinfo, FALSE);
    246  *		write data...
    247  *		jpeg_finish_compress(cinfo);
    248  *
    249  * jpeg_write_tables has the side effect of marking all tables written
    250  * (same as jpeg_suppress_tables(..., TRUE)).  Thus a subsequent start_compress
    251  * will not re-emit the tables unless it is passed write_all_tables=TRUE.
    252  */
    253 
    254 GLOBAL(void)
    255 jpeg_write_tables (j_compress_ptr cinfo)
    256 {
    257   if (cinfo->global_state != CSTATE_START)
    258     ERREXIT1(cinfo, JERR_BAD_STATE, cinfo->global_state);
    259 
    260   /* (Re)initialize error mgr and destination modules */
    261   (*cinfo->err->reset_error_mgr) ((j_common_ptr) cinfo);
    262   (*cinfo->dest->init_destination) (cinfo);
    263   /* Initialize the marker writer ... bit of a crock to do it here. */
    264   jinit_marker_writer(cinfo);
    265   /* Write them tables! */
    266   (*cinfo->marker->write_tables_only) (cinfo);
    267   /* And clean up. */
    268   (*cinfo->dest->term_destination) (cinfo);
    269   /*
    270    * In library releases up through v6a, we called jpeg_abort() here to free
    271    * any working memory allocated by the destination manager and marker
    272    * writer.  Some applications had a problem with that: they allocated space
    273    * of their own from the library memory manager, and didn't want it to go
    274    * away during write_tables.  So now we do nothing.  This will cause a
    275    * memory leak if an app calls write_tables repeatedly without doing a full
    276    * compression cycle or otherwise resetting the JPEG object.  However, that
    277    * seems less bad than unexpectedly freeing memory in the normal case.
    278    * An app that prefers the old behavior can call jpeg_abort for itself after
    279    * each call to jpeg_write_tables().
    280    */
    281 }
    282 
    283 #endif //_FX_JPEG_TURBO_
    284