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/ .
17 from this_version import *
19 VERSION = get_aubio_version()
20 LIB_VERSION = get_libaubio_version()
25 def add_option_enable_disable(ctx, name, default = None,
26 help_str = None, help_disable_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',
33 dest = 'enable_' + name.replace('-','_'),
35 ctx.add_option('--disable-' + name, action = 'store_false',
37 dest = 'enable_' + name.replace('-','_'),
38 help = help_disable_str )
41 ctx.add_option('--build-type', action = 'store',
43 choices = ('debug', 'release'),
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, 'complex', default = False,
54 help_str ='compile with C99 complex',
55 help_disable_str = 'do not use C99 complex (default)' )
56 add_option_enable_disable(ctx, 'jack', default = None,
57 help_str = 'compile with jack (auto)',
58 help_disable_str = 'disable jack support')
59 add_option_enable_disable(ctx, 'sndfile', default = None,
60 help_str = 'compile with sndfile (auto)',
61 help_disable_str = 'disable sndfile')
62 add_option_enable_disable(ctx, 'avcodec', default = None,
63 help_str = 'compile with libavcodec (auto)',
64 help_disable_str = 'disable libavcodec')
65 add_option_enable_disable(ctx, 'samplerate', default = None,
66 help_str = 'compile with samplerate (auto)',
67 help_disable_str = 'disable samplerate')
68 add_option_enable_disable(ctx, 'memcpy', default = True,
69 help_str = 'use memcpy hacks (default)',
70 help_disable_str = 'do not use memcpy hacks')
71 add_option_enable_disable(ctx, 'double', default = False,
72 help_str = 'compile in double precision mode',
73 help_disable_str = 'compile in single precision mode (default)')
74 add_option_enable_disable(ctx, 'fat', default = False,
75 help_str = 'build fat binaries (darwin only)',
76 help_disable_str = 'do not build fat binaries (default)')
77 add_option_enable_disable(ctx, 'accelerate', default = None,
78 help_str = 'use Accelerate framework (darwin only) (auto)',
79 help_disable_str = 'do not use Accelerate framework')
80 add_option_enable_disable(ctx, 'apple-audio', default = None,
81 help_str = 'use CoreFoundation (darwin only) (auto)',
82 help_disable_str = 'do not use CoreFoundation framework')
83 add_option_enable_disable(ctx, 'atlas', default = False,
84 help_str = 'use Atlas library (no)',
85 help_disable_str = 'do not use Atlas library')
86 add_option_enable_disable(ctx, 'wavread', default = True,
87 help_str = 'compile with source_wavread (default)',
88 help_disable_str = 'do not compile source_wavread')
89 add_option_enable_disable(ctx, 'wavwrite', default = True,
90 help_str = 'compile with source_wavwrite (default)',
91 help_disable_str = 'do not compile source_wavwrite')
93 add_option_enable_disable(ctx, 'docs', default = None,
94 help_str = 'build documentation (auto)',
95 help_disable_str = 'do not build documentation')
97 ctx.add_option('--with-target-platform', type='string',
98 help='set target platform for cross-compilation', dest='target_platform')
100 ctx.load('compiler_c')
101 ctx.load('waf_unit_test')
105 from waflib import Options
106 ctx.load('compiler_c')
107 ctx.load('waf_unit_test')
110 target_platform = sys.platform
111 if ctx.options.target_platform:
112 target_platform = ctx.options.target_platform
115 if target_platform=='emscripten':
116 # need to force spaces between flag -o and path
118 # https://github.com/waf-project/waf/blob/master/waflib/extras/c_emscripten.py (#1885)
119 # (OSX /emscripten 1.37.9)
120 ctx.env.CC_TGT_F = ['-c', '-o', '']
121 ctx.env.CCLNK_TGT_F = ['-o', '']
122 # check for common headers
123 ctx.check(header_name='stdlib.h')
124 ctx.check(header_name='stdio.h')
125 ctx.check(header_name='math.h')
126 ctx.check(header_name='string.h')
127 ctx.check(header_name='limits.h')
128 ctx.check(header_name='stdarg.h')
129 ctx.check(header_name='getopt.h', mandatory = False)
130 ctx.check(header_name='unistd.h', mandatory = False)
132 ctx.env['DEST_OS'] = target_platform
134 if ctx.options.build_type == "debug":
135 ctx.define('DEBUG', 1)
137 ctx.define('NDEBUG', 1)
139 if ctx.env.CC_NAME != 'msvc':
140 if ctx.options.build_type == "debug":
141 # no optimization in debug mode
142 ctx.env.prepend_value('CFLAGS', ['-O0'])
144 if target_platform == 'emscripten':
145 # -Oz for small js file generation
146 ctx.env.prepend_value('CFLAGS', ['-Oz'])
148 # default to -O2 in release mode
149 ctx.env.prepend_value('CFLAGS', ['-O2'])
150 # enable debug symbols and configure warnings
151 ctx.env.prepend_value('CFLAGS', ['-g', '-Wall', '-Wextra'])
153 # enable debug symbols
154 ctx.env.CFLAGS += ['/Z7', '/FS']
155 ctx.env.LINKFLAGS += ['/DEBUG', '/INCREMENTAL:NO']
157 ctx.env.CFLAGS += ['/W4', '/D_CRT_SECURE_NO_WARNINGS']
158 # set optimization level and runtime libs
159 if (ctx.options.build_type == "release"):
160 ctx.env.CFLAGS += ['/Ox']
161 ctx.env.CFLAGS += ['/MD']
163 assert(ctx.options.build_type == "debug")
164 ctx.env.CFLAGS += ['/MDd']
166 ctx.check_cc(lib='m', uselib_store='M', mandatory=False)
168 if target_platform not in ['win32', 'win64']:
169 ctx.env.CFLAGS += ['-fPIC']
171 ctx.define('HAVE_WIN_HACKS', 1)
172 ctx.env['cshlib_PATTERN'] = 'lib%s.dll'
174 if target_platform == 'darwin' and ctx.options.enable_fat:
175 ctx.env.CFLAGS += ['-arch', 'i386', '-arch', 'x86_64']
176 ctx.env.LINKFLAGS += ['-arch', 'i386', '-arch', 'x86_64']
178 ctx.env.CFLAGS += [ '-mmacosx-version-min=' + MINSDKVER ]
179 ctx.env.LINKFLAGS += [ '-mmacosx-version-min=' + MINSDKVER ]
181 if target_platform in [ 'darwin', 'ios', 'iosimulator']:
182 if (ctx.options.enable_apple_audio != False):
183 ctx.env.FRAMEWORK += ['CoreFoundation', 'AudioToolbox']
184 ctx.define('HAVE_SOURCE_APPLE_AUDIO', 1)
185 ctx.define('HAVE_SINK_APPLE_AUDIO', 1)
186 ctx.msg('Checking for AudioToolbox.framework', 'yes')
188 ctx.msg('Checking for AudioToolbox.framework', 'no (disabled)', color = 'YELLOW')
189 if (ctx.options.enable_accelerate != False):
190 ctx.define('HAVE_ACCELERATE', 1)
191 ctx.env.FRAMEWORK += ['Accelerate']
192 ctx.msg('Checking for Accelerate framework', 'yes')
194 ctx.msg('Checking for Accelerate framework', 'no (disabled)', color = 'YELLOW')
196 if target_platform in [ 'ios', 'iosimulator' ]:
198 ctx.env.CFLAGS += ['-std=c99']
199 if (ctx.options.enable_apple_audio != False):
200 ctx.define('HAVE_AUDIO_UNIT', 1)
201 #ctx.env.FRAMEWORK += ['CoreFoundation', 'AudioToolbox']
202 if target_platform == 'ios':
203 DEVROOT = "/Applications/Xcode.app/Contents"
204 DEVROOT += "/Developer/Platforms/iPhoneOS.platform/Developer"
205 SDKROOT = "%(DEVROOT)s/SDKs/iPhoneOS.sdk" % locals()
206 ctx.env.CFLAGS += [ '-fembed-bitcode' ]
207 ctx.env.CFLAGS += [ '-arch', 'arm64' ]
208 ctx.env.CFLAGS += [ '-arch', 'armv7' ]
209 ctx.env.CFLAGS += [ '-arch', 'armv7s' ]
210 ctx.env.LINKFLAGS += [ '-arch', 'arm64' ]
211 ctx.env.LINKFLAGS += ['-arch', 'armv7']
212 ctx.env.LINKFLAGS += ['-arch', 'armv7s']
213 ctx.env.CFLAGS += [ '-miphoneos-version-min=' + MINSDKVER ]
214 ctx.env.LINKFLAGS += [ '-miphoneos-version-min=' + MINSDKVER ]
216 DEVROOT = "/Applications/Xcode.app/Contents"
217 DEVROOT += "/Developer/Platforms/iPhoneSimulator.platform/Developer"
218 SDKROOT = "%(DEVROOT)s/SDKs/iPhoneSimulator.sdk" % locals()
219 ctx.env.CFLAGS += [ '-arch', 'i386' ]
220 ctx.env.CFLAGS += [ '-arch', 'x86_64' ]
221 ctx.env.LINKFLAGS += ['-arch', 'i386']
222 ctx.env.LINKFLAGS += ['-arch', 'x86_64']
223 ctx.env.CFLAGS += [ '-mios-simulator-version-min=' + MINSDKVER ]
224 ctx.env.LINKFLAGS += [ '-mios-simulator-version-min=' + MINSDKVER ]
225 ctx.env.CFLAGS += [ '-isysroot' , SDKROOT]
226 ctx.env.LINKFLAGS += [ '-isysroot' , SDKROOT]
228 if target_platform == 'emscripten':
230 ctx.env.CFLAGS += [ '-I' + os.path.join(os.environ['EMSCRIPTEN'], 'system', 'include') ]
232 if ctx.options.build_type == "debug":
233 ctx.env.cshlib_PATTERN = '%s.js'
234 ctx.env.LINKFLAGS += ['-s','ASSERTIONS=2']
235 ctx.env.LINKFLAGS += ['-s','SAFE_HEAP=1']
236 ctx.env.LINKFLAGS += ['-s','ALIASING_FUNCTION_POINTERS=0']
237 ctx.env.LINKFLAGS += ['-O0']
239 ctx.env.LINKFLAGS += ['-Oz']
240 ctx.env.cshlib_PATTERN = '%s.min.js'
242 # doesnt ship file system support in lib
243 ctx.env.LINKFLAGS_cshlib += ['-s', 'NO_FILESYSTEM=1']
244 # put memory file inside generated js files for easier portability
245 ctx.env.LINKFLAGS += ['--memory-init-file', '0']
246 ctx.env.cprogram_PATTERN = "%s.js"
247 ctx.env.cstlib_PATTERN = '%s.a'
249 # tell emscripten functions we want to expose
250 from python.lib.gen_external import get_c_declarations, get_cpp_objects_from_c_declarations, get_all_func_names_from_lib, generate_lib_from_c_declarations
251 c_decls = get_c_declarations(usedouble=False) # emscripten can't use double
252 objects = get_cpp_objects_from_c_declarations(c_decls)
253 # ensure that aubio structs are exported
254 objects += ['fvec_t', 'cvec_t', 'fmat_t']
255 lib = generate_lib_from_c_declarations(objects, c_decls)
256 exported_funcnames = get_all_func_names_from_lib(lib)
257 c_mangled_names = ['_' + s for s in exported_funcnames]
258 ctx.env.LINKFLAGS_cshlib += ['-s', 'EXPORTED_FUNCTIONS=%s' % c_mangled_names]
260 if (ctx.options.enable_atlas != True):
261 ctx.options.enable_atlas = False
263 # check support for C99 __VA_ARGS__ macros
264 check_c99_varargs = '''
266 #define AUBIO_ERR(...) fprintf(stderr, __VA_ARGS__)
269 if ctx.check_cc(fragment = check_c99_varargs,
271 msg = 'Checking for C99 __VA_ARGS__ macro',
273 ctx.define('HAVE_C99_VARARGS_MACROS', 1)
275 # show a message about enable_double status
276 if (ctx.options.enable_double == True):
277 ctx.msg('Checking for size of smpl_t', 'double')
278 ctx.msg('Checking for size of lsmp_t', 'long double')
280 ctx.msg('Checking for size of smpl_t', 'float')
281 ctx.msg('Checking for size of lsmp_t', 'double')
283 # optionally use complex.h
284 if (ctx.options.enable_complex == True):
285 ctx.check(header_name='complex.h')
287 ctx.msg('Checking if complex.h is enabled', 'no')
290 if (ctx.options.enable_fftw3 != False or ctx.options.enable_fftw3f != False):
291 # one of fftwf or fftw3f
292 if (ctx.options.enable_fftw3f != False):
293 ctx.check_cfg(package = 'fftw3f',
294 args = '--cflags --libs fftw3f >= 3.0.0',
295 mandatory = ctx.options.enable_fftw3f)
296 if (ctx.options.enable_double == True):
298 'fftw3f enabled, but compiling in double precision!')
300 # fftw3f disabled, take most sensible one according to
302 if (ctx.options.enable_double == True):
303 ctx.check_cfg(package = 'fftw3',
304 args = '--cflags --libs fftw3 >= 3.0.0.',
305 mandatory = ctx.options.enable_fftw3)
307 ctx.check_cfg(package = 'fftw3f',
308 args = '--cflags --libs fftw3f >= 3.0.0',
309 mandatory = ctx.options.enable_fftw3)
310 ctx.define('HAVE_FFTW3', 1)
312 # fftw not enabled, use vDSP or ooura
313 if 'HAVE_FFTW3F' in ctx.env.define_key:
314 ctx.msg('Checking for FFT implementation', 'fftw3f')
315 elif 'HAVE_FFTW3' in ctx.env.define_key:
316 ctx.msg('Checking for FFT implementation', 'fftw3')
317 elif 'HAVE_ACCELERATE' in ctx.env.define_key:
318 ctx.msg('Checking for FFT implementation', 'vDSP')
320 ctx.msg('Checking for FFT implementation', 'ooura')
322 # check for libsndfile
323 if (ctx.options.enable_sndfile != False):
324 ctx.check_cfg(package = 'sndfile',
325 args = '--cflags --libs sndfile >= 1.0.4',
326 mandatory = ctx.options.enable_sndfile)
328 # check for libsamplerate
329 if (ctx.options.enable_double):
330 if (ctx.options.enable_samplerate):
331 ctx.fatal("Could not compile aubio in double precision mode with libsamplerate")
333 ctx.options.enable_samplerate = False
334 ctx.msg('Checking if using samplerate', 'no (disabled in double precision mode)',
336 if (ctx.options.enable_samplerate != False):
337 ctx.check_cfg(package = 'samplerate',
338 args = '--cflags --libs samplerate >= 0.0.15',
339 mandatory = ctx.options.enable_samplerate)
342 if (ctx.options.enable_jack != False):
343 ctx.check_cfg(package = 'jack',
344 args = '--cflags --libs',
345 mandatory = ctx.options.enable_jack)
348 if (ctx.options.enable_avcodec != False):
349 ctx.check_cfg(package = 'libavcodec',
350 args = '--cflags --libs libavcodec >= 54.35.0',
351 uselib_store = 'AVCODEC',
352 mandatory = ctx.options.enable_avcodec)
353 ctx.check_cfg(package = 'libavformat',
354 args = '--cflags --libs libavformat >= 52.3.0',
355 uselib_store = 'AVFORMAT',
356 mandatory = ctx.options.enable_avcodec)
357 ctx.check_cfg(package = 'libavutil',
358 args = '--cflags --libs libavutil >= 52.3.0',
359 uselib_store = 'AVUTIL',
360 mandatory = ctx.options.enable_avcodec)
361 ctx.check_cfg(package = 'libswresample',
362 args = '--cflags --libs libswresample >= 1.2.0',
363 uselib_store = 'SWRESAMPLE',
365 if 'HAVE_SWRESAMPLE' not in ctx.env:
366 ctx.check_cfg(package = 'libavresample',
367 args = '--cflags --libs libavresample >= 1.0.1',
368 uselib_store = 'AVRESAMPLE',
371 msg_check = 'Checking for all libav libraries'
372 if 'HAVE_AVCODEC' not in ctx.env:
373 ctx.msg(msg_check, 'not found (missing avcodec)', color = 'YELLOW')
374 elif 'HAVE_AVFORMAT' not in ctx.env:
375 ctx.msg(msg_check, 'not found (missing avformat)', color = 'YELLOW')
376 elif 'HAVE_AVUTIL' not in ctx.env:
377 ctx.msg(msg_check, 'not found (missing avutil)', color = 'YELLOW')
378 elif 'HAVE_SWRESAMPLE' not in ctx.env and 'HAVE_AVRESAMPLE' not in ctx.env:
379 resample_missing = 'not found (avresample or swresample required)'
380 ctx.msg(msg_check, resample_missing, color = 'YELLOW')
382 ctx.msg(msg_check, 'yes')
383 if 'HAVE_SWRESAMPLE' in ctx.env:
384 ctx.define('HAVE_SWRESAMPLE', 1)
385 elif 'HAVE_AVRESAMPLE' in ctx.env:
386 ctx.define('HAVE_AVRESAMPLE', 1)
387 ctx.define('HAVE_LIBAV', 1)
389 if (ctx.options.enable_wavread != False):
390 ctx.define('HAVE_WAVREAD', 1)
391 ctx.msg('Checking if using source_wavread', ctx.options.enable_wavread and 'yes' or 'no')
392 if (ctx.options.enable_wavwrite!= False):
393 ctx.define('HAVE_WAVWRITE', 1)
394 ctx.msg('Checking if using sink_wavwrite', ctx.options.enable_wavwrite and 'yes' or 'no')
397 if (ctx.options.enable_atlas != False):
398 ctx.check(header_name = 'atlas/cblas.h', mandatory = ctx.options.enable_atlas)
399 #ctx.check(lib = 'lapack', uselib_store = 'LAPACK', mandatory = ctx.options.enable_atlas)
400 ctx.check(lib = 'cblas', uselib_store = 'BLAS', mandatory = ctx.options.enable_atlas)
403 if (ctx.options.enable_memcpy == True):
404 ctx.define('HAVE_MEMCPY_HACKS', 1)
406 # write configuration header
407 ctx.write_config_header('src/config.h')
409 # the following defines will be passed as arguments to the compiler
410 # instead of being written to src/config.h
411 ctx.define('HAVE_CONFIG_H', 1)
413 # add some defines used in examples
414 ctx.define('AUBIO_PREFIX', ctx.env['PREFIX'])
415 ctx.define('PACKAGE', APPNAME)
417 # double precision mode
418 if (ctx.options.enable_double == True):
419 ctx.define('HAVE_AUBIO_DOUBLE', 1)
421 if (ctx.options.enable_docs != False):
422 # check if txt2man is installed, optional
424 ctx.find_program('txt2man', var='TXT2MAN')
425 except ctx.errors.ConfigurationError:
426 ctx.to_log('txt2man was not found (ignoring)')
428 # check if doxygen is installed, optional
430 ctx.find_program('doxygen', var='DOXYGEN')
431 except ctx.errors.ConfigurationError:
432 ctx.to_log('doxygen was not found (ignoring)')
434 # check if sphinx-build is installed, optional
436 ctx.find_program('sphinx-build', var='SPHINX')
437 except ctx.errors.ConfigurationError:
438 ctx.to_log('sphinx-build was not found (ignoring)')
441 bld.env['VERSION'] = VERSION
442 bld.env['LIB_VERSION'] = LIB_VERSION
447 # add sub directories
448 if bld.env['DEST_OS'] not in ['ios', 'iosimulator', 'android']:
449 bld.recurse('examples')
452 # pkg-config template
453 bld( source = 'aubio.pc.in' )
461 # build manpages from txt files using txt2man
462 if bld.env['TXT2MAN']:
463 from waflib import TaskGen
464 if 'MANDIR' not in bld.env:
465 bld.env['MANDIR'] = bld.env['DATAROOTDIR'] + '/man'
466 bld.env.VERSION = VERSION
467 rule_str = '${TXT2MAN} -t `basename ${TGT} | cut -f 1 -d . | tr a-z A-Z`'
468 rule_str += ' -r ${PACKAGE}\\ ${VERSION} -P ${PACKAGE}'
469 rule_str += ' -v ${PACKAGE}\\ User\\\'s\\ manual'
470 rule_str += ' -s 1 ${SRC} > ${TGT}'
471 TaskGen.declare_chain(
477 install_path = '${MANDIR}/man1',
479 bld( source = bld.path.ant_glob('doc/*.txt') )
482 # build documentation from source files using doxygen
483 if bld.env['DOXYGEN']:
484 bld.env.VERSION = VERSION
485 rule = '( cat ${SRC} && echo PROJECT_NUMBER=${VERSION}; )'
486 rule += ' | doxygen - > /dev/null'
487 bld( name = 'doxygen', rule = rule,
488 source = 'doc/web.cfg',
489 target = '../doc/web/html/index.html',
491 bld.install_files( '${DATAROOTDIR}' + '/doc/libaubio-doc',
492 bld.path.ant_glob('doc/web/html/**'),
493 cwd = bld.path.find_dir ('doc/web'),
494 relative_trick = True)
497 # build documentation from source files using sphinx-build
498 # note: build in ../doc/_build/html, otherwise waf wont install unsigned files
499 if bld.env['SPHINX']:
500 bld.env.VERSION = VERSION
501 bld( name = 'sphinx',
502 rule = '${SPHINX} -b html -D release=${VERSION} -D version=${VERSION} -a -q `dirname ${SRC}` `dirname ${TGT}`',
503 source = 'doc/conf.py',
504 target = '../doc/_build/html/index.html')
505 bld.install_files( '${DATAROOTDIR}' + '/doc/libaubio-doc/sphinx',
506 bld.path.ant_glob('doc/_build/html/**'),
507 cwd = bld.path.find_dir('doc/_build/html'),
508 relative_trick = True)
510 # register the previous rules as build rules
511 from waflib.Build import BuildContext
513 class build_txt2man(BuildContext):
517 class build_manpages(BuildContext):
521 class build_sphinx(BuildContext):
525 class build_doxygen(BuildContext):
530 from waflib import Logs
531 if bld.options.target_platform in ['ios', 'iosimulator']:
532 msg ='building for %s, contact the author for a commercial license' % bld.options.target_platform
533 Logs.pprint('RED', msg)
534 msg =' Paul Brossier <piem@aubio.org>'
535 Logs.pprint('RED', msg)
538 ctx.excl = ' **/.waf* **/*~ **/*.pyc **/*.swp **/*.swo **/*.swn **/.lock-w* **/.git*'
539 ctx.excl += ' **/build/*'
540 ctx.excl += ' doc/_build'
541 ctx.excl += ' python/demos_*'
542 ctx.excl += ' **/python/gen **/python/build **/python/dist'
543 ctx.excl += ' **/python/ext/config.h'
544 ctx.excl += ' **/python/lib/aubio/_aubio.so'
545 ctx.excl += ' **.egg-info'
546 ctx.excl += ' **/**.zip **/**.tar.bz2'
547 ctx.excl += ' **.tar.bz2'
548 ctx.excl += ' **/doc/full/* **/doc/web/*'
549 ctx.excl += ' **/doc/full.cfg'
550 ctx.excl += ' **/python/*.db'
551 ctx.excl += ' **/python.old/*'
552 ctx.excl += ' **/python/*/*.old'
553 ctx.excl += ' **/python/tests/sounds'
554 ctx.excl += ' **/**.asc'
555 ctx.excl += ' **/dist*'
556 ctx.excl += ' **/.DS_Store'
557 ctx.excl += ' **/.travis.yml'
558 ctx.excl += ' **/.landscape.yml'
559 ctx.excl += ' **/.appveyor.yml'