ardour/wscript

#!/usr/bin/env python
from waflib.extras import autowaf as autowaf
from waflib import Options
import os
import re
import string
import subprocess
import sys
import platform as PLATFORM
from waflib.Tools import winres
from waflib.Build import Context
from waflib.Build import BuildContext

class i18n(BuildContext):
        cmd = 'i18n'
        fun = 'i18n'

class i18n_pot(BuildContext):
        cmd = 'i18n_pot'
        fun = 'i18n_pot'

class i18n_po(BuildContext):
        cmd = 'i18n_po'
        fun = 'i18n_po'

class i18n_mo(BuildContext):
        cmd = 'i18n_mo'
        fun = 'i18n_mo'

def is_tracks_build(self, *k, **kw):
        return self.env['PROGRAM_NAME'] == 'Tracks Live'

Context.Context.is_tracks_build = is_tracks_build

compiler_flags_dictionaries= {
    'gcc' : {
        # Flags required when building a debug build
        'debuggable' : [ '-g' ],
        # Flags required for the linker (if any) when building a debug build
        'linker-debuggable' : '',
        # Flags required when building a non-debug optimized build
        'nondebuggable' : '-DNDEBUG',
        # Flags required to enable profiling at runtime with optimized builds
        'profile' : [ '-fno-omit-frame-pointer' ],
        # Flags required to enable gprofile profiling
        'gprofile' : '-pg',
        # Flags required to disable warnings about unused arguments to function calls
        'silence-unused-arguments' : '',
        # Flags required to use SSE unit for general math
        'sse' : '-msse',
        # Flags required to use SSE unit for floating point math
        'fpmath-sse' : '-mfpmath=sse',
        # Flags required to use XMM Intrinsics
        'xmmintrinsics' : '-DUSE_XMMINTRIN',
        # Flags to use posix pipes between compiler stages
        'pipe' : '-pipe',
        # Flags for maximally optimized build
        'full-optimization' : [ '-O3', '-fomit-frame-pointer', '-ffast-math', '-fstrength-reduce', ],
        # Flag to ensure that compiler error output includes column/line numbers
        'show-column' : '-fshow-column',
        # Flags required to build for x86 only (OS X feature)
        'generic-x86' : '',
        # Flags required to build for PowerPC only (OS X feature)
        'generic-ppc' : '',
        # All flags required to get basic warnings to be generated by the compiler
        'basic-warnings' : [ '-Wall', '-Wpointer-arith', '-Wcast-qual', '-Wcast-align', '-Wno-unused-parameter' ],
        # Any additional flags for warnings that are specific to C (not C++)
        'extra-c-warnings' : [ '-Wstrict-prototypes', '-Wmissing-prototypes' ],
        # Any additional flags for warnings that are specific to C++ (not C)
        'extra-cxx-warnings' : [ '-Woverloaded-virtual', '-Wno-unused-local-typedefs' ],
        # Flags used for "strict" compilation, C and C++ (i.e. compiler will warn about language issues)
        'strict' : ['-Wall', '-Wcast-align', '-Wextra', '-Wwrite-strings', '-Wunsafe-loop-optimizations', '-Wlogical-op' ],
        # Flags used for "strict" compilation, C only (i.e. compiler will warn about language issues)
        'c-strict' : ['-std=c99', '-pedantic', '-Wshadow'],
        # Flags used for "strict" compilation, C++ only (i.e. compiler will warn about language issues)
        'cxx-strict' : [ '-ansi', '-Wnon-virtual-dtor', '-Woverloaded-virtual', '-fstrict-overflow' ],
        # Flags required for whatever consider the strictest possible compilation
        'ultra-strict' : ['-Wredundant-decls', '-Wstrict-prototypes', '-Wmissing-prototypes'],
        # Flag to turn on C99 compliance by itself
        'c99': '-std=c99',
        # Flag to enable AT&T assembler syntax
        'attasm': '-masm=att',
        # Flags to make AVX instructions/intrinsics available
        'avx': '-mavx',
        # Flags to generate position independent code, when needed to build a shared object
        'pic': '-fPIC',
        # Flags required to compile C code with anonymous unions (only part of C11)
        'c-anonymous-union': '-fms-extensions',
    },
    'msvc' : {
        'debuggable' : ['/DDEBUG', '/Od', '/Zi', '/MDd', '/Gd', '/EHsc'],
        'linker-debuggable' : ['/DEBUG', '/INCREMENTAL' ],
        'nondebuggable' : ['/DNDEBUG', '/Ob1', '/MD', '/Gd', '/EHsc'],
        'profile' : '/Oy-',
        'sse' : '/arch:SSE',
        'silence-unused-arguments' : '',
        'sse' : '',
        'fpmath-sse' : '',
        'xmmintrinsics' : '',
        'pipe' : '',
        'full-optimization' : '/O2',
        'no-frame-pointer' : '',
        'fast-math' : '',
        'strength-reduce' : '',
        'show-column' : '',
        'generic-x86' : '',
        'generic-ppc' : '',
        'basic-warnings' : '',
        'extra-c-warnings' : '',
        'extra-cxx-warnings' : '',
        'ultra-strict' : '',
        'c-strict' : '',
        'cxx-strict' : '',
        'strict' : '',
        'c99': '/TP',
        'attasm': '',
        'avx': '',
        'pic': '',
        'c-anonymous-union': '',
    },
}

# Copy, edit and insert variants on gcc dict for gcc-darwin and clang

gcc_darwin_dict = compiler_flags_dictionaries['gcc'].copy()
gcc_darwin_dict['extra-cxx-warnings'] = [ '-Woverloaded-virtual' ]
gcc_darwin_dict['cxx-strict'] = [ '-ansi', '-Wnon-virtual-dtor', '-Woverloaded-virtual' ]
gcc_darwin_dict['strict'] = ['-Wall', '-Wcast-align', '-Wextra', '-Wwrite-strings' ]
gcc_darwin_dict['generic-x86'] = [ '-arch', 'i386' ]
gcc_darwin_dict['generic-ppc'] = [ '-arch', 'ppc' ]
compiler_flags_dictionaries['gcc-darwin'] = gcc_darwin_dict;

clang_dict = compiler_flags_dictionaries['gcc'].copy();
clang_dict['sse'] = ''
clang_dict['fpmath-sse'] = ''
clang_dict['xmmintrinsics'] = ''
clang_dict['silence-unused-arguments'] = '-Qunused-arguments'
clang_dict['extra-cxx-warnings'] = [ '-Woverloaded-virtual', '-Wno-mismatched-tags', '-Wno-cast-align', '-Wno-unused-local-typedefs' ]
clang_dict['cxx-strict'] = [ '-ansi', '-Wnon-virtual-dtor', '-Woverloaded-virtual', '-fstrict-overflow' ]
clang_dict['strict'] = ['-Wall', '-Wcast-align', '-Wextra', '-Wwrite-strings' ]
clang_dict['generic-x86'] = [ '-arch', 'i386' ]
clang_dict['full-optimization'] = [ '-O3', '-fomit-frame-pointer', '-ffast-math', ]
compiler_flags_dictionaries['clang'] = clang_dict;

clang_darwin_dict = compiler_flags_dictionaries['clang'].copy();
clang_darwin_dict['cxx-strict'] = [ '-ansi', '-Wnon-virtual-dtor', '-Woverloaded-virtual', ]
clang_darwin_dict['full-optimization'] = [ '-O3', '-ffast-math']
compiler_flags_dictionaries['clang-darwin'] = clang_darwin_dict;

def fetch_git_revision ():
    cmd = "git describe HEAD | sed 's/^[A-Za-z0-9]*+//'"
    output = subprocess.Popen(cmd, shell=True, stderr=subprocess.STDOUT, stdout=subprocess.PIPE).communicate()[0].splitlines()
    rev = output[0].decode ('utf-8')
    return rev

def fetch_tarball_revision ():
    if not os.path.exists ('libs/ardour/revision.cc'):
        print ('This tarball was not created correctly - it is missing libs/ardour/revision.cc')
        sys.exit (1)
    with open('libs/ardour/revision.cc', 'rb') as f:
        content = f.readlines()
        remove_punctuation_map = dict((ord(char), None) for char in '";')
        return content[1].decode('utf-8').strip().split(' ')[7].translate (remove_punctuation_map)

if os.path.isdir (os.path.join(os.getcwd(), '.git')):
    rev = fetch_git_revision ()
