4 * Copyright (C) 1991-1998, Thomas G. Lane.
5 * Copyright (C) 2010, D. R. Commander.
6 * This file is part of the Independent JPEG Group's software.
7 * For conditions of distribution and use, see the accompanying README file.
9 * This file contains routines to write JPEG datastream markers.
12 #define JPEG_INTERNALS
18 typedef enum { /* JPEG marker codes */
89 struct jpeg_marker_writer pub; /* public fields */
91 unsigned int last_restart_interval; /* last DRI value emitted; 0 after SOI */
94 typedef my_marker_writer * my_marker_ptr;
98 * Basic output routines.
100 * Note that we do not support suspension while writing a marker.
101 * Therefore, an application using suspension must ensure that there is
102 * enough buffer space for the initial markers (typ. 600-700 bytes) before
103 * calling jpeg_start_compress, and enough space to write the trailing EOI
104 * (a few bytes) before calling jpeg_finish_compress. Multipass compression
105 * modes are not supported at all with suspension, so those two are the only
106 * points where markers will be written.
110 emit_byte (j_compress_ptr cinfo, int val)
113 struct jpeg_destination_mgr * dest = cinfo->dest;
115 *(dest->next_output_byte)++ = (JOCTET) val;
116 if (--dest->free_in_buffer == 0) {
117 if (! (*dest->empty_output_buffer) (cinfo))
118 ERREXIT(cinfo, JERR_CANT_SUSPEND);
124 emit_marker (j_compress_ptr cinfo, JPEG_MARKER mark)
125 /* Emit a marker code */
127 emit_byte(cinfo, 0xFF);
128 emit_byte(cinfo, (int) mark);
133 emit_2bytes (j_compress_ptr cinfo, int value)
134 /* Emit a 2-byte integer; these are always MSB first in JPEG files */
136 emit_byte(cinfo, (value >> 8) & 0xFF);
137 emit_byte(cinfo, value & 0xFF);
142 * Routines to write specific marker types.
146 emit_dqt (j_compress_ptr cinfo, int index)
147 /* Emit a DQT marker */
148 /* Returns the precision used (0 = 8bits, 1 = 16bits) for baseline checking */
150 JQUANT_TBL * qtbl = cinfo->quant_tbl_ptrs[index];
155 ERREXIT1(cinfo, JERR_NO_QUANT_TABLE, index);
158 for (i = 0; i < DCTSIZE2; i++) {
159 if (qtbl->quantval[i] > 255)
163 if (! qtbl->sent_table) {
164 emit_marker(cinfo, M_DQT);
166 emit_2bytes(cinfo, prec ? DCTSIZE2*2 + 1 + 2 : DCTSIZE2 + 1 + 2);
168 emit_byte(cinfo, index + (prec<<4));
170 for (i = 0; i < DCTSIZE2; i++) {
171 /* The table entries must be emitted in zigzag order. */
172 unsigned int qval = qtbl->quantval[jpeg_natural_order[i]];
174 emit_byte(cinfo, (int) (qval >> 8));
175 emit_byte(cinfo, (int) (qval & 0xFF));
178 qtbl->sent_table = TRUE;
186 emit_dht (j_compress_ptr cinfo, int index, boolean is_ac)
187 /* Emit a DHT marker */
193 htbl = cinfo->ac_huff_tbl_ptrs[index];
194 index += 0x10; /* output index has AC bit set */
196 htbl = cinfo->dc_huff_tbl_ptrs[index];
200 ERREXIT1(cinfo, JERR_NO_HUFF_TABLE, index);
202 if (! htbl->sent_table) {
203 emit_marker(cinfo, M_DHT);
206 for (i = 1; i <= 16; i++)
207 length += htbl->bits[i];
209 emit_2bytes(cinfo, length + 2 + 1 + 16);
210 emit_byte(cinfo, index);
212 for (i = 1; i <= 16; i++)
213 emit_byte(cinfo, htbl->bits[i]);
215 for (i = 0; i < length; i++)
216 emit_byte(cinfo, htbl->huffval[i]);
218 htbl->sent_table = TRUE;
224 emit_dac (j_compress_ptr cinfo)
225 /* Emit a DAC marker */
226 /* Since the useful info is so small, we want to emit all the tables in */
227 /* one DAC marker. Therefore this routine does its own scan of the table. */
229 #ifdef C_ARITH_CODING_SUPPORTED
230 char dc_in_use[NUM_ARITH_TBLS];
231 char ac_in_use[NUM_ARITH_TBLS];
233 jpeg_component_info *compptr;
235 for (i = 0; i < NUM_ARITH_TBLS; i++)
236 dc_in_use[i] = ac_in_use[i] = 0;
238 for (i = 0; i < cinfo->comps_in_scan; i++) {
239 compptr = cinfo->cur_comp_info[i];
240 dc_in_use[compptr->dc_tbl_no] = 1;
241 ac_in_use[compptr->ac_tbl_no] = 1;
245 for (i = 0; i < NUM_ARITH_TBLS; i++)
246 length += dc_in_use[i] + ac_in_use[i];
248 emit_marker(cinfo, M_DAC);
250 emit_2bytes(cinfo, length*2 + 2);
252 for (i = 0; i < NUM_ARITH_TBLS; i++) {
255 emit_byte(cinfo, cinfo->arith_dc_L[i] + (cinfo->arith_dc_U[i]<<4));
258 emit_byte(cinfo, i + 0x10);
259 emit_byte(cinfo, cinfo->arith_ac_K[i]);
262 #endif /* C_ARITH_CODING_SUPPORTED */
267 emit_dri (j_compress_ptr cinfo)
268 /* Emit a DRI marker */
270 emit_marker(cinfo, M_DRI);
272 emit_2bytes(cinfo, 4); /* fixed length */
274 emit_2bytes(cinfo, (int) cinfo->restart_interval);
279 emit_sof (j_compress_ptr cinfo, JPEG_MARKER code)
280 /* Emit a SOF marker */
283 jpeg_component_info *compptr;
285 emit_marker(cinfo, code);
287 emit_2bytes(cinfo, 3 * cinfo->num_components + 2 + 5 + 1); /* length */
289 /* Make sure image isn't bigger than SOF field can handle */
290 if ((long) cinfo->_jpeg_height > 65535L ||
291 (long) cinfo->_jpeg_width > 65535L)
292 ERREXIT1(cinfo, JERR_IMAGE_TOO_BIG, (unsigned int) 65535);
294 emit_byte(cinfo, cinfo->data_precision);
295 emit_2bytes(cinfo, (int) cinfo->_jpeg_height);
296 emit_2bytes(cinfo, (int) cinfo->_jpeg_width);
298 emit_byte(cinfo, cinfo->num_components);
300 for (ci = 0, compptr = cinfo->comp_info; ci < cinfo->num_components;
302 emit_byte(cinfo, compptr->component_id);
303 emit_byte(cinfo, (compptr->h_samp_factor << 4) + compptr->v_samp_factor);
304 emit_byte(cinfo, compptr->quant_tbl_no);
310 emit_sos (j_compress_ptr cinfo)
311 /* Emit a SOS marker */
314 jpeg_component_info *compptr;
316 emit_marker(cinfo, M_SOS);
318 emit_2bytes(cinfo, 2 * cinfo->comps_in_scan + 2 + 1 + 3); /* length */
320 emit_byte(cinfo, cinfo->comps_in_scan);
322 for (i = 0; i < cinfo->comps_in_scan; i++) {
323 compptr = cinfo->cur_comp_info[i];
324 emit_byte(cinfo, compptr->component_id);
325 td = compptr->dc_tbl_no;
326 ta = compptr->ac_tbl_no;
327 if (cinfo->progressive_mode) {
328 /* Progressive mode: only DC or only AC tables are used in one scan;
329 * furthermore, Huffman coding of DC refinement uses no table at all.
330 * We emit 0 for unused field(s); this is recommended by the P&M text
331 * but does not seem to be specified in the standard.
333 if (cinfo->Ss == 0) {
334 ta = 0; /* DC scan */
335 if (cinfo->Ah != 0 && !cinfo->arith_code)
336 td = 0; /* no DC table either */
338 td = 0; /* AC scan */
341 emit_byte(cinfo, (td << 4) + ta);
344 emit_byte(cinfo, cinfo->Ss);
345 emit_byte(cinfo, cinfo->Se);
346 emit_byte(cinfo, (cinfo->Ah << 4) + cinfo->Al);
351 emit_jfif_app0 (j_compress_ptr cinfo)
352 /* Emit a JFIF-compliant APP0 marker */
355 * Length of APP0 block (2 bytes)
356 * Block ID (4 bytes - ASCII "JFIF")
357 * Zero byte (1 byte to terminate the ID string)
358 * Version Major, Minor (2 bytes - major first)
359 * Units (1 byte - 0x00 = none, 0x01 = inch, 0x02 = cm)
360 * Xdpu (2 bytes - dots per unit horizontal)
361 * Ydpu (2 bytes - dots per unit vertical)
362 * Thumbnail X size (1 byte)
363 * Thumbnail Y size (1 byte)
366 emit_marker(cinfo, M_APP0);
368 emit_2bytes(cinfo, 2 + 4 + 1 + 2 + 1 + 2 + 2 + 1 + 1); /* length */
370 emit_byte(cinfo, 0x4A); /* Identifier: ASCII "JFIF" */
371 emit_byte(cinfo, 0x46);
372 emit_byte(cinfo, 0x49);
373 emit_byte(cinfo, 0x46);
375 emit_byte(cinfo, cinfo->JFIF_major_version); /* Version fields */
376 emit_byte(cinfo, cinfo->JFIF_minor_version);
377 emit_byte(cinfo, cinfo->density_unit); /* Pixel size information */
378 emit_2bytes(cinfo, (int) cinfo->X_density);
379 emit_2bytes(cinfo, (int) cinfo->Y_density);
380 emit_byte(cinfo, 0); /* No thumbnail image */
386 emit_adobe_app14 (j_compress_ptr cinfo)
387 /* Emit an Adobe APP14 marker */
390 * Length of APP14 block (2 bytes)
391 * Block ID (5 bytes - ASCII "Adobe")
392 * Version Number (2 bytes - currently 100)
393 * Flags0 (2 bytes - currently 0)
394 * Flags1 (2 bytes - currently 0)
395 * Color transform (1 byte)
397 * Although Adobe TN 5116 mentions Version = 101, all the Adobe files
398 * now in circulation seem to use Version = 100, so that's what we write.
400 * We write the color transform byte as 1 if the JPEG color space is
401 * YCbCr, 2 if it's YCCK, 0 otherwise. Adobe's definition has to do with
402 * whether the encoder performed a transformation, which is pretty useless.
405 emit_marker(cinfo, M_APP14);
407 emit_2bytes(cinfo, 2 + 5 + 2 + 2 + 2 + 1); /* length */
409 emit_byte(cinfo, 0x41); /* Identifier: ASCII "Adobe" */
410 emit_byte(cinfo, 0x64);
411 emit_byte(cinfo, 0x6F);
412 emit_byte(cinfo, 0x62);
413 emit_byte(cinfo, 0x65);
414 emit_2bytes(cinfo, 100); /* Version */
415 emit_2bytes(cinfo, 0); /* Flags0 */
416 emit_2bytes(cinfo, 0); /* Flags1 */
417 switch (cinfo->jpeg_color_space) {
419 emit_byte(cinfo, 1); /* Color transform = 1 */
422 emit_byte(cinfo, 2); /* Color transform = 2 */
425 emit_byte(cinfo, 0); /* Color transform = 0 */
432 * These routines allow writing an arbitrary marker with parameters.
433 * The only intended use is to emit COM or APPn markers after calling
434 * write_file_header and before calling write_frame_header.
435 * Other uses are not guaranteed to produce desirable results.
436 * Counting the parameter bytes properly is the caller's responsibility.
440 write_marker_header (j_compress_ptr cinfo, int marker, unsigned int datalen)
441 /* Emit an arbitrary marker header */
443 if (datalen > (unsigned int) 65533) /* safety check */
444 ERREXIT(cinfo, JERR_BAD_LENGTH);
446 emit_marker(cinfo, (JPEG_MARKER) marker);
448 emit_2bytes(cinfo, (int) (datalen + 2)); /* total length */
452 write_marker_byte (j_compress_ptr cinfo, int val)
453 /* Emit one byte of marker parameters following write_marker_header */
455 emit_byte(cinfo, val);
460 * Write datastream header.
461 * This consists of an SOI and optional APPn markers.
462 * We recommend use of the JFIF marker, but not the Adobe marker,
463 * when using YCbCr or grayscale data. The JFIF marker should NOT
464 * be used for any other JPEG colorspace. The Adobe marker is helpful
465 * to distinguish RGB, CMYK, and YCCK colorspaces.
466 * Note that an application can write additional header markers after
467 * jpeg_start_compress returns.
471 write_file_header (j_compress_ptr cinfo)
473 my_marker_ptr marker = (my_marker_ptr) cinfo->marker;
475 emit_marker(cinfo, M_SOI); /* first the SOI */
477 /* SOI is defined to reset restart interval to 0 */
478 marker->last_restart_interval = 0;
480 if (cinfo->write_JFIF_header) /* next an optional JFIF APP0 */
481 emit_jfif_app0(cinfo);
482 if (cinfo->write_Adobe_marker) /* next an optional Adobe APP14 */
483 emit_adobe_app14(cinfo);
488 * Write frame header.
489 * This consists of DQT and SOFn markers.
490 * Note that we do not emit the SOF until we have emitted the DQT(s).
491 * This avoids compatibility problems with incorrect implementations that
492 * try to error-check the quant table numbers as soon as they see the SOF.
496 write_frame_header (j_compress_ptr cinfo)
500 jpeg_component_info *compptr;
502 /* Emit DQT for each quantization table.
503 * Note that emit_dqt() suppresses any duplicate tables.
506 for (ci = 0, compptr = cinfo->comp_info; ci < cinfo->num_components;
508 prec += emit_dqt(cinfo, compptr->quant_tbl_no);
510 /* now prec is nonzero iff there are any 16-bit quant tables. */
512 /* Check for a non-baseline specification.
513 * Note we assume that Huffman table numbers won't be changed later.
515 if (cinfo->arith_code || cinfo->progressive_mode ||
516 cinfo->data_precision != 8) {
520 for (ci = 0, compptr = cinfo->comp_info; ci < cinfo->num_components;
522 if (compptr->dc_tbl_no > 1 || compptr->ac_tbl_no > 1)
525 if (prec && is_baseline) {
527 /* If it's baseline except for quantizer size, warn the user */
528 TRACEMS(cinfo, 0, JTRC_16BIT_TABLES);
532 /* Emit the proper SOF marker */
533 if (cinfo->arith_code) {
534 emit_sof(cinfo, M_SOF9); /* SOF code for arithmetic coding */
536 if (cinfo->progressive_mode)
537 emit_sof(cinfo, M_SOF2); /* SOF code for progressive Huffman */
538 else if (is_baseline)
539 emit_sof(cinfo, M_SOF0); /* SOF code for baseline implementation */
541 emit_sof(cinfo, M_SOF1); /* SOF code for non-baseline Huffman file */
548 * This consists of DHT or DAC markers, optional DRI, and SOS.
549 * Compressed data will be written following the SOS.
553 write_scan_header (j_compress_ptr cinfo)
555 my_marker_ptr marker = (my_marker_ptr) cinfo->marker;
557 jpeg_component_info *compptr;
559 if (cinfo->arith_code) {
560 /* Emit arith conditioning info. We may have some duplication
561 * if the file has multiple scans, but it's so small it's hardly
562 * worth worrying about.
566 /* Emit Huffman tables.
567 * Note that emit_dht() suppresses any duplicate tables.
569 for (i = 0; i < cinfo->comps_in_scan; i++) {
570 compptr = cinfo->cur_comp_info[i];
571 if (cinfo->progressive_mode) {
572 /* Progressive mode: only DC or only AC tables are used in one scan */
573 if (cinfo->Ss == 0) {
574 if (cinfo->Ah == 0) /* DC needs no table for refinement scan */
575 emit_dht(cinfo, compptr->dc_tbl_no, FALSE);
577 emit_dht(cinfo, compptr->ac_tbl_no, TRUE);
580 /* Sequential mode: need both DC and AC tables */
581 emit_dht(cinfo, compptr->dc_tbl_no, FALSE);
582 emit_dht(cinfo, compptr->ac_tbl_no, TRUE);
587 /* Emit DRI if required --- note that DRI value could change for each scan.
588 * We avoid wasting space with unnecessary DRIs, however.
590 if (cinfo->restart_interval != marker->last_restart_interval) {
592 marker->last_restart_interval = cinfo->restart_interval;
600 * Write datastream trailer.
604 write_file_trailer (j_compress_ptr cinfo)
606 emit_marker(cinfo, M_EOI);
611 * Write an abbreviated table-specification datastream.
612 * This consists of SOI, DQT and DHT tables, and EOI.
613 * Any table that is defined and not marked sent_table = TRUE will be
614 * emitted. Note that all tables will be marked sent_table = TRUE at exit.
618 write_tables_only (j_compress_ptr cinfo)
622 emit_marker(cinfo, M_SOI);
624 for (i = 0; i < NUM_QUANT_TBLS; i++) {
625 if (cinfo->quant_tbl_ptrs[i] != NULL)
626 (void) emit_dqt(cinfo, i);
629 if (! cinfo->arith_code) {
630 for (i = 0; i < NUM_HUFF_TBLS; i++) {
631 if (cinfo->dc_huff_tbl_ptrs[i] != NULL)
632 emit_dht(cinfo, i, FALSE);
633 if (cinfo->ac_huff_tbl_ptrs[i] != NULL)
634 emit_dht(cinfo, i, TRUE);
638 emit_marker(cinfo, M_EOI);
643 * Initialize the marker writer module.
647 jinit_marker_writer (j_compress_ptr cinfo)
649 my_marker_ptr marker;
651 /* Create the subobject */
652 marker = (my_marker_ptr)
653 (*cinfo->mem->alloc_small) ((j_common_ptr) cinfo, JPOOL_IMAGE,
654 SIZEOF(my_marker_writer));
655 cinfo->marker = (struct jpeg_marker_writer *) marker;
656 /* Initialize method pointers */
657 marker->pub.write_file_header = write_file_header;
658 marker->pub.write_frame_header = write_frame_header;
659 marker->pub.write_scan_header = write_scan_header;
660 marker->pub.write_file_trailer = write_file_trailer;
661 marker->pub.write_tables_only = write_tables_only;
662 marker->pub.write_marker_header = write_marker_header;
663 marker->pub.write_marker_byte = write_marker_byte;
664 /* Initialize private state */
665 marker->last_restart_interval = 0;