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 version_dict = get_version_info();
126 ctx.define('AUBIO_VERSION',VERSION)
127 ctx.define('AUBIO_MAJOR_VERSION', version_dict['AUBIO_MAJOR_VERSION'])
128 ctx.define('AUBIO_MINOR_VERSION', version_dict['AUBIO_MINOR_VERSION'])
129 ctx.define('AUBIO_PATCH_VERSION', version_dict['AUBIO_PATCH_VERSION'])
130 ctx.define('AUBIO_VERSION_STATUS', version_dict['AUBIO_VERSION_STATUS'])
132 if ctx.options.build_type == "debug":
133 ctx.define('DEBUG', 1)
135 ctx.define('NDEBUG', 1)
137 if ctx.env.CC_NAME != 'msvc':
138 if ctx.options.build_type == "debug":
139 # no optimization in debug mode
140 ctx.env.prepend_value('CFLAGS', ['-O0'])
142 # default to -O2 in release mode
143 ctx.env.prepend_value('CFLAGS', ['-O2'])
144 # enable debug symbols and configure warnings
145 ctx.env.prepend_value('CFLAGS', ['-g', '-Wall', '-Wextra'])
147 # enable debug symbols
148 ctx.env.CFLAGS += ['/Z7', '/FS']
149 ctx.env.LINKFLAGS += ['/DEBUG', '/INCREMENTAL:NO']
151 ctx.env.CFLAGS += ['/W4', '/D_CRT_SECURE_NO_WARNINGS']
152 # set optimization level and runtime libs
153 if (ctx.options.build_type == "release"):
154 ctx.env.CFLAGS += ['/Ox']
155 ctx.env.CFLAGS += ['/MD']
157 assert(ctx.options.build_type == "debug")
158 ctx.env.CFLAGS += ['/MDd']
160 ctx.check_cc(lib='m', uselib_store='M', mandatory=False)
162 if target_platform not in ['win32', 'win64']:
163 ctx.env.CFLAGS += ['-fPIC']
165 ctx.define('HAVE_WIN_HACKS', 1)
166 ctx.env['cshlib_PATTERN'] = 'lib%s.dll'
168 if target_platform == 'darwin' and ctx.options.enable_fat:
169 ctx.env.CFLAGS += ['-arch', 'i386', '-arch', 'x86_64']
170 ctx.env.LINKFLAGS += ['-arch', 'i386', '-arch', 'x86_64']
172 ctx.env.CFLAGS += [ '-mmacosx-version-min=' + MINSDKVER ]
173 ctx.env.LINKFLAGS += [ '-mmacosx-version-min=' + MINSDKVER ]
175 if target_platform in [ 'darwin', 'ios', 'iosimulator']:
176 if (ctx.options.enable_apple_audio != False):
177 ctx.env.FRAMEWORK += ['CoreFoundation', 'AudioToolbox']
178 ctx.define('HAVE_SOURCE_APPLE_AUDIO', 1)
179 ctx.define('HAVE_SINK_APPLE_AUDIO', 1)
180 ctx.msg('Checking for AudioToolbox.framework', 'yes')
182 ctx.msg('Checking for AudioToolbox.framework', 'no (disabled)', color = 'YELLOW')
183 if (ctx.options.enable_accelerate != False):
184 ctx.define('HAVE_ACCELERATE', 1)
185 ctx.env.FRAMEWORK += ['Accelerate']
186 ctx.msg('Checking for Accelerate framework', 'yes')
188 ctx.msg('Checking for Accelerate framework', 'no (disabled)', color = 'YELLOW')
190 if target_platform in [ 'ios', 'iosimulator' ]:
192 ctx.env.CFLAGS += ['-std=c99']
193 if (ctx.options.enable_apple_audio != False):
194 ctx.define('HAVE_AUDIO_UNIT', 1)
195 #ctx.env.FRAMEWORK += ['CoreFoundation', 'AudioToolbox']
196 if target_platform == 'ios':
197 DEVROOT = "/Applications/Xcode.app/Contents"
198 DEVROOT += "/Developer/Platforms/iPhoneOS.platform/Developer"
199 SDKROOT = "%(DEVROOT)s/SDKs/iPhoneOS.sdk" % locals()
200 ctx.env.CFLAGS += [ '-fembed-bitcode' ]
201 ctx.env.CFLAGS += [ '-arch', 'arm64' ]
202 ctx.env.CFLAGS += [ '-arch', 'armv7' ]
203 ctx.env.CFLAGS += [ '-arch', 'armv7s' ]
204 ctx.env.LINKFLAGS += [ '-arch', 'arm64' ]
205 ctx.env.LINKFLAGS += ['-arch', 'armv7']
206 ctx.env.LINKFLAGS += ['-arch', 'armv7s']
207 ctx.env.CFLAGS += [ '-miphoneos-version-min=' + MINSDKVER ]
208 ctx.env.LINKFLAGS += [ '-miphoneos-version-min=' + MINSDKVER ]
210 DEVROOT = "/Applications/Xcode.app/Contents"
211 DEVROOT += "/Developer/Platforms/iPhoneSimulator.platform/Developer"
212 SDKROOT = "%(DEVROOT)s/SDKs/iPhoneSimulator.sdk" % locals()
213 ctx.env.CFLAGS += [ '-arch', 'i386' ]
214 ctx.env.CFLAGS += [ '-arch', 'x86_64' ]
215 ctx.env.LINKFLAGS += ['-arch', 'i386']
216 ctx.env.LINKFLAGS += ['-arch', 'x86_64']
217 ctx.env.CFLAGS += [ '-mios-simulator-version-min=' + MINSDKVER ]
218 ctx.env.LINKFLAGS += [ '-mios-simulator-version-min=' + MINSDKVER ]
219 ctx.env.CFLAGS += [ '-isysroot' , SDKROOT]
220 ctx.env.LINKFLAGS += [ '-isysroot' , SDKROOT]
222 if target_platform == 'emscripten':
224 ctx.env.CFLAGS += [ '-I' + os.path.join(os.environ['EMSCRIPTEN'], 'system', 'include') ]
225 ctx.env.CFLAGS += ['-Oz']
226 ctx.env.cprogram_PATTERN = "%s.js"
227 if (ctx.options.enable_atlas != True):
228 ctx.options.enable_atlas = False
230 # check support for C99 __VA_ARGS__ macros
231 check_c99_varargs = '''
233 #define AUBIO_ERR(...) fprintf(stderr, __VA_ARGS__)
236 if ctx.check_cc(fragment = check_c99_varargs,
238 msg = 'Checking for C99 __VA_ARGS__ macro',
240 ctx.define('HAVE_C99_VARARGS_MACROS', 1)
242 # show a message about enable_double status
243 if (ctx.options.enable_double == True):
244 ctx.msg('Checking for size of smpl_t', 'double')
245 ctx.msg('Checking for size of lsmp_t', 'long double')
247 ctx.msg('Checking for size of smpl_t', 'float')
248 ctx.msg('Checking for size of lsmp_t', 'double')
250 # optionally use complex.h
251 if (ctx.options.enable_complex == True):
252 ctx.check(header_name='complex.h')
254 ctx.msg('Checking if complex.h is enabled', 'no')
257 if (ctx.options.enable_fftw3 != False or ctx.options.enable_fftw3f != False):
258 # one of fftwf or fftw3f
259 if (ctx.options.enable_fftw3f != False):
260 ctx.check_cfg(package = 'fftw3f', atleast_version = '3.0.0',
261 args = '--cflags --libs',
262 mandatory = ctx.options.enable_fftw3f)
263 if (ctx.options.enable_double == True):
265 'fftw3f enabled, but compiling in double precision!')
267 # fftw3f disabled, take most sensible one according to
269 if (ctx.options.enable_double == True):
270 ctx.check_cfg(package = 'fftw3', atleast_version = '3.0.0',
271 args = '--cflags --libs', mandatory =
272 ctx.options.enable_fftw3)
274 ctx.check_cfg(package = 'fftw3f', atleast_version = '3.0.0',
275 args = '--cflags --libs',
276 mandatory = ctx.options.enable_fftw3)
277 ctx.define('HAVE_FFTW3', 1)
279 # fftw not enabled, use vDSP or ooura
280 if 'HAVE_FFTW3F' in ctx.env.define_key:
281 ctx.msg('Checking for FFT implementation', 'fftw3f')
282 elif 'HAVE_FFTW3' in ctx.env.define_key:
283 ctx.msg('Checking for FFT implementation', 'fftw3')
284 elif 'HAVE_ACCELERATE' in ctx.env.define_key:
285 ctx.msg('Checking for FFT implementation', 'vDSP')
287 ctx.msg('Checking for FFT implementation', 'ooura')
289 # check for libsndfile
290 if (ctx.options.enable_sndfile != False):
291 ctx.check_cfg(package = 'sndfile', atleast_version = '1.0.4',
292 args = '--cflags --libs',
293 mandatory = ctx.options.enable_sndfile)
295 # check for libsamplerate
296 if (ctx.options.enable_double):
297 if (ctx.options.enable_samplerate):
298 ctx.fatal("Could not compile aubio in double precision mode with libsamplerate")
300 ctx.options.enable_samplerate = False
301 ctx.msg('Checking if using samplerate', 'no (disabled in double precision mode)',
303 if (ctx.options.enable_samplerate != False):
304 ctx.check_cfg(package = 'samplerate', atleast_version = '0.0.15',
305 args = '--cflags --libs',
306 mandatory = ctx.options.enable_samplerate)
309 if (ctx.options.enable_jack != False):
310 ctx.check_cfg(package = 'jack',
311 args = '--cflags --libs',
312 mandatory = ctx.options.enable_jack)
315 if (ctx.options.enable_avcodec != False):
316 ctx.check_cfg(package = 'libavcodec', atleast_version = '54.35.0',
317 args = '--cflags --libs', uselib_store = 'AVCODEC',
318 mandatory = ctx.options.enable_avcodec)
319 ctx.check_cfg(package = 'libavformat', atleast_version = '52.3.0',
320 args = '--cflags --libs', uselib_store = 'AVFORMAT',
321 mandatory = ctx.options.enable_avcodec)
322 ctx.check_cfg(package = 'libavutil', atleast_version = '52.3.0',
323 args = '--cflags --libs', uselib_store = 'AVUTIL',
324 mandatory = ctx.options.enable_avcodec)
325 ctx.check_cfg(package = 'libswresample', atleast_version = '2.3.0',
326 args = '--cflags --libs', uselib_store = 'SWRESAMPLE',
328 if 'HAVE_SWRESAMPLE' not in ctx.env:
329 ctx.check_cfg(package = 'libavresample', atleast_version = '1.0.1',
330 args = '--cflags --libs', uselib_store = 'AVRESAMPLE',
333 msg_check = 'Checking for all libav libraries'
334 if 'HAVE_AVCODEC' not in ctx.env:
335 ctx.msg(msg_check, 'not found (missing avcodec)', color = 'YELLOW')
336 elif 'HAVE_AVFORMAT' not in ctx.env:
337 ctx.msg(msg_check, 'not found (missing avformat)', color = 'YELLOW')
338 elif 'HAVE_AVUTIL' not in ctx.env:
339 ctx.msg(msg_check, 'not found (missing avutil)', color = 'YELLOW')
340 elif 'HAVE_SWRESAMPLE' not in ctx.env and 'HAVE_AVRESAMPLE' not in ctx.env:
341 resample_missing = 'not found (avresample or swresample required)'
342 ctx.msg(msg_check, resample_missing, color = 'YELLOW')
344 ctx.msg(msg_check, 'yes')
345 if 'HAVE_SWRESAMPLE' in ctx.env:
346 ctx.define('HAVE_SWRESAMPLE', 1)
347 elif 'HAVE_AVRESAMPLE' in ctx.env:
348 ctx.define('HAVE_AVRESAMPLE', 1)
349 ctx.define('HAVE_LIBAV', 1)
351 if (ctx.options.enable_wavread != False):
352 ctx.define('HAVE_WAVREAD', 1)
353 ctx.msg('Checking if using source_wavread', ctx.options.enable_wavread and 'yes' or 'no')
354 if (ctx.options.enable_wavwrite!= False):
355 ctx.define('HAVE_WAVWRITE', 1)
356 ctx.msg('Checking if using sink_wavwrite', ctx.options.enable_wavwrite and 'yes' or 'no')
359 if (ctx.options.enable_atlas != False):
360 ctx.check(header_name = 'atlas/cblas.h', mandatory = ctx.options.enable_atlas)
361 #ctx.check(lib = 'lapack', uselib_store = 'LAPACK', mandatory = ctx.options.enable_atlas)
362 ctx.check(lib = 'cblas', uselib_store = 'BLAS', mandatory = ctx.options.enable_atlas)
365 if (ctx.options.enable_memcpy == True):
366 ctx.define('HAVE_MEMCPY_HACKS', 1)
368 # write configuration header
369 ctx.write_config_header('src/config.h')
371 # the following defines will be passed as arguments to the compiler
372 # instead of being written to src/config.h
373 ctx.define('HAVE_CONFIG_H', 1)
375 # add some defines used in examples
376 ctx.define('AUBIO_PREFIX', ctx.env['PREFIX'])
377 ctx.define('PACKAGE', APPNAME)
379 # double precision mode
380 if (ctx.options.enable_double == True):
381 ctx.define('HAVE_AUBIO_DOUBLE', 1)
383 if (ctx.options.enable_docs != False):
384 # check if txt2man is installed, optional
386 ctx.find_program('txt2man', var='TXT2MAN')
387 except ctx.errors.ConfigurationError:
388 ctx.to_log('txt2man was not found (ignoring)')
390 # check if doxygen is installed, optional
392 ctx.find_program('doxygen', var='DOXYGEN')
393 except ctx.errors.ConfigurationError:
394 ctx.to_log('doxygen was not found (ignoring)')
396 # check if sphinx-build is installed, optional
398 ctx.find_program('sphinx-build', var='SPHINX')
399 except ctx.errors.ConfigurationError:
400 ctx.to_log('sphinx-build was not found (ignoring)')
403 bld.env['VERSION'] = VERSION
404 bld.env['LIB_VERSION'] = LIB_VERSION
409 # add sub directories
410 if bld.env['DEST_OS'] not in ['ios', 'iosimulator', 'android']:
411 bld.recurse('examples')
414 # pkg-config template
415 bld( source = 'aubio.pc.in' )
423 # build manpages from txt files using txt2man
424 if bld.env['TXT2MAN']:
425 from waflib import TaskGen
426 if 'MANDIR' not in bld.env:
427 bld.env['MANDIR'] = bld.env['DATAROOTDIR'] + '/man'
428 bld.env.VERSION = str(VERSION)
429 rule_str = '${TXT2MAN} -t `basename ${TGT} | cut -f 1 -d . | tr a-z A-Z`'
430 rule_str += ' -r ${PACKAGE}\\ ${VERSION} -P ${PACKAGE}'
431 rule_str += ' -v ${PACKAGE}\\ User\\\'s\\ manual'
432 rule_str += ' -s 1 ${SRC} > ${TGT}'
433 TaskGen.declare_chain(
439 install_path = '${MANDIR}/man1',
441 bld( source = bld.path.ant_glob('doc/*.txt') )
444 # build documentation from source files using doxygen
445 if bld.env['DOXYGEN']:
446 bld( name = 'doxygen', rule = 'doxygen ${SRC} > /dev/null',
447 source = 'doc/web.cfg',
448 target = '../doc/web/html/index.html',
450 bld.install_files( '${DATAROOTDIR}' + '/doc/libaubio-doc',
451 bld.path.ant_glob('doc/web/html/**'),
452 cwd = bld.path.find_dir ('doc/web'),
453 relative_trick = True)
456 # build documentation from source files using sphinx-build
457 # note: build in ../doc/_build/html, otherwise waf wont install unsigned files
458 if bld.env['SPHINX']:
459 bld.env.VERSION = str(VERSION)
460 bld( name = 'sphinx',
461 rule = '${SPHINX} -b html -D release=${VERSION} -D version=${VERSION} -a -q `dirname ${SRC}` `dirname ${TGT}`',
462 source = 'doc/conf.py',
463 target = '../doc/_build/html/index.html')
464 bld.install_files( '${DATAROOTDIR}' + '/doc/libaubio-doc/sphinx',
465 bld.path.ant_glob('doc/_build/html/**'),
466 cwd = bld.path.find_dir('doc/_build/html'),
467 relative_trick = True)
469 # register the previous rules as build rules
470 from waflib.Build import BuildContext
472 class build_txt2man(BuildContext):
476 class build_manpages(BuildContext):
480 class build_sphinx(BuildContext):
484 class build_doxygen(BuildContext):
489 from waflib import Logs
490 if bld.options.target_platform in ['ios', 'iosimulator']:
491 msg ='building for %s, contact the author for a commercial license' % bld.options.target_platform
492 Logs.pprint('RED', msg)
493 msg =' Paul Brossier <piem@aubio.org>'
494 Logs.pprint('RED', msg)
497 ctx.excl = ' **/.waf* **/*~ **/*.pyc **/*.swp **/*.swo **/*.swn **/.lock-w* **/.git*'
498 ctx.excl += ' **/build/*'
499 ctx.excl += ' doc/_build'
500 ctx.excl += ' python/demos_*'
501 ctx.excl += ' **/python/gen **/python/build **/python/dist'
502 ctx.excl += ' **/python/ext/config.h'
503 ctx.excl += ' **/python/lib/aubio/_aubio.so'
504 ctx.excl += ' **.egg-info'
505 ctx.excl += ' **/**.zip **/**.tar.bz2'
506 ctx.excl += ' **.tar.bz2'
507 ctx.excl += ' **/doc/full/* **/doc/web/*'
508 ctx.excl += ' **/doc/full.cfg'
509 ctx.excl += ' **/python/*.db'
510 ctx.excl += ' **/python.old/*'
511 ctx.excl += ' **/python/*/*.old'
512 ctx.excl += ' **/python/tests/sounds'
513 ctx.excl += ' **/**.asc'
514 ctx.excl += ' **/dist*'
515 ctx.excl += ' **/.DS_Store'
516 ctx.excl += ' **/.travis.yml'
517 ctx.excl += ' **/.landscape.yml'
518 ctx.excl += ' **/.appveyor.yml'