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