minor change for readability
[openjpeg.git] / jpwl / encoder / libopenjpeg / jp2.h
1 /*
2  * Copyright (c) 2003, Yannick Verschueren
3  * Copyright (c) 2003,  Communications and remote sensing Laboratory, Universite catholique de Louvain, Belgium
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
16  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
19  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
20  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
21  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
22  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
23  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
24  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
25  * POSSIBILITY OF SUCH DAMAGE.
26  */
27 #ifndef __JP2_H
28 #define __JP2_H
29
30 #include "j2k.h"
31
32 typedef struct {
33   int depth;              
34   int sgnd;                
35   int bpcc;
36 } jp2_comps_t;
37
38 typedef struct {
39   unsigned int w;
40   unsigned int h;
41   unsigned int numcomps;
42   unsigned int bpc;
43   unsigned int C;
44   unsigned int UnkC;
45   unsigned int IPR;
46   unsigned int meth;
47   unsigned int approx;
48   unsigned int enumcs;
49   unsigned int precedence;
50   unsigned int brand;
51   unsigned int minversion;
52   unsigned int numcl;
53   unsigned int *cl;
54   jp2_comps_t *comps;
55   j2k_image_t *image;
56 } jp2_struct_t;
57
58 typedef struct {
59   int length;
60   int type;
61   int init_pos;
62 } jp2_box_t;
63
64 /* int jp2_init_stdjp2(jp2_struct_t * jp2_struct, j2k_image_t * img); 
65  *
66  * Create a standard jp2_structure
67  * jp2_struct: the structure you are creating
68  * img: a j2k_image_t wich will help you to create the jp2_structure
69  */
70 int jp2_init_stdjp2(jp2_struct_t * jp2_struct, j2k_image_t * img);
71
72 /* int jp2_write_jp2c(j2k_image_t * img, j2k_cp_t * cp, char *jp2_buffer,
73  *                 char *index);
74  *
75  * Write the jp2c codestream box 
76  * img: the j2k_image that will be compressed
77  * jp2_buffer: the buffer that will recieve the compressed data
78  * index: the name of the index file 
79  */
80 int jp2_write_jp2c(j2k_image_t * img, j2k_cp_t * cp, char *jp2_buffer,
81                    char *index);
82
83
84 /* int jp2_write_jp2h(jp2_struct_t * jp2_struct);
85  *
86  * Write the jp2h header box 
87  * jp2_struct: the jp2 structure you are working with
88  */
89 void jp2_write_jp2h(jp2_struct_t * jp2_struct);
90
91 /* int jp2_read_jp2h(jp2_struct_t * jp2_struct);
92  *
93  * Read the jp2h header box 
94  * jp2_struct: the jp2 structure you are working with
95  */
96 int jp2_read_jp2h(jp2_struct_t * jp2_struct);
97
98 /* int jp2_encode(jp2_struct_t * jp2_struct, j2k_cp_t * cp, char *output,
99  *       char *index);
100  *
101  * Encode a JP2 file
102  * jp2_buffer: the buffer containing the pointer to the image to encode
103  * cp: coding parameters of the image
104  * outbuf: pointer to memory where compressed data will be written
105  * index: the name of the index file 
106  */
107 int jp2_encode(jp2_struct_t * jp2_struct, j2k_cp_t * cp, char *output,
108                char *index);
109
110 /* int jp2_decode(unsigned char *src, int len, jp2_struct_t * jp2_struct,
111  *             j2k_cp_t * cp);
112  *
113  * Decode a JP2 file
114  * src: pointer to memory where compressed data is stored
115  * len: length of src buffer
116  * jp2_struct: the jp2 structure that will be created 
117  * cp: coding parameters of the image
118  */
119 int jp2_decode(unsigned char *src, int len, jp2_struct_t * jp2_struct,
120                j2k_cp_t * cp);
121
122 #endif