source: wscript @ 255c4c8

feature/autosinkfeature/cnnfeature/cnn_orgfeature/constantqfeature/crepefeature/crepe_orgfeature/pitchshiftfeature/pydocstringsfeature/timestretchfix/ffmpeg5sampler
Last change on this file since 255c4c8 was 255c4c8, checked in by Martin Hermant <martin.hermant@gmail.com>, 7 years ago

cleaner api for Version.py

  • Property mode set to 100644
File size: 20.5 KB
Line 
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
13import sys
14
15APPNAME = 'aubio'
16
17# source VERSION
18
19
20from Version import *
21
22
23
24
25VERSION = get_aubio_version()
26LIB_VERSION = get_libaubio_version()
27
28top = '.'
29out = 'build'
30
31def add_option_enable_disable(ctx, name, default = None,
32        help_str = None, help_disable_str = None):
33    if help_str == None:
34        help_str = 'enable ' + name + ' support'
35    if help_disable_str == None:
36        help_disable_str = 'do not ' + help_str
37    ctx.add_option('--enable-' + name, action = 'store_true',
38            default = default,
39            dest = 'enable_' + name.replace('-','_'),
40            help = help_str)
41    ctx.add_option('--disable-' + name, action = 'store_false',
42            #default = default,
43            dest = 'enable_' + name.replace('-','_'),
44            help = help_disable_str )
45
46def options(ctx):
47    ctx.add_option('--build-type', action = 'store',
48            default = "release",
49            choices = ('debug', 'release'),
50            dest = 'build_type',
51            help = 'whether to compile with (--build-type=release) or without (--build-type=debug) '\
52              ' compiler opimizations [default: release]')
53    add_option_enable_disable(ctx, 'fftw3f', default = False,
54            help_str = 'compile with fftw3f instead of ooura (recommended)',
55            help_disable_str = 'do not compile with fftw3f')
56    add_option_enable_disable(ctx, 'fftw3', default = False,
57            help_str = 'compile with fftw3 instead of ooura',
58            help_disable_str = 'do not compile with fftw3')
59    add_option_enable_disable(ctx, 'complex', default = False,
60            help_str ='compile with C99 complex',
61            help_disable_str = 'do not use C99 complex (default)' )
62    add_option_enable_disable(ctx, 'jack', default = None,
63            help_str = 'compile with jack (auto)',
64            help_disable_str = 'disable jack support')
65    add_option_enable_disable(ctx, 'sndfile', default = None,
66            help_str = 'compile with sndfile (auto)',
67            help_disable_str = 'disable sndfile')
68    add_option_enable_disable(ctx, 'avcodec', default = None,
69            help_str = 'compile with libavcodec (auto)',
70            help_disable_str = 'disable libavcodec')
71    add_option_enable_disable(ctx, 'samplerate', default = None,
72            help_str = 'compile with samplerate (auto)',
73            help_disable_str = 'disable samplerate')
74    add_option_enable_disable(ctx, 'memcpy', default = True,
75            help_str = 'use memcpy hacks (default)',
76            help_disable_str = 'do not use memcpy hacks')
77    add_option_enable_disable(ctx, 'double', default = False,
78            help_str = 'compile in double precision mode',
79            help_disable_str = 'compile in single precision mode (default)')
80    add_option_enable_disable(ctx, 'fat', default = False,
81            help_str = 'build fat binaries (darwin only)',
82            help_disable_str = 'do not build fat binaries (default)')
83    add_option_enable_disable(ctx, 'accelerate', default = None,
84            help_str = 'use Accelerate framework (darwin only) (auto)',
85            help_disable_str = 'do not use Accelerate framework')
86    add_option_enable_disable(ctx, 'apple-audio', default = None,
87            help_str = 'use CoreFoundation (darwin only) (auto)',
88            help_disable_str = 'do not use CoreFoundation framework')
89    add_option_enable_disable(ctx, 'atlas', default = False,
90            help_str = 'use Atlas library (no)',
91            help_disable_str = 'do not use Atlas library')
92    add_option_enable_disable(ctx, 'wavread', default = True,
93            help_str = 'compile with source_wavread (default)',
94            help_disable_str = 'do not compile source_wavread')
95    add_option_enable_disable(ctx, 'wavwrite', default = True,
96            help_str = 'compile with source_wavwrite (default)',
97            help_disable_str = 'do not compile source_wavwrite')
98
99    add_option_enable_disable(ctx, 'docs', default = None,
100            help_str = 'build documentation (auto)',
101            help_disable_str = 'do not build documentation')
102
103    ctx.add_option('--with-target-platform', type='string',
104            help='set target platform for cross-compilation', dest='target_platform')
105
106    ctx.load('compiler_c')
107    ctx.load('waf_unit_test')
108    ctx.load('gnu_dirs')
109
110def configure(ctx):
111    from waflib import Options
112    ctx.load('compiler_c')
113    ctx.load('waf_unit_test')
114    ctx.load('gnu_dirs')
115
116    # check for common headers
117    ctx.check(header_name='stdlib.h')
118    ctx.check(header_name='stdio.h')
119    ctx.check(header_name='math.h')
120    ctx.check(header_name='string.h')
121    ctx.check(header_name='limits.h')
122    ctx.check(header_name='stdarg.h')
123    ctx.check(header_name='getopt.h', mandatory = False)
124    ctx.check(header_name='unistd.h', mandatory = False)
125
126    target_platform = sys.platform
127    if ctx.options.target_platform:
128        target_platform = ctx.options.target_platform
129    ctx.env['DEST_OS'] = target_platform
130
131    version_dict = get_version_info();
132    ctx.define('AUBIO_VERSION',VERSION)
133    ctx.define('AUBIO_MAJOR_VERSION', version_dict['AUBIO_MAJOR_VERSION'])
134    ctx.define('AUBIO_MINOR_VERSION', version_dict['AUBIO_MINOR_VERSION'])
135    ctx.define('AUBIO_PATCH_VERSION', version_dict['AUBIO_PATCH_VERSION'])
136    ctx.define('AUBIO_VERSION_STATUS', version_dict['AUBIO_VERSION_STATUS'])
137   
138    if ctx.options.build_type == "debug":
139        ctx.define('DEBUG', 1)
140    else:
141        ctx.define('NDEBUG', 1)
142
143    if ctx.env.CC_NAME != 'msvc':
144        if ctx.options.build_type == "debug":
145            # no optimization in debug mode
146            ctx.env.prepend_value('CFLAGS', ['-O0'])
147        else:
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'])
152    else:
153        # enable debug symbols
154        ctx.env.CFLAGS += ['/Z7', '/FS']
155        ctx.env.LINKFLAGS += ['/DEBUG', '/INCREMENTAL:NO']
156        # configure warnings
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']
162        else:
163            assert(ctx.options.build_type == "debug")
164            ctx.env.CFLAGS += ['/MDd']
165
166    ctx.check_cc(lib='m', uselib_store='M', mandatory=False)
167
168    if target_platform not in ['win32', 'win64']:
169        ctx.env.CFLAGS += ['-fPIC']
170    else:
171        ctx.define('HAVE_WIN_HACKS', 1)
172        ctx.env['cshlib_PATTERN'] = 'lib%s.dll'
173
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']
177        MINSDKVER="10.4"
178        ctx.env.CFLAGS += [ '-mmacosx-version-min=' + MINSDKVER ]
179        ctx.env.LINKFLAGS += [ '-mmacosx-version-min=' + MINSDKVER ]
180
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')
187        else:
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')
193        else:
194            ctx.msg('Checking for Accelerate framework', 'no (disabled)', color = 'YELLOW')
195
196    if target_platform in [ 'ios', 'iosimulator' ]:
197        MINSDKVER="6.1"
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 ]
215        else:
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]
227
228    if target_platform == 'emscripten':
229        import os.path
230        ctx.env.CFLAGS += [ '-I' + os.path.join(os.environ['EMSCRIPTEN'], 'system', 'include') ]
231        ctx.env.CFLAGS += ['-Oz']
232        ctx.env.cprogram_PATTERN = "%s.js"
233        if (ctx.options.enable_atlas != True):
234            ctx.options.enable_atlas = False
235
236    # check support for C99 __VA_ARGS__ macros
237    check_c99_varargs = '''
238#include <stdio.h>
239#define AUBIO_ERR(...) fprintf(stderr, __VA_ARGS__)
240'''
241
242    if ctx.check_cc(fragment = check_c99_varargs,
243            type='cstlib',
244            msg = 'Checking for C99 __VA_ARGS__ macro',
245            mandatory = False):
246        ctx.define('HAVE_C99_VARARGS_MACROS', 1)
247
248    # show a message about enable_double status
249    if (ctx.options.enable_double == True):
250        ctx.msg('Checking for size of smpl_t', 'double')
251        ctx.msg('Checking for size of lsmp_t', 'long double')
252    else:
253        ctx.msg('Checking for size of smpl_t', 'float')
254        ctx.msg('Checking for size of lsmp_t', 'double')
255
256    # optionally use complex.h
257    if (ctx.options.enable_complex == True):
258        ctx.check(header_name='complex.h')
259    else:
260        ctx.msg('Checking if complex.h is enabled', 'no')
261
262    # check for fftw3
263    if (ctx.options.enable_fftw3 != False or ctx.options.enable_fftw3f != False):
264        # one of fftwf or fftw3f
265        if (ctx.options.enable_fftw3f != False):
266            ctx.check_cfg(package = 'fftw3f', atleast_version = '3.0.0',
267                    args = '--cflags --libs',
268                    mandatory = ctx.options.enable_fftw3f)
269            if (ctx.options.enable_double == True):
270                ctx.msg('Warning',
271                        'fftw3f enabled, but compiling in double precision!')
272        else:
273            # fftw3f disabled, take most sensible one according to
274            # enable_double
275            if (ctx.options.enable_double == True):
276                ctx.check_cfg(package = 'fftw3', atleast_version = '3.0.0',
277                        args = '--cflags --libs', mandatory =
278                        ctx.options.enable_fftw3)
279            else:
280                ctx.check_cfg(package = 'fftw3f', atleast_version = '3.0.0',
281                        args = '--cflags --libs',
282                        mandatory = ctx.options.enable_fftw3)
283        ctx.define('HAVE_FFTW3', 1)
284
285    # fftw not enabled, use vDSP or ooura
286    if 'HAVE_FFTW3F' in ctx.env.define_key:
287        ctx.msg('Checking for FFT implementation', 'fftw3f')
288    elif 'HAVE_FFTW3' in ctx.env.define_key:
289        ctx.msg('Checking for FFT implementation', 'fftw3')
290    elif 'HAVE_ACCELERATE' in ctx.env.define_key:
291        ctx.msg('Checking for FFT implementation', 'vDSP')
292    else:
293        ctx.msg('Checking for FFT implementation', 'ooura')
294
295    # check for libsndfile
296    if (ctx.options.enable_sndfile != False):
297        ctx.check_cfg(package = 'sndfile', atleast_version = '1.0.4',
298                args = '--cflags --libs',
299                mandatory = ctx.options.enable_sndfile)
300
301    # check for libsamplerate
302    if (ctx.options.enable_double):
303        if (ctx.options.enable_samplerate):
304            ctx.fatal("Could not compile aubio in double precision mode with libsamplerate")
305        else:
306            ctx.options.enable_samplerate = False
307            ctx.msg('Checking if using samplerate', 'no (disabled in double precision mode)',
308                    color = 'YELLOW')
309    if (ctx.options.enable_samplerate != False):
310        ctx.check_cfg(package = 'samplerate', atleast_version = '0.0.15',
311                args = '--cflags --libs',
312                mandatory = ctx.options.enable_samplerate)
313
314    # check for jack
315    if (ctx.options.enable_jack != False):
316        ctx.check_cfg(package = 'jack',
317                args = '--cflags --libs',
318                mandatory = ctx.options.enable_jack)
319
320    # check for libav
321    if (ctx.options.enable_avcodec != False):
322        ctx.check_cfg(package = 'libavcodec', atleast_version = '54.35.0',
323                args = '--cflags --libs', uselib_store = 'AVCODEC',
324                mandatory = ctx.options.enable_avcodec)
325        ctx.check_cfg(package = 'libavformat', atleast_version = '52.3.0',
326                args = '--cflags --libs', uselib_store = 'AVFORMAT',
327                mandatory = ctx.options.enable_avcodec)
328        ctx.check_cfg(package = 'libavutil', atleast_version = '52.3.0',
329                args = '--cflags --libs', uselib_store = 'AVUTIL',
330                mandatory = ctx.options.enable_avcodec)
331        ctx.check_cfg(package = 'libavresample', atleast_version = '1.0.1',
332                args = '--cflags --libs', uselib_store = 'AVRESAMPLE',
333                mandatory = ctx.options.enable_avcodec)
334        if all ( 'HAVE_' + i in ctx.env
335                for i in ['AVCODEC', 'AVFORMAT', 'AVUTIL', 'AVRESAMPLE'] ):
336            ctx.define('HAVE_LIBAV', 1)
337            ctx.msg('Checking for all libav libraries', 'yes')
338        else:
339            ctx.msg('Checking for all libav libraries', 'not found', color = 'YELLOW')
340
341    if (ctx.options.enable_wavread != False):
342        ctx.define('HAVE_WAVREAD', 1)
343    ctx.msg('Checking if using source_wavread', ctx.options.enable_wavread and 'yes' or 'no')
344    if (ctx.options.enable_wavwrite!= False):
345        ctx.define('HAVE_WAVWRITE', 1)
346    ctx.msg('Checking if using sink_wavwrite', ctx.options.enable_wavwrite and 'yes' or 'no')
347
348    # use ATLAS
349    if (ctx.options.enable_atlas != False):
350        ctx.check(header_name = 'atlas/cblas.h', mandatory = ctx.options.enable_atlas)
351        #ctx.check(lib = 'lapack', uselib_store = 'LAPACK', mandatory = ctx.options.enable_atlas)
352        ctx.check(lib = 'cblas', uselib_store = 'BLAS', mandatory = ctx.options.enable_atlas)
353
354    # use memcpy hacks
355    if (ctx.options.enable_memcpy == True):
356        ctx.define('HAVE_MEMCPY_HACKS', 1)
357
358    # write configuration header
359    ctx.write_config_header('src/config.h')
360
361    # the following defines will be passed as arguments to the compiler
362    # instead of being written to src/config.h
363    ctx.define('HAVE_CONFIG_H', 1)
364
365    # add some defines used in examples
366    ctx.define('AUBIO_PREFIX', ctx.env['PREFIX'])
367    ctx.define('PACKAGE', APPNAME)
368
369    # double precision mode
370    if (ctx.options.enable_double == True):
371        ctx.define('HAVE_AUBIO_DOUBLE', 1)
372
373    if (ctx.options.enable_docs != False):
374        # check if txt2man is installed, optional
375        try:
376          ctx.find_program('txt2man', var='TXT2MAN')
377        except ctx.errors.ConfigurationError:
378          ctx.to_log('txt2man was not found (ignoring)')
379
380        # check if doxygen is installed, optional
381        try:
382          ctx.find_program('doxygen', var='DOXYGEN')
383        except ctx.errors.ConfigurationError:
384          ctx.to_log('doxygen was not found (ignoring)')
385
386        # check if sphinx-build is installed, optional
387        try:
388          ctx.find_program('sphinx-build', var='SPHINX')
389        except ctx.errors.ConfigurationError:
390          ctx.to_log('sphinx-build was not found (ignoring)')
391
392def build(bld):
393    bld.env['VERSION'] = VERSION
394    bld.env['LIB_VERSION'] = LIB_VERSION
395
396    # main source
397    bld.recurse('src')
398
399    # add sub directories
400    if bld.env['DEST_OS'] not in ['ios', 'iosimulator', 'android']:
401        bld.recurse('examples')
402        bld.recurse('tests')
403
404    # pkg-config template
405    bld( source = 'aubio.pc.in' )
406
407    # documentation
408    txt2man(bld)
409    doxygen(bld)
410    sphinx(bld)
411
412def txt2man(bld):
413    # build manpages from txt files using txt2man
414    if bld.env['TXT2MAN']:
415        from waflib import TaskGen
416        if 'MANDIR' not in bld.env:
417            bld.env['MANDIR'] = bld.env['DATAROOTDIR'] + '/man'
418        bld.env.VERSION = VERSION
419        rule_str = '${TXT2MAN} -t `basename ${TGT} | cut -f 1 -d . | tr a-z A-Z`'
420        rule_str += ' -r ${PACKAGE}\\ ${VERSION} -P ${PACKAGE}'
421        rule_str += ' -v ${PACKAGE}\\ User\\\'s\\ manual'
422        rule_str += ' -s 1 ${SRC} > ${TGT}'
423        TaskGen.declare_chain(
424                name      = 'txt2man',
425                rule      = rule_str,
426                ext_in    = '.txt',
427                ext_out   = '.1',
428                reentrant = False,
429                install_path =  '${MANDIR}/man1',
430                )
431        bld( source = bld.path.ant_glob('doc/*.txt') )
432
433def doxygen(bld):
434    # build documentation from source files using doxygen
435    if bld.env['DOXYGEN']:
436        bld( name = 'doxygen', rule = 'doxygen ${SRC} > /dev/null',
437                source = 'doc/web.cfg',
438                target = '../doc/web/html/index.html',
439                cwd = 'doc')
440        bld.install_files( '${DATAROOTDIR}' + '/doc/libaubio-doc',
441                bld.path.ant_glob('doc/web/html/**'),
442                cwd = bld.path.find_dir ('doc/web'),
443                relative_trick = True)
444
445def sphinx(bld):
446    # build documentation from source files using sphinx-build
447    # note: build in ../doc/_build/html, otherwise waf wont install unsigned files
448    if bld.env['SPHINX']:
449        bld.env.VERSION = VERSION
450        bld( name = 'sphinx',
451                rule = '${SPHINX} -b html -D release=${VERSION} -D version=${VERSION} -a -q `dirname ${SRC}` `dirname ${TGT}`',
452                source = 'doc/conf.py',
453                target = '../doc/_build/html/index.html')
454        bld.install_files( '${DATAROOTDIR}' + '/doc/libaubio-doc/sphinx',
455                bld.path.ant_glob('doc/_build/html/**'),
456                cwd = bld.path.find_dir('doc/_build/html'),
457                relative_trick = True)
458
459# register the previous rules as build rules
460from waflib.Build import BuildContext
461
462class build_txt2man(BuildContext):
463    cmd = 'txt2man'
464    fun = 'txt2man'
465
466class build_manpages(BuildContext):
467    cmd = 'manpages'
468    fun = 'txt2man'
469
470class build_sphinx(BuildContext):
471    cmd = 'sphinx'
472    fun = 'sphinx'
473
474class build_doxygen(BuildContext):
475    cmd = 'doxygen'
476    fun = 'doxygen'
477
478def shutdown(bld):
479    from waflib import Logs
480    if bld.options.target_platform in ['ios', 'iosimulator']:
481        msg ='building for %s, contact the author for a commercial license' % bld.options.target_platform
482        Logs.pprint('RED', msg)
483        msg ='   Paul Brossier <piem@aubio.org>'
484        Logs.pprint('RED', msg)
485
486def dist(ctx):
487    ctx.excl  = ' **/.waf* **/*~ **/*.pyc **/*.swp **/*.swo **/*.swn **/.lock-w* **/.git*'
488    ctx.excl += ' **/build/*'
489    ctx.excl += ' doc/_build'
490    ctx.excl += ' python/demos_*'
491    ctx.excl += ' **/python/gen **/python/build **/python/dist'
492    ctx.excl += ' **/python/ext/config.h'
493    ctx.excl += ' **/python/lib/aubio/_aubio.so'
494    ctx.excl += ' **.egg-info'
495    ctx.excl += ' **/**.zip **/**.tar.bz2'
496    ctx.excl += ' **.tar.bz2'
497    ctx.excl += ' **/doc/full/* **/doc/web/*'
498    ctx.excl += ' **/doc/full.cfg'
499    ctx.excl += ' **/python/*.db'
500    ctx.excl += ' **/python.old/*'
501    ctx.excl += ' **/python/*/*.old'
502    ctx.excl += ' **/python/tests/sounds'
503    ctx.excl += ' **/**.asc'
504    ctx.excl += ' **/dist*'
505    ctx.excl += ' **/.DS_Store'
506    ctx.excl += ' **/.travis.yml'
507    ctx.excl += ' **/.landscape.yml'
508    ctx.excl += ' **/.appveyor.yml'
Note: See TracBrowser for help on using the repository browser.