wscript

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