summaryrefslogtreecommitdiffstats
path: root/src/H5IMimage.h
blob: cc5b0b1595a84d185b76148397f07fea56028231 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204

/****************************************************************************
 * NCSA HDF                                                                 *
 * Scientific Data Technologies                                             *
 * National Center for Supercomputing Applications                          *
 * University of Illinois at Urbana-Champaign                               *
 * 605 E. Springfield, Champaign IL 61820                                   *
 *                                                                          *
 * For conditions of distribution and use, see the accompanying             *
 * hdf/COPYING file.                                                        *
 *                                                                          *
 ****************************************************************************/


#ifndef _H5IMimage_H
#define _H5IMimage_H


#include "H5lite.h"


/* HDF5 image information */
typedef struct H5IM_imageinfo_t 
{
 char     subclass[20];	     /* Image subclass */
 char     color_model[20];   /* Color model  	*/
 char     interlace[20];     /* Interlace mode for 24 bit images */
 int		    white_is_zero;	    /* For grayscale, bitmap images	  */
 int		    minmax[2];	        /* Minimum, maximum value of data	*/
 int		    bkindex;	          /* Index of the background color 	*/
 int		    trindex;	          /* Index of the transparent color 	*/
 int		    aspect_ratio;	     /* Aspect ratio 	*/
 float    gamma_correction;  /* Gamma correction  	*/
 hsize_t		color_planes;	     /* Number of color planes 	*/
} H5IM_imageinfo_t;




/* Default Template identifier for 8bit images */
#define H5IM_8BIT 0

/* Default Template identifier for 24bit images */
#define H5IM_24BIT 1


/* Default struct H5L_imageinfo_t for 8bit images */
static const H5IM_imageinfo_t	H5IM_create_dflt8bit = 
{

 "IMAGE_INDEXED",	         /* Image subclass */
 "RGB",                    /* Color model  	*/
 "NOT_DEFINED",            /* Interlace mode */
 -1,	                      /* white_is_zero	  */
 {-1,-1},	                 /* Minimum, maximum value of data	*/
 -1,	                      /* Index of the background color 	*/
 -1,	                      /* Index of the transparent color 	*/
 -1,	                      /* Aspect ratio 	*/
 -1,                       /* Gamma correction  	*/
  0                        /* Number of color planes 	*/
};


/* Default struct H5L_imageinfo_t for 24bit images */
static const H5IM_imageinfo_t	H5IM_create_dflt24bit = 
{

 "IMAGE_TRUECOLOR",	       /* Image subclass */
 "RGB",                    /* Color model  	*/
 "INTERLACE_PIXEL",        /* Interlace mode */
 -1,	                      /* white_is_zero	  */
 {-1,-1},	                 /* Minimum, maximum value of data	*/
 -1,	                      /* Index of the background color 	*/
 -1,	                      /* Index of the transparent color 	*/
 -1,	                      /* Aspect ratio 	*/
 -1,                       /* Gamma correction  	*/
  3                        /* Number of color planes 	*/
};



herr_t H5IMmake_image( hid_t loc_id, 
                       const char *dset_name, 
                       hsize_t width,
                       hsize_t height,
                       hid_t plist_id,
                       const void *buffer );


herr_t H5IMset_subclass ( hid_t plist_id, const char* str );
herr_t H5IMset_interlace( hid_t plist_id, const char* str );
herr_t H5IMset_color_planes( hid_t plist_id, int n );




/*********************** OLD *****************************/


#if 0

#define H5L_NORANGEINDEX 0
#define H5L_NOMINMAX     0



/* HDF5 image subclass */
typedef enum H5L_imagesc_t
{
  H5L_IMAGE_GRAYSCALE,       
  H5L_IMAGE_BITMAP,
  H5L_IMAGE_TRUECOLOR,
  H5L_IMAGE_INDEXED
} H5L_imagesc_t;



/* HDF5 image/palette color models */
typedef enum H5L_colormodel_t
{
  H5L_MODEL_RGB        = 0,   /*RGB                 */
  H5L_MODEL_YUV        = 1,   /*YUV                 */
  H5L_MODEL_CMY        = 2,   /*CMY                 */
  H5L_MODEL_CMYK       = 3,   /*CMYK                */
  H5L_MODEL_YCBCR      = 4,   /*YCbCr               */
  H5L_MODEL_HSV        = 5,   /*HSV                 */
} H5L_colormodel_t;


/* HDF5 image interlace mode */
typedef enum H5L_interlace_t 
{
  H5L_NOT_DEFINED      = -1,
  H5L_INTERLACE_PIXEL  = 0,   
  H5L_INTERLACE_PLANE  = 1,  
  H5L_INTERLACE_LINE   = 2
} H5L_interlace_t;



/* HDF5 palette types */
typedef enum H5L_palette_t 
{
  H5L_PAL_STANDARD,   
  H5L_PAL_RANGEINDEX  
} H5L_palette_t;





/* HDF5 image information */
typedef struct H5L_imageinfo_t 
{
 H5L_imagesc_t    subclass;	       /* Image subclass */
 H5L_interlace_t  interlace;       /* Interlace mode */
 int		            white_is_zero;	  /* For grayscale, bitmap images	  */
 int		            minmax[2];	      /* Minimum, maximum value of data	*/
 int		            bkindex;	        /* Index of the background color 	*/
 int		            trindex;	        /* Index of the transparent color 	*/
 int		            aspect_ratio;	   /* Aspect ratio 	*/
 H5L_colormodel_t color_model;     /* Color model  	*/
 float            gamma_correction;/* Gamma correction  	*/
} H5L_imageinfo_t;



herr_t H5Lmake_image( hid_t loc_id, 
                        const char *dset_name,
                        const hsize_t *dims,
                        hid_t file_type_id,
                        hid_t mem_type_id,
                        const void *buffer,
                        H5L_imageinfo_t imageinfo );

herr_t H5Lmake_image_indexed( hid_t loc_id, 
                        const char *dset_name,
                        const hsize_t *dims,
                        hid_t file_type_id,
                        hid_t mem_type_id,
                        const void *buffer );

herr_t H5Lmake_image_truecolor( hid_t loc_id, 
                        const char *dset_name,
                        const hsize_t *dims,
                        hid_t file_type_id,
                        hid_t mem_type_id,
                        const void *buffer );

herr_t H5Lattach_palette( hid_t loc_id, 
                        const char *image_name, 
                        const char *pal_name,
                        const hsize_t *pal_dims,
                        hid_t file_type_id,
                        hid_t mem_type_id,
                        const void *pal_data,
                        H5L_colormodel_t color_model,
                        H5L_palette_t palette_t,
                        const char *rangeindex,
                        const void *minmax );

#endif

#endif