bbfedf79ca60bdf0b1425a3d6cabb47be7f78a50
[aubio.git] / wscript
1 #! /usr/bin/python
2 #
3 # usage:
4 #   $ python waf --help
5 #
6 # example:
7 #   $ ./waf distclean configure build
8 #
9 # Note: aubio uses the waf build system, which relies on Python. Provided you
10 # have Python installed, you do *not* need to install anything to build aubio.
11 # For more info about waf, see http://code.google.com/p/waf/ .
12
13 import sys
14
15 APPNAME = 'aubio'
16
17 # source VERSION
18 for l in open('VERSION').readlines(): exec (l.strip())
19
20 VERSION = '.'.join ([str(x) for x in [
21     AUBIO_MAJOR_VERSION,
22     AUBIO_MINOR_VERSION,
23     AUBIO_PATCH_VERSION
24     ]]) + AUBIO_VERSION_STATUS
25
26 LIB_VERSION = '.'.join ([str(x) for x in [
27     LIBAUBIO_LT_CUR,
28     LIBAUBIO_LT_REV,
29     LIBAUBIO_LT_AGE]])
30
31 top = '.'
32 out = 'build'
33
34 def add_option_enable_disable(ctx, name, default = None,
35         help_str = None, help_disable_str = None):
36     if help_str == None:
37         help_str = 'enable ' + name + ' support'
38     if help_disable_str == None:
39         help_disable_str = 'do not ' + help_str
40     ctx.add_option('--enable-' + name, action = 'store_true',
41             default = default,
42             dest = 'enable_' + name.replace('-','_'),
43             help = help_str)
44     ctx.add_option('--disable-' + name, action = 'store_false',
45             #default = default,
46             dest = 'enable_' + name.replace('-','_'),
47             help = help_disable_str )
48
49 def options(ctx):
50     ctx.add_option('--build-type', action = 'store',
51             default = "release",
52             choices = ('debug', 'release'),
53             dest = 'build_type',
54             help = 'whether to compile with (--build-type=release) or without (--build-type=debug) '\
55               ' compiler opimizations [default: release]')
56     add_option_enable_disable(ctx, 'fftw3f', default = False,
57             help_str = 'compile with fftw3f instead of ooura (recommended)',
58             help_disable_str = 'do not compile with fftw3f')
59     add_option_enable_disable(ctx, 'fftw3', default = False,
60             help_str = 'compile with fftw3 instead of ooura',
61             help_disable_str = 'do not compile with fftw3')
62     add_option_enable_disable(ctx, 'complex', default = False,
63             help_str ='compile with C99 complex',
64             help_disable_str = 'do not use C99 complex (default)' )
65     add_option_enable_disable(ctx, 'jack', default = None,
66             help_str = 'compile with jack (auto)',
67             help_disable_str = 'disable jack support')
68     add_option_enable_disable(ctx, 'sndfile', default = None,
69             help_str = 'compile with sndfile (auto)',
70             help_disable_str = 'disable sndfile')
71     add_option_enable_disable(ctx, 'avcodec', default = None,
72             help_str = 'compile with libavcodec (auto)',
73             help_disable_str = 'disable libavcodec')
74     add_option_enable_disable(ctx, 'samplerate', default = None,
75             help_str = 'compile with samplerate (auto)',
76             help_disable_str = 'disable samplerate')
77     add_option_enable_disable(ctx, 'memcpy', default = True,
78             help_str = 'use memcpy hacks (default)',
79             help_disable_str = 'do not use memcpy hacks')
80     add_option_enable_disable(ctx, 'double', default = False,
81             help_str = 'compile in double precision mode',
82             help_disable_str = 'compile in single precision mode (default)')
83     add_option_enable_disable(ctx, 'fat', default = False,
84             help_str = 'build fat binaries (darwin only)',
85             help_disable_str = 'do not build fat binaries (default)')
86     add_option_enable_disable(ctx, 'accelerate', default = None,
87             help_str = 'use Accelerate framework (darwin only) (auto)',
88             help_disable_str = 'do not use Accelerate framework')
89     add_option_enable_disable(ctx, 'apple-audio', default = None,
90             help_str = 'use CoreFoundation (darwin only) (auto)',
91             help_disable_str = 'do not use CoreFoundation framework')
92     add_option_enable_disable(ctx, 'atlas', default = False,
93             help_str = 'use Atlas library (no)',
94             help_disable_str = 'do not use Atlas library')
95     add_option_enable_disable(ctx, 'wavread', default = True,
96             help_str = 'compile with source_wavread (default)',
97             help_disable_str = 'do not compile source_wavread')
98     add_option_enable_disable(ctx, 'wavwrite', default = True,
99             help_str = 'compile with source_wavwrite (default)',
100             help_disable_str = 'do not compile source_wavwrite')
101
102     add_option_enable_disable(ctx, 'docs', default = None,
103             help_str = 'build documentation (auto)',
104             help_disable_str = 'do not build documentation')
105
106     ctx.add_option('--with-target-platform', type='string',
107             help='set target platform for cross-compilation', dest='target_platform')
108
109     ctx.load('compiler_c')
110     ctx.load('waf_unit_test')
111     ctx.load('gnu_dirs')
112
113 def configure(ctx):
114     from waflib import Options
115     ctx.load('compiler_c')
116     ctx.load('waf_unit_test')
117     ctx.load('gnu_dirs')
118
119     # check for common headers
120     ctx.check(header_name='stdlib.h')
121     ctx.check(header_name='stdio.h')
122     ctx.check(header_name='math.h')
123     ctx.check(header_name='string.h')
124     ctx.check(header_name='limits.h')
125     ctx.check(header_name='stdarg.h')
126     ctx.check(header_name='getopt.h', mandatory = False)
127     ctx.check(header_name='unistd.h', mandatory = False)
128
129     target_platform = sys.platform
130     if ctx.options.target_platform:
131         target_platform = ctx.options.target_platform
132     ctx.env['DEST_OS'] = target_platform
133
134     if ctx.options.build_type == "debug":
135         ctx.define('DEBUG', 1)
136     else:
137         ctx.define('NDEBUG', 1)
138
139     if ctx.env.CC_NAME != 'msvc':
140         # enable debug symbols and configure warnings
141         ctx.env.CFLAGS += ['-g', '-Wall', '-Wextra']
142         if ctx.options.build_type == "release":
143             # set optimization level
144             ctx.env.CFLAGS += ['-O2']
145         else:
146             ctx.env.CFLAGS += ['-O0']
147     else:
148         # enable debug symbols
149         ctx.env.CFLAGS += ['/Z7', '/FS']
150         ctx.env.LINKFLAGS += ['/DEBUG', '/INCREMENTAL:NO']
151         # configure warnings
152         ctx.env.CFLAGS += ['/W4', '/D_CRT_SECURE_NO_WARNINGS']
153         # set optimization level and runtime libs
154         if (ctx.options.build_type == "release"):
155             ctx.env.CFLAGS += ['/Ox']
156             ctx.env.CFLAGS += ['/MD']
157         else:
158             assert(ctx.options.build_type == "debug")
159             ctx.env.CFLAGS += ['/MDd']
160
161     ctx.check_cc(lib='m', uselib_store='M', mandatory=False)
162
163     if target_platform not in ['win32', 'win64']:
164         ctx.env.CFLAGS += ['-fPIC']
165     else:
166         ctx.define('HAVE_WIN_HACKS', 1)
167         ctx.env['cshlib_PATTERN'] = 'lib%s.dll'
168
169     if target_platform == 'darwin' and ctx.options.enable_fat:
170         ctx.env.CFLAGS += ['-arch', 'i386', '-arch', 'x86_64']
171         ctx.env.LINKFLAGS += ['-arch', 'i386', '-arch', 'x86_64']
172         MINSDKVER="10.4"
173         ctx.env.CFLAGS += [ '-mmacosx-version-min=' + MINSDKVER ]
174         ctx.env.LINKFLAGS += [ '-mmacosx-version-min=' + MINSDKVER ]
175
176     if target_platform in [ 'darwin', 'ios', 'iosimulator']:
177         if (ctx.options.enable_apple_audio != False):
178             ctx.env.FRAMEWORK += ['CoreFoundation', 'AudioToolbox']
179             ctx.define('HAVE_SOURCE_APPLE_AUDIO', 1)
180             ctx.define('HAVE_SINK_APPLE_AUDIO', 1)
181             ctx.msg('Checking for AudioToolbox.framework', 'yes')
182         else:
183             ctx.msg('Checking for AudioToolbox.framework', 'no (disabled)', color = 'YELLOW')
184         if (ctx.options.enable_accelerate != False):
185             ctx.define('HAVE_ACCELERATE', 1)
186             ctx.env.FRAMEWORK += ['Accelerate']
187             ctx.msg('Checking for Accelerate framework', 'yes')
188         else:
189             ctx.msg('Checking for Accelerate framework', 'no (disabled)', color = 'YELLOW')
190
191     if target_platform in [ 'ios', 'iosimulator' ]:
192         MINSDKVER="6.1"
193         ctx.env.CFLAGS += ['-std=c99']
194         if (ctx.options.enable_apple_audio != False):
195             ctx.define('HAVE_AUDIO_UNIT', 1)
196             #ctx.env.FRAMEWORK += ['CoreFoundation', 'AudioToolbox']
197         if target_platform == 'ios':
198             DEVROOT = "/Applications/Xcode.app/Contents"
199             DEVROOT += "/Developer/Platforms/iPhoneOS.platform/Developer"
200             SDKROOT = "%(DEVROOT)s/SDKs/iPhoneOS.sdk" % locals()
201             ctx.env.CFLAGS += [ '-fembed-bitcode' ]
202             ctx.env.CFLAGS += [ '-arch', 'arm64' ]
203             ctx.env.CFLAGS += [ '-arch', 'armv7' ]
204             ctx.env.CFLAGS += [ '-arch', 'armv7s' ]
205             ctx.env.LINKFLAGS += [ '-arch', 'arm64' ]
206             ctx.env.LINKFLAGS += ['-arch', 'armv7']
207             ctx.env.LINKFLAGS += ['-arch', 'armv7s']
208             ctx.env.CFLAGS += [ '-miphoneos-version-min=' + MINSDKVER ]
209             ctx.env.LINKFLAGS += [ '-miphoneos-version-min=' + MINSDKVER ]
210         else:
211             DEVROOT = "/Applications/Xcode.app/Contents"
212             DEVROOT += "/Developer/Platforms/iPhoneSimulator.platform/Developer"
213             SDKROOT = "%(DEVROOT)s/SDKs/iPhoneSimulator.sdk" % locals()
214             ctx.env.CFLAGS += [ '-arch', 'i386' ]
215             ctx.env.CFLAGS += [ '-arch', 'x86_64' ]
216             ctx.env.LINKFLAGS += ['-arch', 'i386']
217             ctx.env.LINKFLAGS += ['-arch', 'x86_64']
218             ctx.env.CFLAGS += [ '-mios-simulator-version-min=' + MINSDKVER ]
219             ctx.env.LINKFLAGS += [ '-mios-simulator-version-min=' + MINSDKVER ]
220         ctx.env.CFLAGS += [ '-isysroot' , SDKROOT]
221         ctx.env.LINKFLAGS += [ '-isysroot' , SDKROOT]
222
223     if target_platform == 'emscripten':
224         import os.path
225         ctx.env.CFLAGS += [ '-I' + os.path.join(os.environ['EMSCRIPTEN'], 'system', 'include') ]
226         ctx.env.CFLAGS += ['-Oz']
227         ctx.env.cprogram_PATTERN = "%s.js"
228         if (ctx.options.enable_atlas != True):
229             ctx.options.enable_atlas = False
230
231     # check support for C99 __VA_ARGS__ macros
232     check_c99_varargs = '''
233 #include <stdio.h>
234 #define AUBIO_ERR(...) fprintf(stderr, __VA_ARGS__)
235 '''
236
237     if ctx.check_cc(fragment = check_c99_varargs,
238             type='cstlib',
239             msg = 'Checking for C99 __VA_ARGS__ macro',
240             mandatory = False):
241         ctx.define('HAVE_C99_VARARGS_MACROS', 1)
242
243     # show a message about enable_double status
244     if (ctx.options.enable_double == True):
245         ctx.msg('Checking for size of smpl_t', 'double')
246         ctx.msg('Checking for size of lsmp_t', 'long double')
247     else:
248         ctx.msg('Checking for size of smpl_t', 'float')
249         ctx.msg('Checking for size of lsmp_t', 'double')
250
251     # optionally use complex.h
252     if (ctx.options.enable_complex == True):
253         ctx.check(header_name='complex.h')
254     else:
255         ctx.msg('Checking if complex.h is enabled', 'no')
256
257     # check for fftw3
258     if (ctx.options.enable_fftw3 != False or ctx.options.enable_fftw3f != False):
259         # one of fftwf or fftw3f
260         if (ctx.options.enable_fftw3f != False):
261             ctx.check_cfg(package = 'fftw3f', atleast_version = '3.0.0',
262                     args = '--cflags --libs',
263                     mandatory = ctx.options.enable_fftw3f)
264             if (ctx.options.enable_double == True):
265                 ctx.msg('Warning',
266                         'fftw3f enabled, but compiling in double precision!')
267         else:
268             # fftw3f disabled, take most sensible one according to
269             # enable_double
270             if (ctx.options.enable_double == True):
271                 ctx.check_cfg(package = 'fftw3', atleast_version = '3.0.0',
272                         args = '--cflags --libs', mandatory =
273                         ctx.options.enable_fftw3)
274             else:
275                 ctx.check_cfg(package = 'fftw3f', atleast_version = '3.0.0',
276                         args = '--cflags --libs',
277                         mandatory = ctx.options.enable_fftw3)
278         ctx.define('HAVE_FFTW3', 1)
279
280     # fftw not enabled, use vDSP or ooura
281     if 'HAVE_FFTW3F' in ctx.env.define_key:
282         ctx.msg('Checking for FFT implementation', 'fftw3f')
283     elif 'HAVE_FFTW3' in ctx.env.define_key:
284         ctx.msg('Checking for FFT implementation', 'fftw3')
285     elif 'HAVE_ACCELERATE' in ctx.env.define_key:
286         ctx.msg('Checking for FFT implementation', 'vDSP')
287     else:
288         ctx.msg('Checking for FFT implementation', 'ooura')
289
290     # check for libsndfile
291     if (ctx.options.enable_sndfile != False):
292         ctx.check_cfg(package = 'sndfile', atleast_version = '1.0.4',
293                 args = '--cflags --libs',
294                 mandatory = ctx.options.enable_sndfile)
295
296     # check for libsamplerate
297     if (ctx.options.enable_double):
298         if (ctx.options.enable_samplerate):
299             ctx.fatal("Could not compile aubio in double precision mode with libsamplerate")
300         else:
301             ctx.options.enable_samplerate = False
302             ctx.msg('Checking if using samplerate', 'no (disabled in double precision mode)',
303                     color = 'YELLOW')
304     if (ctx.options.enable_samplerate != False):
305         ctx.check_cfg(package = 'samplerate', atleast_version = '0.0.15',
306                 args = '--cflags --libs',
307                 mandatory = ctx.options.enable_samplerate)
308
309     # check for jack
310     if (ctx.options.enable_jack != False):
311         ctx.check_cfg(package = 'jack',
312                 args = '--cflags --libs',
313                 mandatory = ctx.options.enable_jack)
314
315     # check for libav
316     if (ctx.options.enable_avcodec != False):
317         ctx.check_cfg(package = 'libavcodec', atleast_version = '54.35.0',
318                 args = '--cflags --libs', uselib_store = 'AVCODEC',
319                 mandatory = ctx.options.enable_avcodec)
320         ctx.check_cfg(package = 'libavformat', atleast_version = '52.3.0',
321                 args = '--cflags --libs', uselib_store = 'AVFORMAT',
322                 mandatory = ctx.options.enable_avcodec)
323         ctx.check_cfg(package = 'libavutil', atleast_version = '52.3.0',
324                 args = '--cflags --libs', uselib_store = 'AVUTIL',
325                 mandatory = ctx.options.enable_avcodec)
326         ctx.check_cfg(package = 'libavresample', atleast_version = '1.0.1',
327                 args = '--cflags --libs', uselib_store = 'AVRESAMPLE',
328                 mandatory = ctx.options.enable_avcodec)
329         if all ( 'HAVE_' + i in ctx.env
330                 for i in ['AVCODEC', 'AVFORMAT', 'AVUTIL', 'AVRESAMPLE'] ):
331             ctx.define('HAVE_LIBAV', 1)
332             ctx.msg('Checking for all libav libraries', 'yes')
333         else:
334             ctx.msg('Checking for all libav libraries', 'not found', color = 'YELLOW')
335
336     if (ctx.options.enable_wavread != False):
337         ctx.define('HAVE_WAVREAD', 1)
338     ctx.msg('Checking if using source_wavread', ctx.options.enable_wavread and 'yes' or 'no')
339     if (ctx.options.enable_wavwrite!= False):
340         ctx.define('HAVE_WAVWRITE', 1)
341     ctx.msg('Checking if using sink_wavwrite', ctx.options.enable_wavwrite and 'yes' or 'no')
342
343     # use ATLAS
344     if (ctx.options.enable_atlas != False):
345         ctx.check(header_name = 'atlas/cblas.h', mandatory = ctx.options.enable_atlas)
346         #ctx.check(lib = 'lapack', uselib_store = 'LAPACK', mandatory = ctx.options.enable_atlas)
347         ctx.check(lib = 'cblas', uselib_store = 'BLAS', mandatory = ctx.options.enable_atlas)
348
349     # use memcpy hacks
350     if (ctx.options.enable_memcpy == True):
351         ctx.define('HAVE_MEMCPY_HACKS', 1)
352
353     # write configuration header
354     ctx.write_config_header('src/config.h')
355
356     # the following defines will be passed as arguments to the compiler
357     # instead of being written to src/config.h
358     ctx.define('HAVE_CONFIG_H', 1)
359
360     # add some defines used in examples
361     ctx.define('AUBIO_PREFIX', ctx.env['PREFIX'])
362     ctx.define('PACKAGE', APPNAME)
363
364     # double precision mode
365     if (ctx.options.enable_double == True):
366         ctx.define('HAVE_AUBIO_DOUBLE', 1)
367
368     if (ctx.options.enable_docs != False):
369         # check if txt2man is installed, optional
370         try:
371           ctx.find_program('txt2man', var='TXT2MAN')
372         except ctx.errors.ConfigurationError:
373           ctx.to_log('txt2man was not found (ignoring)')
374
375         # check if doxygen is installed, optional
376         try:
377           ctx.find_program('doxygen', var='DOXYGEN')
378         except ctx.errors.ConfigurationError:
379           ctx.to_log('doxygen was not found (ignoring)')
380
381         # check if sphinx-build is installed, optional
382         try:
383           ctx.find_program('sphinx-build', var='SPHINX')
384         except ctx.errors.ConfigurationError:
385           ctx.to_log('sphinx-build was not found (ignoring)')
386
387 def build(bld):
388     bld.env['VERSION'] = VERSION
389     bld.env['LIB_VERSION'] = LIB_VERSION
390
391     # main source
392     bld.recurse('src')
393
394     # add sub directories
395     if bld.env['DEST_OS'] not in ['ios', 'iosimulator', 'android']:
396         bld.recurse('examples')
397         bld.recurse('tests')
398
399     # pkg-config template
400     bld( source = 'aubio.pc.in' )
401
402     # documentation
403     txt2man(bld)
404     doxygen(bld)
405     sphinx(bld)
406
407 def txt2man(bld):
408     # build manpages from txt files using txt2man
409     if bld.env['TXT2MAN']:
410         from waflib import TaskGen
411         if 'MANDIR' not in bld.env:
412             bld.env['MANDIR'] = bld.env['DATAROOTDIR'] + '/man'
413         rule_str = '${TXT2MAN} -t `basename ${TGT} | cut -f 1 -d . | tr a-z A-Z`'
414         rule_str += ' -r ${PACKAGE}\\ ${VERSION} -P ${PACKAGE}'
415         rule_str += ' -v ${PACKAGE}\\ User\\\'s\\ manual'
416         rule_str += ' -s 1 ${SRC} > ${TGT}'
417         TaskGen.declare_chain(
418                 name      = 'txt2man',
419                 rule      = rule_str,
420                 ext_in    = '.txt',
421                 ext_out   = '.1',
422                 reentrant = False,
423                 install_path =  '${MANDIR}/man1',
424                 )
425         bld( source = bld.path.ant_glob('doc/*.txt') )
426
427 def doxygen(bld):
428     # build documentation from source files using doxygen
429     if bld.env['DOXYGEN']:
430         bld( name = 'doxygen', rule = 'doxygen ${SRC} > /dev/null',
431                 source = 'doc/web.cfg',
432                 cwd = 'doc')
433         bld.install_files( '${DATAROOTDIR}' + '/doc/libaubio-doc',
434                 bld.path.ant_glob('doc/web/html/**'),
435                 cwd = bld.path.find_dir ('doc/web'),
436                 relative_trick = True)
437
438 def sphinx(bld):
439     # build documentation from source files using sphinx-build
440     # note: build in ../doc/_build/html, otherwise waf wont install unsigned files
441     if bld.env['SPHINX']:
442         bld( name = 'sphinx',
443                 rule = '${SPHINX} -b html -a -q `dirname ${SRC}` `dirname ${TGT}`',
444                 source = 'doc/conf.py',
445                 target = '../doc/_build/html/index.html')
446         bld.install_files( '${DATAROOTDIR}' + '/doc/libaubio-doc/sphinx',
447                 bld.path.ant_glob('doc/_build/html/**'),
448                 cwd = bld.path.find_dir('doc/_build/html'),
449                 relative_trick = True)
450
451 # register the previous rules as build rules
452 from waflib.Build import BuildContext
453
454 class build_txt2man(BuildContext):
455     cmd = 'txt2man'
456     fun = 'txt2man'
457
458 class build_manpages(BuildContext):
459     cmd = 'manpages'
460     fun = 'txt2man'
461
462 class build_sphinx(BuildContext):
463     cmd = 'sphinx'
464     fun = 'sphinx'
465
466 class build_doxygen(BuildContext):
467     cmd = 'doxygen'
468     fun = 'doxygen'
469
470 def shutdown(bld):
471     from waflib import Logs
472     if bld.options.target_platform in ['ios', 'iosimulator']:
473         msg ='building for %s, contact the author for a commercial license' % bld.options.target_platform
474         Logs.pprint('RED', msg)
475         msg ='   Paul Brossier <piem@aubio.org>'
476         Logs.pprint('RED', msg)
477
478 def dist(ctx):
479     ctx.excl  = ' **/.waf* **/*~ **/*.pyc **/*.swp **/*.swo **/*.swn **/.lock-w* **/.git*'
480     ctx.excl += ' **/build/*'
481     ctx.excl += ' doc/_build'
482     ctx.excl += ' python/demos_*'
483     ctx.excl += ' **/python/gen **/python/build **/python/dist'
484     ctx.excl += ' **/python/ext/config.h'
485     ctx.excl += ' **/python/lib/aubio/_aubio.so'
486     ctx.excl += ' **.egg-info'
487     ctx.excl += ' **/**.zip **/**.tar.bz2'
488     ctx.excl += ' **.tar.bz2'
489     ctx.excl += ' **/doc/full/* **/doc/web/*'
490     ctx.excl += ' **/doc/full.cfg'
491     ctx.excl += ' **/python/*.db'
492     ctx.excl += ' **/python.old/*'
493     ctx.excl += ' **/python/*/*.old'
494     ctx.excl += ' **/python/tests/sounds'
495     ctx.excl += ' **/**.asc'
496     ctx.excl += ' **/dist*'
497     ctx.excl += ' **/.DS_Store'
498     ctx.excl += ' **/.travis.yml'
499     ctx.excl += ' **/.landscape.yml'
500     ctx.excl += ' **/.appveyor.yml'