Merge pull request #706 from mayeut/issue135
[openjpeg.git] / src / bin / jp2 / opj_dump.c
index 19ed2971f605e69e70f7af2867302083fdc82799..d62eea14f17f38963a0d583c7d4d066e766f2af2 100644 (file)
@@ -1,4 +1,9 @@
 /*
+ * The copyright in this software is being made available under the 2-clauses 
+ * BSD License, included below. This software may be subject to other third 
+ * party and contributor rights, including patent rights, and no such rights
+ * are granted under this license.
+ *
  * Copyright (c) 2010, Mathieu Malaterre, GDCM
  * Copyright (c) 2011-2012, Centre National d'Etudes Spatiales (CNES), France 
  * Copyright (c) 2012, CS Systemes d'Information, France
@@ -52,6 +57,7 @@
 #include "index.h"
 
 #include "format_defs.h"
+#include "opj_string.h"
 
 typedef struct dircnt{
        /** Buffer for holding images read from Directory*/
@@ -71,6 +77,7 @@ typedef struct img_folder{
        /** Enable Cod Format for output*/
        char set_out_format;
 
+  int flag;
 }img_fol_t;
 
 /* -------------------------------------------------------------------------- */
@@ -85,19 +92,14 @@ static int parse_cmdline_decoder(int argc, char **argv, opj_dparameters_t *param
 
 /* -------------------------------------------------------------------------- */
 static void decode_help_display(void) {
-       fprintf(stdout,"HELP for opj_dump\n----\n\n");
-       fprintf(stdout,"- the -h option displays this help information on screen\n\n");
-
-/* UniPG>> */
-       fprintf(stdout,"List of parameters for the JPEG 2000 "
-#ifdef USE_JPWL
-               "+ JPWL "
-#endif /* USE_JPWL */
-               "decoder:\n");
-/* <<UniPG */
-       fprintf(stdout,"\n");
-       fprintf(stdout,"\n");
-       fprintf(stdout,"  -ImgDir \n");
+    fprintf(stdout,"\nThis is the opj_dump utility from the OpenJPEG project.\n"
+            "It dumps JPEG 2000 codestream info to stdout or a given file.\n"
+            "It has been compiled against openjp2 library v%s.\n\n",opj_version());
+
+    fprintf(stdout,"Parameters:\n");
+    fprintf(stdout,"-----------\n");
+    fprintf(stdout,"\n");
+    fprintf(stdout,"  -ImgDir <directory>\n");
        fprintf(stdout,"        Image file Directory path \n");
        fprintf(stdout,"  -i <compressed file>\n");
        fprintf(stdout,"    REQUIRED only if an Input image directory not specified\n");
@@ -107,10 +109,10 @@ static void decode_help_display(void) {
        fprintf(stdout,"    OPTIONAL\n");
        fprintf(stdout,"    Output file where file info will be dump.\n");
        fprintf(stdout,"    By default it will be in the stdout.\n");
-       fprintf(stdout,"  -v "); /* FIXME WIP_MSD */
+    fprintf(stdout,"  -v "); /* FIXME WIP_MSD */
        fprintf(stdout,"    OPTIONAL\n");
-       fprintf(stdout,"    Activate or not the verbose mode (display info and warning message)\n");
-       fprintf(stdout,"    By default verbose mode is off.\n");
+    fprintf(stdout,"    Enable informative messages\n");
+    fprintf(stdout,"    By default verbose mode is off.\n");
        fprintf(stdout,"\n");
 }
 
@@ -133,6 +135,7 @@ static int get_num_images(char *imgdirpath){
                        continue;
                num_images++;
        }
+       closedir(dir);
        return num_images;
 }
 
@@ -159,6 +162,7 @@ static int load_images(dircnt_t *dirptr, char *imgdirpath){
                strcpy(dirptr->filename[i],content->d_name);
                i++;
        }
+       closedir(dir);
        return 0;       
 }
 
