Labels in this dialog don't have full stops.
[ardour.git] / wscript
1 #!/usr/bin/env python
2 from waflib.extras import autowaf as autowaf
3 from waflib import Options
4 import os
5 import re
6 import string
7 import subprocess
8 import sys
9 import platform as PLATFORM
10 from waflib.Tools import winres
11 from waflib.Build import Context
12 from waflib.Build import BuildContext
13
14 class i18n(BuildContext):
15         cmd = 'i18n'
16         fun = 'i18n'
17
18 class i18n_pot(BuildContext):
19         cmd = 'i18n_pot'
20         fun = 'i18n_pot'
21
22 class i18n_po(BuildContext):
23         cmd = 'i18n_po'
24         fun = 'i18n_po'
25
26 class i18n_mo(BuildContext):
27         cmd = 'i18n_mo'
28         fun = 'i18n_mo'
29
30 def is_tracks_build(self, *k, **kw):
31         return self.env['PROGRAM_NAME'] == 'Tracks Live'
32
33 Context.Context.is_tracks_build = is_tracks_build
34
35 compiler_flags_dictionaries= {
36     'gcc' : {
37         # Flags required when building a debug build
38         'debuggable' : [ '-g' ],
39         # Flags required for the linker (if any) when building a debug build
40         'linker-debuggable' : '',
41         # Flags required when building a non-debug optimized build
42         'nondebuggable' : '-DNDEBUG',
43         # Flags required to enable profiling at runtime with optimized builds
44         'profile' : [ '-fno-omit-frame-pointer' ],
45         # Flags required to enable gprofile profiling
46         'gprofile' : '-pg',
47         # Flags required to disable warnings about unused arguments to function calls
48         'silence-unused-arguments' : '',
49         # Flags required to use SSE unit for general math
50         'sse' : '-msse',
51         # Flags required to use SSE unit for floating point math
52         'fpmath-sse' : '-mfpmath=sse',
53         # Flags required to use XMM Intrinsics
54         'xmmintrinsics' : '-DUSE_XMMINTRIN',
55         # Flags to use posix pipes between compiler stages
56         'pipe' : '-pipe',
57         # Flags for maximally optimized build
58         'full-optimization' : [ '-O3', '-fomit-frame-pointer', '-ffast-math', '-fstrength-reduce', ],
59         # Flag to ensure that compiler error output includes column/line numbers
60         'show-column' : '-fshow-column',
61         # Flags required to build for x86 only (OS X feature)
62         'generic-x86' : '',
63         # Flags required to build for PowerPC only (OS X feature)
64         'generic-ppc' : '',
65         # All flags required to get basic warnings to be generated by the compiler
66         'basic-warnings' : [ '-Wall', '-Wpointer-arith', '-Wcast-qual', '-Wcast-align', '-Wno-unused-parameter' ],
67         # Any additional flags for warnings that are specific to C (not C++)
68         'extra-c-warnings' : [ '-Wstrict-prototypes', '-Wmissing-prototypes' ],
69         # Any additional flags for warnings that are specific to C++ (not C)
70         'extra-cxx-warnings' : [ '-Woverloaded-virtual', '-Wno-unused-local-typedefs' ],
71         # Flags used for "strict" compilation, C and C++ (i.e. compiler will warn about language issues)
72         'strict' : ['-Wall', '-Wcast-align', '-Wextra', '-Wwrite-strings', '-Wunsafe-loop-optimizations', '-Wlogical-op' ],
73         # Flags used for "strict" compilation, C only (i.e. compiler will warn about language issues)
74         'c-strict' : ['-std=c99', '-pedantic', '-Wshadow'],
75         # Flags used for "strict" compilation, C++ only (i.e. compiler will warn about language issues)
76         'cxx-strict' : [ '-ansi', '-Wnon-virtual-dtor', '-Woverloaded-virtual', '-fstrict-overflow' ],
77         # Flags required for whatever consider the strictest possible compilation
78         'ultra-strict' : ['-Wredundant-decls', '-Wstrict-prototypes', '-Wmissing-prototypes'],
79         # Flag to turn on C99 compliance by itself
80         'c99': '-std=c99',
81         # Flag to enable AT&T assembler syntax
82         'attasm': '-masm=att',
83         # Flags to make AVX instructions/intrinsics available
84         'avx': '-mavx',
85         # Flags to generate position independent code, when needed to build a shared object
86         'pic': '-fPIC',
87         # Flags required to compile C code with anonymous unions (only part of C11)
88         'c-anonymous-union': '-fms-extensions',
89     },
90     'msvc' : {
91         'debuggable' : ['/DDEBUG', '/Od', '/Zi', '/MDd', '/Gd', '/EHsc'],
92         'linker-debuggable' : ['/DEBUG', '/INCREMENTAL' ],
93         'nondebuggable' : ['/DNDEBUG', '/Ob1', '/MD', '/Gd', '/EHsc'],
94         'profile' : '/Oy-',
95         'sse' : '/arch:SSE',
96         'silence-unused-arguments' : '',
97         'sse' : '',
98         'fpmath-sse' : '',
99         'xmmintrinsics' : '',
100         'pipe' : '',
101         'full-optimization' : '/O2',
102         'no-frame-pointer' : '',
103         'fast-math' : '',
104         'strength-reduce' : '',
105         'show-column' : '',
106         'generic-x86' : '',
107         'generic-ppc' : '',
108         'basic-warnings' : '',
109         'extra-c-warnings' : '',
110         'extra-cxx-warnings' : '',
111         'ultra-strict' : '',
112         'c-strict' : '',
113         'cxx-strict' : '',
114         'strict' : '',
115         'c99': '/TP',
116         'attasm': '',
117         'avx': '',
118         'pic': '',
119         'c-anonymous-union': '',
120     },
121 }
122
123 # Copy, edit and insert variants on gcc dict for gcc-darwin and clang
124
125 gcc_darwin_dict = compiler_flags_dictionaries['gcc'].copy()
126 gcc_darwin_dict['extra-cxx-warnings'] = [ '-Woverloaded-virtual' ]
127 gcc_darwin_dict['cxx-strict'] = [ '-ansi', '-Wnon-virtual-dtor', '-Woverloaded-virtual' ]
128 gcc_darwin_dict['strict'] = ['-Wall', '-Wcast-align', '-Wextra', '-Wwrite-strings' ]
129 gcc_darwin_dict['generic-x86'] = [ '-arch', 'i386' ]
130 gcc_darwin_dict['generic-ppc'] = [ '-arch', 'ppc' ]
131 compiler_flags_dictionaries['gcc-darwin'] = gcc_darwin_dict;
132
133 clang_dict = compiler_flags_dictionaries['gcc'].copy();
134 clang_dict['sse'] = ''
135 clang_dict['fpmath-sse'] = ''
136 clang_dict['xmmintrinsics'] = ''
137 clang_dict['silence-unused-arguments'] = '-Qunused-arguments'
138 clang_dict['extra-cxx-warnings'] = [ '-Woverloaded-virtual', '-Wno-mismatched-tags', '-Wno-cast-align', '-Wno-unused-local-typedefs' ]
139 clang_dict['cxx-strict'] = [ '-ansi', '-Wnon-virtual-dtor', '-Woverloaded-virtual', '-fstrict-overflow' ]
140 clang_dict['strict'] = ['-Wall', '-Wcast-align', '-Wextra', '-Wwrite-strings' ]
141 clang_dict['generic-x86'] = [ '-arch', 'i386' ]
142 clang_dict['full-optimization'] = [ '-O3', '-fomit-frame-pointer', '-ffast-math', ]
143 compiler_flags_dictionaries['clang'] = clang_dict;
144
145 clang_darwin_dict = compiler_flags_dictionaries['clang'].copy();
146 clang_darwin_dict['cxx-strict'] = [ '-ansi', '-Wnon-virtual-dtor', '-Woverloaded-virtual', ]
147 clang_darwin_dict['full-optimization'] = [ '-O3', '-ffast-math']
148 compiler_flags_dictionaries['clang-darwin'] = clang_darwin_dict;
149
150 def fetch_git_revision ():
151     cmd = "git describe HEAD | sed 's/^[A-Za-z0-9]*+//'"
152     output = subprocess.Popen(cmd, shell=True, stderr=subprocess.STDOUT, stdout=subprocess.PIPE).communicate()[0].splitlines()
153     rev = output[0].decode ('utf-8')
154     return rev
155
156 def fetch_tarball_revision ():
157     if not os.path.exists ('libs/ardour/revision.cc'):
158         print ('This tarball was not created correctly - it is missing libs/ardour/revision.cc')
159         sys.exit (1)
160     with open('libs/ardour/revision.cc', 'rb') as f:
161         content = f.readlines()
162         remove_punctuation_map = dict((ord(char), None) for char in '";')
163         return content[1].decode('utf-8').strip().split(' ')[7].translate (remove_punctuation_map)
164
165 if os.path.isdir (os.path.join(os.getcwd(), '.git')):
166     rev = fetch_git_revision ()
167 else:
168     rev = fetch_tarball_revision ()
169
170 #
171 # rev is now of the form MAJOR.MINOR[-rcX]-rev-commit
172 # or, if right at the same rev as a release, MAJOR.MINOR[-rcX]
173 #
174
175 parts = rev.split ('.', 1)
176 MAJOR = parts[0]
177 other = parts[1].split('-', 1)
178 MINOR = other[0]
179 if len(other) > 1:
180     MICRO = other[1].rsplit('-',1)[0].replace('-','.')
181 else:
182     MICRO = '0'
183
184 V = MAJOR + '.' + MINOR + '.' + MICRO
185
186 def sanitize(s):
187     # round-trip to remove anything in the string that is not encodable in
188     # ASCII, yet still keep a real (utf8-encoded internally) string.
189     s = s.encode ('ascii', 'ignore').decode ("utf-8")
190     # In Python3, bytes is the class of binary content and encode() returns
191     # bytes to transform a string according to a text encoding; str is the
192     # class of normal strings (utf8-encoded internally) and decode() returns
193     # that type.
194     # Python 2 did not initially cater for encoding problems and can use str
195     # for both binary content and for (decoded) strings. The Unicode type was
196     # added to correspond to Python 3 str, and the Python 2 str type should
197     # only correspond to bytes. Alas, almost everything in the Python 2
198     # ecosystem has been written with str in mind and doesn't handle Unicode
199     # objects correctly. If Python 2 is in use, s will be a Unicode object and
200     # to avoid strange problems later we convert back to str, but in utf-8
201     # nonetheless.
202     if not isinstance(s, str):
203         s = s.encode("utf-8")
204     return s
205 VERSION = sanitize(V)
206 PROGRAM_VERSION = sanitize(MAJOR)
207 del sanitize
208
209 if len (sys.argv) > 1 and sys.argv[1] == 'dist':
210         if not 'APPNAME' in os.environ:
211                 print ("You must define APPNAME in the environment when running ./waf dist")
212                 sys.exit (1)
213         APPNAME = os.environ['APPNAME'];
214
215 # Mandatory variables
216 top = '.'
217 out = 'build'
218
219 children = [
220         # optionally external libraries
221         'libs/fluidsynth',
222         'libs/hidapi',
223         'libs/libltc',
224         'libs/lua',
225         'libs/ptformat',
226         'libs/qm-dsp',
227         'libs/vamp-plugins',
228         # core ardour libraries
229         'libs/pbd',
230         'libs/midi++2',
231         'libs/evoral',
232         'libs/surfaces',
233         'libs/panners',
234         'libs/backends',
235         'libs/timecode',
236         'libs/ardour',
237         'libs/gtkmm2ext',
238         'libs/audiographer',
239         'libs/canvas',
240         'libs/widgets',
241         'libs/waveview',
242         'libs/plugins/reasonablesynth.lv2',
243         'libs/plugins/a-comp.lv2',
244         'libs/plugins/a-delay.lv2',
245         'libs/plugins/a-eq.lv2',
246         'libs/plugins/a-reverb.lv2',
247         'libs/plugins/a-fluidsynth.lv2',
248         'gtk2_ardour',
249         'export',
250         'midi_maps',
251         'mcp',
252         'osc',
253         'patchfiles',
254         'scripts',
255         'headless',
256         'session_utils',
257         # shared helper binaries (plugin-scanner, exec-wrapper)
258         'libs/fst',
259         'libs/vfork',
260         'libs/ardouralsautil',
261         'tools/luadevel',
262 ]
263
264 i18n_children = [
265         'gtk2_ardour',
266         'libs/ardour',
267         'libs/gtkmm2ext',
268 ]
269
270 # Version stuff
271
272 def fetch_gcc_version (CC):
273     cmd = "%s --version" % CC
274     output = subprocess.Popen(cmd, shell=True, stderr=subprocess.STDOUT, stdout=subprocess.PIPE).communicate()[0].splitlines()
275     o = output[0].decode('utf-8')
276     version = o.split(' ')[2].split('.')
277     return version
278
279 def create_stored_revision():
280     rev = ""
281     if os.path.exists('.git'):
282         rev = fetch_git_revision();
283         print("Git version: " + rev + "\n")
284     elif os.path.exists('libs/ardour/revision.cc'):
285         print("Using packaged revision")
286         return
287     else:
288         print("Missing libs/ardour/revision.cc.  Blame the packager.")
289         sys.exit(-1)
290
291     try:
292         #
293         # if you change the format of this, be sure to fix fetch_tarball_revision() above
294         # so that  it still works.
295         #
296         text =  '#include "ardour/revision.h"\n'
297         text += 'namespace ARDOUR { const char* revision = \"%s\"; }\n' % rev
298         print('Writing revision info to libs/ardour/revision.cc using ' + rev)
299         o = open('libs/ardour/revision.cc', 'w')
300         o.write(text)
301         o.close()
302     except IOError:
303         print('Could not open libs/ardour/revision.cc for writing\n')
304         sys.exit(-1)
305
306 def get_depstack_rev(depstack_root):
307     try:
308         with open(depstack_root + '/../.vers', 'r') as f:
309             return f.readline()
310     except IOError:
311         return '-unknown-';
312
313 def set_compiler_flags (conf,opt):
314     #
315     # Compiler flags and other system-dependent stuff
316     #
317     build_host_supports_sse = False
318
319     # Flags necessary for building
320     compiler_flags = []     # generic
321     c_flags = []            # C-specific
322     cxx_flags = []          # C++-specific
323     linker_flags = []
324
325     # Optimization flags (overridable)
326     optimization_flags = []
327
328     # Debugging flags
329     debug_flags = []
330
331     u = PLATFORM.uname ()
332     cpu = u[4]
333     platform = u[0].lower()
334     version = u[2]
335
336     # waf adds -O0 -g itself. thanks waf!
337     is_clang = conf.check_cxx(fragment = '''
338 #ifndef __clang__
339 #error
340 #endif
341 int main() { return 0; }''',
342                          features  = 'cxx',
343                          mandatory = False,
344                          execute   = False,
345                          msg       = 'Checking for clang')
346
347     if is_clang:
348         if platform == 'darwin':
349             compiler_name = 'clang-darwin'
350         else:
351             compiler_name = 'clang'
352     elif conf.env['MSVC_COMPILER']:
353             compiler_name = 'msvc'
354     else:
355         if platform == 'darwin':
356             compiler_name = 'gcc-darwin'
357         else:
358             compiler_name = 'gcc'
359
360     flags_dict = compiler_flags_dictionaries[compiler_name]
361     # Save the compiler flags because we need them at build time
362     # when we need to add compiler specific flags in certain
363     # libraries
364     conf.env['compiler_flags_dict'] = flags_dict;
365
366     autowaf.set_basic_compiler_flags (conf,flags_dict)
367
368     if conf.options.asan:
369         conf.check_cxx(cxxflags=["-fsanitize=address", "-fno-omit-frame-pointer"], linkflags=["-fsanitize=address"])
370         cxx_flags.append('-fsanitize=address')
371         cxx_flags.append('-fno-omit-frame-pointer')
372         linker_flags.append('-fsanitize=address')
373
374     if opt.gprofile:
375         debug_flags = [ flags_dict['gprofile'] ]
376
377     # OSX
378     if platform == 'darwin':
379         if re.search ("^13[.]", version) != None:
380             conf.env['build_host'] = 'mavericks'
381         elif re.search ("^14[.]", version) != None:
382             conf.env['build_host'] = 'yosemite'
383         elif re.search ("^15[.]", version) != None:
384             conf.env['build_host'] = 'el_capitan'
385         elif re.search ("^16[.]", version) != None:
386             conf.env['build_host'] = 'sierra'
387         elif re.search ("^17[.]", version) != None:
388             conf.env['build_host'] = 'high_sierra'
389         else:
390             conf.env['build_host'] = 'irrelevant'
391
392     # Autodetect
393     if opt.dist_target == 'auto':
394         if platform == 'darwin':
395             # The [.] matches to the dot after the major version, "." would match any character
396             if re.search ("^[0-7][.]", version) != None:
397                 conf.env['build_target'] = 'panther'
398             elif re.search ("^8[.]", version) != None:
399                 conf.env['build_target'] = 'tiger'
400             elif re.search ("^9[.]", version) != None:
401                 conf.env['build_target'] = 'leopard'
402             elif re.search ("^10[.]", version) != None:
403                 conf.env['build_target'] = 'snowleopard'
404             elif re.search ("^11[.]", version) != None:
405                 conf.env['build_target'] = 'lion'
406             elif re.search ("^12[.]", version) != None:
407                 conf.env['build_target'] = 'mountainlion'
408             elif re.search ("^13[.]", version) != None:
409                 conf.env['build_target'] = 'mavericks'
410             elif re.search ("^14[.]", version) != None:
411                 conf.env['build_target'] = 'yosemite'
412             elif re.search ("^15[.]", version) != None:
413                 conf.env['build_target'] = 'el_capitan'
414             elif re.search ("^16[.]", version) != None:
415                 conf.env['build_target'] = 'sierra'
416             else:
417                 conf.env['build_target'] = 'high_sierra'
418         else:
419             match = re.search(
420                     "(?P<cpu>i[0-6]86|x86_64|powerpc|ppc|ppc64|arm|s390x?)",
421                     cpu)
422             if (match):
423                 conf.env['build_target'] = match.group("cpu")
424                 if re.search("i[0-5]86", conf.env['build_target']):
425                     conf.env['build_target'] = "i386"
426             else:
427                 conf.env['build_target'] = 'none'
428     else:
429         conf.env['build_target'] = opt.dist_target
430
431     if conf.env['build_target'] == 'snowleopard':
432         #
433         # stupid OS X 10.6 has a bug in math.h that prevents llrint and friends
434         # from being visible.
435         #
436         compiler_flags.append ('-U__STRICT_ANSI__')
437
438     if opt.use_libcpp or conf.env['build_host'] in [ 'el_capitan', 'sierra', 'high_sierra' ]:
439        cxx_flags.append('--stdlib=libc++')
440        linker_flags.append('--stdlib=libc++')
441
442     if conf.options.cxx11 or conf.env['build_host'] in [ 'mavericks', 'yosemite', 'el_capitan', 'sierra', 'high_sierra' ]:
443         conf.check_cxx(cxxflags=["-std=c++11"])
444         cxx_flags.append('-std=c++11')
445         if platform == "darwin":
446             # Mavericks and later changed the syntax to be used when including Carbon headers,
447             # from requiring a full path to requiring just the header name.
448             cxx_flags.append('-DCARBON_FLAT_HEADERS')
449
450             if not opt.use_libcpp and not conf.env['build_host'] in [ 'el_capitan', 'sierra', 'high_sierra' ]:
451                 cxx_flags.append('--stdlib=libstdc++')
452                 linker_flags.append('--stdlib=libstdc++')
453             # Prevents visibility issues in standard headers
454             conf.define("_DARWIN_C_SOURCE", 1)
455         else:
456             cxx_flags.append('-DBOOST_NO_AUTO_PTR')
457
458
459     if (is_clang and platform == "darwin") or conf.env['build_host'] in [ 'mavericks', 'yosemite', 'el_capitan', 'sierra', 'high_sierra' ]:
460         # Silence warnings about the non-existing osx clang compiler flags
461         # -compatibility_version and -current_version.  These are Waf
462         # generated and not needed with clang
463         c_flags.append("-Qunused-arguments")
464         cxx_flags.append("-Qunused-arguments")
465
466     if (re.search ("(i[0-9]86|x86_64|AMD64)", cpu) != None) and conf.env['build_target'] != 'none':
467
468         #
469         # ARCH_X86 means anything in the x86 family from i386 to x86_64
470         # the compile-time presence of the macro _LP64 is used to
471         # distingush 32 and 64 bit assembler
472         #
473
474         compiler_flags.append ("-DARCH_X86")
475
476         if platform == 'linux' :
477
478             #
479             # determine processor flags via /proc/cpuinfo
480             #
481
482             if conf.env['build_target'] != 'i386':
483
484                 flag_line = os.popen ("cat /proc/cpuinfo | grep '^flags'").read()[:-1]
485                 x86_flags = flag_line.split (": ")[1:][0].split ()
486
487                 if "mmx" in x86_flags:
488                     compiler_flags.append ("-mmmx")
489                 if "sse" in x86_flags:
490                     build_host_supports_sse = True
491                 if "3dnow" in x86_flags:
492                     compiler_flags.append ("-m3dnow")
493
494             if cpu == "i586":
495                 compiler_flags.append ("-march=i586")
496             elif cpu == "i686":
497                 compiler_flags.append ("-march=i686")
498
499         if not is_clang and ((conf.env['build_target'] == 'i686') or (conf.env['build_target'] == 'x86_64')) and build_host_supports_sse:
500             compiler_flags.extend ([ flags_dict['sse'], flags_dict['fpmath-sse'], flags_dict['xmmintrinsics'] ])
501
502         if (conf.env['build_target'] == 'mingw'):
503             if (re.search ("(x86_64|AMD64)", cpu) != None):
504                 # on Windows sse is supported by 64 bit platforms only
505                 build_host_supports_sse = True
506
507                 # mingw GCC compiler to uses at&t (Unix specific) assembler dialect by default
508                 # compiler_flags.append (["--mmnemonic=att", "msyntax=att")
509
510                 compiler_flags.extend ([ flags_dict['sse'], flags_dict['fpmath-sse'], flags_dict['xmmintrinsics'], flags_dict['attasm'] ])
511
512     # end of processor-specific section
513
514     # optimization section
515     if conf.env['FPU_OPTIMIZATION']:
516         if sys.platform == 'darwin':
517             compiler_flags.append("-DBUILD_VECLIB_OPTIMIZATIONS");
518             conf.env.append_value('LINKFLAGS_OSX', ['-framework', 'Accelerate'])
519         elif conf.env['build_target'] == 'i686' or conf.env['build_target'] == 'x86_64':
520                 compiler_flags.append ("-DBUILD_SSE_OPTIMIZATIONS")
521         elif conf.env['build_target'] == 'mingw':
522                 # usability of the 64 bit windows assembler depends on the compiler target,
523                 # not the build host, which in turn can only be inferred from the name
524                 # of the compiler.
525                 if re.search ('x86_64-w64', str(conf.env['CC'])) != None:
526                         compiler_flags.append ("-DBUILD_SSE_OPTIMIZATIONS")
527         if not build_host_supports_sse:
528             print("\nWarning: you are building Ardour with SSE support even though your system does not support these instructions. (This may not be an error, especially if you are a package maintainer)")
529
530     # end optimization section
531
532     #
533     # no VST on x86_64
534     #
535
536     if conf.env['build_target'] == 'x86_64' and opt.windows_vst:
537         print("\n\n==================================================")
538         print("64bit Windows VST support on 64bit Linux is experimental.")
539         print("(This version of ardour will not load 32bit VSTs)")
540         print("==================================================\n\n")
541
542     if conf.env['LXVST_SUPPORT'] == True:
543         if conf.env['build_target'] == 'x86_64':
544             compiler_flags.append("-DLXVST_64BIT")
545         else:
546             compiler_flags.append("-DLXVST_32BIT")
547
548     #
549     # a single way to test if we're on OS X
550     #
551
552     if conf.env['build_target'] in ['panther', 'tiger', 'leopard' ]:
553         # force tiger or later, to avoid issues on PPC which defaults
554         # back to 10.1 if we don't tell it otherwise.
555
556         compiler_flags.extend(
557                 ("-DMAC_OS_X_VERSION_MIN_REQUIRED=1040",
558                  '-mmacosx-version-min=10.4'))
559
560     elif conf.env['build_target'] in [ 'snowleopard' ]:
561         compiler_flags.extend(
562                 ("-DMAC_OS_X_VERSION_MIN_REQUIRED=1060",
563                  '-mmacosx-version-min=10.6'))
564
565     elif conf.env['build_target'] in [ 'lion', 'mountainlion' ]:
566         compiler_flags.extend(
567                 ("-DMAC_OS_X_VERSION_MIN_REQUIRED=1070",
568                  '-mmacosx-version-min=10.7'))
569
570     elif conf.env['build_target'] in [ 'mavericks', 'yosemite' ]:
571         compiler_flags.extend(
572                 ("-DMAC_OS_X_VERSION_MAX_ALLOWED=1090",
573                  "-mmacosx-version-min=10.8"))
574
575     elif conf.env['build_target'] in ['el_capitan', 'sierra', 'high_sierra' ]:
576         compiler_flags.extend(
577                 ("-DMAC_OS_X_VERSION_MAX_ALLOWED=1090",
578                  "-mmacosx-version-min=10.9"))
579
580     #
581     # save off CPU element in an env
582     #
583     conf.define ('CONFIG_ARCH', cpu)
584
585     #
586     # ARCH="..." overrides all
587     #
588
589     if opt.arch != None:
590         optimization_flags = opt.arch.split()
591
592     #
593     # prepend boiler plate optimization flags that work on all architectures
594     #
595
596     optimization_flags[:0] = [flags_dict['pipe']]
597
598     # don't prepend optimization flags if "-O<something>" is present
599     prepend_opt_flags = True
600     for flag in optimization_flags:
601         if flag.startswith("-O"):
602             prepend_opt_flags = False
603             break
604
605     if prepend_opt_flags:
606         optimization_flags[:0] = flags_dict['full-optimization']
607
608     if opt.debug_symbols:
609         optimization_flags += flags_dict['debuggable']
610
611     if opt.profile:
612         optimization_flags += flags_dict['profile']
613
614     if opt.stl_debug:
615         cxx_flags.append("-D_GLIBCXX_DEBUG")
616
617     if re.search ("freebsd", sys.platform) != None or re.search ("openbsd", sys.platform) != None:
618         linker_flags.append('-lexecinfo')
619
620     if conf.env['DEBUG_RT_ALLOC']:
621         compiler_flags.append('-DDEBUG_RT_ALLOC')
622         linker_flags.append('-ldl')
623
624     if conf.env['DEBUG_DENORMAL_EXCEPTION']:
625         compiler_flags.append('-DDEBUG_DENORMAL_EXCEPTION')
626
627     if opt.generic:
628         compiler_flags.extend(flags_dict['generic-x86'])
629         linker_flags.extend(flags_dict['generic-x86'])
630
631     if opt.ppc:
632         compiler_flags.extend(flags_dict['generic-ppc'])
633         linker_flags.extend(flags_dict['generic-ppc'])
634
635     #
636     # warnings flags
637     #
638
639     compiler_flags.extend(flags_dict['basic-warnings'])
640
641     c_flags.extend(flags_dict['extra-c-warnings'])
642     cxx_flags.extend (flags_dict['extra-cxx-warnings'])
643
644     #
645     # more boilerplate
646     #
647
648     # need ISOC9X for llabs()
649     compiler_flags.extend(
650         ('-DBOOST_SYSTEM_NO_DEPRECATED', '-D_ISOC9X_SOURCE',
651          '-D_LARGEFILE64_SOURCE', '-D_FILE_OFFSET_BITS=64'))
652     cxx_flags.extend(
653         ('-D__STDC_LIMIT_MACROS', '-D__STDC_FORMAT_MACROS',
654          '-DCANVAS_COMPATIBILITY', '-DCANVAS_DEBUG'))
655
656     if opt.nls:
657         compiler_flags.append('-DENABLE_NLS')
658
659     # use sparingly, prefer runtime profile
660     if Options.options.program_name.lower() == "mixbus":
661         compiler_flags.append ('-DMIXBUS')
662
663     if Options.options.program_name.lower() == "mixbus32c":
664         compiler_flags.append ('-DMIXBUS')
665         compiler_flags.append ('-DMIXBUS32C')
666
667     compiler_flags.append ('-DPROGRAM_NAME="' + Options.options.program_name + '"')
668     compiler_flags.append ('-DPROGRAM_VERSION="' + PROGRAM_VERSION + '"')
669
670     conf.env['PROGRAM_NAME'] = Options.options.program_name
671
672     if opt.debug:
673         conf.env.append_value('CFLAGS', debug_flags)
674         conf.env.append_value('CXXFLAGS', debug_flags)
675     else:
676         conf.env.append_value('CFLAGS', optimization_flags)
677         conf.env.append_value('CXXFLAGS', optimization_flags)
678
679     if opt.backtrace:
680         if platform != 'darwin' and not is_clang and not Options.options.dist_target == 'mingw':
681             linker_flags += [ '-rdynamic' ]
682
683     conf.env.append_value('CFLAGS', compiler_flags)
684     conf.env.append_value('CFLAGS', c_flags)
685     conf.env.append_value('CXXFLAGS', compiler_flags)
686     conf.env.append_value('CXXFLAGS', cxx_flags)
687     conf.env.append_value('LINKFLAGS', linker_flags)
688
689 def create_resource_file(icon):
690     try:
691         text = 'IDI_ICON1 ICON DISCARDABLE "icons/' + icon + '.ico"\n'
692         o = open('gtk2_ardour/windows_icon.rc', 'w')
693         o.write(text)
694         o.close()
695     except IOError:
696         print('Could not open gtk2_ardour/windows_icon.rc for writing\n')
697         sys.exit(-1)
698
699 def is_tracks_build (conf):
700         return conf.env['PROGRAM_NAME'] == 'Tracks Live'
701
702 #----------------------------------------------------------------
703
704 # Waf stages
705
706 def options(opt):
707     opt.load('compiler_c')
708     opt.load('compiler_cxx')
709     autowaf.set_options(opt, debug_by_default=True)
710     opt.add_option('--program-name', type='string', action='store', default='Ardour', dest='program_name',
711                     help='The user-visible name of the program being built')
712     opt.add_option('--arch', type='string', action='store', dest='arch',
713                     help='Architecture-specific compiler FLAGS')
714     opt.add_option('--with-backends', type='string', action='store', default='jack', dest='with_backends',
715                     help='Specify which backend modules are to be included(jack,alsa,dummy,portaudio,coreaudio)')
716     opt.add_option('--backtrace', action='store_true', default=False, dest='backtrace',
717                     help='Compile with -rdynamic -- allow obtaining backtraces from within Ardour')
718     opt.add_option('--no-carbon', action='store_true', default=False, dest='nocarbon',
719                     help='Compile without support for AU Plugins with only CARBON UI (needed for 64bit)')
720     opt.add_option('--boost-sp-debug', action='store_true', default=False, dest='boost_sp_debug',
721                     help='Compile with Boost shared pointer debugging')
722     opt.add_option('--debug-symbols', action='store_true', default=False, dest='debug_symbols',
723                     help='Add debug-symbols to optimized builds')
724     opt.add_option('--depstack-root', type='string', default='~', dest='depstack_root',
725                     help='Directory/folder where dependency stack trees (gtk, a3) can be found (defaults to ~)')
726     opt.add_option('--dist-target', type='string', default='auto', dest='dist_target',
727                     help='Specify the target for cross-compiling [auto,none,x86,i386,i686,x86_64,tiger,leopard,mingw,msvc]')
728     opt.add_option('--fpu-optimization', action='store_true', default=True, dest='fpu_optimization',
729                     help='Build runtime checked assembler code (default)')
730     opt.add_option('--no-fpu-optimization', action='store_false', dest='fpu_optimization')
731     opt.add_option('--exports-hidden', action='store_true', default=False, dest='exports_hidden')
732     opt.add_option('--freedesktop', action='store_true', default=False, dest='freedesktop',
733                     help='Build MIME type and .desktop files as per freedesktop.org standards (will be placed in build/gtk2_ardour)')
734     opt.add_option('--freebie', action='store_true', default=False, dest='freebie',
735                     help='Build a version suitable for distribution as a zero-cost binary')
736     opt.add_option('--profile', action='store_true', default=False, dest='profile',
737                     help='Compile for use with profiling tools requiring a frame pointer')
738     opt.add_option('--gprofile', action='store_true', default=False, dest='gprofile',
739                     help='Compile for use with gprofile')
740     opt.add_option('--libjack', type='string', default="auto", dest='libjack_link',
741                     help='libjack link mode  [auto|link|weak]')
742     opt.add_option('--internal-shared-libs', action='store_true', default=True, dest='internal_shared_libs',
743                    help='Build internal libs as shared libraries')
744     opt.add_option('--internal-static-libs', action='store_false', dest='internal_shared_libs',
745                    help='Build internal libs as static libraries')
746     opt.add_option('--use-external-libs', action='store_true', default=False, dest='use_external_libs',
747                    help='Use external/system versions of some bundled libraries')
748     opt.add_option('--keepflags', action='store_true', default=False, dest='keepflags',
749                     help='Do not ignore CFLAGS/CXXFLAGS environment vars')
750     opt.add_option('--luadoc', action='store_true', default=False, dest='luadoc',
751                     help='Compile Tool to dump LuaBindings (needs C++11)')
752     opt.add_option('--canvasui', action='store_true', default=False, dest='canvasui',
753                     help='Compile libcanvas test GUI')
754     opt.add_option('--beatbox', action='store_true', default=False, dest='beatbox',
755                     help='Compile beatbox test app')
756     opt.add_option('--lv2', action='store_true', default=True, dest='lv2',
757                     help='Compile with support for LV2 (if Lilv+Suil is available)')
758     opt.add_option('--no-lv2', action='store_false', dest='lv2',
759                     help='Do not compile with support for LV2')
760     opt.add_option('--lv2dir', type='string', help="install destination for builtin LV2 bundles [Default: LIBDIR/lv2]")
761     opt.add_option('--lxvst', action='store_true', default=True, dest='lxvst',
762                     help='Compile with support for linuxVST plugins')
763     opt.add_option('--no-lxvst', action='store_false', dest='lxvst',
764                     help='Compile without support for linuxVST plugins')
765     opt.add_option('--no-lrdf', action='store_true', dest='no_lrdf',
766                     help='Compile without support for LRDF LADSPA data even if present')
767     opt.add_option('--nls', action='store_true', default=True, dest='nls',
768                     help='Enable i18n (native language support) (default)')
769     opt.add_option('--no-nls', action='store_false', dest='nls')
770     opt.add_option('--phone-home', action='store_true', default=True, dest='phone_home',
771                    help='Contact ardour.org at startup for new announcements')
772     opt.add_option('--no-phone-home', action='store_false', dest='phone_home',
773                    help='Do not contact ardour.org at startup for new announcements')
774     opt.add_option('--stl-debug', action='store_true', default=False, dest='stl_debug',
775                     help='Build with debugging for the STL')
776     opt.add_option('--rt-alloc-debug', action='store_true', default=False, dest='rt_alloc_debug',
777                     help='Build with debugging for memory allocation in the real-time thread')
778     opt.add_option('--pt-timing', action='store_true', default=False, dest='pt_timing',
779                     help='Build with logging of timing in the process thread(s)')
780     opt.add_option('--denormal-exception', action='store_true', default=False, dest='denormal_exception',
781                     help='Raise a floating point exception if a denormal is detected')
782     opt.add_option('--test', action='store_true', default=False, dest='build_tests',
783                     help="Build unit tests")
784     opt.add_option('--run-tests', action='store_true', default=False, dest='run_tests',
785                     help="Run tests after build")
786     opt.add_option('--single-tests', action='store_true', default=False, dest='single_tests',
787                     help="Build a single executable for each unit test")
788     #opt.add_option('--tranzport', action='store_true', default=False, dest='tranzport',
789     # help='Compile with support for Frontier Designs Tranzport (if libusb is available)')
790     opt.add_option('--generic', action='store_true', default=False, dest='generic',
791                     help='Compile with -arch i386 (OS X ONLY)')
792     opt.add_option('--ppc', action='store_true', default=False, dest='ppc',
793                     help='Compile with -arch ppc (OS X ONLY)')
794     opt.add_option('--versioned', action='store_true', default=False, dest='versioned',
795                     help='Add revision information to executable name inside the build directory')
796     opt.add_option('--windows-vst', action='store_true', default=False, dest='windows_vst',
797                     help='Compile with support for Windows VST')
798     opt.add_option('--windows-key', type='string', action='store', dest='windows_key', default='Mod4><Super',
799                     help='X Modifier(s) (Mod1,Mod2, etc) for the Windows key (X11 builds only). ' +
800                     'Multiple modifiers must be separated by \'><\'')
801     opt.add_option('--boost-include', type='string', action='store', dest='boost_include', default='',
802                     help='directory where Boost header files can be found')
803     opt.add_option('--also-include', type='string', action='store', dest='also_include', default='',
804                     help='additional include directory where header files can be found (split multiples with commas)')
805     opt.add_option('--also-libdir', type='string', action='store', dest='also_libdir', default='',
806                     help='additional include directory where shared libraries can be found (split multiples with commas)')
807     opt.add_option('--wine-include', type='string', action='store', dest='wine_include', default='/usr/include/wine/windows',
808                     help='directory where Wine\'s Windows header files can be found')
809     opt.add_option('--noconfirm', action='store_true', default=False, dest='noconfirm',
810                     help='Do not ask questions that require confirmation during the build')
811     opt.add_option('--cxx11', action='store_true', default=False, dest='cxx11',
812                     help='Turn on c++11 compiler flags (-std=c++11)')
813     opt.add_option('--use-libc++', action='store_true', default=False, dest='use_libcpp',
814                     help='use libc++ instead of default or auto-detected stdlib')
815     opt.add_option('--address-sanitizer', action='store_true', default=False, dest='asan',
816                     help='Turn on AddressSanitizer (requires GCC >= 4.8 or clang >= 3.1)')
817     opt.add_option('--ptformat', action='store_true', default=False, dest='ptformat',
818                     help='Turn on PT session import option')
819     opt.add_option('--no-threaded-waveviews', action='store_true', default=False, dest='no_threaded_waveviews',
820                     help='Disable threaded waveview rendering')
821     opt.add_option(
822         '--qm-dsp-include', type='string', action='store',
823         dest='qm_dsp_include', default='/usr/include/qm-dsp',
824         help='directory where the header files of qm-dsp can be found')
825
826     for i in children:
827         opt.recurse(i)
828
829 def sub_config_and_use(conf, name, has_objects = True):
830     conf.recurse(name)
831     autowaf.set_local_lib(conf, name, has_objects)
832
833 def configure(conf):
834     conf.load('compiler_c')
835     conf.load('compiler_cxx')
836     if Options.options.dist_target == 'mingw':
837         conf.load('winres')
838
839     if Options.options.dist_target == 'msvc':
840         conf.env['MSVC_VERSIONS'] = ['msvc 10.0', 'msvc 9.0', 'msvc 8.0', 'msvc 7.1', 'msvc 7.0', 'msvc 6.0', ]
841         conf.env['MSVC_TARGETS'] = ['x64']
842         conf.load('msvc')
843
844     if Options.options.debug and not Options.options.keepflags:
845         # Nuke user CFLAGS/CXXFLAGS if debug is set (they likely contain -O3, NDEBUG, etc)
846         conf.env['CFLAGS'] = []
847         conf.env['CXXFLAGS'] = []
848
849     # freedesktop translations needs itstool > 1.0.3 (-j option)
850     if Options.options.freedesktop:
851         output = subprocess.Popen("itstool --version", shell=True, stderr=subprocess.STDOUT, stdout=subprocess.PIPE).communicate()[0].splitlines()
852         o = output[0].decode('utf-8')
853         itstool = o.split(' ')[0]
854         version = o.split(' ')[1].split('.')
855         # use  distutils.version.StrictVersion  or something python to check >= 1.0.4
856         # but first make sure that all build-hosts (incl. OSX-10.5/PPC) have that python lib.
857         # lazy approach: just use major version 2.X.X
858         if itstool != "itstool" or version[0] < "2":
859             print("--freedesktop requires itstool > 2.0.0 to translate files.")
860             sys.exit(-1)
861
862     conf.env['VERSION'] = VERSION
863     conf.env['MAJOR'] = MAJOR
864     conf.env['MINOR'] = MINOR
865     conf.env['MICRO'] = MICRO
866     conf.line_just = 52
867     autowaf.set_recursive()
868     autowaf.configure(conf)
869     autowaf.display_header('Ardour Configuration')
870
871     # systems with glibc have libintl builtin. systems without require explicit
872     # linkage against libintl.
873     #
874
875     pkg_config_path = os.getenv('PKG_CONFIG_PATH')
876     user_gtk_root = os.path.expanduser (Options.options.depstack_root + '/gtk/inst')
877
878     if pkg_config_path is not None and pkg_config_path.find (user_gtk_root) >= 0:
879         # told to search user_gtk_root
880         prefinclude = ''.join ([ '-I', user_gtk_root + '/include'])
881         preflib = ''.join ([ '-L', user_gtk_root + '/lib'])
882         conf.env.append_value('CFLAGS', [ prefinclude ])
883         conf.env.append_value('CXXFLAGS',  [prefinclude ])
884         conf.env.append_value('LINKFLAGS', [ preflib ])
885         autowaf.display_msg(conf, 'Will build against private GTK dependency stack in ' + user_gtk_root, 'yes')
886         conf.env['DEPSTACK_REV'] = get_depstack_rev (Options.options.depstack_root)
887     else:
888         autowaf.display_msg(conf, 'Will build against private GTK dependency stack', 'no')
889         conf.env['DEPSTACK_REV'] = '-system-'
890
891     if sys.platform == 'darwin':
892         conf.define ('NEED_INTL', 1)
893         autowaf.display_msg(conf, 'Will use explicit linkage against libintl in ' + user_gtk_root, 'yes')
894     else:
895         # libintl is part of the system, so use it
896         autowaf.display_msg(conf, 'Will rely on libintl built into libc', 'yes')
897
898     user_ardour_root = os.path.expanduser (Options.options.depstack_root + '/a3/inst')
899     if pkg_config_path is not None and pkg_config_path.find (user_ardour_root) >= 0:
900         # told to search user_ardour_root
901         prefinclude = ''.join ([ '-I', user_ardour_root + '/include'])
902         preflib = ''.join ([ '-L', user_ardour_root + '/lib'])
903         conf.env.append_value('CFLAGS', [ prefinclude ])
904         conf.env.append_value('CXXFLAGS',  [prefinclude ])
905         conf.env.append_value('LINKFLAGS', [ preflib ])
906         autowaf.display_msg(conf, 'Will build against private Ardour dependency stack in ' + user_ardour_root, 'yes')
907     else:
908         autowaf.display_msg(conf, 'Will build against private Ardour dependency stack', 'no')
909
910     if Options.options.freebie:
911         conf.env.append_value ('CFLAGS', '-DSILENCE_AFTER')
912         conf.env.append_value ('CXXFLAGS', '-DSILENCE_AFTER')
913         conf.define ('FREEBIE', 1)
914
915     if Options.options.lv2dir:
916         conf.env['LV2DIR'] = Options.options.lv2dir
917     else:
918         conf.env['LV2DIR'] = os.path.join(conf.env['LIBDIR'], 'ardour' + str(conf.env['MAJOR']), 'LV2')
919
920     conf.env['LV2DIR'] = os.path.normpath(conf.env['LV2DIR'])
921
922     if sys.platform == 'darwin':
923
924         # this is required, potentially, for anything we link and then relocate into a bundle
925         conf.env.append_value('LINKFLAGS', [ '-Xlinker', '-headerpad_max_install_names' ])
926
927         conf.define ('HAVE_COREAUDIO', 1)
928         conf.define ('AUDIOUNIT_SUPPORT', 1)
929
930         if not Options.options.ppc:
931             conf.define('MACVST_SUPPORT', 1)
932
933         conf.define ('TOP_MENUBAR',1)
934
935         # It would be nice to be able to use this to force back-compatibility with 10.4
936         # but even by the time of 11, the 10.4 SDK is no longer available in any normal
937         # way.
938         #
939         #conf.env.append_value('CXXFLAGS_OSX', "-isysroot /Developer/SDKs/MacOSX10.4u.sdk")
940         #conf.env.append_value('CFLAGS_OSX', "-isysroot /Developer/SDKs/MacOSX10.4u.sdk")
941         #conf.env.append_value('LINKFLAGS_OSX', "-sysroot /Developer/SDKs/MacOSX10.4u.sdk")
942         #conf.env.append_value('LINKFLAGS_OSX', "-sysroot /Developer/SDKs/MacOSX10.4u.sdk")
943
944         conf.env.append_value('CXXFLAGS_OSX', "-msse")
945         conf.env.append_value('CFLAGS_OSX', "-msse")
946         conf.env.append_value('CXXFLAGS_OSX', "-msse2")
947         conf.env.append_value('CFLAGS_OSX', "-msse2")
948         #
949         #       TODO: The previous sse flags NEED to be based
950         #       off processor type.  Need to add in a check
951         #       for that.
952         #
953         conf.env.append_value('CXXFLAGS_OSX', '-F/System/Library/Frameworks')
954         conf.env.append_value('CXXFLAGS_OSX', '-F/Library/Frameworks')
955
956         conf.env.append_value('LINKFLAGS_OSX', ['-framework', 'AppKit'])
957         conf.env.append_value('LINKFLAGS_OSX', ['-framework', 'CoreAudio'])
958         conf.env.append_value('LINKFLAGS_OSX', ['-framework', 'CoreAudioKit'])
959         conf.env.append_value('LINKFLAGS_OSX', ['-framework', 'CoreFoundation'])
960         conf.env.append_value('LINKFLAGS_OSX', ['-framework', 'CoreServices'])
961
962         conf.env.append_value('LINKFLAGS_OSX', ['-undefined', 'dynamic_lookup' ])
963         conf.env.append_value('LINKFLAGS_OSX', ['-flat_namespace'])
964
965         conf.env.append_value('CXXFLAGS_AUDIOUNITS', "-DAUDIOUNIT_SUPPORT")
966         conf.env.append_value('LINKFLAGS_AUDIOUNITS', ['-framework', 'AudioToolbox', '-framework', 'AudioUnit'])
967         conf.env.append_value('LINKFLAGS_AUDIOUNITS', ['-framework', 'Cocoa'])
968
969         if (
970                 # osx up to and including 10.6 (uname 10.X.X)
971                 (re.search ("^[1-9][0-9]\.", os.uname()[2]) == None or not re.search ("^10\.", os.uname()[2]) == None)
972                 and (Options.options.generic or Options.options.ppc)
973                 and not Options.options.nocarbon
974            ):
975             conf.env.append_value('CXXFLAGS_AUDIOUNITS', "-DWITH_CARBON")
976             conf.env.append_value('LINKFLAGS_AUDIOUNITS', ['-framework', 'Carbon'])
977         else:
978             print ('No Carbon support available for this build\n')
979
980
981     if Options.options.canvasui:
982         conf.env['CANVASTESTUI'] = True
983         conf.define ('CANVASTESTUI', 1)
984
985     if Options.options.beatbox:
986         conf.env['BEATBOX'] = True
987         conf.define ('BEATBOX', 1)
988
989     if Options.options.luadoc:
990         conf.env['LUABINDINGDOC'] = True
991         conf.define ('LUABINDINGDOC', 1)
992
993     if Options.options.internal_shared_libs:
994         conf.define('INTERNAL_SHARED_LIBS', 1)
995
996     if Options.options.use_external_libs:
997         conf.define('USE_EXTERNAL_LIBS', 1)
998         conf.env.append_value(
999             'CXXFLAGS', '-I' + Options.options.qm_dsp_include)
1000
1001     if Options.options.boost_include != '':
1002         conf.env.append_value('CXXFLAGS', '-I' + Options.options.boost_include)
1003
1004     if Options.options.also_include != '':
1005         conf.env.append_value('CXXFLAGS', '-I' + Options.options.also_include)
1006         conf.env.append_value('CFLAGS', '-I' + Options.options.also_include)
1007
1008     if Options.options.also_libdir != '':
1009         conf.env.append_value('LDFLAGS', '-L' + Options.options.also_libdir)
1010
1011     if Options.options.boost_sp_debug:
1012         conf.env.append_value('CXXFLAGS', '-DBOOST_SP_ENABLE_DEBUG_HOOKS')
1013
1014     # executing a test program is n/a when cross-compiling
1015     if Options.options.dist_target != 'mingw':
1016         if Options.options.dist_target != 'msvc' and re.search ("openbsd", sys.platform) == None:
1017             if re.search ("freebsd", sys.platform) != None:
1018                 conf.check_cc(function_name='dlopen', header_name='dlfcn.h', uselib_store='DL')
1019             else:
1020                 conf.check_cc(function_name='dlopen', header_name='dlfcn.h', lib='dl', uselib_store='DL')
1021         conf.check_cxx(fragment = "#include <boost/version.hpp>\nint main(void) { return (BOOST_VERSION >= 103900 ? 0 : 1); }\n",
1022                   execute = "1",
1023                   mandatory = True,
1024                   msg = 'Checking for boost library >= 1.39',
1025                   okmsg = 'ok',
1026                   errmsg = 'too old\nPlease install boost version 1.39 or higher.')
1027
1028     if re.search ("linux", sys.platform) != None and Options.options.dist_target != 'mingw':
1029         autowaf.check_pkg(conf, 'alsa', uselib_store='ALSA')
1030
1031     if re.search ("openbsd", sys.platform) != None:
1032         conf.env.append_value('LDFLAGS', '-L/usr/X11R6/lib')
1033
1034     autowaf.check_pkg(conf, 'glib-2.0', uselib_store='GLIB', atleast_version='2.28', mandatory=True)
1035     autowaf.check_pkg(conf, 'gthread-2.0', uselib_store='GTHREAD', atleast_version='2.2', mandatory=True)
1036     autowaf.check_pkg(conf, 'glibmm-2.4', uselib_store='GLIBMM', atleast_version='2.32.0', mandatory=True)
1037     autowaf.check_pkg(conf, 'sndfile', uselib_store='SNDFILE', atleast_version='1.0.18', mandatory=True)
1038     autowaf.check_pkg(conf, 'giomm-2.4', uselib_store='GIOMM', atleast_version='2.2', mandatory=True)
1039     autowaf.check_pkg(conf, 'libcurl', uselib_store='CURL', atleast_version='7.0.0', mandatory=True)
1040     autowaf.check_pkg(conf, 'libarchive', uselib_store='ARCHIVE', atleast_version='3.0.0', mandatory=True)
1041     autowaf.check_pkg(conf, 'liblo', uselib_store='LO', atleast_version='0.26', mandatory=True)
1042     autowaf.check_pkg(conf, 'taglib', uselib_store='TAGLIB', atleast_version='1.6', mandatory=True)
1043     autowaf.check_pkg(conf, 'vamp-sdk', uselib_store='VAMPSDK', atleast_version='2.1', mandatory=True)
1044     autowaf.check_pkg(conf, 'vamp-hostsdk', uselib_store='VAMPHOSTSDK', atleast_version='2.1', mandatory=True)
1045     autowaf.check_pkg(conf, 'rubberband', uselib_store='RUBBERBAND', mandatory=True)
1046
1047     have_rf64_riff_support = conf.check_cc(fragment = '''
1048 #include <sndfile.h>
1049 int main () { int x = SFC_RF64_AUTO_DOWNGRADE; return 0; }
1050 ''',
1051                                            features  = 'c',
1052                                            mandatory = False,
1053                                            execute   = False,
1054                                            use = 'SNDFILE',
1055                                            msg       = 'Checking for  sndfile RF64=>RIFF support',
1056                                            okmsg = 'Found',
1057                                            errmsg = 'Not found, no RF64-to-WAV support')
1058
1059     if have_rf64_riff_support:
1060             conf.env.append_value('CXXFLAGS', "-DHAVE_RF64_RIFF")
1061             conf.env.append_value('CFLAGS', "-DHAVE_RF64_RIFF")
1062
1063     if Options.options.dist_target == 'mingw':
1064         Options.options.fpu_optimization = True
1065         conf.env.append_value('CFLAGS', '-DPLATFORM_WINDOWS')
1066         conf.env.append_value('CFLAGS', '-DCOMPILER_MINGW')
1067         conf.env.append_value('CXXFLAGS', '-DPLATFORM_WINDOWS')
1068         conf.env.append_value('CXXFLAGS', '-DCOMPILER_MINGW')
1069         if conf.options.cxx11:
1070             conf.env.append_value('CFLAGS', '-D_USE_MATH_DEFINES')
1071             conf.env.append_value('CXXFLAGS', '-D_USE_MATH_DEFINES')
1072             conf.env.append_value('CFLAGS', '-DWIN32')
1073             conf.env.append_value('CXXFLAGS', '-DWIN32')
1074         conf.env.append_value('LIB', 'pthread')
1075         # needed for at least libsmf
1076         conf.check_cc(function_name='htonl', header_name='winsock2.h', lib='ws2_32')
1077         conf.env.append_value('LIB', 'ws2_32')
1078         conf.env.append_value('LIB', 'winmm')
1079         # needed for mingw64 packages, not harmful on normal mingw build
1080         conf.env.append_value('LIB', 'intl')
1081         conf.check_cc(function_name='regcomp', header_name='regex.h',
1082                       lib='regex', uselib_store="REGEX", define_name='HAVE_REGEX_H')
1083         # TODO put this only where it is needed
1084         conf.env.append_value('LIB', 'regex')
1085         # TODO this should only be necessary for a debug build
1086         conf.env.append_value('LIB', 'dbghelp')
1087
1088         # work around GdkDrawable BitBlt performance issue on windows
1089         # see http://gareus.org/wiki/ardour_windows_gdk_and_cairo
1090         conf.env.append_value('CFLAGS', '-DUSE_CAIRO_IMAGE_SURFACE')
1091         conf.env.append_value('CXXFLAGS', '-DUSE_CAIRO_IMAGE_SURFACE')
1092         conf.define ('WINDOWS', 1)
1093
1094         have_ptw_semaphore = conf.check_cc(fragment = '''
1095 #include <pthread.h>
1096 #include <semaphore.h>
1097 int main () { return 0; }
1098 ''',
1099                                            features  = 'c',
1100                                            mandatory = False,
1101                                            execute   = False,
1102                                            msg       = 'Checking for pthread posix semaphore',
1103                                            okmsg     = 'Found',
1104                                            errmsg    = 'Not found, falling back to Windows Semaphore.')
1105
1106         #if have_ptw_semaphore:
1107         #    conf.define('USE_PTW32_SEMAPHORE', 1)
1108         #    conf.env.append_value('CFLAGS', '-DUSE_PTW32_SEMAPHORE')
1109         #    conf.env.append_value('CXXFLAGS', '-DUSE_PTW32_SEMAPHORE')
1110
1111     if Options.options.dist_target == 'msvc':
1112         conf.env.append_value('CFLAGS', '-DPLATFORM_WINDOWS')
1113         conf.env.append_value('CFLAGS', '-DCOMPILER_MSVC')
1114         conf.env.append_value('CXXFLAGS', '-DPLATFORM_WINDOWS')
1115         conf.env.append_value('CXXFLAGS', '-DCOMPILER_MSVC')
1116         # work around GdkDrawable BitBlt performance issue on windows
1117         # see http://gareus.org/wiki/ardour_windows_gdk_and_cairo
1118         conf.env.append_value('CFLAGS', '-DUSE_CAIRO_IMAGE_SURFACE')
1119         conf.env.append_value('CXXFLAGS', '-DUSE_CAIRO_IMAGE_SURFACE')
1120         # MORE STUFF PROBABLY NEEDED HERE
1121         conf.define ('WINDOWS', 1)
1122
1123     # Tell everyone that this is a waf build
1124
1125     conf.env.append_value('CFLAGS', '-DWAF_BUILD')
1126     conf.env.append_value('CXXFLAGS', '-DWAF_BUILD')
1127
1128     opts = Options.options
1129
1130     # (optionally) Adopt Microsoft-like convention that makes all non-explicitly exported
1131     # symbols invisible (rather than doing this all over the wscripts in the src tree)
1132     #
1133     # This won't apply to MSVC but that hasn't been added as a target yet
1134     #
1135     # We can't do this till all tests are complete, since some fail if this is et.
1136     if opts.exports_hidden:
1137         conf.define ('EXPORT_VISIBILITY_HIDDEN', True)
1138         if opts.internal_shared_libs:
1139             conf.env.append_value ('CXXFLAGS', '-fvisibility=hidden')
1140             conf.env.append_value ('CFLAGS', '-fvisibility=hidden')
1141     else:
1142         conf.define ('EXPORT_VISIBILITY_HIDDEN', False)
1143
1144     # Set up waf environment and C defines
1145     if opts.phone_home:
1146         conf.define('PHONE_HOME', 1)
1147         conf.env['PHONE_HOME'] = True
1148     if opts.fpu_optimization:
1149         conf.env['FPU_OPTIMIZATION'] = True
1150     if opts.freedesktop:
1151         conf.env['FREEDESKTOP'] = True
1152     if opts.nls:
1153         conf.define('ENABLE_NLS', 1)
1154         conf.env['ENABLE_NLS'] = True
1155     if opts.build_tests:
1156         conf.env['BUILD_TESTS'] = True
1157         conf.env['RUN_TESTS'] = opts.run_tests
1158     if opts.single_tests:
1159         conf.env['SINGLE_TESTS'] = opts.single_tests
1160     #if opts.tranzport:
1161     #    conf.env['TRANZPORT'] = 1
1162     if opts.windows_vst:
1163         conf.define('WINDOWS_VST_SUPPORT', 1)
1164         conf.env['WINDOWS_VST_SUPPORT'] = True
1165         if not Options.options.dist_target == 'mingw':
1166             conf.env.append_value('CFLAGS', '-I' + Options.options.wine_include)
1167             conf.env.append_value('CXXFLAGS', '-I' + Options.options.wine_include)
1168             autowaf.check_header(conf, 'cxx', 'windows.h', mandatory = True)
1169     if opts.lxvst:
1170         if sys.platform == 'darwin':
1171             conf.env['LXVST_SUPPORT'] = False
1172         elif Options.options.dist_target == 'mingw':
1173             conf.env['LXVST_SUPPORT'] = False
1174         else:
1175             conf.define('LXVST_SUPPORT', 1)
1176             conf.env['LXVST_SUPPORT'] = True
1177     conf.env['WINDOWS_KEY'] = opts.windows_key
1178     if opts.rt_alloc_debug:
1179         conf.define('DEBUG_RT_ALLOC', 1)
1180         conf.env['DEBUG_RT_ALLOC'] = True
1181     if opts.pt_timing:
1182         conf.define('PT_TIMING', 1)
1183         conf.env['PT_TIMING'] = True
1184     if opts.denormal_exception:
1185         conf.define('DEBUG_DENORMAL_EXCEPTION', 1)
1186         conf.env['DEBUG_DENORMAL_EXCEPTION'] = True
1187     if opts.build_tests:
1188         autowaf.check_pkg(conf, 'cppunit', uselib_store='CPPUNIT', atleast_version='1.12.0', mandatory=True)
1189     if opts.ptformat:
1190         conf.define('PTFORMAT', 1)
1191         conf.env['PTFORMAT'] = True
1192     if opts.no_threaded_waveviews:
1193         conf.define('NO_THREADED_WAVEVIEWS', 1)
1194         conf.env['NO_THREADED_WAVEVIEWS'] = True
1195
1196     backends = opts.with_backends.split(',')
1197     if opts.build_tests and 'dummy' not in backends:
1198         backends += ['dummy']
1199
1200     if not backends:
1201         print("Must configure and build at least one backend")
1202         sys.exit(1)
1203
1204     conf.env['BACKENDS'] = backends
1205     conf.env['BUILD_JACKBACKEND'] = any('jack' in b for b in backends)
1206     conf.env['BUILD_ALSABACKEND'] = any('alsa' in b for b in backends)
1207     conf.env['BUILD_DUMMYBACKEND'] = any('dummy' in b for b in backends)
1208     conf.env['BUILD_PABACKEND'] = any('portaudio' in b for b in backends)
1209     conf.env['BUILD_CORECRAPPITA'] = any('coreaudio' in b for b in backends)
1210
1211     if re.search ("linux", sys.platform) != None and Options.options.dist_target != 'mingw' and conf.env['BUILD_PABACKEND']:
1212         print("PortAudio Backend is not for Linux")
1213         sys.exit(1)
1214
1215     if sys.platform != 'darwin' and conf.env['BUILD_CORECRAPPITA']:
1216         print("Coreaudio backend is only available for OSX")
1217         sys.exit(1)
1218
1219     if re.search ("linux", sys.platform) == None and conf.env['BUILD_ALSABACKEND']:
1220         print("ALSA Backend is only available on Linux")
1221         sys.exit(1)
1222
1223     set_compiler_flags (conf, Options.options)
1224
1225     if sys.platform == 'darwin':
1226         sub_config_and_use(conf, 'libs/appleutility')
1227     elif re.search ("openbsd", sys.platform) != None:
1228         pass
1229     elif Options.options.dist_target != 'mingw':
1230         sub_config_and_use(conf, 'tools/sanity_check')
1231         sub_config_and_use(conf, 'tools/gccabicheck')
1232
1233     sub_config_and_use(conf, 'libs/clearlooks-newer')
1234
1235     for i in children:
1236         sub_config_and_use(conf, i)
1237
1238     # Fix utterly braindead FLAC include path to not smash assert.h
1239     conf.env['INCLUDES_FLAC'] = []
1240
1241     config_text = open('libs/ardour/config_text.cc', "w")
1242     config_text.write('''#include "ardour/ardour.h"
1243 namespace ARDOUR {
1244 const char* const ardour_config_info = "\\n\\
1245 ''')
1246
1247     def write_config_text(title, val):
1248         autowaf.display_msg(conf, title, val)
1249         config_text.write(title + ': ')
1250         config_text.write(str(val).replace ('"', '\\"'))
1251         config_text.write("\\n\\\n")
1252
1253     write_config_text('Build documentation',   conf.env['DOCS'])
1254     write_config_text('Debuggable build',      conf.env['DEBUG'])
1255     write_config_text('Export all symbols (backtrace)', opts.backtrace)
1256     write_config_text('Install prefix',        conf.env['PREFIX'])
1257     write_config_text('Strict compiler flags', conf.env['STRICT'])
1258     write_config_text('Internal Shared Libraries', conf.is_defined('INTERNAL_SHARED_LIBS'))
1259     write_config_text('Use External Libraries', conf.is_defined('USE_EXTERNAL_LIBS'))
1260     write_config_text('Library exports hidden', conf.is_defined('EXPORT_VISIBILITY_HIDDEN'))
1261     write_config_text('Free/Demo copy',        conf.is_defined('FREEBIE'))
1262     config_text.write("\\n\\\n")
1263     write_config_text('ALSA DBus Reservation', conf.is_defined('HAVE_DBUS'))
1264     write_config_text('Architecture flags',    opts.arch)
1265     write_config_text('Aubio',                 conf.is_defined('HAVE_AUBIO'))
1266     write_config_text('AudioUnits',            conf.is_defined('AUDIOUNIT_SUPPORT'))
1267     write_config_text('Build target',          conf.env['build_target'])
1268     write_config_text('Canvas Test UI',        conf.is_defined('CANVASTESTUI'))
1269     write_config_text('Beatbox test app',      conf.is_defined('BEATBOX'))
1270     write_config_text('CoreAudio',             conf.is_defined('HAVE_COREAUDIO'))
1271     write_config_text('CoreAudio 10.5 compat', conf.is_defined('COREAUDIO105'))
1272     write_config_text('Debug RT allocations',  conf.is_defined('DEBUG_RT_ALLOC'))
1273     write_config_text('Debug Symbols',         conf.is_defined('debug_symbols') or conf.env['DEBUG'])
1274     write_config_text('Denormal exceptions',   conf.is_defined('DEBUG_DENORMAL_EXCEPTION'))
1275     write_config_text('FLAC',                  conf.is_defined('HAVE_FLAC'))
1276     write_config_text('FPU optimization',      opts.fpu_optimization)
1277     write_config_text('Freedesktop files',     opts.freedesktop)
1278     write_config_text('Libjack linking',       conf.env['libjack_link'])
1279     write_config_text('Libjack metadata',      conf.is_defined ('HAVE_JACK_METADATA'))
1280     write_config_text('Lua Binding Doc',       conf.is_defined('LUABINDINGDOC'))
1281     write_config_text('LV2 UI embedding',      conf.is_defined('HAVE_SUIL'))
1282     write_config_text('LV2 support',           conf.is_defined('LV2_SUPPORT'))
1283     write_config_text('LV2 extensions',        conf.is_defined('LV2_EXTENDED'))
1284     write_config_text('LXVST support',         conf.is_defined('LXVST_SUPPORT'))
1285     write_config_text('Mac VST support',       conf.is_defined('MACVST_SUPPORT'))
1286     write_config_text('OGG',                   conf.is_defined('HAVE_OGG'))
1287     write_config_text('Phone home',            conf.is_defined('PHONE_HOME'))
1288     write_config_text('Process thread timing', conf.is_defined('PT_TIMING'))
1289     write_config_text('Program name',          opts.program_name)
1290     write_config_text('Samplerate',            conf.is_defined('HAVE_SAMPLERATE'))
1291     write_config_text('PT format',             conf.is_defined('PTFORMAT'))
1292     write_config_text('PTW32 Semaphore',       conf.is_defined('USE_PTW32_SEMAPHORE'))
1293 #    write_config_text('Soundtouch',            conf.is_defined('HAVE_SOUNDTOUCH'))
1294     write_config_text('Threaded WaveViews',    not opts.no_threaded_waveviews)
1295     write_config_text('Translation',           opts.nls)
1296 #    write_config_text('Tranzport',             opts.tranzport)
1297     write_config_text('Unit tests',            conf.env['BUILD_TESTS'])
1298     write_config_text('Windows VST support',   opts.windows_vst)
1299     write_config_text('Wiimote support',       conf.is_defined('BUILD_WIIMOTE'))
1300     write_config_text('Windows key',           opts.windows_key)
1301     config_text.write("\\n\\\n")
1302     write_config_text('PortAudio Backend',     conf.env['BUILD_PABACKEND'])
1303     write_config_text('CoreAudio/Midi Backend',conf.env['BUILD_CORECRAPPITA'])
1304     write_config_text('ALSA Backend',          conf.env['BUILD_ALSABACKEND'])
1305     write_config_text('Dummy backend',         conf.env['BUILD_DUMMYBACKEND'])
1306     write_config_text('JACK Backend',          conf.env['BUILD_JACKBACKEND'])
1307     config_text.write("\\n\\\n")
1308     write_config_text('Builstack', conf.env['DEPSTACK_REV'])
1309     write_config_text('Mac i386 Architecture', opts.generic)
1310     write_config_text('Mac ppc Architecture',  opts.ppc)
1311     config_text.write("\\n\\\n")
1312     write_config_text('C compiler flags',      conf.env['CFLAGS'])
1313     write_config_text('C++ compiler flags',    conf.env['CXXFLAGS'])
1314     write_config_text('Linker flags',          conf.env['LINKFLAGS'])
1315
1316     config_text.write ('";\n}\n')
1317     config_text.close ()
1318     print('')
1319
1320     if Options.options.dist_target == 'mingw' or Options.options.dist_target == 'msvc':
1321         create_resource_file(Options.options.program_name)
1322
1323 def build(bld):
1324     create_stored_revision()
1325
1326     # add directories that contain only headers, to workaround an issue with waf
1327
1328     if not bld.is_defined('USE_EXTERNAL_LIBS'):
1329         bld.path.find_dir ('libs/libltc/ltc')
1330     bld.path.find_dir ('libs/evoral/evoral')
1331     bld.path.find_dir ('libs/surfaces/control_protocol/control_protocol')
1332     bld.path.find_dir ('libs/timecode/timecode')
1333     bld.path.find_dir ('libs/gtkmm2ext/gtkmm2ext')
1334     bld.path.find_dir ('libs/ardour/ardour')
1335     bld.path.find_dir ('libs/pbd/pbd')
1336
1337     # set up target directories
1338     lwrcase_dirname = 'ardour' + bld.env['MAJOR']
1339
1340     if bld.is_tracks_build():
1341         bld.env.append_value ('CXXFLAGS', '-DUSE_TRACKS_CODE_FEATURES')
1342         bld.env.append_value ('CFLAGS', '-DUSE_TRACKS_CODE_FEATURES')
1343         lwrcase_dirname = 'trx'
1344
1345     # configuration files go here
1346     bld.env['CONFDIR'] = os.path.join(bld.env['SYSCONFDIR'], lwrcase_dirname)
1347     # data files loaded at run time go here
1348     bld.env['DATADIR'] = os.path.join(bld.env['DATADIR'], lwrcase_dirname)
1349     # shared objects loaded at runtime go here (two aliases)
1350     bld.env['DLLDIR'] = os.path.join(bld.env['LIBDIR'], lwrcase_dirname)
1351     bld.env['LIBDIR'] = bld.env['DLLDIR']
1352     bld.env['LOCALEDIR'] = os.path.join(bld.env['DATADIR'], 'locale')
1353     bld.env['lwrcase_dirname'] = lwrcase_dirname;
1354
1355     autowaf.set_recursive()
1356
1357     if sys.platform == 'darwin':
1358         bld.recurse('libs/appleutility')
1359     elif re.search ("openbsd", sys.platform) != None:
1360         pass
1361     elif bld.env['build_target'] != 'mingw':
1362         bld.recurse('tools/sanity_check')
1363         bld.recurse('tools/gccabicheck')
1364
1365     bld.recurse('libs/clearlooks-newer')
1366
1367     for i in children:
1368         bld.recurse(i)
1369
1370     if bld.is_defined ('BEATBOX'):
1371         bld.recurse('tools/bb')
1372             
1373     bld.install_files (bld.env['CONFDIR'], 'system_config')
1374
1375     bld.install_files (os.path.join (bld.env['DATADIR'], 'templates'), bld.path.ant_glob ('templates/**'), cwd=bld.path.find_dir ('templates'), relative_trick=True)
1376
1377     if bld.env['RUN_TESTS']:
1378         bld.add_post_fun(test)
1379
1380 def i18n(bld):
1381     print(bld.env)
1382     bld.recurse (i18n_children)
1383
1384 def i18n_pot(bld):
1385     bld.recurse (i18n_children)
1386
1387 def i18n_po(bld):
1388     bld.recurse (i18n_children)
1389
1390 def i18n_mo(bld):
1391     bld.recurse (i18n_children)
1392
1393 def tarball(bld):
1394     create_stored_revision()
1395
1396 def test(bld):
1397     subprocess.call("gtk2_ardour/artest")
1398
1399 def help2man(bld):
1400     cmd = "help2man -s 1 -N -o ardour.1 -n Ardour --version-string='Ardour %s' gtk2_ardour/ardev" % PROGRAM_VERSION
1401     subprocess.call(cmd, shell=True)