]> Creatis software - gdcm.git/blob - src/gdcmjpeg/jdatadst.c
Fix mistyping
[gdcm.git] / src / gdcmjpeg / jdatadst.c
1 /*
2  * jdatadst.c
3  *
4  * Copyright (C) 1994-1996, Thomas G. Lane.
5  * This file is part of the Independent JPEG Group's software.
6  * For conditions of distribution and use, see the accompanying README file.
7  *
8  * This file contains compression data destination routines for the case of
9  * emitting JPEG data to a file (or any stdio stream).  While these routines
10  * are sufficient for most applications, some will want to use a different
11  * destination manager.
12  * IMPORTANT: we assume that fwrite() will correctly transcribe an array of
13  * JOCTETs into 8-bit-wide elements on external storage.  If char is wider
14  * than 8 bits on your machine, you may need to do some tweaking.
15  */
16
17 /* this is not a core library module, so it doesn't define JPEG_INTERNALS */
18 #include "jinclude.h"
19 #include "jpeglib.h"
20 #include "jerror.h"
21
22
23 /* Expanded data destination object for stdio output */
24
25 /**
26  * \brief very low level C 'structure', used to decode jpeg file
27  * Should not appear in the Doxygen supplied documentation
28  */
29 typedef struct {
30   struct jpeg_destination_mgr pub; /* public fields */
31   FILE * outfile;    /* target stream */
32   JOCTET * buffer;    /* start of buffer */
33 } my_destination_mgr;
34
35 typedef my_destination_mgr * my_dest_ptr;
36
37 #define OUTPUT_BUF_SIZE  4096  /* choose an efficiently fwrite'able size */
38
39
40 /*
41  * Initialize destination --- called by jpeg_start_compress
42  * before any data is actually written.
43  */
44
45 METHODDEF(void)
46 init_destination (j_compress_ptr cinfo)
47 {
48   my_dest_ptr dest = (my_dest_ptr) cinfo->dest;
49
50   /* Allocate the output buffer --- it will be released when done with image */
51   dest->buffer = (JOCTET *)
52       (*cinfo->mem->alloc_small) ((j_common_ptr) cinfo, JPOOL_IMAGE,
53           OUTPUT_BUF_SIZE * SIZEOF(JOCTET));
54
55   dest->pub.next_output_byte = dest->buffer;
56   dest->pub.free_in_buffer = OUTPUT_BUF_SIZE;
57 }
58
59
60 /*
61  * Empty the output buffer --- called whenever buffer fills up.
62  *
63  * In typical applications, this should write the entire output buffer
64  * (ignoring the current state of next_output_byte & free_in_buffer),
65  * reset the pointer & count to the start of the buffer, and return TRUE
66  * indicating that the buffer has been dumped.
67  *
68  * In applications that need to be able to suspend compression due to output
69  * overrun, a FALSE return indicates that the buffer cannot be emptied now.
70  * In this situation, the compressor will return to its caller (possibly with
71  * an indication that it has not accepted all the supplied scanlines).  The
72  * application should resume compression after it has made more room in the
73  * output buffer.  Note that there are substantial restrictions on the use of
74  * suspension --- see the documentation.
75  *
76  * When suspending, the compressor will back up to a convenient restart point
77  * (typically the start of the current MCU). next_output_byte & free_in_buffer
78  * indicate where the restart point will be if the current call returns FALSE.
79  * Data beyond this point will be regenerated after resumption, so do not
80  * write it out when emptying the buffer externally.
81  */
82
83 METHODDEF(boolean)
84 empty_output_buffer (j_compress_ptr cinfo)
85 {
86   my_dest_ptr dest = (my_dest_ptr) cinfo->dest;
87
88   if (JFWRITE(dest->outfile, dest->buffer, OUTPUT_BUF_SIZE) !=
89       (size_t) OUTPUT_BUF_SIZE)
90     ERREXIT(cinfo, JERR_FILE_WRITE);
91
92   dest->pub.next_output_byte = dest->buffer;
93   dest->pub.free_in_buffer = OUTPUT_BUF_SIZE;
94
95   return TRUE;
96 }
97
98
99 /*
100  * Terminate destination --- called by jpeg_finish_compress
101  * after all data has been written.  Usually needs to flush buffer.
102  *
103  * NB: *not* called by jpeg_abort or jpeg_destroy; surrounding
104  * application must deal with any cleanup that should happen even
105  * for error exit.
106  */
107
108 METHODDEF(void)
109 term_destination (j_compress_ptr cinfo)
110 {
111   my_dest_ptr dest = (my_dest_ptr) cinfo->dest;
112   size_t datacount = OUTPUT_BUF_SIZE - dest->pub.free_in_buffer;
113
114   /* Write any data remaining in the buffer */
115   if (datacount > 0) {
116     if (JFWRITE(dest->outfile, dest->buffer, datacount) != datacount)
117       ERREXIT(cinfo, JERR_FILE_WRITE);
118   }
119   fflush(dest->outfile);
120   /* Make sure we wrote the output file OK */
121   if (ferror(dest->outfile))
122     ERREXIT(cinfo, JERR_FILE_WRITE);
123 }
124
125
126 /*
127  * Prepare for output to a stdio stream.
128  * The caller must have already opened the stream, and is responsible
129  * for closing it after finishing compression.
130  */
131
132 GLOBAL(void)
133 jpeg_stdio_dest (j_compress_ptr cinfo, FILE * outfile)
134 {
135   my_dest_ptr dest;
136
137   /* The destination object is made permanent so that multiple JPEG images
138    * can be written to the same file without re-executing jpeg_stdio_dest.
139    * This makes it dangerous to use this manager and a different destination
140    * manager serially with the same JPEG object, because their private object
141    * sizes may be different.  Caveat programmer.
142    */
143   if (cinfo->dest == NULL) {  /* first time for this JPEG object? */
144     cinfo->dest = (struct jpeg_destination_mgr *)
145       (*cinfo->mem->alloc_small) ((j_common_ptr) cinfo, JPOOL_PERMANENT,
146           SIZEOF(my_destination_mgr));
147   }
148
149   dest = (my_dest_ptr) cinfo->dest;
150   dest->pub.init_destination = init_destination;
151   dest->pub.empty_output_buffer = empty_output_buffer;
152   dest->pub.term_destination = term_destination;
153   dest->outfile = outfile;
154 }