7 # $ ./waf distclean configure build
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/ .
18 from this_version import *
20 VERSION = get_aubio_version()
21 LIB_VERSION = get_libaubio_version()
26 def add_option_enable_disable(ctx, name, default = None,
27 help_str = None, help_disable_str = None):
29 help_str = 'enable ' + name + ' support'
30 if help_disable_str == None:
31 help_disable_str = 'do not ' + help_str
32 ctx.add_option('--enable-' + name, action = 'store_true',
34 dest = 'enable_' + name.replace('-','_'),
36 ctx.add_option('--disable-' + name, action = 'store_false',
38 dest = 'enable_' + name.replace('-','_'),
39 help = help_disable_str )
42 ctx.add_option('--build-type', action = 'store',
44 choices = ('debug', 'release'),
46 help = 'whether to compile with (--build-type=release)' \
47 ' or without (--build-type=debug)' \
48 ' compiler opimizations [default: release]')
49 ctx.add_option('--debug', action = 'store_const',
50 dest = 'build_type', const = 'debug',
51 help = 'build in debug mode (see --build-type)')
52 ctx.add_option('--nodeps', action = 'store_const',
53 dest = 'nodeps', const = 'debug',
54 help = 'build with no external dependencies')
55 add_option_enable_disable(ctx, 'fftw3f', default = False,
56 help_str = 'compile with fftw3f instead of ooura (recommended)',
57 help_disable_str = 'do not compile with fftw3f')
58 add_option_enable_disable(ctx, 'fftw3', default = False,
59 help_str = 'compile with fftw3 instead of ooura',
60 help_disable_str = 'do not compile with fftw3')
61 add_option_enable_disable(ctx, 'intelipp', default = False,
62 help_str = 'use Intel IPP libraries (auto)',
63 help_disable_str = 'do not use Intel IPP libraries')
64 add_option_enable_disable(ctx, 'complex', default = False,
65 help_str ='compile with C99 complex',
66 help_disable_str = 'do not use C99 complex (default)' )
67 add_option_enable_disable(ctx, 'jack', default = None,
68 help_str = 'compile with jack (auto)',
69 help_disable_str = 'disable jack support')
70 add_option_enable_disable(ctx, 'sndfile', default = None,
71 help_str = 'compile with sndfile (auto)',
72 help_disable_str = 'disable sndfile')
73 add_option_enable_disable(ctx, 'avcodec', default = None,
74 help_str = 'compile with libavcodec (auto)',
75 help_disable_str = 'disable libavcodec')
76 add_option_enable_disable(ctx, 'vorbis', default = None,
77 help_str = 'compile with libvorbis (auto)',
78 help_disable_str = 'disable libvorbis')
79 add_option_enable_disable(ctx, 'flac', default = None,
80 help_str = 'compile with libFLAC (auto)',
81 help_disable_str = 'disable libflac')
82 add_option_enable_disable(ctx, 'samplerate', default = None,
83 help_str = 'compile with samplerate (auto)',
84 help_disable_str = 'disable samplerate')
85 add_option_enable_disable(ctx, 'rubberband', default = None,
86 help_str = 'compile with rubberband (auto)',
87 help_disable_str = 'disable rubberband')
88 add_option_enable_disable(ctx, 'memcpy', default = True,
89 help_str = 'use memcpy hacks (default)',
90 help_disable_str = 'do not use memcpy hacks')
91 add_option_enable_disable(ctx, 'double', default = False,
92 help_str = 'compile in double precision mode',
93 help_disable_str = 'compile in single precision mode (default)')
94 add_option_enable_disable(ctx, 'fat', default = False,
95 help_str = 'build fat binaries (darwin only)',
96 help_disable_str = 'do not build fat binaries (default)')
97 add_option_enable_disable(ctx, 'accelerate', default = None,
98 help_str = 'use Accelerate framework (darwin only) (auto)',
99 help_disable_str = 'do not use Accelerate framework')
100 add_option_enable_disable(ctx, 'apple-audio', default = None,
101 help_str = 'use CoreFoundation (darwin only) (auto)',
102 help_disable_str = 'do not use CoreFoundation framework')
103 add_option_enable_disable(ctx, 'blas', default = False,
104 help_str = 'use BLAS acceleration library (no)',
105 help_disable_str = 'do not use BLAS library')
106 add_option_enable_disable(ctx, 'atlas', default = False,
107 help_str = 'use ATLAS acceleration library (no)',
108 help_disable_str = 'do not use ATLAS library')
109 add_option_enable_disable(ctx, 'wavread', default = True,
110 help_str = 'compile with source_wavread (default)',
111 help_disable_str = 'do not compile source_wavread')
112 add_option_enable_disable(ctx, 'wavwrite', default = True,
113 help_str = 'compile with source_wavwrite (default)',
114 help_disable_str = 'do not compile source_wavwrite')
116 add_option_enable_disable(ctx, 'docs', default = None,
117 help_str = 'build documentation (auto)',
118 help_disable_str = 'do not build documentation')
120 add_option_enable_disable(ctx, 'tests', default = True,
121 help_str = 'build tests (true)',
122 help_disable_str = 'do not build or run tests')
124 add_option_enable_disable(ctx, 'examples', default = True,
125 help_str = 'build examples (true)',
126 help_disable_str = 'do not build examples')
128 ctx.add_option('--with-target-platform', type='string',
129 help='set target platform for cross-compilation',
130 dest='target_platform')
132 ctx.load('compiler_c')
133 ctx.load('waf_unit_test')
135 ctx.load('waf_gensyms', tooldir='.')
138 target_platform = sys.platform
139 if ctx.options.target_platform:
140 target_platform = ctx.options.target_platform
142 if ctx.options.nodeps:
155 for d in external_deps:
156 if not hasattr(ctx.options, 'enable_' + d):
157 raise ctx.errors.ConfigurationError ('--enable-%s missing from options' % d)
158 if getattr(ctx.options, 'enable_' + d) == True:
159 msg = 'Option --nodeps can not be used along with --enable-%s' % d
160 raise ctx.errors.ConfigurationError (msg)
161 elif getattr(ctx.options, 'enable_' + d) is None:
162 msg = 'Option --nodeps used but automatic detection with --enable-%s' % d
163 ctx.msg('Warning', msg)
164 setattr(ctx.options, 'enable_' + d, False)
166 from waflib import Options
168 if target_platform=='emscripten':
169 ctx.load('c_emscripten')
171 ctx.load('compiler_c')
173 ctx.load('waf_unit_test')
175 ctx.load('waf_gensyms', tooldir='.')
177 # check for common headers
178 ctx.check(header_name='stdlib.h')
179 ctx.check(header_name='stdio.h')
180 ctx.check(header_name='math.h')
181 ctx.check(header_name='string.h')
182 ctx.check(header_name='errno.h')
183 ctx.check(header_name='limits.h')
184 ctx.check(header_name='stdarg.h')
185 ctx.check(header_name='getopt.h', mandatory = False)
186 ctx.check(header_name='unistd.h', mandatory = False)
188 ctx.env['DEST_OS'] = target_platform
190 if ctx.options.build_type == "debug":
191 ctx.define('DEBUG', 1)
193 ctx.define('NDEBUG', 1)
195 if ctx.env.CC_NAME != 'msvc':
196 if ctx.options.build_type == "debug":
197 # no optimization in debug mode
198 ctx.env.prepend_value('CFLAGS', ['-O0'])
200 if target_platform == 'emscripten':
201 # -Oz for small js file generation
202 ctx.env.prepend_value('CFLAGS', ['-Oz'])
204 # default to -O2 in release mode
205 ctx.env.prepend_value('CFLAGS', ['-O2'])
206 # enable debug symbols and configure warnings
207 ctx.env.prepend_value('CFLAGS', ['-g', '-Wall', '-Wextra'])
209 # enable debug symbols
210 ctx.env.CFLAGS += ['/Z7']
211 # /FS flag available in msvc >= 12 (2013)
212 if 'MSVC_VERSION' in ctx.env and ctx.env.MSVC_VERSION >= 12:
213 ctx.env.CFLAGS += ['/FS']
214 ctx.env.LINKFLAGS += ['/DEBUG', '/INCREMENTAL:NO']
216 ctx.env.CFLAGS += ['/W4', '/D_CRT_SECURE_NO_WARNINGS']
217 # ignore "possible loss of data" warnings
218 ctx.env.CFLAGS += ['/wd4305', '/wd4244', '/wd4245', '/wd4267']
219 # ignore "unreferenced formal parameter" warnings
220 ctx.env.CFLAGS += ['/wd4100']
221 # set optimization level and runtime libs
222 if (ctx.options.build_type == "release"):
223 ctx.env.CFLAGS += ['/Ox']
224 ctx.env.CFLAGS += ['/MD']
226 assert(ctx.options.build_type == "debug")
227 ctx.env.CFLAGS += ['/MDd']
229 ctx.check_cc(lib='m', uselib_store='M', mandatory=False)
231 if target_platform not in ['win32', 'win64']:
232 ctx.env.CFLAGS += ['-fPIC']
234 ctx.define('HAVE_WIN_HACKS', 1)
235 ctx.env['cshlib_PATTERN'] = 'lib%s.dll'
237 if target_platform == 'darwin' and ctx.options.enable_fat:
238 ctx.env.CFLAGS += ['-arch', 'arm64', '-arch', 'x86_64']
239 ctx.env.LINKFLAGS += ['-arch', 'arm64', '-arch', 'x86_64']
241 ctx.env.CFLAGS += [ '-mmacosx-version-min=' + MINSDKVER ]
242 ctx.env.LINKFLAGS += [ '-mmacosx-version-min=' + MINSDKVER ]
244 if target_platform in [ 'darwin', 'ios', 'iosimulator' ]:
245 if (ctx.options.enable_apple_audio != False):
246 ctx.env.FRAMEWORK += ['CoreFoundation', 'AudioToolbox']
247 ctx.define('HAVE_SOURCE_APPLE_AUDIO', 1)
248 ctx.define('HAVE_SINK_APPLE_AUDIO', 1)
249 ctx.msg('Checking for AudioToolbox.framework', 'yes')
251 ctx.msg('Checking for AudioToolbox.framework', 'no (disabled)',
253 if (ctx.options.enable_accelerate != False):
254 ctx.define('HAVE_ACCELERATE', 1)
255 ctx.env.FRAMEWORK += ['Accelerate']
256 ctx.msg('Checking for Accelerate framework', 'yes')
258 ctx.msg('Checking for Accelerate framework', 'no (disabled)',
261 if target_platform in [ 'ios', 'iosimulator', 'watchos', 'watchsimulator' ]:
263 xcodeslct_output = subprocess.check_output (['xcode-select', '--print-path'])
264 XCODEPATH = xcodeslct_output.decode(sys.stdout.encoding).strip()
265 if target_platform == 'ios':
267 elif target_platform == 'iosimulator':
268 SDKNAME = "iPhoneSimulator"
269 elif target_platform == 'watchos':
271 elif target_platform == 'watchsimulator':
272 SDKNAME = "WatchSimulator"
274 raise ctx.errors.ConfigurationError ("Error: unknown target platform '"
275 + target_platform + "'")
276 DEVROOT = "%(XCODEPATH)s/Platforms/%(SDKNAME)s.platform/Developer" % locals()
277 SDKROOT = "%(DEVROOT)s/SDKs/%(SDKNAME)s.sdk" % locals()
278 ctx.env.CFLAGS += ['-std=c99']
279 if ctx.options.enable_apple_audio != False and target_platform.startswith ('ios'):
280 ctx.define('HAVE_AUDIO_UNIT', 1)
281 #ctx.env.FRAMEWORK += ['CoreFoundation', 'AudioToolbox']
282 if target_platform == 'ios':
283 ctx.env.CFLAGS += [ '-fembed-bitcode' ]
284 ctx.env.CFLAGS += [ '-arch', 'arm64' ]
285 ctx.env.CFLAGS += [ '-arch', 'armv7' ]
286 ctx.env.CFLAGS += [ '-arch', 'armv7s' ]
287 ctx.env.LINKFLAGS += [ '-arch', 'arm64' ]
288 ctx.env.LINKFLAGS += ['-arch', 'armv7']
289 ctx.env.LINKFLAGS += ['-arch', 'armv7s']
290 ctx.env.CFLAGS += [ '-miphoneos-version-min=' + MINSDKVER ]
291 ctx.env.LINKFLAGS += [ '-miphoneos-version-min=' + MINSDKVER ]
292 elif target_platform == 'iosimulator':
293 ctx.env.CFLAGS += [ '-arch', 'x86_64' ]
294 ctx.env.CFLAGS += [ '-arch', 'arm64' ]
295 ctx.env.LINKFLAGS += ['-arch', 'x86_64']
296 ctx.env.LINKFLAGS += ['-arch', 'arm64']
297 ctx.env.CFLAGS += [ '-mios-simulator-version-min=' + MINSDKVER ]
298 ctx.env.LINKFLAGS += [ '-mios-simulator-version-min=' + MINSDKVER ]
299 elif target_platform == 'watchos':
300 ctx.env.CFLAGS += [ '-arch', 'armv7' ]
301 ctx.env.CFLAGS += [ '-arch', 'armv7s' ]
302 ctx.env.LINKFLAGS += ['-arch', 'armv7']
303 ctx.env.LINKFLAGS += ['-arch', 'armv7s']
304 ctx.env.CFLAGS += [ '-mwatchos-version-min=' + MINSDKVER ]
305 ctx.env.LINKFLAGS += [ '-mwatchos-version-min=' + MINSDKVER ]
306 elif target_platform == 'watchsimulator':
307 ctx.env.CFLAGS += [ '-arch', 'x86_64' ]
308 ctx.env.CFLAGS += [ '-arch', 'arm64' ]
309 ctx.env.LINKFLAGS += ['-arch', 'x86_64']
310 ctx.env.LINKFLAGS += ['-arch', 'arm64']
311 ctx.env.CFLAGS += [ '-mwatchsimulator-version-min=' + MINSDKVER ]
312 ctx.env.LINKFLAGS += [ '-mwatchsimulator-version-min=' + MINSDKVER ]
313 ctx.env.CFLAGS += [ '-isysroot' , SDKROOT]
314 ctx.env.LINKFLAGS += [ '-isysroot' , SDKROOT]
316 if target_platform == 'emscripten':
317 if ctx.options.build_type == "debug":
318 ctx.env.cshlib_PATTERN = '%s.js'
319 ctx.env.LINKFLAGS += ['-s','ASSERTIONS=2']
320 ctx.env.LINKFLAGS += ['-s','SAFE_HEAP=1']
321 ctx.env.LINKFLAGS += ['-s','ALIASING_FUNCTION_POINTERS=0']
322 ctx.env.LINKFLAGS += ['-O0']
324 ctx.env.LINKFLAGS += ['-Oz']
325 ctx.env.cshlib_PATTERN = '%s.min.js'
327 # doesnt ship file system support in lib
328 ctx.env.LINKFLAGS_cshlib += ['-s', 'NO_FILESYSTEM=1']
329 # put memory file inside generated js files for easier portability
330 ctx.env.LINKFLAGS += ['--memory-init-file', '0']
331 ctx.env.cprogram_PATTERN = "%s.js"
332 ctx.env.cstlib_PATTERN = '%s.a'
334 # tell emscripten functions we want to expose
335 from python.lib.gen_external import get_c_declarations, \
336 get_cpp_objects_from_c_declarations, \
337 get_all_func_names_from_lib, \
338 generate_lib_from_c_declarations
339 # emscripten can't use double
340 c_decls = get_c_declarations(usedouble=False)
341 objects = list(get_cpp_objects_from_c_declarations(c_decls))
342 # ensure that aubio structs are exported
343 objects += ['fvec_t', 'cvec_t', 'fmat_t']
344 lib = generate_lib_from_c_declarations(objects, c_decls)
345 exported_funcnames = get_all_func_names_from_lib(lib)
346 c_mangled_names = ['_' + s for s in exported_funcnames]
347 ctx.env.LINKFLAGS_cshlib += ['-s',
348 'EXPORTED_FUNCTIONS=%s' % c_mangled_names]
350 # check support for C99 __VA_ARGS__ macros
351 check_c99_varargs = '''
353 #define AUBIO_ERR(...) fprintf(stderr, __VA_ARGS__)
356 if ctx.check_cc(fragment = check_c99_varargs,
358 msg = 'Checking for C99 __VA_ARGS__ macro',
360 ctx.define('HAVE_C99_VARARGS_MACROS', 1)
362 # show a message about enable_double status
363 if (ctx.options.enable_double == True):
364 ctx.msg('Checking for size of smpl_t', 'double')
365 ctx.msg('Checking for size of lsmp_t', 'long double')
367 ctx.msg('Checking for size of smpl_t', 'float')
368 ctx.msg('Checking for size of lsmp_t', 'double')
370 # optionally use complex.h
371 if (ctx.options.enable_complex == True):
372 ctx.check(header_name='complex.h')
374 ctx.msg('Checking if complex.h is enabled', 'no')
376 # check for Intel IPP
377 if (ctx.options.enable_intelipp != False):
378 has_ipp_headers = ctx.check(header_name=['ippcore.h', 'ippvm.h',
379 'ipps.h'], mandatory = False)
380 has_ipp_libs = ctx.check(lib=['ippcore', 'ippvm', 'ipps'],
381 uselib_store='INTEL_IPP', mandatory = False)
382 if (has_ipp_headers and has_ipp_libs):
383 ctx.msg('Checking if Intel IPP is available', 'yes')
384 ctx.define('HAVE_INTEL_IPP', 1)
385 if ctx.env.CC_NAME == 'msvc':
386 # force linking multi-threaded static IPP libraries on Windows
388 ctx.define('_IPP_SEQUENTIAL_STATIC', 1)
390 ctx.msg('Checking if Intel IPP is available', 'no')
393 if (ctx.options.enable_fftw3 != False or ctx.options.enable_fftw3f != False):
394 # one of fftwf or fftw3f
395 if (ctx.options.enable_fftw3f != False):
396 ctx.check_cfg(package = 'fftw3f',
397 args = '--cflags --libs fftw3f >= 3.0.0',
398 mandatory = ctx.options.enable_fftw3f)
399 if (ctx.options.enable_double == True):
401 'fftw3f enabled, but compiling in double precision!')
403 # fftw3f disabled, take most sensible one according to
405 if (ctx.options.enable_double == True):
406 ctx.check_cfg(package = 'fftw3',
407 args = '--cflags --libs fftw3 >= 3.0.0.',
408 mandatory = ctx.options.enable_fftw3)
410 ctx.check_cfg(package = 'fftw3f',
411 args = '--cflags --libs fftw3f >= 3.0.0',
412 mandatory = ctx.options.enable_fftw3)
413 ctx.define('HAVE_FFTW3', 1)
415 # fftw not enabled, use vDSP, intelIPP or ooura
416 if 'HAVE_FFTW3F' in ctx.env.define_key:
417 ctx.msg('Checking for FFT implementation', 'fftw3f')
418 elif 'HAVE_FFTW3' in ctx.env.define_key:
419 ctx.msg('Checking for FFT implementation', 'fftw3')
420 elif 'HAVE_ACCELERATE' in ctx.env.define_key:
421 ctx.msg('Checking for FFT implementation', 'vDSP')
422 elif 'HAVE_INTEL_IPP' in ctx.env.define_key:
423 ctx.msg('Checking for FFT implementation', 'Intel IPP')
425 ctx.msg('Checking for FFT implementation', 'ooura')
427 # check for libsndfile
428 if (ctx.options.enable_sndfile != False):
429 ctx.check_cfg(package = 'sndfile',
430 args = '--cflags --libs sndfile >= 1.0.4',
431 mandatory = ctx.options.enable_sndfile)
433 # check for libsamplerate
434 if (ctx.options.enable_double):
435 if (ctx.options.enable_samplerate):
436 ctx.fatal("Could not compile aubio in double precision mode' \
437 ' with libsamplerate")
439 ctx.options.enable_samplerate = False
440 ctx.msg('Checking if using samplerate',
441 'no (disabled in double precision mode)', color = 'YELLOW')
442 if (ctx.options.enable_samplerate != False):
443 ctx.check_cfg(package = 'samplerate',
444 args = '--cflags --libs samplerate >= 0.0.15',
445 mandatory = ctx.options.enable_samplerate)
447 # check for librubberband
448 if (ctx.options.enable_rubberband != False):
449 ctx.check_cfg(package = 'rubberband', atleast_version = '1.3',
450 args = '--cflags --libs',
451 mandatory = ctx.options.enable_rubberband)
454 if (ctx.options.enable_jack != False):
455 ctx.check_cfg(package = 'jack',
456 args = '--cflags --libs',
457 mandatory = ctx.options.enable_jack)
460 if (ctx.options.enable_avcodec != False):
461 ctx.check_cfg(package = 'libavcodec',
462 args = '--cflags --libs libavcodec >= 54.35.0',
463 uselib_store = 'AVCODEC',
464 mandatory = ctx.options.enable_avcodec)
465 ctx.check_cfg(package = 'libavformat',
466 args = '--cflags --libs libavformat >= 52.3.0',
467 uselib_store = 'AVFORMAT',
468 mandatory = ctx.options.enable_avcodec)
469 ctx.check_cfg(package = 'libavutil',
470 args = '--cflags --libs libavutil >= 52.3.0',
471 uselib_store = 'AVUTIL',
472 mandatory = ctx.options.enable_avcodec)
473 ctx.check_cfg(package = 'libswresample',
474 args = '--cflags --libs libswresample >= 1.2.0',
475 uselib_store = 'SWRESAMPLE',
478 msg_check = 'Checking for all libav libraries'
479 if 'HAVE_AVCODEC' not in ctx.env:
480 ctx.msg(msg_check, 'not found (missing avcodec)', color = 'YELLOW')
481 elif 'HAVE_AVFORMAT' not in ctx.env:
482 ctx.msg(msg_check, 'not found (missing avformat)', color = 'YELLOW')
483 elif 'HAVE_AVUTIL' not in ctx.env:
484 ctx.msg(msg_check, 'not found (missing avutil)', color = 'YELLOW')
485 elif 'HAVE_SWRESAMPLE' not in ctx.env :
486 resample_missing = 'not found (missing swresample)'
487 ctx.msg(msg_check, resample_missing, color = 'YELLOW')
489 ctx.msg(msg_check, 'yes')
490 ctx.define('HAVE_LIBAV', 1)
492 # check for vorbisenc
493 if (ctx.options.enable_vorbis != False):
494 ctx.check_cfg(package = 'vorbisenc vorbis ogg',
495 args = '--cflags --libs',
496 uselib_store = 'VORBISENC',
497 mandatory = ctx.options.enable_vorbis)
500 if (ctx.options.enable_flac != False):
501 ctx.check_cfg(package = 'flac',
502 args = '--cflags --libs',
503 uselib_store = 'FLAC',
504 mandatory = ctx.options.enable_flac)
506 if (ctx.options.enable_wavread != False):
507 ctx.define('HAVE_WAVREAD', 1)
508 ctx.msg('Checking if using source_wavread',
509 ctx.options.enable_wavread and 'yes' or 'no')
510 if (ctx.options.enable_wavwrite!= False):
511 ctx.define('HAVE_WAVWRITE', 1)
512 ctx.msg('Checking if using sink_wavwrite',
513 ctx.options.enable_wavwrite and 'yes' or 'no')
516 if (ctx.options.enable_blas != False):
517 ctx.check_cfg(package = 'blas',
518 args = '--cflags --libs',
519 uselib_store='BLAS', mandatory = ctx.options.enable_blas)
520 if 'LIB_BLAS' in ctx.env:
522 if ctx.env['LIBPATH_BLAS']:
523 if 'atlas' in ctx.env['LIBPATH_BLAS'][0]:
524 blas_header = 'atlas/cblas.h'
525 elif 'openblas' in ctx.env['LIBPATH_BLAS'][0]:
526 blas_header = 'openblas/cblas.h'
528 blas_header = 'cblas.h'
529 ctx.check(header_name = blas_header, mandatory =
530 ctx.options.enable_atlas)
533 if (ctx.options.enable_memcpy == True):
534 ctx.define('HAVE_MEMCPY_HACKS', 1)
536 # write configuration header
537 ctx.write_config_header('src/config.h')
539 # the following defines will be passed as arguments to the compiler
540 # instead of being written to src/config.h
541 ctx.define('HAVE_CONFIG_H', 1)
543 # add some defines used in examples
544 ctx.define('AUBIO_PREFIX', ctx.env['PREFIX'])
545 ctx.define('PACKAGE', APPNAME)
547 # double precision mode
548 if (ctx.options.enable_double == True):
549 ctx.define('HAVE_AUBIO_DOUBLE', 1)
551 if (ctx.options.enable_docs != False):
552 # check if txt2man is installed, optional
554 ctx.find_program('txt2man', var='TXT2MAN')
555 except ctx.errors.ConfigurationError:
556 ctx.to_log('txt2man was not found (ignoring)')
558 # check if doxygen is installed, optional
560 ctx.find_program('doxygen', var='DOXYGEN')
561 except ctx.errors.ConfigurationError:
562 ctx.to_log('doxygen was not found (ignoring)')
564 # check if sphinx-build is installed, optional
566 ctx.find_program('sphinx-build', var='SPHINX')
567 except ctx.errors.ConfigurationError:
568 ctx.to_log('sphinx-build was not found (ignoring)')
571 bld.env['VERSION'] = VERSION
572 bld.env['LIB_VERSION'] = LIB_VERSION
577 # add sub directories
578 if bld.env['DEST_OS'] not in ['ios', 'iosimulator', 'watchos', 'watchsimulator', 'android']:
579 if bld.env['DEST_OS']=='emscripten' and not bld.options.testcmd:
580 bld.options.testcmd = 'node %s'
581 if bld.options.enable_examples:
582 bld.recurse('examples')
583 if bld.options.enable_tests:
586 # pkg-config template
587 bld( source = 'aubio.pc.in' )
594 from waflib.Tools import waf_unit_test
595 bld.add_post_fun(waf_unit_test.summary)
596 bld.add_post_fun(waf_unit_test.set_exit_code)
599 # build manpages from txt files using txt2man
600 if bld.env['TXT2MAN']:
601 from waflib import TaskGen
602 if 'MANDIR' not in bld.env:
603 bld.env['MANDIR'] = bld.env['DATAROOTDIR'] + '/man'
604 bld.env.VERSION = VERSION
605 rule_str = '${TXT2MAN} -t `basename ${TGT} | cut -f 1 -d . | tr a-z A-Z`'
606 rule_str += ' -r ${PACKAGE}\\ ${VERSION} -P ${PACKAGE}'
607 rule_str += ' -v ${PACKAGE}\\ User\\\'s\\ manual'
608 rule_str += ' -s 1 ${SRC} > ${TGT}'
609 TaskGen.declare_chain(
615 install_path = '${MANDIR}/man1',
617 bld( source = bld.path.ant_glob('doc/*.txt') )
620 # build documentation from source files using doxygen
621 if bld.env['DOXYGEN']:
622 bld.env.VERSION = VERSION
623 rule = '( cat ${SRC[0]} && echo PROJECT_NUMBER=${VERSION}'
624 rule += ' && echo OUTPUT_DIRECTORY=%s && echo HTML_OUTPUT=%s )'
625 rule += ' | doxygen - > /dev/null'
626 rule %= (os.path.abspath(out), 'api')
627 bld( name = 'doxygen', rule = rule,
628 source = ['doc/web.cfg']
629 + bld.path.find_dir('src').ant_glob('**/*.h'),
630 target = bld.path.find_or_declare('api/index.html'),
631 cwd = bld.path.find_dir('doc'))
632 # evaluate nodes lazily to prevent build directory traversal warnings
633 bld.install_files('${DATAROOTDIR}/doc/libaubio-doc/api',
634 bld.path.find_or_declare('api').ant_glob('**/*',
635 generator=True), cwd=bld.path.find_or_declare('api'),
639 # build documentation from source files using sphinx-build
644 from waflib import Logs
645 Logs.pprint('YELLOW', "Sphinx manual: install aubio first")
647 if bld.env['SPHINX'] and has_aubio:
648 bld.env.VERSION = VERSION
649 rule = '${SPHINX} -b html -D release=${VERSION}' \
650 ' -D version=${VERSION} -W -a -q' \
651 ' -d %s ' % os.path.join(os.path.abspath(out), 'doctrees')
652 rule += ' . %s' % os.path.join(os.path.abspath(out), 'manual')
653 bld( name = 'sphinx', rule = rule,
654 cwd = bld.path.find_dir('doc'),
655 source = bld.path.find_dir('doc').ant_glob('*.rst'),
656 target = bld.path.find_or_declare('manual/index.html'))
657 # evaluate nodes lazily to prevent build directory traversal warnings
658 bld.install_files('${DATAROOTDIR}/doc/libaubio-doc/manual',
659 bld.path.find_or_declare('manual').ant_glob('**/*',
660 generator=True), cwd=bld.path.find_or_declare('manual'),
663 # register the previous rules as build rules
664 from waflib.Build import BuildContext
666 class build_txt2man(BuildContext):
670 class build_manpages(BuildContext):
674 class build_sphinx(BuildContext):
678 class build_doxygen(BuildContext):
683 from waflib import Logs
684 if bld.options.target_platform in ['ios', 'iosimulator']:
685 msg ='building for %s, contact the author for a commercial license' \
686 % bld.options.target_platform
687 Logs.pprint('RED', msg)
688 msg =' Paul Brossier <piem@aubio.org>'
689 Logs.pprint('RED', msg)
692 ctx.excl = ' **/.waf*'
693 ctx.excl += ' **/.git*'
694 ctx.excl += ' **/*~ **/*.pyc **/*.swp **/*.swo **/*.swn **/.lock-w*'
695 ctx.excl += ' **/build/*'
696 ctx.excl += ' doc/_build'
697 ctx.excl += ' python/demos_*'
698 ctx.excl += ' **/python/gen **/python/build **/python/dist'
699 ctx.excl += ' **/python/ext/config.h'
700 ctx.excl += ' **/python/lib/aubio/_aubio.so'
701 ctx.excl += ' **.egg-info'
702 ctx.excl += ' **/.eggs'
703 ctx.excl += ' **/.pytest_cache'
704 ctx.excl += ' **/.cache'
705 ctx.excl += ' **/**.zip **/**.tar.bz2'
706 ctx.excl += ' **.tar.bz2**'
707 ctx.excl += ' **/doc/full/* **/doc/web/*'
708 ctx.excl += ' **/doc/full.cfg'
709 ctx.excl += ' **/python/*.db'
710 ctx.excl += ' **/python.old/*'
711 ctx.excl += ' **/python/*/*.old'
712 ctx.excl += ' **/python/lib/aubio/*.so'
713 ctx.excl += ' **/python/tests/sounds'
714 ctx.excl += ' **/**.asc'
715 ctx.excl += ' **/dist*'
716 ctx.excl += ' **/.DS_Store'
717 ctx.excl += ' **/.travis.yml'
718 ctx.excl += ' **/.appveyor.yml'
719 ctx.excl += ' **/.circleci/*'
720 ctx.excl += ' **/azure-pipelines.yml'
721 ctx.excl += ' **/.coverage*'