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