remove deprecated v1 style function opj_decode and opj_decode_with_info
[openjpeg.git] / libopenjpeg / j2k.c
index caa5a781ade61fdb2a0d5e7bf9258549508429ab..a5617372184883a515234a041956bf27b087df63 100644 (file)
@@ -8,7 +8,7 @@
  * Copyright (c) 2008, Jerome Fimes, Communications & Systemes <jerome.fimes@c-s.fr>
  * Copyright (c) 2006-2007, Parvatha Elangovan
  * Copyright (c) 2010-2011, Kaori Hagihara
- * Copyright (c) 2011, Mickael Savinaud, Communications & Systemes <mickael.savinaud@c-s.fr>
+ * Copyright (c) 2011-2012, Mickael Savinaud, Communications & Systemes <mickael.savinaud@c-s.fr>
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -49,23 +49,22 @@ void j2k_setup_header_reading (opj_j2k_v2_t *p_j2k);
 /**
  * The read header procedure.
  */
-opj_bool j2k_read_header_procedure(
-                                                           opj_j2k_v2_t *p_j2k,
-                                                               struct opj_stream_private *p_stream,
-                                                               struct opj_event_mgr * p_manager);
+static opj_bool j2k_read_header_procedure(  opj_j2k_v2_t *p_j2k,
+                                            opj_stream_private_t *p_stream,
+                                            opj_event_mgr_t * p_manager);
 
 /**
  * The default encoding validation procedure without any extension.
  *
  * @param      p_j2k                   the jpeg2000 codec to validate.
- * @param      p_stream                                the input stream to validate.
+ * @param      p_stream                the input stream to validate.
  * @param      p_manager               the user event manager.
  *
  * @return true if the parameters are correct.
  */
-opj_bool j2k_encoding_validation (     opj_j2k_v2_t * p_j2k,
-                                                                       opj_stream_private_t *p_stream,
-                                                                       opj_event_mgr_t * p_manager );
+static opj_bool j2k_encoding_validation (   opj_j2k_v2_t * p_j2k,
+                                            opj_stream_private_t *p_stream,
+                                            opj_event_mgr_t * p_manager );
 
 /**
  * The default decoding validation procedure without any extension.
@@ -76,11 +75,9 @@ opj_bool j2k_encoding_validation (   opj_j2k_v2_t * p_j2k,
  *
  * @return true if the parameters are correct.
  */
-opj_bool j2k_decoding_validation (
-                                                               opj_j2k_v2_t * p_j2k,
-                                                               opj_stream_private_t *p_stream,
-                                                               opj_event_mgr_t * p_manager
-                                                       );
+static opj_bool j2k_decoding_validation (   opj_j2k_v2_t * p_j2k,
+                                            opj_stream_private_t *p_stream,
+                                            opj_event_mgr_t * p_manager );
 
 /**
  * Sets up the validation ,i.e. adds the procedures to lauch to make sure the codec parameters
@@ -109,29 +106,29 @@ static void j2k_setup_end_compress (opj_j2k_v2_t *p_j2k);
  *
  * @return true if the parameters are correct.
  */
-opj_bool j2k_mct_validation (  opj_j2k_v2_t * p_j2k,
-                                                               opj_stream_private_t *p_stream,
-                                                               opj_event_mgr_t * p_manager );
+static opj_bool j2k_mct_validation (opj_j2k_v2_t * p_j2k,
+                                    opj_stream_private_t *p_stream,
+                                    opj_event_mgr_t * p_manager );
 
 /**
  * Builds the tcd decoder to use to decode tile.
  */
-opj_bool j2k_build_decoder (opj_j2k_v2_t * p_j2k,
-                                                       opj_stream_private_t *p_stream,
-                                                       opj_event_mgr_t * p_manager );
+static opj_bool j2k_build_decoder ( opj_j2k_v2_t * p_j2k,
+                                    opj_stream_private_t *p_stream,
+                                    opj_event_mgr_t * p_manager );
 /**
  * Builds the tcd encoder to use to encode tile.
  */
