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