add documentations
[openjpeg.git] / applications / jpip / tools / test_index.c
1 /*
2  * $Id: test_index.c 46 2011-02-17 14:50:55Z kaori $
3  *
4  * Copyright (c) 2002-2011, Communications and Remote Sensing Laboratory, Universite catholique de Louvain (UCL), Belgium
5  * Copyright (c) 2002-2011, Professor Benoit Macq
6  * Copyright (c) 2010-2011, Kaori Hagihara
7  * All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
19  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
22  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28  * POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 /*! \file
32  *  \brief test_index is a program to test the index code format of a JP2 file
33  *
34  *  \section impinst Implementing instructions
35  *  This program takes one argument, and print out text type index information to the terminal. \n
36  *   -# Input  JP2 file\n
37  *   % ./test_index input.jp2\n
38  */
39
40 #include <stdio.h>
41 #include <sys/types.h>
42 #include <sys/stat.h>
43 #include <fcntl.h>
44 #include <unistd.h>
45 #include <stdlib.h>
46 #include <string.h>
47 #include "index_manager.h"
48
49
50 #ifdef SERVER
51 #include "fcgi_stdio.h"
52 #define logstream FCGI_stdout
53 #else
54 #define FCGI_stdout stdout
55 #define FCGI_stderr stderr
56 #define logstream stderr
57 #endif //SERVER
58
59
60 /**
61  * Open JP2 file with the check of JP2 header
62  *
63  * @param[in] filename file name string
64  * @return             file descriptor
65  */
66 int myopen_jp2file( char filename[]);
67
68
69 int
70 main(int argc, char *argv[])
71 {
72   int fd;
73   index_param_t *jp2idx;
74   
75   if((fd = myopen_jp2file( argv[1])) == -1){
76     fprintf( stderr, "jp2 file open error\n"); 
77     return -1;
78   }
79
80   if( !(jp2idx = parse_jp2file( fd))){
81     fprintf( FCGI_stdout, "Status: 501\r\n");
82     return -1;
83   }
84   
85   print_index( *jp2idx);
86
87   delete_index( &jp2idx);
88
89   return 0;
90 } /* main */
91
92
93
94 int myopen_jp2file( char filename[])
95 {
96   int fd;
97   char *data;
98
99   if( (fd = open( filename, O_RDONLY)) == -1){
100     fprintf( FCGI_stdout, "Reason: Target %s not found\r\n", filename);
101     return -1;
102   }
103   // Check resource is a JP family file.
104   if( lseek( fd, 0, SEEK_SET)==-1){
105     close(fd);
106     fprintf( FCGI_stdout, "Reason: Target %s broken (lseek error)\r\n", filename);
107     return -1;
108   }
109   
110   data = (char *)malloc( 12); // size of header
111   if( read( fd, data, 12) != 12){
112     free( data);
113     close(fd);
114     fprintf( FCGI_stdout, "Reason: Target %s broken (read error)\r\n", filename);
115     return -1;
116   }
117     
118   if( *data || *(data + 1) || *(data + 2) ||
119       *(data + 3) != 12 || strncmp (data + 4, "jP  \r\n\x87\n", 8)){
120     free( data);
121     close(fd);
122     fprintf( FCGI_stdout, "Reason: No JPEG 2000 Signature box in target %s\r\n", filename);
123     return -1;
124   } 
125   free( data);
126   return fd;
127 }
128