-opj_bool j2k_build_encoder (opj_j2k_v2_t * p_j2k,
-                                                       opj_stream_private_t *p_stream,
-                                                       opj_event_mgr_t * p_manager );
+static opj_bool j2k_build_encoder ( opj_j2k_v2_t * p_j2k,
+                                    opj_stream_private_t *p_stream,
+                                    opj_event_mgr_t * p_manager );
 
 /**
  * Creates a tile-coder decoder.
  *
- * @param      p_stream                                the stream to write data to.
+ * @param      p_stream                        the stream to write data to.
  * @param      p_j2k                           J2K codec.
- * @param      p_manager               the user event manager.
+ * @param      p_manager                   the user event manager.
 */
 static opj_bool j2k_create_tcd(        opj_j2k_v2_t *p_j2k,
                                                                struct opj_stream_private *p_stream,
@@ -141,18 +138,16 @@ static opj_bool j2k_create_tcd(   opj_j2k_v2_t *p_j2k,
  * Excutes the given procedures on the given codec.
  *
  * @param      p_procedure_list        the list of procedures to execute
- * @param      p_j2k                                   the jpeg2000 codec to execute the procedures on.
- * @param      p_stream                                        the stream to execute the procedures on.
+ * @param      p_j2k                           the jpeg2000 codec to execute the procedures on.
+ * @param      p_stream                        the stream to execute the procedures on.
  * @param      p_manager                       the user manager.
  *
  * @return     true                            if all the procedures were successfully executed.
  */
-static opj_bool j2k_exec (
-                                       opj_j2k_v2_t * p_j2k,
-                                       opj_procedure_list_t * p_procedure_list,
-                                       opj_stream_private_t *p_stream,
-                                       opj_event_mgr_t * p_manager
-                                 );
+static opj_bool j2k_exec (  opj_j2k_v2_t * p_j2k,
+                            opj_procedure_list_t * p_procedure_list,
+                            opj_stream_private_t *p_stream,
+                            opj_event_mgr_t * p_manager);
 
 /**
  * Updates the rates of the tcp.
@@ -162,23 +157,23 @@ static opj_bool j2k_exec (
  * @param      p_manager               the user event manager.
 */
 static opj_bool j2k_update_rates(      opj_j2k_v2_t *p_j2k,
-                                                                       struct opj_stream_private *p_stream,
-                                                                       struct opj_event_mgr * p_manager );
+                                                                       opj_stream_private_t *p_stream,
+                                                                       opj_event_mgr_t * p_manager );
 
 /**
  * Copies the decoding tile parameters onto all the tile parameters.
  * Creates also the tile decoder.
  */
-opj_bool j2k_copy_default_tcp_and_create_tcd ( opj_j2k_v2_t * p_j2k,
-                                                                                               opj_stream_private_t *p_stream,
-                                                                                               opj_event_mgr_t * p_manager );
+static opj_bool j2k_copy_default_tcp_and_create_tcd (  opj_j2k_v2_t * p_j2k,
+                                                        opj_stream_private_t *p_stream,
+                                                        opj_event_mgr_t * p_manager );
 
 /**
  * Destroys the memory associated with the decoding of headers.
  */
-opj_bool j2k_destroy_header_memory (opj_j2k_v2_t * p_j2k,
-                                                                       opj_stream_private_t *p_stream,
-                                                                       opj_event_mgr_t * p_manager );
+static opj_bool j2k_destroy_header_memory ( opj_j2k_v2_t * p_j2k,
+                                            opj_stream_private_t *p_stream,
+                                            opj_event_mgr_t * p_manager );
 
 /**
  * Reads the lookup table containing all the marker, status and action, and returns the handler associated
@@ -247,13 +242,11 @@ static OPJ_UINT32 j2k_get_SPCod_SPCoc_size (opj_j2k_v2_t *p_j2k,
  * @param      p_header_size   the size of the data contained in the COM marker.
  * @param      p_manager               the user event manager.
 */
-static opj_bool j2k_read_SPCod_SPCoc(
-                                                       opj_j2k_v2_t *p_j2k,
-                                                       OPJ_UINT32 compno,
-                                                       OPJ_BYTE * p_header_data,
-                                                       OPJ_UINT32 * p_header_size,
-                                                       struct opj_event_mgr * p_manager
-                                                       );
+static opj_bool j2k_read_SPCod_SPCoc(   opj_j2k_v2_t *p_j2k,
+                                        OPJ_UINT32 compno,
+                                        OPJ_BYTE * p_header_data,
+                                        OPJ_UINT32 * p_header_size,
+                                        opj_event_mgr_t * p_manager );
 
 /**
  * Gets the size taken by writing SQcd or SQcc element, i.e. the quantization values of a band in the QCD or QCC.
@@ -284,8 +277,7 @@ static opj_bool j2k_write_SQcd_SQcc(opj_j2k_v2_t *p_j2k,
                                                                        OPJ_UINT32 p_comp_no,
                                                                        OPJ_BYTE * p_data,
                                                                        OPJ_UINT32 * p_header_size,
-                                                                       struct opj_event_mgr * p_manager
-                                                                       );
+                                                                       opj_event_mgr_t * p_manager);
 
 /**
  * Updates the Tile Length Marker.
@@ -303,38 +295,32 @@ static void j2k_update_tlm ( opj_j2k_v2_t * p_j2k, OPJ_UINT32 p_tile_part_size);
  * @param      p_manager               the user event manager.
  *
 */
-static opj_bool j2k_read_SQcd_SQcc(
-                                                       opj_j2k_v2_t *p_j2k,
-                                                       OPJ_UINT32 compno,
-                                                       OPJ_BYTE * p_header_data,
-                                                       OPJ_UINT32 * p_header_size,
-                                                       struct opj_event_mgr * p_manager
-                                       );
+static opj_bool j2k_read_SQcd_SQcc( opj_j2k_v2_t *p_j2k,
+                                    OPJ_UINT32 compno,
+                                    OPJ_BYTE * p_header_data,
+                                    OPJ_UINT32 * p_header_size,
+                                    opj_event_mgr_t * p_manager );
 
 /**
  * Copies the tile component parameters of all the component from the first tile component.
  *
  * @param              p_j2k           the J2k codec.
  */
-static void j2k_copy_tile_component_parameters(
-                                                       opj_j2k_v2_t *p_j2k
-                                                       );
+static void j2k_copy_tile_component_parameters( opj_j2k_v2_t *p_j2k );
 
 /**
  * Copies the tile quantization parameters of all the component from the first tile component.
  *
  * @param              p_j2k           the J2k codec.
  */
-static void j2k_copy_tile_quantization_parameters(
-                                                       opj_j2k_v2_t *p_j2k
-                                                       );
+static void j2k_copy_tile_quantization_parameters( opj_j2k_v2_t *p_j2k );
 
 /**
  * Reads the tiles.
  */
-opj_bool j2k_decode_tiles (    opj_j2k_v2_t *p_j2k,
-                                                       opj_stream_private_t *p_stream,
-                                                       opj_event_mgr_t * p_manager);
+static opj_bool j2k_decode_tiles (     opj_j2k_v2_t *p_j2k,
+                                    opj_stream_private_t *p_stream,
+                                    opj_event_mgr_t * p_manager);
 
 
 static opj_bool j2k_pre_write_tile ( opj_j2k_v2_t * p_j2k,
@@ -356,7 +342,7 @@ static opj_bool j2k_post_write_tile (opj_j2k_v2_t * p_j2k,
  * Sets up the procedures to do on writing header.
  * Developers wanting to extend the library can add their own writing procedures.
  */
-void j2k_setup_header_writting (opj_j2k_v2_t *p_j2k);
+static void j2k_setup_header_writting (opj_j2k_v2_t *p_j2k);
 
 static opj_bool j2k_write_first_tile_part(     opj_j2k_v2_t *p_j2k,
                                                                                        OPJ_BYTE * p_data,
@@ -6326,7 +6312,7 @@ opj_bool j2k_update_rates(        opj_j2k_v2_t *p_j2k,
 
 static void j2k_read_eoc(opj_j2k_t *j2k) {
        int i, tileno;
-       opj_bool success = false;
+       opj_bool success = OPJ_FALSE;
 
        /* if packets should be decoded */
        if (j2k->cp->limit_decoding != DECODE_ALL_BUT_PACKETS) {
@@ -6343,7 +6329,7 @@ static void j2k_read_eoc(opj_j2k_t *j2k) {
                                tcd_free_decode_tile(tcd, i);
                        }
                        else
-                               success = false;
+                               success = OPJ_FALSE;
                        if (success == OPJ_FALSE) {
                                j2k->state |= J2K_STATE_ERR;
                                break;
@@ -8951,6 +8937,10 @@ opj_bool j2k_read_header(        struct opj_stream_private *p_stream,
        /* Copy codestream image information to the output image */
        opj_copy_image_header(p_j2k->m_private_image, *p_image);
 
+    /*Allocate and initialize some elements of codestrem index*/
+       if (!j2k_allocate_tile_element_cstr_index(p_j2k)){
+               return OPJ_FALSE;
+       }
 
        return OPJ_TRUE;
 }
@@ -11260,33 +11250,43 @@ void j2k_dump_MH_index(opj_j2k_v2_t* p_j2k, FILE* out_stream)
 
 
        if (cstr_index->tile_index){
-               fprintf(out_stream, "\t Tile index: {\n");
-
-               for (it_tile=0; it_tile < cstr_index->nb_of_tiles ; it_tile++){
-                       OPJ_UINT32 nb_of_tile_part = cstr_index->tile_index[it_tile].nb_tps;
-
-                       fprintf(out_stream, "\t\t nb of tile-part in tile [%d]=%d\n", it_tile, nb_of_tile_part);
-
-                       if (cstr_index->tile_index[it_tile].tp_index){
-                               for (it_tile_part =0; it_tile_part < nb_of_tile_part; it_tile_part++){
-                                       fprintf(out_stream, "\t\t\t tile-part[%d]: star_pos=%" PRIi64 ", end_header=%" PRIi64 ", end_pos=%" PRIi64 ".\n",
-                                                       it_tile_part,
-                                                       cstr_index->tile_index[it_tile].tp_index[it_tile_part].start_pos,
-                                                       cstr_index->tile_index[it_tile].tp_index[it_tile_part].end_header,
-                                                       cstr_index->tile_index[it_tile].tp_index[it_tile_part].end_pos);
-                               }
-                       }
 
-                       if (cstr_index->tile_index[it_tile].marker){
-                               for (it_marker=0; it_marker < cstr_index->tile_index[it_tile].marknum ; it_marker++){
-                                       fprintf(out_stream, "\t\t type=%#x, pos=%" PRIi64 ", len=%d\n",
-                                                       cstr_index->tile_index[it_tile].marker[it_marker].type,
-                                                       cstr_index->tile_index[it_tile].marker[it_marker].pos,
-                                                       cstr_index->tile_index[it_tile].marker[it_marker].len );
-                               }
-                       }
-               }
-               fprintf(out_stream,"\t }\n");
+        /* Simple test to avoid to write empty information*/
+        OPJ_UINT32 l_acc_nb_of_tile_part = 0;
+        for (it_tile=0; it_tile < cstr_index->nb_of_tiles ; it_tile++){
+                       l_acc_nb_of_tile_part += cstr_index->tile_index[it_tile].nb_tps;
+        }
+
+        if (l_acc_nb_of_tile_part)
+        {
+            fprintf(out_stream, "\t Tile index: {\n");
+       
+                   for (it_tile=0; it_tile < cstr_index->nb_of_tiles ; it_tile++){
+                           OPJ_UINT32 nb_of_tile_part = cstr_index->tile_index[it_tile].nb_tps;
+
+                           fprintf(out_stream, "\t\t nb of tile-part in tile [%d]=%d\n", it_tile, nb_of_tile_part);
+
+                           if (cstr_index->tile_index[it_tile].tp_index){
+                                   for (it_tile_part =0; it_tile_part < nb_of_tile_part; it_tile_part++){
+                                           fprintf(out_stream, "\t\t\t tile-part[%d]: star_pos=%" PRIi64 ", end_header=%" PRIi64 ", end_pos=%" PRIi64 ".\n",
+                                                           it_tile_part,
+                                                           cstr_index->tile_index[it_tile].tp_index[it_tile_part].start_pos,
+                                                           cstr_index->tile_index[it_tile].tp_index[it_tile_part].end_header,
+                                                           cstr_index->tile_index[it_tile].tp_index[it_tile_part].end_pos);
+                                   }
+                           }
+
+                           if (cstr_index->tile_index[it_tile].marker){
+                                   for (it_marker=0; it_marker < cstr_index->tile_index[it_tile].marknum ; it_marker++){
+                                           fprintf(out_stream, "\t\t type=%#x, pos=%" PRIi64 ", len=%d\n",
+                                                           cstr_index->tile_index[it_tile].marker[it_marker].type,
+                                                           cstr_index->tile_index[it_tile].marker[it_marker].pos,
+                                                           cstr_index->tile_index[it_tile].marker[it_marker].len );
+                                   }
+                           }
+                   }
+                   fprintf(out_stream,"\t }\n");
+        }
        }
 
        fprintf(out_stream,"}\n");
@@ -11658,11 +11658,7 @@ opj_bool j2k_decode_tiles (    opj_j2k_v2_t *p_j2k,
        }
        l_max_data_size = 1000;
 
-       /*Allocate and initialize some elements of codestrem index*/
-       if (!j2k_allocate_tile_element_cstr_index(p_j2k)){
-               opj_free(l_current_data);
-               return OPJ_FALSE;
-       }
+
 
        while (OPJ_TRUE) {
                if (! j2k_read_tile_header(     p_j2k,