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