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 # check for common headers
111 ctx.check(header_name='stdlib.h')
112 ctx.check(header_name='stdio.h')
113 ctx.check(header_name='math.h')
114 ctx.check(header_name='string.h')
115 ctx.check(header_name='limits.h')
116 ctx.check(header_name='stdarg.h')
117 ctx.check(header_name='getopt.h', mandatory = False)
118 ctx.check(header_name='unistd.h', mandatory = False)
120 target_platform = sys.platform
121 if ctx.options.target_platform:
122 target_platform = ctx.options.target_platform
123 ctx.env['DEST_OS'] = target_platform
125 if ctx.options.build_type == "debug":
126 ctx.define('DEBUG', 1)
128 ctx.define('NDEBUG', 1)
130 if ctx.env.CC_NAME != 'msvc':
131 if ctx.options.build_type == "debug":
132 # no optimization in debug mode
133 ctx.env.prepend_value('CFLAGS', ['-O0'])
135 # default to -O2 in release mode
136 ctx.env.prepend_value('CFLAGS', ['-O2'])
137 # enable debug symbols and configure warnings
138 ctx.env.prepend_value('CFLAGS', ['-g', '-Wall', '-Wextra'])
140 # enable debug symbols
141 ctx.env.CFLAGS += ['/Z7', '/FS']
142 ctx.env.LINKFLAGS += ['/DEBUG', '/INCREMENTAL:NO']
144 ctx.env.CFLAGS += ['/W4', '/D_CRT_SECURE_NO_WARNINGS']
145 # set optimization level and runtime libs
146 if (ctx.options.build_type == "release"):
147 ctx.env.CFLAGS += ['/Ox']
148 ctx.env.CFLAGS += ['/MD']
150 assert(ctx.options.build_type == "debug")
151 ctx.env.CFLAGS += ['/MDd']
153 ctx.check_cc(lib='m', uselib_store='M', mandatory=False)
155 if target_platform not in ['win32', 'win64']:
156 ctx.env.CFLAGS += ['-fPIC']
158 ctx.define('HAVE_WIN_HACKS', 1)
159 ctx.env['cshlib_PATTERN'] = 'lib%s.dll'
161 if target_platform == 'darwin' and ctx.options.enable_fat:
162 ctx.env.CFLAGS += ['-arch', 'i386', '-arch', 'x86_64']
163 ctx.env.LINKFLAGS += ['-arch', 'i386', '-arch', 'x86_64']
165 ctx.env.CFLAGS += [ '-mmacosx-version-min=' + MINSDKVER ]
166 ctx.env.LINKFLAGS += [ '-mmacosx-version-min=' + MINSDKVER ]
168 if target_platform in [ 'darwin', 'ios', 'iosimulator']:
169 if (ctx.options.enable_apple_audio != False):
170 ctx.env.FRAMEWORK += ['CoreFoundation', 'AudioToolbox']
171 ctx.define('HAVE_SOURCE_APPLE_AUDIO', 1)
172 ctx.define('HAVE_SINK_APPLE_AUDIO', 1)
173 ctx.msg('Checking for AudioToolbox.framework', 'yes')
175 ctx.msg('Checking for AudioToolbox.framework', 'no (disabled)', color = 'YELLOW')
176 if (ctx.options.enable_accelerate != False):
177 ctx.define('HAVE_ACCELERATE', 1)
178 ctx.env.FRAMEWORK += ['Accelerate']
179 ctx.msg('Checking for Accelerate framework', 'yes')
181 ctx.msg('Checking for Accelerate framework', 'no (disabled)', color = 'YELLOW')
183 if target_platform in [ 'ios', 'iosimulator' ]:
185 ctx.env.CFLAGS += ['-std=c99']
186 if (ctx.options.enable_apple_audio != False):
187 ctx.define('HAVE_AUDIO_UNIT', 1)
188 #ctx.env.FRAMEWORK += ['CoreFoundation', 'AudioToolbox']
189 if target_platform == 'ios':
190 DEVROOT = "/Applications/Xcode.app/Contents"
191 DEVROOT += "/Developer/Platforms/iPhoneOS.platform/Developer"
192 SDKROOT = "%(DEVROOT)s/SDKs/iPhoneOS.sdk" % locals()
193 ctx.env.CFLAGS += [ '-fembed-bitcode' ]
194 ctx.env.CFLAGS += [ '-arch', 'arm64' ]
195 ctx.env.CFLAGS += [ '-arch', 'armv7' ]
196 ctx.env.CFLAGS += [ '-arch', 'armv7s' ]
197 ctx.env.LINKFLAGS += [ '-arch', 'arm64' ]
198 ctx.env.LINKFLAGS += ['-arch', 'armv7']
199 ctx.env.LINKFLAGS += ['-arch', 'armv7s']
200 ctx.env.CFLAGS += [ '-miphoneos-version-min=' + MINSDKVER ]
201 ctx.env.LINKFLAGS += [ '-miphoneos-version-min=' + MINSDKVER ]
203 DEVROOT = "/Applications/Xcode.app/Contents"
204 DEVROOT += "/Developer/Platforms/iPhoneSimulator.platform/Developer"
205 SDKROOT = "%(DEVROOT)s/SDKs/iPhoneSimulator.sdk" % locals()
206 ctx.env.CFLAGS += [ '-arch', 'i386' ]
207 ctx.env.CFLAGS += [ '-arch', 'x86_64' ]
208 ctx.env.LINKFLAGS += ['-arch', 'i386']
209 ctx.env.LINKFLAGS += ['-arch', 'x86_64']
210 ctx.env.CFLAGS += [ '-mios-simulator-version-min=' + MINSDKVER ]
211 ctx.env.LINKFLAGS += [ '-mios-simulator-version-min=' + MINSDKVER ]
212 ctx.env.CFLAGS += [ '-isysroot' , SDKROOT]
213 ctx.env.LINKFLAGS += [ '-isysroot' , SDKROOT]
215 if target_platform == 'emscripten':
217 ctx.env.CFLAGS += [ '-I' + os.path.join(os.environ['EMSCRIPTEN'], 'system', 'include') ]
218 ctx.env.CFLAGS += ['-Oz']
219 ctx.env.cprogram_PATTERN = "%s.js"
220 if (ctx.options.enable_atlas != True):
221 ctx.options.enable_atlas = False
223 # check support for C99 __VA_ARGS__ macros
224 check_c99_varargs = '''
226 #define AUBIO_ERR(...) fprintf(stderr, __VA_ARGS__)
229 if ctx.check_cc(fragment = check_c99_varargs,
231 msg = 'Checking for C99 __VA_ARGS__ macro',
233 ctx.define('HAVE_C99_VARARGS_MACROS', 1)
235 # show a message about enable_double status
236 if (ctx.options.enable_double == True):
237 ctx.msg('Checking for size of smpl_t', 'double')
238 ctx.msg('Checking for size of lsmp_t', 'long double')
240 ctx.msg('Checking for size of smpl_t', 'float')
241 ctx.msg('Checking for size of lsmp_t', 'double')
243 # optionally use complex.h
244 if (ctx.options.enable_complex == True):
245 ctx.check(header_name='complex.h')
247 ctx.msg('Checking if complex.h is enabled', 'no')
250 if (ctx.options.enable_fftw3 != False or ctx.options.enable_fftw3f != False):
251 # one of fftwf or fftw3f
252 if (ctx.options.enable_fftw3f != False):
253 ctx.check_cfg(package = 'fftw3f',
254 args = '--cflags --libs fftw3f >= 3.0.0',
255 mandatory = ctx.options.enable_fftw3f)
256 if (ctx.options.enable_double == True):
258 'fftw3f enabled, but compiling in double precision!')
260 # fftw3f disabled, take most sensible one according to
262 if (ctx.options.enable_double == True):
263 ctx.check_cfg(package = 'fftw3',
264 args = '--cflags --libs fftw3 >= 3.0.0.',
265 mandatory = ctx.options.enable_fftw3)
267 ctx.check_cfg(package = 'fftw3f',
268 args = '--cflags --libs fftw3f >= 3.0.0',
269 mandatory = ctx.options.enable_fftw3)
270 ctx.define('HAVE_FFTW3', 1)
272 # fftw not enabled, use vDSP or ooura
273 if 'HAVE_FFTW3F' in ctx.env.define_key:
274 ctx.msg('Checking for FFT implementation', 'fftw3f')
275 elif 'HAVE_FFTW3' in ctx.env.define_key:
276 ctx.msg('Checking for FFT implementation', 'fftw3')
277 elif 'HAVE_ACCELERATE' in ctx.env.define_key:
278 ctx.msg('Checking for FFT implementation', 'vDSP')
280 ctx.msg('Checking for FFT implementation', 'ooura')
282 # check for libsndfile
283 if (ctx.options.enable_sndfile != False):
284 ctx.check_cfg(package = 'sndfile',
285 args = '--cflags --libs sndfile >= 1.0.4',
286 mandatory = ctx.options.enable_sndfile)
288 # check for libsamplerate
289 if (ctx.options.enable_double):
290 if (ctx.options.enable_samplerate):
291 ctx.fatal("Could not compile aubio in double precision mode with libsamplerate")
293 ctx.options.enable_samplerate = False
294 ctx.msg('Checking if using samplerate', 'no (disabled in double precision mode)',
296 if (ctx.options.enable_samplerate != False):
297 ctx.check_cfg(package = 'samplerate',
298 args = '--cflags --libs samplerate >= 0.0.15',
299 mandatory = ctx.options.enable_samplerate)
302 if (ctx.options.enable_jack != False):
303 ctx.check_cfg(package = 'jack',
304 args = '--cflags --libs',
305 mandatory = ctx.options.enable_jack)
308 if (ctx.options.enable_avcodec != False):
309 ctx.check_cfg(package = 'libavcodec',
310 args = '--cflags --libs libavcodec >= 54.35.0',
311 uselib_store = 'AVCODEC',
312 mandatory = ctx.options.enable_avcodec)
313 ctx.check_cfg(package = 'libavformat',
314 args = '--cflags --libs libavformat >= 52.3.0',
315 uselib_store = 'AVFORMAT',
316 mandatory = ctx.options.enable_avcodec)
317 ctx.check_cfg(package = 'libavutil',
318 args = '--cflags --libs libavutil >= 52.3.0',
319 uselib_store = 'AVUTIL',
320 mandatory = ctx.options.enable_avcodec)
321 ctx.check_cfg(package = 'libswresample',
322 args = '--cflags --libs libswresample >= 2.3.0',
323 uselib_store = 'SWRESAMPLE',
325 if 'HAVE_SWRESAMPLE' not in ctx.env:
326 ctx.check_cfg(package = 'libavresample',
327 args = '--cflags --libs libavresample >= 1.0.1',
328 uselib_store = 'AVRESAMPLE',
331 msg_check = 'Checking for all libav libraries'
332 if 'HAVE_AVCODEC' not in ctx.env:
333 ctx.msg(msg_check, 'not found (missing avcodec)', color = 'YELLOW')
334 elif 'HAVE_AVFORMAT' not in ctx.env:
335 ctx.msg(msg_check, 'not found (missing avformat)', color = 'YELLOW')
336 elif 'HAVE_AVUTIL' not in ctx.env:
337 ctx.msg(msg_check, 'not found (missing avutil)', color = 'YELLOW')
338 elif 'HAVE_SWRESAMPLE' not in ctx.env and 'HAVE_AVRESAMPLE' not in ctx.env:
339 resample_missing = 'not found (avresample or swresample required)'
340 ctx.msg(msg_check, resample_missing, color = 'YELLOW')
342 ctx.msg(msg_check, 'yes')
343 if 'HAVE_SWRESAMPLE' in ctx.env:
344 ctx.define('HAVE_SWRESAMPLE', 1)
345 elif 'HAVE_AVRESAMPLE' in ctx.env:
346 ctx.define('HAVE_AVRESAMPLE', 1)
347 ctx.define('HAVE_LIBAV', 1)
349 if (ctx.options.enable_wavread != False):
350 ctx.define('HAVE_WAVREAD', 1)
351 ctx.msg('Checking if using source_wavread', ctx.options.enable_wavread and 'yes' or 'no')
352 if (ctx.options.enable_wavwrite!= False):
353 ctx.define('HAVE_WAVWRITE', 1)
354 ctx.msg('Checking if using sink_wavwrite', ctx.options.enable_wavwrite and 'yes' or 'no')
357 if (ctx.options.enable_atlas != False):
358 ctx.check(header_name = 'atlas/cblas.h', mandatory = ctx.options.enable_atlas)
359 #ctx.check(lib = 'lapack', uselib_store = 'LAPACK', mandatory = ctx.options.enable_atlas)
360 ctx.check(lib = 'cblas', uselib_store = 'BLAS', mandatory = ctx.options.enable_atlas)
363 if (ctx.options.enable_memcpy == True):
364 ctx.define('HAVE_MEMCPY_HACKS', 1)
366 # write configuration header
367 ctx.write_config_header('src/config.h')
369 # the following defines will be passed as arguments to the compiler
370 # instead of being written to src/config.h
371 ctx.define('HAVE_CONFIG_H', 1)
373 # add some defines used in examples
374 ctx.define('AUBIO_PREFIX', ctx.env['PREFIX'])
375 ctx.define('PACKAGE', APPNAME)
377 # double precision mode
378 if (ctx.options.enable_double == True):
379 ctx.define('HAVE_AUBIO_DOUBLE', 1)
381 if (ctx.options.enable_docs != False):
382 # check if txt2man is installed, optional
384 ctx.find_program('txt2man', var='TXT2MAN')
385 except ctx.errors.ConfigurationError:
386 ctx.to_log('txt2man was not found (ignoring)')
388 # check if doxygen is installed, optional
390 ctx.find_program('doxygen', var='DOXYGEN')
391 except ctx.errors.ConfigurationError:
392 ctx.to_log('doxygen was not found (ignoring)')
394 # check if sphinx-build is installed, optional
396 ctx.find_program('sphinx-build', var='SPHINX')
397 except ctx.errors.ConfigurationError:
398 ctx.to_log('sphinx-build was not found (ignoring)')
401 bld.env['VERSION'] = VERSION
402 bld.env['LIB_VERSION'] = LIB_VERSION
407 # add sub directories
408 if bld.env['DEST_OS'] not in ['ios', 'iosimulator', 'android']:
409 bld.recurse('examples')
412 # pkg-config template
413 bld( source = 'aubio.pc.in' )
421 # build manpages from txt files using txt2man
422 if bld.env['TXT2MAN']:
423 from waflib import TaskGen
424 if 'MANDIR' not in bld.env:
425 bld.env['MANDIR'] = bld.env['DATAROOTDIR'] + '/man'
426 bld.env.VERSION = VERSION
427 rule_str = '${TXT2MAN} -t `basename ${TGT} | cut -f 1 -d . | tr a-z A-Z`'
428 rule_str += ' -r ${PACKAGE}\\ ${VERSION} -P ${PACKAGE}'
429 rule_str += ' -v ${PACKAGE}\\ User\\\'s\\ manual'
430 rule_str += ' -s 1 ${SRC} > ${TGT}'
431 TaskGen.declare_chain(
437 install_path = '${MANDIR}/man1',
439 bld( source = bld.path.ant_glob('doc/*.txt') )
442 # build documentation from source files using doxygen
443 if bld.env['DOXYGEN']:
444 bld.env.VERSION = VERSION
445 rule = '( cat ${SRC} && echo PROJECT_NUMBER=${VERSION}; )'
446 rule += ' | doxygen - > /dev/null'
447 bld( name = 'doxygen', rule = rule,
448 source = 'doc/web.cfg',
449 target = '../doc/web/html/index.html',
451 bld.install_files( '${DATAROOTDIR}' + '/doc/libaubio-doc',
452 bld.path.ant_glob('doc/web/html/**'),
453 cwd = bld.path.find_dir ('doc/web'),
454 relative_trick = True)
457 # build documentation from source files using sphinx-build
458 # note: build in ../doc/_build/html, otherwise waf wont install unsigned files
459 if bld.env['SPHINX']:
460 bld.env.VERSION = VERSION
461 bld( name = 'sphinx',
462 rule = '${SPHINX} -b html -D release=${VERSION} -D version=${VERSION} -a -q `dirname ${SRC}` `dirname ${TGT}`',
463 source = 'doc/conf.py',
464 target = '../doc/_build/html/index.html')
465 bld.install_files( '${DATAROOTDIR}' + '/doc/libaubio-doc/sphinx',
466 bld.path.ant_glob('doc/_build/html/**'),
467 cwd = bld.path.find_dir('doc/_build/html'),
468 relative_trick = True)
470 # register the previous rules as build rules
471 from waflib.Build import BuildContext
473 class build_txt2man(BuildContext):
477 class build_manpages(BuildContext):
481 class build_sphinx(BuildContext):
485 class build_doxygen(BuildContext):
490 from waflib import Logs
491 if bld.options.target_platform in ['ios', 'iosimulator']:
492 msg ='building for %s, contact the author for a commercial license' % bld.options.target_platform
493 Logs.pprint('RED', msg)
494 msg =' Paul Brossier <piem@aubio.org>'
495 Logs.pprint('RED', msg)
498 ctx.excl = ' **/.waf* **/*~ **/*.pyc **/*.swp **/*.swo **/*.swn **/.lock-w* **/.git*'
499 ctx.excl += ' **/build/*'
500 ctx.excl += ' doc/_build'
501 ctx.excl += ' python/demos_*'
502 ctx.excl += ' **/python/gen **/python/build **/python/dist'
503 ctx.excl += ' **/python/ext/config.h'
504 ctx.excl += ' **/python/lib/aubio/_aubio.so'
505 ctx.excl += ' **.egg-info'
506 ctx.excl += ' **/**.zip **/**.tar.bz2'
507 ctx.excl += ' **.tar.bz2'
508 ctx.excl += ' **/doc/full/* **/doc/web/*'
509 ctx.excl += ' **/doc/full.cfg'
510 ctx.excl += ' **/python/*.db'
511 ctx.excl += ' **/python.old/*'
512 ctx.excl += ' **/python/*/*.old'
513 ctx.excl += ' **/python/tests/sounds'
514 ctx.excl += ' **/**.asc'
515 ctx.excl += ' **/dist*'
516 ctx.excl += ' **/.DS_Store'
517 ctx.excl += ' **/.travis.yml'
518 ctx.excl += ' **/.landscape.yml'
519 ctx.excl += ' **/.appveyor.yml'