else:
    rev = fetch_tarball_revision ()

#
# rev is now of the form MAJOR.MINOR[-rcX]-rev-commit
# or, if right at the same rev as a release, MAJOR.MINOR[-rcX]
#

parts = rev.split ('.', 1)
MAJOR = parts[0]
other = parts[1].split('-', 1)
MINOR = other[0]
if len(other) > 1:
    MICRO = other[1].rsplit('-',1)[0].replace('-','.')
else:
    MICRO = '0'

V = MAJOR + '.' + MINOR + '.' + MICRO

def sanitize(s):
    # round-trip to remove anything in the string that is not encodable in
    # ASCII, yet still keep a real (utf8-encoded internally) string.
    s = s.encode ('ascii', 'ignore').decode ("utf-8")
    # In Python3, bytes is the class of binary content and encode() returns
    # bytes to transform a string according to a text encoding; str is the
    # class of normal strings (utf8-encoded internally) and decode() returns
    # that type.
    # Python 2 did not initially cater for encoding problems and can use str
    # for both binary content and for (decoded) strings. The Unicode type was
    # added to correspond to Python 3 str, and the Python 2 str type should
    # only correspond to bytes. Alas, almost everything in the Python 2
    # ecosystem has been written with str in mind and doesn't handle Unicode
    # objects correctly. If Python 2 is in use, s will be a Unicode object and
    # to avoid strange problems later we convert back to str, but in utf-8
    # nonetheless.
    if not isinstance(s, str):
        s = s.encode("utf-8")
    return s
VERSION = sanitize(V)
PROGRAM_VERSION = sanitize(MAJOR)
del sanitize

if len (sys.argv) > 1 and sys.argv[1] == 'dist':
        if not 'APPNAME' in os.environ:
                print ("You must define APPNAME in the environment when running ./waf dist")
                sys.exit (1)
        APPNAME = os.environ['APPNAME'];

# Mandatory variables
top = '.'
out = 'build'

children = [
        # optionally external libraries
        'libs/fluidsynth',
        'libs/hidapi',
        'libs/libltc',
        'libs/lua',
        'libs/ptformat',
        'libs/qm-dsp',
        'libs/vamp-plugins',
        'libs/zita-resampler',
        # core ardour libraries
        'libs/pbd',
        'libs/midi++2',
        'libs/evoral',
        'libs/surfaces',
        'libs/panners',
        'libs/backends',
        'libs/timecode',
        'libs/ardour',
        'libs/gtkmm2ext',
        'libs/audiographer',
        'libs/canvas',
        'libs/widgets',
        'libs/waveview',
        'libs/plugins/reasonablesynth.lv2',
        'libs/plugins/a-comp.lv2',
        'libs/plugins/a-delay.lv2',
        'libs/plugins/a-eq.lv2',
        'libs/plugins/a-reverb.lv2',
        'libs/plugins/a-fluidsynth.lv2',
        'gtk2_ardour',
        'export',
        'midi_maps',
        'mcp',
        'osc',
        'patchfiles',
        'scripts',
        'headless',
        'session_utils',
        # shared helper binaries (plugin-scanner, exec-wrapper)
        'libs/fst',
        'libs/vfork',
        'libs/ardouralsautil',
        'tools/luadevel',
]

i18n_children = [
        'gtk2_ardour',
        'libs/ardour',
        'libs/gtkmm2ext',
]

# Version stuff

def fetch_gcc_version (CC):
    cmd = "%s --version" % CC
    output = subprocess.Popen(cmd, shell=True, stderr=subprocess.STDOUT, stdout=subprocess.PIPE).communicate()[0].splitlines()
    o = output[0].decode('utf-8')
    version = o.split(' ')[2].split('.')
    return version

def create_stored_revision():
    rev = ""
    if os.path.exists('.git'):
        rev = fetch_git_revision();
        print("Git version: " + rev + "\n")
    elif os.path.exists('libs/ardour/revision.cc'):
        print("Using packaged revision")
        return
    else:
        print("Missing libs/ardour/revision.cc.  Blame the packager.")
        sys.exit(-1)

    try:
        #
        # if you change the format of this, be sure to fix fetch_tarball_revision() above
        # so that  it still works.
        #
        text =  '#include "ardour/revision.h"\n'
        text += 'namespace ARDOUR { const char* revision = \"%s\"; }\n' % rev
        print('Writing revision info to libs/ardour/revision.cc using ' + rev)
        o = open('libs/ardour/revision.cc', 'w')
        o.write(text)
        o.close()
    except IOError:
        print('Could not open libs/ardour/revision.cc for writing\n')
        sys.exit(-1)

def get_depstack_rev(depstack_root):
    try:
        with open(depstack_root + '/../.vers', 'r') as f:
            return f.readline()
    except IOError:
        return '-unknown-';

