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