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 for l in open('VERSION').readlines(): exec (l.strip())
20 VERSION = '.'.join ([str(x) for x in [
24 ]]) + AUBIO_VERSION_STATUS
26 LIB_VERSION = '.'.join ([str(x) for x in [
34 def add_option_enable_disable(ctx, name, default = None,
35 help_str = None, help_disable_str = None):
37 help_str = 'enable ' + name + ' support'
38 if help_disable_str == None:
39 help_disable_str = 'do not ' + help_str
40 ctx.add_option('--enable-' + name, action = 'store_true',
42 dest = 'enable_' + name.replace('-','_'),
44 ctx.add_option('--disable-' + name, action = 'store_false',
46 dest = 'enable_' + name.replace('-','_'),
47 help = help_disable_str )
50 ctx.add_option('--build-type', action = 'store',
52 choices = ('debug', 'release'),
54 help = 'whether to compile with (--build-type=release) or without (--build-type=debug) '\
55 ' compiler opimizations [default: release]')
56 add_option_enable_disable(ctx, 'fftw3f', default = False,
57 help_str = 'compile with fftw3f instead of ooura (recommended)',
58 help_disable_str = 'do not compile with fftw3f')
59 add_option_enable_disable(ctx, 'fftw3', default = False,
60 help_str = 'compile with fftw3 instead of ooura',
61 help_disable_str = 'do not compile with fftw3')
62 add_option_enable_disable(ctx, 'complex', default = False,
63 help_str ='compile with C99 complex',
64 help_disable_str = 'do not use C99 complex (default)' )
65 add_option_enable_disable(ctx, 'jack', default = None,
66 help_str = 'compile with jack (auto)',
67 help_disable_str = 'disable jack support')
68 add_option_enable_disable(ctx, 'sndfile', default = None,
69 help_str = 'compile with sndfile (auto)',
70 help_disable_str = 'disable sndfile')
71 add_option_enable_disable(ctx, 'avcodec', default = None,
72 help_str = 'compile with libavcodec (auto)',
73 help_disable_str = 'disable libavcodec')
74 add_option_enable_disable(ctx, 'samplerate', default = None,
75 help_str = 'compile with samplerate (auto)',
76 help_disable_str = 'disable samplerate')
77 add_option_enable_disable(ctx, 'memcpy', default = True,
78 help_str = 'use memcpy hacks (default)',
79 help_disable_str = 'do not use memcpy hacks')
80 add_option_enable_disable(ctx, 'double', default = False,
81 help_str = 'compile in double precision mode',
82 help_disable_str = 'compile in single precision mode (default)')
83 add_option_enable_disable(ctx, 'fat', default = False,
84 help_str = 'build fat binaries (darwin only)',
85 help_disable_str = 'do not build fat binaries (default)')
86 add_option_enable_disable(ctx, 'accelerate', default = None,
87 help_str = 'use Accelerate framework (darwin only) (auto)',
88 help_disable_str = 'do not use Accelerate framework')
89 add_option_enable_disable(ctx, 'apple-audio', default = None,
90 help_str = 'use CoreFoundation (darwin only) (auto)',
91 help_disable_str = 'do not use CoreFoundation framework')
92 add_option_enable_disable(ctx, 'atlas', default = False,
93 help_str = 'use Atlas library (no)',
94 help_disable_str = 'do not use Atlas library')
95 add_option_enable_disable(ctx, 'wavread', default = True,
96 help_str = 'compile with source_wavread (default)',
97 help_disable_str = 'do not compile source_wavread')
98 add_option_enable_disable(ctx, 'wavwrite', default = True,
99 help_str = 'compile with source_wavwrite (default)',
100 help_disable_str = 'do not compile source_wavwrite')
102 add_option_enable_disable(ctx, 'docs', default = None,
103 help_str = 'build documentation (auto)',
104 help_disable_str = 'do not build documentation')
106 ctx.add_option('--with-target-platform', type='string',
107 help='set target platform for cross-compilation', dest='target_platform')
109 ctx.load('compiler_c')
110 ctx.load('waf_unit_test')
114 from waflib import Options
115 ctx.load('compiler_c')
116 ctx.load('waf_unit_test')
119 # check for common headers
120 ctx.check(header_name='stdlib.h')
121 ctx.check(header_name='stdio.h')
122 ctx.check(header_name='math.h')
123 ctx.check(header_name='string.h')
124 ctx.check(header_name='limits.h')
125 ctx.check(header_name='stdarg.h')
126 ctx.check(header_name='getopt.h', mandatory = False)
127 ctx.check(header_name='unistd.h', mandatory = False)
129 target_platform = sys.platform
130 if ctx.options.target_platform:
131 target_platform = ctx.options.target_platform
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 # default to -O2 in release mode
145 ctx.env.prepend_value('CFLAGS', ['-O2'])
146 # enable debug symbols and configure warnings
147 ctx.env.prepend_value('CFLAGS', ['-g', '-Wall', '-Wextra'])
149 # enable debug symbols
150 ctx.env.CFLAGS += ['/Z7', '/FS']
151 ctx.env.LINKFLAGS += ['/DEBUG', '/INCREMENTAL:NO']
153 ctx.env.CFLAGS += ['/W4', '/D_CRT_SECURE_NO_WARNINGS']
154 # set optimization level and runtime libs
155 if (ctx.options.build_type == "release"):
156 ctx.env.CFLAGS += ['/Ox']
157 ctx.env.CFLAGS += ['/MD']
159 assert(ctx.options.build_type == "debug")
160 ctx.env.CFLAGS += ['/MDd']
162 ctx.check_cc(lib='m', uselib_store='M', mandatory=False)
164 if target_platform not in ['win32', 'win64']:
165 ctx.env.CFLAGS += ['-fPIC']
167 ctx.define('HAVE_WIN_HACKS', 1)
168 ctx.env['cshlib_PATTERN'] = 'lib%s.dll'
170 if target_platform == 'darwin' and ctx.options.enable_fat:
171 ctx.env.CFLAGS += ['-arch', 'i386', '-arch', 'x86_64']
172 ctx.env.LINKFLAGS += ['-arch', 'i386', '-arch', 'x86_64']
174 ctx.env.CFLAGS += [ '-mmacosx-version-min=' + MINSDKVER ]
175 ctx.env.LINKFLAGS += [ '-mmacosx-version-min=' + MINSDKVER ]
177 if target_platform in [ 'darwin', 'ios', 'iosimulator']:
178 if (ctx.options.enable_apple_audio != False):
179 ctx.env.FRAMEWORK += ['CoreFoundation', 'AudioToolbox']
180 ctx.define('HAVE_SOURCE_APPLE_AUDIO', 1)
181 ctx.define('HAVE_SINK_APPLE_AUDIO', 1)
182 ctx.msg('Checking for AudioToolbox.framework', 'yes')
184 ctx.msg('Checking for AudioToolbox.framework', 'no (disabled)', color = 'YELLOW')
185 if (ctx.options.enable_accelerate != False):
186 ctx.define('HAVE_ACCELERATE', 1)
187 ctx.env.FRAMEWORK += ['Accelerate']
188 ctx.msg('Checking for Accelerate framework', 'yes')
190 ctx.msg('Checking for Accelerate framework', 'no (disabled)', color = 'YELLOW')
192 if target_platform in [ 'ios', 'iosimulator' ]:
194 ctx.env.CFLAGS += ['-std=c99']
195 if (ctx.options.enable_apple_audio != False):
196 ctx.define('HAVE_AUDIO_UNIT', 1)
197 #ctx.env.FRAMEWORK += ['CoreFoundation', 'AudioToolbox']
198 if target_platform == 'ios':
199 DEVROOT = "/Applications/Xcode.app/Contents"
200 DEVROOT += "/Developer/Platforms/iPhoneOS.platform/Developer"
201 SDKROOT = "%(DEVROOT)s/SDKs/iPhoneOS.sdk" % locals()
202 ctx.env.CFLAGS += [ '-fembed-bitcode' ]
203 ctx.env.CFLAGS += [ '-arch', 'arm64' ]
204 ctx.env.CFLAGS += [ '-arch', 'armv7' ]
205 ctx.env.CFLAGS += [ '-arch', 'armv7s' ]
206 ctx.env.LINKFLAGS += [ '-arch', 'arm64' ]
207 ctx.env.LINKFLAGS += ['-arch', 'armv7']
208 ctx.env.LINKFLAGS += ['-arch', 'armv7s']
209 ctx.env.CFLAGS += [ '-miphoneos-version-min=' + MINSDKVER ]
210 ctx.env.LINKFLAGS += [ '-miphoneos-version-min=' + MINSDKVER ]
212 DEVROOT = "/Applications/Xcode.app/Contents"
213 DEVROOT += "/Developer/Platforms/iPhoneSimulator.platform/Developer"
214 SDKROOT = "%(DEVROOT)s/SDKs/iPhoneSimulator.sdk" % locals()
215 ctx.env.CFLAGS += [ '-arch', 'i386' ]
216 ctx.env.CFLAGS += [ '-arch', 'x86_64' ]
217 ctx.env.LINKFLAGS += ['-arch', 'i386']
218 ctx.env.LINKFLAGS += ['-arch', 'x86_64']
219 ctx.env.CFLAGS += [ '-mios-simulator-version-min=' + MINSDKVER ]
220 ctx.env.LINKFLAGS += [ '-mios-simulator-version-min=' + MINSDKVER ]
221 ctx.env.CFLAGS += [ '-isysroot' , SDKROOT]
222 ctx.env.LINKFLAGS += [ '-isysroot' , SDKROOT]
224 if target_platform == 'emscripten':
226 ctx.env.CFLAGS += [ '-I' + os.path.join(os.environ['EMSCRIPTEN'], 'system', 'include') ]
227 ctx.env.CFLAGS += ['-Oz']
228 ctx.env.cprogram_PATTERN = "%s.js"
229 if (ctx.options.enable_atlas != True):
230 ctx.options.enable_atlas = False
232 # check support for C99 __VA_ARGS__ macros
233 check_c99_varargs = '''
235 #define AUBIO_ERR(...) fprintf(stderr, __VA_ARGS__)
238 if ctx.check_cc(fragment = check_c99_varargs,
240 msg = 'Checking for C99 __VA_ARGS__ macro',
242 ctx.define('HAVE_C99_VARARGS_MACROS', 1)
244 # show a message about enable_double status
245 if (ctx.options.enable_double == True):
246 ctx.msg('Checking for size of smpl_t', 'double')
247 ctx.msg('Checking for size of lsmp_t', 'long double')
249 ctx.msg('Checking for size of smpl_t', 'float')
250 ctx.msg('Checking for size of lsmp_t', 'double')
252 # optionally use complex.h
253 if (ctx.options.enable_complex == True):
254 ctx.check(header_name='complex.h')
256 ctx.msg('Checking if complex.h is enabled', 'no')
259 if (ctx.options.enable_fftw3 != False or ctx.options.enable_fftw3f != False):
260 # one of fftwf or fftw3f
261 if (ctx.options.enable_fftw3f != False):
262 ctx.check_cfg(package = 'fftw3f', atleast_version = '3.0.0',
263 args = '--cflags --libs',
264 mandatory = ctx.options.enable_fftw3f)
265 if (ctx.options.enable_double == True):
267 'fftw3f enabled, but compiling in double precision!')
269 # fftw3f disabled, take most sensible one according to
271 if (ctx.options.enable_double == True):
272 ctx.check_cfg(package = 'fftw3', atleast_version = '3.0.0',
273 args = '--cflags --libs', mandatory =
274 ctx.options.enable_fftw3)
276 ctx.check_cfg(package = 'fftw3f', atleast_version = '3.0.0',
277 args = '--cflags --libs',
278 mandatory = ctx.options.enable_fftw3)
279 ctx.define('HAVE_FFTW3', 1)
281 # fftw not enabled, use vDSP or ooura
282 if 'HAVE_FFTW3F' in ctx.env.define_key:
283 ctx.msg('Checking for FFT implementation', 'fftw3f')
284 elif 'HAVE_FFTW3' in ctx.env.define_key:
285 ctx.msg('Checking for FFT implementation', 'fftw3')
286 elif 'HAVE_ACCELERATE' in ctx.env.define_key:
287 ctx.msg('Checking for FFT implementation', 'vDSP')
289 ctx.msg('Checking for FFT implementation', 'ooura')
291 # check for libsndfile
292 if (ctx.options.enable_sndfile != False):
293 ctx.check_cfg(package = 'sndfile', atleast_version = '1.0.4',
294 args = '--cflags --libs',
295 mandatory = ctx.options.enable_sndfile)
297 # check for libsamplerate
298 if (ctx.options.enable_double):
299 if (ctx.options.enable_samplerate):
300 ctx.fatal("Could not compile aubio in double precision mode with libsamplerate")
302 ctx.options.enable_samplerate = False
303 ctx.msg('Checking if using samplerate', 'no (disabled in double precision mode)',
305 if (ctx.options.enable_samplerate != False):
306 ctx.check_cfg(package = 'samplerate', atleast_version = '0.0.15',
307 args = '--cflags --libs',
308 mandatory = ctx.options.enable_samplerate)
311 if (ctx.options.enable_jack != False):
312 ctx.check_cfg(package = 'jack',
313 args = '--cflags --libs',
314 mandatory = ctx.options.enable_jack)
317 if (ctx.options.enable_avcodec != False):
318 ctx.check_cfg(package = 'libavcodec', atleast_version = '54.35.0',
319 args = '--cflags --libs', uselib_store = 'AVCODEC',
320 mandatory = ctx.options.enable_avcodec)
321 ctx.check_cfg(package = 'libavformat', atleast_version = '52.3.0',
322 args = '--cflags --libs', uselib_store = 'AVFORMAT',
323 mandatory = ctx.options.enable_avcodec)
324 ctx.check_cfg(package = 'libavutil', atleast_version = '52.3.0',
325 args = '--cflags --libs', uselib_store = 'AVUTIL',
326 mandatory = ctx.options.enable_avcodec)
327 ctx.check_cfg(package = 'libavresample', atleast_version = '1.0.1',
328 args = '--cflags --libs', uselib_store = 'AVRESAMPLE',
329 mandatory = ctx.options.enable_avcodec)
330 if all ( 'HAVE_' + i in ctx.env
331 for i in ['AVCODEC', 'AVFORMAT', 'AVUTIL', 'AVRESAMPLE'] ):
332 ctx.define('HAVE_LIBAV', 1)
333 ctx.msg('Checking for all libav libraries', 'yes')
335 ctx.msg('Checking for all libav libraries', 'not found', color = 'YELLOW')
337 if (ctx.options.enable_wavread != False):
338 ctx.define('HAVE_WAVREAD', 1)
339 ctx.msg('Checking if using source_wavread', ctx.options.enable_wavread and 'yes' or 'no')
340 if (ctx.options.enable_wavwrite!= False):
341 ctx.define('HAVE_WAVWRITE', 1)
342 ctx.msg('Checking if using sink_wavwrite', ctx.options.enable_wavwrite and 'yes' or 'no')
345 if (ctx.options.enable_atlas != False):
346 ctx.check(header_name = 'atlas/cblas.h', mandatory = ctx.options.enable_atlas)
347 #ctx.check(lib = 'lapack', uselib_store = 'LAPACK', mandatory = ctx.options.enable_atlas)
348 ctx.check(lib = 'cblas', uselib_store = 'BLAS', mandatory = ctx.options.enable_atlas)
351 if (ctx.options.enable_memcpy == True):
352 ctx.define('HAVE_MEMCPY_HACKS', 1)
354 # write configuration header
355 ctx.write_config_header('src/config.h')
357 # the following defines will be passed as arguments to the compiler
358 # instead of being written to src/config.h
359 ctx.define('HAVE_CONFIG_H', 1)
361 # add some defines used in examples
362 ctx.define('AUBIO_PREFIX', ctx.env['PREFIX'])
363 ctx.define('PACKAGE', APPNAME)
365 # double precision mode
366 if (ctx.options.enable_double == True):
367 ctx.define('HAVE_AUBIO_DOUBLE', 1)
369 if (ctx.options.enable_docs != False):
370 # check if txt2man is installed, optional
372 ctx.find_program('txt2man', var='TXT2MAN')
373 except ctx.errors.ConfigurationError:
374 ctx.to_log('txt2man was not found (ignoring)')
376 # check if doxygen is installed, optional
378 ctx.find_program('doxygen', var='DOXYGEN')
379 except ctx.errors.ConfigurationError:
380 ctx.to_log('doxygen was not found (ignoring)')
382 # check if sphinx-build is installed, optional
384 ctx.find_program('sphinx-build', var='SPHINX')
385 except ctx.errors.ConfigurationError:
386 ctx.to_log('sphinx-build was not found (ignoring)')
389 bld.env['VERSION'] = VERSION
390 bld.env['LIB_VERSION'] = LIB_VERSION
395 # add sub directories
396 if bld.env['DEST_OS'] not in ['ios', 'iosimulator', 'android']:
397 bld.recurse('examples')
400 # pkg-config template
401 bld( source = 'aubio.pc.in' )
409 # build manpages from txt files using txt2man
410 if bld.env['TXT2MAN']:
411 from waflib import TaskGen
412 if 'MANDIR' not in bld.env:
413 bld.env['MANDIR'] = bld.env['DATAROOTDIR'] + '/man'
414 bld.env.VERSION = VERSION
415 rule_str = '${TXT2MAN} -t `basename ${TGT} | cut -f 1 -d . | tr a-z A-Z`'
416 rule_str += ' -r ${PACKAGE}\\ ${VERSION} -P ${PACKAGE}'
417 rule_str += ' -v ${PACKAGE}\\ User\\\'s\\ manual'
418 rule_str += ' -s 1 ${SRC} > ${TGT}'
419 TaskGen.declare_chain(
425 install_path = '${MANDIR}/man1',
427 bld( source = bld.path.ant_glob('doc/*.txt') )
430 # build documentation from source files using doxygen
431 if bld.env['DOXYGEN']:
432 bld( name = 'doxygen', rule = 'doxygen ${SRC} > /dev/null',
433 source = 'doc/web.cfg',
435 bld.install_files( '${DATAROOTDIR}' + '/doc/libaubio-doc',
436 bld.path.ant_glob('doc/web/html/**'),
437 cwd = bld.path.find_dir ('doc/web'),
438 relative_trick = True)
441 # build documentation from source files using sphinx-build
442 # note: build in ../doc/_build/html, otherwise waf wont install unsigned files
443 if bld.env['SPHINX']:
444 bld.env.VERSION = VERSION
445 bld( name = 'sphinx',
446 rule = '${SPHINX} -b html -D release=${VERSION} -D version=${VERSION} -a -q `dirname ${SRC}` `dirname ${TGT}`',
447 source = 'doc/conf.py',
448 target = '../doc/_build/html/index.html')
449 bld.install_files( '${DATAROOTDIR}' + '/doc/libaubio-doc/sphinx',
450 bld.path.ant_glob('doc/_build/html/**'),
451 cwd = bld.path.find_dir('doc/_build/html'),
452 relative_trick = True)
454 # register the previous rules as build rules
455 from waflib.Build import BuildContext
457 class build_txt2man(BuildContext):
461 class build_manpages(BuildContext):
465 class build_sphinx(BuildContext):
469 class build_doxygen(BuildContext):
474 from waflib import Logs
475 if bld.options.target_platform in ['ios', 'iosimulator']:
476 msg ='building for %s, contact the author for a commercial license' % bld.options.target_platform
477 Logs.pprint('RED', msg)
478 msg =' Paul Brossier <piem@aubio.org>'
479 Logs.pprint('RED', msg)
482 ctx.excl = ' **/.waf* **/*~ **/*.pyc **/*.swp **/*.swo **/*.swn **/.lock-w* **/.git*'
483 ctx.excl += ' **/build/*'
484 ctx.excl += ' doc/_build'
485 ctx.excl += ' python/demos_*'
486 ctx.excl += ' **/python/gen **/python/build **/python/dist'
487 ctx.excl += ' **/python/ext/config.h'
488 ctx.excl += ' **/python/lib/aubio/_aubio.so'
489 ctx.excl += ' **.egg-info'
490 ctx.excl += ' **/**.zip **/**.tar.bz2'
491 ctx.excl += ' **.tar.bz2'
492 ctx.excl += ' **/doc/full/* **/doc/web/*'
493 ctx.excl += ' **/doc/full.cfg'
494 ctx.excl += ' **/python/*.db'
495 ctx.excl += ' **/python.old/*'
496 ctx.excl += ' **/python/*/*.old'
497 ctx.excl += ' **/python/tests/sounds'
498 ctx.excl += ' **/**.asc'
499 ctx.excl += ' **/dist*'
500 ctx.excl += ' **/.DS_Store'
501 ctx.excl += ' **/.travis.yml'
502 ctx.excl += ' **/.landscape.yml'
503 ctx.excl += ' **/.appveyor.yml'