def set_compiler_flags (conf,opt):
    #
    # Compiler flags and other system-dependent stuff
    #
    build_host_supports_sse = False

    # Flags necessary for building
    compiler_flags = []     # generic
    c_flags = []            # C-specific
    cxx_flags = []          # C++-specific
    linker_flags = []

    # Optimization flags (overridable)
    optimization_flags = []

    # Debugging flags
    debug_flags = []

    u = PLATFORM.uname ()
    cpu = u[4]
    platform = u[0].lower()
    version = u[2]

    # waf adds -O0 -g itself. thanks waf!
    is_clang = conf.check_cxx(fragment = '''
#ifndef __clang__
#error
#endif
int main() { return 0; }''',
                         features  = 'cxx',
                         mandatory = False,
                         execute   = False,
                         msg       = 'Checking for clang')

    if is_clang:
        if platform == 'darwin':
            compiler_name = 'clang-darwin'
        else:
            compiler_name = 'clang'
    elif conf.env['MSVC_COMPILER']:
            compiler_name = 'msvc'
    else:
        if platform == 'darwin':
            compiler_name = 'gcc-darwin'
        else:
            compiler_name = 'gcc'

    flags_dict = compiler_flags_dictionaries[compiler_name]
    # Save the compiler flags because we need them at build time
    # when we need to add compiler specific flags in certain
    # libraries
    conf.env['compiler_flags_dict'] = flags_dict;

    autowaf.set_basic_compiler_flags (conf,flags_dict)

    if conf.options.asan:
        conf.check_cxx(cxxflags=["-fsanitize=address", "-fno-omit-frame-pointer"], linkflags=["-fsanitize=address"])
        cxx_flags.append('-fsanitize=address')
        cxx_flags.append('-fno-omit-frame-pointer')
        linker_flags.append('-fsanitize=address')

    if opt.gprofile:
        debug_flags = [ flags_dict['gprofile'] ]

    # OSX
    if platform == 'darwin':
        if re.search ("^13[.]", version) != None:
            conf.env['build_host'] = 'mavericks'
        elif re.search ("^14[.]", version) != None:
            conf.env['build_host'] = 'yosemite'
        elif re.search ("^15[.]", version) != None:
            conf.env['build_host'] = 'el_capitan'
        elif re.search ("^16[.]", version) != None:
            conf.env['build_host'] = 'sierra'
        else:
            conf.env['build_host'] = 'irrelevant'

    # Autodetect
    if opt.dist_target == 'auto':
        if platform == 'darwin':
            # The [.] matches to the dot after the major version, "." would match any character
            if re.search ("^[0-7][.]", version) != None:
                conf.env['build_target'] = 'panther'
            elif re.search ("^8[.]", version) != None:
                conf.env['build_target'] = 'tiger'
            elif re.search ("^9[.]", version) != None:
                conf.env['build_target'] = 'leopard'
            elif re.search ("^10[.]", version) != None:
                conf.env['build_target'] = 'snowleopard'
            elif re.search ("^11[.]", version) != None:
                conf.env['build_target'] = 'lion'
            elif re.search ("^12[.]", version) != None:
                conf.env['build_target'] = 'mountainlion'
            elif re.search ("^13[.]", version) != None:
                conf.env['build_target'] = 'mavericks'
            elif re.search ("^14[.]", version) != None:
                conf.env['build_target'] = 'yosemite'
            elif re.search ("^15[.]", version) != None:
                conf.env['build_target'] = 'el_capitan'
            else:
                conf.env['build_target'] = 'sierra'
        else:
            match = re.search(
                    "(?P<cpu>i[0-6]86|x86_64|powerpc|ppc|ppc64|arm|s390x?)",
                    cpu)
            if (match):
                conf.env['build_target'] = match.group("cpu")
                if re.search("i[0-5]86", conf.env['build_target']):
                    conf.env['build_target'] = "i386"
            else:
                conf.env['build_target'] = 'none'
    else:
        conf.env['build_target'] = opt.dist_target

    if conf.env['build_target'] == 'snowleopard':
        #
        # stupid OS X 10.6 has a bug in math.h that prevents llrint and friends
        # from being visible.
        #
        compiler_flags.append ('-U__STRICT_ANSI__')

    if opt.use_libcpp or conf.env['build_host'] in [ 'el_capitan', 'sierra' ]:
       cxx_flags.append('--stdlib=libc++')
       linker_flags.append('--stdlib=libc++')

    if conf.options.cxx11 or conf.env['build_host'] in [ 'mavericks', 'yosemite', 'el_capitan', 'sierra' ]:
        conf.check_cxx(cxxflags=["-std=c++11"])
        cxx_flags.append('-std=c++11')
        if platform == "darwin":
            # Mavericks and later changed the syntax to be used when including Carbon headers,
            # from requiring a full path to requiring just the header name.
            cxx_flags.append('-DCARBON_FLAT_HEADERS')

            if not opt.use_libcpp and not conf.env['build_host'] in [ 'el_capitan', 'sierra' ]:
                cxx_flags.append('--stdlib=libstdc++')
                linker_flags.append('--stdlib=libstdc++')
            # Prevents visibility issues in standard headers
            conf.define("_DARWIN_C_SOURCE", 1)
        else:
            cxx_flags.append('-DBOOST_NO_AUTO_PTR')


    if (is_clang and platform == "darwin") or conf.env['build_host'] in [ 'mavericks', 'yosemite', 'el_capitan', 'sierra' ]:
        # Silence warnings about the non-existing osx clang compiler flags
        # -compatibility_version and -current_version.  These are Waf
        # generated and not needed with clang
        c_flags.append("-Qunused-arguments")
        cxx_flags.append("-Qunused-arguments")

    if (re.search ("(i[0-9]86|x86_64|AMD64)", cpu) != None) and conf.env['build_target'] != 'none':

        #
        # ARCH_X86 means anything in the x86 family from i386 to x86_64
        # the compile-time presence of the macro _LP64 is used to
        # distingush 32 and 64 bit assembler
        #

        compiler_flags.append ("-DARCH_X86")

        if platform == 'linux' :

            #
            # determine processor flags via /proc/cpuinfo
            #

            if conf.env['build_target'] != 'i386':

                flag_line = os.popen ("cat /proc/cpuinfo | grep '^flags'").read()[:-1]
                x86_flags = flag_line.split (": ")[1:][0].split ()

                if "mmx" in x86_flags:
                    compiler_flags.append ("-mmmx")
                if "sse" in x86_flags:
                    build_host_supports_sse = True
                if "3dnow" in x86_flags:
                    compiler_flags.append ("-m3dnow")

            if cpu == "i586":
                compiler_flags.append ("-march=i586")
            elif cpu == "i686":
                compiler_flags.append ("-march=i686")

        if not is_clang and ((conf.env['build_target'] == 'i686') or (conf.env['build_target'] == 'x86_64')) and build_host_supports_sse:
            compiler_flags.extend ([ flags_dict['sse'], flags_dict['fpmath-sse'], flags_dict['xmmintrinsics'] ])

        if (conf.env['build_target'] == 'mingw'):
            if (re.search ("(x86_64|AMD64)", cpu) != None):
                # on Windows sse is supported by 64 bit platforms only
                build_host_supports_sse = True

                # mingw GCC compiler to uses at&t (Unix specific) assembler dialect by default
                # compiler_flags.append (["--mmnemonic=att", "msyntax=att")

                compiler_flags.extend ([ flags_dict['sse'], flags_dict['fpmath-sse'], flags_dict['xmmintrinsics'], flags_dict['attasm'] ])

    # end of processor-specific section

    # optimization section
    if conf.env['FPU_OPTIMIZATION']:
        if sys.platform == 'darwin':
            compiler_flags.append("-DBUILD_VECLIB_OPTIMIZATIONS");
            conf.env.append_value('LINKFLAGS_OSX', ['-framework', 'Accelerate'])
        elif conf.env['build_target'] == 'i686' or conf.env['build_target'] == 'x86_64':
                compiler_flags.append ("-DBUILD_SSE_OPTIMIZATIONS")
        elif conf.env['build_target'] == 'mingw':
                # usability of the 64 bit windows assembler depends on the compiler target,
                # not the build host, which in turn can only be inferred from the name
                # of the compiler.
                if re.search ('x86_64-w64', str(conf.env['CC'])) != None:
                        compiler_flags.append ("-DBUILD_SSE_OPTIMIZATIONS")
        if not build_host_supports_sse:
            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)")

    # end optimization section

    #
    # no VST on x86_64
    #

    if conf.env['build_target'] == 'x86_64' and opt.windows_vst:
        print("\n\n==================================================")
        print("64bit Windows VST support on 64bit Linux is experimental.")
        print("(This version of ardour will not load 32bit VSTs)")
        print("==================================================\n\n")

    if conf.env['LXVST_SUPPORT'] == True:
        if conf.env['build_target'] == 'x86_64':
            compiler_flags.append("-DLXVST_64BIT")
        else:
            compiler_flags.append("-DLXVST_32BIT")

    #
    # a single way to test if we're on OS X
    #

    if conf.env['build_target'] in ['panther', 'tiger', 'leopard' ]:
        # force tiger or later, to avoid issues on PPC which defaults
        # back to 10.1 if we don't tell it otherwise.

        compiler_flags.extend(
                ("-DMAC_OS_X_VERSION_MIN_REQUIRED=1040",
                 '-mmacosx-version-min=10.4'))

    elif conf.env['build_target'] in [ 'snowleopard' ]:
        compiler_flags.extend(
                ("-DMAC_OS_X_VERSION_MIN_REQUIRED=1060",
                 '-mmacosx-version-min=10.6'))

    elif conf.env['build_target'] in [ 'lion', 'mountainlion' ]:
        compiler_flags.extend(
                ("-DMAC_OS_X_VERSION_MIN_REQUIRED=1070",
                 '-mmacosx-version-min=10.7'))

    elif conf.env['build_target'] in [ 'mavericks', 'yosemite' ]:
        compiler_flags.extend(
                ("-DMAC_OS_X_VERSION_MAX_ALLOWED=1090",
                 "-mmacosx-version-min=10.8"))

    elif conf.env['build_target'] in ['el_capitan', 'sierra' ]:
        compiler_flags.extend(
                ("-DMAC_OS_X_VERSION_MAX_ALLOWED=1090",
                 "-mmacosx-version-min=10.9"))

    #
    # save off CPU element in an env
    #
    conf.define ('CONFIG_ARCH', cpu)

    #
    # ARCH="..." overrides all
    #

    if opt.arch != None:
        optimization_flags = opt.arch.split()

    #
    # prepend boiler plate optimization flags that work on all architectures
    #

    optimization_flags[:0] = [flags_dict['pipe']]

    # don't prepend optimization flags if "-O<something>" is present
    prepend_opt_flags = True
    for flag in optimization_flags:
        if flag.startswith("-O"):
            prepend_opt_flags = False
            break

    if prepend_opt_flags:
        optimization_flags[:0] = flags_dict['full-optimization']

    if opt.debug_symbols:
        optimization_flags += flags_dict['debuggable']

    if opt.profile:
        optimization_flags += flags_dict['profile']

    if opt.stl_debug:
        cxx_flags.append("-D_GLIBCXX_DEBUG")

    if re.search ("freebsd", sys.platform) != None or re.search ("openbsd", sys.platform) != None:
        linker_flags.append('-lexecinfo')

    if conf.env['DEBUG_RT_ALLOC']:
        compiler_flags.append('-DDEBUG_RT_ALLOC')
        linker_flags.append('-ldl')

    if conf.env['DEBUG_DENORMAL_EXCEPTION']:
        compiler_flags.append('-DDEBUG_DENORMAL_EXCEPTION')

    if opt.generic:
        compiler_flags.extend(flags_dict['generic-x86'])
        linker_flags.extend(flags_dict['generic-x86'])

    if opt.ppc:
        compiler_flags.extend(flags_dict['generic-ppc'])
        linker_flags.extend(flags_dict['generic-ppc'])

    #
    # warnings flags
    #

    compiler_flags.extend(flags_dict['basic-warnings'])

    c_flags.extend(flags_dict['extra-c-warnings'])
    cxx_flags.extend (flags_dict['extra-cxx-warnings'])

    #
    # more boilerplate
    #

    # need ISOC9X for llabs()
    compiler_flags.extend(
        ('-DBOOST_SYSTEM_NO_DEPRECATED', '-D_ISOC9X_SOURCE',
         '-D_LARGEFILE64_SOURCE', '-D_FILE_OFFSET_BITS=64'))
    cxx_flags.extend(
        ('-D__STDC_LIMIT_MACROS', '-D__STDC_FORMAT_MACROS',
         '-DCANVAS_COMPATIBILITY', '-DCANVAS_DEBUG'))

    if opt.nls:
        compiler_flags.append('-DENABLE_NLS')

    # use sparingly, prefer runtime profile
    if Options.options.program_name.lower() == "mixbus":
        compiler_flags.append ('-DMIXBUS')

    if Options.options.program_name.lower() == "mixbus32c":
        compiler_flags.append ('-DMIXBUS')
        compiler_flags.append ('-DMIXBUS32C')

    compiler_flags.append ('-DPROGRAM_NAME="' + Options.options.program_name + '"')
    compiler_flags.append ('-DPROGRAM_VERSION="' + PROGRAM_VERSION + '"')

    conf.env['PROGRAM_NAME'] = Options.options.program_name

    if opt.debug:
        conf.env.append_value('CFLAGS', debug_flags)
        conf.env.append_value('CXXFLAGS', debug_flags)
    else:
        conf.env.append_value('CFLAGS', optimization_flags)
        conf.env.append_value('CXXFLAGS', optimization_flags)

    if opt.backtrace:
        if platform != 'darwin' and not is_clang and not Options.options.dist_target == 'mingw':
            linker_flags += [ '-rdynamic' ]

    conf.env.append_value('CFLAGS', compiler_flags)
    conf.env.append_value('CFLAGS', c_flags)
    conf.env.append_value('CXXFLAGS', compiler_flags)
    conf.env.append_value('CXXFLAGS', cxx_flags)
    conf.env.append_value('LINKFLAGS', linker_flags)

