wscript: add options to disable examples and tests
[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 from this_version import *
18
19 VERSION = get_aubio_version()
20 LIB_VERSION = get_libaubio_version()
21
22 top = '.'
23 out = 'build'
24
25 def add_option_enable_disable(ctx, name, default = None,
26         help_str = None, help_disable_str = None):
27     if help_str == None:
28         help_str = 'enable ' + name + ' support'
29     if help_disable_str == None:
30         help_disable_str = 'do not ' + help_str
31     ctx.add_option('--enable-' + name, action = 'store_true',
32             default = default,
33             dest = 'enable_' + name.replace('-','_'),
34             help = help_str)
35     ctx.add_option('--disable-' + name, action = 'store_false',
36             #default = default,
37             dest = 'enable_' + name.replace('-','_'),
38             help = help_disable_str )
39
40 def options(ctx):
41     ctx.add_option('--build-type', action = 'store',
42             default = "release",
43             choices = ('debug', 'release'),
44             dest = 'build_type',
45             help = 'whether to compile with (--build-type=release) or without (--build-type=debug) '\
46               ' compiler opimizations [default: release]')
47     add_option_enable_disable(ctx, 'fftw3f', default = False,
48             help_str = 'compile with fftw3f instead of ooura (recommended)',
49             help_disable_str = 'do not compile with fftw3f')
50     add_option_enable_disable(ctx, 'fftw3', default = False,
51             help_str = 'compile with fftw3 instead of ooura',
52             help_disable_str = 'do not compile with fftw3')
53     add_option_enable_disable(ctx, 'intelipp', default = False,
54             help_str = 'use Intel IPP libraries (auto)',
55             help_disable_str = 'do not use Intel IPP libraries')
56     add_option_enable_disable(ctx, 'complex', default = False,
57             help_str ='compile with C99 complex',
58             help_disable_str = 'do not use C99 complex (default)' )
59     add_option_enable_disable(ctx, 'jack', default = None,
60             help_str = 'compile with jack (auto)',
61             help_disable_str = 'disable jack support')
62     add_option_enable_disable(ctx, 'sndfile', default = None,
63             help_str = 'compile with sndfile (auto)',
64             help_disable_str = 'disable sndfile')
65     add_option_enable_disable(ctx, 'avcodec', default = None,
66             help_str = 'compile with libavcodec (auto)',
67             help_disable_str = 'disable libavcodec')
68     add_option_enable_disable(ctx, 'samplerate', default = None,
69             help_str = 'compile with samplerate (auto)',
70             help_disable_str = 'disable samplerate')
71     add_option_enable_disable(ctx, 'memcpy', default = True,
72             help_str = 'use memcpy hacks (default)',
73             help_disable_str = 'do not use memcpy hacks')
74     add_option_enable_disable(ctx, 'double', default = False,
75             help_str = 'compile in double precision mode',
76             help_disable_str = 'compile in single precision mode (default)')
77     add_option_enable_disable(ctx, 'fat', default = False,
78             help_str = 'build fat binaries (darwin only)',
79             help_disable_str = 'do not build fat binaries (default)')
80     add_option_enable_disable(ctx, 'accelerate', default = None,
81             help_str = 'use Accelerate framework (darwin only) (auto)',
82             help_disable_str = 'do not use Accelerate framework')
83     add_option_enable_disable(ctx, 'apple-audio', default = None,
84             help_str = 'use CoreFoundation (darwin only) (auto)',
85             help_disable_str = 'do not use CoreFoundation framework')
86     add_option_enable_disable(ctx, 'atlas', default = False,
87             help_str = 'use Atlas library (no)',
88             help_disable_str = 'do not use Atlas library')
89     add_option_enable_disable(ctx, 'wavread', default = True,
90             help_str = 'compile with source_wavread (default)',
91             help_disable_str = 'do not compile source_wavread')
92     add_option_enable_disable(ctx, 'wavwrite', default = True,
93             help_str = 'compile with source_wavwrite (default)',
94             help_disable_str = 'do not compile source_wavwrite')
95
96     add_option_enable_disable(ctx, 'docs', default = None,
97             help_str = 'build documentation (auto)',
98             help_disable_str = 'do not build documentation')
99
100     add_option_enable_disable(ctx, 'tests', default = True,
101             help_str = 'build tests (true)',
102             help_disable_str = 'do not build or run tests')
103
104     add_option_enable_disable(ctx, 'examples', default = True,
105             help_str = 'build examples (true)',
106             help_disable_str = 'do not build examples')
107
108     ctx.add_option('--with-target-platform', type='string',
109             help='set target platform for cross-compilation', dest='target_platform')
110
111     ctx.load('compiler_c')
112     ctx.load('waf_unit_test')
113     ctx.load('gnu_dirs')
114     ctx.load('waf_gensyms', tooldir='.')
115
116 def configure(ctx):
117     target_platform = sys.platform
118     if ctx.options.target_platform:
119         target_platform = ctx.options.target_platform
120
121     from waflib import Options
122
123     if target_platform=='emscripten':
124         ctx.load('c_emscripten')
125     else:
126         ctx.load('compiler_c')
127
128     ctx.load('waf_unit_test')
129     ctx.load('gnu_dirs')
130     ctx.load('waf_gensyms', tooldir='.')
131
132     # check for common headers
133     ctx.check(header_name='stdlib.h')
134     ctx.check(header_name='stdio.h')
135     ctx.check(header_name='math.h')
136     ctx.check(header_name='string.h')
137     ctx.check(header_name='limits.h')
138     ctx.check(header_name='stdarg.h')
139     ctx.check(header_name='getopt.h', mandatory = False)
140     ctx.check(header_name='unistd.h', mandatory = False)
141
142     ctx.env['DEST_OS'] = target_platform
143
144     if ctx.options.build_type == "debug":
145         ctx.define('DEBUG', 1)
146     else:
147         ctx.define('NDEBUG', 1)
148
149     if ctx.env.CC_NAME != 'msvc':
150         if ctx.options.build_type == "debug":
151             # no optimization in debug mode
152             ctx.env.prepend_value('CFLAGS', ['-O0'])
153         else:
154             if target_platform == 'emscripten':
155                 # -Oz for small js file generation
156                 ctx.env.prepend_value('CFLAGS', ['-Oz'])
157             else:
158                 # default to -O2 in release mode
159                 ctx.env.prepend_value('CFLAGS', ['-O2'])
160         # enable debug symbols and configure warnings
161         ctx.env.prepend_value('CFLAGS', ['-g', '-Wall', '-Wextra'])
162     else:
163         # enable debug symbols
164         ctx.env.CFLAGS += ['/Z7']
165         # /FS flag available in msvc >= 12 (2013)
166         if 'MSVC_VERSION' in ctx.env and ctx.env.MSVC_VERSION >= 12:
167             ctx.env.CFLAGS += ['/FS']
168         ctx.env.LINKFLAGS += ['/DEBUG', '/INCREMENTAL:NO']
169         # configure warnings
170         ctx.env.CFLAGS += ['/W4', '/D_CRT_SECURE_NO_WARNINGS']
171         # ignore "possible loss of data" warnings
172         ctx.env.CFLAGS += ['/wd4305', '/wd4244', '/wd4245', '/wd4267']
173         # ignore "unreferenced formal parameter" warnings
174         ctx.env.CFLAGS += ['/wd4100']
175         # set optimization level and runtime libs
176         if (ctx.options.build_type == "release"):
177             ctx.env.CFLAGS += ['/Ox']
178             ctx.env.CFLAGS += ['/MD']
179         else:
180             assert(ctx.options.build_type == "debug")
181             ctx.env.CFLAGS += ['/MDd']
182
183     ctx.check_cc(lib='m', uselib_store='M', mandatory=False)
184
185     if target_platform not in ['win32', 'win64']:
186         ctx.env.CFLAGS += ['-fPIC']
187     else:
188         ctx.define('HAVE_WIN_HACKS', 1)
189         ctx.env['cshlib_PATTERN'] = 'lib%s.dll'
190
191     if target_platform == 'darwin' and ctx.options.enable_fat:
192         ctx.env.CFLAGS += ['-arch', 'i386', '-arch', 'x86_64']
193         ctx.env.LINKFLAGS += ['-arch', 'i386', '-arch', 'x86_64']
194         MINSDKVER="10.4"
195         ctx.env.CFLAGS += [ '-mmacosx-version-min=' + MINSDKVER ]
196         ctx.env.LINKFLAGS += [ '-mmacosx-version-min=' + MINSDKVER ]
197
198     if target_platform in [ 'darwin', 'ios', 'iosimulator']:
199         if (ctx.options.enable_apple_audio != False):
200             ctx.env.FRAMEWORK += ['CoreFoundation', 'AudioToolbox']
201             ctx.define('HAVE_SOURCE_APPLE_AUDIO', 1)
202             ctx.define('HAVE_SINK_APPLE_AUDIO', 1)
203             ctx.msg('Checking for AudioToolbox.framework', 'yes')
204         else:
205             ctx.msg('Checking for AudioToolbox.framework', 'no (disabled)', color = 'YELLOW')
206         if (ctx.options.enable_accelerate != False):
207             ctx.define('HAVE_ACCELERATE', 1)
208             ctx.env.FRAMEWORK += ['Accelerate']
209             ctx.msg('Checking for Accelerate framework', 'yes')
210         else:
211             ctx.msg('Checking for Accelerate framework', 'no (disabled)', color = 'YELLOW')
212
213     if target_platform in [ 'ios', 'iosimulator' ]:
214         MINSDKVER="6.1"
215         ctx.env.CFLAGS += ['-std=c99']
216         if (ctx.options.enable_apple_audio != False):
217             ctx.define('HAVE_AUDIO_UNIT', 1)
218             #ctx.env.FRAMEWORK += ['CoreFoundation', 'AudioToolbox']
219         if target_platform == 'ios':
220             DEVROOT = "/Applications/Xcode.app/Contents"
221             DEVROOT += "/Developer/Platforms/iPhoneOS.platform/Developer"
222             SDKROOT = "%(DEVROOT)s/SDKs/iPhoneOS.sdk" % locals()
223             ctx.env.CFLAGS += [ '-fembed-bitcode' ]
224             ctx.env.CFLAGS += [ '-arch', 'arm64' ]
225             ctx.env.CFLAGS += [ '-arch', 'armv7' ]
226             ctx.env.CFLAGS += [ '-arch', 'armv7s' ]
227             ctx.env.LINKFLAGS += [ '-arch', 'arm64' ]
228             ctx.env.LINKFLAGS += ['-arch', 'armv7']
229             ctx.env.LINKFLAGS += ['-arch', 'armv7s']
230             ctx.env.CFLAGS += [ '-miphoneos-version-min=' + MINSDKVER ]
231             ctx.env.LINKFLAGS += [ '-miphoneos-version-min=' + MINSDKVER ]
232         else:
233             DEVROOT = "/Applications/Xcode.app/Contents"
234             DEVROOT += "/Developer/Platforms/iPhoneSimulator.platform/Developer"
235             SDKROOT = "%(DEVROOT)s/SDKs/iPhoneSimulator.sdk" % locals()
236             ctx.env.CFLAGS += [ '-arch', 'i386' ]
237             ctx.env.CFLAGS += [ '-arch', 'x86_64' ]
238             ctx.env.LINKFLAGS += ['-arch', 'i386']
239             ctx.env.LINKFLAGS += ['-arch', 'x86_64']
240             ctx.env.CFLAGS += [ '-mios-simulator-version-min=' + MINSDKVER ]
241             ctx.env.LINKFLAGS += [ '-mios-simulator-version-min=' + MINSDKVER ]
242         ctx.env.CFLAGS += [ '-isysroot' , SDKROOT]
243         ctx.env.LINKFLAGS += [ '-isysroot' , SDKROOT]
244
245     if target_platform == 'emscripten':
246         if ctx.options.build_type == "debug":
247             ctx.env.cshlib_PATTERN = '%s.js'
248             ctx.env.LINKFLAGS += ['-s','ASSERTIONS=2']
249             ctx.env.LINKFLAGS += ['-s','SAFE_HEAP=1']
250             ctx.env.LINKFLAGS += ['-s','ALIASING_FUNCTION_POINTERS=0']
251             ctx.env.LINKFLAGS += ['-O0']
252         else:
253             ctx.env.LINKFLAGS += ['-Oz']
254             ctx.env.cshlib_PATTERN = '%s.min.js'
255
256         # doesnt ship file system support in lib
257         ctx.env.LINKFLAGS_cshlib += ['-s', 'NO_FILESYSTEM=1']
258         # put memory file inside generated js files for easier portability
259         ctx.env.LINKFLAGS += ['--memory-init-file', '0']
260         ctx.env.cprogram_PATTERN = "%s.js"
261         ctx.env.cstlib_PATTERN = '%s.a'
262
263         # tell emscripten functions we want to expose
264         from python.lib.gen_external import get_c_declarations, \
265                 get_cpp_objects_from_c_declarations, get_all_func_names_from_lib, \
266                 generate_lib_from_c_declarations
267         c_decls = get_c_declarations(usedouble=False)  # emscripten can't use double
268         objects = list(get_cpp_objects_from_c_declarations(c_decls))
269         # ensure that aubio structs are exported
270         objects += ['fvec_t', 'cvec_t', 'fmat_t']
271         lib = generate_lib_from_c_declarations(objects, c_decls)
272         exported_funcnames = get_all_func_names_from_lib(lib)
273         c_mangled_names = ['_' + s for s in exported_funcnames]
274         ctx.env.LINKFLAGS_cshlib += ['-s', 'EXPORTED_FUNCTIONS=%s' % c_mangled_names]
275
276     if (ctx.options.enable_atlas != True):
277         ctx.options.enable_atlas = False
278
279     # check support for C99 __VA_ARGS__ macros
280     check_c99_varargs = '''
281 #include <stdio.h>
282 #define AUBIO_ERR(...) fprintf(stderr, __VA_ARGS__)
283 '''
284
285     if ctx.check_cc(fragment = check_c99_varargs,
286             type='cstlib',
287             msg = 'Checking for C99 __VA_ARGS__ macro',
288             mandatory = False):
289         ctx.define('HAVE_C99_VARARGS_MACROS', 1)
290
291     # show a message about enable_double status
292     if (ctx.options.enable_double == True):
293         ctx.msg('Checking for size of smpl_t', 'double')
294         ctx.msg('Checking for size of lsmp_t', 'long double')
295     else:
296         ctx.msg('Checking for size of smpl_t', 'float')
297         ctx.msg('Checking for size of lsmp_t', 'double')
298
299     # optionally use complex.h
300     if (ctx.options.enable_complex == True):
301         ctx.check(header_name='complex.h')
302     else:
303         ctx.msg('Checking if complex.h is enabled', 'no')
304
305     # check for Intel IPP
306     if (ctx.options.enable_intelipp != False):
307         has_ipp_headers = ctx.check(header_name=['ippcore.h', 'ippvm.h', 'ipps.h'],
308                 mandatory = False)
309         has_ipp_libs = ctx.check(lib=['ippcore', 'ippvm', 'ipps'],
310                 uselib_store='INTEL_IPP', mandatory = False)
311         if (has_ipp_headers and has_ipp_libs):
312             ctx.msg('Checking if Intel IPP is available', 'yes')
313             ctx.define('HAVE_INTEL_IPP', 1)
314             if ctx.env.CC_NAME == 'msvc':
315                 # force linking multi-threaded static IPP libraries on Windows with msvc
316                 ctx.define('_IPP_SEQUENTIAL_STATIC', 1)
317         else:
318             ctx.msg('Checking if Intel IPP is available', 'no')
319
320     # check for fftw3
321     if (ctx.options.enable_fftw3 != False or ctx.options.enable_fftw3f != False):
322         # one of fftwf or fftw3f
323         if (ctx.options.enable_fftw3f != False):
324             ctx.check_cfg(package = 'fftw3f',
325                     args = '--cflags --libs fftw3f >= 3.0.0',
326                     mandatory = ctx.options.enable_fftw3f)
327             if (ctx.options.enable_double == True):
328                 ctx.msg('Warning',
329                         'fftw3f enabled, but compiling in double precision!')
330         else:
331             # fftw3f disabled, take most sensible one according to
332             # enable_double
333             if (ctx.options.enable_double == True):
334                 ctx.check_cfg(package = 'fftw3',
335                         args = '--cflags --libs fftw3 >= 3.0.0.',
336                         mandatory = ctx.options.enable_fftw3)
337             else:
338                 ctx.check_cfg(package = 'fftw3f',
339                         args = '--cflags --libs fftw3f >= 3.0.0',
340                         mandatory = ctx.options.enable_fftw3)
341         ctx.define('HAVE_FFTW3', 1)
342
343     # fftw not enabled, use vDSP, intelIPP or ooura
344     if 'HAVE_FFTW3F' in ctx.env.define_key:
345         ctx.msg('Checking for FFT implementation', 'fftw3f')
346     elif 'HAVE_FFTW3' in ctx.env.define_key:
347         ctx.msg('Checking for FFT implementation', 'fftw3')
348     elif 'HAVE_ACCELERATE' in ctx.env.define_key:
349         ctx.msg('Checking for FFT implementation', 'vDSP')
350     elif 'HAVE_INTEL_IPP' in ctx.env.define_key:
351         ctx.msg('Checking for FFT implementation', 'Intel IPP')
352     else:
353         ctx.msg('Checking for FFT implementation', 'ooura')
354
355     # check for libsndfile
356     if (ctx.options.enable_sndfile != False):
357         ctx.check_cfg(package = 'sndfile',
358                 args = '--cflags --libs sndfile >= 1.0.4',
359                 mandatory = ctx.options.enable_sndfile)
360
361     # check for libsamplerate
362     if (ctx.options.enable_double):
363         if (ctx.options.enable_samplerate):
364             ctx.fatal("Could not compile aubio in double precision mode with libsamplerate")
365         else:
366             ctx.options.enable_samplerate = False
367             ctx.msg('Checking if using samplerate', 'no (disabled in double precision mode)',
368                     color = 'YELLOW')
369     if (ctx.options.enable_samplerate != False):
370         ctx.check_cfg(package = 'samplerate',
371                 args = '--cflags --libs samplerate >= 0.0.15',
372                 mandatory = ctx.options.enable_samplerate)
373
374     # check for jack
375     if (ctx.options.enable_jack != False):
376         ctx.check_cfg(package = 'jack',
377                 args = '--cflags --libs',
378                 mandatory = ctx.options.enable_jack)
379
380     # check for libav
381     if (ctx.options.enable_avcodec != False):
382         ctx.check_cfg(package = 'libavcodec',
383                 args = '--cflags --libs libavcodec >= 54.35.0',
384                 uselib_store = 'AVCODEC',
385                 mandatory = ctx.options.enable_avcodec)
386         ctx.check_cfg(package = 'libavformat',
387                 args = '--cflags --libs libavformat >= 52.3.0',
388                 uselib_store = 'AVFORMAT',
389                 mandatory = ctx.options.enable_avcodec)
390         ctx.check_cfg(package = 'libavutil',
391                 args = '--cflags --libs libavutil >= 52.3.0',
392                 uselib_store = 'AVUTIL',
393                 mandatory = ctx.options.enable_avcodec)
394         ctx.check_cfg(package = 'libswresample',
395                 args = '--cflags --libs libswresample >= 1.2.0',
396                 uselib_store = 'SWRESAMPLE',
397                 mandatory = False)
398         if 'HAVE_SWRESAMPLE' not in ctx.env:
399             ctx.check_cfg(package = 'libavresample',
400                     args = '--cflags --libs libavresample >= 1.0.1',
401                     uselib_store = 'AVRESAMPLE',
402                     mandatory = False)
403
404         msg_check = 'Checking for all libav libraries'
405         if 'HAVE_AVCODEC' not in ctx.env:
406             ctx.msg(msg_check, 'not found (missing avcodec)', color = 'YELLOW')
407         elif 'HAVE_AVFORMAT' not in ctx.env:
408             ctx.msg(msg_check, 'not found (missing avformat)', color = 'YELLOW')
409         elif 'HAVE_AVUTIL' not in ctx.env:
410             ctx.msg(msg_check, 'not found (missing avutil)', color = 'YELLOW')
411         elif 'HAVE_SWRESAMPLE' not in ctx.env and 'HAVE_AVRESAMPLE' not in ctx.env:
412             resample_missing = 'not found (avresample or swresample required)'
413             ctx.msg(msg_check, resample_missing, color = 'YELLOW')
414         else:
415             ctx.msg(msg_check, 'yes')
416             if 'HAVE_SWRESAMPLE' in ctx.env:
417                 ctx.define('HAVE_SWRESAMPLE', 1)
418             elif 'HAVE_AVRESAMPLE' in ctx.env:
419                 ctx.define('HAVE_AVRESAMPLE', 1)
420             ctx.define('HAVE_LIBAV', 1)
421
422     if (ctx.options.enable_wavread != False):
423         ctx.define('HAVE_WAVREAD', 1)
424     ctx.msg('Checking if using source_wavread', ctx.options.enable_wavread and 'yes' or 'no')
425     if (ctx.options.enable_wavwrite!= False):
426         ctx.define('HAVE_WAVWRITE', 1)
427     ctx.msg('Checking if using sink_wavwrite', ctx.options.enable_wavwrite and 'yes' or 'no')
428
429     # use ATLAS
430     if (ctx.options.enable_atlas != False):
431         ctx.check(header_name = 'atlas/cblas.h', mandatory = ctx.options.enable_atlas)
432         #ctx.check(lib = 'lapack', uselib_store = 'LAPACK', mandatory = ctx.options.enable_atlas)
433         ctx.check(lib = 'cblas', uselib_store = 'BLAS', mandatory = ctx.options.enable_atlas)
434
435     # use memcpy hacks
436     if (ctx.options.enable_memcpy == True):
437         ctx.define('HAVE_MEMCPY_HACKS', 1)
438
439     # write configuration header
440     ctx.write_config_header('src/config.h')
441
442     # the following defines will be passed as arguments to the compiler
443     # instead of being written to src/config.h
444     ctx.define('HAVE_CONFIG_H', 1)
445
446     # add some defines used in examples
447     ctx.define('AUBIO_PREFIX', ctx.env['PREFIX'])
448     ctx.define('PACKAGE', APPNAME)
449
450     # double precision mode
451     if (ctx.options.enable_double == True):
452         ctx.define('HAVE_AUBIO_DOUBLE', 1)
453
454     if (ctx.options.enable_docs != False):
455         # check if txt2man is installed, optional
456         try:
457           ctx.find_program('txt2man', var='TXT2MAN')
458         except ctx.errors.ConfigurationError:
459           ctx.to_log('txt2man was not found (ignoring)')
460
461         # check if doxygen is installed, optional
462         try:
463           ctx.find_program('doxygen', var='DOXYGEN')
464         except ctx.errors.ConfigurationError:
465           ctx.to_log('doxygen was not found (ignoring)')
466
467         # check if sphinx-build is installed, optional
468         try:
469           ctx.find_program('sphinx-build', var='SPHINX')
470         except ctx.errors.ConfigurationError:
471           ctx.to_log('sphinx-build was not found (ignoring)')
472
473 def build(bld):
474     bld.env['VERSION'] = VERSION
475     bld.env['LIB_VERSION'] = LIB_VERSION
476
477     # main source
478     bld.recurse('src')
479
480     # add sub directories
481     if bld.env['DEST_OS'] not in ['ios', 'iosimulator', 'android']:
482         if bld.env['DEST_OS']=='emscripten' and not bld.options.testcmd:
483             bld.options.testcmd = 'node %s'
484         if bld.options.enable_examples:
485             bld.recurse('examples')
486         if bld.options.enable_tests:
487             bld.recurse('tests')
488
489     # pkg-config template
490     bld( source = 'aubio.pc.in' )
491
492     # documentation
493     txt2man(bld)
494     doxygen(bld)
495     sphinx(bld)
496
497 def txt2man(bld):
498     # build manpages from txt files using txt2man
499     if bld.env['TXT2MAN']:
500         from waflib import TaskGen
501         if 'MANDIR' not in bld.env:
502             bld.env['MANDIR'] = bld.env['DATAROOTDIR'] + '/man'
503         bld.env.VERSION = VERSION
504         rule_str = '${TXT2MAN} -t `basename ${TGT} | cut -f 1 -d . | tr a-z A-Z`'
505         rule_str += ' -r ${PACKAGE}\\ ${VERSION} -P ${PACKAGE}'
506         rule_str += ' -v ${PACKAGE}\\ User\\\'s\\ manual'
507         rule_str += ' -s 1 ${SRC} > ${TGT}'
508         TaskGen.declare_chain(
509                 name      = 'txt2man',
510                 rule      = rule_str,
511                 ext_in    = '.txt',
512                 ext_out   = '.1',
513                 reentrant = False,
514                 install_path =  '${MANDIR}/man1',
515                 )
516         bld( source = bld.path.ant_glob('doc/*.txt') )
517
518 def doxygen(bld):
519     # build documentation from source files using doxygen
520     if bld.env['DOXYGEN']:
521         bld.env.VERSION = VERSION
522         rule = '( cat ${SRC} && echo PROJECT_NUMBER=${VERSION}; )'
523         rule += ' | doxygen - > /dev/null'
524         bld( name = 'doxygen', rule = rule,
525                 source = 'doc/web.cfg',
526                 target = '../doc/web/html/index.html',
527                 cwd = 'doc')
528         bld.install_files( '${DATAROOTDIR}' + '/doc/libaubio-doc',
529                 bld.path.ant_glob('doc/web/html/**'),
530                 cwd = bld.path.find_dir ('doc/web'),
531                 relative_trick = True)
532
533 def sphinx(bld):
534     # build documentation from source files using sphinx-build
535     # note: build in ../doc/_build/html, otherwise waf wont install unsigned files
536     if bld.env['SPHINX']:
537         bld.env.VERSION = VERSION
538         bld( name = 'sphinx',
539                 rule = '${SPHINX} -b html -D release=${VERSION} -D version=${VERSION} -a -q `dirname ${SRC}` `dirname ${TGT}`',
540                 source = 'doc/conf.py',
541                 target = '../doc/_build/html/index.html')
542         bld.install_files( '${DATAROOTDIR}' + '/doc/libaubio-doc/sphinx',
543                 bld.path.ant_glob('doc/_build/html/**'),
544                 cwd = bld.path.find_dir('doc/_build/html'),
545                 relative_trick = True)
546
547 # register the previous rules as build rules
548 from waflib.Build import BuildContext
549
550 class build_txt2man(BuildContext):
551     cmd = 'txt2man'
552     fun = 'txt2man'
553
554 class build_manpages(BuildContext):
555     cmd = 'manpages'
556     fun = 'txt2man'
557
558 class build_sphinx(BuildContext):
559     cmd = 'sphinx'
560     fun = 'sphinx'
561
562 class build_doxygen(BuildContext):
563     cmd = 'doxygen'
564     fun = 'doxygen'
565
566 def shutdown(bld):
567     from waflib import Logs
568     if bld.options.target_platform in ['ios', 'iosimulator']:
569         msg ='building for %s, contact the author for a commercial license' % bld.options.target_platform
570         Logs.pprint('RED', msg)
571         msg ='   Paul Brossier <piem@aubio.org>'
572         Logs.pprint('RED', msg)
573
574 def dist(ctx):
575     ctx.excl  = ' **/.waf* **/*~ **/*.pyc **/*.swp **/*.swo **/*.swn **/.lock-w* **/.git*'
576     ctx.excl += ' **/build/*'
577     ctx.excl += ' doc/_build'
578     ctx.excl += ' python/demos_*'
579     ctx.excl += ' **/python/gen **/python/build **/python/dist'
580     ctx.excl += ' **/python/ext/config.h'
581     ctx.excl += ' **/python/lib/aubio/_aubio.so'
582     ctx.excl += ' **.egg-info'
583     ctx.excl += ' **/**.zip **/**.tar.bz2'
584     ctx.excl += ' **.tar.bz2'
585     ctx.excl += ' **/doc/full/* **/doc/web/*'
586     ctx.excl += ' **/doc/full.cfg'
587     ctx.excl += ' **/python/*.db'
588     ctx.excl += ' **/python.old/*'
589     ctx.excl += ' **/python/*/*.old'
590     ctx.excl += ' **/python/tests/sounds'
591     ctx.excl += ' **/**.asc'
592     ctx.excl += ' **/dist*'
593     ctx.excl += ' **/.DS_Store'
594     ctx.excl += ' **/.travis.yml'
595     ctx.excl += ' **/.landscape.yml'
596     ctx.excl += ' **/.appveyor.yml'
597     ctx.excl += ' **/circlei.yml'