70bda45f214ea893450be98a78858c6b29c99c6d
[blender-staging.git] / source / blender / imbuf / intern / gen_dynlibtiff.py
1 #!/usr/bin/env python
2
3 # ***** BEGIN GPL/BL DUAL LICENSE BLOCK *****
4 #
5 # This program is free software; you can redistribute it and/or
6 # modify it under the terms of the GNU General Public License
7 # as published by the Free Software Foundation; either version 2
8 # of the License, or (at your option) any later version. The Blender
9 # Foundation also sells licenses for use in proprietary software under
10 # the Blender License.  See http://www.blender.org/BL/ for information
11 # about this.
12 #
13 # This program is distributed in the hope that it will be useful,
14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 # GNU General Public License for more details.
17 #
18 # You should have received a copy of the GNU General Public License
19 # along with this program; if not, write to the Free Software Foundation,
20 # Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
21 #
22 # Contributor(s): Jonathan Merritt.
23 #
24 # ***** END GPL/BL DUAL LICENSE BLOCK *****
25
26 #
27 # This script generates a C source file and a header file that implement
28 # dynamic loading functionality for libtiff.
29 # If you need to make more functions from libtiff available, then simply add
30 # them to the tiff_functions[] list below.
31 #
32
33
34 FILENAME   = 'dynlibtiff'
35 C_FILENAME = '%s.c' % FILENAME
36 H_FILENAME = '%s.h' % FILENAME
37
38
39 COMMENT = \
40 """/**
41  * Dynamically loaded libtiff support.
42  *
43  * This file is automatically generated by the gen_dynlibtiff.py script.
44  * 
45  * ***** BEGIN GPL/BL DUAL LICENSE BLOCK *****
46  *
47  * This program is free software; you can redistribute it and/or
48  * modify it under the terms of the GNU General Public License
49  * as published by the Free Software Foundation; either version 2
50  * of the License, or (at your option) any later version. The Blender
51  * Foundation also sells licenses for use in proprietary software under
52  * the Blender License.  See http://www.blender.org/BL/ for information
53  * about this.
54  *
55  * This program is distributed in the hope that it will be useful,
56  * but WITHOUT ANY WARRANTY; without even the implied warranty of
57  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
58  * GNU General Public License for more details.
59  *
60  * You should have received a copy of the GNU General Public License
61  * along with this program; if not, write to the Free Software Foundation,
62  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
63  *
64  * Contributor(s): Jonathan Merritt.
65  *
66  * ***** END GPL/BL DUAL LICENSE BLOCK *****
67  */
68  
69 /**
70  * To use the dynamic libtiff support, you must initialize the library using:
71  *      libtiff_init()
72  * This attempts to load libtiff dynamically at runtime.  G.have_libtiff will
73  * be set to indicate whether or not libtiff is available.  If libtiff is
74  * not available, Blender can proceed with no ill effects, provided that
75  * it does not attempt to use any of the libtiff_ functions.  When you're
76  * finished, close the library with:
77  *      libtiff_exit()
78  * These functions are both declared in IMB_imbuf.h
79  *
80  * The functions provided by dyn_libtiff.h are the same as those in the
81  * normal static / shared libtiff, except that they are prefixed by the 
82  * string "libtiff_" to indicate that they belong to a dynamically-loaded 
83  * version.
84  */
85 """
86
87
88 C_EXTRA = \
89 """
90 #include <assert.h>
91 #include <stdio.h>
92 #include <stdlib.h>
93
94 #include "BLI_blenlib.h"
95
96 #include "imbuf.h"
97 #include "imbuf_patch.h"
98 #include "IMB_imbuf.h"
99
100 #include "BKE_global.h"
101 #include "PIL_dynlib.h"
102
103 /*********************
104  * LOCAL DEFINITIONS *
105  *********************/
106 PILdynlib *libtiff = NULL;
107 void  libtiff_loadlibtiff();
108 void* libtiff_findsymbol(char*);
109 int   libtiff_load_symbols();
110
111
112 /**************************
113  * LIBRARY INITIALIZATION *
114  **************************/
115
116 void libtiff_loadlibtiff()
117 {
118         char *filename;
119         libtiff = NULL;
120
121         /* Try to find libtiff in a couple of standard places */
122         libtiff = PIL_dynlib_open("libtiff.so");
123         if (libtiff != NULL)  return;
124         libtiff = PIL_dynlib_open("libtiff.dll");
125         if (libtiff != NULL)  return;
126         libtiff = PIL_dynlib_open("/usr/lib/libtiff.so");
127         if (libtiff != NULL)  return;
128         /* OSX has version specific library */
129         libtiff = PIL_dynlib_open("/usr/lib/libtiff.so.3");
130         if (libtiff != NULL)  return;
131         libtiff = PIL_dynlib_open("/usr/local/lib/libtiff.so");
132         if (libtiff != NULL)  return;
133         /* For solaris */
134         libtiff = PIL_dynlib_open("/usr/openwin/lib/libtiff.so");
135         if (libtiff != NULL)  return;
136
137         filename = getenv("BF_TIFF_LIB");
138         if (filename) libtiff = PIL_dynlib_open(filename);
139 }
140
141 void *libtiff_findsymbol(char *name)
142 {
143         void *symbol = NULL;
144         assert(libtiff != NULL);
145         symbol = PIL_dynlib_find_symbol(libtiff, name);
146         if (symbol == NULL) {
147                 printf("libtiff_findsymbol: error %s\\n",
148                         PIL_dynlib_get_error_as_string(libtiff));
149                 libtiff = NULL;
150                 G.have_libtiff = (0);
151                 return NULL;
152         }
153         return symbol;
154 }
155
156 void libtiff_init()
157 {
158         if (libtiff != NULL) {
159                 printf("libtiff_init: Attempted to load libtiff twice!\\n");
160                 return;
161         }
162         libtiff_loadlibtiff();
163         G.have_libtiff = ((libtiff != NULL) && (libtiff_load_symbols()));
164 }
165
166 void libtiff_exit()
167 {
168         if (libtiff != NULL) {
169                 PIL_dynlib_close(libtiff);
170                 libtiff = NULL;
171         }
172 }
173
174
175 """
176
177
178 class CFun:
179         def __init__(self, name, retType, args):
180                 self.name    = name
181                 self.retType = retType
182                 self.args    = args
183         def getDynamicName(self):
184                 return ('libtiff_%s' % self.name)
185         def getDynamicDecl(self):
186                 argstr = (('%s, '*len(self.args)) % tuple(self.args))[:-2]
187                 return ('%s (*%s)(%s)' % (self.retType, 
188                         self.getDynamicName(), argstr))
189         def getLoadSymbol(self):
190                 dname = self.getDynamicName()
191                 return (
192                 """\t/* Attempt to load %s */
193         %s = libtiff_findsymbol("%s");
194         if (%s == NULL) {
195                 return (0);
196         }\n""" % (self.name, dname, self.name, dname))
197
198
199 # If you need more functions, add them to the list below, based upon entries
200 # in either tiffio.h or tiff.h.
201 tiff_functions = [
202         CFun('TIFFClientOpen', 'TIFF*', ['const char*', 'const char*',
203                 'thandle_t', 'TIFFReadWriteProc', 'TIFFReadWriteProc',
204                 'TIFFSeekProc', 'TIFFCloseProc', 'TIFFSizeProc',
205                 'TIFFMapFileProc', 'TIFFUnmapFileProc']),
206         CFun('TIFFClose', 'void', ['TIFF*']),
207         CFun('TIFFGetField', 'int', ['TIFF*', 'ttag_t', '...']),
208         CFun('TIFFOpen', 'TIFF*', ['const char*', 'const char*']),
209         CFun('TIFFReadRGBAImage', 'int', ['TIFF*', 'uint32', 'uint32',
210                 'uint32*', 'int']),
211         CFun('TIFFSetField', 'int', ['TIFF*', 'ttag_t', '...']),
212         CFun('TIFFWriteEncodedStrip', 'tsize_t', ['TIFF*', 'tstrip_t',
213                 'tdata_t', 'tsize_t']),
214         CFun('_TIFFfree', 'void', ['tdata_t']),
215         CFun('_TIFFmalloc', 'tdata_t', ['tsize_t']),
216 ]
217
218
219 def outputDynCFile(outfile, header_file_name):
220         outfile.write(COMMENT)
221         outfile.write('#include "%s"\n' % header_file_name)
222         outfile.write(C_EXTRA)
223         outfile.write('int libtiff_load_symbols()\n')
224         outfile.write('{\n')
225         for function in tiff_functions:
226                 outfile.write(function.getLoadSymbol())
227         outfile.write('\treturn (1);\n')
228         outfile.write('}\n')
229         outfile.write("""
230         
231 /*******************
232  * SYMBOL POINTERS *
233  *******************/\n\n""")
234         for function in tiff_functions:
235                 outfile.write('%s = NULL;\n' % function.getDynamicDecl())
236
237
238 def outputDynHFile(outfile):
239         outfile.write(COMMENT)
240         outfile.write('#ifndef DYN_LIBTIFF_H\n')
241         outfile.write('#include "tiffio.h"\n')
242         for function in tiff_functions:
243                 outfile.write('extern %s;\n' % function.getDynamicDecl())
244         outfile.write('#endif /* DYN_LIBTIFF_H */\n\n')
245
246
247 if __name__ == '__main__':
248         outfile = file(C_FILENAME, 'w')
249         outputDynCFile(outfile, H_FILENAME)
250         outfile.close()
251         outfile = file(H_FILENAME, 'w')
252         outputDynHFile(outfile)
253         outfile.close()