def create_resource_file(icon):
    try:
        text = 'IDI_ICON1 ICON DISCARDABLE "icons/' + icon + '.ico"\n'
        o = open('gtk2_ardour/windows_icon.rc', 'w')
        o.write(text)
        o.close()
    except IOError:
        print('Could not open gtk2_ardour/windows_icon.rc for writing\n')
        sys.exit(-1)

def is_tracks_build (conf):
        return conf.env['PROGRAM_NAME'] == 'Tracks Live'

#----------------------------------------------------------------

# Waf stages

def options(opt):
    opt.load('compiler_c')
    opt.load('compiler_cxx')
    autowaf.set_options(opt, debug_by_default=True)
    opt.add_option('--program-name', type='string', action='store', default='Ardour', dest='program_name',
                    help='The user-visible name of the program being built')
    opt.add_option('--arch', type='string', action='store', dest='arch',
                    help='Architecture-specific compiler FLAGS')
    opt.add_option('--with-backends', type='string', action='store', default='jack', dest='with_backends',
                    help='Specify which backend modules are to be included(jack,alsa,dummy,portaudio,coreaudio)')
    opt.add_option('--backtrace', action='store_true', default=False, dest='backtrace',
                    help='Compile with -rdynamic -- allow obtaining backtraces from within Ardour')
    opt.add_option('--no-carbon', action='store_true', default=False, dest='nocarbon',
                    help='Compile without support for AU Plugins with only CARBON UI (needed for 64bit)')
    opt.add_option('--boost-sp-debug', action='store_true', default=False, dest='boost_sp_debug',
                    help='Compile with Boost shared pointer debugging')
    opt.add_option('--debug-symbols', action='store_true', default=False, dest='debug_symbols',
                    help='Add debug-symbols to optimized builds')
    opt.add_option('--depstack-root', type='string', default='~', dest='depstack_root',
                    help='Directory/folder where dependency stack trees (gtk, a3) can be found (defaults to ~)')
    opt.add_option('--dist-target', type='string', default='auto', dest='dist_target',
                    help='Specify the target for cross-compiling [auto,none,x86,i386,i686,x86_64,tiger,leopard,mingw,msvc]')
    opt.add_option('--fpu-optimization', action='store_true', default=True, dest='fpu_optimization',
                    help='Build runtime checked assembler code (default)')
    opt.add_option('--no-fpu-optimization', action='store_false', dest='fpu_optimization')
    opt.add_option('--exports-hidden', action='store_true', default=False, dest='exports_hidden')
    opt.add_option('--freedesktop', action='store_true', default=False, dest='freedesktop',
                    help='Build MIME type and .desktop files as per freedesktop.org standards (will be placed in build/gtk2_ardour)')
    opt.add_option('--freebie', action='store_true', default=False, dest='freebie',
                    help='Build a version suitable for distribution as a zero-cost binary')
    opt.add_option('--profile', action='store_true', default=False, dest='profile',
                    help='Compile for use with profiling tools requiring a frame pointer')
    opt.add_option('--gprofile', action='store_true', default=False, dest='gprofile',
                    help='Compile for use with gprofile')
    opt.add_option('--libjack', type='string', default="auto", dest='libjack_link',
                    help='libjack link mode  [auto|link|weak]')
    opt.add_option('--internal-shared-libs', action='store_true', default=True, dest='internal_shared_libs',
                   help='Build internal libs as shared libraries')
    opt.add_option('--internal-static-libs', action='store_false', dest='internal_shared_libs',
                   help='Build internal libs as static libraries')
    opt.add_option('--use-external-libs', action='store_true', default=False, dest='use_external_libs',
                   help='Use external/system versions of some bundled libraries')
    opt.add_option('--keepflags', action='store_true', default=False, dest='keepflags',
                    help='Do not ignore CFLAGS/CXXFLAGS environment vars')
    opt.add_option('--luadoc', action='store_true', default=False, dest='luadoc',
                    help='Compile Tool to dump LuaBindings (needs C++11)')
    opt.add_option('--canvasui', action='store_true', default=False, dest='canvasui',
                    help='Compile libcanvas test GUI')
    opt.add_option('--beatbox', action='store_true', default=False, dest='beatbox',
                    help='Compile beatbox test app')
    opt.add_option('--lv2', action='store_true', default=True, dest='lv2',
                    help='Compile with support for LV2 (if Lilv+Suil is available)')
    opt.add_option('--no-lv2', action='store_false', dest='lv2',
                    help='Do not compile with support for LV2')
    opt.add_option('--lv2dir', type='string', help="install destination for builtin LV2 bundles [Default: LIBDIR/lv2]")
    opt.add_option('--lxvst', action='store_true', default=True, dest='lxvst',
                    help='Compile with support for linuxVST plugins')
    opt.add_option('--no-lxvst', action='store_false', dest='lxvst',
                    help='Compile without support for linuxVST plugins')
    opt.add_option('--no-lrdf', action='store_true', dest='no_lrdf',
                    help='Compile without support for LRDF LADSPA data even if present')
    opt.add_option('--nls', action='store_true', default=True, dest='nls',
                    help='Enable i18n (native language support) (default)')
    opt.add_option('--no-nls', action='store_false', dest='nls')
    opt.add_option('--phone-home', action='store_true', default=True, dest='phone_home',
                   help='Contact ardour.org at startup for new announcements')
    opt.add_option('--no-phone-home', action='store_false', dest='phone_home',
                   help='Do not contact ardour.org at startup for new announcements')
    opt.add_option('--stl-debug', action='store_true', default=False, dest='stl_debug',
                    help='Build with debugging for the STL')
    opt.add_option('--rt-alloc-debug', action='store_true', default=False, dest='rt_alloc_debug',
                    help='Build with debugging for memory allocation in the real-time thread')
    opt.add_option('--pt-timing', action='store_true', default=False, dest='pt_timing',
                    help='Build with logging of timing in the process thread(s)')
    opt.add_option('--denormal-exception', action='store_true', default=False, dest='denormal_exception',
                    help='Raise a floating point exception if a denormal is detected')
    opt.add_option('--test', action='store_true', default=False, dest='build_tests',
                    help="Build unit tests")
    opt.add_option('--run-tests', action='store_true', default=False, dest='run_tests',
                    help="Run tests after build")
    opt.add_option('--single-tests', action='store_true', default=False, dest='single_tests',
                    help="Build a single executable for each unit test")
    #opt.add_option('--tranzport', action='store_true', default=False, dest='tranzport',
    # help='Compile with support for Frontier Designs Tranzport (if libusb is available)')
    opt.add_option('--generic', action='store_true', default=False, dest='generic',
                    help='Compile with -arch i386 (OS X ONLY)')
    opt.add_option('--ppc', action='store_true', default=False, dest='ppc',
                    help='Compile with -arch ppc (OS X ONLY)')
    opt.add_option('--versioned', action='store_true', default=False, dest='versioned',
                    help='Add revision information to executable name inside the build directory')
    opt.add_option('--windows-vst', action='store_true', default=False, dest='windows_vst',
                    help='Compile with support for Windows VST')
    opt.add_option('--windows-key', type='string', action='store', dest='windows_key', default='Mod4><Super',
                    help='X Modifier(s) (Mod1,Mod2, etc) for the Windows key (X11 builds only). ' +
                    'Multiple modifiers must be separated by \'><\'')
    opt.add_option('--boost-include', type='string', action='store', dest='boost_include', default='',
                    help='directory where Boost header files can be found')
    opt.add_option('--also-include', type='string', action='store', dest='also_include', default='',
                    help='additional include directory where header files can be found (split multiples with commas)')
    opt.add_option('--also-libdir', type='string', action='store', dest='also_libdir', default='',
                    help='additional include directory where shared libraries can be found (split multiples with commas)')
    opt.add_option('--wine-include', type='string', action='store', dest='wine_include', default='/usr/include/wine/windows',
                    help='directory where Wine\'s Windows header files can be found')
    opt.add_option('--noconfirm', action='store_true', default=False, dest='noconfirm',
                    help='Do not ask questions that require confirmation during the build')
    opt.add_option('--cxx11', action='store_true', default=False, dest='cxx11',
                    help='Turn on c++11 compiler flags (-std=c++11)')
    opt.add_option('--use-libc++', action='store_true', default=False, dest='use_libcpp',
                    help='use libc++ instead of default or auto-detected stdlib')
    opt.add_option('--address-sanitizer', action='store_true', default=False, dest='asan',
                    help='Turn on AddressSanitizer (requires GCC >= 4.8 or clang >= 3.1)')
    opt.add_option('--ptformat', action='store_true', default=False, dest='ptformat',
                    help='Turn on PT session import option')
    opt.add_option('--no-threaded-waveviews', action='store_true', default=False, dest='no_threaded_waveviews',
                    help='Disable threaded waveview rendering')
    opt.add_option(
        '--qm-dsp-include', type='string', action='store',
        dest='qm_dsp_include', default='/usr/include/qm-dsp',
        help='directory where the header files of qm-dsp can be found')

    for i in children:
        opt.recurse(i)

