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.
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.
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
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.
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.
33 #include "opj_config.h"
41 #include "windirent.h"
50 #define _stricmp strcasecmp
51 #define _strnicmp strncasecmp
55 #include "opj_getopt.h"
59 #include "format_defs.h"
60 #include "opj_string.h"
62 typedef struct dircnt{
63 /** Buffer for holding images read from Directory*/
65 /** Pointer to the buffer*/
70 typedef struct img_folder{
71 /** The directory path of the folder containing input images*/
74 const char *out_format;
77 /** Enable Cod Format for output*/
83 /* -------------------------------------------------------------------------- */
85 static int get_num_images(char *imgdirpath);
86 static int load_images(dircnt_t *dirptr, char *imgdirpath);
87 static int get_file_format(const char *filename);
88 static char get_next_file(int imageno,dircnt_t *dirptr,img_fol_t *img_fol, opj_dparameters_t *parameters);
89 static int infile_format(const char *fname);
91 static int parse_cmdline_decoder(int argc, char **argv, opj_dparameters_t *parameters,img_fol_t *img_fol);
93 /* -------------------------------------------------------------------------- */
94 static void decode_help_display(void) {
95 fprintf(stdout,"\nThis is the opj_dump utility from the OpenJPEG project.\n"
96 "It dumps JPEG 2000 codestream info to stdout or a given file.\n"
97 "It has been compiled against openjp2 library v%s.\n\n",opj_version());
99 fprintf(stdout,"Parameters:\n");
100 fprintf(stdout,"-----------\n");
101 fprintf(stdout,"\n");
102 fprintf(stdout," -ImgDir <directory>\n");
103 fprintf(stdout," Image file Directory path \n");
104 fprintf(stdout," -i <compressed file>\n");
105 fprintf(stdout," REQUIRED only if an Input image directory not specified\n");
106 fprintf(stdout," Currently accepts J2K-files, JP2-files and JPT-files. The file type\n");
107 fprintf(stdout," is identified based on its suffix.\n");
108 fprintf(stdout," -o <output file>\n");
109 fprintf(stdout," OPTIONAL\n");
110 fprintf(stdout," Output file where file info will be dump.\n");
111 fprintf(stdout," By default it will be in the stdout.\n");
112 fprintf(stdout," -v "); /* FIXME WIP_MSD */
113 fprintf(stdout," OPTIONAL\n");
114 fprintf(stdout," Enable informative messages\n");
115 fprintf(stdout," By default verbose mode is off.\n");
116 fprintf(stdout,"\n");
119 /* -------------------------------------------------------------------------- */
120 static int get_num_images(char *imgdirpath){
122 struct dirent* content;
125 /*Reading the input images from given input directory*/
127 dir= opendir(imgdirpath);
129 fprintf(stderr,"Could not open Folder %s\n",imgdirpath);
133 while((content=readdir(dir))!=NULL){
134 if(strcmp(".",content->d_name)==0 || strcmp("..",content->d_name)==0 )
142 /* -------------------------------------------------------------------------- */
143 static int load_images(dircnt_t *dirptr, char *imgdirpath){
145 struct dirent* content;
148 /*Reading the input images from given input directory*/
150 dir= opendir(imgdirpath);
152 fprintf(stderr,"Could not open Folder %s\n",imgdirpath);
155 fprintf(stderr,"Folder opened successfully\n");
158 while((content=readdir(dir))!=NULL){
159 if(strcmp(".",content->d_name)==0 || strcmp("..",content->d_name)==0 )
162 strcpy(dirptr->filename[i],content->d_name);
169 /* -------------------------------------------------------------------------- */
170 static int get_file_format(const char *filename) {
172 static const char *extension[] = {"pgx", "pnm", "pgm", "ppm", "bmp","tif", "raw", "tga", "png", "j2k", "jp2", "jpt", "j2c", "jpc" };
173 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 };
174 const char *ext = strrchr(filename, '.');
179 for(i = 0; i < sizeof(format)/sizeof(*format); i++) {
180 if(_strnicmp(ext, extension[i], 3) == 0) {
189 /* -------------------------------------------------------------------------- */
190 static char get_next_file(int imageno,dircnt_t *dirptr,img_fol_t *img_fol, opj_dparameters_t *parameters){
191 char image_filename[OPJ_PATH_LEN], infilename[OPJ_PATH_LEN],outfilename[OPJ_PATH_LEN],temp_ofname[OPJ_PATH_LEN];
192 char *temp_p, temp1[OPJ_PATH_LEN]="";
194 strcpy(image_filename,dirptr->filename[imageno]);
195 fprintf(stderr,"File Number %d \"%s\"\n",imageno,image_filename);
196 parameters->decod_format = get_file_format(image_filename);
197 if (parameters->decod_format == -1)
199 sprintf(infilename,"%s/%s",img_fol->imgdirpath,image_filename);
200 if (opj_strcpy_s(parameters->infile, sizeof(parameters->infile), infilename) != 0) {
205 strcpy(temp_ofname,strtok(image_filename,"."));
206 while((temp_p = strtok(NULL,".")) != NULL){
207 strcat(temp_ofname,temp1);
208 sprintf(temp1,".%s",temp_p);
210 if(img_fol->set_out_format==1){
211 sprintf(outfilename,"%s/%s.%s",img_fol->imgdirpath,temp_ofname,img_fol->out_format);
212 if (opj_strcpy_s(parameters->outfile, sizeof(parameters->outfile), outfilename) != 0) {
219 /* -------------------------------------------------------------------------- */
220 #define JP2_RFC3745_MAGIC "\x00\x00\x00\x0c\x6a\x50\x20\x20\x0d\x0a\x87\x0a"
221 #define JP2_MAGIC "\x0d\x0a\x87\x0a"
222 /* position 45: "\xff\x52" */
223 #define J2K_CODESTREAM_MAGIC "\xff\x4f\xff\x51"
225 static int infile_format(const char *fname)
228 const char *s, *magic_s;
229 int ext_format, magic_format;
230 unsigned char buf[12];
233 reader = fopen(fname, "rb");
239 l_nb_read = fread(buf, 1, 12, reader);
246 ext_format = get_file_format(fname);
248 if (ext_format == JPT_CFMT)
251 if (memcmp(buf, JP2_RFC3745_MAGIC, 12) == 0 || memcmp(buf, JP2_MAGIC, 4) == 0) {
252 magic_format = JP2_CFMT;
255 else if (memcmp(buf, J2K_CODESTREAM_MAGIC, 4) == 0) {
256 magic_format = J2K_CFMT;
257 magic_s = ".j2k or .jpc or .j2c";
262 if (magic_format == ext_format)
265 s = fname + strlen(fname) - 4;
267 fputs("\n===========================================\n", stderr);
268 fprintf(stderr, "The extension of this file is incorrect.\n"
269 "FOUND %s. SHOULD BE %s\n", s, magic_s);
270 fputs("===========================================\n", stderr);
274 /* -------------------------------------------------------------------------- */
276 * Parse the command line
278 /* -------------------------------------------------------------------------- */
279 static int parse_cmdline_decoder(int argc, char **argv, opj_dparameters_t *parameters,img_fol_t *img_fol) {
281 opj_option_t long_option[]={
282 {"ImgDir",REQ_ARG, NULL ,'y'}
284 const char optlist[] = "i:o:f:hv";
286 totlen=sizeof(long_option);
287 img_fol->set_out_format = 0;
289 c = opj_getopt_long(argc, argv,optlist,long_option,totlen);
293 case 'i': /* input file */
295 char *infile = opj_optarg;
296 parameters->decod_format = infile_format(infile);
297 switch(parameters->decod_format) {
306 "[ERROR] Unknown input file format: %s \n"
307 " Known file formats are *.j2k, *.jp2, *.jpc or *.jpt\n",
311 if (opj_strcpy_s(parameters->infile, sizeof(parameters->infile), infile) != 0) {
312 fprintf(stderr, "[ERROR] Path is too long\n");
318 /* ------------------------------------------------------ */
320 case 'o': /* output file */
322 if (opj_strcpy_s(parameters->outfile, sizeof(parameters->outfile), opj_optarg) != 0) {
323 fprintf(stderr, "[ERROR] Path is too long\n");
329 /* ----------------------------------------------------- */
331 img_fol->flag = atoi(opj_optarg);
333 /* ----------------------------------------------------- */
335 case 'h': /* display an help description */
336 decode_help_display();
339 /* ------------------------------------------------------ */
341 case 'y': /* Image Directory path */
343 img_fol->imgdirpath = (char*)malloc(strlen(opj_optarg) + 1);
344 strcpy(img_fol->imgdirpath,opj_optarg);
345 img_fol->set_imgdir=1;
349 /* ----------------------------------------------------- */
351 case 'v': /* Verbose mode */
353 parameters->m_verbose = 1;
357 /* ----------------------------------------------------- */
359 fprintf(stderr, "[WARNING] An invalid option has been ignored.\n");
364 /* check for possible errors */
365 if(img_fol->set_imgdir==1){
366 if(!(parameters->infile[0]==0)){
367 fprintf(stderr, "[ERROR] options -ImgDir and -i cannot be used together.\n");
370 if(img_fol->set_out_format == 0){
371 fprintf(stderr, "[ERROR] When -ImgDir is used, -OutFor <FORMAT> must be used.\n");
372 fprintf(stderr, "Only one format allowed.\n"
373 "Valid format are PGM, PPM, PNM, PGX, BMP, TIF, RAW and TGA.\n");
376 if(!(parameters->outfile[0] == 0)){
377 fprintf(stderr, "[ERROR] options -ImgDir and -o cannot be used together\n");
381 if(parameters->infile[0] == 0) {
382 fprintf(stderr, "[ERROR] Required parameter is missing\n");
383 fprintf(stderr, "Example: %s -i image.j2k\n",argv[0]);
384 fprintf(stderr, " Help: %s -h\n",argv[0]);
392 /* -------------------------------------------------------------------------- */
395 sample error debug callback expecting no client object
397 static void error_callback(const char *msg, void *client_data) {
399 fprintf(stdout, "[ERROR] %s", msg);
402 sample warning debug callback expecting no client object
404 static void warning_callback(const char *msg, void *client_data) {
406 fprintf(stdout, "[WARNING] %s", msg);
409 sample debug callback expecting no client object
411 static void info_callback(const char *msg, void *client_data) {
413 fprintf(stdout, "[INFO] %s", msg);
416 /* -------------------------------------------------------------------------- */
420 /* -------------------------------------------------------------------------- */
421 int main(int argc, char *argv[])
425 opj_dparameters_t parameters; /* Decompression parameters */
426 opj_image_t* image = NULL; /* Image structure */
427 opj_codec_t* l_codec = NULL; /* Handle to a decompressor */
428 opj_stream_t *l_stream = NULL; /* Stream */
429 opj_codestream_info_v2_t* cstr_info = NULL;
430 opj_codestream_index_t* cstr_index = NULL;
432 OPJ_INT32 num_images, imageno;
434 dircnt_t *dirptr = NULL;
437 OPJ_BOOL l_go_on = OPJ_TRUE;
438 OPJ_UINT32 l_max_data_size = 1000;
439 OPJ_BYTE * l_data = (OPJ_BYTE *) malloc(1000);
442 /* Set decoding parameters to default values */
443 opj_set_default_decoder_parameters(¶meters);
445 /* Initialize img_fol */
446 memset(&img_fol,0,sizeof(img_fol_t));
447 img_fol.flag = OPJ_IMG_INFO | OPJ_J2K_MH_INFO | OPJ_J2K_MH_IND;
449 /* Parse input and get user encoding parameters */
450 if(parse_cmdline_decoder(argc, argv, ¶meters,&img_fol) == 1) {
454 /* Initialize reading of directory */
455 if(img_fol.set_imgdir==1){
457 num_images=get_num_images(img_fol.imgdirpath);
459 dirptr=(dircnt_t*)malloc(sizeof(dircnt_t));
461 dirptr->filename_buf = (char*)malloc((size_t)num_images*OPJ_PATH_LEN*sizeof(char)); /* Stores at max 10 image file names*/
462 dirptr->filename = (char**) malloc((size_t)num_images*sizeof(char*));
464 if(!dirptr->filename_buf){
468 for(it_image=0;it_image<num_images;it_image++){
469 dirptr->filename[it_image] = dirptr->filename_buf + it_image*OPJ_PATH_LEN;
472 if(load_images(dirptr,img_fol.imgdirpath)==1){
477 fprintf(stdout,"Folder is empty\n");
484 /* Try to open for writing the output file if necessary */
485 if (parameters.outfile[0] != 0){
486 fout = fopen(parameters.outfile,"w");
488 fprintf(stderr, "ERROR -> failed to open %s for writing\n", parameters.outfile);
495 /* Read the header of each image one by one */
496 for(imageno = 0; imageno < num_images ; imageno++){
498 fprintf(stderr,"\n");
500 if(img_fol.set_imgdir==1){
501 if (get_next_file(imageno, dirptr,&img_fol, ¶meters)) {
502 fprintf(stderr,"skipping file...\n");
507 /* Read the input file and put it in memory */
508 /* ---------------------------------------- */
510 l_stream = opj_stream_create_default_file_stream(parameters.infile,1);
512 fprintf(stderr, "ERROR -> failed to create the stream from the file %s\n",parameters.infile);
516 /* Read the JPEG2000 stream */
517 /* ------------------------ */
519 switch(parameters.decod_format) {
520 case J2K_CFMT: /* JPEG-2000 codestream */
522 /* Get a decoder handle */
523 l_codec = opj_create_decompress(OPJ_CODEC_J2K);
526 case JP2_CFMT: /* JPEG 2000 compressed image data */
528 /* Get a decoder handle */
529 l_codec = opj_create_decompress(OPJ_CODEC_JP2);
532 case JPT_CFMT: /* JPEG 2000, JPIP */
534 /* Get a decoder handle */
535 l_codec = opj_create_decompress(OPJ_CODEC_JPT);
539 fprintf(stderr, "skipping file..\n");
540 opj_stream_destroy(l_stream);
544 /* catch events using our callbacks and give a local context */
545 opj_set_info_handler(l_codec, info_callback,00);
546 opj_set_warning_handler(l_codec, warning_callback,00);
547 opj_set_error_handler(l_codec, error_callback,00);
549 /* Setup the decoder decoding parameters using user parameters */
550 if ( !opj_setup_decoder(l_codec, ¶meters) ){
551 fprintf(stderr, "ERROR -> opj_dump: failed to setup the decoder\n");
552 opj_stream_destroy(l_stream);
553 opj_destroy_codec(l_codec);
558 /* Read the main header of the codestream and if necessary the JP2 boxes*/
559 if(! opj_read_header(l_stream, l_codec, &image)){
560 fprintf(stderr, "ERROR -> opj_dump: failed to read the header\n");
561 opj_stream_destroy(l_stream);
562 opj_destroy_codec(l_codec);
563 opj_image_destroy(image);
568 opj_dump_codec(l_codec, img_fol.flag, fout );
570 cstr_info = opj_get_cstr_info(l_codec);
572 cstr_index = opj_get_cstr_index(l_codec);
574 /* close the byte stream */
575 opj_stream_destroy(l_stream);
577 /* free remaining structures */
579 opj_destroy_codec(l_codec);
582 /* destroy the image header */
583 opj_image_destroy(image);
585 /* destroy the codestream index */
586 opj_destroy_cstr_index(&cstr_index);
588 /* destroy the codestream info */
589 opj_destroy_cstr_info(&cstr_info);
593 /* Close the output file */