@@ -167,7 +171,7 @@ static int get_file_format(const char *filename) {
        unsigned int i;
        static const char *extension[] = {"pgx", "pnm", "pgm", "ppm", "bmp","tif", "raw", "tga", "png", "j2k", "jp2", "jpt", "j2c", "jpc"  };
        static const int format[] = { PGX_DFMT, PXM_DFMT, PXM_DFMT, PXM_DFMT, BMP_DFMT, TIF_DFMT, RAW_DFMT, TGA_DFMT, PNG_DFMT, J2K_CFMT, JP2_CFMT, JPT_CFMT, J2K_CFMT, J2K_CFMT };
-       char * ext = strrchr(filename, '.');
+       const char *ext = strrchr(filename, '.');
        if (ext == NULL)
                return -1;
        ext++;
@@ -193,7 +197,9 @@ static char get_next_file(int imageno,dircnt_t *dirptr,img_fol_t *img_fol, opj_d
        if (parameters->decod_format == -1)
                return 1;
        sprintf(infilename,"%s/%s",img_fol->imgdirpath,image_filename);
-       strncpy(parameters->infile, infilename, sizeof(infilename));
+       if (opj_strcpy_s(parameters->infile, sizeof(parameters->infile), infilename) != 0) {
+               return 1;
+       }
 
        /*Set output file*/
        strcpy(temp_ofname,strtok(image_filename,"."));
@@ -203,7 +209,9 @@ static char get_next_file(int imageno,dircnt_t *dirptr,img_fol_t *img_fol, opj_d
        }
        if(img_fol->set_out_format==1){
                sprintf(outfilename,"%s/%s.%s",img_fol->imgdirpath,temp_ofname,img_fol->out_format);
-               strncpy(parameters->outfile, outfilename, sizeof(outfilename));
+               if (opj_strcpy_s(parameters->outfile, sizeof(parameters->outfile), outfilename) != 0) {
+                       return 1;
+               }
        }
        return 0;
 }
@@ -271,9 +279,9 @@ static int infile_format(const char *fname)
 static int parse_cmdline_decoder(int argc, char **argv, opj_dparameters_t *parameters,img_fol_t *img_fol) {
        int totlen, c;
        opj_option_t long_option[]={
-               {"ImgDir",REQ_ARG, NULL ,'y'},
+        {"ImgDir",REQ_ARG, NULL ,'y'}
        };
-       const char optlist[] = "i:o:hv";
+    const char optlist[] = "i:o:f:hv";
 
        totlen=sizeof(long_option);
        img_fol->set_out_format = 0;
@@ -292,14 +300,18 @@ static int parse_cmdline_decoder(int argc, char **argv, opj_dparameters_t *param
                                        case JP2_CFMT:
                                                break;
                                        case JPT_CFMT:
-                                               break;
-                                       default:
-                                               fprintf(stderr, 
-                                                       "!! Unrecognized format for infile : %s [accept only *.j2k, *.jp2, *.jpc or *.jpt] !!\n\n", 
-                                                       infile);
-                                               return 1;
+                    break;
+                default:
+                    fprintf(stderr,
+                            "[ERROR] Unknown input file format: %s \n"
+                            "        Known file formats are *.j2k, *.jp2, *.jpc or *.jpt\n",
+                            infile);
+                    return 1;
+                               }
+                               if (opj_strcpy_s(parameters->infile, sizeof(parameters->infile), infile) != 0) {
+                                       fprintf(stderr, "[ERROR] Path is too long\n");
+                                       return 1;
                                }
-                               strncpy(parameters->infile, infile, sizeof(parameters->infile)-1);
                        }
                        break;
 
@@ -307,12 +319,18 @@ static int parse_cmdline_decoder(int argc, char **argv, opj_dparameters_t *param
 
                        case 'o':     /* output file */
                        {
-                         char *outfile = opj_optarg;
-                         strncpy(parameters->outfile, outfile, sizeof(parameters->outfile)-1);
+                               if (opj_strcpy_s(parameters->outfile, sizeof(parameters->outfile), opj_optarg) != 0) {
+                                       fprintf(stderr, "[ERROR] Path is too long\n");
+                                       return 1;
+                               }
                        }
                        break;
                                
                                /* ----------------------------------------------------- */
+      case 'f':                        /* flag */
+        img_fol->flag = atoi(opj_optarg);
+        break;
+                               /* ----------------------------------------------------- */
 
                        case 'h':                       /* display an help description */
                                decode_help_display();
@@ -323,6 +341,9 @@ static int parse_cmdline_decoder(int argc, char **argv, opj_dparameters_t *param
                        case 'y':                       /* Image Directory path */
                        {
                                img_fol->imgdirpath = (char*)malloc(strlen(opj_optarg) + 1);
+                               if(img_fol->imgdirpath == NULL){
+                                       return 1;
+                               }
                                strcpy(img_fol->imgdirpath,opj_optarg);
                                img_fol->set_imgdir=1;
                        }
@@ -330,38 +351,40 @@ static int parse_cmdline_decoder(int argc, char **argv, opj_dparameters_t *param
 
                        /* ----------------------------------------------------- */
 
-                       case 'v':               /* Verbose mode */
+            case 'v':                  /* Verbose mode */
                        {
-                               parameters->m_verbose = 1;
+                parameters->m_verbose = 1;
                        }
                        break;
                        
                                /* ----------------------------------------------------- */
-                       default:
-                               fprintf(stderr,"WARNING -> this option is not valid \"-%c %s\"\n",c, opj_optarg);
-                               break;
-               }
+        default:
+            fprintf(stderr, "[WARNING] An invalid option has been ignored.\n");
+            break;
+        }
        }while(c != -1);
 
        /* check for possible errors */
        if(img_fol->set_imgdir==1){
                if(!(parameters->infile[0]==0)){
-                       fprintf(stderr, "Error: options -ImgDir and -i cannot be used together !!\n");
+            fprintf(stderr, "[ERROR] options -ImgDir and -i cannot be used together.\n");
                        return 1;
                }
                if(img_fol->set_out_format == 0){
-                       fprintf(stderr, "Error: When -ImgDir is used, -OutFor <FORMAT> must be used !!\n");
-                       fprintf(stderr, "Only one format allowed! Valid format PGM, PPM, PNM, PGX, BMP, TIF, RAW and TGA!!\n");
+            fprintf(stderr, "[ERROR] When -ImgDir is used, -OutFor <FORMAT> must be used.\n");
+            fprintf(stderr, "Only one format allowed.\n"
+                            "Valid format are PGM, PPM, PNM, PGX, BMP, TIF, RAW and TGA.\n");
                        return 1;
                }
                if(!(parameters->outfile[0] == 0)){
-                       fprintf(stderr, "Error: options -ImgDir and -o cannot be used together !!\n");
+            fprintf(stderr, "[ERROR] options -ImgDir and -o cannot be used together\n");
                        return 1;
                }
        }else{
                if(parameters->infile[0] == 0) {
+            fprintf(stderr, "[ERROR] Required parameter is missing\n");
                        fprintf(stderr, "Example: %s -i image.j2k\n",argv[0]);
-                       fprintf(stderr, "    Try: %s -h\n",argv[0]);
+            fprintf(stderr, "   Help: %s -h\n",argv[0]);
                        return 1;
                }
        }
@@ -413,20 +436,17 @@ int main(int argc, char *argv[])
        img_fol_t img_fol;
        dircnt_t *dirptr = NULL;
 
-#ifdef MSD
-       OPJ_BOOL l_go_on = OPJ_TRUE;
-       OPJ_UINT32 l_max_data_size = 1000;
-       OPJ_BYTE * l_data = (OPJ_BYTE *) malloc(1000);
-#endif
-
        /* Set decoding parameters to default values */
        opj_set_default_decoder_parameters(&parameters);
 
        /* Initialize img_fol */
        memset(&img_fol,0,sizeof(img_fol_t));
+  img_fol.flag = OPJ_IMG_INFO | OPJ_J2K_MH_INFO | OPJ_J2K_MH_IND;
 
        /* Parse input and get user encoding parameters */
        if(parse_cmdline_decoder(argc, argv, &parameters,&img_fol) == 1) {
+               if(img_fol.imgdirpath) free(img_fol.imgdirpath);
+
                return EXIT_FAILURE;
        }
 
@@ -436,25 +456,31 @@ int main(int argc, char *argv[])
                num_images=get_num_images(img_fol.imgdirpath);
 
                dirptr=(dircnt_t*)malloc(sizeof(dircnt_t));
-               if(dirptr){
-                       dirptr->filename_buf = (char*)malloc(num_images*OPJ_PATH_LEN*sizeof(char));     /* Stores at max 10 image file names*/
-                       dirptr->filename = (char**) malloc(num_images*sizeof(char*));
+               if(!dirptr){
+                       return EXIT_FAILURE;
+               }
+               dirptr->filename_buf = (char*)malloc((size_t)num_images*OPJ_PATH_LEN*sizeof(char));     /* Stores at max 10 image file names*/
+               if(!dirptr->filename_buf){
+                       free(dirptr);
+                       return EXIT_FAILURE;
+               }
+               dirptr->filename = (char**) malloc((size_t)num_images*sizeof(char*));
 
-                       if(!dirptr->filename_buf){
-                               return EXIT_FAILURE;
-                       }
+               if(!dirptr->filename){
+                       goto fails;
+               }
 
-                       for(it_image=0;it_image<num_images;it_image++){
-                               dirptr->filename[it_image] = dirptr->filename_buf + it_image*OPJ_PATH_LEN;
-                       }
+               for(it_image=0;it_image<num_images;it_image++){
+                       dirptr->filename[it_image] = dirptr->filename_buf + it_image*OPJ_PATH_LEN;
                }
+               
                if(load_images(dirptr,img_fol.imgdirpath)==1){
-                       return EXIT_FAILURE;
+                       goto fails;
                }
 
                if (num_images==0){
                        fprintf(stdout,"Folder is empty\n");
-                       return EXIT_FAILURE;
+                       goto fails;
                }
        }else{
                num_images=1;
@@ -465,7 +491,7 @@ int main(int argc, char *argv[])
                fout = fopen(parameters.outfile,"w");
                if (!fout){
                        fprintf(stderr, "ERROR -> failed to open %s for writing\n", parameters.outfile);
-                       return EXIT_FAILURE;
+                       goto fails;
                }
        }
        else
@@ -486,10 +512,10 @@ int main(int argc, char *argv[])
                /* Read the input file and put it in memory */
                /* ---------------------------------------- */
 
-               l_stream = opj_stream_create_default_file_stream_v3(parameters.infile,1);
+               l_stream = opj_stream_create_default_file_stream(parameters.infile,1);
                if (!l_stream){
                        fprintf(stderr, "ERROR -> failed to create the stream from the file %s\n",parameters.infile);
-                       return EXIT_FAILURE;
+                       goto fails;
                }
 
                /* Read the JPEG2000 stream */
@@ -516,7 +542,7 @@ int main(int argc, char *argv[])
                        }
                        default:
                                fprintf(stderr, "skipping file..\n");
