change version.py => this_version.py
[aubio.git] / wscript
1 #! /usr/bin/python
2 #
3 # usage:
4 #   $ python waf --help
5 #
6 # example:
7 #   $ ./waf distclean configure build
8 #
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/ .
12
13 import sys
14
15 APPNAME = 'aubio'
16
17 from this_version import *
18
19 VERSION = get_aubio_version()
20 LIB_VERSION = get_libaubio_version()
21
22 top = '.'
23 out = 'build'
24
25 def add_option_enable_disable(ctx, name, default = None,
26         help_str = None, help_disable_str = None):
27     if help_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',
32             default = default,
33             dest = 'enable_' + name.replace('-','_'),
34             help = help_str)
35     ctx.add_option('--disable-' + name, action = 'store_false',
36             #default = default,
37             dest = 'enable_' + name.replace('-','_'),
38             help = help_disable_str )
39
40 def options(ctx):
41     ctx.add_option('--build-type', action = 'store',
42             default = "release",
43             choices = ('debug', 'release'),
44             dest = 'build_type',
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')
92
93     add_option_enable_disable(ctx, 'docs', default = None,
94             help_str = 'build documentation (auto)',
95             help_disable_str = 'do not build documentation')
96
97     ctx.add_option('--with-target-platform', type='string',
98             help='set target platform for cross-compilation', dest='target_platform')
99
100     ctx.load('compiler_c')
101     ctx.load('waf_unit_test')
102     ctx.load('gnu_dirs')
103
104 def configure(ctx):
105     from waflib import Options
106     ctx.load('compiler_c')
107     ctx.load('waf_unit_test')
108     ctx.load('gnu_dirs')
109
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)
119
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
124
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'])
131     
132     if ctx.options.build_type == "debug":
133         ctx.define('DEBUG', 1)
134     else:
135         ctx.define('NDEBUG', 1)
136
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'])
141         else:
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'])
146     else:
147         # enable debug symbols
148         ctx.env.CFLAGS += ['/Z7', '/FS']
149         ctx.env.LINKFLAGS += ['/DEBUG', '/INCREMENTAL:NO']
150         # configure warnings
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']
156         else:
157             assert(ctx.options.build_type == "debug")
158             ctx.env.CFLAGS += ['/MDd']
159
160     ctx.check_cc(lib='m', uselib_store='M', mandatory=False)
161
162     if target_platform not in ['win32', 'win64']:
163         ctx.env.CFLAGS += ['-fPIC']
164     else:
165         ctx.define('HAVE_WIN_HACKS', 1)
166         ctx.env['cshlib_PATTERN'] = 'lib%s.dll'
167
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']
171         MINSDKVER="10.4"
172         ctx.env.CFLAGS += [ '-mmacosx-version-min=' + MINSDKVER ]
173         ctx.env.LINKFLAGS += [ '-mmacosx-version-min=' + MINSDKVER ]
174
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')
181         else:
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')
187         else:
188             ctx.msg('Checking for Accelerate framework', 'no (disabled)', color = 'YELLOW')
189
190     if target_platform in [ 'ios', 'iosimulator' ]:
191         MINSDKVER="6.1"
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 ]
209         else:
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]
221
222     if target_platform == 'emscripten':
223         import os.path
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
229
230     # check support for C99 __VA_ARGS__ macros
231     check_c99_varargs = '''
232 #include <stdio.h>
233 #define AUBIO_ERR(...) fprintf(stderr, __VA_ARGS__)
234 '''
235
236     if ctx.check_cc(fragment = check_c99_varargs,
237             type='cstlib',
238             msg = 'Checking for C99 __VA_ARGS__ macro',
239             mandatory = False):
240         ctx.define('HAVE_C99_VARARGS_MACROS', 1)
241
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')
246     else:
247         ctx.msg('Checking for size of smpl_t', 'float')
248         ctx.msg('Checking for size of lsmp_t', 'double')
249
250     # optionally use complex.h
251     if (ctx.options.enable_complex == True):
252         ctx.check(header_name='complex.h')
253     else:
254         ctx.msg('Checking if complex.h is enabled', 'no')
255
256     # check for fftw3
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):
264                 ctx.msg('Warning',
265                         'fftw3f enabled, but compiling in double precision!')
266         else:
267             # fftw3f disabled, take most sensible one according to
268             # enable_double
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)
273             else:
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)
278
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')
286     else:
287         ctx.msg('Checking for FFT implementation', 'ooura')
288
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)
294
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")
299         else:
300             ctx.options.enable_samplerate = False
301             ctx.msg('Checking if using samplerate', 'no (disabled in double precision mode)',
302                     color = 'YELLOW')
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)
307
308     # check for jack
309     if (ctx.options.enable_jack != False):
310         ctx.check_cfg(package = 'jack',
311                 args = '--cflags --libs',
312                 mandatory = ctx.options.enable_jack)
313
314     # check for libav
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 = 'libavresample', atleast_version = '1.0.1',
326                 args = '--cflags --libs', uselib_store = 'AVRESAMPLE',
327                 mandatory = ctx.options.enable_avcodec)
328         if all ( 'HAVE_' + i in ctx.env
329                 for i in ['AVCODEC', 'AVFORMAT', 'AVUTIL', 'AVRESAMPLE'] ):
330             ctx.define('HAVE_LIBAV', 1)
331             ctx.msg('Checking for all libav libraries', 'yes')
332         else:
333             ctx.msg('Checking for all libav libraries', 'not found', color = 'YELLOW')
334
335     if (ctx.options.enable_wavread != False):
336         ctx.define('HAVE_WAVREAD', 1)
337     ctx.msg('Checking if using source_wavread', ctx.options.enable_wavread and 'yes' or 'no')
338     if (ctx.options.enable_wavwrite!= False):
339         ctx.define('HAVE_WAVWRITE', 1)
340     ctx.msg('Checking if using sink_wavwrite', ctx.options.enable_wavwrite and 'yes' or 'no')
341
342     # use ATLAS
343     if (ctx.options.enable_atlas != False):
344         ctx.check(header_name = 'atlas/cblas.h', mandatory = ctx.options.enable_atlas)
345         #ctx.check(lib = 'lapack', uselib_store = 'LAPACK', mandatory = ctx.options.enable_atlas)
346         ctx.check(lib = 'cblas', uselib_store = 'BLAS', mandatory = ctx.options.enable_atlas)
347
348     # use memcpy hacks
349     if (ctx.options.enable_memcpy == True):
350         ctx.define('HAVE_MEMCPY_HACKS', 1)
351
352     # write configuration header
353     ctx.write_config_header('src/config.h')
354
355     # the following defines will be passed as arguments to the compiler
356     # instead of being written to src/config.h
357     ctx.define('HAVE_CONFIG_H', 1)
358
359     # add some defines used in examples
360     ctx.define('AUBIO_PREFIX', ctx.env['PREFIX'])
361     ctx.define('PACKAGE', APPNAME)
362
363     # double precision mode
364     if (ctx.options.enable_double == True):
365         ctx.define('HAVE_AUBIO_DOUBLE', 1)
366
367     if (ctx.options.enable_docs != False):
368         # check if txt2man is installed, optional
369         try:
370           ctx.find_program('txt2man', var='TXT2MAN')
371         except ctx.errors.ConfigurationError:
372           ctx.to_log('txt2man was not found (ignoring)')
373
374         # check if doxygen is installed, optional
375         try:
376           ctx.find_program('doxygen', var='DOXYGEN')
377         except ctx.errors.ConfigurationError:
378           ctx.to_log('doxygen was not found (ignoring)')
379
380         # check if sphinx-build is installed, optional
381         try:
382           ctx.find_program('sphinx-build', var='SPHINX')
383         except ctx.errors.ConfigurationError:
384           ctx.to_log('sphinx-build was not found (ignoring)')
385
386 def build(bld):
387     bld.env['VERSION'] = VERSION
388     bld.env['LIB_VERSION'] = LIB_VERSION
389
390     # main source
391     bld.recurse('src')
392
393     # add sub directories
394     if bld.env['DEST_OS'] not in ['ios', 'iosimulator', 'android']:
395         bld.recurse('examples')
396         bld.recurse('tests')
397
398     # pkg-config template
399     bld( source = 'aubio.pc.in' )
400
401     # documentation
402     txt2man(bld)
403     doxygen(bld)
404     sphinx(bld)
405
406 def txt2man(bld):
407     # build manpages from txt files using txt2man
408     if bld.env['TXT2MAN']:
409         from waflib import TaskGen
410         if 'MANDIR' not in bld.env:
411             bld.env['MANDIR'] = bld.env['DATAROOTDIR'] + '/man'
412         bld.env.VERSION = VERSION
413         rule_str = '${TXT2MAN} -t `basename ${TGT} | cut -f 1 -d . | tr a-z A-Z`'
414         rule_str += ' -r ${PACKAGE}\\ ${VERSION} -P ${PACKAGE}'
415         rule_str += ' -v ${PACKAGE}\\ User\\\'s\\ manual'
416         rule_str += ' -s 1 ${SRC} > ${TGT}'
417         TaskGen.declare_chain(
418                 name      = 'txt2man',
419                 rule      = rule_str,
420                 ext_in    = '.txt',
421                 ext_out   = '.1',
422                 reentrant = False,
423                 install_path =  '${MANDIR}/man1',
424                 )
425         bld( source = bld.path.ant_glob('doc/*.txt') )
426
427 def doxygen(bld):
428     # build documentation from source files using doxygen
429     if bld.env['DOXYGEN']:
430         bld( name = 'doxygen', rule = 'doxygen ${SRC} > /dev/null',
431                 source = 'doc/web.cfg',
432                 target = '../doc/web/html/index.html',
433                 cwd = 'doc')
434         bld.install_files( '${DATAROOTDIR}' + '/doc/libaubio-doc',
435                 bld.path.ant_glob('doc/web/html/**'),
436                 cwd = bld.path.find_dir ('doc/web'),
437                 relative_trick = True)
438
439 def sphinx(bld):
440     # build documentation from source files using sphinx-build
441     # note: build in ../doc/_build/html, otherwise waf wont install unsigned files
442     if bld.env['SPHINX']:
443         bld.env.VERSION = VERSION
444         bld( name = 'sphinx',
445                 rule = '${SPHINX} -b html -D release=${VERSION} -D version=${VERSION} -a -q `dirname ${SRC}` `dirname ${TGT}`',
446                 source = 'doc/conf.py',
447                 target = '../doc/_build/html/index.html')
448         bld.install_files( '${DATAROOTDIR}' + '/doc/libaubio-doc/sphinx',
449                 bld.path.ant_glob('doc/_build/html/**'),
450                 cwd = bld.path.find_dir('doc/_build/html'),
451                 relative_trick = True)
452
453 # register the previous rules as build rules
454 from waflib.Build import BuildContext
455
456 class build_txt2man(BuildContext):
457     cmd = 'txt2man'
458     fun = 'txt2man'
459
460 class build_manpages(BuildContext):
461     cmd = 'manpages'
462     fun = 'txt2man'
463
464 class build_sphinx(BuildContext):
465     cmd = 'sphinx'
466     fun = 'sphinx'
467
468 class build_doxygen(BuildContext):
469     cmd = 'doxygen'
470     fun = 'doxygen'
471
472 def shutdown(bld):
473     from waflib import Logs
474     if bld.options.target_platform in ['ios', 'iosimulator']:
475         msg ='building for %s, contact the author for a commercial license' % bld.options.target_platform
476         Logs.pprint('RED', msg)
477         msg ='   Paul Brossier <piem@aubio.org>'
478         Logs.pprint('RED', msg)
479
480 def dist(ctx):
481     ctx.excl  = ' **/.waf* **/*~ **/*.pyc **/*.swp **/*.swo **/*.swn **/.lock-w* **/.git*'
482     ctx.excl += ' **/build/*'
483     ctx.excl += ' doc/_build'
484     ctx.excl += ' python/demos_*'
485     ctx.excl += ' **/python/gen **/python/build **/python/dist'
486     ctx.excl += ' **/python/ext/config.h'
487     ctx.excl += ' **/python/lib/aubio/_aubio.so'
488     ctx.excl += ' **.egg-info'
489     ctx.excl += ' **/**.zip **/**.tar.bz2'
490     ctx.excl += ' **.tar.bz2'
491     ctx.excl += ' **/doc/full/* **/doc/web/*'
492     ctx.excl += ' **/doc/full.cfg'
493     ctx.excl += ' **/python/*.db'
494     ctx.excl += ' **/python.old/*'
495     ctx.excl += ' **/python/*/*.old'
496     ctx.excl += ' **/python/tests/sounds'
497     ctx.excl += ' **/**.asc'
498     ctx.excl += ' **/dist*'
499     ctx.excl += ' **/.DS_Store'
500     ctx.excl += ' **/.travis.yml'
501     ctx.excl += ' **/.landscape.yml'
502     ctx.excl += ' **/.appveyor.yml'