]> Creatis software - gdcm.git/blob - src/gdcmjasper/src/libjasper/pnm/pnm_cod.h
ENH: Ok since OJ warnings are not going to be fixed anytime soon remove them
[gdcm.git] / src / gdcmjasper / src / libjasper / pnm / pnm_cod.h
1 /*
2  * Copyright (c) 1999-2000 Image Power, Inc. and the University of
3  *   British Columbia.
4  * Copyright (c) 2001-2002 Michael David Adams.
5  * All rights reserved.
6  */
7
8 /* __START_OF_JASPER_LICENSE__
9  * 
10  * JasPer License Version 2.0
11  * 
12  * Copyright (c) 1999-2000 Image Power, Inc.
13  * Copyright (c) 1999-2000 The University of British Columbia
14  * Copyright (c) 2001-2003 Michael David Adams
15  * 
16  * All rights reserved.
17  * 
18  * Permission is hereby granted, free of charge, to any person (the
19  * "User") obtaining a copy of this software and associated documentation
20  * files (the "Software"), to deal in the Software without restriction,
21  * including without limitation the rights to use, copy, modify, merge,
22  * publish, distribute, and/or sell copies of the Software, and to permit
23  * persons to whom the Software is furnished to do so, subject to the
24  * following conditions:
25  * 
26  * 1.  The above copyright notices and this permission notice (which
27  * includes the disclaimer below) shall be included in all copies or
28  * substantial portions of the Software.
29  * 
30  * 2.  The name of a copyright holder shall not be used to endorse or
31  * promote products derived from the Software without specific prior
32  * written permission.
33  * 
34  * THIS DISCLAIMER OF WARRANTY CONSTITUTES AN ESSENTIAL PART OF THIS
35  * LICENSE.  NO USE OF THE SOFTWARE IS AUTHORIZED HEREUNDER EXCEPT UNDER
36  * THIS DISCLAIMER.  THE SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS
37  * "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
38  * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
39  * PARTICULAR PURPOSE AND NONINFRINGEMENT OF THIRD PARTY RIGHTS.  IN NO
40  * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL
41  * INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING
42  * FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
43  * NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
44  * WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.  NO ASSURANCES ARE
45  * PROVIDED BY THE COPYRIGHT HOLDERS THAT THE SOFTWARE DOES NOT INFRINGE
46  * THE PATENT OR OTHER INTELLECTUAL PROPERTY RIGHTS OF ANY OTHER ENTITY.
47  * EACH COPYRIGHT HOLDER DISCLAIMS ANY LIABILITY TO THE USER FOR CLAIMS
48  * BROUGHT BY ANY OTHER ENTITY BASED ON INFRINGEMENT OF INTELLECTUAL
49  * PROPERTY RIGHTS OR OTHERWISE.  AS A CONDITION TO EXERCISING THE RIGHTS
50  * GRANTED HEREUNDER, EACH USER HEREBY ASSUMES SOLE RESPONSIBILITY TO SECURE
51  * ANY OTHER INTELLECTUAL PROPERTY RIGHTS NEEDED, IF ANY.  THE SOFTWARE
52  * IS NOT FAULT-TOLERANT AND IS NOT INTENDED FOR USE IN MISSION-CRITICAL
53  * SYSTEMS, SUCH AS THOSE USED IN THE OPERATION OF NUCLEAR FACILITIES,
54  * AIRCRAFT NAVIGATION OR COMMUNICATION SYSTEMS, AIR TRAFFIC CONTROL
55  * SYSTEMS, DIRECT LIFE SUPPORT MACHINES, OR WEAPONS SYSTEMS, IN WHICH
56  * THE FAILURE OF THE SOFTWARE OR SYSTEM COULD LEAD DIRECTLY TO DEATH,
57  * PERSONAL INJURY, OR SEVERE PHYSICAL OR ENVIRONMENTAL DAMAGE ("HIGH
58  * RISK ACTIVITIES").  THE COPYRIGHT HOLDERS SPECIFICALLY DISCLAIM ANY
59  * EXPRESS OR IMPLIED WARRANTY OF FITNESS FOR HIGH RISK ACTIVITIES.
60  * 
61  * __END_OF_JASPER_LICENSE__
62  */
63
64 /*
65  * Portable Pixmap/Graymap Format Support
66  *
67  * $Id: pnm_cod.h,v 1.3 2005/06/13 04:04:31 malaterre Exp $
68  */
69
70 #ifndef PNM_COD_H
71 #define PNM_COD_H
72
73 /******************************************************************************\
74 * Includes.
75 \******************************************************************************/
76
77 #include "jasper/jas_types.h"
78
79 /******************************************************************************\
80 * Constants.
81 \******************************************************************************/
82
83 /* Magic numbers. */
84 #define PNM_MAGIC_TXTPBM  0x5031 /* Text Portable BitMap (P1) */
85 #define PNM_MAGIC_TXTPGM  0x5032 /* Text Portable GrayMap (P2) */
86 #define PNM_MAGIC_TXTPPM  0x5033 /* Text Portable PixMap (P3) */
87 #define PNM_MAGIC_BINPBM  0x5034 /* Binary Portable BitMap (P4) */
88 #define PNM_MAGIC_BINPGM  0x5035 /* Binary Portable GrayMap (P5) */
89 #define PNM_MAGIC_BINPPM  0x5036 /* Binary Portable PixMap (P6) */
90 #define  PNM_MAGIC_PAM    0x5037 /* PAM (P7) */
91
92 /* Type of image data. */
93 #define PNM_TYPE_PPM  0 /* PixMap */
94 #define PNM_TYPE_PGM  1 /* GrayMap */
95 #define PNM_TYPE_PBM  2 /* BitMap */
96
97 /* Format of image data. */
98 #define PNM_FMT_TXT  0 /* Text */
99 #define PNM_FMT_BIN  1 /* Binary */
100
101 #define  PNM_MAXLINELEN  79
102
103 #define  PNM_TUPLETYPE_UNKNOWN  0
104 #define  PNM_TUPLETYPE_MONO  1
105 #define  PNM_TUPLETYPE_GRAY  2
106 #define  PNM_TUPLETYPE_GRAYA  3
107 #define  PNM_TUPLETYPE_RGB  4
108 #define  PNM_TUPLETYPE_RGBA  5
109
110 /******************************************************************************\
111 * Types.
112 \******************************************************************************/
113
114 /* File header. */
115
116 typedef struct {
117
118   int magic;
119   /* The magic number. */
120
121   int width;
122   /* The image width. */
123
124   int height;
125   /* The image height. */
126
127   int numcmpts;
128
129   int maxval;
130   /* The maximum allowable sample value. */
131
132 #if 0
133   int tupletype;
134 #endif
135
136   bool sgnd;
137   /* The sample data is signed. */
138
139 } pnm_hdr_t;
140
141 /******************************************************************************\
142 * Functions.
143 \******************************************************************************/
144
145 int pnm_type(uint_fast16_t magic);
146 /* Determine type (i.e., PGM or PPM) from magic number. */
147
148 int pnm_fmt(uint_fast16_t magic);
149 /* Determine format (i.e., text or binary) from magic number. */
150
151 int pnm_maxvaltodepth(uint_fast32_t maxval);
152 /* Determine depth (i.e., precision) from maximum value. */
153
154 #define  PNM_ONES(n) \
155   (((n) < 32) ? ((1UL << (n)) - 1) : 0xffffffffUL)
156 #endif