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
  12 def fetch_git_revision ():
  13     cmd = "git describe HEAD"
  14     output = subprocess.Popen(cmd, shell=True, stderr=subprocess.STDOUT, stdout=subprocess.PIPE).communicate()[0].splitlines()
  15     rev = output[0].decode ('utf-8')
  16     return rev
  17
  18 def fetch_tarball_revision ():
  19     if not os.path.exists ('libs/ardour/revision.cc'):
  20         print ('This tarball was not created correctly - it is missing libs/ardour/revision.cc')
  21         sys.exit (1)
  22     with open('libs/ardour/revision.cc') as f:
  23         content = f.readlines()
  24         remove_punctuation_map = dict((ord(char), None) for char in '";')
  25         return content[1].decode('utf-8').strip().split(' ')[7].translate (remove_punctuation_map)
  26
  27 if os.path.isdir (os.path.join(os.getcwd(), '.git')):
  28     rev = fetch_git_revision ()
  29 else:
  30     rev = fetch_tarball_revision ()
  31
  32 #
  33 # rev is now of the form MAJOR.MINOR-rev-commit
  34 # or, if right at the same rev as a release, MAJOR.MINOR
  35 #
  36
  37 parts = rev.split ('.')
  38 MAJOR = parts[0]
  39 other = parts[1].split ('-')
  40 MINOR = other[0]
  41 if len(other) > 1:
  42     MICRO = other[1]
  43 else:
  44     MICRO = '0'
  45
  46 V = MAJOR + '.' + MINOR + '.' + MICRO
  47 VERSION = V
  48 PROGRAM_VERSION = MAJOR
  49
  50 # Mandatory variables
  51 top = '.'
  52 out = 'build'
  53
  54 children = [
  55         # optionally external libraries
  56         'libs/qm-dsp',
  57         'libs/vamp-plugins',
  58         'libs/libltc',
  59         # core ardour libraries
  60         'libs/pbd',
  61         'libs/midi++2',
  62         'libs/evoral',
  63         'libs/surfaces',
  64         'libs/panners',
  65         'libs/backends',
  66         'libs/timecode',
  67         'libs/ardour',
  68         'libs/gtkmm2ext',
  69         'libs/audiographer',
  70         'libs/canvas',
  71         'libs/plugins/reasonablesynth.lv2',
  72         'gtk2_ardour',
  73         'export',
  74         'midi_maps',
  75         'mcp',
  76         'patchfiles',
  77         'headless',
  78         # shared helper binaries (plugin-scanner, exec-wrapper)
  79         'libs/fst',
  80         'libs/vfork',
  81         'libs/ardouralsautil',
  82 ]
  83
  84 i18n_children = [
  85         'gtk2_ardour',
  86         'libs/ardour',
  87         'libs/gtkmm2ext',
  88 ]
  89
  90 # Version stuff
  91
  92 def fetch_gcc_version (CC):
  93     cmd = "%s --version" % CC
  94     output = subprocess.Popen(cmd, shell=True, stderr=subprocess.STDOUT, stdout=subprocess.PIPE).communicate()[0].splitlines()
  95     o = output[0].decode('utf-8')
  96     version = o.split(' ')[2].split('.')
  97     return version
  98
  99 def create_stored_revision():
 100     rev = ""
 101     if os.path.exists('.git'):
 102         rev = fetch_git_revision();
 103         print("Git version: " + rev + "\n")
 104     elif os.path.exists('libs/ardour/revision.cc'):
 105         print("Using packaged revision")
 106         return
 107     else:
 108         print("Missing libs/ardour/revision.cc.  Blame the packager.")
 109         sys.exit(-1)
 110
 111     try:
 112         #
 113         # if you change the format of this, be sure to fix fetch_tarball_revision() above
 114         # so that  it still works.
 115         #
 116         text =  '#include "ardour/revision.h"\n'
 117         text += 'namespace ARDOUR { const char* revision = \"%s\"; }\n' % rev
 118         print('Writing revision info to libs/ardour/revision.cc using ' + rev)
 119         o = open('libs/ardour/revision.cc', 'w')
 120         o.write(text)
 121         o.close()
 122     except IOError:
 123         print('Could not open libs/ardour/revision.cc for writing\n')
 124         sys.exit(-1)
 125
 126 def set_compiler_flags (conf,opt):
 127     #
 128     # Compiler flags and other system-dependent stuff
 129     #
 130
 131     build_host_supports_sse = False
 132
 133     # Flags necessary for building
 134     compiler_flags = []     # generic
 135     c_flags = []            # C-specific
 136     cxx_flags = []          # C++-specific
 137     linker_flags = []
 138
 139     # Optimization flags (overridable)
 140     optimization_flags = []
 141
 142     # Debugging flags
 143     debug_flags = []
 144
 145     u = PLATFORM.uname ()
 146     cpu = u[4]
 147     platform = u[0].lower()
 148     version = u[2]
 149
 150     # waf adds -O0 -g itself. thanks waf!
 151     is_clang = conf.check_cxx(fragment = '''
 152 #ifndef __clang__
 153 #error
 154 #endif
 155 int main() { return 0; }''',
 156                          features  = 'cxx',
 157                          mandatory = False,
 158                          execute   = False,
 159                          msg       = 'Checking for clang')
 160
 161     if conf.options.asan:
 162         conf.check_cxx(cxxflags=["-fsanitize=address", "-fno-omit-frame-pointer"], linkflags=["-fsanitize=address"])
 163         cxx_flags.append('-fsanitize=address')
 164         cxx_flags.append('-fno-omit-frame-pointer')
 165         linker_flags.append('-fsanitize=address')
 166
 167     if opt.gprofile:
 168         debug_flags = [ '-pg' ]
 169
 170     # OSX
 171     if platform == 'darwin':
 172         if re.search ("^13[.]", version) != None:
 173             conf.env['build_host'] = 'mavericks'
 174         elif re.search ("^14[.]", version) != None:
 175             conf.env['build_host'] = 'yosemite'
 176         else:
 177             conf.env['build_host'] = 'irrelevant'
 178
 179     # Autodetect
 180     if opt.dist_target == 'auto':
 181         if platform == 'darwin':
 182             # The [.] matches to the dot after the major version, "." would match any character
 183             if re.search ("^[0-7][.]", version) != None:
 184                 conf.env['build_target'] = 'panther'
 185             elif re.search ("^8[.]", version) != None:
 186                 conf.env['build_target'] = 'tiger'
 187             elif re.search ("^9[.]", version) != None:
 188                 conf.env['build_target'] = 'leopard'
 189             elif re.search ("^10[.]", version) != None:
 190                 conf.env['build_target'] = 'snowleopard'
 191             elif re.search ("^11[.]", version) != None:
 192                 conf.env['build_target'] = 'lion'
 193             elif re.search ("^12[.]", version) != None:
 194                 conf.env['build_target'] = 'mountainlion'
 195             elif re.search ("^13[.]", version) != None:
 196                 conf.env['build_target'] = 'mavericks'
 197             else:
 198                 conf.env['build_target'] = 'yosemite'
 199         else:
 200             match = re.search(
 201                     "(?P<cpu>i[0-6]86|x86_64|powerpc|ppc|ppc64|arm|s390x?)",
 202                     cpu)
 203             if (match):
 204                 conf.env['build_target'] = match.group("cpu")
 205                 if re.search("i[0-5]86", conf.env['build_target']):
 206                     conf.env['build_target'] = "i386"
 207             else:
 208                 conf.env['build_target'] = 'none'
 209     else:
 210         conf.env['build_target'] = opt.dist_target
 211
 212     if conf.env['build_target'] == 'snowleopard':
 213         #
 214         # stupid OS X 10.6 has a bug in math.h that prevents llrint and friends
 215         # from being visible.
 216         #
 217         compiler_flags.append ('-U__STRICT_ANSI__')
 218
 219     if conf.options.cxx11 or conf.env['build_host'] in [ 'mavericks', 'yosemite' ]:
 220         conf.check_cxx(cxxflags=["-std=c++11"])
 221         cxx_flags.append('-std=c++11')
 222         if platform == "darwin":
 223             cxx_flags.append('--stdlib=libstdc++')
 224             # Mavericks and later changed the syntax to be used when including Carbon headers,
 225             # from requiring a full path to requiring just the header name.
 226             cxx_flags.append('-DCARBON_FLAT_HEADERS')
 227             linker_flags.append('--stdlib=libstdc++')
 228             # Prevents visibility issues in standard headers
 229             conf.define("_DARWIN_C_SOURCE", 1)
 230
 231     if (is_clang and platform == "darwin") or conf.env['build_host'] in ['mavericks', 'yosemite']:
 232         # Silence warnings about the non-existing osx clang compiler flags
 233         # -compatibility_version and -current_version.  These are Waf
 234         # generated and not needed with clang
 235         c_flags.append("-Qunused-arguments")
 236         cxx_flags.append("-Qunused-arguments")
 237
 238     if ((re.search ("i[0-9]86", cpu) != None) or (re.search ("x86_64", cpu) != None)) and conf.env['build_target'] != 'none':
 239
 240
 241         #
 242         # ARCH_X86 means anything in the x86 family from i386 to x86_64
 243         # the compile-time presence of the macro _LP64 is used to
 244         # distingush 32 and 64 bit assembler
 245         #
 246
 247         if (re.search ("(i[0-9]86|x86_64)", cpu) != None):
 248             compiler_flags.append ("-DARCH_X86")
 249
 250         if platform == 'linux' :
 251
 252             #
 253             # determine processor flags via /proc/cpuinfo
 254             #
 255
 256             if conf.env['build_target'] != 'i386':
 257
 258                 flag_line = os.popen ("cat /proc/cpuinfo | grep '^flags'").read()[:-1]
 259                 x86_flags = flag_line.split (": ")[1:][0].split ()
 260
 261                 if "mmx" in x86_flags:
 262                     compiler_flags.append ("-mmmx")
 263                 if "sse" in x86_flags:
 264                     build_host_supports_sse = True
 265                 if "3dnow" in x86_flags:
 266                     compiler_flags.append ("-m3dnow")
 267
 268             if cpu == "i586":
 269                 compiler_flags.append ("-march=i586")
 270             elif cpu == "i686":
 271                 compiler_flags.append ("-march=i686")
 272
 273         if not is_clang and ((conf.env['build_target'] == 'i686') or (conf.env['build_target'] == 'x86_64')) and build_host_supports_sse:
 274             compiler_flags.extend (["-msse", "-mfpmath=sse", "-DUSE_XMMINTRIN"])
 275
 276     # end of processor-specific section
 277
 278     # optimization section
 279     if conf.env['FPU_OPTIMIZATION']:
 280         if sys.platform == 'darwin':
 281             compiler_flags.append("-DBUILD_VECLIB_OPTIMIZATIONS");
 282             conf.env.append_value('LINKFLAGS_OSX', ['-framework', 'Accelerate'])
 283         elif conf.env['build_target'] == 'i686' or conf.env['build_target'] == 'x86_64':
 284             compiler_flags.append ("-DBUILD_SSE_OPTIMIZATIONS")
 285         if not build_host_supports_sse:
 286             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)")
 287
 288     # end optimization section
 289
 290     #
 291     # no VST on x86_64
 292     #
 293
 294     if conf.env['build_target'] == 'x86_64' and opt.windows_vst:
 295         print("\n\n==================================================")
 296         print("You cannot use VST plugins with a 64 bit host. Please run waf with --windows-vst=0")
 297         print("\nIt is theoretically possible to build a 32 bit host on a 64 bit system.")
 298         print("However, this is tricky and not recommended for beginners.")
 299         sys.exit (-1)
 300
 301     if conf.env['LXVST_SUPPORT'] == True:
 302         if conf.env['build_target'] == 'x86_64':
 303             compiler_flags.append("-DLXVST_64BIT")
 304         else:
 305             compiler_flags.append("-DLXVST_32BIT")
 306
 307     #
 308     # a single way to test if we're on OS X
 309     #
 310
 311     if conf.env['build_target'] in ['panther', 'tiger', 'leopard' ]:
 312         # force tiger or later, to avoid issues on PPC which defaults
 313         # back to 10.1 if we don't tell it otherwise.
 314
 315         compiler_flags.extend(
 316                 ("-DMAC_OS_X_VERSION_MIN_REQUIRED=1040",
 317                  '-mmacosx-version-min=10.4'))
 318
 319     elif conf.env['build_target'] in [ 'snowleopard' ]:
 320         compiler_flags.extend(
 321                 ("-DMAC_OS_X_VERSION_MIN_REQUIRED=1060",
 322                  '-mmacosx-version-min=10.6'))
 323
 324     elif conf.env['build_target'] in [ 'lion', 'mountainlion' ]:
 325         compiler_flags.extend(
 326                 ("-DMAC_OS_X_VERSION_MIN_REQUIRED=1070",
 327                  '-mmacosx-version-min=10.7'))
 328
 329     elif conf.env['build_target'] in [ 'mavericks', 'yosemite' ]:
 330         compiler_flags.extend(
 331                 ("-DMAC_OS_X_VERSION_MAX_ALLOWED=1090",
 332                  "-mmacosx-version-min=10.8"))
 333
 334     #
 335     # save off CPU element in an env
 336     #
 337     conf.define ('CONFIG_ARCH', cpu)
 338
 339     #
 340     # ARCH="..." overrides all
 341     #
 342
 343     if opt.arch != None:
 344         optimization_flags = opt.arch.split()
 345
 346     #
 347     # prepend boiler plate optimization flags that work on all architectures
 348     #
 349
 350     optimization_flags[:0] = ["-pipe"]
 351
 352     # don't prepend optimization flags if "-O<something>" is present
 353     prepend_opt_flags = True
 354     for flag in optimization_flags:
 355         if flag.startswith("-O"):
 356             prepend_opt_flags = False
 357             break
 358
 359     if prepend_opt_flags:
 360         optimization_flags[:0] = [
 361                 "-O3",
 362                 "-fomit-frame-pointer",
 363                 "-ffast-math",
 364                 "-fstrength-reduce"
 365                 ]
 366
 367     if opt.debug_symbols:
 368         optimization_flags += [ '-g' ]
 369
 370     if opt.stl_debug:
 371         cxx_flags.append("-D_GLIBCXX_DEBUG")
 372
 373     if conf.env['DEBUG_RT_ALLOC']:
 374         compiler_flags.append('-DDEBUG_RT_ALLOC')
 375         linker_flags.append('-ldl')
 376
 377     if conf.env['DEBUG_DENORMAL_EXCEPTION']:
 378         compiler_flags.append('-DDEBUG_DENORMAL_EXCEPTION')
 379
 380     if opt.generic:
 381         compiler_flags.extend(('-arch', 'i386'))
 382         linker_flags.extend(('-arch', 'i386'))
 383
 384     if opt.ppc:
 385         compiler_flags.extend(('-arch', 'ppc'))
 386         linker_flags.extend(('-arch', 'ppc'))
 387
 388     #
 389     # warnings flags
 390     #
 391
 392     compiler_flags.extend(
 393             ('-Wall', '-Wpointer-arith', '-Wcast-qual', '-Wcast-align', '-Wno-unused-parameter'))
 394
 395     c_flags.extend(('-Wstrict-prototypes', '-Wmissing-prototypes'))
 396     cxx_flags.append('-Woverloaded-virtual')
 397     if (not is_clang and not platform == "darwin"):
 398         cxx_flags.append('-Wno-unused-local-typedefs')
 399     if is_clang:
 400         cxx_flags.append('-Wno-mismatched-tags')
 401
 402     #
 403     # more boilerplate
 404     #
 405
 406     # need ISOC9X for llabs()
 407     compiler_flags.extend(
 408         ('-DBOOST_SYSTEM_NO_DEPRECATED', '-D_ISOC9X_SOURCE',
 409          '-D_LARGEFILE64_SOURCE', '-D_FILE_OFFSET_BITS=64'))
 410     cxx_flags.extend(
 411         ('-D__STDC_LIMIT_MACROS', '-D__STDC_FORMAT_MACROS',
 412          '-DCANVAS_COMPATIBILITY', '-DCANVAS_DEBUG'))
 413
 414     if opt.nls:
 415         compiler_flags.append('-DENABLE_NLS')
 416
 417     compiler_flags.append ('-DPROGRAM_NAME="' + Options.options.program_name + '"')
 418     compiler_flags.append ('-DPROGRAM_VERSION="' + PROGRAM_VERSION + '"')
 419
 420     if opt.debug:
 421         conf.env.append_value('CFLAGS', debug_flags)
 422         conf.env.append_value('CXXFLAGS', debug_flags)
 423     else:
 424         conf.env.append_value('CFLAGS', optimization_flags)
 425         conf.env.append_value('CXXFLAGS', optimization_flags)
 426
 427     if opt.backtrace:
 428         if platform != 'darwin' and not is_clang and not Options.options.dist_target == 'mingw':
 429             linker_flags += [ '-rdynamic' ]
 430
 431     conf.env.append_value('CFLAGS', compiler_flags)
 432     conf.env.append_value('CFLAGS', c_flags)
 433     conf.env.append_value('CXXFLAGS', compiler_flags)
 434     conf.env.append_value('CXXFLAGS', cxx_flags)
 435     conf.env.append_value('LINKFLAGS', linker_flags)
 436
 437 #----------------------------------------------------------------
 438
 439 # Waf stages
 440
 441 def options(opt):
 442     opt.load('compiler_c')
 443     opt.load('compiler_cxx')
 444     autowaf.set_options(opt, debug_by_default=True)
 445     opt.add_option('--program-name', type='string', action='store', default='Ardour', dest='program_name',
 446                     help='The user-visible name of the program being built')
 447     opt.add_option ('--trx', action='store_true', default=False, dest='trx_build',
 448                     help='Whether to build for TRX')
 449     opt.add_option('--arch', type='string', action='store', dest='arch',
 450                     help='Architecture-specific compiler FLAGS')
 451     opt.add_option('--with-backends', type='string', action='store', default='jack', dest='with_backends',
 452                     help='Specify which backend modules are to be included(jack,alsa,wavesaudio,dummy)')
 453     opt.add_option('--backtrace', action='store_true', default=True, dest='backtrace',
 454                     help='Compile with -rdynamic -- allow obtaining backtraces from within Ardour')
 455     opt.add_option('--no-carbon', action='store_true', default=False, dest='nocarbon',
 456                     help='Compile without support for AU Plugins with only CARBON UI (needed for 64bit)')
 457     opt.add_option('--boost-sp-debug', action='store_true', default=False, dest='boost_sp_debug',
 458                     help='Compile with Boost shared pointer debugging')
 459     opt.add_option('--debug-symbols', action='store_true', default=False, dest='debug_symbols',
 460                     help='Add debug-symbols to optimized builds')
 461     opt.add_option('--depstack-root', type='string', default='~', dest='depstack_root',
 462                     help='Directory/folder where dependency stack trees (gtk, a3) can be found (defaults to ~)')
 463     opt.add_option('--dist-target', type='string', default='auto', dest='dist_target',
 464                     help='Specify the target for cross-compiling [auto,none,x86,i386,i686,x86_64,tiger,leopard,mingw]')
 465     opt.add_option('--fpu-optimization', action='store_true', default=True, dest='fpu_optimization',
 466                     help='Build runtime checked assembler code (default)')
 467     opt.add_option('--no-fpu-optimization', action='store_false', dest='fpu_optimization')
 468     opt.add_option('--exports-hidden', action='store_true', default=False, dest='exports_hidden')
 469     opt.add_option('--freedesktop', action='store_true', default=False, dest='freedesktop',
 470                     help='Install MIME type, icons and .desktop file as per freedesktop.org standards')
 471     opt.add_option('--freebie', action='store_true', default=False, dest='freebie',
 472                     help='Build a version suitable for distribution as a zero-cost binary')
 473     opt.add_option('--gprofile', action='store_true', default=False, dest='gprofile',
 474                     help='Compile for use with gprofile')
 475     opt.add_option('--libjack', type='string', default="auto", dest='libjack_link',
 476                     help='libjack link mode  [auto|link|weak]')
 477     opt.add_option('--internal-shared-libs', action='store_true', default=True, dest='internal_shared_libs',
 478                    help='Build internal libs as shared libraries')
 479     opt.add_option('--internal-static-libs', action='store_false', dest='internal_shared_libs',
 480                    help='Build internal libs as static libraries')
 481     opt.add_option('--use-external-libs', action='store_true', default=False, dest='use_external_libs',
 482                    help='Use external/system versions of some bundled libraries')
 483     opt.add_option('--lv2', action='store_true', default=True, dest='lv2',
 484                     help='Compile with support for LV2 (if Lilv+Suil is available)')
 485     opt.add_option('--no-lv2', action='store_false', dest='lv2',
 486                     help='Do not compile with support for LV2')
 487     opt.add_option('--lv2dir', type='string', help="install destination for builtin LV2 bundles [Default: LIBDIR/lv2]")
 488     opt.add_option('--lxvst', action='store_true', default=True, dest='lxvst',
 489                     help='Compile with support for linuxVST plugins')
 490     opt.add_option('--no-lxvst', action='store_false', dest='lxvst',
 491                     help='Compile without support for linuxVST plugins')
 492     opt.add_option('--nls', action='store_true', default=True, dest='nls',
 493                     help='Enable i18n (native language support) (default)')
 494     opt.add_option('--no-nls', action='store_false', dest='nls')
 495     opt.add_option('--phone-home', action='store_true', default=True, dest='phone_home',
 496                    help='Contact ardour.org at startup for new announcements')
 497     opt.add_option('--no-phone-home', action='store_false', dest='phone_home',
 498                    help='Do not contact ardour.org at startup for new announcements')
 499     opt.add_option('--stl-debug', action='store_true', default=False, dest='stl_debug',
 500                     help='Build with debugging for the STL')
 501     opt.add_option('--rt-alloc-debug', action='store_true', default=False, dest='rt_alloc_debug',
 502                     help='Build with debugging for memory allocation in the real-time thread')
 503     opt.add_option('--pt-timing', action='store_true', default=False, dest='pt_timing',
 504                     help='Build with logging of timing in the process thread(s)')
 505     opt.add_option('--denormal-exception', action='store_true', default=False, dest='denormal_exception',
 506                     help='Raise a floating point exception if a denormal is detected')
 507     opt.add_option('--test', action='store_true', default=False, dest='build_tests',
 508                     help="Build unit tests")
 509     opt.add_option('--run-tests', action='store_true', default=False, dest='run_tests',
 510                     help="Run tests after build")
 511     opt.add_option('--single-tests', action='store_true', default=False, dest='single_tests',
 512                     help="Build a single executable for each unit test")
 513     #opt.add_option('--tranzport', action='store_true', default=False, dest='tranzport',
 514     # help='Compile with support for Frontier Designs Tranzport (if libusb is available)')
 515     opt.add_option('--generic', action='store_true', default=False, dest='generic',
 516                     help='Compile with -arch i386 (OS X ONLY)')
 517     opt.add_option('--ppc', action='store_true', default=False, dest='ppc',
 518                     help='Compile with -arch ppc (OS X ONLY)')
 519     opt.add_option('--versioned', action='store_true', default=False, dest='versioned',
 520                     help='Add revision information to executable name inside the build directory')
 521     opt.add_option('--windows-vst', action='store_true', default=False, dest='windows_vst',
 522                     help='Compile with support for Windows VST')
 523     opt.add_option('--windows-key', type='string', action='store', dest='windows_key', default='Mod4><Super',
 524                     help='X Modifier(s) (Mod1,Mod2, etc) for the Windows key (X11 builds only). ' +
 525                     'Multiple modifiers must be separated by \'><\'')
 526     opt.add_option('--boost-include', type='string', action='store', dest='boost_include', default='',
 527                     help='directory where Boost header files can be found')
 528     opt.add_option('--also-include', type='string', action='store', dest='also_include', default='',
 529                     help='additional include directory where header files can be found (split multiples with commas)')
 530     opt.add_option('--also-libdir', type='string', action='store', dest='also_libdir', default='',
 531                     help='additional include directory where shared libraries can be found (split multiples with commas)')
 532     opt.add_option('--wine-include', type='string', action='store', dest='wine_include', default='/usr/include/wine/windows',
 533                     help='directory where Wine\'s Windows header files can be found')
 534     opt.add_option('--noconfirm', action='store_true', default=False, dest='noconfirm',
 535                     help='Do not ask questions that require confirmation during the build')
 536     opt.add_option('--cxx11', action='store_true', default=False, dest='cxx11',
 537                     help='Turn on c++11 compiler flags (-std=c++11)')
 538     opt.add_option('--address-sanitizer', action='store_true', default=False, dest='asan',
 539                     help='Turn on AddressSanitizer (requires GCC >= 4.8 or clang >= 3.1)')
 540     for i in children:
 541         opt.recurse(i)
 542
 543 def sub_config_and_use(conf, name, has_objects = True):
 544     conf.recurse(name)
 545     autowaf.set_local_lib(conf, name, has_objects)
 546
 547 def configure(conf):
 548     conf.load('compiler_c')
 549     conf.load('compiler_cxx')
 550     if Options.options.dist_target == 'mingw':
 551         conf.load('winres')
 552
 553     conf.env['VERSION'] = VERSION
 554     conf.env['MAJOR'] = MAJOR
 555     conf.env['MINOR'] = MINOR
 556     conf.line_just = 52
 557     autowaf.set_recursive()
 558     autowaf.configure(conf)
 559     autowaf.display_header('Ardour Configuration')
 560
 561     gcc_versions = fetch_gcc_version(str(conf.env['CC']))
 562     if not Options.options.debug and gcc_versions[0] == '4' and gcc_versions[1] > '4':
 563         print('Version 4.5 of gcc is not ready for use when compiling Ardour with optimization.')
 564         print('Please use a different version or re-configure with --debug')
 565         exit (1)
 566
 567     # systems with glibc have libintl builtin. systems without require explicit
 568     # linkage against libintl.
 569     #
 570
 571     pkg_config_path = os.getenv('PKG_CONFIG_PATH')
 572     user_gtk_root = os.path.expanduser (Options.options.depstack_root + '/gtk/inst')
 573
 574     if pkg_config_path is not None and pkg_config_path.find (user_gtk_root) >= 0:
 575         # told to search user_gtk_root
 576         prefinclude = ''.join ([ '-I', user_gtk_root + '/include'])
 577         preflib = ''.join ([ '-L', user_gtk_root + '/lib'])
 578         conf.env.append_value('CFLAGS', [ prefinclude ])
 579         conf.env.append_value('CXXFLAGS',  [prefinclude ])
 580         conf.env.append_value('LINKFLAGS', [ preflib ])
 581         autowaf.display_msg(conf, 'Will build against private GTK dependency stack in ' + user_gtk_root, 'yes')
 582     else:
 583         autowaf.display_msg(conf, 'Will build against private GTK dependency stack', 'no')
 584
 585     if sys.platform == 'darwin':
 586         conf.define ('NEED_INTL', 1)
 587         autowaf.display_msg(conf, 'Will use explicit linkage against libintl in ' + user_gtk_root, 'yes')
 588     else:
 589         # libintl is part of the system, so use it
 590         autowaf.display_msg(conf, 'Will rely on libintl built into libc', 'yes')
 591
 592     user_ardour_root = os.path.expanduser (Options.options.depstack_root + '/a3/inst')
 593     if pkg_config_path is not None and pkg_config_path.find (user_ardour_root) >= 0:
 594         # told to search user_ardour_root
 595         prefinclude = ''.join ([ '-I', user_ardour_root + '/include'])
 596         preflib = ''.join ([ '-L', user_ardour_root + '/lib'])
 597         conf.env.append_value('CFLAGS', [ prefinclude ])
 598         conf.env.append_value('CXXFLAGS',  [prefinclude ])
 599         conf.env.append_value('LINKFLAGS', [ preflib ])
 600         autowaf.display_msg(conf, 'Will build against private Ardour dependency stack in ' + user_ardour_root, 'yes')
 601     else:
 602         autowaf.display_msg(conf, 'Will build against private Ardour dependency stack', 'no')
 603
 604     if Options.options.freebie:
 605         conf.env.append_value ('CFLAGS', '-DNO_PLUGIN_STATE')
 606         conf.env.append_value ('CXXFLAGS', '-DNO_PLUGIN_STATE')
 607         conf.define ('NO_PLUGIN_STATE', 1)
 608
 609     if Options.options.trx_build:
 610         conf.define ('TRX_BUILD', 1)
 611
 612     if Options.options.lv2dir:
 613         conf.env['LV2DIR'] = Options.options.lv2dir
 614     else:
 615         conf.env['LV2DIR'] = os.path.join(conf.env['LIBDIR'], 'lv2')
 616
 617     conf.env['LV2DIR'] = os.path.normpath(conf.env['LV2DIR'])
 618
 619     if sys.platform == 'darwin':
 620
 621         # this is required, potentially, for anything we link and then relocate into a bundle
 622         conf.env.append_value('LINKFLAGS', [ '-Xlinker', '-headerpad_max_install_names' ])
 623
 624         conf.define ('HAVE_COREAUDIO', 1)
 625         conf.define ('AUDIOUNIT_SUPPORT', 1)
 626
 627         conf.define ('GTKOSX', 1)
 628         conf.define ('TOP_MENUBAR',1)
 629         conf.define ('GTKOSX',1)
 630
 631         # It would be nice to be able to use this to force back-compatibility with 10.4
 632         # but even by the time of 11, the 10.4 SDK is no longer available in any normal
 633         # way.
 634         #
 635         #conf.env.append_value('CXXFLAGS_OSX', "-isysroot /Developer/SDKs/MacOSX10.4u.sdk")
 636         #conf.env.append_value('CFLAGS_OSX', "-isysroot /Developer/SDKs/MacOSX10.4u.sdk")
 637         #conf.env.append_value('LINKFLAGS_OSX', "-sysroot /Developer/SDKs/MacOSX10.4u.sdk")
 638         #conf.env.append_value('LINKFLAGS_OSX', "-sysroot /Developer/SDKs/MacOSX10.4u.sdk")
 639
 640         conf.env.append_value('CXXFLAGS_OSX', "-msse")
 641         conf.env.append_value('CFLAGS_OSX', "-msse")
 642         conf.env.append_value('CXXFLAGS_OSX', "-msse2")
 643         conf.env.append_value('CFLAGS_OSX', "-msse2")
 644         #
 645         #       TODO: The previous sse flags NEED to be based
 646         #       off processor type.  Need to add in a check
 647         #       for that.
 648         #
 649         conf.env.append_value('CXXFLAGS_OSX', '-F/System/Library/Frameworks')
 650         conf.env.append_value('CXXFLAGS_OSX', '-F/Library/Frameworks')
 651
 652         conf.env.append_value('LINKFLAGS_OSX', ['-framework', 'AppKit'])
 653         conf.env.append_value('LINKFLAGS_OSX', ['-framework', 'CoreAudio'])
 654         conf.env.append_value('LINKFLAGS_OSX', ['-framework', 'CoreAudioKit'])
 655         conf.env.append_value('LINKFLAGS_OSX', ['-framework', 'CoreFoundation'])
 656         conf.env.append_value('LINKFLAGS_OSX', ['-framework', 'CoreServices'])
 657
 658         conf.env.append_value('LINKFLAGS_OSX', ['-undefined', 'dynamic_lookup' ])
 659         conf.env.append_value('LINKFLAGS_OSX', ['-flat_namespace'])
 660
 661         conf.env.append_value('CXXFLAGS_AUDIOUNITS', "-DAUDIOUNIT_SUPPORT")
 662         conf.env.append_value('LINKFLAGS_AUDIOUNITS', ['-framework', 'AudioToolbox', '-framework', 'AudioUnit'])
 663         conf.env.append_value('LINKFLAGS_AUDIOUNITS', ['-framework', 'Cocoa'])
 664
 665         if re.search ("^[1-9][0-9]\.", os.uname()[2]) == None and not Options.options.nocarbon:
 666             conf.env.append_value('CXXFLAGS_AUDIOUNITS', "-DWITH_CARBON")
 667             conf.env.append_value('LINKFLAGS_AUDIOUNITS', ['-framework', 'Carbon'])
 668         else:
 669             print ('No Carbon support available for this build\n')
 670
 671
 672     if Options.options.internal_shared_libs:
 673         conf.define('INTERNAL_SHARED_LIBS', 1)
 674
 675     if Options.options.use_external_libs:
 676         conf.define('USE_EXTERNAL_LIBS', 1)
 677
 678     if Options.options.boost_include != '':
 679         conf.env.append_value('CXXFLAGS', '-I' + Options.options.boost_include)
 680
 681     if Options.options.also_include != '':
 682         conf.env.append_value('CXXFLAGS', '-I' + Options.options.also_include)
 683         conf.env.append_value('CFLAGS', '-I' + Options.options.also_include)
 684
 685     if Options.options.also_libdir != '':
 686         conf.env.append_value('LDFLAGS', '-L' + Options.options.also_libdir)
 687
 688     if Options.options.boost_sp_debug:
 689         conf.env.append_value('CXXFLAGS', '-DBOOST_SP_ENABLE_DEBUG_HOOKS')
 690
 691     # executing a test program is n/a when cross-compiling
 692     if Options.options.dist_target != 'mingw':
 693         conf.check_cc(function_name='dlopen', header_name='dlfcn.h', lib='dl', uselib_store='DL')
 694         conf.check_cxx(fragment = "#include <boost/version.hpp>\nint main(void) { return (BOOST_VERSION >= 103900 ? 0 : 1); }\n",
 695                   execute = "1",
 696                   mandatory = True,
 697                   msg = 'Checking for boost library >= 1.39',
 698                   okmsg = 'ok',
 699                   errmsg = 'too old\nPlease install boost version 1.39 or higher.')
 700
 701     if re.search ("linux", sys.platform) != None and Options.options.dist_target != 'mingw':
 702         autowaf.check_pkg(conf, 'alsa', uselib_store='ALSA')
 703
 704     autowaf.check_pkg(conf, 'glib-2.0', uselib_store='GLIB', atleast_version='2.2', mandatory=True)
 705     autowaf.check_pkg(conf, 'gthread-2.0', uselib_store='GTHREAD', atleast_version='2.2', mandatory=True)
 706     autowaf.check_pkg(conf, 'glibmm-2.4', uselib_store='GLIBMM', atleast_version='2.32.0', mandatory=True)
 707     autowaf.check_pkg(conf, 'sndfile', uselib_store='SNDFILE', atleast_version='1.0.18, mandatory=True')
 708     autowaf.check_pkg(conf, 'giomm-2.4', uselib_store='GIOMM', atleast_version='2.2', mandatory=True)
 709     autowaf.check_pkg(conf, 'libcurl', uselib_store='CURL', atleast_version='7.0.0', mandatory=True)
 710     autowaf.check_pkg(conf, 'liblo', uselib_store='LO', atleast_version='0.26', mandatory=True)
 711     autowaf.check_pkg(conf, 'taglib', uselib_store='TAGLIB', atleast_version='1.6', mandatory=True)
 712     autowaf.check_pkg(conf, 'vamp-sdk', uselib_store='VAMPSDK', atleast_version='2.1', mandatory=True)
 713     autowaf.check_pkg(conf, 'vamp-hostsdk', uselib_store='VAMPHOSTSDK', atleast_version='2.1', mandatory=True)
 714     autowaf.check_pkg(conf, 'rubberband', uselib_store='RUBBERBAND', mandatory=True)
 715
 716     if Options.options.dist_target == 'mingw':
 717         Options.options.fpu_optimization = False
 718         conf.env.append_value('CFLAGS', '-DPLATFORM_WINDOWS')
 719         conf.env.append_value('CFLAGS', '-DCOMPILER_MINGW')
 720         conf.env.append_value('CXXFLAGS', '-DPLATFORM_WINDOWS')
 721         conf.env.append_value('CXXFLAGS', '-DCOMPILER_MINGW')
 722         conf.env.append_value('LIB', 'pthread')
 723         # needed for at least libsmf
 724         conf.check_cc(function_name='htonl', header_name='winsock2.h', lib='ws2_32')
 725         conf.env.append_value('LIB', 'ws2_32')
 726         # needed for mingw64 packages, not harmful on normal mingw build
 727         conf.env.append_value('LIB', 'intl')
 728         conf.check_cc(function_name='regcomp', header_name='regex.h',
 729                       lib='regex', uselib_store="REGEX", define_name='HAVE_REGEX_H')
 730         # TODO put this only where it is needed
 731         conf.env.append_value('LIB', 'regex')
 732
 733         # work around GdkDrawable BitBlt performance issue on windows
 734         # see http://gareus.org/wiki/ardour_windows_gdk_and_cairo
 735         conf.env.append_value('CFLAGS', '-DUSE_CAIRO_IMAGE_SURFACE')
 736         conf.env.append_value('CXXFLAGS', '-DUSE_CAIRO_IMAGE_SURFACE')
 737
 738     # Tell everyone that this is a waf build
 739
 740     conf.env.append_value('CFLAGS', '-DWAF_BUILD')
 741     conf.env.append_value('CXXFLAGS', '-DWAF_BUILD')
 742
 743     opts = Options.options
 744
 745     # (optionally) Adopt Microsoft-like convention that makes all non-explicitly exported
 746     # symbols invisible (rather than doing this all over the wscripts in the src tree)
 747     #
 748     # This won't apply to MSVC but that hasn't been added as a target yet
 749     #
 750     # We can't do this till all tests are complete, since some fail if this is et.
 751     if opts.exports_hidden:
 752         conf.define ('EXPORT_VISIBILITY_HIDDEN', True)
 753         if opts.internal_shared_libs:
 754             conf.env.append_value ('CXXFLAGS', '-fvisibility=hidden')
 755             conf.env.append_value ('CFLAGS', '-fvisibility=hidden')
 756     else:
 757         conf.define ('EXPORT_VISIBILITY_HIDDEN', False)
 758
 759     # Set up waf environment and C defines
 760     if opts.phone_home:
 761         conf.define('PHONE_HOME', 1)
 762         conf.env['PHONE_HOME'] = True
 763     if opts.fpu_optimization:
 764         conf.env['FPU_OPTIMIZATION'] = True
 765     if opts.nls:
 766         conf.define('ENABLE_NLS', 1)
 767         conf.env['ENABLE_NLS'] = True
 768     if opts.build_tests:
 769         conf.env['BUILD_TESTS'] = True
 770         conf.env['RUN_TESTS'] = opts.run_tests
 771     if opts.single_tests:
 772         conf.env['SINGLE_TESTS'] = opts.single_tests
 773     #if opts.tranzport:
 774     #    conf.env['TRANZPORT'] = 1
 775     if opts.windows_vst:
 776         conf.define('WINDOWS_VST_SUPPORT', 1)
 777         conf.env['WINDOWS_VST_SUPPORT'] = True
 778         if not Options.options.dist_target == 'mingw':
 779             conf.env.append_value('CFLAGS', '-I' + Options.options.wine_include)
 780             conf.env.append_value('CXXFLAGS', '-I' + Options.options.wine_include)
 781             autowaf.check_header(conf, 'cxx', 'windows.h', mandatory = True)
 782     if opts.lxvst:
 783         if sys.platform == 'darwin':
 784             conf.env['LXVST_SUPPORT'] = False
 785         elif Options.options.dist_target == 'mingw':
 786             conf.env['LXVST_SUPPORT'] = False
 787         else:
 788             conf.define('LXVST_SUPPORT', 1)
 789             conf.env['LXVST_SUPPORT'] = True
 790     conf.env['WINDOWS_KEY'] = opts.windows_key
 791     if opts.rt_alloc_debug:
 792         conf.define('DEBUG_RT_ALLOC', 1)
 793         conf.env['DEBUG_RT_ALLOC'] = True
 794     if opts.pt_timing:
 795         conf.define('PT_TIMING', 1)
 796         conf.env['PT_TIMING'] = True
 797     if opts.denormal_exception:
 798         conf.define('DEBUG_DENORMAL_EXCEPTION', 1)
 799         conf.env['DEBUG_DENORMAL_EXCEPTION'] = True
 800     if opts.build_tests:
 801         autowaf.check_pkg(conf, 'cppunit', uselib_store='CPPUNIT', atleast_version='1.12.0', mandatory=True)
 802
 803     backends = opts.with_backends.split(',')
 804     if not backends:
 805         print("Must configure and build at least one backend")
 806         sys.exit(1)
 807
 808     conf.env['BACKENDS'] = backends
 809     conf.env['BUILD_JACKBACKEND'] = any('jack' in b for b in backends)
 810     conf.env['BUILD_ALSABACKEND'] = any('alsa' in b for b in backends)
 811     conf.env['BUILD_DUMMYBACKEND'] = any('dummy' in b for b in backends)
 812     conf.env['BUILD_WAVESBACKEND'] = any('wavesaudio' in b for b in backends)
 813
 814     set_compiler_flags (conf, Options.options)
 815
 816     if sys.platform == 'darwin':
 817         sub_config_and_use(conf, 'libs/appleutility')
 818     elif Options.options.dist_target != 'mingw':
 819         sub_config_and_use(conf, 'tools/sanity_check')
 820
 821     sub_config_and_use(conf, 'libs/clearlooks-newer')
 822
 823     for i in children:
 824         sub_config_and_use(conf, i)
 825
 826     # Fix utterly braindead FLAC include path to not smash assert.h
 827     conf.env['INCLUDES_FLAC'] = []
 828
 829     config_text = open('libs/ardour/config_text.cc', "w")
 830     config_text.write('''#include "ardour/ardour.h"
 831 namespace ARDOUR {
 832 const char* const ardour_config_info = "\\n\\
 833 ''')
 834
 835     def write_config_text(title, val):
 836         autowaf.display_msg(conf, title, val)
 837         config_text.write(title + ': ')
 838         config_text.write(str(val).replace ('"', '\\"'))
 839         config_text.write("\\n\\\n")
 840
 841     write_config_text('Build documentation',   conf.env['DOCS'])
 842     write_config_text('Debuggable build',      conf.env['DEBUG'])
 843     write_config_text('Export all symbols (backtrace)', opts.backtrace)
 844     write_config_text('Install prefix',        conf.env['PREFIX'])
 845     write_config_text('Strict compiler flags', conf.env['STRICT'])
 846     write_config_text('Internal Shared Libraries', conf.is_defined('INTERNAL_SHARED_LIBS'))
 847     write_config_text('Use External Libraries', conf.is_defined('USE_EXTERNAL_LIBS'))
 848     write_config_text('Library exports hidden', conf.is_defined('EXPORT_VISIBILITY_HIDDEN'))
 849
 850     write_config_text('ALSA Backend',          conf.env['BUILD_ALSABACKEND'])
 851     write_config_text('ALSA DBus Reservation', conf.is_defined('HAVE_DBUS'))
 852     write_config_text('Architecture flags',    opts.arch)
 853     write_config_text('Aubio',                 conf.is_defined('HAVE_AUBIO'))
 854     write_config_text('AudioUnits',            conf.is_defined('AUDIOUNIT_SUPPORT'))
 855     write_config_text('No plugin state',       conf.is_defined('NO_PLUGIN_STATE'))
 856     write_config_text('Build target',          conf.env['build_target'])
 857     write_config_text('CoreAudio',             conf.is_defined('HAVE_COREAUDIO'))
 858     write_config_text('Debug RT allocations',  conf.is_defined('DEBUG_RT_ALLOC'))
 859     write_config_text('Debug Symbols',         conf.is_defined('debug_symbols') or conf.env['DEBUG'])
 860     write_config_text('Dummy backend',         conf.env['BUILD_DUMMYBACKEND'])
 861     write_config_text('Process thread timing', conf.is_defined('PT_TIMING'))
 862     write_config_text('Denormal exceptions',   conf.is_defined('DEBUG_DENORMAL_EXCEPTION'))
 863     write_config_text('FLAC',                  conf.is_defined('HAVE_FLAC'))
 864     write_config_text('FPU optimization',      opts.fpu_optimization)
 865     write_config_text('Freedesktop files',     opts.freedesktop)
 866     write_config_text('JACK Backend',          conf.env['BUILD_JACKBACKEND'])
 867     write_config_text('Libjack linking',       conf.env['libjack_link'])
 868     write_config_text('LV2 UI embedding',      conf.is_defined('HAVE_SUIL'))
 869     write_config_text('LV2 support',           conf.is_defined('LV2_SUPPORT'))
 870     write_config_text('LXVST support',         conf.is_defined('LXVST_SUPPORT'))
 871     write_config_text('OGG',                   conf.is_defined('HAVE_OGG'))
 872     write_config_text('Phone home',            conf.is_defined('PHONE_HOME'))
 873     write_config_text('Program name',          opts.program_name)
 874     write_config_text('Samplerate',            conf.is_defined('HAVE_SAMPLERATE'))
 875 #    write_config_text('Soundtouch',            conf.is_defined('HAVE_SOUNDTOUCH'))
 876     write_config_text('Translation',           opts.nls)
 877 #    write_config_text('Tranzport',             opts.tranzport)
 878     write_config_text('Unit tests',            conf.env['BUILD_TESTS'])
 879     write_config_text('Mac i386 Architecture', opts.generic)
 880     write_config_text('Mac ppc Architecture',  opts.ppc)
 881     write_config_text('Waves Backend',         conf.env['BUILD_WAVESBACKEND'])
 882     write_config_text('Windows VST support',   opts.windows_vst)
 883     write_config_text('Wiimote support',       conf.is_defined('BUILD_WIIMOTE'))
 884     write_config_text('Windows key',           opts.windows_key)
 885
 886     write_config_text('C compiler flags',      conf.env['CFLAGS'])
 887     write_config_text('C++ compiler flags',    conf.env['CXXFLAGS'])
 888     write_config_text('Linker flags',          conf.env['LINKFLAGS'])
 889
 890     config_text.write ('";\n}\n')
 891     config_text.close ()
 892     print('')
 893
 894 def build(bld):
 895     create_stored_revision()
 896
 897     # add directories that contain only headers, to workaround an issue with waf
 898
 899     if not bld.is_defined('USE_EXTERNAL_LIBS'):
 900         bld.path.find_dir ('libs/libltc/ltc')
 901     bld.path.find_dir ('libs/evoral/evoral')
 902     bld.path.find_dir ('libs/surfaces/control_protocol/control_protocol')
 903     bld.path.find_dir ('libs/timecode/timecode')
 904     bld.path.find_dir ('libs/gtkmm2ext/gtkmm2ext')
 905     bld.path.find_dir ('libs/ardour/ardour')
 906     bld.path.find_dir ('libs/pbd/pbd')
 907
 908     # set up target directories
 909     lwrcase_dirname = 'ardour3'
 910
 911     if bld.is_defined ('TRX_BUILD'):
 912         lwrcase_dirname = 'trx'
 913
 914     # configuration files go here
 915     bld.env['CONFDIR'] = os.path.join(bld.env['SYSCONFDIR'], lwrcase_dirname)
 916     # data files loaded at run time go here
 917     bld.env['DATADIR'] = os.path.join(bld.env['DATADIR'], lwrcase_dirname)
 918     # shared objects loaded at runtime go here (two aliases)
 919     bld.env['DLLDIR'] = os.path.join(bld.env['LIBDIR'], lwrcase_dirname)
 920     bld.env['LIBDIR'] = bld.env['DLLDIR']
 921
 922     autowaf.set_recursive()
 923
 924     if sys.platform == 'darwin':
 925         bld.recurse('libs/appleutility')
 926     elif bld.env['build_target'] != 'mingw':
 927         bld.recurse('tools/sanity_check')
 928
 929     bld.recurse('libs/clearlooks-newer')
 930
 931     for i in children:
 932         bld.recurse(i)
 933
 934     bld.install_files (bld.env['CONFDIR'], 'system_config')
 935
 936     if bld.env['RUN_TESTS']:
 937         bld.add_post_fun(test)
 938
 939 def i18n(bld):
 940     bld.recurse (i18n_children)
 941
 942 def i18n_pot(bld):
 943     bld.recurse (i18n_children)
 944
 945 def i18n_po(bld):
 946     bld.recurse (i18n_children)
 947
 948 def i18n_mo(bld):
 949     bld.recurse (i18n_children)
 950
 951 def tarball(bld):
 952     create_stored_revision()
 953
 954 def test(bld):
 955     subprocess.call("gtk2_ardour/artest")