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