Creating a BGE staging branch.
[blender-staging.git] / extern / libopenjpeg / jpt.h
1 /*
2  * Copyright (c) 2002-2007, Communications and Remote Sensing Laboratory, Universite catholique de Louvain (UCL), Belgium
3  * Copyright (c) 2002-2007, Professor Benoit Macq
4  * Copyright (c) 2002-2003, Yannick Verschueren
5  * Copyright (c) 2005, Herve Drolon, FreeImage Team
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
18  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
21  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27  * POSSIBILITY OF SUCH DAMAGE.
28  */
29
30 #ifndef __JPT_H
31 #define __JPT_H
32 /**
33 @file jpt.h
34 @brief JPT-stream reader (JPEG 2000, JPIP)
35
36 JPT-stream functions are implemented in J2K.C. 
37 */
38
39 /**
40 Message Header JPT stream structure
41 */
42 typedef struct opj_jpt_msg_header {
43         /** In-class Identifier */
44         unsigned int Id;
45         /** Last byte information */
46         unsigned int last_byte; 
47         /** Class Identifier */
48         unsigned int Class_Id;  
49         /** CSn : index identifier */
50         unsigned int CSn_Id;
51         /** Message offset */
52         unsigned int Msg_offset;
53         /** Message length */
54         unsigned int Msg_length;
55         /** Auxiliary for JPP case */
56         unsigned int Layer_nb;
57 } opj_jpt_msg_header_t;
58
59 /* ----------------------------------------------------------------------- */
60
61 /**
62 Initialize the value of the message header structure 
63 @param header Message header structure
64 */
65 void jpt_init_msg_header(opj_jpt_msg_header_t * header);
66
67 /**
68 Read the message header for a JPP/JPT - stream
69 @param cinfo Codec context info
70 @param cio CIO handle
71 @param header Message header structure
72 */
73 void jpt_read_msg_header(opj_common_ptr cinfo, opj_cio_t *cio, opj_jpt_msg_header_t *header);
74
75 #endif