-                               opj_stream_destroy_v3(l_stream);
+                               opj_stream_destroy(l_stream);
                                continue;
                }
 
@@ -528,30 +554,30 @@ int main(int argc, char *argv[])
                /* Setup the decoder decoding parameters using user parameters */
                if ( !opj_setup_decoder(l_codec, &parameters) ){
                        fprintf(stderr, "ERROR -> opj_dump: failed to setup the decoder\n");
-                       opj_stream_destroy_v3(l_stream);
+                       opj_stream_destroy(l_stream);
                        opj_destroy_codec(l_codec);
                        fclose(fout);
-                       return EXIT_FAILURE;
+                       goto fails;
                }
 
                /* Read the main header of the codestream and if necessary the JP2 boxes*/
                if(! opj_read_header(l_stream, l_codec, &image)){
                        fprintf(stderr, "ERROR -> opj_dump: failed to read the header\n");
-                       opj_stream_destroy_v3(l_stream);
+                       opj_stream_destroy(l_stream);
                        opj_destroy_codec(l_codec);
                        opj_image_destroy(image);
                        fclose(fout);
-                       return EXIT_FAILURE;
+                       goto fails;
                }
 
-               opj_dump_codec(l_codec, OPJ_IMG_INFO | OPJ_J2K_MH_INFO | OPJ_J2K_MH_IND, fout );
+               opj_dump_codec(l_codec, img_fol.flag, fout );
 
                cstr_info = opj_get_cstr_info(l_codec);
 
                cstr_index = opj_get_cstr_index(l_codec);
 
                /* close the byte stream */
-               opj_stream_destroy_v3(l_stream);
+               opj_stream_destroy(l_stream);
 
                /* free remaining structures */
                if (l_codec) {
@@ -573,4 +599,12 @@ int main(int argc, char *argv[])
        fclose(fout);
 
   return EXIT_SUCCESS;
+
+fails:
+       if(dirptr){
+               if(dirptr->filename) free(dirptr->filename);
+               if(dirptr->filename_buf) free(dirptr->filename_buf);
+               free(dirptr);
+       }
+       return EXIT_FAILURE;
 }