def sub_config_and_use(conf, name, has_objects = True):
    conf.recurse(name)
    autowaf.set_local_lib(conf, name, has_objects)

def configure(conf):
    conf.load('compiler_c')
    conf.load('compiler_cxx')
    if Options.options.dist_target == 'mingw':
        conf.load('winres')

    if Options.options.dist_target == 'msvc':
        conf.env['MSVC_VERSIONS'] = ['msvc 10.0', 'msvc 9.0', 'msvc 8.0', 'msvc 7.1', 'msvc 7.0', 'msvc 6.0', ]
        conf.env['MSVC_TARGETS'] = ['x64']
        conf.load('msvc')

    if Options.options.debug and not Options.options.keepflags:
        # Nuke user CFLAGS/CXXFLAGS if debug is set (they likely contain -O3, NDEBUG, etc)
        conf.env['CFLAGS'] = []
        conf.env['CXXFLAGS'] = []

    # freedesktop translations needs itstool > 1.0.3 (-j option)
    if Options.options.freedesktop:
        output = subprocess.Popen("itstool --version", shell=True, stderr=subprocess.STDOUT, stdout=subprocess.PIPE).communicate()[0].splitlines()
        o = output[0].decode('utf-8')
        itstool = o.split(' ')[0]
        version = o.split(' ')[1].split('.')
        # use  distutils.version.StrictVersion  or something python to check >= 1.0.4
        # but first make sure that all build-hosts (incl. OSX-10.5/PPC) have that python lib.
        # lazy approach: just use major version 2.X.X
        if itstool != "itstool" or version[0] < "2":
            print("--freedesktop requires itstool > 2.0.0 to translate files.")
            sys.exit(-1)

    conf.env['VERSION'] = VERSION
    conf.env['MAJOR'] = MAJOR
    conf.env['MINOR'] = MINOR
    conf.env['MICRO'] = MICRO
    conf.line_just = 52
    autowaf.set_recursive()
    autowaf.configure(conf)
    autowaf.display_header('Ardour Configuration')

    # systems with glibc have libintl builtin. systems without require explicit
    # linkage against libintl.
    #

    pkg_config_path = os.getenv('PKG_CONFIG_PATH')
    user_gtk_root = os.path.expanduser (Options.options.depstack_root + '/gtk/inst')

    if pkg_config_path is not None and pkg_config_path.find (user_gtk_root) >= 0:
        # told to search user_gtk_root
        prefinclude = ''.join ([ '-I', user_gtk_root + '/include'])
        preflib = ''.join ([ '-L', user_gtk_root + '/lib'])
        conf.env.append_value('CFLAGS', [ prefinclude ])
        conf.env.append_value('CXXFLAGS',  [prefinclude ])
        conf.env.append_value('LINKFLAGS', [ preflib ])
        autowaf.display_msg(conf, 'Will build against private GTK dependency stack in ' + user_gtk_root, 'yes')
        conf.env['DEPSTACK_REV'] = get_depstack_rev (Options.options.depstack_root)
    else:
        autowaf.display_msg(conf, 'Will build against private GTK dependency stack', 'no')
        conf.env['DEPSTACK_REV'] = '-system-'

    if sys.platform == 'darwin':
        conf.define ('NEED_INTL', 1)
        autowaf.display_msg(conf, 'Will use explicit linkage against libintl in ' + user_gtk_root, 'yes')
    else:
        # libintl is part of the system, so use it
        autowaf.display_msg(conf, 'Will rely on libintl built into libc', 'yes')

    user_ardour_root = os.path.expanduser (Options.options.depstack_root + '/a3/inst')
    if pkg_config_path is not None and pkg_config_path.find (user_ardour_root) >= 0:
        # told to search user_ardour_root
        prefinclude = ''.join ([ '-I', user_ardour_root + '/include'])
        preflib = ''.join ([ '-L', user_ardour_root + '/lib'])
        conf.env.append_value('CFLAGS', [ prefinclude ])
        conf.env.append_value('CXXFLAGS',  [prefinclude ])
        conf.env.append_value('LINKFLAGS', [ preflib ])
        autowaf.display_msg(conf, 'Will build against private Ardour dependency stack in ' + user_ardour_root, 'yes')
    else:
        autowaf.display_msg(conf, 'Will build against private Ardour dependency stack', 'no')

    if Options.options.freebie:
        conf.env.append_value ('CFLAGS', '-DSILENCE_AFTER')
        conf.env.append_value ('CXXFLAGS', '-DSILENCE_AFTER')
        conf.define ('FREEBIE', 1)

    if Options.options.lv2dir:
        conf.env['LV2DIR'] = Options.options.lv2dir
    else:
        conf.env['LV2DIR'] = os.path.join(conf.env['LIBDIR'], 'ardour' + str(conf.env['MAJOR']), 'LV2')

    conf.env['LV2DIR'] = os.path.normpath(conf.env['LV2DIR'])

    if sys.platform == 'darwin':

        # this is required, potentially, for anything we link and then relocate into a bundle
        conf.env.append_value('LINKFLAGS', [ '-Xlinker', '-headerpad_max_install_names' ])

        conf.define ('HAVE_COREAUDIO', 1)
        conf.define ('AUDIOUNIT_SUPPORT', 1)

        if not Options.options.ppc:
            conf.define('MACVST_SUPPORT', 1)

        conf.define ('TOP_MENUBAR',1)

        # It would be nice to be able to use this to force back-compatibility with 10.4
        # but even by the time of 11, the 10.4 SDK is no longer available in any normal
        # way.
        #
        #conf.env.append_value('CXXFLAGS_OSX', "-isysroot /Developer/SDKs/MacOSX10.4u.sdk")
        #conf.env.append_value('CFLAGS_OSX', "-isysroot /Developer/SDKs/MacOSX10.4u.sdk")
        #conf.env.append_value('LINKFLAGS_OSX', "-sysroot /Developer/SDKs/MacOSX10.4u.sdk")
        #conf.env.append_value('LINKFLAGS_OSX', "-sysroot /Developer/SDKs/MacOSX10.4u.sdk")

        conf.env.append_value('CXXFLAGS_OSX', "-msse")
        conf.env.append_value('CFLAGS_OSX', "-msse")
        conf.env.append_value('CXXFLAGS_OSX', "-msse2")
        conf.env.append_value('CFLAGS_OSX', "-msse2")
        #
        #       TODO: The previous sse flags NEED to be based
        #       off processor type.  Need to add in a check
        #       for that.
        #
        conf.env.append_value('CXXFLAGS_OSX', '-F/System/Library/Frameworks')
        conf.env.append_value('CXXFLAGS_OSX', '-F/Library/Frameworks')

        conf.env.append_value('LINKFLAGS_OSX', ['-framework', 'AppKit'])
        conf.env.append_value('LINKFLAGS_OSX', ['-framework', 'CoreAudio'])
        conf.env.append_value('LINKFLAGS_OSX', ['-framework', 'CoreAudioKit'])
        conf.env.append_value('LINKFLAGS_OSX', ['-framework', 'CoreFoundation'])
        conf.env.append_value('LINKFLAGS_OSX', ['-framework', 'CoreServices'])

        conf.env.append_value('LINKFLAGS_OSX', ['-undefined', 'dynamic_lookup' ])
        conf.env.append_value('LINKFLAGS_OSX', ['-flat_namespace'])

        conf.env.append_value('CXXFLAGS_AUDIOUNITS', "-DAUDIOUNIT_SUPPORT")
        conf.env.append_value('LINKFLAGS_AUDIOUNITS', ['-framework', 'AudioToolbox', '-framework', 'AudioUnit'])
        conf.env.append_value('LINKFLAGS_AUDIOUNITS', ['-framework', 'Cocoa'])

        if (
                # osx up to and including 10.6 (uname 10.X.X)
                (re.search ("^[1-9][0-9]\.", os.uname()[2]) == None or not re.search ("^10\.", os.uname()[2]) == None)
                and (Options.options.generic or Options.options.ppc)
                and not Options.options.nocarbon
           ):
            conf.env.append_value('CXXFLAGS_AUDIOUNITS', "-DWITH_CARBON")
            conf.env.append_value('LINKFLAGS_AUDIOUNITS', ['-framework', 'Carbon'])
        else:
            print ('No Carbon support available for this build\n')


    if Options.options.canvasui:
        conf.env['CANVASTESTUI'] = True
        conf.define ('CANVASTESTUI', 1)

    if Options.options.beatbox:
        conf.env['BEATBOX'] = True
        conf.define ('BEATBOX', 1)

    if Options.options.luadoc:
        conf.env['LUABINDINGDOC'] = True
        conf.define ('LUABINDINGDOC', 1)

    if Options.options.internal_shared_libs:
        conf.define('INTERNAL_SHARED_LIBS', 1)

    if Options.options.use_external_libs:
        conf.define('USE_EXTERNAL_LIBS', 1)
        conf.env.append_value(
            'CXXFLAGS', '-I' + Options.options.qm_dsp_include)

    if Options.options.boost_include != '':
        conf.env.append_value('CXXFLAGS', '-I' + Options.options.boost_include)

    if Options.options.also_include != '':
        conf.env.append_value('CXXFLAGS', '-I' + Options.options.also_include)
        conf.env.append_value('CFLAGS', '-I' + Options.options.also_include)

    if Options.options.also_libdir != '':
        conf.env.append_value('LDFLAGS', '-L' + Options.options.also_libdir)

    if Options.options.boost_sp_debug:
        conf.env.append_value('CXXFLAGS', '-DBOOST_SP_ENABLE_DEBUG_HOOKS')

    # executing a test program is n/a when cross-compiling
    if Options.options.dist_target != 'mingw':
        if Options.options.dist_target != 'msvc' and re.search ("openbsd", sys.platform) == None:
            if re.search ("freebsd", sys.platform) != None:
                conf.check_cc(function_name='dlopen', header_name='dlfcn.h', uselib_store='DL')
            else:
                conf.check_cc(function_name='dlopen', header_name='dlfcn.h', lib='dl', uselib_store='DL')
        conf.check_cxx(fragment = "#include <boost/version.hpp>\nint main(void) { return (BOOST_VERSION >= 103900 ? 0 : 1); }\n",
                  execute = "1",
                  mandatory = True,
                  msg = 'Checking for boost library >= 1.39',
                  okmsg = 'ok',
                  errmsg = 'too old\nPlease install boost version 1.39 or higher.')

    if re.search ("linux", sys.platform) != None and Options.options.dist_target != 'mingw':
        autowaf.check_pkg(conf, 'alsa', uselib_store='ALSA')

    if re.search ("openbsd", sys.platform) != None:
        conf.env.append_value('LDFLAGS', '-L/usr/X11R6/lib')

    autowaf.check_pkg(conf, 'glib-2.0', uselib_store='GLIB', atleast_version='2.28', mandatory=True)
    autowaf.check_pkg(conf, 'gthread-2.0', uselib_store='GTHREAD', atleast_version='2.2', mandatory=True)
    autowaf.check_pkg(conf, 'glibmm-2.4', uselib_store='GLIBMM', atleast_version='2.32.0', mandatory=True)
    autowaf.check_pkg(conf, 'sndfile', uselib_store='SNDFILE', atleast_version='1.0.18', mandatory=True)
    autowaf.check_pkg(conf, 'giomm-2.4', uselib_store='GIOMM', atleast_version='2.2', mandatory=True)
    autowaf.check_pkg(conf, 'libcurl', uselib_store='CURL', atleast_version='7.0.0', mandatory=True)
    autowaf.check_pkg(conf, 'libarchive', uselib_store='ARCHIVE', atleast_version='3.0.0', mandatory=True)
    autowaf.check_pkg(conf, 'liblo', uselib_store='LO', atleast_version='0.26', mandatory=True)
    autowaf.check_pkg(conf, 'taglib', uselib_store='TAGLIB', atleast_version='1.6', mandatory=True)
    autowaf.check_pkg(conf, 'vamp-sdk', uselib_store='VAMPSDK', atleast_version='2.1', mandatory=True)
    autowaf.check_pkg(conf, 'vamp-hostsdk', uselib_store='VAMPHOSTSDK', atleast_version='2.1', mandatory=True)
    autowaf.check_pkg(conf, 'rubberband', uselib_store='RUBBERBAND', mandatory=True)

    have_rf64_riff_support = conf.check_cc(fragment = '''
#include <sndfile.h>
int main () { int x = SFC_RF64_AUTO_DOWNGRADE; return 0; }
''',
                                           features  = 'c',
                                           mandatory = False,
                                           execute   = False,
                                           use = 'SNDFILE',
                                           msg       = 'Checking for  sndfile RF64=>RIFF support',
                                           okmsg = 'Found',
                                           errmsg = 'Not found, no RF64-to-WAV support')

    if have_rf64_riff_support:
            conf.env.append_value('CXXFLAGS', "-DHAVE_RF64_RIFF")
            conf.env.append_value('CFLAGS', "-DHAVE_RF64_RIFF")

    if Options.options.dist_target == 'mingw':
        Options.options.fpu_optimization = True
        conf.env.append_value('CFLAGS', '-DPLATFORM_WINDOWS')
        conf.env.append_value('CFLAGS', '-DCOMPILER_MINGW')
        conf.env.append_value('CXXFLAGS', '-DPLATFORM_WINDOWS')
        conf.env.append_value('CXXFLAGS', '-DCOMPILER_MINGW')
        if conf.options.cxx11:
            conf.env.append_value('CFLAGS', '-D_USE_MATH_DEFINES')
            conf.env.append_value('CXXFLAGS', '-D_USE_MATH_DEFINES')
            conf.env.append_value('CFLAGS', '-DWIN32')
            conf.env.append_value('CXXFLAGS', '-DWIN32')
        conf.env.append_value('LIB', 'pthread')
        # needed for at least libsmf
        conf.check_cc(function_name='htonl', header_name='winsock2.h', lib='ws2_32')
        conf.env.append_value('LIB', 'ws2_32')
        conf.env.append_value('LIB', 'winmm')
        # needed for mingw64 packages, not harmful on normal mingw build
        conf.env.append_value('LIB', 'intl')
        conf.check_cc(function_name='regcomp', header_name='regex.h',
                      lib='regex', uselib_store="REGEX", define_name='HAVE_REGEX_H')
        # TODO put this only where it is needed
        conf.env.append_value('LIB', 'regex')
        # TODO this should only be necessary for a debug build
        conf.env.append_value('LIB', 'dbghelp')

        # work around GdkDrawable BitBlt performance issue on windows
        # see http://gareus.org/wiki/ardour_windows_gdk_and_cairo
        conf.env.append_value('CFLAGS', '-DUSE_CAIRO_IMAGE_SURFACE')
        conf.env.append_value('CXXFLAGS', '-DUSE_CAIRO_IMAGE_SURFACE')
        conf.define ('WINDOWS', 1)

        have_ptw_semaphore = conf.check_cc(fragment = '''
#include <pthread.h>
#include <semaphore.h>
int main () { return 0; }
''',
                                           features  = 'c',
                                           mandatory = False,
                                           execute   = False,
                                           msg       = 'Checking for pthread posix semaphore',
                                           okmsg     = 'Found',
                                           errmsg    = 'Not found, falling back to Windows Semaphore.')

        #if have_ptw_semaphore:
        #    conf.define('USE_PTW32_SEMAPHORE', 1)
        #    conf.env.append_value('CFLAGS', '-DUSE_PTW32_SEMAPHORE')
        #    conf.env.append_value('CXXFLAGS', '-DUSE_PTW32_SEMAPHORE')

    if Options.options.dist_target == 'msvc':
        conf.env.append_value('CFLAGS', '-DPLATFORM_WINDOWS')
        conf.env.append_value('CFLAGS', '-DCOMPILER_MSVC')
        conf.env.append_value('CXXFLAGS', '-DPLATFORM_WINDOWS')
        conf.env.append_value('CXXFLAGS', '-DCOMPILER_MSVC')
        # work around GdkDrawable BitBlt performance issue on windows
        # see http://gareus.org/wiki/ardour_windows_gdk_and_cairo
        conf.env.append_value('CFLAGS', '-DUSE_CAIRO_IMAGE_SURFACE')
        conf.env.append_value('CXXFLAGS', '-DUSE_CAIRO_IMAGE_SURFACE')
        # MORE STUFF PROBABLY NEEDED HERE
        conf.define ('WINDOWS', 1)

    # Tell everyone that this is a waf build

    conf.env.append_value('CFLAGS', '-DWAF_BUILD')
    conf.env.append_value('CXXFLAGS', '-DWAF_BUILD')

    opts = Options.options

    # (optionally) Adopt Microsoft-like convention that makes all non-explicitly exported
    # symbols invisible (rather than doing this all over the wscripts in the src tree)
    #
    # This won't apply to MSVC but that hasn't been added as a target yet
    #
    # We can't do this till all tests are complete, since some fail if this is et.
    if opts.exports_hidden:
        conf.define ('EXPORT_VISIBILITY_HIDDEN', True)
        if opts.internal_shared_libs:
            conf.env.append_value ('CXXFLAGS', '-fvisibility=hidden')
            conf.env.append_value ('CFLAGS', '-fvisibility=hidden')
    else:
        conf.define ('EXPORT_VISIBILITY_HIDDEN', False)

    # Set up waf environment and C defines
    if opts.phone_home:
        conf.define('PHONE_HOME', 1)
        conf.env['PHONE_HOME'] = True
    if opts.fpu_optimization:
        conf.env['FPU_OPTIMIZATION'] = True
    if opts.freedesktop:
        conf.env['FREEDESKTOP'] = True
    if opts.nls:
        conf.define('ENABLE_NLS', 1)
        conf.env['ENABLE_NLS'] = True
    if opts.build_tests:
        conf.env['BUILD_TESTS'] = True
        conf.env['RUN_TESTS'] = opts.run_tests
    if opts.single_tests:
        conf.env['SINGLE_TESTS'] = opts.single_tests
    #if opts.tranzport:
    #    conf.env['TRANZPORT'] = 1
    if opts.windows_vst:
        conf.define('WINDOWS_VST_SUPPORT', 1)
        conf.env['WINDOWS_VST_SUPPORT'] = True
        if not Options.options.dist_target == 'mingw':
            conf.env.append_value('CFLAGS', '-I' + Options.options.wine_include)
            conf.env.append_value('CXXFLAGS', '-I' + Options.options.wine_include)
            autowaf.check_header(conf, 'cxx', 'windows.h', mandatory = True)
    if opts.lxvst:
        if sys.platform == 'darwin':
            conf.env['LXVST_SUPPORT'] = False
        elif Options.options.dist_target == 'mingw':
            conf.env['LXVST_SUPPORT'] = False
        else:
            conf.define('LXVST_SUPPORT', 1)
            conf.env['LXVST_SUPPORT'] = True
    conf.env['WINDOWS_KEY'] = opts.windows_key
    if opts.rt_alloc_debug:
        conf.define('DEBUG_RT_ALLOC', 1)
        conf.env['DEBUG_RT_ALLOC'] = True
    if opts.pt_timing:
        conf.define('PT_TIMING', 1)
        conf.env['PT_TIMING'] = True
    if opts.denormal_exception:
        conf.define('DEBUG_DENORMAL_EXCEPTION', 1)
        conf.env['DEBUG_DENORMAL_EXCEPTION'] = True
    if opts.build_tests:
        autowaf.check_pkg(conf, 'cppunit', uselib_store='CPPUNIT', atleast_version='1.12.0', mandatory=True)
    if opts.ptformat:
        conf.define('PTFORMAT', 1)
        conf.env['PTFORMAT'] = True
    if opts.no_threaded_waveviews:
        conf.define('NO_THREADED_WAVEVIEWS', 1)
        conf.env['NO_THREADED_WAVEVIEWS'] = True

    backends = opts.with_backends.split(',')
    if opts.build_tests and 'dummy' not in backends:
        backends += ['dummy']

    if not backends:
        print("Must configure and build at least one backend")
        sys.exit(1)

    conf.env['BACKENDS'] = backends
    conf.env['BUILD_JACKBACKEND'] = any('jack' in b for b in backends)
    conf.env['BUILD_ALSABACKEND'] = any('alsa' in b for b in backends)
    conf.env['BUILD_DUMMYBACKEND'] = any('dummy' in b for b in backends)
    conf.env['BUILD_PABACKEND'] = any('portaudio' in b for b in backends)
    conf.env['BUILD_CORECRAPPITA'] = any('coreaudio' in b for b in backends)

    if re.search ("linux", sys.platform) != None and Options.options.dist_target != 'mingw' and conf.env['BUILD_PABACKEND']:
        print("PortAudio Backend is not for Linux")
        sys.exit(1)

    if sys.platform != 'darwin' and conf.env['BUILD_CORECRAPPITA']:
        print("Coreaudio backend is only available for OSX")
        sys.exit(1)

    if re.search ("linux", sys.platform) == None and conf.env['BUILD_ALSABACKEND']:
        print("ALSA Backend is only available on Linux")
        sys.exit(1)

    set_compiler_flags (conf, Options.options)

    if sys.platform == 'darwin':
        sub_config_and_use(conf, 'libs/appleutility')
    elif re.search ("openbsd", sys.platform) != None:
        pass
    elif Options.options.dist_target != 'mingw':
        sub_config_and_use(conf, 'tools/sanity_check')
        sub_config_and_use(conf, 'tools/gccabicheck')

    sub_config_and_use(conf, 'libs/clearlooks-newer')

    for i in children:
        sub_config_and_use(conf, i)

    # Fix utterly braindead FLAC include path to not smash assert.h
    conf.env['INCLUDES_FLAC'] = []

    config_text = open('libs/ardour/config_text.cc', "w")
    config_text.write('''#include "ardour/ardour.h"
namespace ARDOUR {
const char* const ardour_config_info = "\\n\\
''')

    def write_config_text(title, val):
        autowaf.display_msg(conf, title, val)
        config_text.write(title + ': ')
        config_text.write(str(val).replace ('"', '\\"'))
        config_text.write("\\n\\\n")

    write_config_text('Build documentation',   conf.env['DOCS'])
    write_config_text('Debuggable build',      conf.env['DEBUG'])
    write_config_text('Export all symbols (backtrace)', opts.backtrace)
    write_config_text('Install prefix',        conf.env['PREFIX'])
    write_config_text('Strict compiler flags', conf.env['STRICT'])
    write_config_text('Internal Shared Libraries', conf.is_defined('INTERNAL_SHARED_LIBS'))
    write_config_text('Use External Libraries', conf.is_defined('USE_EXTERNAL_LIBS'))
    write_config_text('Library exports hidden', conf.is_defined('EXPORT_VISIBILITY_HIDDEN'))
    write_config_text('Free/Demo copy',        conf.is_defined('FREEBIE'))
    config_text.write("\\n\\\n")
    write_config_text('ALSA DBus Reservation', conf.is_defined('HAVE_DBUS'))
    write_config_text('Architecture flags',    opts.arch)
    write_config_text('Aubio',                 conf.is_defined('HAVE_AUBIO'))
    write_config_text('AudioUnits',            conf.is_defined('AUDIOUNIT_SUPPORT'))
    write_config_text('Build target',          conf.env['build_target'])
    write_config_text('Canvas Test UI',        conf.is_defined('CANVASTESTUI'))
    write_config_text('Beatbox test app',      conf.is_defined('BEATBOX'))
    write_config_text('CoreAudio',             conf.is_defined('HAVE_COREAUDIO'))
    write_config_text('CoreAudio 10.5 compat', conf.is_defined('COREAUDIO105'))
    write_config_text('Debug RT allocations',  conf.is_defined('DEBUG_RT_ALLOC'))
    write_config_text('Debug Symbols',         conf.is_defined('debug_symbols') or conf.env['DEBUG'])
    write_config_text('Denormal exceptions',   conf.is_defined('DEBUG_DENORMAL_EXCEPTION'))
    write_config_text('FLAC',                  conf.is_defined('HAVE_FLAC'))
    write_config_text('FPU optimization',      opts.fpu_optimization)
    write_config_text('Freedesktop files',     opts.freedesktop)
    write_config_text('Libjack linking',       conf.env['libjack_link'])
    write_config_text('Libjack metadata',      conf.is_defined ('HAVE_JACK_METADATA'))
    write_config_text('Lua Binding Doc',       conf.is_defined('LUABINDINGDOC'))
    write_config_text('LV2 UI embedding',      conf.is_defined('HAVE_SUIL'))
    write_config_text('LV2 support',           conf.is_defined('LV2_SUPPORT'))
    write_config_text('LV2 extensions',        conf.is_defined('LV2_EXTENDED'))
    write_config_text('LXVST support',         conf.is_defined('LXVST_SUPPORT'))
    write_config_text('Mac VST support',       conf.is_defined('MACVST_SUPPORT'))
    write_config_text('OGG',                   conf.is_defined('HAVE_OGG'))
    write_config_text('Phone home',            conf.is_defined('PHONE_HOME'))
    write_config_text('Process thread timing', conf.is_defined('PT_TIMING'))
    write_config_text('Program name',          opts.program_name)
    write_config_text('Samplerate',            conf.is_defined('HAVE_SAMPLERATE'))
    write_config_text('PT format',             conf.is_defined('PTFORMAT'))
    write_config_text('PTW32 Semaphore',       conf.is_defined('USE_PTW32_SEMAPHORE'))
