2 from waflib.extras import autowaf as autowaf
3 from waflib import Options
9 import platform as PLATFORM
10 from waflib.Tools import winres
12 compiler_flags_dictionaries= {
14 # Flags required when building a debug build
15 'debuggable' : [ '-O0', '-g' ],
16 # Flags required for the linker (if any) when building a debug build
17 'linker-debuggable' : '',
18 # Flags required when building a non-debug optimized build
19 'nondebuggable' : '-DNDEBUG',
20 # Flags required to enable profiling at runtime
22 # Flags required to disable warnings about unused arguments to function calls
23 'silence-unused-arguments' : '',
24 # Flags required to use SSE unit for general math
26 # Flags required to use SSE unit for floating point math
27 'fpmath-sse' : '-mfpmath=sse',
28 # Flags required to use XMM Intrinsics
29 'xmmintrinsics' : '-DUSE_XMMINTRIN',
30 # Flags to use posix pipes between compiler stages
32 # Flags for maximally optimized build
33 'full-optimization' : [ '-O3', '-fomit-frame-pointer', '-ffast-math', '-fstrength-reduce', ],
34 # Flag to ensure that compiler error output includes column/line numbers
35 'show-column' : '-fshow-column',
36 # Flags required to build for x86 only (OS X feature)
38 # Flags required to build for PowerPC only (OS X feature)
40 # All flags required to get basic warnings to be generated by the compiler
41 'basic-warnings' : [ '-Wall', '-Wpointer-arith', '-Wcast-qual', '-Wcast-align', '-Wno-unused-parameter' ],
42 # Any additional flags for warnings that are specific to C (not C++)
43 'extra-c-warnings' : [ '-Wstrict-prototypes', '-Wmissing-prototypes' ],
44 # Any additional flags for warnings that are specific to C++ (not C)
45 'extra-cxx-warnings' : [ '-Woverloaded-virtual', '-Wno-unused-local-typedefs' ],
46 # Flags used for "strict" compilation, C and C++ (i.e. compiler will warn about language issues)
47 'strict' : ['-Wall', '-Wcast-align', '-Wextra', '-Wwrite-strings', '-Wunsafe-loop-optimizations', '-Wlogical-op' ],
48 # Flags used for "strict" compilation, C only (i.e. compiler will warn about language issues)
49 'c-strict' : ['-std=c99', '-pedantic', '-Wshadow'],
50 # Flags used for "strict" compilation, C++ only (i.e. compiler will warn about language issues)
51 'cxx-strict' : [ '-ansi', '-Wnon-virtual-dtor', '-Woverloaded-virtual', '-fstrict-overflow' ],
52 # Flags required for whatever consider the strictest possible compilation
53 'ultra-strict' : ['-Wredundant-decls', '-Wstrict-prototypes', '-Wmissing-prototypes'],
54 # Flag to turn on C99 compliance by itself
58 'debuggable' : ['/Od', '/Zi', '/MTd'],
59 'linker-debuggable' : ['/DEBUG' ],
60 'nondebuggable' : [ '/MD', '-DNDEBUG' ],
62 'silence-unused-arguments' : '',
67 'full-optimization' : '',
68 'no-frame-pointer' : '',
70 'strength-reduce' : '',
74 'basic-warnings' : '',
75 'extra-c-warnings' : '',
76 'extra-cxx-warnings' : '',
85 # Copy, edit and insert variants on gcc dict for gcc-darwin and clang
87 gcc_darwin_dict = compiler_flags_dictionaries['gcc'].copy()
88 gcc_darwin_dict['extra-cxx-warnings'] = [ '-Woverloaded-virtual' ]
89 gcc_darwin_dict['cxx-strict'] = [ '-ansi', '-Wnon-virtual-dtor', '-Woverloaded-virtual' ]
90 gcc_darwin_dict['strict'] = ['-Wall', '-Wcast-align', '-Wextra', '-Wwrite-strings' ]
91 gcc_darwin_dict['generic-x86'] = [ '-arch', 'i386' ]
92 gcc_darwin_dict['generic-ppc'] = [ '-arch', 'ppc' ]
93 compiler_flags_dictionaries['gcc-darwin'] = gcc_darwin_dict;
95 clang_dict = compiler_flags_dictionaries['gcc'].copy();
96 clang_dict['sse'] = ''
97 clang_dict['fpmath-sse'] = ''
98 clang_dict['xmmintrinsics'] = ''
99 clang_dict['silence-unused-arguments'] = '-Qunused-arguments'
100 clang_dict['extra-cxx-warnings'] = [ '-Woverloaded-virtual', '-Wno-mismatched-tags' ]
101 clang_dict['cxx-strict'] = [ '-ansi', '-Wnon-virtual-dtor', '-Woverloaded-virtual', '-fstrict-overflow' ]
102 clang_dict['strict'] = ['-Wall', '-Wcast-align', '-Wextra', '-Wwrite-strings' ]
103 compiler_flags_dictionaries['clang'] = clang_dict;
105 clang_darwin_dict = compiler_flags_dictionaries['clang'].copy();
106 clang_darwin_dict['cxx-strict'] = [ '-ansi', '-Wnon-virtual-dtor', '-Woverloaded-virtual', ]
107 compiler_flags_dictionaries['clang-darwin'] = clang_darwin_dict;
109 def fetch_git_revision ():
110 cmd = "git describe HEAD"
111 output = subprocess.Popen(cmd, shell=True, stderr=subprocess.STDOUT, stdout=subprocess.PIPE).communicate()[0].splitlines()
112 rev = output[0].decode ('utf-8')
115 def fetch_tarball_revision ():
116 if not os.path.exists ('libs/ardour/revision.cc'):
117 print ('This tarball was not created correctly - it is missing libs/ardour/revision.cc')
119 with open('libs/ardour/revision.cc') as f:
120 content = f.readlines()
121 remove_punctuation_map = dict((ord(char), None) for char in '";')
122 return content[1].decode('utf-8').strip().split(' ')[7].translate (remove_punctuation_map)
124 if os.path.isdir (os.path.join(os.getcwd(), '.git')):
125 rev = fetch_git_revision ()
127 rev = fetch_tarball_revision ()
130 # rev is now of the form MAJOR.MINOR-rev-commit
131 # or, if right at the same rev as a release, MAJOR.MINOR
134 parts = rev.split ('.')
136 other = parts[1].split ('-')
143 V = MAJOR + '.' + MINOR + '.' + MICRO
145 PROGRAM_VERSION = MAJOR
147 # Mandatory variables
152 # optionally external libraries
156 # core ardour libraries
168 'libs/plugins/reasonablesynth.lv2',
175 # shared helper binaries (plugin-scanner, exec-wrapper)
178 'libs/ardouralsautil',
189 def fetch_gcc_version (CC):
190 cmd = "%s --version" % CC
191 output = subprocess.Popen(cmd, shell=True, stderr=subprocess.STDOUT, stdout=subprocess.PIPE).communicate()[0].splitlines()
192 o = output[0].decode('utf-8')
193 version = o.split(' ')[2].split('.')
196 def create_stored_revision():
198 if os.path.exists('.git'):
199 rev = fetch_git_revision();
200 print("Git version: " + rev + "\n")
201 elif os.path.exists('libs/ardour/revision.cc'):
202 print("Using packaged revision")
205 print("Missing libs/ardour/revision.cc. Blame the packager.")
210 # if you change the format of this, be sure to fix fetch_tarball_revision() above
211 # so that it still works.
213 text = '#include "ardour/revision.h"\n'
214 text += 'namespace ARDOUR { const char* revision = \"%s\"; }\n' % rev
215 print('Writing revision info to libs/ardour/revision.cc using ' + rev)
216 o = open('libs/ardour/revision.cc', 'w')
220 print('Could not open libs/ardour/revision.cc for writing\n')
223 def set_compiler_flags (conf,opt):
225 # Compiler flags and other system-dependent stuff
227 build_host_supports_sse = False
229 # Flags necessary for building
230 compiler_flags = [] # generic
231 c_flags = [] # C-specific
232 cxx_flags = [] # C++-specific
235 # Optimization flags (overridable)
236 optimization_flags = []
241 u = PLATFORM.uname ()
243 platform = u[0].lower()
246 # waf adds -O0 -g itself. thanks waf!
247 is_clang = conf.check_cxx(fragment = '''
251 int main() { return 0; }''',
255 msg = 'Checking for clang')
258 if platform == 'darwin':
259 compiler_name = 'clang-darwin'
261 compiler_name = 'clang'
262 elif conf.env['MSVC_COMPILER']:
263 compiler_name = 'msvc'
265 if platform == 'darwin':
266 compiler_name = 'gcc-darwin'
268 compiler_name = 'gcc'
270 flags_dict = compiler_flags_dictionaries[compiler_name]
272 autowaf.set_basic_compiler_flags (conf,flags_dict)
274 if conf.options.asan:
275 conf.check_cxx(cxxflags=["-fsanitize=address", "-fno-omit-frame-pointer"], linkflags=["-fsanitize=address"])
276 cxx_flags.append('-fsanitize=address')
277 cxx_flags.append('-fno-omit-frame-pointer')
278 linker_flags.append('-fsanitize=address')
281 debug_flags = [ flags_dict['profile'] ]
284 if platform == 'darwin':
285 if re.search ("^13[.]", version) != None:
286 conf.env['build_host'] = 'mavericks'
287 elif re.search ("^14[.]", version) != None:
288 conf.env['build_host'] = 'yosemite'
290 conf.env['build_host'] = 'irrelevant'
293 if opt.dist_target == 'auto':
294 if platform == 'darwin':
295 # The [.] matches to the dot after the major version, "." would match any character
296 if re.search ("^[0-7][.]", version) != None:
297 conf.env['build_target'] = 'panther'
298 elif re.search ("^8[.]", version) != None:
299 conf.env['build_target'] = 'tiger'
300 elif re.search ("^9[.]", version) != None:
301 conf.env['build_target'] = 'leopard'
302 elif re.search ("^10[.]", version) != None:
303 conf.env['build_target'] = 'snowleopard'
304 elif re.search ("^11[.]", version) != None:
305 conf.env['build_target'] = 'lion'
306 elif re.search ("^12[.]", version) != None:
307 conf.env['build_target'] = 'mountainlion'
308 elif re.search ("^13[.]", version) != None:
309 conf.env['build_target'] = 'mavericks'
311 conf.env['build_target'] = 'yosemite'
314 "(?P<cpu>i[0-6]86|x86_64|powerpc|ppc|ppc64|arm|s390x?)",
317 conf.env['build_target'] = match.group("cpu")
318 if re.search("i[0-5]86", conf.env['build_target']):
319 conf.env['build_target'] = "i386"
321 conf.env['build_target'] = 'none'
323 conf.env['build_target'] = opt.dist_target
325 if conf.env['build_target'] == 'snowleopard':
327 # stupid OS X 10.6 has a bug in math.h that prevents llrint and friends
328 # from being visible.
330 compiler_flags.append ('-U__STRICT_ANSI__')
332 if conf.options.cxx11 or conf.env['build_host'] in [ 'mavericks', 'yosemite' ]:
333 conf.check_cxx(cxxflags=["-std=c++11"])
334 cxx_flags.append('-std=c++11')
335 if platform == "darwin":
336 cxx_flags.append('--stdlib=libstdc++')
337 # Mavericks and later changed the syntax to be used when including Carbon headers,
338 # from requiring a full path to requiring just the header name.
339 cxx_flags.append('-DCARBON_FLAT_HEADERS')
340 linker_flags.append('--stdlib=libstdc++')
341 # Prevents visibility issues in standard headers
342 conf.define("_DARWIN_C_SOURCE", 1)
344 if (is_clang and platform == "darwin") or conf.env['build_host'] in ['mavericks', 'yosemite']:
345 # Silence warnings about the non-existing osx clang compiler flags
346 # -compatibility_version and -current_version. These are Waf
347 # generated and not needed with clang
348 c_flags.append("-Qunused-arguments")
349 cxx_flags.append("-Qunused-arguments")
351 if ((re.search ("i[0-9]86", cpu) != None) or (re.search ("x86_64", cpu) != None)) and conf.env['build_target'] != 'none':
355 # ARCH_X86 means anything in the x86 family from i386 to x86_64
356 # the compile-time presence of the macro _LP64 is used to
357 # distingush 32 and 64 bit assembler
360 if (re.search ("(i[0-9]86|x86_64)", cpu) != None):
361 compiler_flags.append ("-DARCH_X86")
363 if platform == 'linux' :
366 # determine processor flags via /proc/cpuinfo
369 if conf.env['build_target'] != 'i386':
371 flag_line = os.popen ("cat /proc/cpuinfo | grep '^flags'").read()[:-1]
372 x86_flags = flag_line.split (": ")[1:][0].split ()
374 if "mmx" in x86_flags:
375 compiler_flags.append ("-mmmx")
376 if "sse" in x86_flags:
377 build_host_supports_sse = True
378 if "3dnow" in x86_flags:
379 compiler_flags.append ("-m3dnow")
382 compiler_flags.append ("-march=i586")
384 compiler_flags.append ("-march=i686")
386 if ((conf.env['build_target'] == 'i686') or (conf.env['build_target'] == 'x86_64')) and build_host_supports_sse:
387 compiler_flags.extend ([ flags_dict['sse'], flags_dict['fpmath-sse'], flags_dict['xmmintrinsics'] ])
389 # end of processor-specific section
391 # optimization section
392 if conf.env['FPU_OPTIMIZATION']:
393 if sys.platform == 'darwin':
394 compiler_flags.append("-DBUILD_VECLIB_OPTIMIZATIONS");
395 conf.env.append_value('LINKFLAGS_OSX', ['-framework', 'Accelerate'])
396 elif conf.env['build_target'] == 'i686' or conf.env['build_target'] == 'x86_64':
397 compiler_flags.append ("-DBUILD_SSE_OPTIMIZATIONS")
398 if not build_host_supports_sse:
399 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)")
401 # end optimization section
407 if conf.env['build_target'] == 'x86_64' and opt.windows_vst:
408 print("\n\n==================================================")
409 print("You cannot use VST plugins with a 64 bit host. Please run waf with --windows-vst=0")
410 print("\nIt is theoretically possible to build a 32 bit host on a 64 bit system.")
411 print("However, this is tricky and not recommended for beginners.")
414 if conf.env['LXVST_SUPPORT'] == True:
415 if conf.env['build_target'] == 'x86_64':
416 compiler_flags.append("-DLXVST_64BIT")
418 compiler_flags.append("-DLXVST_32BIT")
421 # a single way to test if we're on OS X
424 if conf.env['build_target'] in ['panther', 'tiger', 'leopard' ]:
425 # force tiger or later, to avoid issues on PPC which defaults
426 # back to 10.1 if we don't tell it otherwise.
428 compiler_flags.extend(
429 ("-DMAC_OS_X_VERSION_MIN_REQUIRED=1040",
430 '-mmacosx-version-min=10.4'))
432 elif conf.env['build_target'] in [ 'snowleopard' ]:
433 compiler_flags.extend(
434 ("-DMAC_OS_X_VERSION_MIN_REQUIRED=1060",
435 '-mmacosx-version-min=10.6'))
437 elif conf.env['build_target'] in [ 'lion', 'mountainlion' ]:
438 compiler_flags.extend(
439 ("-DMAC_OS_X_VERSION_MIN_REQUIRED=1070",
440 '-mmacosx-version-min=10.7'))
442 elif conf.env['build_target'] in [ 'mavericks', 'yosemite' ]:
443 compiler_flags.extend(
444 ("-DMAC_OS_X_VERSION_MAX_ALLOWED=1090",
445 "-mmacosx-version-min=10.8"))
448 # save off CPU element in an env
450 conf.define ('CONFIG_ARCH', cpu)
453 # ARCH="..." overrides all
457 optimization_flags = opt.arch.split()
460 # prepend boiler plate optimization flags that work on all architectures
463 optimization_flags[:0] = [flags_dict['pipe']]
465 # don't prepend optimization flags if "-O<something>" is present
466 prepend_opt_flags = True
467 for flag in optimization_flags:
468 if flag.startswith("-O"):
469 prepend_opt_flags = False
472 if prepend_opt_flags:
473 optimization_flags[:0] = flags_dict['full-optimization']
475 if opt.debug_symbols:
476 optimization_flags += flags_dict['debuggable']
479 cxx_flags.append("-D_GLIBCXX_DEBUG")
481 if conf.env['DEBUG_RT_ALLOC']:
482 compiler_flags.append('-DDEBUG_RT_ALLOC')
483 linker_flags.append('-ldl')
485 if conf.env['DEBUG_DENORMAL_EXCEPTION']:
486 compiler_flags.append('-DDEBUG_DENORMAL_EXCEPTION')
489 compiler_flags.extend(flags_dict['generic-x86'])
490 linker_flags.extend(flags_dict['generic-x86'])
493 compiler_flags.extend(flags_dict['generic-ppc'])
494 linker_flags.extend(flags_dict['generic-ppc'])
500 compiler_flags.extend(flags_dict['basic-warnings'])
502 c_flags.extend(flags_dict['extra-c-warnings'])
503 cxx_flags.extend (flags_dict['extra-cxx-warnings'])
509 # need ISOC9X for llabs()
510 compiler_flags.extend(
511 ('-DBOOST_SYSTEM_NO_DEPRECATED', '-D_ISOC9X_SOURCE',
512 '-D_LARGEFILE64_SOURCE', '-D_FILE_OFFSET_BITS=64'))
514 ('-D__STDC_LIMIT_MACROS', '-D__STDC_FORMAT_MACROS',
515 '-DCANVAS_COMPATIBILITY', '-DCANVAS_DEBUG'))
518 compiler_flags.append('-DENABLE_NLS')
520 compiler_flags.append ('-DPROGRAM_NAME="' + Options.options.program_name + '"')
521 compiler_flags.append ('-DPROGRAM_VERSION="' + PROGRAM_VERSION + '"')
524 conf.env.append_value('CFLAGS', debug_flags)
525 conf.env.append_value('CXXFLAGS', debug_flags)
527 conf.env.append_value('CFLAGS', optimization_flags)
528 conf.env.append_value('CXXFLAGS', optimization_flags)
531 if platform != 'darwin' and not is_clang and not Options.options.dist_target == 'mingw':
532 linker_flags += [ '-rdynamic' ]
534 conf.env.append_value('CFLAGS', compiler_flags)
535 conf.env.append_value('CFLAGS', c_flags)
536 conf.env.append_value('CXXFLAGS', compiler_flags)
537 conf.env.append_value('CXXFLAGS', cxx_flags)
538 conf.env.append_value('LINKFLAGS', linker_flags)
540 #----------------------------------------------------------------
545 opt.load('compiler_c')
546 opt.load('compiler_cxx')
547 autowaf.set_options(opt, debug_by_default=True)
548 opt.add_option('--program-name', type='string', action='store', default='Ardour', dest='program_name',
549 help='The user-visible name of the program being built')
550 opt.add_option ('--trx', action='store_true', default=False, dest='trx_build',
551 help='Whether to build for TRX')
552 opt.add_option('--arch', type='string', action='store', dest='arch',
553 help='Architecture-specific compiler FLAGS')
554 opt.add_option('--with-backends', type='string', action='store', default='jack', dest='with_backends',
555 help='Specify which backend modules are to be included(jack,alsa,wavesaudio,dummy)')
556 opt.add_option('--backtrace', action='store_true', default=True, dest='backtrace',
557 help='Compile with -rdynamic -- allow obtaining backtraces from within Ardour')
558 opt.add_option('--no-carbon', action='store_true', default=False, dest='nocarbon',
559 help='Compile without support for AU Plugins with only CARBON UI (needed for 64bit)')
560 opt.add_option('--boost-sp-debug', action='store_true', default=False, dest='boost_sp_debug',
561 help='Compile with Boost shared pointer debugging')
562 opt.add_option('--debug-symbols', action='store_true', default=False, dest='debug_symbols',
563 help='Add debug-symbols to optimized builds')
564 opt.add_option('--depstack-root', type='string', default='~', dest='depstack_root',
565 help='Directory/folder where dependency stack trees (gtk, a3) can be found (defaults to ~)')
566 opt.add_option('--dist-target', type='string', default='auto', dest='dist_target',
567 help='Specify the target for cross-compiling [auto,none,x86,i386,i686,x86_64,tiger,leopard,mingw,msvc]')
568 opt.add_option('--fpu-optimization', action='store_true', default=True, dest='fpu_optimization',
569 help='Build runtime checked assembler code (default)')
570 opt.add_option('--no-fpu-optimization', action='store_false', dest='fpu_optimization')
571 opt.add_option('--exports-hidden', action='store_true', default=False, dest='exports_hidden')
572 opt.add_option('--freedesktop', action='store_true', default=False, dest='freedesktop',
573 help='Install MIME type, icons and .desktop file as per freedesktop.org standards')
574 opt.add_option('--freebie', action='store_true', default=False, dest='freebie',
575 help='Build a version suitable for distribution as a zero-cost binary')
576 opt.add_option('--gprofile', action='store_true', default=False, dest='gprofile',
577 help='Compile for use with gprofile')
578 opt.add_option('--libjack', type='string', default="auto", dest='libjack_link',
579 help='libjack link mode [auto|link|weak]')
580 opt.add_option('--internal-shared-libs', action='store_true', default=True, dest='internal_shared_libs',
581 help='Build internal libs as shared libraries')
582 opt.add_option('--internal-static-libs', action='store_false', dest='internal_shared_libs',
583 help='Build internal libs as static libraries')
584 opt.add_option('--use-external-libs', action='store_true', default=False, dest='use_external_libs',
585 help='Use external/system versions of some bundled libraries')
586 opt.add_option('--lv2', action='store_true', default=True, dest='lv2',
587 help='Compile with support for LV2 (if Lilv+Suil is available)')
588 opt.add_option('--no-lv2', action='store_false', dest='lv2',
589 help='Do not compile with support for LV2')
590 opt.add_option('--lv2dir', type='string', help="install destination for builtin LV2 bundles [Default: LIBDIR/lv2]")
591 opt.add_option('--lxvst', action='store_true', default=True, dest='lxvst',
592 help='Compile with support for linuxVST plugins')
593 opt.add_option('--no-lxvst', action='store_false', dest='lxvst',
594 help='Compile without support for linuxVST plugins')
595 opt.add_option('--nls', action='store_true', default=True, dest='nls',
596 help='Enable i18n (native language support) (default)')
597 opt.add_option('--no-nls', action='store_false', dest='nls')
598 opt.add_option('--phone-home', action='store_true', default=True, dest='phone_home',
599 help='Contact ardour.org at startup for new announcements')
600 opt.add_option('--no-phone-home', action='store_false', dest='phone_home',
601 help='Do not contact ardour.org at startup for new announcements')
602 opt.add_option('--stl-debug', action='store_true', default=False, dest='stl_debug',
603 help='Build with debugging for the STL')
604 opt.add_option('--rt-alloc-debug', action='store_true', default=False, dest='rt_alloc_debug',
605 help='Build with debugging for memory allocation in the real-time thread')
606 opt.add_option('--pt-timing', action='store_true', default=False, dest='pt_timing',
607 help='Build with logging of timing in the process thread(s)')
608 opt.add_option('--denormal-exception', action='store_true', default=False, dest='denormal_exception',
609 help='Raise a floating point exception if a denormal is detected')
610 opt.add_option('--test', action='store_true', default=False, dest='build_tests',
611 help="Build unit tests")
612 opt.add_option('--run-tests', action='store_true', default=False, dest='run_tests',
613 help="Run tests after build")
614 opt.add_option('--single-tests', action='store_true', default=False, dest='single_tests',
615 help="Build a single executable for each unit test")
616 #opt.add_option('--tranzport', action='store_true', default=False, dest='tranzport',
617 # help='Compile with support for Frontier Designs Tranzport (if libusb is available)')
618 opt.add_option('--generic', action='store_true', default=False, dest='generic',
619 help='Compile with -arch i386 (OS X ONLY)')
620 opt.add_option('--ppc', action='store_true', default=False, dest='ppc',
621 help='Compile with -arch ppc (OS X ONLY)')
622 opt.add_option('--versioned', action='store_true', default=False, dest='versioned',
623 help='Add revision information to executable name inside the build directory')
624 opt.add_option('--windows-vst', action='store_true', default=False, dest='windows_vst',
625 help='Compile with support for Windows VST')
626 opt.add_option('--windows-key', type='string', action='store', dest='windows_key', default='Mod4><Super',
627 help='X Modifier(s) (Mod1,Mod2, etc) for the Windows key (X11 builds only). ' +
628 'Multiple modifiers must be separated by \'><\'')
629 opt.add_option('--boost-include', type='string', action='store', dest='boost_include', default='',
630 help='directory where Boost header files can be found')
631 opt.add_option('--also-include', type='string', action='store', dest='also_include', default='',
632 help='additional include directory where header files can be found (split multiples with commas)')
633 opt.add_option('--also-libdir', type='string', action='store', dest='also_libdir', default='',
634 help='additional include directory where shared libraries can be found (split multiples with commas)')
635 opt.add_option('--wine-include', type='string', action='store', dest='wine_include', default='/usr/include/wine/windows',
636 help='directory where Wine\'s Windows header files can be found')
637 opt.add_option('--noconfirm', action='store_true', default=False, dest='noconfirm',
638 help='Do not ask questions that require confirmation during the build')
639 opt.add_option('--cxx11', action='store_true', default=False, dest='cxx11',
640 help='Turn on c++11 compiler flags (-std=c++11)')
641 opt.add_option('--address-sanitizer', action='store_true', default=False, dest='asan',
642 help='Turn on AddressSanitizer (requires GCC >= 4.8 or clang >= 3.1)')
646 def sub_config_and_use(conf, name, has_objects = True):
648 autowaf.set_local_lib(conf, name, has_objects)
651 conf.load('compiler_c')
652 conf.load('compiler_cxx')
653 if Options.options.dist_target == 'mingw':
656 if Options.options.dist_target == 'msvc':
657 conf.env['MSVC_VERSIONS'] = ['msvc 10.0', 'msvc 9.0', 'msvc 8.0', 'msvc 7.1', 'msvc 7.0', 'msvc 6.0', ]
658 conf.env['MSVC_TARGETS'] = ['x64']
661 if Options.options.debug:
662 # Nuke user CFLAGS/CXXFLAGS if debug is set (they likely contain -O3, NDEBUG, etc)
663 conf.env['CFLAGS'] = []
664 conf.env['CXXFLAGS'] = []
666 conf.env['VERSION'] = VERSION
667 conf.env['MAJOR'] = MAJOR
668 conf.env['MINOR'] = MINOR
670 autowaf.set_recursive()
671 autowaf.configure(conf)
672 autowaf.display_header('Ardour Configuration')
674 gcc_versions = fetch_gcc_version(str(conf.env['CC']))
675 if not Options.options.debug and gcc_versions[0] == '4' and gcc_versions[1] > '4':
676 print('Version 4.5 of gcc is not ready for use when compiling Ardour with optimization.')
677 print('Please use a different version or re-configure with --debug')
680 # systems with glibc have libintl builtin. systems without require explicit
681 # linkage against libintl.
684 pkg_config_path = os.getenv('PKG_CONFIG_PATH')
685 user_gtk_root = os.path.expanduser (Options.options.depstack_root + '/gtk/inst')
687 if pkg_config_path is not None and pkg_config_path.find (user_gtk_root) >= 0:
688 # told to search user_gtk_root
689 prefinclude = ''.join ([ '-I', user_gtk_root + '/include'])
690 preflib = ''.join ([ '-L', user_gtk_root + '/lib'])
691 conf.env.append_value('CFLAGS', [ prefinclude ])
692 conf.env.append_value('CXXFLAGS', [prefinclude ])
693 conf.env.append_value('LINKFLAGS', [ preflib ])
694 autowaf.display_msg(conf, 'Will build against private GTK dependency stack in ' + user_gtk_root, 'yes')
696 autowaf.display_msg(conf, 'Will build against private GTK dependency stack', 'no')
698 if sys.platform == 'darwin':
699 conf.define ('NEED_INTL', 1)
700 autowaf.display_msg(conf, 'Will use explicit linkage against libintl in ' + user_gtk_root, 'yes')
702 # libintl is part of the system, so use it
703 autowaf.display_msg(conf, 'Will rely on libintl built into libc', 'yes')
705 user_ardour_root = os.path.expanduser (Options.options.depstack_root + '/a3/inst')
706 if pkg_config_path is not None and pkg_config_path.find (user_ardour_root) >= 0:
707 # told to search user_ardour_root
708 prefinclude = ''.join ([ '-I', user_ardour_root + '/include'])
709 preflib = ''.join ([ '-L', user_ardour_root + '/lib'])
710 conf.env.append_value('CFLAGS', [ prefinclude ])
711 conf.env.append_value('CXXFLAGS', [prefinclude ])
712 conf.env.append_value('LINKFLAGS', [ preflib ])
713 autowaf.display_msg(conf, 'Will build against private Ardour dependency stack in ' + user_ardour_root, 'yes')
715 autowaf.display_msg(conf, 'Will build against private Ardour dependency stack', 'no')
717 if Options.options.freebie:
718 conf.env.append_value ('CFLAGS', '-DNO_PLUGIN_STATE')
719 conf.env.append_value ('CXXFLAGS', '-DNO_PLUGIN_STATE')
720 conf.define ('NO_PLUGIN_STATE', 1)
722 if Options.options.trx_build:
723 conf.define ('TRX_BUILD', 1)
725 if Options.options.lv2dir:
726 conf.env['LV2DIR'] = Options.options.lv2dir
728 conf.env['LV2DIR'] = os.path.join(conf.env['LIBDIR'], 'lv2')
730 conf.env['LV2DIR'] = os.path.normpath(conf.env['LV2DIR'])
732 if sys.platform == 'darwin':
734 # this is required, potentially, for anything we link and then relocate into a bundle
735 conf.env.append_value('LINKFLAGS', [ '-Xlinker', '-headerpad_max_install_names' ])
737 conf.define ('HAVE_COREAUDIO', 1)
738 conf.define ('AUDIOUNIT_SUPPORT', 1)
740 conf.define ('GTKOSX', 1)
741 conf.define ('TOP_MENUBAR',1)
742 conf.define ('GTKOSX',1)
744 # It would be nice to be able to use this to force back-compatibility with 10.4
745 # but even by the time of 11, the 10.4 SDK is no longer available in any normal
748 #conf.env.append_value('CXXFLAGS_OSX', "-isysroot /Developer/SDKs/MacOSX10.4u.sdk")
749 #conf.env.append_value('CFLAGS_OSX', "-isysroot /Developer/SDKs/MacOSX10.4u.sdk")
750 #conf.env.append_value('LINKFLAGS_OSX', "-sysroot /Developer/SDKs/MacOSX10.4u.sdk")
751 #conf.env.append_value('LINKFLAGS_OSX', "-sysroot /Developer/SDKs/MacOSX10.4u.sdk")
753 conf.env.append_value('CXXFLAGS_OSX', "-msse")
754 conf.env.append_value('CFLAGS_OSX', "-msse")
755 conf.env.append_value('CXXFLAGS_OSX', "-msse2")
756 conf.env.append_value('CFLAGS_OSX', "-msse2")
758 # TODO: The previous sse flags NEED to be based
759 # off processor type. Need to add in a check
762 conf.env.append_value('CXXFLAGS_OSX', '-F/System/Library/Frameworks')
763 conf.env.append_value('CXXFLAGS_OSX', '-F/Library/Frameworks')
765 conf.env.append_value('LINKFLAGS_OSX', ['-framework', 'AppKit'])
766 conf.env.append_value('LINKFLAGS_OSX', ['-framework', 'CoreAudio'])
767 conf.env.append_value('LINKFLAGS_OSX', ['-framework', 'CoreAudioKit'])
768 conf.env.append_value('LINKFLAGS_OSX', ['-framework', 'CoreFoundation'])
769 conf.env.append_value('LINKFLAGS_OSX', ['-framework', 'CoreServices'])
771 conf.env.append_value('LINKFLAGS_OSX', ['-undefined', 'dynamic_lookup' ])
772 conf.env.append_value('LINKFLAGS_OSX', ['-flat_namespace'])
774 conf.env.append_value('CXXFLAGS_AUDIOUNITS', "-DAUDIOUNIT_SUPPORT")
775 conf.env.append_value('LINKFLAGS_AUDIOUNITS', ['-framework', 'AudioToolbox', '-framework', 'AudioUnit'])
776 conf.env.append_value('LINKFLAGS_AUDIOUNITS', ['-framework', 'Cocoa'])
778 if re.search ("^[1-9][0-9]\.", os.uname()[2]) == None and not Options.options.nocarbon:
779 conf.env.append_value('CXXFLAGS_AUDIOUNITS', "-DWITH_CARBON")
780 conf.env.append_value('LINKFLAGS_AUDIOUNITS', ['-framework', 'Carbon'])
782 print ('No Carbon support available for this build\n')
785 if Options.options.internal_shared_libs:
786 conf.define('INTERNAL_SHARED_LIBS', 1)
788 if Options.options.use_external_libs:
789 conf.define('USE_EXTERNAL_LIBS', 1)
791 if Options.options.boost_include != '':
792 conf.env.append_value('CXXFLAGS', '-I' + Options.options.boost_include)
794 if Options.options.also_include != '':
795 conf.env.append_value('CXXFLAGS', '-I' + Options.options.also_include)
796 conf.env.append_value('CFLAGS', '-I' + Options.options.also_include)
798 if Options.options.also_libdir != '':
799 conf.env.append_value('LDFLAGS', '-L' + Options.options.also_libdir)
801 if Options.options.boost_sp_debug:
802 conf.env.append_value('CXXFLAGS', '-DBOOST_SP_ENABLE_DEBUG_HOOKS')
804 # executing a test program is n/a when cross-compiling
805 if Options.options.dist_target != 'mingw':
806 conf.check_cc(function_name='dlopen', header_name='dlfcn.h', lib='dl', uselib_store='DL')
807 conf.check_cxx(fragment = "#include <boost/version.hpp>\nint main(void) { return (BOOST_VERSION >= 103900 ? 0 : 1); }\n",
810 msg = 'Checking for boost library >= 1.39',
812 errmsg = 'too old\nPlease install boost version 1.39 or higher.')
814 if re.search ("linux", sys.platform) != None and Options.options.dist_target != 'mingw':
815 autowaf.check_pkg(conf, 'alsa', uselib_store='ALSA')
817 autowaf.check_pkg(conf, 'glib-2.0', uselib_store='GLIB', atleast_version='2.2', mandatory=True)
818 autowaf.check_pkg(conf, 'gthread-2.0', uselib_store='GTHREAD', atleast_version='2.2', mandatory=True)
819 autowaf.check_pkg(conf, 'glibmm-2.4', uselib_store='GLIBMM', atleast_version='2.32.0', mandatory=True)
820 autowaf.check_pkg(conf, 'sndfile', uselib_store='SNDFILE', atleast_version='1.0.18', mandatory=True)
821 autowaf.check_pkg(conf, 'giomm-2.4', uselib_store='GIOMM', atleast_version='2.2', mandatory=True)
822 autowaf.check_pkg(conf, 'libcurl', uselib_store='CURL', atleast_version='7.0.0', mandatory=True)
823 autowaf.check_pkg(conf, 'liblo', uselib_store='LO', atleast_version='0.26', mandatory=True)
824 autowaf.check_pkg(conf, 'taglib', uselib_store='TAGLIB', atleast_version='1.6', mandatory=True)
825 autowaf.check_pkg(conf, 'vamp-sdk', uselib_store='VAMPSDK', atleast_version='2.1', mandatory=True)
826 autowaf.check_pkg(conf, 'vamp-hostsdk', uselib_store='VAMPHOSTSDK', atleast_version='2.1', mandatory=True)
827 autowaf.check_pkg(conf, 'rubberband', uselib_store='RUBBERBAND', mandatory=True)
829 if Options.options.dist_target == 'mingw':
830 Options.options.fpu_optimization = False
831 conf.env.append_value('CFLAGS', '-DPLATFORM_WINDOWS')
832 conf.env.append_value('CFLAGS', '-DCOMPILER_MINGW')
833 conf.env.append_value('CXXFLAGS', '-DPLATFORM_WINDOWS')
834 conf.env.append_value('CXXFLAGS', '-DCOMPILER_MINGW')
835 conf.env.append_value('LIB', 'pthread')
836 # needed for at least libsmf
837 conf.check_cc(function_name='htonl', header_name='winsock2.h', lib='ws2_32')
838 conf.env.append_value('LIB', 'ws2_32')
839 # needed for mingw64 packages, not harmful on normal mingw build
840 conf.env.append_value('LIB', 'intl')
841 conf.check_cc(function_name='regcomp', header_name='regex.h',
842 lib='regex', uselib_store="REGEX", define_name='HAVE_REGEX_H')
843 # TODO put this only where it is needed
844 conf.env.append_value('LIB', 'regex')
846 # work around GdkDrawable BitBlt performance issue on windows
847 # see http://gareus.org/wiki/ardour_windows_gdk_and_cairo
848 conf.env.append_value('CFLAGS', '-DUSE_CAIRO_IMAGE_SURFACE')
849 conf.env.append_value('CXXFLAGS', '-DUSE_CAIRO_IMAGE_SURFACE')
851 if Options.options.dist_target == 'msvc':
852 conf.env.append_value('CFLAGS', '-DPLATFORM_WINDOWS')
853 conf.env.append_value('CFLAGS', '-DCOMPILER_MSVC')
854 conf.env.append_value('CXXFLAGS', '-DPLATFORM_WINDOWS')
855 conf.env.append_value('CXXFLAGS', '-DCOMPILER_MSVC')
856 # work around GdkDrawable BitBlt performance issue on windows
857 # see http://gareus.org/wiki/ardour_windows_gdk_and_cairo
858 conf.env.append_value('CFLAGS', '-DUSE_CAIRO_IMAGE_SURFACE')
859 conf.env.append_value('CXXFLAGS', '-DUSE_CAIRO_IMAGE_SURFACE')
860 # MORE STUFF PROBABLY NEEDED HERE
862 # Tell everyone that this is a waf build
864 conf.env.append_value('CFLAGS', '-DWAF_BUILD')
865 conf.env.append_value('CXXFLAGS', '-DWAF_BUILD')
867 opts = Options.options
869 # (optionally) Adopt Microsoft-like convention that makes all non-explicitly exported
870 # symbols invisible (rather than doing this all over the wscripts in the src tree)
872 # This won't apply to MSVC but that hasn't been added as a target yet
874 # We can't do this till all tests are complete, since some fail if this is et.
875 if opts.exports_hidden:
876 conf.define ('EXPORT_VISIBILITY_HIDDEN', True)
877 if opts.internal_shared_libs:
878 conf.env.append_value ('CXXFLAGS', '-fvisibility=hidden')
879 conf.env.append_value ('CFLAGS', '-fvisibility=hidden')
881 conf.define ('EXPORT_VISIBILITY_HIDDEN', False)
883 # Set up waf environment and C defines
885 conf.define('PHONE_HOME', 1)
886 conf.env['PHONE_HOME'] = True
887 if opts.fpu_optimization:
888 conf.env['FPU_OPTIMIZATION'] = True
890 conf.define('ENABLE_NLS', 1)
891 conf.env['ENABLE_NLS'] = True
893 conf.env['BUILD_TESTS'] = True
894 conf.env['RUN_TESTS'] = opts.run_tests
895 if opts.single_tests:
896 conf.env['SINGLE_TESTS'] = opts.single_tests
898 # conf.env['TRANZPORT'] = 1
900 conf.define('WINDOWS_VST_SUPPORT', 1)
901 conf.env['WINDOWS_VST_SUPPORT'] = True
902 if not Options.options.dist_target == 'mingw':
903 conf.env.append_value('CFLAGS', '-I' + Options.options.wine_include)
904 conf.env.append_value('CXXFLAGS', '-I' + Options.options.wine_include)
905 autowaf.check_header(conf, 'cxx', 'windows.h', mandatory = True)
907 if sys.platform == 'darwin':
908 conf.env['LXVST_SUPPORT'] = False
909 elif Options.options.dist_target == 'mingw':
910 conf.env['LXVST_SUPPORT'] = False
912 conf.define('LXVST_SUPPORT', 1)
913 conf.env['LXVST_SUPPORT'] = True
914 conf.env['WINDOWS_KEY'] = opts.windows_key
915 if opts.rt_alloc_debug:
916 conf.define('DEBUG_RT_ALLOC', 1)
917 conf.env['DEBUG_RT_ALLOC'] = True
919 conf.define('PT_TIMING', 1)
920 conf.env['PT_TIMING'] = True
921 if opts.denormal_exception:
922 conf.define('DEBUG_DENORMAL_EXCEPTION', 1)
923 conf.env['DEBUG_DENORMAL_EXCEPTION'] = True
925 autowaf.check_pkg(conf, 'cppunit', uselib_store='CPPUNIT', atleast_version='1.12.0', mandatory=True)
927 backends = opts.with_backends.split(',')
929 print("Must configure and build at least one backend")
932 conf.env['BACKENDS'] = backends
933 conf.env['BUILD_JACKBACKEND'] = any('jack' in b for b in backends)
934 conf.env['BUILD_ALSABACKEND'] = any('alsa' in b for b in backends)
935 conf.env['BUILD_DUMMYBACKEND'] = any('dummy' in b for b in backends)
936 conf.env['BUILD_WAVESBACKEND'] = any('wavesaudio' in b for b in backends)
938 set_compiler_flags (conf, Options.options)
940 if sys.platform == 'darwin':
941 sub_config_and_use(conf, 'libs/appleutility')
942 elif Options.options.dist_target != 'mingw':
943 sub_config_and_use(conf, 'tools/sanity_check')
945 sub_config_and_use(conf, 'libs/clearlooks-newer')
948 sub_config_and_use(conf, i)
950 # Fix utterly braindead FLAC include path to not smash assert.h
951 conf.env['INCLUDES_FLAC'] = []
953 config_text = open('libs/ardour/config_text.cc', "w")
954 config_text.write('''#include "ardour/ardour.h"
956 const char* const ardour_config_info = "\\n\\
959 def write_config_text(title, val):
960 autowaf.display_msg(conf, title, val)
961 config_text.write(title + ': ')
962 config_text.write(str(val).replace ('"', '\\"'))
963 config_text.write("\\n\\\n")
965 write_config_text('Build documentation', conf.env['DOCS'])
966 write_config_text('Debuggable build', conf.env['DEBUG'])
967 write_config_text('Export all symbols (backtrace)', opts.backtrace)
968 write_config_text('Install prefix', conf.env['PREFIX'])
969 write_config_text('Strict compiler flags', conf.env['STRICT'])
970 write_config_text('Internal Shared Libraries', conf.is_defined('INTERNAL_SHARED_LIBS'))
971 write_config_text('Use External Libraries', conf.is_defined('USE_EXTERNAL_LIBS'))
972 write_config_text('Library exports hidden', conf.is_defined('EXPORT_VISIBILITY_HIDDEN'))
974 write_config_text('ALSA Backend', conf.env['BUILD_ALSABACKEND'])
975 write_config_text('ALSA DBus Reservation', conf.is_defined('HAVE_DBUS'))
976 write_config_text('Architecture flags', opts.arch)
977 write_config_text('Aubio', conf.is_defined('HAVE_AUBIO'))
978 write_config_text('AudioUnits', conf.is_defined('AUDIOUNIT_SUPPORT'))
979 write_config_text('No plugin state', conf.is_defined('NO_PLUGIN_STATE'))
980 write_config_text('Build target', conf.env['build_target'])
981 write_config_text('CoreAudio', conf.is_defined('HAVE_COREAUDIO'))
982 write_config_text('Debug RT allocations', conf.is_defined('DEBUG_RT_ALLOC'))
983 write_config_text('Debug Symbols', conf.is_defined('debug_symbols') or conf.env['DEBUG'])
984 write_config_text('Dummy backend', conf.env['BUILD_DUMMYBACKEND'])
985 write_config_text('Process thread timing', conf.is_defined('PT_TIMING'))
986 write_config_text('Denormal exceptions', conf.is_defined('DEBUG_DENORMAL_EXCEPTION'))
987 write_config_text('FLAC', conf.is_defined('HAVE_FLAC'))
988 write_config_text('FPU optimization', opts.fpu_optimization)
989 write_config_text('Freedesktop files', opts.freedesktop)
990 write_config_text('JACK Backend', conf.env['BUILD_JACKBACKEND'])
991 write_config_text('Libjack linking', conf.env['libjack_link'])
992 write_config_text('LV2 UI embedding', conf.is_defined('HAVE_SUIL'))
993 write_config_text('LV2 support', conf.is_defined('LV2_SUPPORT'))
994 write_config_text('LXVST support', conf.is_defined('LXVST_SUPPORT'))
995 write_config_text('OGG', conf.is_defined('HAVE_OGG'))
996 write_config_text('Phone home', conf.is_defined('PHONE_HOME'))
997 write_config_text('Program name', opts.program_name)
998 write_config_text('Samplerate', conf.is_defined('HAVE_SAMPLERATE'))
999 # write_config_text('Soundtouch', conf.is_defined('HAVE_SOUNDTOUCH'))
1000 write_config_text('Translation', opts.nls)
1001 # write_config_text('Tranzport', opts.tranzport)
1002 write_config_text('Unit tests', conf.env['BUILD_TESTS'])
1003 write_config_text('Mac i386 Architecture', opts.generic)
1004 write_config_text('Mac ppc Architecture', opts.ppc)
1005 write_config_text('Waves Backend', conf.env['BUILD_WAVESBACKEND'])
1006 write_config_text('Windows VST support', opts.windows_vst)
1007 write_config_text('Wiimote support', conf.is_defined('BUILD_WIIMOTE'))
1008 write_config_text('Windows key', opts.windows_key)
1010 write_config_text('C compiler flags', conf.env['CFLAGS'])
1011 write_config_text('C++ compiler flags', conf.env['CXXFLAGS'])
1012 write_config_text('Linker flags', conf.env['LINKFLAGS'])
1014 config_text.write ('";\n}\n')
1015 config_text.close ()
1019 create_stored_revision()
1021 # add directories that contain only headers, to workaround an issue with waf
1023 if not bld.is_defined('USE_EXTERNAL_LIBS'):
1024 bld.path.find_dir ('libs/libltc/ltc')
1025 bld.path.find_dir ('libs/evoral/evoral')
1026 bld.path.find_dir ('libs/surfaces/control_protocol/control_protocol')
1027 bld.path.find_dir ('libs/timecode/timecode')
1028 bld.path.find_dir ('libs/gtkmm2ext/gtkmm2ext')
1029 bld.path.find_dir ('libs/ardour/ardour')
1030 bld.path.find_dir ('libs/pbd/pbd')
1032 # set up target directories
1033 lwrcase_dirname = 'ardour3'
1035 if bld.is_defined ('TRX_BUILD'):
1036 lwrcase_dirname = 'trx'
1038 # configuration files go here
1039 bld.env['CONFDIR'] = os.path.join(bld.env['SYSCONFDIR'], lwrcase_dirname)
1040 # data files loaded at run time go here
1041 bld.env['DATADIR'] = os.path.join(bld.env['DATADIR'], lwrcase_dirname)
1042 # shared objects loaded at runtime go here (two aliases)
1043 bld.env['DLLDIR'] = os.path.join(bld.env['LIBDIR'], lwrcase_dirname)
1044 bld.env['LIBDIR'] = bld.env['DLLDIR']
1045 bld.env['LOCALEDIR'] = os.path.join(bld.env['DATADIR'], 'locale')
1047 autowaf.set_recursive()
1049 if sys.platform == 'darwin':
1050 bld.recurse('libs/appleutility')
1051 elif bld.env['build_target'] != 'mingw':
1052 bld.recurse('tools/sanity_check')
1054 bld.recurse('libs/clearlooks-newer')
1059 bld.install_files (bld.env['CONFDIR'], 'system_config')
1061 if bld.env['RUN_TESTS']:
1062 bld.add_post_fun(test)
1065 bld.recurse (i18n_children)
1068 bld.recurse (i18n_children)
1071 bld.recurse (i18n_children)
1074 bld.recurse (i18n_children)
1077 create_stored_revision()
1080 subprocess.call("gtk2_ardour/artest")