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