src/bin/jp2/opj_dump.c

   1 /*
   2  * The copyright in this software is being made available under the 2-clauses
   3  * BSD License, included below. This software may be subject to other third
   4  * party and contributor rights, including patent rights, and no such rights
   5  * are granted under this license.
   6  *
   7  * Copyright (c) 2010, Mathieu Malaterre, GDCM
   8  * Copyright (c) 2011-2012, Centre National d'Etudes Spatiales (CNES), France
   9  * Copyright (c) 2012, CS Systemes d'Information, France
  10  * All rights reserved.
  11  *
  12  * Redistribution and use in source and binary forms, with or without
  13  * modification, are permitted provided that the following conditions
  14  * are met:
  15  * 1. Redistributions of source code must retain the above copyright
  16  *    notice, this list of conditions and the following disclaimer.
  17  * 2. Redistributions in binary form must reproduce the above copyright
  18  *    notice, this list of conditions and the following disclaimer in the
  19  *    documentation and/or other materials provided with the distribution.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
  22  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  25  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  26  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  27  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  28  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  29  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  30  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  31  * POSSIBILITY OF SUCH DAMAGE.
  32  */
  33 #include "opj_config.h"
  34
  35 #include <stdio.h>
  36 #include <string.h>
  37 #include <stdlib.h>
  38 #include <math.h>
  39
  40 #ifdef _WIN32
  41 #include "windirent.h"
  42 #else
  43 #include <dirent.h>
  44 #endif /* _WIN32 */
  45
  46 #ifdef _WIN32
  47 #include <windows.h>
  48 #else
  49 #include <strings.h>
  50 #define _stricmp strcasecmp
  51 #define _strnicmp strncasecmp
  52 #endif /* _WIN32 */
  53
  54 #include "openjpeg.h"
  55 #include "opj_getopt.h"
  56 #include "convert.h"
  57 #include "index.h"
  58
  59 #include "format_defs.h"
  60
  61 typedef struct dircnt{
  62         /** Buffer for holding images read from Directory*/
  63         char *filename_buf;
  64         /** Pointer to the buffer*/
  65         char **filename;
  66 }dircnt_t;
  67
  68
  69 typedef struct img_folder{
  70         /** The directory path of the folder containing input images*/
  71         char *imgdirpath;
  72         /** Output format*/
  73         const char *out_format;
  74         /** Enable option*/
  75         char set_imgdir;
  76         /** Enable Cod Format for output*/
  77         char set_out_format;
  78
  79   int flag;
  80 }img_fol_t;
  81
  82 /* -------------------------------------------------------------------------- */
  83 /* Declarations                                                               */
  84 static int get_num_images(char *imgdirpath);
  85 static int load_images(dircnt_t *dirptr, char *imgdirpath);
  86 static int get_file_format(const char *filename);
  87 static char get_next_file(int imageno,dircnt_t *dirptr,img_fol_t *img_fol, opj_dparameters_t *parameters);
  88 static int infile_format(const char *fname);
  89
  90 static int parse_cmdline_decoder(int argc, char **argv, opj_dparameters_t *parameters,img_fol_t *img_fol);
  91
  92 /* -------------------------------------------------------------------------- */
  93 static void decode_help_display(void) {
  94     fprintf(stdout,"\nThis is the opj_dump utility from the OpenJPEG project.\n"
  95             "It dumps JPEG 2000 codestream info to stdout or a given file.\n"
  96             "It has been compiled against openjp2 library v%s.\n\n",opj_version());
  97
  98     fprintf(stdout,"Parameters:\n");
  99     fprintf(stdout,"-----------\n");
 100     fprintf(stdout,"\n");
 101     fprintf(stdout,"  -ImgDir <directory>\n");
 102         fprintf(stdout,"        Image file Directory path \n");
 103         fprintf(stdout,"  -i <compressed file>\n");
 104         fprintf(stdout,"    REQUIRED only if an Input image directory not specified\n");
 105         fprintf(stdout,"    Currently accepts J2K-files, JP2-files and JPT-files. The file type\n");
 106         fprintf(stdout,"    is identified based on its suffix.\n");
 107         fprintf(stdout,"  -o <output file>\n");
 108         fprintf(stdout,"    OPTIONAL\n");
 109         fprintf(stdout,"    Output file where file info will be dump.\n");
 110         fprintf(stdout,"    By default it will be in the stdout.\n");
 111     fprintf(stdout,"  -v "); /* FIXME WIP_MSD */
 112         fprintf(stdout,"    OPTIONAL\n");
 113     fprintf(stdout,"    Enable informative messages\n");
 114     fprintf(stdout,"    By default verbose mode is off.\n");
 115         fprintf(stdout,"\n");
 116 }
 117
 118 /* -------------------------------------------------------------------------- */
 119 static int get_num_images(char *imgdirpath){
 120         DIR *dir;
 121         struct dirent* content;
 122         int num_images = 0;
 123
 124         /*Reading the input images from given input directory*/
 125
 126         dir= opendir(imgdirpath);
 127         if(!dir){
 128                 fprintf(stderr,"Could not open Folder %s\n",imgdirpath);
 129                 return 0;
 130         }
 131
 132         while((content=readdir(dir))!=NULL){
 133                 if(strcmp(".",content->d_name)==0 || strcmp("..",content->d_name)==0 )
 134                         continue;
 135                 num_images++;
 136         }
 137         return num_images;
 138 }
 139
 140 /* -------------------------------------------------------------------------- */
 141 static int load_images(dircnt_t *dirptr, char *imgdirpath){
 142         DIR *dir;
 143         struct dirent* content;
 144         int i = 0;
 145
 146         /*Reading the input images from given input directory*/
 147
 148         dir= opendir(imgdirpath);
 149         if(!dir){
 150                 fprintf(stderr,"Could not open Folder %s\n",imgdirpath);
 151                 return 1;
 152         }else   {
 153                 fprintf(stderr,"Folder opened successfully\n");
 154         }
 155
 156         while((content=readdir(dir))!=NULL){
 157                 if(strcmp(".",content->d_name)==0 || strcmp("..",content->d_name)==0 )
 158                         continue;
 159
 160                 strcpy(dirptr->filename[i],content->d_name);
 161                 i++;
 162         }
 163         return 0;
 164 }
 165
 166 /* -------------------------------------------------------------------------- */
 167 static int get_file_format(const char *filename) {
 168         unsigned int i;
 169         static const char *extension[] = {"pgx", "pnm", "pgm", "ppm", "bmp","tif", "raw", "tga", "png", "j2k", "jp2", "jpt", "j2c", "jpc"  };
 170         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 };
 171         char * ext = strrchr(filename, '.');
 172         if (ext == NULL)
 173                 return -1;
 174         ext++;
 175         if(ext) {
 176                 for(i = 0; i < sizeof(format)/sizeof(*format); i++) {
 177                         if(_strnicmp(ext, extension[i], 3) == 0) {
 178                                 return format[i];
 179                         }
 180                 }
 181         }
 182
 183         return -1;
 184 }
 185
 186 /* -------------------------------------------------------------------------- */
 187 static char get_next_file(int imageno,dircnt_t *dirptr,img_fol_t *img_fol, opj_dparameters_t *parameters){
 188         char image_filename[OPJ_PATH_LEN], infilename[OPJ_PATH_LEN],outfilename[OPJ_PATH_LEN],temp_ofname[OPJ_PATH_LEN];
 189         char *temp_p, temp1[OPJ_PATH_LEN]="";
 190
 191         strcpy(image_filename,dirptr->filename[imageno]);
 192         fprintf(stderr,"File Number %d \"%s\"\n",imageno,image_filename);
 193         parameters->decod_format = get_file_format(image_filename);
 194         if (parameters->decod_format == -1)
 195                 return 1;
 196         sprintf(infilename,"%s/%s",img_fol->imgdirpath,image_filename);
 197         strncpy(parameters->infile, infilename, sizeof(infilename));
 198
 199         /*Set output file*/
 200         strcpy(temp_ofname,strtok(image_filename,"."));
 201         while((temp_p = strtok(NULL,".")) != NULL){
 202                 strcat(temp_ofname,temp1);
 203                 sprintf(temp1,".%s",temp_p);
 204         }
 205         if(img_fol->set_out_format==1){
 206                 sprintf(outfilename,"%s/%s.%s",img_fol->imgdirpath,temp_ofname,img_fol->out_format);
 207                 strncpy(parameters->outfile, outfilename, sizeof(outfilename));
 208         }
 209         return 0;
 210 }
 211
 212 /* -------------------------------------------------------------------------- */
 213 #define JP2_RFC3745_MAGIC "\x00\x00\x00\x0c\x6a\x50\x20\x20\x0d\x0a\x87\x0a"
 214 #define JP2_MAGIC "\x0d\x0a\x87\x0a"
 215 /* position 45: "\xff\x52" */
 216 #define J2K_CODESTREAM_MAGIC "\xff\x4f\xff\x51"
 217
 218 static int infile_format(const char *fname)
 219 {
 220         FILE *reader;
 221         const char *s, *magic_s;
 222         int ext_format, magic_format;
 223         unsigned char buf[12];
 224         size_t l_nb_read;
 225
 226         reader = fopen(fname, "rb");
 227
 228         if (reader == NULL)
 229                 return -1;
 230
 231         memset(buf, 0, 12);
 232         l_nb_read = fread(buf, 1, 12, reader);
 233         fclose(reader);
 234         if (l_nb_read != 12)
 235                 return -1;
 236
 237
 238
 239         ext_format = get_file_format(fname);
 240
 241         if (ext_format == JPT_CFMT)
 242                 return JPT_CFMT;
 243
 244         if (memcmp(buf, JP2_RFC3745_MAGIC, 12) == 0 || memcmp(buf, JP2_MAGIC, 4) == 0) {
 245                 magic_format = JP2_CFMT;
 246                 magic_s = ".jp2";
 247         }
 248         else if (memcmp(buf, J2K_CODESTREAM_MAGIC, 4) == 0) {
 249                 magic_format = J2K_CFMT;
 250                 magic_s = ".j2k or .jpc or .j2c";
 251         }
 252         else
 253                 return -1;
 254
 255         if (magic_format == ext_format)
 256                 return ext_format;
 257
 258         s = fname + strlen(fname) - 4;
 259
 260         fputs("\n===========================================\n", stderr);
 261         fprintf(stderr, "The extension of this file is incorrect.\n"
 262                                         "FOUND %s. SHOULD BE %s\n", s, magic_s);
 263         fputs("===========================================\n", stderr);
 264
 265         return magic_format;
 266 }
 267 /* -------------------------------------------------------------------------- */
 268 /**
 269  * Parse the command line
 270  */
 271 /* -------------------------------------------------------------------------- */
 272 static int parse_cmdline_decoder(int argc, char **argv, opj_dparameters_t *parameters,img_fol_t *img_fol) {
 273         int totlen, c;
 274         opj_option_t long_option[]={
 275         {"ImgDir",REQ_ARG, NULL ,'y'}
 276         };
 277     const char optlist[] = "i:o:f:hv";
 278
 279         totlen=sizeof(long_option);
 280         img_fol->set_out_format = 0;
 281         do {
 282                 c = opj_getopt_long(argc, argv,optlist,long_option,totlen);
 283                 if (c == -1)
 284                         break;
 285                 switch (c) {
 286                         case 'i':                       /* input file */
 287                         {
 288                                 char *infile = opj_optarg;
 289                                 parameters->decod_format = infile_format(infile);
 290                                 switch(parameters->decod_format) {
 291                                         case J2K_CFMT:
 292                                                 break;
 293                                         case JP2_CFMT:
 294                                                 break;
 295                                         case JPT_CFMT:
 296                     break;
 297                 default:
 298                     fprintf(stderr,
 299                             "[ERROR] Unknown input file format: %s \n"
 300                             "        Known file formats are *.j2k, *.jp2, *.jpc or *.jpt\n",
 301                             infile);
 302                     return 1;
 303                                 }
 304                                 strncpy(parameters->infile, infile, sizeof(parameters->infile)-1);
 305                         }
 306                         break;
 307
 308                                 /* ------------------------------------------------------ */
 309
 310                         case 'o':     /* output file */
 311                         {
 312                           char *outfile = opj_optarg;
 313                           strncpy(parameters->outfile, outfile, sizeof(parameters->outfile)-1);
 314                         }
 315                         break;
 316
 317                                 /* ----------------------------------------------------- */
 318       case 'f':                         /* flag */
 319         img_fol->flag = atoi(opj_optarg);
 320         break;
 321                                 /* ----------------------------------------------------- */
 322
 323                         case 'h':                       /* display an help description */
 324                                 decode_help_display();
 325                                 return 1;
 326
 327                                 /* ------------------------------------------------------ */
 328
 329                         case 'y':                       /* Image Directory path */
 330                         {
 331                                 img_fol->imgdirpath = (char*)malloc(strlen(opj_optarg) + 1);
 332                                 strcpy(img_fol->imgdirpath,opj_optarg);
 333                                 img_fol->set_imgdir=1;
 334                         }
 335                         break;
 336
 337                         /* ----------------------------------------------------- */
 338
 339             case 'v':                   /* Verbose mode */
 340                         {
 341                 parameters->m_verbose = 1;
 342                         }
 343                         break;
 344
 345                                 /* ----------------------------------------------------- */
 346         default:
 347             fprintf(stderr, "[WARNING] An invalid option has been ignored.\n");
 348             break;
 349         }
 350         }while(c != -1);
 351
 352         /* check for possible errors */
 353         if(img_fol->set_imgdir==1){
 354                 if(!(parameters->infile[0]==0)){
 355             fprintf(stderr, "[ERROR] options -ImgDir and -i cannot be used together.\n");
 356                         return 1;
 357                 }
 358                 if(img_fol->set_out_format == 0){
 359             fprintf(stderr, "[ERROR] When -ImgDir is used, -OutFor <FORMAT> must be used.\n");
 360             fprintf(stderr, "Only one format allowed.\n"
 361                             "Valid format are PGM, PPM, PNM, PGX, BMP, TIF, RAW and TGA.\n");
 362                         return 1;
 363                 }
 364                 if(!(parameters->outfile[0] == 0)){
 365             fprintf(stderr, "[ERROR] options -ImgDir and -o cannot be used together\n");
 366                         return 1;
 367                 }
 368         }else{
 369                 if(parameters->infile[0] == 0) {
 370             fprintf(stderr, "[ERROR] Required parameter is missing\n");
 371                         fprintf(stderr, "Example: %s -i image.j2k\n",argv[0]);
 372             fprintf(stderr, "   Help: %s -h\n",argv[0]);
 373                         return 1;
 374                 }
 375         }
 376
 377         return 0;
 378 }
 379
 380 /* -------------------------------------------------------------------------- */
 381
 382 /**
 383 sample error debug callback expecting no client object
 384 */
 385 static void error_callback(const char *msg, void *client_data) {
 386         (void)client_data;
 387         fprintf(stdout, "[ERROR] %s", msg);
 388 }
 389 /**
 390 sample warning debug callback expecting no client object
 391 */
 392 static void warning_callback(const char *msg, void *client_data) {
 393         (void)client_data;
 394         fprintf(stdout, "[WARNING] %s", msg);
 395 }
 396 /**
 397 sample debug callback expecting no client object
 398 */
 399 static void info_callback(const char *msg, void *client_data) {
 400         (void)client_data;
 401         fprintf(stdout, "[INFO] %s", msg);
 402 }
 403
 404 /* -------------------------------------------------------------------------- */
 405 /**
 406  * OPJ_DUMP MAIN
 407  */
 408 /* -------------------------------------------------------------------------- */
 409 int main(int argc, char *argv[])
 410 {
 411         FILE *fout = NULL;
 412
 413         opj_dparameters_t parameters;                   /* Decompression parameters */
 414         opj_image_t* image = NULL;                                      /* Image structure */
 415         opj_codec_t* l_codec = NULL;                            /* Handle to a decompressor */
 416         opj_stream_t *l_stream = NULL;                          /* Stream */
 417         opj_codestream_info_v2_t* cstr_info = NULL;
 418         opj_codestream_index_t* cstr_index = NULL;
 419
 420         OPJ_INT32 num_images, imageno;
 421         img_fol_t img_fol;
 422         dircnt_t *dirptr = NULL;
 423
 424 #ifdef MSD
 425         OPJ_BOOL l_go_on = OPJ_TRUE;
 426         OPJ_UINT32 l_max_data_size = 1000;
 427         OPJ_BYTE * l_data = (OPJ_BYTE *) malloc(1000);
 428 #endif
 429
 430         /* Set decoding parameters to default values */
 431         opj_set_default_decoder_parameters(&parameters);
 432
 433         /* Initialize img_fol */
 434         memset(&img_fol,0,sizeof(img_fol_t));
 435   img_fol.flag = OPJ_IMG_INFO | OPJ_J2K_MH_INFO | OPJ_J2K_MH_IND;
 436
 437         /* Parse input and get user encoding parameters */
 438         if(parse_cmdline_decoder(argc, argv, &parameters,&img_fol) == 1) {
 439                 return EXIT_FAILURE;
 440         }
 441
 442         /* Initialize reading of directory */
 443         if(img_fol.set_imgdir==1){
 444                 int it_image;
 445                 num_images=get_num_images(img_fol.imgdirpath);
 446
 447                 dirptr=(dircnt_t*)malloc(sizeof(dircnt_t));
 448                 if(dirptr){
 449                         dirptr->filename_buf = (char*)malloc((size_t)num_images*OPJ_PATH_LEN*sizeof(char));     /* Stores at max 10 image file names*/
 450                         dirptr->filename = (char**) malloc((size_t)num_images*sizeof(char*));
 451
 452                         if(!dirptr->filename_buf){
 453                                 return EXIT_FAILURE;
 454                         }
 455
 456                         for(it_image=0;it_image<num_images;it_image++){
 457                                 dirptr->filename[it_image] = dirptr->filename_buf + it_image*OPJ_PATH_LEN;
 458                         }
 459                 }
 460                 if(load_images(dirptr,img_fol.imgdirpath)==1){
 461                         return EXIT_FAILURE;
 462                 }
 463
 464                 if (num_images==0){
 465                         fprintf(stdout,"Folder is empty\n");
 466                         return EXIT_FAILURE;
 467                 }
 468         }else{
 469                 num_images=1;
 470         }
 471
 472         /* Try to open for writing the output file if necessary */
 473         if (parameters.outfile[0] != 0){
 474                 fout = fopen(parameters.outfile,"w");
 475                 if (!fout){
 476                         fprintf(stderr, "ERROR -> failed to open %s for writing\n", parameters.outfile);
 477                         return EXIT_FAILURE;
 478                 }
 479         }
 480         else
 481                 fout = stdout;
 482
 483         /* Read the header of each image one by one */
 484         for(imageno = 0; imageno < num_images ; imageno++){
 485
 486                 fprintf(stderr,"\n");
 487
 488                 if(img_fol.set_imgdir==1){
 489                         if (get_next_file(imageno, dirptr,&img_fol, &parameters)) {
 490                                 fprintf(stderr,"skipping file...\n");
 491                                 continue;
 492                         }
 493                 }
 494
 495                 /* Read the input file and put it in memory */
 496                 /* ---------------------------------------- */
 497
 498                 l_stream = opj_stream_create_default_file_stream(parameters.infile,1);
 499                 if (!l_stream){
 500                         fprintf(stderr, "ERROR -> failed to create the stream from the file %s\n",parameters.infile);
 501                         return EXIT_FAILURE;
 502                 }
 503
 504                 /* Read the JPEG2000 stream */
 505                 /* ------------------------ */
 506
 507                 switch(parameters.decod_format) {
 508                         case J2K_CFMT:  /* JPEG-2000 codestream */
 509                         {
 510                                 /* Get a decoder handle */
 511                                 l_codec = opj_create_decompress(OPJ_CODEC_J2K);
 512                                 break;
 513                         }
 514                         case JP2_CFMT:  /* JPEG 2000 compressed image data */
 515                         {
 516                                 /* Get a decoder handle */
 517                                 l_codec = opj_create_decompress(OPJ_CODEC_JP2);
 518                                 break;
 519                         }
 520                         case JPT_CFMT:  /* JPEG 2000, JPIP */
 521                         {
 522                                 /* Get a decoder handle */
 523                                 l_codec = opj_create_decompress(OPJ_CODEC_JPT);
 524                                 break;
 525                         }
 526                         default:
 527                                 fprintf(stderr, "skipping file..\n");
 528                                 opj_stream_destroy(l_stream);
 529                                 continue;
 530                 }
 531
 532                 /* catch events using our callbacks and give a local context */
 533                 opj_set_info_handler(l_codec, info_callback,00);
 534                 opj_set_warning_handler(l_codec, warning_callback,00);
 535                 opj_set_error_handler(l_codec, error_callback,00);
 536
 537                 /* Setup the decoder decoding parameters using user parameters */
 538                 if ( !opj_setup_decoder(l_codec, &parameters) ){
 539                         fprintf(stderr, "ERROR -> opj_dump: failed to setup the decoder\n");
 540                         opj_stream_destroy(l_stream);
 541                         opj_destroy_codec(l_codec);
 542                         fclose(fout);
 543                         return EXIT_FAILURE;
 544                 }
 545
 546                 /* Read the main header of the codestream and if necessary the JP2 boxes*/
 547                 if(! opj_read_header(l_stream, l_codec, &image)){
 548                         fprintf(stderr, "ERROR -> opj_dump: failed to read the header\n");
 549                         opj_stream_destroy(l_stream);
 550                         opj_destroy_codec(l_codec);
 551                         opj_image_destroy(image);
 552                         fclose(fout);
 553                         return EXIT_FAILURE;
 554                 }
 555
 556                 opj_dump_codec(l_codec, img_fol.flag, fout );
 557
 558                 cstr_info = opj_get_cstr_info(l_codec);
 559
 560                 cstr_index = opj_get_cstr_index(l_codec);
 561
 562                 /* close the byte stream */
 563                 opj_stream_destroy(l_stream);
 564
 565                 /* free remaining structures */
 566                 if (l_codec) {
 567                         opj_destroy_codec(l_codec);
 568                 }
 569
 570                 /* destroy the image header */
 571                 opj_image_destroy(image);
 572
 573                 /* destroy the codestream index */
 574                 opj_destroy_cstr_index(&cstr_index);
 575
 576                 /* destroy the codestream info */
 577                 opj_destroy_cstr_info(&cstr_info);
 578
 579         }
 580
 581         /* Close the output file */
 582         fclose(fout);
 583
 584   return EXIT_SUCCESS;
 585 }