#    write_config_text('Soundtouch',            conf.is_defined('HAVE_SOUNDTOUCH'))
    write_config_text('Threaded WaveViews',    not opts.no_threaded_waveviews)
    write_config_text('Translation',           opts.nls)
#    write_config_text('Tranzport',             opts.tranzport)
    write_config_text('Unit tests',            conf.env['BUILD_TESTS'])
    write_config_text('Windows VST support',   opts.windows_vst)
    write_config_text('Wiimote support',       conf.is_defined('BUILD_WIIMOTE'))
    write_config_text('Windows key',           opts.windows_key)
    config_text.write("\\n\\\n")
    write_config_text('PortAudio Backend',     conf.env['BUILD_PABACKEND'])
    write_config_text('CoreAudio/Midi Backend',conf.env['BUILD_CORECRAPPITA'])
    write_config_text('ALSA Backend',          conf.env['BUILD_ALSABACKEND'])
    write_config_text('Dummy backend',         conf.env['BUILD_DUMMYBACKEND'])
    write_config_text('JACK Backend',          conf.env['BUILD_JACKBACKEND'])
    config_text.write("\\n\\\n")
    write_config_text('Builstack', conf.env['DEPSTACK_REV'])
    write_config_text('Mac i386 Architecture', opts.generic)
    write_config_text('Mac ppc Architecture',  opts.ppc)
    config_text.write("\\n\\\n")
    write_config_text('C compiler flags',      conf.env['CFLAGS'])
    write_config_text('C++ compiler flags',    conf.env['CXXFLAGS'])
    write_config_text('Linker flags',          conf.env['LINKFLAGS'])

    config_text.write ('";\n}\n')
    config_text.close ()
    print('')

    if Options.options.dist_target == 'mingw' or Options.options.dist_target == 'msvc':
        create_resource_file(Options.options.program_name)

