[py] remove empty init files
[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, 'blas', default = False,
87             help_str = 'use BLAS acceleration library (no)',
88             help_disable_str = 'do not use BLAS library')
89     add_option_enable_disable(ctx, 'atlas', default = False,
90             help_str = 'use ATLAS acceleration library (no)',
91             help_disable_str = 'do not use ATLAS library')
92     add_option_enable_disable(ctx, 'wavread', default = True,
93             help_str = 'compile with source_wavread (default)',
94             help_disable_str = 'do not compile source_wavread')
95     add_option_enable_disable(ctx, 'wavwrite', default = True,
96             help_str = 'compile with source_wavwrite (default)',
97             help_disable_str = 'do not compile source_wavwrite')
98
99     add_option_enable_disable(ctx, 'docs', default = None,
100             help_str = 'build documentation (auto)',
101             help_disable_str = 'do not build documentation')
102
103     add_option_enable_disable(ctx, 'tests', default = True,
104             help_str = 'build tests (true)',
105             help_disable_str = 'do not build or run tests')
106
107     add_option_enable_disable(ctx, 'examples', default = True,
108             help_str = 'build examples (true)',
109             help_disable_str = 'do not build examples')
110
111     ctx.add_option('--with-target-platform', type='string',
112             help='set target platform for cross-compilation', dest='target_platform')
113
114     ctx.load('compiler_c')
115     ctx.load('waf_unit_test')
116     ctx.load('gnu_dirs')
117     ctx.load('waf_gensyms', tooldir='.')
118
119 def configure(ctx):
120     target_platform = sys.platform
121     if ctx.options.target_platform:
122         target_platform = ctx.options.target_platform
123
124     from waflib import Options
125
126     if target_platform=='emscripten':
127         ctx.load('c_emscripten')
128     else:
129         ctx.load('compiler_c')
130
131     ctx.load('waf_unit_test')
132     ctx.load('gnu_dirs')
133     ctx.load('waf_gensyms', tooldir='.')
134
135     # check for common headers
136     ctx.check(header_name='stdlib.h')
137     ctx.check(header_name='stdio.h')
138     ctx.check(header_name='math.h')
139     ctx.check(header_name='string.h')
140     ctx.check(header_name='limits.h')
141     ctx.check(header_name='stdarg.h')
142     ctx.check(header_name='getopt.h', mandatory = False)
143     ctx.check(header_name='unistd.h', mandatory = False)
144
145     ctx.env['DEST_OS'] = target_platform
146
147     if ctx.options.build_type == "debug":
148         ctx.define('DEBUG', 1)
149     else:
150         ctx.define('NDEBUG', 1)
151
152     if ctx.env.CC_NAME != 'msvc':
153         if ctx.options.build_type == "debug":
154             # no optimization in debug mode
155             ctx.env.prepend_value('CFLAGS', ['-O0'])
156         else:
157             if target_platform == 'emscripten':
158                 # -Oz for small js file generation
159                 ctx.env.prepend_value('CFLAGS', ['-Oz'])
160             else:
161                 # default to -O2 in release mode
162                 ctx.env.prepend_value('CFLAGS', ['-O2'])
163         # enable debug symbols and configure warnings
164         ctx.env.prepend_value('CFLAGS', ['-g', '-Wall', '-Wextra'])
165     else:
166         # enable debug symbols
167         ctx.env.CFLAGS += ['/Z7']
168         # /FS flag available in msvc >= 12 (2013)
169         if 'MSVC_VERSION' in ctx.env and ctx.env.MSVC_VERSION >= 12:
170             ctx.env.CFLAGS += ['/FS']
171         ctx.env.LINKFLAGS += ['/DEBUG', '/INCREMENTAL:NO']
172         # configure warnings
173         ctx.env.CFLAGS += ['/W4', '/D_CRT_SECURE_NO_WARNINGS']
174         # ignore "possible loss of data" warnings
175         ctx.env.CFLAGS += ['/wd4305', '/wd4244', '/wd4245', '/wd4267']
176         # ignore "unreferenced formal parameter" warnings
177         ctx.env.CFLAGS += ['/wd4100']
178         # set optimization level and runtime libs
179         if (ctx.options.build_type == "release"):
180             ctx.env.CFLAGS += ['/Ox']
181             ctx.env.CFLAGS += ['/MD']
182         else:
183             assert(ctx.options.build_type == "debug")
184             ctx.env.CFLAGS += ['/MDd']
185
186     ctx.check_cc(lib='m', uselib_store='M', mandatory=False)
187
188     if target_platform not in ['win32', 'win64']:
189         ctx.env.CFLAGS += ['-fPIC']
190     else:
191         ctx.define('HAVE_WIN_HACKS', 1)
192         ctx.env['cshlib_PATTERN'] = 'lib%s.dll'
193
194     if target_platform == 'darwin' and ctx.options.enable_fat:
195         ctx.env.CFLAGS += ['-arch', 'i386', '-arch', 'x86_64']
196         ctx.env.LINKFLAGS += ['-arch', 'i386', '-arch', 'x86_64']
197         MINSDKVER="10.4"
198         ctx.env.CFLAGS += [ '-mmacosx-version-min=' + MINSDKVER ]
199         ctx.env.LINKFLAGS += [ '-mmacosx-version-min=' + MINSDKVER ]
200
201     if target_platform in [ 'darwin', 'ios', 'iosimulator']:
202         if (ctx.options.enable_apple_audio != False):
203             ctx.env.FRAMEWORK += ['CoreFoundation', 'AudioToolbox']
204             ctx.define('HAVE_SOURCE_APPLE_AUDIO', 1)
205             ctx.define('HAVE_SINK_APPLE_AUDIO', 1)
206             ctx.msg('Checking for AudioToolbox.framework', 'yes')
207         else:
208             ctx.msg('Checking for AudioToolbox.framework', 'no (disabled)', color = 'YELLOW')
209         if (ctx.options.enable_accelerate != False):
210             ctx.define('HAVE_ACCELERATE', 1)
211             ctx.env.FRAMEWORK += ['Accelerate']
212             ctx.msg('Checking for Accelerate framework', 'yes')
213         else:
214             ctx.msg('Checking for Accelerate framework', 'no (disabled)', color = 'YELLOW')
215
216     if target_platform in [ 'ios', 'iosimulator' ]:
217         MINSDKVER="6.1"
218         ctx.env.CFLAGS += ['-std=c99']
219         if (ctx.options.enable_apple_audio != False):
220             ctx.define('HAVE_AUDIO_UNIT', 1)
221             #ctx.env.FRAMEWORK += ['CoreFoundation', 'AudioToolbox']
222         if target_platform == 'ios':
223             DEVROOT = "/Applications/Xcode.app/Contents"
224             DEVROOT += "/Developer/Platforms/iPhoneOS.platform/Developer"
225             SDKROOT = "%(DEVROOT)s/SDKs/iPhoneOS.sdk" % locals()
226             ctx.env.CFLAGS += [ '-fembed-bitcode' ]
227             ctx.env.CFLAGS += [ '-arch', 'arm64' ]
228             ctx.env.CFLAGS += [ '-arch', 'armv7' ]
229             ctx.env.CFLAGS += [ '-arch', 'armv7s' ]
230             ctx.env.LINKFLAGS += [ '-arch', 'arm64' ]
231             ctx.env.LINKFLAGS += ['-arch', 'armv7']
232             ctx.env.LINKFLAGS += ['-arch', 'armv7s']
233             ctx.env.CFLAGS += [ '-miphoneos-version-min=' + MINSDKVER ]
234             ctx.env.LINKFLAGS += [ '-miphoneos-version-min=' + MINSDKVER ]
235         else:
236             DEVROOT = "/Applications/Xcode.app/Contents"
237             DEVROOT += "/Developer/Platforms/iPhoneSimulator.platform/Developer"
238             SDKROOT = "%(DEVROOT)s/SDKs/iPhoneSimulator.sdk" % locals()
239             ctx.env.CFLAGS += [ '-arch', 'i386' ]
240             ctx.env.CFLAGS += [ '-arch', 'x86_64' ]
241             ctx.env.LINKFLAGS += ['-arch', 'i386']
242             ctx.env.LINKFLAGS += ['-arch', 'x86_64']
243             ctx.env.CFLAGS += [ '-mios-simulator-version-min=' + MINSDKVER ]
244             ctx.env.LINKFLAGS += [ '-mios-simulator-version-min=' + MINSDKVER ]
245         ctx.env.CFLAGS += [ '-isysroot' , SDKROOT]
246         ctx.env.LINKFLAGS += [ '-isysroot' , SDKROOT]
247
248     if target_platform == 'emscripten':
249         if ctx.options.build_type == "debug":
250             ctx.env.cshlib_PATTERN = '%s.js'
251             ctx.env.LINKFLAGS += ['-s','ASSERTIONS=2']
252             ctx.env.LINKFLAGS += ['-s','SAFE_HEAP=1']
253             ctx.env.LINKFLAGS += ['-s','ALIASING_FUNCTION_POINTERS=0']
254             ctx.env.LINKFLAGS += ['-O0']
255         else:
256             ctx.env.LINKFLAGS += ['-Oz']
257             ctx.env.cshlib_PATTERN = '%s.min.js'
258
259         # doesnt ship file system support in lib
260         ctx.env.LINKFLAGS_cshlib += ['-s', 'NO_FILESYSTEM=1']
261         # put memory file inside generated js files for easier portability
262         ctx.env.LINKFLAGS += ['--memory-init-file', '0']
263         ctx.env.cprogram_PATTERN = "%s.js"
264         ctx.env.cstlib_PATTERN = '%s.a'
265
266         # tell emscripten functions we want to expose
267         from python.lib.gen_external import get_c_declarations, \
268                 get_cpp_objects_from_c_declarations, get_all_func_names_from_lib, \
269                 generate_lib_from_c_declarations
270         c_decls = get_c_declarations(usedouble=False)  # emscripten can't use double
271         objects = list(get_cpp_objects_from_c_declarations(c_decls))
272         # ensure that aubio structs are exported
273         objects += ['fvec_t', 'cvec_t', 'fmat_t']
274         lib = generate_lib_from_c_declarations(objects, c_decls)
275         exported_funcnames = get_all_func_names_from_lib(lib)
276         c_mangled_names = ['_' + s for s in exported_funcnames]
277         ctx.env.LINKFLAGS_cshlib += ['-s', 'EXPORTED_FUNCTIONS=%s' % c_mangled_names]
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 BLAS/ATLAS
430     if (ctx.options.enable_blas != False):
431         ctx.check_cfg(package = 'blas',
432                 args = '--cflags --libs',
433                 uselib_store='BLAS', mandatory = ctx.options.enable_blas)
434         if 'LIB_BLAS' in ctx.env:
435             blas_header = None
436             if ctx.env['LIBPATH_BLAS']:
437                 if 'atlas' in ctx.env['LIBPATH_BLAS'][0]:
438                     blas_header = 'atlas/cblas.h'
439                 elif 'openblas' in ctx.env['LIBPATH_BLAS'][0]:
440                     blas_header = 'openblas/cblas.h'
441             else:
442                 blas_header = 'cblas.h'
443             ctx.check(header_name = blas_header, mandatory =
444                     ctx.options.enable_atlas)
445
446     # use memcpy hacks
447     if (ctx.options.enable_memcpy == True):
448         ctx.define('HAVE_MEMCPY_HACKS', 1)
449
450     # write configuration header
451     ctx.write_config_header('src/config.h')
452
453     # the following defines will be passed as arguments to the compiler
454     # instead of being written to src/config.h
455     ctx.define('HAVE_CONFIG_H', 1)
456
457     # add some defines used in examples
458     ctx.define('AUBIO_PREFIX', ctx.env['PREFIX'])
459     ctx.define('PACKAGE', APPNAME)
460
461     # double precision mode
462     if (ctx.options.enable_double == True):
463         ctx.define('HAVE_AUBIO_DOUBLE', 1)
464
465     if (ctx.options.enable_docs != False):
466         # check if txt2man is installed, optional
467         try:
468           ctx.find_program('txt2man', var='TXT2MAN')
469         except ctx.errors.ConfigurationError:
470           ctx.to_log('txt2man was not found (ignoring)')
471
472         # check if doxygen is installed, optional
473         try:
474           ctx.find_program('doxygen', var='DOXYGEN')
475         except ctx.errors.ConfigurationError:
476           ctx.to_log('doxygen was not found (ignoring)')
477
478         # check if sphinx-build is installed, optional
479         try:
480           ctx.find_program('sphinx-build', var='SPHINX')
481         except ctx.errors.ConfigurationError:
482           ctx.to_log('sphinx-build was not found (ignoring)')
483
484 def build(bld):
485     bld.env['VERSION'] = VERSION
486     bld.env['LIB_VERSION'] = LIB_VERSION
487
488     # main source
489     bld.recurse('src')
490
491     # add sub directories
492     if bld.env['DEST_OS'] not in ['ios', 'iosimulator', 'android']:
493         if bld.env['DEST_OS']=='emscripten' and not bld.options.testcmd:
494             bld.options.testcmd = 'node %s'
495         if bld.options.enable_examples:
496             bld.recurse('examples')
497         if bld.options.enable_tests:
498             bld.recurse('tests')
499
500     # pkg-config template
501     bld( source = 'aubio.pc.in' )
502
503     # documentation
504     txt2man(bld)
505     doxygen(bld)
506     sphinx(bld)
507
508 def txt2man(bld):
509     # build manpages from txt files using txt2man
510     if bld.env['TXT2MAN']:
511         from waflib import TaskGen
512         if 'MANDIR' not in bld.env:
513             bld.env['MANDIR'] = bld.env['DATAROOTDIR'] + '/man'
514         bld.env.VERSION = VERSION
515         rule_str = '${TXT2MAN} -t `basename ${TGT} | cut -f 1 -d . | tr a-z A-Z`'
516         rule_str += ' -r ${PACKAGE}\\ ${VERSION} -P ${PACKAGE}'
517         rule_str += ' -v ${PACKAGE}\\ User\\\'s\\ manual'
518         rule_str += ' -s 1 ${SRC} > ${TGT}'
519         TaskGen.declare_chain(
520                 name      = 'txt2man',
521                 rule      = rule_str,
522                 ext_in    = '.txt',
523                 ext_out   = '.1',
524                 reentrant = False,
525                 install_path =  '${MANDIR}/man1',
526                 )
527         bld( source = bld.path.ant_glob('doc/*.txt') )
528
529 def doxygen(bld):
530     # build documentation from source files using doxygen
531     if bld.env['DOXYGEN']:
532         bld.env.VERSION = VERSION
533         rule = '( cat ${SRC} && echo PROJECT_NUMBER=${VERSION}; )'
534         rule += ' | doxygen - > /dev/null'
535         bld( name = 'doxygen', rule = rule,
536                 source = 'doc/web.cfg',
537                 target = '../doc/web/html/index.html',
538                 cwd = 'doc')
539         bld.install_files( '${DATAROOTDIR}' + '/doc/libaubio-doc',
540                 bld.path.ant_glob('doc/web/html/**'),
541                 cwd = bld.path.find_dir ('doc/web'),
542                 relative_trick = True)
543
544 def sphinx(bld):
545     # build documentation from source files using sphinx-build
546     # note: build in ../doc/_build/html, otherwise waf wont install unsigned files
547     if bld.env['SPHINX']:
548         bld.env.VERSION = VERSION
549         bld( name = 'sphinx',
550                 rule = '${SPHINX} -b html -D release=${VERSION} -D version=${VERSION} -a -q `dirname ${SRC}` `dirname ${TGT}`',
551                 source = 'doc/conf.py',
552                 target = '../doc/_build/html/index.html')
553         bld.install_files( '${DATAROOTDIR}' + '/doc/libaubio-doc/sphinx',
554                 bld.path.ant_glob('doc/_build/html/**'),
555                 cwd = bld.path.find_dir('doc/_build/html'),
556                 relative_trick = True)
557
558 # register the previous rules as build rules
559 from waflib.Build import BuildContext
560
561 class build_txt2man(BuildContext):
562     cmd = 'txt2man'
563     fun = 'txt2man'
564
565 class build_manpages(BuildContext):
566     cmd = 'manpages'
567     fun = 'txt2man'
568
569 class build_sphinx(BuildContext):
570     cmd = 'sphinx'
571     fun = 'sphinx'
572
573 class build_doxygen(BuildContext):
574     cmd = 'doxygen'
575     fun = 'doxygen'
576
577 def shutdown(bld):
578     from waflib import Logs
579     if bld.options.target_platform in ['ios', 'iosimulator']:
580         msg ='building for %s, contact the author for a commercial license' % bld.options.target_platform
581         Logs.pprint('RED', msg)
582         msg ='   Paul Brossier <piem@aubio.org>'
583         Logs.pprint('RED', msg)
584
585 def dist(ctx):
586     ctx.excl  = ' **/.waf* **/*~ **/*.pyc **/*.swp **/*.swo **/*.swn **/.lock-w* **/.git*'
587     ctx.excl += ' **/build/*'
588     ctx.excl += ' doc/_build'
589     ctx.excl += ' python/demos_*'
590     ctx.excl += ' **/python/gen **/python/build **/python/dist'
591     ctx.excl += ' **/python/ext/config.h'
592     ctx.excl += ' **/python/lib/aubio/_aubio.so'
593     ctx.excl += ' **.egg-info'
594     ctx.excl += ' **/**.zip **/**.tar.bz2'
595     ctx.excl += ' **.tar.bz2'
596     ctx.excl += ' **/doc/full/* **/doc/web/*'
597     ctx.excl += ' **/doc/full.cfg'
598     ctx.excl += ' **/python/*.db'
599     ctx.excl += ' **/python.old/*'
600     ctx.excl += ' **/python/*/*.old'
601     ctx.excl += ' **/python/tests/sounds'
602     ctx.excl += ' **/**.asc'
603     ctx.excl += ' **/dist*'
604     ctx.excl += ' **/.DS_Store'
605     ctx.excl += ' **/.travis.yml'
606     ctx.excl += ' **/.landscape.yml'
607     ctx.excl += ' **/.appveyor.yml'
608     ctx.excl += ' **/.circleci/*'
609     ctx.excl += ' **/azure-pipelines.yml'
610     ctx.excl += ' **/.coveragerc'