doxygen: blender/imbuf tagged.
[blender.git] / source / blender / imbuf / intern / cineon / logImageLib.h
1 /** \file blender/imbuf/intern/cineon/logImageLib.h
2  *  \ingroup imbcineon
3  */
4 /*
5  *       Common library definitions for Cineon and DPX image files.
6  *
7  *       Copyright 1999,2000,2001 David Hodson <hodsond@acm.org>
8  *
9  *       This program is free software; you can redistribute it and/or modify it
10  *       under the terms of the GNU General Public License as published by the Free
11  *       Software Foundation; either version 2 of the License, or (at your option)
12  *       any later version.
13  *
14  *       This program is distributed in the hope that it will be useful, but
15  *       WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
16  *       or FITNESS FOR A PARTICULAR PURPOSE.    See the GNU General Public License
17  *       for more details.
18  *
19  *       You should have received a copy of the GNU General Public License
20  *       along with this program; if not, write to the Free Software
21  *       Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22  *
23  */
24
25 #ifndef _LOG_IMAGE_LIB_H_
26 #define _LOG_IMAGE_LIB_H_
27
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
31
32 /*
33  * Image structure. You don't care what this is.
34  */
35
36 typedef struct _Log_Image_File_t_ LogImageFile;
37
38 /*
39  * Magic numbers for normal and byte-swapped Cineon and Dpx files
40  */
41
42 #define CINEON_FILE_MAGIC 0x802A5FD7
43 #define DPX_FILE_MAGIC 0x53445058
44
45 /*
46  * Image 8 bit <-> 10 bit conversion parameters.
47  */
48
49 typedef struct {
50         float gamma;
51         int blackPoint;
52         int whitePoint;
53         int doLogarithm;
54 } LogImageByteConversionParameters;
55
56 /* int functions return 0 for OK */
57
58 void logImageSetVerbose(int);
59
60 LogImageFile* logImageOpenFromMem(unsigned char *buffer, unsigned int size, int cineon);
61 LogImageFile* logImageOpen(const char* filename, int cineon);
62 int logImageGetSize(const LogImageFile* logImage, int* xsize, int* ysize, int* channels);
63 LogImageFile* logImageCreate(const char* filename, int cineon, int xsize, int ysize, int channels);
64
65 /* get / set header block NYI */
66 int logImageGetHeader(LogImageFile*, int*, void**);
67 int logImageSetHeader(LogImageFile*, int, void*);
68
69 /* byte conversion routines for mapping logImage (usually) 10 bit values to 8 bit */
70 /* see Kodak docs for details... */
71
72 int logImageGetByteConversionDefaults(LogImageByteConversionParameters* params);
73 int logImageGetByteConversion(const LogImageFile* logImage, LogImageByteConversionParameters* params);
74 int logImageSetByteConversion(LogImageFile* logImage, const LogImageByteConversionParameters* params);
75
76 /* get/set scanline of converted bytes */
77 int logImageGetRowBytes(LogImageFile* logImage, unsigned short* row, int y);
78 int logImageSetRowBytes(LogImageFile* logImage, const unsigned short* row, int y);
79
80 /* closes file and deletes data */
81 void logImageClose(LogImageFile* logImage);
82
83 /* read file and dump header info */
84 void logImageDump(const char* filename);
85
86 #ifdef __cplusplus
87 }
88 #endif
89
90 #endif /* _LOG_IMAGE_LIB_H_ */