def build(bld):
    create_stored_revision()

    # add directories that contain only headers, to workaround an issue with waf

    if not bld.is_defined('USE_EXTERNAL_LIBS'):
        bld.path.find_dir ('libs/libltc/ltc')
    bld.path.find_dir ('libs/evoral/evoral')
    bld.path.find_dir ('libs/surfaces/control_protocol/control_protocol')
    bld.path.find_dir ('libs/timecode/timecode')
    bld.path.find_dir ('libs/gtkmm2ext/gtkmm2ext')
    bld.path.find_dir ('libs/ardour/ardour')
    bld.path.find_dir ('libs/pbd/pbd')

    # set up target directories
    lwrcase_dirname = 'ardour' + bld.env['MAJOR']

    if bld.is_tracks_build():
        bld.env.append_value ('CXXFLAGS', '-DUSE_TRACKS_CODE_FEATURES')
        bld.env.append_value ('CFLAGS', '-DUSE_TRACKS_CODE_FEATURES')
        lwrcase_dirname = 'trx'

    # configuration files go here
    bld.env['CONFDIR'] = os.path.join(bld.env['SYSCONFDIR'], lwrcase_dirname)
    # data files loaded at run time go here
    bld.env['DATADIR'] = os.path.join(bld.env['DATADIR'], lwrcase_dirname)
    # shared objects loaded at runtime go here (two aliases)
    bld.env['DLLDIR'] = os.path.join(bld.env['LIBDIR'], lwrcase_dirname)
    bld.env['LIBDIR'] = bld.env['DLLDIR']
    bld.env['LOCALEDIR'] = os.path.join(bld.env['DATADIR'], 'locale')
    bld.env['lwrcase_dirname'] = lwrcase_dirname;

    autowaf.set_recursive()

    if sys.platform == 'darwin':
        bld.recurse('libs/appleutility')
    elif re.search ("openbsd", sys.platform) != None:
        pass
    elif bld.env['build_target'] != 'mingw':
        bld.recurse('tools/sanity_check')
        bld.recurse('tools/gccabicheck')

    bld.recurse('libs/clearlooks-newer')

    for i in children:
        bld.recurse(i)

    if bld.is_defined ('BEATBOX'):
        bld.recurse('tools/bb')
            
    bld.install_files (bld.env['CONFDIR'], 'system_config')

    bld.install_files (os.path.join (bld.env['DATADIR'], 'templates'), bld.path.ant_glob ('templates/**'), cwd=bld.path.find_dir ('templates'), relative_trick=True)

    if bld.env['RUN_TESTS']:
        bld.add_post_fun(test)

def i18n(bld):
    print(bld.env)
    bld.recurse (i18n_children)

def i18n_pot(bld):
    bld.recurse (i18n_children)

def i18n_po(bld):
    bld.recurse (i18n_children)

def i18n_mo(bld):
    bld.recurse (i18n_children)

def tarball(bld):
    create_stored_revision()

def test(bld):
    subprocess.call("gtk2_ardour/artest")

def help2man(bld):
    cmd = "help2man -s 1 -N -o ardour.1 -n Ardour --version-string='Ardour %s' gtk2_ardour/ardev" % PROGRAM_VERSION
    subprocess.call(cmd, shell=True)