Cycles / CUDA Kernel compile:
[blender.git] / build_files / scons / tools / btools.py
1 import os
2 import os.path
3 import SCons.Options
4
5 import SCons.Variables
6 try:
7     import subprocess
8 except ImportError:
9     pass
10 import string
11 import glob
12 import shutil
13 import sys
14
15 Variables = SCons.Variables
16 BoolVariable = SCons.Variables.BoolVariable
17
18 def get_version():
19     import re
20
21     fname = os.path.join(os.path.dirname(__file__), "..", "..", "..", "source", "blender", "blenkernel", "BKE_blender.h")
22     ver_base = None
23     ver_char = None
24     ver_cycle = None
25
26     re_ver = re.compile("^#\s*define\s+BLENDER_VERSION\s+([0-9]+)")
27     re_ver_char = re.compile("^#\s*define\s+BLENDER_VERSION_CHAR\s*(\S*)") # optional arg
28     re_ver_cycle = re.compile("^#\s*define\s+BLENDER_VERSION_CYCLE\s*(\S*)") # optional arg
29
30     for l in open(fname, "r"):
31         match = re_ver.match(l)
32         if match:
33             ver = int(match.group(1))
34             ver_base = "%d.%d" % (ver / 100, ver % 100)
35
36         match = re_ver_char.match(l)
37         if match:
38             ver_char = match.group(1)
39             if ver_char == "BLENDER_CHAR_VERSION":
40                 ver_char = ""
41
42         match = re_ver_cycle.match(l)
43         if match:
44             ver_cycle = match.group(1)
45             if ver_cycle == "BLENDER_CYCLE_VERSION":
46                 ver_cycle = ""
47
48         if (ver_base is not None) and (ver_char is not None) and (ver_cycle is not None):
49             # eg '2.56a-beta'
50             if ver_cycle:
51                 ver_display = "%s%s-%s" % (ver_base, ver_char, ver_cycle)
52             else:
53                 ver_display = "%s%s" % (ver_base, ver_char)  # assume release
54
55             return ver_base, ver_display, ver_cycle
56
57     raise Exception("%s: missing version string" % fname)
58
59 def get_revision():
60     build_rev = os.popen('svnversion').read()[:-1] # remove \n
61     if build_rev == '' or build_rev==None: 
62         build_rev = 'UNKNOWN'
63
64     return 'r' + build_rev
65
66
67 # copied from: http://www.scons.org/wiki/AutoconfRecipes
68 def checkEndian():
69     import struct
70     array = struct.pack('cccc', '\x01', '\x02', '\x03', '\x04')
71     i = struct.unpack('i', array)
72     # Little Endian
73     if i == struct.unpack('<i', array):
74         return "little"
75     # Big Endian
76     elif i == struct.unpack('>i', array):
77         return "big"
78     else:
79         raise Exception("cant find endian")
80
81
82 # This is used in creating the local config directories
83 VERSION, VERSION_DISPLAY, VERSION_RELEASE_CYCLE = get_version()
84 REVISION = get_revision()
85 ENDIAN = checkEndian()
86
87
88 def print_arguments(args, bc):
89     if len(args):
90         for k,v in args.iteritems():
91             if type(v)==list:
92                 v = ' '.join(v)
93             print '\t'+bc.OKBLUE+k+bc.ENDC+' = '+bc.OKGREEN + v + bc.ENDC
94     else:
95         print '\t'+bc.WARNING+'No  command-line arguments given'+bc.ENDC
96
97 def validate_arguments(args, bc):
98     opts_list = [
99             'WITH_BF_PYTHON', 'WITH_BF_PYTHON_SAFETY', 'BF_PYTHON', 'BF_PYTHON_VERSION', 'BF_PYTHON_INC', 'BF_PYTHON_BINARY', 'BF_PYTHON_LIB', 'BF_PYTHON_LIBPATH', 'WITH_BF_STATICPYTHON', 'WITH_OSX_STATICPYTHON', 'BF_PYTHON_LIB_STATIC', 'BF_PYTHON_DLL', 'BF_PYTHON_ABI_FLAGS', 
100             'WITH_BF_OPENAL', 'BF_OPENAL', 'BF_OPENAL_INC', 'BF_OPENAL_LIB', 'BF_OPENAL_LIBPATH', 'WITH_BF_STATICOPENAL', 'BF_OPENAL_LIB_STATIC',
101             'WITH_BF_SDL', 'BF_SDL', 'BF_SDL_INC', 'BF_SDL_LIB', 'BF_SDL_LIBPATH',
102             'WITH_BF_JACK', 'BF_JACK', 'BF_JACK_INC', 'BF_JACK_LIB', 'BF_JACK_LIBPATH',
103             'WITH_BF_SNDFILE', 'BF_SNDFILE', 'BF_SNDFILE_INC', 'BF_SNDFILE_LIB', 'BF_SNDFILE_LIBPATH', 'WITH_BF_STATICSNDFILE', 'BF_SNDFILE_LIB_STATIC',
104             'BF_PTHREADS', 'BF_PTHREADS_INC', 'BF_PTHREADS_LIB', 'BF_PTHREADS_LIBPATH',
105             'WITH_BF_OPENEXR', 'BF_OPENEXR', 'BF_OPENEXR_INC', 'BF_OPENEXR_LIB', 'BF_OPENEXR_LIBPATH', 'WITH_BF_STATICOPENEXR', 'BF_OPENEXR_LIB_STATIC',
106             'WITH_BF_DDS', 'WITH_BF_CINEON', 'WITH_BF_HDR',
107             'WITH_BF_FFMPEG', 'BF_FFMPEG_LIB','BF_FFMPEG_EXTRA', 'BF_FFMPEG',  'BF_FFMPEG_INC', 'BF_FFMPEG_DLL',
108             'WITH_BF_STATICFFMPEG', 'BF_FFMPEG_LIB_STATIC',
109             'WITH_BF_OGG', 'BF_OGG', 'BF_OGG_LIB',
110             'WITH_BF_JPEG', 'BF_JPEG', 'BF_JPEG_INC', 'BF_JPEG_LIB', 'BF_JPEG_LIBPATH',
111             'WITH_BF_OPENJPEG', 'BF_OPENJPEG', 'BF_OPENJPEG_INC', 'BF_OPENJPEG_LIB', 'BF_OPENJPEG_LIBPATH',
112             'WITH_BF_REDCODE', 'BF_REDCODE', 'BF_REDCODE_INC', 'BF_REDCODE_LIB', 'BF_REDCODE_LIBPATH',
113             'WITH_BF_PNG', 'BF_PNG', 'BF_PNG_INC', 'BF_PNG_LIB', 'BF_PNG_LIBPATH',
114             'WITH_BF_TIFF', 'BF_TIFF', 'BF_TIFF_INC', 'BF_TIFF_LIB', 'BF_TIFF_LIBPATH', 'WITH_BF_STATICTIFF', 'BF_TIFF_LIB_STATIC',
115             'WITH_BF_ZLIB', 'BF_ZLIB', 'BF_ZLIB_INC', 'BF_ZLIB_LIB', 'BF_ZLIB_LIBPATH', 'WITH_BF_STATICZLIB', 'BF_ZLIB_LIB_STATIC',
116             'WITH_BF_INTERNATIONAL',
117             'BF_GETTEXT', 'BF_GETTEXT_INC', 'BF_GETTEXT_LIB', 'WITH_BF_GETTEXT_STATIC', 'BF_GETTEXT_LIB_STATIC', 'BF_GETTEXT_LIBPATH',
118             'WITH_BF_ICONV', 'BF_ICONV', 'BF_ICONV_INC', 'BF_ICONV_LIB', 'BF_ICONV_LIBPATH',
119             'WITH_BF_GAMEENGINE',
120             'WITH_BF_BULLET', 'BF_BULLET', 'BF_BULLET_INC', 'BF_BULLET_LIB',
121             'WITH_BF_ELTOPO',
122             'BF_WINTAB', 'BF_WINTAB_INC',
123             'BF_FREETYPE', 'BF_FREETYPE_INC', 'BF_FREETYPE_LIB', 'BF_FREETYPE_LIBPATH', 'BF_FREETYPE_LIB_STATIC', 'WITH_BF_FREETYPE_STATIC',
124             'WITH_BF_QUICKTIME', 'BF_QUICKTIME', 'BF_QUICKTIME_INC', 'BF_QUICKTIME_LIB', 'BF_QUICKTIME_LIBPATH',
125             'WITH_BF_FFTW3', 'BF_FFTW3', 'BF_FFTW3_INC', 'BF_FFTW3_LIB', 'BF_FFTW3_LIBPATH', 'WITH_BF_STATICFFTW3', 'BF_FFTW3_LIB_STATIC',
126             'WITH_BF_STATICOPENGL', 'BF_OPENGL', 'BF_OPENGL_INC', 'BF_OPENGL_LIB', 'BF_OPENGL_LIBPATH', 'BF_OPENGL_LIB_STATIC',
127             'WITH_BF_COLLADA', 'BF_COLLADA', 'BF_COLLADA_INC', 'BF_COLLADA_LIB', 'BF_OPENCOLLADA', 'BF_OPENCOLLADA_INC', 'BF_OPENCOLLADA_LIB', 'BF_OPENCOLLADA_LIBPATH', 'BF_PCRE', 'BF_PCRE_LIB', 'BF_PCRE_LIBPATH', 'BF_EXPAT', 'BF_EXPAT_LIB', 'BF_EXPAT_LIBPATH',
128             'WITH_BF_PLAYER',
129             'WITH_BF_NOBLENDER',
130             'WITH_BF_BINRELOC',
131             'WITH_BF_LZO', 'WITH_BF_LZMA',
132             'LCGDIR',
133             'BF_CXX', 'WITH_BF_STATICCXX', 'BF_CXX_LIB_STATIC',
134             'BF_TWEAK_MODE', 'BF_SPLIT_SRC',
135             'WITHOUT_BF_INSTALL',
136             'WITHOUT_BF_PYTHON_INSTALL',
137             'WITHOUT_BF_OVERWRITE_INSTALL',
138             'WITH_BF_OPENMP', 'BF_OPENMP', 'BF_OPENMP_LIBPATH',
139             'WITH_GHOST_COCOA',
140             'WITH_GHOST_SDL',
141             'BF_GHOST_DEBUG',
142             'USE_QTKIT',
143             'BF_FANCY', 'BF_QUIET', 'BF_LINE_OVERWRITE',
144             'BF_X264_CONFIG',
145             'BF_XVIDCORE_CONFIG',
146             'WITH_BF_DOCS',
147             'BF_NUMJOBS',
148             'BF_MSVS',
149             'BF_VERSION',
150             'WITH_BF_RAYOPTIMIZATION',
151             'BF_RAYOPTIMIZATION_SSE_FLAGS',
152             'WITH_BF_FLUID',
153             'WITH_BF_DECIMATE',
154             'WITH_BF_BOOLEAN',
155             'WITH_BF_OCEANSIM',
156             'WITH_BF_CXX_GUARDEDALLOC',
157             'WITH_BF_JEMALLOC', 'WITH_BF_STATICJEMALLOC', 'BF_JEMALLOC', 'BF_JEMALLOC_INC', 'BF_JEMALLOC_LIBPATH', 'BF_JEMALLOC_LIB', 'BF_JEMALLOC_LIB_STATIC',
158             'BUILDBOT_BRANCH',
159             'WITH_BF_3DMOUSE', 'WITH_BF_STATIC3DMOUSE', 'BF_3DMOUSE', 'BF_3DMOUSE_INC', 'BF_3DMOUSE_LIB', 'BF_3DMOUSE_LIBPATH', 'BF_3DMOUSE_LIB_STATIC',
160             'WITH_BF_CYCLES', 'WITH_BF_CYCLES_CUDA_BINARIES' 'BF_CYCLES_CUDA_NVCC', 'BF_CYCLES_CUDA_NVCC', 'WITH_BF_CYCLES_CUDA_THREADED_COMPILE',
161             'WITH_BF_OIIO', 'WITH_BF_STATICOIIO', 'BF_OIIO', 'BF_OIIO_INC', 'BF_OIIO_LIB', 'BF_OIIO_LIB_STATIC', 'BF_OIIO_LIBPATH',
162             'WITH_BF_BOOST', 'WITH_BF_STATICBOOST', 'BF_BOOST', 'BF_BOOST_INC', 'BF_BOOST_LIB', 'BF_BOOST_LIB_STATIC', 'BF_BOOST_LIBPATH'
163             ]
164     
165     # Have options here that scons expects to be lists
166     opts_list_split = [
167             'BF_PYTHON_LINKFLAGS',
168             'BF_OPENGL_LINKFLAGS',
169             'CFLAGS', 'CCFLAGS', 'CXXFLAGS', 'CPPFLAGS',
170             'REL_CFLAGS', 'REL_CCFLAGS', 'REL_CXXFLAGS',
171             'BGE_CXXFLAGS',
172             'BF_PROFILE_CFLAGS', 'BF_PROFILE_CCFLAGS', 'BF_PROFILE_CXXFLAGS', 'BF_PROFILE_LINKFLAGS',
173             'BF_DEBUG_CFLAGS', 'BF_DEBUG_CCFLAGS', 'BF_DEBUG_CXXFLAGS',
174             'C_WARN', 'CC_WARN', 'CXX_WARN',
175             'LLIBS', 'PLATFORM_LINKFLAGS','MACOSX_ARCHITECTURE', 'MACOSX_SDK_CHECK', 'XCODE_CUR_VER',
176     ]
177     
178     
179     arg_list = ['BF_DEBUG', 'BF_QUIET', 'BF_CROSS', 'BF_UPDATE',
180             'BF_INSTALLDIR', 'BF_TOOLSET', 'BF_BINNAME',
181             'BF_BUILDDIR', 'BF_FANCY', 'BF_QUICK', 'BF_PROFILE', 'BF_LINE_OVERWRITE',
182             'BF_BSC', 'BF_CONFIG',
183             'BF_PRIORITYLIST', 'BF_BUILDINFO','CC', 'CXX', 'BF_QUICKDEBUG',
184             'BF_LISTDEBUG', 'LCGDIR', 'BF_X264_CONFIG', 'BF_XVIDCORE_CONFIG',
185             'BF_UNIT_TEST', 'BF_BITNESS']
186
187     okdict = {}
188
189     for k,v in args.iteritems():
190         if (k in opts_list) or (k in arg_list):
191             okdict[k] = v
192         elif k in opts_list_split:
193             okdict[k] = v.split() # "" have already been stripped
194         else:
195             print '\t'+bc.WARNING+'Invalid argument: '+bc.ENDC+k+'='+v
196
197     return okdict
198
199 def print_targets(targs, bc):
200     if len(targs)>0:
201         for t in targs:
202             print '\t'+bc.OKBLUE+t+bc.ENDC
203     else:
204         print '\t'+bc.WARNING+'No targets given, using '+bc.ENDC+bc.OKGREEN+'default'+bc.ENDC
205
206 def validate_targets(targs, bc):
207     valid_list = ['.', 'blender', 'blenderstatic', 'blenderplayer', 'webplugin',
208             'blendernogame', 'blenderstaticnogame', 'blenderlite', 'release',
209             'everything', 'clean', 'install-bin', 'install', 'nsis','buildslave']
210     oklist = []
211     for t in targs:
212         if t in valid_list:
213             oklist.append(t)
214         else:
215             print '\t'+bc.WARNING+'Invalid target: '+bc.ENDC+t
216     return oklist
217
218 class ourSpawn:
219     def ourspawn(self, sh, escape, cmd, args, env):
220         newargs = string.join(args[1:], ' ')
221         cmdline = cmd + " " + newargs
222         startupinfo = subprocess.STARTUPINFO()
223         startupinfo.dwFlags |= subprocess.STARTF_USESHOWWINDOW
224         proc = subprocess.Popen(cmdline, stdin=subprocess.PIPE, stdout=subprocess.PIPE,
225             stderr=subprocess.PIPE, startupinfo=startupinfo, shell = False)
226         data, err = proc.communicate()
227         rv = proc.wait()
228         if rv:
229             print "====="
230             print err
231             print "====="
232         return rv
233
234 def SetupSpawn( env ):
235     buf = ourSpawn()
236     buf.ourenv = env
237     env['SPAWN'] = buf.ourspawn
238
239
240 def read_opts(env, cfg, args):
241     localopts = Variables.Variables(cfg, args)
242     localopts.AddVariables(
243         ('LCGDIR', 'location of cvs lib dir'),
244         ('LIBDIR', 'root dir of libs'),
245         (BoolVariable('WITH_BF_PYTHON', 'Compile with python', True)),
246         (BoolVariable('WITH_BF_PYTHON_SAFETY', 'Internal API error checking to track invalid data to prevent crash on access (at the expense of some effeciency)', False)),
247         ('BF_PYTHON', 'Base path for python', ''),
248         ('BF_PYTHON_VERSION', 'Python version to use', ''),
249         ('BF_PYTHON_INC', 'Include path for Python headers', ''),
250         ('BF_PYTHON_BINARY', 'Path to the Python interpreter', ''),
251         ('BF_PYTHON_LIB', 'Python library', ''),
252         ('BF_PYTHON_DLL', 'Python dll - used on Windows only', ''),
253         ('BF_PYTHON_LIB_STATIC', 'Python static libraries', ''),
254         ('BF_PYTHON_LIBPATH', 'Library path', ''),
255         ('BF_PYTHON_LINKFLAGS', 'Python link flags', ''),
256         (BoolVariable('WITH_BF_STATICPYTHON', 'Staticly link to python', False)),
257         (BoolVariable('WITH_OSX_STATICPYTHON', 'Staticly link to python', True)),
258         ('BF_PYTHON_ABI_FLAGS', 'Python ABI flags (suffix in library version: m, mu, etc)', ''),
259
260         (BoolVariable('WITH_BF_FLUID', 'Build with Fluid simulation (Elbeem)', True)),
261         (BoolVariable('WITH_BF_DECIMATE', 'Build with decimate modifier', True)),
262         (BoolVariable('WITH_BF_BOOLEAN', 'Build with boolean modifier', True)),
263         (BoolVariable('WITH_BF_OCEANSIM', 'Build with ocean simulation', False)),
264         ('BF_PROFILE_FLAGS', 'Profiling compiler flags', ''),
265         (BoolVariable('WITH_BF_OPENAL', 'Use OpenAL if true', False)),
266         ('BF_OPENAL', 'Base path for OpenAL', ''),
267         ('BF_OPENAL_INC', 'Include path for python headers', ''),
268         ('BF_OPENAL_LIB', 'Path to OpenAL library', ''),
269         ('BF_OPENAL_LIB_STATIC', 'Path to OpenAL static library', ''),
270         ('BF_OPENAL_LIBPATH', 'Path to OpenAL library', ''),
271         (BoolVariable('WITH_BF_STATICOPENAL', 'Staticly link to openal', False)),
272
273         (BoolVariable('WITH_BF_SDL', 'Use SDL if true', False)),
274         ('BF_SDL', 'SDL base path', ''),
275         ('BF_SDL_INC', 'SDL include path', ''),
276         ('BF_SDL_LIB', 'SDL library', ''),
277         ('BF_SDL_LIBPATH', 'SDL library path', ''),
278
279         (BoolVariable('WITH_BF_JACK', 'Enable jack support if true', True)),
280         ('BF_JACK', 'jack base path', ''),
281         ('BF_JACK_INC', 'jack include path', ''),
282         ('BF_JACK_LIB', 'jack library', ''),
283         ('BF_JACK_LIBPATH', 'jack library path', ''),
284
285         (BoolVariable('WITH_BF_SNDFILE', 'Enable sndfile support if true', True)),
286         ('BF_SNDFILE', 'sndfile base path', ''),
287         ('BF_SNDFILE_INC', 'sndfile include path', ''),
288         ('BF_SNDFILE_LIB', 'sndfile library', ''),
289         ('BF_SNDFILE_LIB_STATIC', 'Path to sndfile static library', ''),
290         ('BF_SNDFILE_LIBPATH', 'sndfile library path', ''),
291         (BoolVariable('WITH_BF_STATICSNDFILE', 'Staticly link to sndfile', False)),
292
293         ('BF_PTHREADS', 'Pthreads base path', ''),
294         ('BF_PTHREADS_INC', 'Pthreads include path', ''),
295         ('BF_PTHREADS_LIB', 'Pthreads library', ''),
296         ('BF_PTHREADS_LIBPATH', 'Pthreads library path', ''),
297
298         (BoolVariable('WITH_BF_OPENEXR', 'Use OPENEXR if true', True)),
299         (BoolVariable('WITH_BF_STATICOPENEXR', 'Staticly link to OpenEXR', False)),
300         ('BF_OPENEXR', 'OPENEXR base path', ''),
301         ('BF_OPENEXR_INC', 'OPENEXR include path', ''),
302         ('BF_OPENEXR_LIB', 'OPENEXR library', ''),
303         ('BF_OPENEXR_LIBPATH', 'OPENEXR library path', ''),
304         ('BF_OPENEXR_LIB_STATIC', 'OPENEXR static library', ''),
305
306         (BoolVariable('WITH_BF_DDS', 'Support DDS image format if true', True)),
307
308         (BoolVariable('WITH_BF_CINEON', 'Support CINEON and DPX image formats if true', True)),
309
310         (BoolVariable('WITH_BF_HDR', 'Support HDR image formats if true', True)),
311
312         (BoolVariable('WITH_BF_FFMPEG', 'Use FFMPEG if true', False)),
313         ('BF_FFMPEG', 'FFMPEG base path', ''),
314         ('BF_FFMPEG_LIB', 'FFMPEG library', ''),
315         ('BF_FFMPEG_DLL', 'FFMPEG dll libraries to be installed', ''),
316         ('BF_FFMPEG_EXTRA', 'FFMPEG flags that must be preserved', ''),
317
318         ('BF_FFMPEG_INC', 'FFMPEG includes', ''),
319         ('BF_FFMPEG_LIBPATH', 'FFMPEG library path', ''),
320         (BoolVariable('WITH_BF_STATICFFMPEG', 'Use static FFMPEG if true', False)),
321         ('BF_FFMPEG_LIB_STATIC', 'Static FFMPEG libraries', ''),
322         
323         (BoolVariable('WITH_BF_OGG', 'Use OGG, THEORA, VORBIS in FFMPEG if true',
324                     False)),
325         ('BF_OGG', 'OGG base path', ''),
326         ('BF_OGG_LIB', 'OGG library', ''),
327
328         (BoolVariable('WITH_BF_JPEG', 'Use JPEG if true', True)),
329         ('BF_JPEG', 'JPEG base path', ''),
330         ('BF_JPEG_INC', 'JPEG include path', ''),
331         ('BF_JPEG_LIB', 'JPEG library', ''),
332         ('BF_JPEG_LIBPATH', 'JPEG library path', ''),
333
334         (BoolVariable('WITH_BF_OPENJPEG', 'Use OPENJPEG if true', False)),
335         ('BF_OPENJPEG', 'OPENJPEG base path', ''),
336         ('BF_OPENJPEG_INC', 'OPENJPEG include path', ''),
337         ('BF_OPENJPEG_LIB', 'OPENJPEG library', ''),
338         ('BF_OPENJPEG_LIBPATH', 'OPENJPEG library path', ''),
339
340         (BoolVariable('WITH_BF_REDCODE', 'Use REDCODE if true', False)),
341         ('BF_REDCODE', 'REDCODE base path', ''),
342         ('BF_REDCODE_INC', 'REDCODE include path', ''),
343         ('BF_REDCODE_LIB', 'REDCODE library', ''),
344         ('BF_REDCODE_LIBPATH', 'REDCODE library path', ''),
345
346         (BoolVariable('WITH_BF_PNG', 'Use PNG if true', True)),
347         ('BF_PNG', 'PNG base path', ''),
348         ('BF_PNG_INC', 'PNG include path', ''),
349         ('BF_PNG_LIB', 'PNG library', ''),
350         ('BF_PNG_LIBPATH', 'PNG library path', ''),
351
352         (BoolVariable('WITH_BF_TIFF', 'Use TIFF if true', True)),
353         (BoolVariable('WITH_BF_STATICTIFF', 'Staticly link to TIFF', False)),
354         ('BF_TIFF', 'TIFF base path', ''),
355         ('BF_TIFF_INC', 'TIFF include path', ''),
356         ('BF_TIFF_LIB', 'TIFF library', ''),
357         ('BF_TIFF_LIBPATH', 'TIFF library path', ''),
358         ('BF_TIFF_LIB_STATIC', 'TIFF static library', ''),
359
360         (BoolVariable('WITH_BF_ZLIB', 'Use ZLib if true', True)),
361         (BoolVariable('WITH_BF_STATICZLIB', 'Staticly link to ZLib', False)),
362         ('BF_ZLIB', 'ZLib base path', ''),
363         ('BF_ZLIB_INC', 'ZLib include path', ''),
364         ('BF_ZLIB_LIB', 'ZLib library', ''),
365         ('BF_ZLIB_LIBPATH', 'ZLib library path', ''),
366         ('BF_ZLIB_LIB_STATIC', 'ZLib static library', ''),
367
368         (BoolVariable('WITH_BF_INTERNATIONAL', 'Use Gettext if true', True)),
369
370         ('BF_GETTEXT', 'gettext base path', ''),
371         ('BF_GETTEXT_INC', 'gettext include path', ''),
372         ('BF_GETTEXT_LIB', 'gettext library', ''),
373         (BoolVariable('WITH_BF_GETTEXT_STATIC', 'Use static gettext library if true', False)),
374         ('BF_GETTEXT_LIB_STATIC', 'static gettext library', ''),
375         ('BF_GETTEXT_LIBPATH', 'gettext library path', ''),
376         
377         (BoolVariable('WITH_BF_ICONV', 'Use iconv if true', True)),
378         ('BF_ICONV', 'iconv base path', ''),
379         ('BF_ICONV_INC', 'iconv include path', ''),
380         ('BF_ICONV_LIB', 'iconv library', ''),
381         ('BF_ICONV_LIBPATH', 'iconv library path', ''),
382         
383         (BoolVariable('WITH_BF_GAMEENGINE', 'Build with gameengine' , False)),
384
385         (BoolVariable('WITH_BF_BULLET', 'Use Bullet if true', True)),
386         (BoolVariable('WITH_BF_ELTOPO', 'Use Eltopo collision library if true', False)),
387         
388         ('BF_BULLET', 'Bullet base dir', ''),
389         ('BF_BULLET_INC', 'Bullet include path', ''),
390         ('BF_BULLET_LIB', 'Bullet library', ''),
391         
392         ('BF_WINTAB', 'WinTab base dir', ''),
393         ('BF_WINTAB_INC', 'WinTab include dir', ''),
394         ('BF_CXX', 'c++ base path for libstdc++, only used when static linking', ''),
395         (BoolVariable('WITH_BF_STATICCXX', 'static link to stdc++', False)),
396         ('BF_CXX_LIB_STATIC', 'static library path for stdc++', ''),
397
398         ('BF_FREETYPE', 'Freetype base path', ''),
399         ('BF_FREETYPE_INC', 'Freetype include path', ''),
400         ('BF_FREETYPE_LIB', 'Freetype library', ''),
401         ('BF_FREETYPE_LIBPATH', 'Freetype library path', ''),
402         (BoolVariable('WITH_BF_FREETYPE_STATIC', 'Use Static Freetype if true', False)),
403         ('BF_FREETYPE_LIB_STATIC', 'Static Freetype library', ''),
404
405         (BoolVariable('WITH_BF_OPENMP', 'Use OpenMP if true', False)),
406         ('BF_OPENMP', 'Base path to OpenMP (used when cross-compiling with older versions of WinGW)', ''),
407         ('BF_OPENMP_INC', 'Path to OpenMP includes (used when cross-compiling with older versions of WinGW)', ''),
408         ('BF_OPENMP_LIBPATH', 'Path to OpenMP libraries (used when cross-compiling with older versions of WinGW)', ''),
409         (BoolVariable('WITH_GHOST_COCOA', 'Use Cocoa-framework if true', False)),
410         (BoolVariable('WITH_GHOST_SDL', 'Enable building blender against SDL for windowing rather then the native APIs', False)),
411         (BoolVariable('USE_QTKIT', 'Use QTKIT if true', False)),
412
413         (BoolVariable('WITH_BF_QUICKTIME', 'Use QuickTime if true', False)),
414         ('BF_QUICKTIME', 'QuickTime base path', ''),
415         ('BF_QUICKTIME_INC', 'QuickTime include path', ''),
416         ('BF_QUICKTIME_LIB', 'QuickTime library', ''),
417         ('BF_QUICKTIME_LIBPATH', 'QuickTime library path', ''),
418         
419         (BoolVariable('WITH_BF_FFTW3', 'Use FFTW3 if true', False)),
420         ('BF_FFTW3', 'FFTW3 base path', ''),
421         ('BF_FFTW3_INC', 'FFTW3 include path', ''),
422         ('BF_FFTW3_LIB', 'FFTW3 library', ''),
423         ('BF_FFTW3_LIB_STATIC', 'FFTW3 static libraries', ''),
424         ('BF_FFTW3_LIBPATH', 'FFTW3 library path', ''),
425         (BoolVariable('WITH_BF_STATICFFTW3', 'Staticly link to FFTW3', False)),
426
427         (BoolVariable('WITH_BF_STATICOPENGL', 'Use MESA if true', True)),
428         ('BF_OPENGL', 'OpenGL base path', ''),
429         ('BF_OPENGL_INC', 'OpenGL include path', ''),
430         ('BF_OPENGL_LIB', 'OpenGL libraries', ''),
431         ('BF_OPENGL_LIBPATH', 'OpenGL library path', ''),
432         ('BF_OPENGL_LIB_STATIC', 'OpenGL static libraries', ''),
433         ('BF_OPENGL_LINKFLAGS', 'OpenGL link flags', ''),
434
435         (BoolVariable('WITH_BF_COLLADA', 'Build COLLADA import/export module if true', False)),
436         ('BF_COLLADA', 'COLLADA base path', ''),
437         ('BF_COLLADA_INC', 'COLLADA include path', ''),
438         ('BF_COLLADA_LIB', 'COLLADA library', ''),
439         ('BF_OPENCOLLADA', 'OpenCollada base path', ''),
440         ('BF_OPENCOLLADA_INC', 'OpenCollada base include path', ''),
441         ('BF_OPENCOLLADA_LIB', 'OpenCollada library', ''),
442         ('BF_OPENCOLLADA_LIBPATH', 'OpenCollada library path', ''),
443         ('BF_PCRE', 'PCRE base path', ''),
444         ('BF_PCRE_LIB', 'PCRE library', ''),
445         ('BF_PCRE_LIBPATH', 'PCRE library path', ''),
446         ('BF_EXPAT', 'Expat base path', ''),
447         ('BF_EXPAT_LIB', 'Expat library', ''),
448         ('BF_EXPAT_LIBPATH', 'Expat library path', ''),
449         
450         (BoolVariable('WITH_BF_JEMALLOC', 'Use jemalloc if true', False)),
451         (BoolVariable('WITH_BF_STATICJEMALLOC', 'Staticly link to jemalloc', False)),
452         ('BF_JEMALLOC', 'jemalloc base path', ''),
453         ('BF_JEMALLOC_INC', 'jemalloc include path', ''),
454         ('BF_JEMALLOC_LIB', 'jemalloc library', ''),
455         ('BF_JEMALLOC_LIBPATH', 'jemalloc library path', ''),
456         ('BF_JEMALLOC_LIB_STATIC', 'jemalloc static library', ''),
457
458         (BoolVariable('WITH_BF_PLAYER', 'Build blenderplayer if true', False)),
459         (BoolVariable('WITH_BF_NOBLENDER', 'Do not build blender if true', False)),
460
461         (BoolVariable('WITH_BF_3DMOUSE', 'Build blender with support of 3D mouses', False)),
462         (BoolVariable('WITH_BF_STATIC3DMOUSE', 'Staticly link to 3d mouse library', False)),
463         ('BF_3DMOUSE', '3d mouse library base path', ''),
464         ('BF_3DMOUSE_INC', '3d mouse library include path', ''),
465         ('BF_3DMOUSE_LIB', '3d mouse library', ''),
466         ('BF_3DMOUSE_LIBPATH', '3d mouse library path', ''),
467         ('BF_3DMOUSE_LIB_STATIC', '3d mouse static library', ''),
468
469         ('CFLAGS', 'C only flags', []),
470         ('CCFLAGS', 'Generic C and C++ flags', []),
471         ('CXXFLAGS', 'C++ only flags', []),
472         ('BGE_CXXFLAGS', 'C++ only flags for BGE', []),
473         ('CPPFLAGS', 'Defines', []),
474         ('REL_CFLAGS', 'C only release flags', []),
475         ('REL_CCFLAGS', 'Generic C and C++ release flags', []),
476         ('REL_CXXFLAGS', 'C++ only release flags', []),
477
478         ('C_WARN', 'C warning flags', []),
479         ('CC_WARN', 'Generic C and C++ warning flags', []),
480         ('CXX_WARN', 'C++ only warning flags', []),
481
482         ('LLIBS', 'Platform libs', []),
483         ('PLATFORM_LINKFLAGS', 'Platform linkflags', []),
484         ('MACOSX_ARCHITECTURE', 'python_arch.zip select', ''),
485         ('MACOSX_SDK_CHECK', 'detect available OSX sdk`s', ''),
486         ('XCODE_CUR_VER', 'detect XCode version', ''),
487
488         (BoolVariable('BF_PROFILE', 'Add profiling information if true', False)),
489         ('BF_PROFILE_CFLAGS', 'C only profiling flags', []),
490         ('BF_PROFILE_CCFLAGS', 'C and C++ profiling flags', []),
491         ('BF_PROFILE_CXXFLAGS', 'C++ only profiling flags', []),
492         ('BF_PROFILE_LINKFLAGS', 'Profile linkflags', []),
493
494         (BoolVariable('BF_DEBUG', 'Add debug flags if true', False)),
495         ('BF_DEBUG_CFLAGS', 'C only debug flags', []),
496         ('BF_DEBUG_CCFLAGS', 'C and C++ debug flags', []),
497         ('BF_DEBUG_CXXFLAGS', 'C++ only debug flags', []),
498
499         (BoolVariable('BF_BSC', 'Create .bsc files (msvc only)', False)),
500
501         ('BF_BUILDDIR', 'Build dir', ''),
502         ('BF_INSTALLDIR', 'Installation dir', ''),
503
504         ('CC', 'C compiler to use', env['CC']),
505         ('CXX', 'C++ compiler to use', env['CXX']),
506
507         (BoolVariable('BF_BUILDINFO', 'Buildtime in splash if true', True)),
508
509         (BoolVariable('BF_TWEAK_MODE', 'Enable tweak mode if true', False)),
510         (BoolVariable('BF_SPLIT_SRC', 'Split src lib into several chunks if true', False)),
511         (BoolVariable('WITHOUT_BF_INSTALL', 'dont install if true', False)),
512         (BoolVariable('WITHOUT_BF_PYTHON_INSTALL', 'dont install Python modules if true', False)),
513         (BoolVariable('WITHOUT_BF_OVERWRITE_INSTALL', 'dont remove existing files before breating the new install directory (set to False when making packages for others)', False)),
514         (BoolVariable('BF_FANCY', 'Enable fancy output if true', True)),
515         (BoolVariable('BF_QUIET', 'Enable silent output if true', True)),
516         (BoolVariable('BF_LINE_OVERWRITE', 'Enable overwriting of compile line in BF_QUIET mode if true', False)),
517         (BoolVariable('WITH_BF_BINRELOC', 'Enable relocatable binary (linux only)', False)),
518         
519         (BoolVariable('WITH_BF_LZO', 'Enable fast LZO pointcache compression', True)),
520         (BoolVariable('WITH_BF_LZMA', 'Enable best LZMA pointcache compression', True)),
521         
522         (BoolVariable('WITH_BF_LIBMV', 'Enable libmv structure from motion library', True)),
523
524         ('BF_X264_CONFIG', 'configuration flags for x264', ''),
525         ('BF_XVIDCORE_CONFIG', 'configuration flags for xvidcore', ''),
526 #        (BoolVariable('WITH_BF_DOCS', 'Generate API documentation', False)),
527         
528         ('BF_CONFIG', 'SCons python config file used to set default options', 'user_config.py'),
529         ('BF_NUMJOBS', 'Number of build processes to spawn', '1'),
530         ('BF_MSVS', 'Generate MSVS project files and solution', False),
531
532         ('BF_VERSION', 'The root path for Unix (non-apple)', '2.5'),
533
534         (BoolVariable('BF_UNIT_TEST', 'Build with unit test support.', False)),
535         
536         (BoolVariable('BF_GHOST_DEBUG', 'Make GHOST print events and info to stdout. (very verbose)', False)),
537         
538         (BoolVariable('WITH_BF_RAYOPTIMIZATION', 'Enable raytracer SSE/SIMD optimization.', False)),
539         ('BF_RAYOPTIMIZATION_SSE_FLAGS', 'SSE flags', ''),
540         (BoolVariable('WITH_BF_CXX_GUARDEDALLOC', 'Enable GuardedAlloc for C++ memory allocation tracking.', False)),
541
542         ('BUILDBOT_BRANCH', 'Buildbot branch name', ''),
543     ) # end of opts.AddOptions()
544
545     localopts.AddVariables(
546         (BoolVariable('WITH_BF_CYCLES', 'Build with the Cycles engine', True)),
547         (BoolVariable('WITH_BF_CYCLES_CUDA_BINARIES', 'Build with precompiled CUDA binaries', False)),
548         (BoolVariable('WITH_BF_CYCLES_CUDA_THREADED_COMPILE', 'Build several render kernels at once (using BF_NUMJOBS)', False)),
549         ('BF_CYCLES_CUDA_NVCC', 'CUDA nvcc compiler path', ''),
550         ('BF_CYCLES_CUDA_BINARIES_ARCH', 'CUDA architectures to compile binaries for', []),
551
552         (BoolVariable('WITH_BF_OIIO', 'Build with OpenImageIO', False)),
553         (BoolVariable('WITH_BF_STATICOIIO', 'Staticly link to OpenImageIO', False)),
554         ('BF_OIIO', 'OIIO root path', ''),
555         ('BF_OIIO_INC', 'OIIO include path', ''),
556         ('BF_OIIO_LIB', 'OIIO library', ''),
557         ('BF_OIIO_LIBPATH', 'OIIO library path', ''),
558         ('BF_OIIO_LIB_STATIC', 'OIIO static library', ''),
559
560         (BoolVariable('WITH_BF_BOOST', 'Build with Boost', False)),
561         (BoolVariable('WITH_BF_STATICBOOST', 'Staticly link to boost', False)),
562         ('BF_BOOST', 'Boost root path', ''),
563         ('BF_BOOST_INC', 'Boost include path', ''),
564         ('BF_BOOST_LIB', 'Boost library', ''),
565         ('BF_BOOST_LIBPATH', 'Boost library path', ''),
566         ('BF_BOOST_LIB_STATIC', 'Boost static library', '')
567     ) # end of opts.AddOptions()
568
569     return localopts
570
571 def buildbot_zip(src, dest, package_name, extension):
572     import zipfile
573     ln = len(src)+1 # one extra to remove leading os.sep when cleaning root for package_root
574     flist = list()
575
576     # create list of tuples containing file and archive name
577     for root, dirs, files in os.walk(src):
578         package_root = os.path.join(package_name, root[ln:])
579         flist.extend([(os.path.join(root, file), os.path.join(package_root, file)) for file in files])
580
581     if extension == '.zip':
582         package = zipfile.ZipFile(dest, 'w', zipfile.ZIP_DEFLATED)
583         package.comment = package_name + ' is a zip-file containing the Blender software. Visit http://www.blender.org for more information.'
584         for entry in flist:
585             package.write(entry[0], entry[1])
586         package.close()
587     else:
588         import tarfile
589         package = tarfile.open(dest, 'w:bz2')
590         for entry in flist:
591             package.add(entry[0], entry[1], recursive=False)
592         package.close()
593     bb_zip_name = os.path.normpath(src + os.sep + '..' + os.sep + 'buildbot_upload.zip')
594     print("creating %s" % (bb_zip_name))
595     bb_zip = zipfile.ZipFile(bb_zip_name, 'w', zipfile.ZIP_DEFLATED)
596     print("writing %s to %s" % (dest, bb_zip_name))
597     bb_zip.write(dest, os.path.split(dest)[1])
598     bb_zip.close()
599     print("removing unneeded packed file %s (to keep install directory clean)" % (dest))
600     os.remove(dest)
601     print("done.")
602
603 def buildslave_print(target, source, env):
604     return "Running buildslave target"
605
606 def buildslave(target=None, source=None, env=None):
607     """
608     Builder for buildbot integration. Used by buildslaves of http://builder.blender.org only.
609     """
610
611     if env['OURPLATFORM'] in ('win32-vc', 'win64-vc', 'win32-mingw', 'darwin'):
612         extension = '.zip'
613     else:
614         extension = '.tar.bz2'
615
616     platform = env['OURPLATFORM'].split('-')[0]
617     if platform == 'linux':
618         import platform
619
620         bitness = platform.architecture()[0]
621         if bitness == '64bit':
622             platform = 'linux-glibc27-x86_64'
623         elif bitness == '32bit':
624             platform = 'linux-glibc27-i686'
625     if platform == 'darwin':
626         platform = 'OSX-' + env['MACOSX_ARCHITECTURE']
627
628     branch = env['BUILDBOT_BRANCH']
629
630     outdir = os.path.abspath(env['BF_INSTALLDIR'])
631     package_name = 'blender-' + VERSION+'-'+REVISION + '-' + platform
632     if branch != '':
633         package_name = branch + '-' + package_name
634     package_dir = os.path.normpath(outdir + os.sep + '..' + os.sep + package_name)
635     package_archive = os.path.normpath(outdir + os.sep + '..' + os.sep + package_name + extension)
636
637     try:
638         if os.path.exists(package_archive):
639             os.remove(package_archive)
640         if os.path.exists(package_dir):
641             shutil.rmtree(package_dir)
642     except Exception, ex:
643         sys.stderr.write('Failed to clean up old package files: ' + str(ex) + '\n')
644         return 1
645
646     buildbot_zip(outdir, package_archive, package_name, extension)
647
648     return 0
649
650 def NSIS_print(target, source, env):
651     return "Creating NSIS installer for Blender"
652
653 def NSIS_Installer(target=None, source=None, env=None):
654     print "="*35
655
656     if env['OURPLATFORM'] not in ('win32-vc', 'win32-mingw', 'win64-vc'):
657         print "NSIS installer is only available on Windows."
658         Exit()
659     if env['OURPLATFORM'] == 'win32-vc':
660         bitness = '32'
661     elif env['OURPLATFORM'] == 'win64-vc':
662         bitness = '64'
663     else:
664         bitness = '-mingw'
665
666     start_dir = os.getcwd()
667     rel_dir = os.path.join(start_dir,'release','windows','installer')
668     install_base_dir = start_dir + os.sep
669
670     bf_installdir = os.path.join(os.getcwd(),env['BF_INSTALLDIR'])
671     bf_installdir = os.path.normpath(bf_installdir)
672
673     doneroot = False
674     rootdirconts = []
675     datafiles = ''
676     deldatafiles = ''
677     deldatadirs = ''
678     l = len(bf_installdir)
679     
680     for dp,dn,df in os.walk(bf_installdir):
681         # install
682         if not doneroot:
683             for f in df:
684                 rootdirconts.append(os.path.join(dp,f))
685             doneroot = True
686         else:
687             if len(df)>0:
688                 dp_tmp = dp[l:]
689                 datafiles += "\n" +r'SetOutPath $INSTDIR'+dp[l:]+"\n\n"
690
691                 for f in df:
692                     outfile = os.path.join(dp,f)
693                     datafiles += '  File '+outfile + "\n"
694
695         # uninstall
696         deldir = dp[l+1:]
697
698         if len(deldir)>0:
699             deldatadirs = "RMDir $INSTDIR\\" + deldir + "\n" + deldatadirs
700             deldatadirs = "RMDir /r $INSTDIR\\" + deldir + "\\__pycache__\n" + deldatadirs
701
702             for f in df:
703                 deldatafiles += 'Delete \"$INSTDIR\\' + os.path.join(deldir, f) + "\"\n"
704
705     #### change to suit install dir ####
706     inst_dir = install_base_dir + env['BF_INSTALLDIR']
707     
708     os.chdir(rel_dir)
709
710     ns = open("00.sconsblender.nsi","r")
711
712     ns_cnt = str(ns.read())
713     ns.close()
714
715     # var replacements
716     ns_cnt = string.replace(ns_cnt, "[DISTDIR]", os.path.normpath(inst_dir+os.sep))
717     ns_cnt = string.replace(ns_cnt, "[VERSION]", VERSION_DISPLAY)
718     ns_cnt = string.replace(ns_cnt, "[SHORTVERSION]", VERSION)
719     ns_cnt = string.replace(ns_cnt, "[RELDIR]", os.path.normpath(rel_dir))
720     ns_cnt = string.replace(ns_cnt, "[BITNESS]", bitness)
721
722     # do root
723     rootlist = []
724     for rootitem in rootdirconts:
725         rootlist.append("File \"" + rootitem + "\"")
726     rootstring = string.join(rootlist, "\n  ")
727     rootstring = rootstring
728     rootstring += "\n\n"
729     ns_cnt = string.replace(ns_cnt, "[ROOTDIRCONTS]", rootstring)
730
731
732     # do delete items
733     delrootlist = []
734     for rootitem in rootdirconts:
735         delrootlist.append("Delete $INSTDIR\\" + rootitem[l+1:])
736     delrootstring = string.join(delrootlist, "\n ")
737     delrootstring += "\n"
738     ns_cnt = string.replace(ns_cnt, "[DELROOTDIRCONTS]", delrootstring)
739
740     ns_cnt = string.replace(ns_cnt, "[DODATAFILES]", datafiles)
741     ns_cnt = string.replace(ns_cnt, "[DELDATAFILES]", deldatafiles)
742     ns_cnt = string.replace(ns_cnt, "[DELDATADIRS]", deldatadirs)
743
744     tmpnsi = os.path.normpath(install_base_dir+os.sep+env['BF_BUILDDIR']+os.sep+"00.blender_tmp.nsi")
745     new_nsis = open(tmpnsi, 'w')
746     new_nsis.write(ns_cnt)
747     new_nsis.close()
748     print "NSIS Installer script created"
749
750     os.chdir(start_dir)
751     print "Launching 'makensis'"
752
753     cmdline = "makensis " + "\""+tmpnsi+"\""
754
755     startupinfo = subprocess.STARTUPINFO()
756     startupinfo.dwFlags |= subprocess.STARTF_USESHOWWINDOW
757     proc = subprocess.Popen(cmdline, stdin=subprocess.PIPE, stdout=subprocess.PIPE,
758         stderr=subprocess.PIPE, startupinfo=startupinfo, shell = True)
759     data, err = proc.communicate()
760     rv = proc.wait()
761
762     if rv != 0:
763         print
764         print data.strip().split("\n")[-1]
765     return rv
766
767 def check_environ():
768     problematic_envvars = ""
769     for i in os.environ:
770         try:
771             os.environ[i].decode('ascii')
772         except UnicodeDecodeError:
773             problematic_envvars = problematic_envvars + "%s = %s\n" % (i, os.environ[i])
774     if len(problematic_envvars)>0:
775         print("================\n\n")
776         print("@@ ABORTING BUILD @@\n")
777         print("PROBLEM DETECTED WITH ENVIRONMENT")
778         print("---------------------------------\n\n")
779         print("A problem with one or more environment variable was found")
780         print("Their value contain non-ascii characters. Check the below")
781         print("list and override them locally to be ASCII-clean by doing")
782         print("'set VARNAME=cleanvalue' on the command-line prior to")
783         print("starting the build process:\n")
784         print(problematic_envvars)
785         return False
786     else:
787         return True