enable all progression orders
[openjpeg.git] / libopenjpeg / cio.c
1 /*
2  * Copyright (c) 2002-2007, Communications and Remote Sensing Laboratory, Universite catholique de Louvain (UCL), Belgium
3  * Copyright (c) 2002-2007, Professor Benoit Macq
4  * Copyright (c) 2001-2003, David Janssens
5  * Copyright (c) 2002-2003, Yannick Verschueren
6  * Copyright (c) 2003-2007, Francois-Olivier Devaux and Antonin Descampe
7  * Copyright (c) 2005, Herve Drolon, FreeImage Team
8  * All rights reserved.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
20  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
23  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  */
31
32 #include "opj_includes.h"
33
34 /* ----------------------------------------------------------------------- */
35
36 opj_cio_t* OPJ_CALLCONV opj_cio_open(opj_common_ptr cinfo, unsigned char *buffer, int length) {
37         opj_cp_t *cp = NULL;
38         opj_cio_t *cio = (opj_cio_t*)opj_malloc(sizeof(opj_cio_t));
39         if(!cio) return NULL;
40         cio->cinfo = cinfo;
41         if(buffer && length) {
42                 /* wrap a user buffer containing the encoded image */
43                 cio->openmode = OPJ_STREAM_READ;
44                 cio->buffer = buffer;
45                 cio->length = length;
46         }
47         else if(!buffer && !length && cinfo) {
48                 /* allocate a buffer for the encoded image */
49                 cio->openmode = OPJ_STREAM_WRITE;
50                 switch(cinfo->codec_format) {
51                         case CODEC_J2K:
52                                 cp = ((opj_j2k_t*)cinfo->j2k_handle)->cp;
53                                 break;
54                         case CODEC_JP2:
55                                 cp = ((opj_jp2_t*)cinfo->jp2_handle)->j2k->cp;
56                                 break;
57                         default:
58                                 opj_free(cio);
59                                 return NULL;
60                 }
61                 cio->length = (unsigned int) (0.1625 * cp->img_size + 2000); /* 0.1625 = 1.3/8 and 2000 bytes as a minimum for headers */
62                 cio->buffer = (unsigned char *)opj_malloc(cio->length);
63                 if(!cio->buffer) {
64                         opj_event_msg(cio->cinfo, EVT_ERROR, "Error allocating memory for compressed bitstream\n");
65                         opj_free(cio);
66                         return NULL;
67                 }
68         }
69         else {
70                 opj_free(cio);
71                 return NULL;
72         }
73
74         /* Initialize byte IO */
75         cio->start = cio->buffer;
76         cio->end = cio->buffer + cio->length;
77         cio->bp = cio->buffer;
78
79         return cio;
80 }
81
82 void OPJ_CALLCONV opj_cio_close(opj_cio_t *cio) {
83         if(cio) {
84                 if(cio->openmode == OPJ_STREAM_WRITE) {
85                         /* destroy the allocated buffer */
86                         opj_free(cio->buffer);
87                 }
88                 /* destroy the cio */
89                 opj_free(cio);
90         }
91 }
92
93
94 /* ----------------------------------------------------------------------- */
95
96 /*
97  * Get position in byte stream.
98  */
99 int OPJ_CALLCONV cio_tell(opj_cio_t *cio) {
100         return cio->bp - cio->start;
101 }
102
103 /*
104  * Set position in byte stream.
105  *
106  * pos : position, in number of bytes, from the beginning of the stream
107  */
108 void OPJ_CALLCONV cio_seek(opj_cio_t *cio, int pos) {
109         cio->bp = cio->start + pos;
110 }
111
112 /*
113  * Number of bytes left before the end of the stream.
114  */
115 int cio_numbytesleft(opj_cio_t *cio) {
116         return cio->end - cio->bp;
117 }
118
119 /*
120  * Get pointer to the current position in the stream.
121  */
122 unsigned char *cio_getbp(opj_cio_t *cio) {
123         return cio->bp;
124 }
125
126 /*
127  * Write a byte.
128  */
129 opj_bool cio_byteout(opj_cio_t *cio, unsigned char v) {
130         if (cio->bp >= cio->end) {
131                 opj_event_msg(cio->cinfo, EVT_ERROR, "write error\n");
132                 return OPJ_FALSE;
133         }
134         *cio->bp++ = v;
135         return OPJ_TRUE;
136 }
137
138 /*
139  * Read a byte.
140  */
141 unsigned char cio_bytein(opj_cio_t *cio) {
142         if (cio->bp >= cio->end) {
143                 opj_event_msg(cio->cinfo, EVT_ERROR, "read error: passed the end of the codestream (start = %d, current = %d, end = %d\n", cio->start, cio->bp, cio->end);
144                 return 0;
145         }
146         return *cio->bp++;
147 }
148
149 /*
150  * Write some bytes.
151  *
152  * v : value to write
153  * n : number of bytes to write
154  */
155 unsigned int cio_write(opj_cio_t *cio, unsigned long long int v, int n) {
156         int i;
157         for (i = n - 1; i >= 0; i--) {
158                 if( !cio_byteout(cio, (unsigned char) ((v >> (i << 3)) & 0xff)) )
159                         return 0;
160         }
161         return n;
162 }
163
164 /*
165  * Read some bytes.
166  *
167  * n : number of bytes to read
168  *
169  * return : value of the n bytes read
170  */
171 unsigned int cio_read(opj_cio_t *cio, int n) {
172         int i;
173         unsigned int v;
174         v = 0;
175         for (i = n - 1; i >= 0; i--) {
176                 v += cio_bytein(cio) << (i << 3);
177         }
178         return v;
179 }
180
181 /* 
182  * Skip some bytes.
183  *
184  * n : number of bytes to skip
185  */
186 void cio_skip(opj_cio_t *cio, int n) {
187         cio->bp += n;
188 }
189
190
191 /* ----------------------------------------------------------------------- */
192
193
194 /**
195  * Write some bytes to the given data buffer, this function is used in Big Endian cpus.
196  * @param p_buffer              pointer the data buffer to write data to.
197  * @param p_value               the value to write
198  * @param p_nb_bytes    the number of bytes to write
199 */
200 void opj_write_bytes_BE (OPJ_BYTE * p_buffer, OPJ_UINT32 p_value, OPJ_UINT32 p_nb_bytes)
201 {
202         const OPJ_BYTE * l_data_ptr = ((const OPJ_BYTE *) &p_value) + p_nb_bytes;
203
204         assert(p_nb_bytes > 0 && p_nb_bytes <=  sizeof(OPJ_UINT32));
205
206         memcpy(p_buffer,l_data_ptr,p_nb_bytes);
207 }
208
209 /**
210  * Write some bytes to the given data buffer, this function is used in Little Endian cpus.
211  * @param p_buffer              pointer the data buffer to write data to.
212  * @param p_value               the value to write
213  * @param p_nb_bytes    the number of bytes to write
214  * @return                              the number of bytes written or -1 if an error occured
215 */
216 void opj_write_bytes_LE (OPJ_BYTE * p_buffer, OPJ_UINT32 p_value, OPJ_UINT32 p_nb_bytes)
217 {
218         const OPJ_BYTE * l_data_ptr = ((const OPJ_BYTE *) &p_value) + p_nb_bytes - 1;
219         OPJ_UINT32 i;
220
221         assert(p_nb_bytes > 0 && p_nb_bytes <= sizeof(OPJ_UINT32));
222
223         for     (i=0;i<p_nb_bytes;++i) {
224                 *(p_buffer++) = *(l_data_ptr--);
225         }
226 }
227
228 /**
229  * Reads some bytes from the given data buffer, this function is used in Big Endian cpus.
230  * @param p_buffer              pointer the data buffer to read data from.
231  * @param p_value               pointer to the value that will store the data.
232  * @param p_nb_bytes    the nb bytes to read.
233  * @return                              the number of bytes read or -1 if an error occured.
234  */
235 void opj_read_bytes_BE(const OPJ_BYTE * p_buffer, OPJ_UINT32 * p_value, OPJ_UINT32 p_nb_bytes)
236 {
237         OPJ_BYTE * l_data_ptr = ((OPJ_BYTE *) p_value);
238
239         assert(p_nb_bytes > 0 && p_nb_bytes <= sizeof(OPJ_UINT32));
240
241         *p_value = 0;
242         memcpy(l_data_ptr+4-p_nb_bytes,p_buffer,p_nb_bytes);
243 }
244
245 /**
246  * Reads some bytes from the given data buffer, this function is used in Little Endian cpus.
247  * @param p_buffer              pointer the data buffer to read data from.
248  * @param p_value               pointer to the value that will store the data.
249  * @param p_nb_bytes    the nb bytes to read.
250  * @return                              the number of bytes read or -1 if an error occured.
251  */
252 void opj_read_bytes_LE(const OPJ_BYTE * p_buffer, OPJ_UINT32 * p_value, OPJ_UINT32 p_nb_bytes)
253 {
254         OPJ_BYTE * l_data_ptr = ((OPJ_BYTE *) p_value) + p_nb_bytes-1;
255         OPJ_UINT32 i;
256
257         assert(p_nb_bytes > 0 && p_nb_bytes <= sizeof(OPJ_UINT32));
258
259         *p_value = 0;
260         for (i=0;i<p_nb_bytes;++i) {
261                 *(l_data_ptr--) = *(p_buffer++);
262         }
263 }
264
265 /**
266  * Write some bytes to the given data buffer, this function is used in Big Endian cpus.
267  * @param p_buffer              pointer the data buffer to write data to.
268  * @param p_value               the value to write
269  * @return                              the number of bytes written or -1 if an error occured
270  */
271 void opj_write_double_BE(OPJ_BYTE * p_buffer, OPJ_FLOAT64 p_value)
272 {
273         const OPJ_BYTE * l_data_ptr = ((const OPJ_BYTE *) &p_value);
274         memcpy(p_buffer,l_data_ptr,sizeof(OPJ_FLOAT64));
275 }
276
277 /**
278  * Write some bytes to the given data buffer, this function is used in Little Endian cpus.
279  * @param p_buffer              pointer the data buffer to write data to.
280  * @param p_value               the value to write
281  */
282 void opj_write_double_LE(OPJ_BYTE * p_buffer, OPJ_FLOAT64 p_value)
283 {
284         const OPJ_BYTE * l_data_ptr = ((const OPJ_BYTE *) &p_value) + sizeof(OPJ_FLOAT64) - 1;
285         OPJ_UINT32 i;
286         for     (i=0;i<sizeof(OPJ_FLOAT64);++i) {
287                 *(p_buffer++) = *(l_data_ptr--);
288         }
289 }
290
291 /**
292  * Reads some bytes from the given data buffer, this function is used in Big Endian cpus.
293  * @param p_buffer              pointer the data buffer to read data from.
294  * @param p_value               pointer to the value that will store the data.
295  */
296 void opj_read_double_BE(const OPJ_BYTE * p_buffer, OPJ_FLOAT64 * p_value)
297 {
298         OPJ_BYTE * l_data_ptr = ((OPJ_BYTE *) p_value);
299         memcpy(l_data_ptr,p_buffer,sizeof(OPJ_FLOAT64));
300 }
301
302
303 /**
304  * Reads some bytes from the given data buffer, this function is used in Little Endian cpus.
305  * @param p_buffer              pointer the data buffer to read data from.
306  * @param p_value               pointer to the value that will store the data.
307  */
308 void opj_read_double_LE(const OPJ_BYTE * p_buffer, OPJ_FLOAT64 * p_value)
309 {
310         OPJ_BYTE * l_data_ptr = ((OPJ_BYTE *) p_value) + sizeof(OPJ_FLOAT64)-1;
311         OPJ_UINT32 i;
312         for (i=0;i<sizeof(OPJ_FLOAT64);++i) {
313                 *(l_data_ptr--) = *(p_buffer++);
314         }
315 }
316
317 /**
318  * Write some bytes to the given data buffer, this function is used in Big Endian cpus.
319  * @param p_buffer              pointer the data buffer to write data to.
320  * @param p_value               the value to write
321  * @return                              the number of bytes written or -1 if an error occured
322  */
323 void opj_write_float_BE(OPJ_BYTE * p_buffer, OPJ_FLOAT32 p_value)
324 {
325         const OPJ_BYTE * l_data_ptr = ((const OPJ_BYTE *) &p_value);
326         memcpy(p_buffer,l_data_ptr,sizeof(OPJ_FLOAT32));
327 }
328
329 /**
330  * Write some bytes to the given data buffer, this function is used in Little Endian cpus.
331  * @param p_buffer              pointer the data buffer to write data to.
332  * @param p_value               the value to write
333  */
334 void opj_write_float_LE(OPJ_BYTE * p_buffer, OPJ_FLOAT32 p_value)
335 {
336         const OPJ_BYTE * l_data_ptr = ((const OPJ_BYTE *) &p_value) + sizeof(OPJ_FLOAT32) - 1;
337         OPJ_UINT32 i;
338         for     (i=0;i<sizeof(OPJ_FLOAT32);++i) {
339                 *(p_buffer++) = *(l_data_ptr--);
340         }
341 }
342
343 /**
344  * Reads some bytes from the given data buffer, this function is used in Big Endian cpus.
345  * @param p_buffer              pointer the data buffer to read data from.
346  * @param p_value               pointer to the value that will store the data.
347  */
348 void opj_read_float_BE(const OPJ_BYTE * p_buffer, OPJ_FLOAT32 * p_value)
349 {
350         OPJ_BYTE * l_data_ptr = ((OPJ_BYTE *) p_value);
351         memcpy(l_data_ptr,p_buffer,sizeof(OPJ_FLOAT32));
352 }
353
354
355 /**
356  * Reads some bytes from the given data buffer, this function is used in Little Endian cpus.
357  * @param p_buffer              pointer the data buffer to read data from.
358  * @param p_value               pointer to the value that will store the data.
359  */
360 void opj_read_float_LE(const OPJ_BYTE * p_buffer, OPJ_FLOAT32 * p_value)
361 {
362         OPJ_BYTE * l_data_ptr = ((OPJ_BYTE *) p_value) + sizeof(OPJ_FLOAT32)-1;
363         OPJ_UINT32 i;
364         for     (i=0;i<sizeof(OPJ_FLOAT32);++i) {
365                 *(l_data_ptr--) = *(p_buffer++);
366         }
367 }
368
369
370 /**
371  * Creates an abstract stream. This function does nothing except allocating memory and initializing the abstract stream.
372  * @return a stream object.
373 */
374 opj_stream_t* OPJ_CALLCONV opj_stream_create(OPJ_UINT32 p_size,opj_bool l_is_input)
375 {
376         opj_stream_private_t * l_stream = 00;
377         l_stream = (opj_stream_private_t*) opj_malloc(sizeof(opj_stream_private_t));
378         if (! l_stream) {
379                 return 00;
380         }
381
382         memset(l_stream,0,sizeof(opj_stream_private_t));
383         l_stream->m_buffer_size = p_size;
384         l_stream->m_stored_data = (OPJ_BYTE *) opj_malloc(p_size);
385         if (! l_stream->m_stored_data) {
386                 opj_free(l_stream);
387                 return 00;
388         }
389
390         l_stream->m_current_data = l_stream->m_stored_data;
391
392         if (l_is_input) {
393                 l_stream->m_status |= opj_stream_e_input;
394                 l_stream->m_opj_skip = opj_stream_read_skip;
395                 l_stream->m_opj_seek = opj_stream_read_seek;
396         }
397         else {
398                 l_stream->m_status |= opj_stream_e_output;
399                 l_stream->m_opj_skip = opj_stream_write_skip;
400                 l_stream->m_opj_seek = opj_stream_write_seek;
401         }
402
403         l_stream->m_read_fn = opj_stream_default_read;
404         l_stream->m_write_fn = opj_stream_default_write;
405         l_stream->m_skip_fn = opj_stream_default_skip;
406         l_stream->m_seek_fn = opj_stream_default_seek;
407
408         return (opj_stream_t *) l_stream;
409 }
410
411 /**
412  * Creates an abstract stream. This function does nothing except allocating memory and initializing the abstract stream.
413  * @return a stream object.
414 */
415 opj_stream_t* OPJ_CALLCONV opj_stream_default_create(opj_bool l_is_input)
416 {
417         return opj_stream_create(J2K_STREAM_CHUNK_SIZE,l_is_input);
418 }
419
420 /**
421  * Destroys a stream created by opj_create_stream. This function does NOT close the abstract stream. If needed the user must
422  * close its own implementation of the stream.
423  */
424 OPJ_API void OPJ_CALLCONV opj_stream_destroy(opj_stream_t* p_stream)
425 {
426         opj_stream_private_t* l_stream = (opj_stream_private_t*) p_stream;
427         if (l_stream) {
428                 opj_free(l_stream->m_stored_data);
429                 l_stream->m_stored_data = 00;
430                 opj_free(l_stream);
431         }
432 }
433
434 /**
435  * Sets the given function to be used as a read function.
436  * @param               p_stream        the stream to modify
437  * @param               p_function      the function to use a read function.
438 */
439 OPJ_API void OPJ_CALLCONV opj_stream_set_read_function(opj_stream_t* p_stream, opj_stream_read_fn p_function)
440 {
441         opj_stream_private_t* l_stream = (opj_stream_private_t*) p_stream;
442
443         if ((!l_stream) || (! (l_stream->m_status & opj_stream_e_input))) {
444                 return;
445         }
446
447         l_stream->m_read_fn = p_function;
448 }
449
450 OPJ_API void OPJ_CALLCONV opj_stream_set_seek_function(opj_stream_t* p_stream, opj_stream_seek_fn p_function)
451 {
452         opj_stream_private_t* l_stream = (opj_stream_private_t*) p_stream;
453         if
454                 (!l_stream)
455         {
456                 return;
457         }
458         l_stream->m_seek_fn = p_function;
459 }
460
461 /**
462  * Sets the given function to be used as a write function.
463  * @param               p_stream        the stream to modify
464  * @param               p_function      the function to use a write function.
465 */
466 OPJ_API void OPJ_CALLCONV opj_stream_set_write_function(opj_stream_t* p_stream, opj_stream_write_fn p_function)
467 {
468         opj_stream_private_t* l_stream = (opj_stream_private_t*) p_stream;
469         if
470                 ((!l_stream )|| (! (l_stream->m_status & opj_stream_e_output)))
471         {
472                 return;
473         }
474         l_stream->m_write_fn = p_function;
475 }
476
477 /**
478  * Sets the given function to be used as a skip function.
479  * @param               p_stream        the stream to modify
480  * @param               p_function      the function to use a skip function.
481 */
482 OPJ_API void OPJ_CALLCONV opj_stream_set_skip_function(opj_stream_t* p_stream, opj_stream_skip_fn p_function)
483 {
484         opj_stream_private_t* l_stream = (opj_stream_private_t*) p_stream;
485         if
486                 (! l_stream)
487         {
488                 return;
489         }
490         l_stream->m_skip_fn = p_function;
491 }
492
493 /**
494  * Sets the given data to be used as a user data for the stream.
495  * @param               p_stream        the stream to modify
496  * @param               p_data          the data to set.
497 */
498 OPJ_API void OPJ_CALLCONV opj_stream_set_user_data(opj_stream_t* p_stream, void * p_data)
499 {
500         opj_stream_private_t* l_stream = (opj_stream_private_t*) p_stream;
501         l_stream->m_user_data = p_data;
502 }
503
504 /**
505  * Sets the given data to be used as a user data for the stream.
506  * @param               p_stream        the stream to modify
507  * @param               p_data          the data to set.
508 */
509 OPJ_API void OPJ_CALLCONV opj_stream_set_user_data_length(opj_stream_t* p_stream, OPJ_UINT32 data_length)
510 {
511         opj_stream_private_t* l_stream = (opj_stream_private_t*) p_stream;
512
513         l_stream->m_user_data_length = data_length;
514 }
515
516 /**
517  * Reads some bytes from the stream.
518  * @param               p_stream        the stream to read data from.
519  * @param               p_buffer        pointer to the data buffer that will receive the data.
520  * @param               p_size          number of bytes to read.
521  * @param               p_event_mgr     the user event manager to be notified of special events.
522  * @return              the number of bytes read, or -1 if an error occured or if the stream is at the end.
523  */
524 OPJ_UINT32 opj_stream_read_data (opj_stream_private_t * p_stream,OPJ_BYTE * p_buffer, OPJ_UINT32 p_size, opj_event_mgr_t * p_event_mgr)
525 {
526         OPJ_UINT32 l_read_nb_bytes = 0;
527         if
528                 (p_stream->m_bytes_in_buffer >= p_size)
529         {
530                 memcpy(p_buffer,p_stream->m_current_data,p_size);
531                 p_stream->m_current_data += p_size;
532                 p_stream->m_bytes_in_buffer -= p_size;
533                 l_read_nb_bytes += p_size;
534                 p_stream->m_byte_offset += p_size;
535                 return l_read_nb_bytes;
536         }
537
538         // we are now in the case when the remaining data if not sufficient
539         if
540                 (p_stream->m_status & opj_stream_e_end)
541         {
542                 l_read_nb_bytes += p_stream->m_bytes_in_buffer;
543                 memcpy(p_buffer,p_stream->m_current_data,p_stream->m_bytes_in_buffer);
544                 p_stream->m_current_data += p_stream->m_bytes_in_buffer;
545                 p_stream->m_byte_offset += p_stream->m_bytes_in_buffer;
546                 p_stream->m_bytes_in_buffer = 0;
547                 return l_read_nb_bytes ? l_read_nb_bytes : -1;
548         }
549
550         // the flag is not set, we copy data and then do an actual read on the stream
551         if
552                 (p_stream->m_bytes_in_buffer)
553         {
554                 l_read_nb_bytes += p_stream->m_bytes_in_buffer;
555                 memcpy(p_buffer,p_stream->m_current_data,p_stream->m_bytes_in_buffer);
556                 p_stream->m_current_data = p_stream->m_stored_data;
557                 p_buffer += p_stream->m_bytes_in_buffer;
558                 p_size -= p_stream->m_bytes_in_buffer;
559                 p_stream->m_byte_offset += p_stream->m_bytes_in_buffer;
560                 p_stream->m_bytes_in_buffer = 0;
561         }
562   else
563   {
564     /* case where we are already at the end of the buffer
565        so reset the m_current_data to point to the start of the
566        stored buffer to get ready to read from disk*/
567     p_stream->m_current_data = p_stream->m_stored_data;
568   }
569
570
571         while(1){
572                 // we should read less than a chunk -> read a chunk
573                 if
574                         (p_size < p_stream->m_buffer_size)
575                 {
576                         // we should do an actual read on the media
577                         p_stream->m_bytes_in_buffer = p_stream->m_read_fn(p_stream->m_stored_data,p_stream->m_buffer_size,p_stream->m_user_data);
578                         if
579                                 (p_stream->m_bytes_in_buffer == -1)
580                         {
581                                 // end of stream
582                                 opj_event_msg_v2(p_event_mgr, EVT_INFO, "Stream reached its end !\n");
583
584                                 p_stream->m_bytes_in_buffer = 0;
585                                 p_stream->m_status |= opj_stream_e_end;
586                                 // end of stream
587                                 return l_read_nb_bytes ? l_read_nb_bytes : -1;
588                         }
589                         else if
590                                 (p_stream->m_bytes_in_buffer < p_size)
591                         {
592                                 // not enough data
593                                 l_read_nb_bytes += p_stream->m_bytes_in_buffer;
594                                 memcpy(p_buffer,p_stream->m_current_data,p_stream->m_bytes_in_buffer);
595                                 p_stream->m_current_data = p_stream->m_stored_data;
596                                 p_buffer += p_stream->m_bytes_in_buffer;
597                                 p_size -= p_stream->m_bytes_in_buffer;
598                                 p_stream->m_byte_offset += p_stream->m_bytes_in_buffer;
599                                 p_stream->m_bytes_in_buffer = 0;
600                         }
601                         else
602                         {
603                                 l_read_nb_bytes += p_size;
604                                 memcpy(p_buffer,p_stream->m_current_data,p_size);
605                                 p_stream->m_current_data += p_size;
606                                 p_stream->m_bytes_in_buffer -= p_size;
607                                 p_stream->m_byte_offset += p_size;
608                                 return l_read_nb_bytes;
609                         }
610                 }
611                 else
612                 {
613                         // direct read on the dest buffer
614                         p_stream->m_bytes_in_buffer = p_stream->m_read_fn(p_buffer,p_size,p_stream->m_user_data);
615                         if
616                                 (p_stream->m_bytes_in_buffer == -1)
617                         {
618                                 // end of stream
619                                 opj_event_msg_v2(p_event_mgr, EVT_INFO, "Stream reached its end !\n");
620
621                                 p_stream->m_bytes_in_buffer = 0;
622                                 p_stream->m_status |= opj_stream_e_end;
623                                 // end of stream
624                                 return l_read_nb_bytes ? l_read_nb_bytes : -1;
625                         }
626                         else if
627                                 (p_stream->m_bytes_in_buffer < p_size)
628                         {
629                                 // not enough data
630                                 l_read_nb_bytes += p_stream->m_bytes_in_buffer;
631                                 p_stream->m_current_data = p_stream->m_stored_data;
632                                 p_buffer += p_stream->m_bytes_in_buffer;
633                                 p_size -= p_stream->m_bytes_in_buffer;
634                                 p_stream->m_byte_offset += p_stream->m_bytes_in_buffer;
635                                 p_stream->m_bytes_in_buffer = 0;
636                         }
637                         else
638                         {
639                                 // we have read the exact size
640                                 l_read_nb_bytes += p_stream->m_bytes_in_buffer;
641                                 p_stream->m_byte_offset += p_stream->m_bytes_in_buffer;
642                                 p_stream->m_current_data = p_stream->m_stored_data;
643                                 p_stream->m_bytes_in_buffer = 0;
644                                 return l_read_nb_bytes;
645                         }
646                 }
647         }
648 }
649
650 /**
651  * Writes some bytes from the stream.
652  * @param               p_stream        the stream to write data to.
653  * @param               p_buffer        pointer to the data buffer holds the data to be writtent.
654  * @param               p_size          number of bytes to write.
655  * @param               p_event_mgr     the user event manager to be notified of special events.
656  * @return              the number of bytes writtent, or -1 if an error occured.
657  */
658 OPJ_UINT32 opj_stream_write_data (opj_stream_private_t * p_stream,const OPJ_BYTE * p_buffer,OPJ_UINT32 p_size, opj_event_mgr_t * p_event_mgr)
659 {
660         OPJ_UINT32 l_remaining_bytes = 0;
661         OPJ_UINT32 l_write_nb_bytes = 0;
662
663         if
664                 (p_stream->m_status & opj_stream_e_error)
665         {
666                 return -1;
667         }
668
669         while(1)
670         {
671                 l_remaining_bytes = p_stream->m_buffer_size - p_stream->m_bytes_in_buffer;
672                 // we have more memory than required
673                 if
674                         (l_remaining_bytes >= p_size)
675                 {
676                         memcpy(p_stream->m_current_data,p_buffer,p_size);
677                         p_stream->m_current_data += p_size;
678                         p_stream->m_bytes_in_buffer += p_size;
679                         l_write_nb_bytes += p_size;
680                         p_stream->m_byte_offset += p_size;
681                         return l_write_nb_bytes;
682                 }
683
684                 // we copy data and then do an actual read on the stream
685                 if
686                         (l_remaining_bytes)
687                 {
688                         l_write_nb_bytes += l_remaining_bytes;
689                         memcpy(p_stream->m_current_data,p_buffer,l_remaining_bytes);
690                         p_stream->m_current_data = p_stream->m_stored_data;
691                         p_buffer += l_remaining_bytes;
692                         p_size -= l_remaining_bytes;
693                         p_stream->m_bytes_in_buffer += l_remaining_bytes;
694                         p_stream->m_byte_offset += l_remaining_bytes;
695                 }
696                 if
697                         (! opj_stream_flush(p_stream, p_event_mgr))
698                 {
699                         return -1;
700                 }
701         }
702
703 }
704
705 /**
706  * Writes the content of the stream buffer to the stream.
707  * @param               p_stream        the stream to write data to.
708  * @param               p_event_mgr     the user event manager to be notified of special events.
709  * @return              the number of bytes written, or -1 if an error occured.
710  */
711 opj_bool opj_stream_flush (opj_stream_private_t * p_stream, opj_event_mgr_t * p_event_mgr)
712 {
713         // the number of bytes written on the media.
714         OPJ_UINT32 l_current_write_nb_bytes = 0;
715         p_stream->m_current_data = p_stream->m_stored_data;
716
717         while
718                 (p_stream->m_bytes_in_buffer)
719         {
720                 // we should do an actual write on the media
721                 l_current_write_nb_bytes = p_stream->m_write_fn(p_stream->m_current_data,p_stream->m_bytes_in_buffer,p_stream->m_user_data);
722                 if
723                         (l_current_write_nb_bytes == -1)
724                 {
725                         p_stream->m_status |= opj_stream_e_error;
726                         opj_event_msg_v2(p_event_mgr, EVT_INFO, "Error on writting stream!\n");
727
728                         return EXIT_FAILURE;
729                 }
730                 p_stream->m_current_data += l_current_write_nb_bytes;
731                 p_stream->m_bytes_in_buffer -= l_current_write_nb_bytes;
732         }
733         p_stream->m_current_data = p_stream->m_stored_data;
734         return EXIT_SUCCESS;
735 }
736
737 /**
738  * Skips a number of bytes from the stream.
739  * @param               p_stream        the stream to skip data from.
740  * @param               p_size          the number of bytes to skip.
741  * @param               p_event_mgr     the user event manager to be notified of special events.
742  * @return              the number of bytes skipped, or -1 if an error occured.
743  */
744 OPJ_SIZE_T opj_stream_read_skip (opj_stream_private_t * p_stream, OPJ_SIZE_T p_size, opj_event_mgr_t * p_event_mgr)
745 {
746         OPJ_SIZE_T l_skip_nb_bytes = 0;
747         OPJ_SIZE_T l_current_skip_nb_bytes = 0;
748
749         if
750                 (p_stream->m_bytes_in_buffer >= p_size)
751         {
752                 p_stream->m_current_data += p_size;
753                 p_stream->m_bytes_in_buffer -= p_size;
754                 l_skip_nb_bytes += p_size;
755                 p_stream->m_byte_offset += l_skip_nb_bytes;
756                 return l_skip_nb_bytes;
757         }
758
759         // we are now in the case when the remaining data if not sufficient
760         if
761                 (p_stream->m_status & opj_stream_e_end)
762         {
763                 l_skip_nb_bytes += p_stream->m_bytes_in_buffer;
764                 p_stream->m_current_data += p_stream->m_bytes_in_buffer;
765                 p_stream->m_bytes_in_buffer = 0;
766                 p_stream->m_byte_offset += l_skip_nb_bytes;
767                 return l_skip_nb_bytes ? l_skip_nb_bytes : (OPJ_SIZE_T) -1;
768         }
769
770         // the flag is not set, we copy data and then do an actual skip on the stream
771         if
772                 (p_stream->m_bytes_in_buffer)
773         {
774                 l_skip_nb_bytes += p_stream->m_bytes_in_buffer;
775                 p_stream->m_current_data = p_stream->m_stored_data;
776                 p_size -= p_stream->m_bytes_in_buffer;
777                 p_stream->m_bytes_in_buffer = 0;
778         }
779
780         while
781                 (p_size > 0)
782         {
783                 // we should do an actual skip on the media
784                 l_current_skip_nb_bytes = p_stream->m_skip_fn(p_size, p_stream->m_user_data);
785                 if
786                         (l_current_skip_nb_bytes == (OPJ_SIZE_T) -1)
787                 {
788                         opj_event_msg_v2(p_event_mgr, EVT_INFO, "Stream reached its end !\n");
789
790                         p_stream->m_status |= opj_stream_e_end;
791                         p_stream->m_byte_offset += l_skip_nb_bytes;
792                         // end if stream
793                         return l_skip_nb_bytes ? l_skip_nb_bytes : (OPJ_SIZE_T) -1;
794                 }
795                 p_size -= l_current_skip_nb_bytes;
796                 l_skip_nb_bytes += l_current_skip_nb_bytes;
797         }
798         p_stream->m_byte_offset += l_skip_nb_bytes;
799         return l_skip_nb_bytes;
800 }
801
802 /**
803  * Skips a number of bytes from the stream.
804  * @param               p_stream        the stream to skip data from.
805  * @param               p_size          the number of bytes to skip.
806  * @param               p_event_mgr     the user event manager to be notified of special events.
807  * @return              the number of bytes skipped, or -1 if an error occured.
808  */
809 OPJ_SIZE_T opj_stream_write_skip (opj_stream_private_t * p_stream, OPJ_SIZE_T p_size, opj_event_mgr_t * p_event_mgr)
810 {
811         opj_bool l_is_written = 0;
812         OPJ_SIZE_T l_current_skip_nb_bytes = 0;
813         OPJ_SIZE_T l_skip_nb_bytes = 0;
814
815         if
816                 (p_stream->m_status & opj_stream_e_error)
817         {
818                 return (OPJ_SIZE_T) -1;
819         }
820
821         // we should flush data
822         l_is_written = opj_stream_flush (p_stream, p_event_mgr);
823         if
824                 (! l_is_written)
825         {
826                 p_stream->m_status |= opj_stream_e_error;
827                 p_stream->m_bytes_in_buffer = 0;
828                 p_stream->m_current_data = p_stream->m_current_data;
829                 return (OPJ_SIZE_T) -1;
830         }
831         // then skip
832
833         while
834                 (p_size > 0)
835         {
836                 // we should do an actual skip on the media
837                 l_current_skip_nb_bytes = p_stream->m_skip_fn(p_size, p_stream->m_user_data);
838                 if
839                         (l_current_skip_nb_bytes == (OPJ_SIZE_T)-1)
840                 {
841                         opj_event_msg_v2(p_event_mgr, EVT_INFO, "Stream error!\n");
842
843                         p_stream->m_status |= opj_stream_e_error;
844                         p_stream->m_byte_offset += l_skip_nb_bytes;
845                         // end if stream
846                         return l_skip_nb_bytes ? l_skip_nb_bytes : (OPJ_SIZE_T)-1;
847                 }
848                 p_size -= l_current_skip_nb_bytes;
849                 l_skip_nb_bytes += l_current_skip_nb_bytes;
850         }
851         p_stream->m_byte_offset += l_skip_nb_bytes;
852         return l_skip_nb_bytes;
853 }
854
855 /**
856  * Tells the byte offset on the stream (similar to ftell).
857  *
858  * @param               p_stream        the stream to get the information from.
859  *
860  * @return              the current position of the stream.
861  */
862 OPJ_SIZE_T opj_stream_tell (const opj_stream_private_t * p_stream)
863 {
864         return p_stream->m_byte_offset;
865 }
866
867
868 /**
869  * Get the number of bytes left before the end of the stream (similar to cio_numbytesleft).
870  *
871  * @param               p_stream        the stream to get the information from.
872  *
873  * @return              Number of bytes left before the end of the stream.
874  */
875 OPJ_SIZE_T opj_stream_get_number_byte_left (const opj_stream_private_t * p_stream)
876 {
877         return p_stream->m_user_data_length ?
878                                 p_stream->m_user_data_length - p_stream->m_byte_offset :
879                                 0;
880 }
881
882 /**
883  * Skips a number of bytes from the stream.
884  * @param               p_stream        the stream to skip data from.
885  * @param               p_size          the number of bytes to skip.
886  * @param               p_event_mgr     the user event manager to be notified of special events.
887  * @return              the number of bytes skipped, or -1 if an error occured.
888  */
889 OPJ_SIZE_T opj_stream_skip (opj_stream_private_t * p_stream, OPJ_SIZE_T p_size, opj_event_mgr_t * p_event_mgr)
890 {
891         return p_stream->m_opj_skip(p_stream,p_size,p_event_mgr);
892 }
893
894
895 /**
896  * Skips a number of bytes from the stream.
897  * @param               p_stream        the stream to skip data from.
898  * @param               p_size          the number of bytes to skip.
899  * @param               p_event_mgr     the user event manager to be notified of special events.
900  * @return              the number of bytes skipped, or -1 if an error occured.
901  */
902 opj_bool opj_stream_read_seek (opj_stream_private_t * p_stream, OPJ_SIZE_T p_size, opj_event_mgr_t * p_event_mgr)
903 {
904         p_stream->m_current_data = p_stream->m_stored_data;
905         p_stream->m_bytes_in_buffer = 0;
906         if
907                 (! p_stream->m_seek_fn(p_size,p_stream->m_user_data))
908         {
909                 p_stream->m_status |= opj_stream_e_end;
910                 return EXIT_FAILURE;
911         }
912         else
913         {
914                 // reset stream status
915                 p_stream->m_status &= (~opj_stream_e_end);
916                 p_stream->m_byte_offset = p_size;
917
918         }
919         return EXIT_SUCCESS;
920 }
921
922 /**
923  * Skips a number of bytes from the stream.
924  * @param               p_stream        the stream to skip data from.
925  * @param               p_size          the number of bytes to skip.
926  * @param               p_event_mgr     the user event manager to be notified of special events.
927  * @return              the number of bytes skipped, or -1 if an error occured.
928  */
929 opj_bool opj_stream_write_seek (opj_stream_private_t * p_stream, OPJ_SIZE_T p_size, opj_event_mgr_t * p_event_mgr)
930 {
931         if
932                 (! opj_stream_flush(p_stream,p_event_mgr))
933         {
934                 p_stream->m_status |= opj_stream_e_error;
935                 return EXIT_FAILURE;
936         }
937
938         p_stream->m_current_data = p_stream->m_stored_data;
939         p_stream->m_bytes_in_buffer = 0;
940
941         if
942                 (! p_stream->m_seek_fn(p_size,p_stream->m_user_data))
943         {
944                 p_stream->m_status |= opj_stream_e_error;
945                 return EXIT_FAILURE;
946         }
947         else
948         {
949                 p_stream->m_byte_offset = p_size;
950         }
951         return EXIT_SUCCESS;
952 }
953
954
955 /**
956  * Seeks a number of bytes from the stream.
957  * @param               p_stream        the stream to skip data from.
958  * @param               p_size          the number of bytes to skip.
959  * @param               p_event_mgr     the user event manager to be notified of special events.
960  * @return              true if the stream is seekable.
961  */
962 opj_bool opj_stream_seek (opj_stream_private_t * p_stream, OPJ_SIZE_T p_size, struct opj_event_mgr * p_event_mgr)
963 {
964         return p_stream->m_opj_seek(p_stream,p_size,p_event_mgr);
965 }
966
967 /**
968  * Tells if the given stream is seekable.
969  */
970 opj_bool opj_stream_has_seek (const opj_stream_private_t * p_stream)
971 {
972         return p_stream->m_seek_fn != opj_stream_default_seek;
973 }
974
975
976
977
978
979 OPJ_UINT32 opj_stream_default_read (void * p_buffer, OPJ_UINT32 p_nb_bytes, void * p_user_data)
980 {
981         return (OPJ_UINT32) -1;
982 }
983 OPJ_UINT32 opj_stream_default_write (void * p_buffer, OPJ_UINT32 p_nb_bytes, void * p_user_data)
984 {
985         return (OPJ_UINT32) -1;
986 }
987 OPJ_SIZE_T opj_stream_default_skip (OPJ_SIZE_T p_nb_bytes, void * p_user_data)
988 {
989         return (OPJ_SIZE_T) -1;
990 }
991
992 opj_bool opj_stream_default_seek (OPJ_SIZE_T p_nb_bytes, void * p_user_data)
993 {
994         return EXIT_FAILURE;
995 }
996
997
998
999