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' : ['/DDEBUG', '/Od', '/Zi', '/MDd', '/Gd', '/EHsc'],
59 'linker-debuggable' : ['/DEBUG', '/INCREMENTAL' ],
60 'nondebuggable' : ['/DNDEBUG', '/Ob1', '/MD', '/Gd', '/EHsc'],
63 'silence-unused-arguments' : '',
68 'full-optimization' : '/O2',
69 'no-frame-pointer' : '',
71 'strength-reduce' : '',
75 'basic-warnings' : '',
76 'extra-c-warnings' : '',
77 'extra-cxx-warnings' : '',
86 # Copy, edit and insert variants on gcc dict for gcc-darwin and clang
88 gcc_darwin_dict = compiler_flags_dictionaries['gcc'].copy()
89 gcc_darwin_dict['extra-cxx-warnings'] = [ '-Woverloaded-virtual' ]
90 gcc_darwin_dict['cxx-strict'] = [ '-ansi', '-Wnon-virtual-dtor', '-Woverloaded-virtual' ]
91 gcc_darwin_dict['strict'] = ['-Wall', '-Wcast-align', '-Wextra', '-Wwrite-strings' ]
92 gcc_darwin_dict['generic-x86'] = [ '-arch', 'i386' ]
93 gcc_darwin_dict['generic-ppc'] = [ '-arch', 'ppc' ]
94 compiler_flags_dictionaries['gcc-darwin'] = gcc_darwin_dict;
96 clang_dict = compiler_flags_dictionaries['gcc'].copy();
97 clang_dict['sse'] = ''
98 clang_dict['fpmath-sse'] = ''
99 clang_dict['xmmintrinsics'] = ''
100 clang_dict['silence-unused-arguments'] = '-Qunused-arguments'
101 clang_dict['extra-cxx-warnings'] = [ '-Woverloaded-virtual', '-Wno-mismatched-tags' ]
102 clang_dict['cxx-strict'] = [ '-ansi', '-Wnon-virtual-dtor', '-Woverloaded-virtual', '-fstrict-overflow' ]
103 clang_dict['strict'] = ['-Wall', '-Wcast-align', '-Wextra', '-Wwrite-strings' ]
104 clang_dict['generic-x86'] = [ '-arch', 'i386' ]
105 compiler_flags_dictionaries['clang'] = clang_dict;
107 clang_darwin_dict = compiler_flags_dictionaries['clang'].copy();
108 clang_darwin_dict['cxx-strict'] = [ '-ansi', '-Wnon-virtual-dtor', '-Woverloaded-virtual', ]
109 compiler_flags_dictionaries['clang-darwin'] = clang_darwin_dict;
111 def fetch_git_revision ():
112 cmd = "git describe HEAD"
113 output = subprocess.Popen(cmd, shell=True, stderr=subprocess.STDOUT, stdout=subprocess.PIPE).communicate()[0].splitlines()
114 rev = output[0].decode ('utf-8')
117 def fetch_tarball_revision ():
118 if not os.path.exists ('libs/ardour/revision.cc'):
119 print ('This tarball was not created correctly - it is missing libs/ardour/revision.cc')
121 with open('libs/ardour/revision.cc') as f:
122 content = f.readlines()
123 remove_punctuation_map = dict((ord(char), None) for char in '";')
124 return content[1].decode('utf-8').strip().split(' ')[7].translate (remove_punctuation_map)
126 if os.path.isdir (os.path.join(os.getcwd(), '.git')):
127 rev = fetch_git_revision ()
129 rev = fetch_tarball_revision ()
132 # rev is now of the form MAJOR.MINOR-rev-commit
133 # or, if right at the same rev as a release, MAJOR.MINOR
136 parts = rev.split ('.')
138 other = parts[1].split ('-')
145 V = MAJOR + '.' + MINOR + '.' + MICRO
147 PROGRAM_VERSION = MAJOR
149 # Mandatory variables
154 # optionally external libraries
158 # core ardour libraries
170 'libs/plugins/reasonablesynth.lv2',
177 # shared helper binaries (plugin-scanner, exec-wrapper)
180 'libs/ardouralsautil',
191 def fetch_gcc_version (CC):
192 cmd = "%s --version" % CC
193 output = subprocess.Popen(cmd, shell=True, stderr=subprocess.STDOUT, stdout=subprocess.PIPE).communicate()[0].splitlines()
194 o = output[0].decode('utf-8')
195 version = o.split(' ')[2].split('.')
198 def create_stored_revision():
200 if os.path.exists('.git'):
201 rev = fetch_git_revision();
202 print("Git version: " + rev + "\n")
203 elif os.path.exists('libs/ardour/revision.cc'):
204 print("Using packaged revision")
207 print("Missing libs/ardour/revision.cc. Blame the packager.")
212 # if you change the format of this, be sure to fix fetch_tarball_revision() above
213 # so that it still works.
215 text = '#include "ardour/revision.h"\n'
216 text += 'namespace ARDOUR { const char* revision = \"%s\"; }\n' % rev
217 print('Writing revision info to libs/ardour/revision.cc using ' + rev)
218 o = open('libs/ardour/revision.cc', 'w')
222 print('Could not open libs/ardour/revision.cc for writing\n')
225 def set_compiler_flags (conf,opt):
227 # Compiler flags and other system-dependent stuff
229 build_host_supports_sse = False
231 # Flags necessary for building
232 compiler_flags = [] # generic
233 c_flags = [] # C-specific
234 cxx_flags = [] # C++-specific
237 # Optimization flags (overridable)
238 optimization_flags = []
243 u = PLATFORM.uname ()
245 platform = u[0].lower()
248 # waf adds -O0 -g itself. thanks waf!
249 is_clang = conf.check_cxx(fragment = '''
253 int main() { return 0; }''',
257 msg = 'Checking for clang')
260 if platform == 'darwin':
261 compiler_name = 'clang-darwin'
263 compiler_name = 'clang'
264 elif conf.env['MSVC_COMPILER']:
265 compiler_name = 'msvc'
267 if platform == 'darwin':
268 compiler_name = 'gcc-darwin'
270 compiler_name = 'gcc'
272 flags_dict = compiler_flags_dictionaries[compiler_name]
274 autowaf.set_basic_compiler_flags (conf,flags_dict)
276 if conf.options.asan:
277 conf.check_cxx(cxxflags=["-fsanitize=address", "-fno-omit-frame-pointer"], linkflags=["-fsanitize=address"])
278 cxx_flags.append('-fsanitize=address')
279 cxx_flags.append('-fno-omit-frame-pointer')
280 linker_flags.append('-fsanitize=address')
283 debug_flags = [ flags_dict['profile'] ]
286 if platform == 'darwin':
287 if re.search ("^13[.]", version) != None:
288 conf.env['build_host'] = 'mavericks'
289 elif re.search ("^14[.]", version) != None:
290 conf.env['build_host'] = 'yosemite'
292 conf.env['build_host'] = 'irrelevant'
295 if opt.dist_target == 'auto':
296 if platform == 'darwin':
297 # The [.] matches to the dot after the major version, "." would match any character
298 if re.search ("^[0-7][.]", version) != None:
299 conf.env['build_target'] = 'panther'
300 elif re.search ("^8[.]", version) != None:
301 conf.env['build_target'] = 'tiger'
302 elif re.search ("^9[.]", version) != None:
303 conf.env['build_target'] = 'leopard'
304 elif re.search ("^10[.]", version) != None:
305 conf.env['build_target'] = 'snowleopard'
306 elif re.search ("^11[.]", version) != None:
307 conf.env['build_target'] = 'lion'
308 elif re.search ("^12[.]", version) != None:
309 conf.env['build_target'] = 'mountainlion'
310 elif re.search ("^13[.]", version) != None:
311 conf.env['build_target'] = 'mavericks'
313 conf.env['build_target'] = 'yosemite'
316 "(?P<cpu>i[0-6]86|x86_64|powerpc|ppc|ppc64|arm|s390x?)",
319 conf.env['build_target'] = match.group("cpu")
320 if re.search("i[0-5]86", conf.env['build_target']):
321 conf.env['build_target'] = "i386"
323 conf.env['build_target'] = 'none'
325 conf.env['build_target'] = opt.dist_target
327 if conf.env['build_target'] == 'snowleopard':
329 # stupid OS X 10.6 has a bug in math.h that prevents llrint and friends
330 # from being visible.
332 compiler_flags.append ('-U__STRICT_ANSI__')
334 if conf.options.cxx11 or conf.env['build_host'] in [ 'mavericks', 'yosemite' ]:
335 conf.check_cxx(cxxflags=["-std=c++11"])
336 cxx_flags.append('-std=c++11')
337 if platform == "darwin":
338 cxx_flags.append('--stdlib=libstdc++')
339 # Mavericks and later changed the syntax to be used when including Carbon headers,
340 # from requiring a full path to requiring just the header name.
341 cxx_flags.append('-DCARBON_FLAT_HEADERS')
342 linker_flags.append('--stdlib=libstdc++')
343 # Prevents visibility issues in standard headers
344 conf.define("_DARWIN_C_SOURCE", 1)
346 if (is_clang and platform == "darwin") or conf.env['build_host'] in ['mavericks', 'yosemite']:
347 # Silence warnings about the non-existing osx clang compiler flags
348 # -compatibility_version and -current_version. These are Waf
349 # generated and not needed with clang
350 c_flags.append("-Qunused-arguments")
351 cxx_flags.append("-Qunused-arguments")
353 if ((re.search ("i[0-9]86", cpu) != None) or (re.search ("x86_64", cpu) != None)) and conf.env['build_target'] != 'none':
357 # ARCH_X86 means anything in the x86 family from i386 to x86_64
358 # the compile-time presence of the macro _LP64 is used to
359 # distingush 32 and 64 bit assembler
362 if (re.search ("(i[0-9]86|x86_64)", cpu) != None):
363 compiler_flags.append ("-DARCH_X86")
365 if platform == 'linux' :
368 # determine processor flags via /proc/cpuinfo
371 if conf.env['build_target'] != 'i386':
373 flag_line = os.popen ("cat /proc/cpuinfo | grep '^flags'").read()[:-1]
374 x86_flags = flag_line.split (": ")[1:][0].split ()
376 if "mmx" in x86_flags:
377 compiler_flags.append ("-mmmx")
378 if "sse" in x86_flags:
379 build_host_supports_sse = True
380 if "3dnow" in x86_flags:
381 compiler_flags.append ("-m3dnow")
384 compiler_flags.append ("-march=i586")
386 compiler_flags.append ("-march=i686")
388 if ((conf.env['build_target'] == 'i686') or (conf.env['build_target'] == 'x86_64')) and build_host_supports_sse:
389 compiler_flags.extend ([ flags_dict['sse'], flags_dict['fpmath-sse'], flags_dict['xmmintrinsics'] ])
391 # end of processor-specific section
393 # optimization section
394 if conf.env['FPU_OPTIMIZATION']:
395 if sys.platform == 'darwin':
396 compiler_flags.append("-DBUILD_VECLIB_OPTIMIZATIONS");
397 conf.env.append_value('LINKFLAGS_OSX', ['-framework', 'Accelerate'])
398 elif conf.env['build_target'] == 'i686' or conf.env['build_target'] == 'x86_64':
399 compiler_flags.append ("-DBUILD_SSE_OPTIMIZATIONS")
400 if not build_host_supports_sse:
401 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)")
403 # end optimization section
409 if conf.env['build_target'] == 'x86_64' and opt.windows_vst:
410 print("\n\n==================================================")
411 print("You cannot use VST plugins with a 64 bit host. Please run waf with --windows-vst=0")
412 print("\nIt is theoretically possible to build a 32 bit host on a 64 bit system.")
413 print("However, this is tricky and not recommended for beginners.")
416 if conf.env['LXVST_SUPPORT'] == True:
417 if conf.env['build_target'] == 'x86_64':
418 compiler_flags.append("-DLXVST_64BIT")
420 compiler_flags.append("-DLXVST_32BIT")
423 # a single way to test if we're on OS X
426 if conf.env['build_target'] in ['panther', 'tiger', 'leopard' ]:
427 # force tiger or later, to avoid issues on PPC which defaults
428 # back to 10.1 if we don't tell it otherwise.
430 compiler_flags.extend(
431 ("-DMAC_OS_X_VERSION_MIN_REQUIRED=1040",
432 '-mmacosx-version-min=10.4'))
434 elif conf.env['build_target'] in [ 'snowleopard' ]:
435 compiler_flags.extend(
436 ("-DMAC_OS_X_VERSION_MIN_REQUIRED=1060",
437 '-mmacosx-version-min=10.6'))
439 elif conf.env['build_target'] in [ 'lion', 'mountainlion' ]:
440 compiler_flags.extend(
441 ("-DMAC_OS_X_VERSION_MIN_REQUIRED=1070",
442 '-mmacosx-version-min=10.7'))
444 elif conf.env['build_target'] in [ 'mavericks', 'yosemite' ]:
445 compiler_flags.extend(
446 ("-DMAC_OS_X_VERSION_MAX_ALLOWED=1090",
447 "-mmacosx-version-min=10.8"))
450 # save off CPU element in an env
452 conf.define ('CONFIG_ARCH', cpu)
455 # ARCH="..." overrides all
459 optimization_flags = opt.arch.split()
462 # prepend boiler plate optimization flags that work on all architectures
465 optimization_flags[:0] = [flags_dict['pipe']]
467 # don't prepend optimization flags if "-O<something>" is present
468 prepend_opt_flags = True
469 for flag in optimization_flags:
470 if flag.startswith("-O"):
471 prepend_opt_flags = False
474 if prepend_opt_flags:
475 optimization_flags[:0] = flags_dict['full-optimization']
477 if opt.debug_symbols:
478 optimization_flags += flags_dict['debuggable']
481 cxx_flags.append("-D_GLIBCXX_DEBUG")
483 if conf.env['DEBUG_RT_ALLOC']:
484 compiler_flags.append('-DDEBUG_RT_ALLOC')
485 linker_flags.append('-ldl')
487 if conf.env['DEBUG_DENORMAL_EXCEPTION']:
488 compiler_flags.append('-DDEBUG_DENORMAL_EXCEPTION')
491 compiler_flags.extend(flags_dict['generic-x86'])
492 linker_flags.extend(flags_dict['generic-x86'])
495 compiler_flags.extend(flags_dict['generic-ppc'])
496 linker_flags.extend(flags_dict['generic-ppc'])
502 compiler_flags.extend(flags_dict['basic-warnings'])
504 c_flags.extend(flags_dict['extra-c-warnings'])
505 cxx_flags.extend (flags_dict['extra-cxx-warnings'])
511 # need ISOC9X for llabs()
512 compiler_flags.extend(
513 ('-DBOOST_SYSTEM_NO_DEPRECATED', '-D_ISOC9X_SOURCE',
514 '-D_LARGEFILE64_SOURCE', '-D_FILE_OFFSET_BITS=64'))
516 ('-D__STDC_LIMIT_MACROS', '-D__STDC_FORMAT_MACROS',
517 '-DCANVAS_COMPATIBILITY', '-DCANVAS_DEBUG'))
520 compiler_flags.append('-DENABLE_NLS')
522 compiler_flags.append ('-DPROGRAM_NAME="' + Options.options.program_name + '"')
523 compiler_flags.append ('-DPROGRAM_VERSION="' + PROGRAM_VERSION + '"')
526 conf.env.append_value('CFLAGS', debug_flags)
527 conf.env.append_value('CXXFLAGS', debug_flags)
529 conf.env.append_value('CFLAGS', optimization_flags)
530 conf.env.append_value('CXXFLAGS', optimization_flags)
533 if platform != 'darwin' and not is_clang and not Options.options.dist_target == 'mingw':
534 linker_flags += [ '-rdynamic' ]
536 conf.env.append_value('CFLAGS', compiler_flags)
537 conf.env.append_value('CFLAGS', c_flags)
538 conf.env.append_value('CXXFLAGS', compiler_flags)
539 conf.env.append_value('CXXFLAGS', cxx_flags)
540 conf.env.append_value('LINKFLAGS', linker_flags)
542 #----------------------------------------------------------------
547 opt.load('compiler_c')
548 opt.load('compiler_cxx')
549 autowaf.set_options(opt, debug_by_default=True)
550 opt.add_option('--program-name', type='string', action='store', default='Ardour', dest='program_name',
551 help='The user-visible name of the program being built')
552 opt.add_option ('--trx', action='store_true', default=False, dest='trx_build',
553 help='Whether to build for TRX')
554 opt.add_option('--arch', type='string', action='store', dest='arch',
555 help='Architecture-specific compiler FLAGS')
556 opt.add_option('--with-backends', type='string', action='store', default='jack', dest='with_backends',
557 help='Specify which backend modules are to be included(jack,alsa,wavesaudio,dummy)')
558 opt.add_option('--backtrace', action='store_true', default=True, dest='backtrace',
559 help='Compile with -rdynamic -- allow obtaining backtraces from within Ardour')
560 opt.add_option('--no-carbon', action='store_true', default=False, dest='nocarbon',
561 help='Compile without support for AU Plugins with only CARBON UI (needed for 64bit)')
562 opt.add_option('--boost-sp-debug', action='store_true', default=False, dest='boost_sp_debug',
563 help='Compile with Boost shared pointer debugging')
564 opt.add_option('--debug-symbols', action='store_true', default=False, dest='debug_symbols',
565 help='Add debug-symbols to optimized builds')
566 opt.add_option('--depstack-root', type='string', default='~', dest='depstack_root',
567 help='Directory/folder where dependency stack trees (gtk, a3) can be found (defaults to ~)')
568 opt.add_option('--dist-target', type='string', default='auto', dest='dist_target',
569 help='Specify the target for cross-compiling [auto,none,x86,i386,i686,x86_64,tiger,leopard,mingw,msvc]')
570 opt.add_option('--fpu-optimization', action='store_true', default=True, dest='fpu_optimization',
571 help='Build runtime checked assembler code (default)')
572 opt.add_option('--no-fpu-optimization', action='store_false', dest='fpu_optimization')
573 opt.add_option('--exports-hidden', action='store_true', default=False, dest='exports_hidden')
574 opt.add_option('--freedesktop', action='store_true', default=False, dest='freedesktop',
575 help='Install MIME type, icons and .desktop file as per freedesktop.org standards')
576 opt.add_option('--freebie', action='store_true', default=False, dest='freebie',
577 help='Build a version suitable for distribution as a zero-cost binary')
578 opt.add_option('--gprofile', action='store_true', default=False, dest='gprofile',
579 help='Compile for use with gprofile')
580 opt.add_option('--libjack', type='string', default="auto", dest='libjack_link',
581 help='libjack link mode [auto|link|weak]')
582 opt.add_option('--internal-shared-libs', action='store_true', default=True, dest='internal_shared_libs',
583 help='Build internal libs as shared libraries')
584 opt.add_option('--internal-static-libs', action='store_false', dest='internal_shared_libs',
585 help='Build internal libs as static libraries')
586 opt.add_option('--use-external-libs', action='store_true', default=False, dest='use_external_libs',
587 help='Use external/system versions of some bundled libraries')
588 opt.add_option('--lv2', action='store_true', default=True, dest='lv2',
589 help='Compile with support for LV2 (if Lilv+Suil is available)')
590 opt.add_option('--no-lv2', action='store_false', dest='lv2',
591 help='Do not compile with support for LV2')
592 opt.add_option('--lv2dir', type='string', help="install destination for builtin LV2 bundles [Default: LIBDIR/lv2]")
593 opt.add_option('--lxvst', action='store_true', default=True, dest='lxvst',
594 help='Compile with support for linuxVST plugins')
595 opt.add_option('--no-lxvst', action='store_false', dest='lxvst',
596 help='Compile without support for linuxVST plugins')
597 opt.add_option('--no-lrdf', action='store_true', dest='no_lrdf',
598 help='Compile without support for LRDF LADSPA data even if present')
599 opt.add_option('--nls', action='store_true', default=True, dest='nls',
600 help='Enable i18n (native language support) (default)')
601 opt.add_option('--no-nls', action='store_false', dest='nls')
602 opt.add_option('--phone-home', action='store_true', default=True, dest='phone_home',
603 help='Contact ardour.org at startup for new announcements')
604 opt.add_option('--no-phone-home', action='store_false', dest='phone_home',
605 help='Do not contact ardour.org at startup for new announcements')
606 opt.add_option('--stl-debug', action='store_true', default=False, dest='stl_debug',
607 help='Build with debugging for the STL')
608 opt.add_option('--rt-alloc-debug', action='store_true', default=False, dest='rt_alloc_debug',
609 help='Build with debugging for memory allocation in the real-time thread')
610 opt.add_option('--pt-timing', action='store_true', default=False, dest='pt_timing',
611 help='Build with logging of timing in the process thread(s)')
612 opt.add_option('--denormal-exception', action='store_true', default=False, dest='denormal_exception',
613 help='Raise a floating point exception if a denormal is detected')
614 opt.add_option('--test', action='store_true', default=False, dest='build_tests',
615 help="Build unit tests")
616 opt.add_option('--run-tests', action='store_true', default=False, dest='run_tests',
617 help="Run tests after build")
618 opt.add_option('--single-tests', action='store_true', default=False, dest='single_tests',
619 help="Build a single executable for each unit test")
620 #opt.add_option('--tranzport', action='store_true', default=False, dest='tranzport',
621 # help='Compile with support for Frontier Designs Tranzport (if libusb is available)')
622 opt.add_option('--generic', action='store_true', default=False, dest='generic',
623 help='Compile with -arch i386 (OS X ONLY)')
624 opt.add_option('--ppc', action='store_true', default=False, dest='ppc',
625 help='Compile with -arch ppc (OS X ONLY)')
626 opt.add_option('--versioned', action='store_true', default=False, dest='versioned',
627 help='Add revision information to executable name inside the build directory')
628 opt.add_option('--windows-vst', action='store_true', default=False, dest='windows_vst',
629 help='Compile with support for Windows VST')
630 opt.add_option('--windows-key', type='string', action='store', dest='windows_key', default='Mod4><Super',
631 help='X Modifier(s) (Mod1,Mod2, etc) for the Windows key (X11 builds only). ' +
632 'Multiple modifiers must be separated by \'><\'')
633 opt.add_option('--boost-include', type='string', action='store', dest='boost_include', default='',
634 help='directory where Boost header files can be found')
635 opt.add_option('--also-include', type='string', action='store', dest='also_include', default='',
636 help='additional include directory where header files can be found (split multiples with commas)')
637 opt.add_option('--also-libdir', type='string', action='store', dest='also_libdir', default='',
638 help='additional include directory where shared libraries can be found (split multiples with commas)')
639 opt.add_option('--wine-include', type='string', action='store', dest='wine_include', default='/usr/include/wine/windows',
640 help='directory where Wine\'s Windows header files can be found')
641 opt.add_option('--noconfirm', action='store_true', default=False, dest='noconfirm',
642 help='Do not ask questions that require confirmation during the build')
643 opt.add_option('--cxx11', action='store_true', default=False, dest='cxx11',
644 help='Turn on c++11 compiler flags (-std=c++11)')
645 opt.add_option('--address-sanitizer', action='store_true', default=False, dest='asan',
646 help='Turn on AddressSanitizer (requires GCC >= 4.8 or clang >= 3.1)')
650 def sub_config_and_use(conf, name, has_objects = True):
652 autowaf.set_local_lib(conf, name, has_objects)
655 conf.load('compiler_c')
656 conf.load('compiler_cxx')
657 if Options.options.dist_target == 'mingw':
660 if Options.options.dist_target == 'msvc':
661 conf.env['MSVC_VERSIONS'] = ['msvc 10.0', 'msvc 9.0', 'msvc 8.0', 'msvc 7.1', 'msvc 7.0', 'msvc 6.0', ]
662 conf.env['MSVC_TARGETS'] = ['x64']
665 if Options.options.debug:
666 # Nuke user CFLAGS/CXXFLAGS if debug is set (they likely contain -O3, NDEBUG, etc)
667 conf.env['CFLAGS'] = []
668 conf.env['CXXFLAGS'] = []
670 conf.env['VERSION'] = VERSION
671 conf.env['MAJOR'] = MAJOR
672 conf.env['MINOR'] = MINOR
674 autowaf.set_recursive()
675 autowaf.configure(conf)
676 autowaf.display_header('Ardour Configuration')
678 gcc_versions = fetch_gcc_version(str(conf.env['CC']))
679 if not Options.options.debug and gcc_versions[0] == '4' and gcc_versions[1] > '4':
680 print('Version 4.5 of gcc is not ready for use when compiling Ardour with optimization.')
681 print('Please use a different version or re-configure with --debug')
684 # systems with glibc have libintl builtin. systems without require explicit
685 # linkage against libintl.
688 pkg_config_path = os.getenv('PKG_CONFIG_PATH')
689 user_gtk_root = os.path.expanduser (Options.options.depstack_root + '/gtk/inst')
691 if pkg_config_path is not None and pkg_config_path.find (user_gtk_root) >= 0:
692 # told to search user_gtk_root
693 prefinclude = ''.join ([ '-I', user_gtk_root + '/include'])
694 preflib = ''.join ([ '-L', user_gtk_root + '/lib'])
695 conf.env.append_value('CFLAGS', [ prefinclude ])
696 conf.env.append_value('CXXFLAGS', [prefinclude ])
697 conf.env.append_value('LINKFLAGS', [ preflib ])
698 autowaf.display_msg(conf, 'Will build against private GTK dependency stack in ' + user_gtk_root, 'yes')
700 autowaf.display_msg(conf, 'Will build against private GTK dependency stack', 'no')
702 if sys.platform == 'darwin':
703 conf.define ('NEED_INTL', 1)
704 autowaf.display_msg(conf, 'Will use explicit linkage against libintl in ' + user_gtk_root, 'yes')
706 # libintl is part of the system, so use it
707 autowaf.display_msg(conf, 'Will rely on libintl built into libc', 'yes')
709 user_ardour_root = os.path.expanduser (Options.options.depstack_root + '/a3/inst')
710 if pkg_config_path is not None and pkg_config_path.find (user_ardour_root) >= 0:
711 # told to search user_ardour_root
712 prefinclude = ''.join ([ '-I', user_ardour_root + '/include'])
713 preflib = ''.join ([ '-L', user_ardour_root + '/lib'])
714 conf.env.append_value('CFLAGS', [ prefinclude ])
715 conf.env.append_value('CXXFLAGS', [prefinclude ])
716 conf.env.append_value('LINKFLAGS', [ preflib ])
717 autowaf.display_msg(conf, 'Will build against private Ardour dependency stack in ' + user_ardour_root, 'yes')
719 autowaf.display_msg(conf, 'Will build against private Ardour dependency stack', 'no')
721 if Options.options.freebie:
722 conf.env.append_value ('CFLAGS', '-DNO_PLUGIN_STATE')
723 conf.env.append_value ('CXXFLAGS', '-DNO_PLUGIN_STATE')
724 conf.define ('NO_PLUGIN_STATE', 1)
726 if Options.options.trx_build:
727 conf.define ('TRX_BUILD', 1)
729 if Options.options.lv2dir:
730 conf.env['LV2DIR'] = Options.options.lv2dir
732 conf.env['LV2DIR'] = os.path.join(conf.env['LIBDIR'], 'lv2')
734 conf.env['LV2DIR'] = os.path.normpath(conf.env['LV2DIR'])
736 if sys.platform == 'darwin':
738 # this is required, potentially, for anything we link and then relocate into a bundle
739 conf.env.append_value('LINKFLAGS', [ '-Xlinker', '-headerpad_max_install_names' ])
741 conf.define ('HAVE_COREAUDIO', 1)
742 conf.define ('AUDIOUNIT_SUPPORT', 1)
744 conf.define ('GTKOSX', 1)
745 conf.define ('TOP_MENUBAR',1)
746 conf.define ('GTKOSX',1)
748 # It would be nice to be able to use this to force back-compatibility with 10.4
749 # but even by the time of 11, the 10.4 SDK is no longer available in any normal
752 #conf.env.append_value('CXXFLAGS_OSX', "-isysroot /Developer/SDKs/MacOSX10.4u.sdk")
753 #conf.env.append_value('CFLAGS_OSX', "-isysroot /Developer/SDKs/MacOSX10.4u.sdk")
754 #conf.env.append_value('LINKFLAGS_OSX', "-sysroot /Developer/SDKs/MacOSX10.4u.sdk")
755 #conf.env.append_value('LINKFLAGS_OSX', "-sysroot /Developer/SDKs/MacOSX10.4u.sdk")
757 conf.env.append_value('CXXFLAGS_OSX', "-msse")
758 conf.env.append_value('CFLAGS_OSX', "-msse")
759 conf.env.append_value('CXXFLAGS_OSX', "-msse2")
760 conf.env.append_value('CFLAGS_OSX', "-msse2")
762 # TODO: The previous sse flags NEED to be based
763 # off processor type. Need to add in a check
766 conf.env.append_value('CXXFLAGS_OSX', '-F/System/Library/Frameworks')
767 conf.env.append_value('CXXFLAGS_OSX', '-F/Library/Frameworks')
769 conf.env.append_value('LINKFLAGS_OSX', ['-framework', 'AppKit'])
770 conf.env.append_value('LINKFLAGS_OSX', ['-framework', 'CoreAudio'])
771 conf.env.append_value('LINKFLAGS_OSX', ['-framework', 'CoreAudioKit'])
772 conf.env.append_value('LINKFLAGS_OSX', ['-framework', 'CoreFoundation'])
773 conf.env.append_value('LINKFLAGS_OSX', ['-framework', 'CoreServices'])
775 conf.env.append_value('LINKFLAGS_OSX', ['-undefined', 'dynamic_lookup' ])
776 conf.env.append_value('LINKFLAGS_OSX', ['-flat_namespace'])
778 conf.env.append_value('CXXFLAGS_AUDIOUNITS', "-DAUDIOUNIT_SUPPORT")
779 conf.env.append_value('LINKFLAGS_AUDIOUNITS', ['-framework', 'AudioToolbox', '-framework', 'AudioUnit'])
780 conf.env.append_value('LINKFLAGS_AUDIOUNITS', ['-framework', 'Cocoa'])
782 if re.search ("^[1-9][0-9]\.", os.uname()[2]) == None and not Options.options.nocarbon:
783 conf.env.append_value('CXXFLAGS_AUDIOUNITS', "-DWITH_CARBON")
784 conf.env.append_value('LINKFLAGS_AUDIOUNITS', ['-framework', 'Carbon'])
786 print ('No Carbon support available for this build\n')
789 if Options.options.internal_shared_libs:
790 conf.define('INTERNAL_SHARED_LIBS', 1)
792 if Options.options.use_external_libs:
793 conf.define('USE_EXTERNAL_LIBS', 1)
795 if Options.options.boost_include != '':
796 conf.env.append_value('CXXFLAGS', '-I' + Options.options.boost_include)
798 if Options.options.also_include != '':
799 conf.env.append_value('CXXFLAGS', '-I' + Options.options.also_include)
800 conf.env.append_value('CFLAGS', '-I' + Options.options.also_include)
802 if Options.options.also_libdir != '':
803 conf.env.append_value('LDFLAGS', '-L' + Options.options.also_libdir)
805 if Options.options.boost_sp_debug:
806 conf.env.append_value('CXXFLAGS', '-DBOOST_SP_ENABLE_DEBUG_HOOKS')
808 # executing a test program is n/a when cross-compiling
809 if Options.options.dist_target != 'mingw':
810 if Options.options.dist_target != 'msvc':
811 conf.check_cc(function_name='dlopen', header_name='dlfcn.h', lib='dl', uselib_store='DL')
812 conf.check_cxx(fragment = "#include <boost/version.hpp>\nint main(void) { return (BOOST_VERSION >= 103900 ? 0 : 1); }\n",
815 msg = 'Checking for boost library >= 1.39',
817 errmsg = 'too old\nPlease install boost version 1.39 or higher.')
819 if re.search ("linux", sys.platform) != None and Options.options.dist_target != 'mingw':
820 autowaf.check_pkg(conf, 'alsa', uselib_store='ALSA')
822 autowaf.check_pkg(conf, 'glib-2.0', uselib_store='GLIB', atleast_version='2.28', mandatory=True)
823 autowaf.check_pkg(conf, 'gthread-2.0', uselib_store='GTHREAD', atleast_version='2.2', mandatory=True)
824 autowaf.check_pkg(conf, 'glibmm-2.4', uselib_store='GLIBMM', atleast_version='2.32.0', mandatory=True)
825 autowaf.check_pkg(conf, 'sndfile', uselib_store='SNDFILE', atleast_version='1.0.18', mandatory=True)
826 autowaf.check_pkg(conf, 'giomm-2.4', uselib_store='GIOMM', atleast_version='2.2', mandatory=True)
827 autowaf.check_pkg(conf, 'libcurl', uselib_store='CURL', atleast_version='7.0.0', mandatory=True)
828 autowaf.check_pkg(conf, 'liblo', uselib_store='LO', atleast_version='0.26', mandatory=True)
829 autowaf.check_pkg(conf, 'taglib', uselib_store='TAGLIB', atleast_version='1.6', mandatory=True)
830 autowaf.check_pkg(conf, 'vamp-sdk', uselib_store='VAMPSDK', atleast_version='2.1', mandatory=True)
831 autowaf.check_pkg(conf, 'vamp-hostsdk', uselib_store='VAMPHOSTSDK', atleast_version='2.1', mandatory=True)
832 autowaf.check_pkg(conf, 'rubberband', uselib_store='RUBBERBAND', mandatory=True)
834 if Options.options.dist_target == 'mingw':
835 Options.options.fpu_optimization = False
836 conf.env.append_value('CFLAGS', '-DPLATFORM_WINDOWS')
837 conf.env.append_value('CFLAGS', '-DCOMPILER_MINGW')
838 conf.env.append_value('CXXFLAGS', '-DPLATFORM_WINDOWS')
839 conf.env.append_value('CXXFLAGS', '-DCOMPILER_MINGW')
840 conf.env.append_value('LIB', 'pthread')
841 # needed for at least libsmf
842 conf.check_cc(function_name='htonl', header_name='winsock2.h', lib='ws2_32')
843 conf.env.append_value('LIB', 'ws2_32')
844 conf.env.append_value('LIB', 'winmm')
845 # needed for mingw64 packages, not harmful on normal mingw build
846 conf.env.append_value('LIB', 'intl')
847 conf.check_cc(function_name='regcomp', header_name='regex.h',
848 lib='regex', uselib_store="REGEX", define_name='HAVE_REGEX_H')
849 # TODO put this only where it is needed
850 conf.env.append_value('LIB', 'regex')
852 # work around GdkDrawable BitBlt performance issue on windows
853 # see http://gareus.org/wiki/ardour_windows_gdk_and_cairo
854 conf.env.append_value('CFLAGS', '-DUSE_CAIRO_IMAGE_SURFACE')
855 conf.env.append_value('CXXFLAGS', '-DUSE_CAIRO_IMAGE_SURFACE')
857 if Options.options.dist_target == 'msvc':
858 conf.env.append_value('CFLAGS', '-DPLATFORM_WINDOWS')
859 conf.env.append_value('CFLAGS', '-DCOMPILER_MSVC')
860 conf.env.append_value('CXXFLAGS', '-DPLATFORM_WINDOWS')
861 conf.env.append_value('CXXFLAGS', '-DCOMPILER_MSVC')
862 # work around GdkDrawable BitBlt performance issue on windows
863 # see http://gareus.org/wiki/ardour_windows_gdk_and_cairo
864 conf.env.append_value('CFLAGS', '-DUSE_CAIRO_IMAGE_SURFACE')
865 conf.env.append_value('CXXFLAGS', '-DUSE_CAIRO_IMAGE_SURFACE')
866 # MORE STUFF PROBABLY NEEDED HERE
868 # Tell everyone that this is a waf build
870 conf.env.append_value('CFLAGS', '-DWAF_BUILD')
871 conf.env.append_value('CXXFLAGS', '-DWAF_BUILD')
873 opts = Options.options
875 # (optionally) Adopt Microsoft-like convention that makes all non-explicitly exported
876 # symbols invisible (rather than doing this all over the wscripts in the src tree)
878 # This won't apply to MSVC but that hasn't been added as a target yet
880 # We can't do this till all tests are complete, since some fail if this is et.
881 if opts.exports_hidden:
882 conf.define ('EXPORT_VISIBILITY_HIDDEN', True)
883 if opts.internal_shared_libs:
884 conf.env.append_value ('CXXFLAGS', '-fvisibility=hidden')
885 conf.env.append_value ('CFLAGS', '-fvisibility=hidden')
887 conf.define ('EXPORT_VISIBILITY_HIDDEN', False)
889 # Set up waf environment and C defines
891 conf.define('PHONE_HOME', 1)
892 conf.env['PHONE_HOME'] = True
893 if opts.fpu_optimization:
894 conf.env['FPU_OPTIMIZATION'] = True
896 conf.define('ENABLE_NLS', 1)
897 conf.env['ENABLE_NLS'] = True
899 conf.env['BUILD_TESTS'] = True
900 conf.env['RUN_TESTS'] = opts.run_tests
901 if opts.single_tests:
902 conf.env['SINGLE_TESTS'] = opts.single_tests
904 # conf.env['TRANZPORT'] = 1
906 conf.define('WINDOWS_VST_SUPPORT', 1)
907 conf.env['WINDOWS_VST_SUPPORT'] = True
908 if not Options.options.dist_target == 'mingw':
909 conf.env.append_value('CFLAGS', '-I' + Options.options.wine_include)
910 conf.env.append_value('CXXFLAGS', '-I' + Options.options.wine_include)
911 autowaf.check_header(conf, 'cxx', 'windows.h', mandatory = True)
913 if sys.platform == 'darwin':
914 conf.env['LXVST_SUPPORT'] = False
915 elif Options.options.dist_target == 'mingw':
916 conf.env['LXVST_SUPPORT'] = False
918 conf.define('LXVST_SUPPORT', 1)
919 conf.env['LXVST_SUPPORT'] = True
920 conf.env['WINDOWS_KEY'] = opts.windows_key
921 if opts.rt_alloc_debug:
922 conf.define('DEBUG_RT_ALLOC', 1)
923 conf.env['DEBUG_RT_ALLOC'] = True
925 conf.define('PT_TIMING', 1)
926 conf.env['PT_TIMING'] = True
927 if opts.denormal_exception:
928 conf.define('DEBUG_DENORMAL_EXCEPTION', 1)
929 conf.env['DEBUG_DENORMAL_EXCEPTION'] = True
931 autowaf.check_pkg(conf, 'cppunit', uselib_store='CPPUNIT', atleast_version='1.12.0', mandatory=True)
933 backends = opts.with_backends.split(',')
935 print("Must configure and build at least one backend")
938 conf.env['BACKENDS'] = backends
939 conf.env['BUILD_JACKBACKEND'] = any('jack' in b for b in backends)
940 conf.env['BUILD_ALSABACKEND'] = any('alsa' in b for b in backends)
941 conf.env['BUILD_DUMMYBACKEND'] = any('dummy' in b for b in backends)
942 conf.env['BUILD_WAVESBACKEND'] = any('wavesaudio' in b for b in backends)
944 set_compiler_flags (conf, Options.options)
946 if sys.platform == 'darwin':
947 sub_config_and_use(conf, 'libs/appleutility')
948 elif Options.options.dist_target != 'mingw':
949 sub_config_and_use(conf, 'tools/sanity_check')
951 sub_config_and_use(conf, 'libs/clearlooks-newer')
954 sub_config_and_use(conf, i)
956 # Fix utterly braindead FLAC include path to not smash assert.h
957 conf.env['INCLUDES_FLAC'] = []
959 config_text = open('libs/ardour/config_text.cc', "w")
960 config_text.write('''#include "ardour/ardour.h"
962 const char* const ardour_config_info = "\\n\\
965 def write_config_text(title, val):
966 autowaf.display_msg(conf, title, val)
967 config_text.write(title + ': ')
968 config_text.write(str(val).replace ('"', '\\"'))
969 config_text.write("\\n\\\n")
971 write_config_text('Build documentation', conf.env['DOCS'])
972 write_config_text('Debuggable build', conf.env['DEBUG'])
973 write_config_text('Export all symbols (backtrace)', opts.backtrace)
974 write_config_text('Install prefix', conf.env['PREFIX'])
975 write_config_text('Strict compiler flags', conf.env['STRICT'])
976 write_config_text('Internal Shared Libraries', conf.is_defined('INTERNAL_SHARED_LIBS'))
977 write_config_text('Use External Libraries', conf.is_defined('USE_EXTERNAL_LIBS'))
978 write_config_text('Library exports hidden', conf.is_defined('EXPORT_VISIBILITY_HIDDEN'))
980 write_config_text('ALSA Backend', conf.env['BUILD_ALSABACKEND'])
981 write_config_text('ALSA DBus Reservation', conf.is_defined('HAVE_DBUS'))
982 write_config_text('Architecture flags', opts.arch)
983 write_config_text('Aubio', conf.is_defined('HAVE_AUBIO'))
984 write_config_text('AudioUnits', conf.is_defined('AUDIOUNIT_SUPPORT'))
985 write_config_text('No plugin state', conf.is_defined('NO_PLUGIN_STATE'))
986 write_config_text('Build target', conf.env['build_target'])
987 write_config_text('CoreAudio', conf.is_defined('HAVE_COREAUDIO'))
988 write_config_text('Debug RT allocations', conf.is_defined('DEBUG_RT_ALLOC'))
989 write_config_text('Debug Symbols', conf.is_defined('debug_symbols') or conf.env['DEBUG'])
990 write_config_text('Dummy backend', conf.env['BUILD_DUMMYBACKEND'])
991 write_config_text('Process thread timing', conf.is_defined('PT_TIMING'))
992 write_config_text('Denormal exceptions', conf.is_defined('DEBUG_DENORMAL_EXCEPTION'))
993 write_config_text('FLAC', conf.is_defined('HAVE_FLAC'))
994 write_config_text('FPU optimization', opts.fpu_optimization)
995 write_config_text('Freedesktop files', opts.freedesktop)
996 write_config_text('JACK Backend', conf.env['BUILD_JACKBACKEND'])
997 write_config_text('Libjack linking', conf.env['libjack_link'])
998 write_config_text('LV2 UI embedding', conf.is_defined('HAVE_SUIL'))
999 write_config_text('LV2 support', conf.is_defined('LV2_SUPPORT'))
1000 write_config_text('LXVST support', conf.is_defined('LXVST_SUPPORT'))
1001 write_config_text('OGG', conf.is_defined('HAVE_OGG'))
1002 write_config_text('Phone home', conf.is_defined('PHONE_HOME'))
1003 write_config_text('Program name', opts.program_name)
1004 write_config_text('Samplerate', conf.is_defined('HAVE_SAMPLERATE'))
1005 # write_config_text('Soundtouch', conf.is_defined('HAVE_SOUNDTOUCH'))
1006 write_config_text('Translation', opts.nls)
1007 # write_config_text('Tranzport', opts.tranzport)
1008 write_config_text('Unit tests', conf.env['BUILD_TESTS'])
1009 write_config_text('Mac i386 Architecture', opts.generic)
1010 write_config_text('Mac ppc Architecture', opts.ppc)
1011 write_config_text('Waves Backend', conf.env['BUILD_WAVESBACKEND'])
1012 write_config_text('Windows VST support', opts.windows_vst)
1013 write_config_text('Wiimote support', conf.is_defined('BUILD_WIIMOTE'))
1014 write_config_text('Windows key', opts.windows_key)
1016 write_config_text('C compiler flags', conf.env['CFLAGS'])
1017 write_config_text('C++ compiler flags', conf.env['CXXFLAGS'])
1018 write_config_text('Linker flags', conf.env['LINKFLAGS'])
1020 config_text.write ('";\n}\n')
1021 config_text.close ()
1025 create_stored_revision()
1027 # add directories that contain only headers, to workaround an issue with waf
1029 if not bld.is_defined('USE_EXTERNAL_LIBS'):
1030 bld.path.find_dir ('libs/libltc/ltc')
1031 bld.path.find_dir ('libs/evoral/evoral')
1032 bld.path.find_dir ('libs/surfaces/control_protocol/control_protocol')
1033 bld.path.find_dir ('libs/timecode/timecode')
1034 bld.path.find_dir ('libs/gtkmm2ext/gtkmm2ext')
1035 bld.path.find_dir ('libs/ardour/ardour')
1036 bld.path.find_dir ('libs/pbd/pbd')
1038 # set up target directories
1039 lwrcase_dirname = 'ardour3'
1041 if bld.is_defined ('TRX_BUILD'):
1042 lwrcase_dirname = 'trx'
1044 # configuration files go here
1045 bld.env['CONFDIR'] = os.path.join(bld.env['SYSCONFDIR'], lwrcase_dirname)
1046 # data files loaded at run time go here
1047 bld.env['DATADIR'] = os.path.join(bld.env['DATADIR'], lwrcase_dirname)
1048 # shared objects loaded at runtime go here (two aliases)
1049 bld.env['DLLDIR'] = os.path.join(bld.env['LIBDIR'], lwrcase_dirname)
1050 bld.env['LIBDIR'] = bld.env['DLLDIR']
1051 bld.env['LOCALEDIR'] = os.path.join(bld.env['DATADIR'], 'locale')
1052 bld.env['lwrcase_dirname'] = lwrcase_dirname;
1054 autowaf.set_recursive()
1056 if sys.platform == 'darwin':
1057 bld.recurse('libs/appleutility')
1058 elif bld.env['build_target'] != 'mingw':
1059 bld.recurse('tools/sanity_check')
1061 bld.recurse('libs/clearlooks-newer')
1066 bld.install_files (bld.env['CONFDIR'], 'system_config')
1068 if bld.env['RUN_TESTS']:
1069 bld.add_post_fun(test)
1072 bld.recurse (i18n_children)
1075 bld.recurse (i18n_children)
1078 bld.recurse (i18n_children)
1081 bld.recurse (i18n_children)
1084 create_stored_revision()
1087 subprocess.call("gtk2_ardour/artest")