source: wscript @ 5025472

feature/autosinkfeature/constantqfeature/pitchshiftfeature/pydocstringsfeature/timestretchsampler
Last change on this file since 5025472 was 5025472, checked in by Paul Brossier <piem@piem.org>, 3 years ago

wscript: remove unused defines for now

  • Property mode set to 100644
File size: 20.9 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
17from this_version import *
18
19VERSION = get_aubio_version()
20LIB_VERSION = get_libaubio_version()
21
22top = '.'
23out = 'build'
24
25def 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
40def 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
104def 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    if ctx.options.build_type == "debug":
126        ctx.define('DEBUG', 1)
127    else:
128        ctx.define('NDEBUG', 1)
129
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'])
134        else:
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'])
139    else:
140        # enable debug symbols
141        ctx.env.CFLAGS += ['/Z7', '/FS']
142        ctx.env.LINKFLAGS += ['/DEBUG', '/INCREMENTAL:NO']
143        # configure warnings
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']
149        else:
150            assert(ctx.options.build_type == "debug")
151            ctx.env.CFLAGS += ['/MDd']
152
153    ctx.check_cc(lib='m', uselib_store='M', mandatory=False)
154
155    if target_platform not in ['win32', 'win64']:
156        ctx.env.CFLAGS += ['-fPIC']
157    else:
158        ctx.define('HAVE_WIN_HACKS', 1)
159        ctx.env['cshlib_PATTERN'] = 'lib%s.dll'
160
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']
164        MINSDKVER="10.4"
165        ctx.env.CFLAGS += [ '-mmacosx-version-min=' + MINSDKVER ]
166        ctx.env.LINKFLAGS += [ '-mmacosx-version-min=' + MINSDKVER ]
167
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')
174        else:
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')
180        else:
181            ctx.msg('Checking for Accelerate framework', 'no (disabled)', color = 'YELLOW')
182
183    if target_platform in [ 'ios', 'iosimulator' ]:
184        MINSDKVER="6.1"
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 ]
202        else:
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]
214
215    if target_platform == 'emscripten':
216        import os.path
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
222
223    # check support for C99 __VA_ARGS__ macros
224    check_c99_varargs = '''
225#include <stdio.h>
226#define AUBIO_ERR(...) fprintf(stderr, __VA_ARGS__)
227'''
228
229    if ctx.check_cc(fragment = check_c99_varargs,
230            type='cstlib',
231            msg = 'Checking for C99 __VA_ARGS__ macro',
232            mandatory = False):
233        ctx.define('HAVE_C99_VARARGS_MACROS', 1)
234
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')
239    else:
240        ctx.msg('Checking for size of smpl_t', 'float')
241        ctx.msg('Checking for size of lsmp_t', 'double')
242
243    # optionally use complex.h
244    if (ctx.options.enable_complex == True):
245        ctx.check(header_name='complex.h')
246    else:
247        ctx.msg('Checking if complex.h is enabled', 'no')
248
249    # check for fftw3
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', atleast_version = '3.0.0',
254                    args = '--cflags --libs',
255                    mandatory = ctx.options.enable_fftw3f)
256            if (ctx.options.enable_double == True):
257                ctx.msg('Warning',
258                        'fftw3f enabled, but compiling in double precision!')
259        else:
260            # fftw3f disabled, take most sensible one according to
261            # enable_double
262            if (ctx.options.enable_double == True):
263                ctx.check_cfg(package = 'fftw3', atleast_version = '3.0.0',
264                        args = '--cflags --libs', mandatory =
265                        ctx.options.enable_fftw3)
266            else:
267                ctx.check_cfg(package = 'fftw3f', atleast_version = '3.0.0',
268                        args = '--cflags --libs',
269                        mandatory = ctx.options.enable_fftw3)
270        ctx.define('HAVE_FFTW3', 1)
271
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')
279    else:
280        ctx.msg('Checking for FFT implementation', 'ooura')
281
282    # check for libsndfile
283    if (ctx.options.enable_sndfile != False):
284        ctx.check_cfg(package = 'sndfile', atleast_version = '1.0.4',
285                args = '--cflags --libs',
286                mandatory = ctx.options.enable_sndfile)
287
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")
292        else:
293            ctx.options.enable_samplerate = False
294            ctx.msg('Checking if using samplerate', 'no (disabled in double precision mode)',
295                    color = 'YELLOW')
296    if (ctx.options.enable_samplerate != False):
297        ctx.check_cfg(package = 'samplerate', atleast_version = '0.0.15',
298                args = '--cflags --libs',
299                mandatory = ctx.options.enable_samplerate)
300
301    # check for jack
302    if (ctx.options.enable_jack != False):
303        ctx.check_cfg(package = 'jack',
304                args = '--cflags --libs',
305                mandatory = ctx.options.enable_jack)
306
307    # check for libav
308    if (ctx.options.enable_avcodec != False):
309        ctx.check_cfg(package = 'libavcodec', atleast_version = '54.35.0',
310                args = '--cflags --libs', uselib_store = 'AVCODEC',
311                mandatory = ctx.options.enable_avcodec)
312        ctx.check_cfg(package = 'libavformat', atleast_version = '52.3.0',
313                args = '--cflags --libs', uselib_store = 'AVFORMAT',
314                mandatory = ctx.options.enable_avcodec)
315        ctx.check_cfg(package = 'libavutil', atleast_version = '52.3.0',
316                args = '--cflags --libs', uselib_store = 'AVUTIL',
317                mandatory = ctx.options.enable_avcodec)
318        ctx.check_cfg(package = 'libswresample', atleast_version = '2.3.0',
319                args = '--cflags --libs', uselib_store = 'SWRESAMPLE',
320                mandatory = False)
321        if 'HAVE_SWRESAMPLE' not in ctx.env:
322            ctx.check_cfg(package = 'libavresample', atleast_version = '1.0.1',
323                    args = '--cflags --libs', uselib_store = 'AVRESAMPLE',
324                    mandatory = False)
325
326        msg_check = 'Checking for all libav libraries'
327        if 'HAVE_AVCODEC' not in ctx.env:
328            ctx.msg(msg_check, 'not found (missing avcodec)', color = 'YELLOW')
329        elif 'HAVE_AVFORMAT' not in ctx.env:
330            ctx.msg(msg_check, 'not found (missing avformat)', color = 'YELLOW')
331        elif 'HAVE_AVUTIL' not in ctx.env:
332            ctx.msg(msg_check, 'not found (missing avutil)', color = 'YELLOW')
333        elif 'HAVE_SWRESAMPLE' not in ctx.env and 'HAVE_AVRESAMPLE' not in ctx.env:
334            resample_missing = 'not found (avresample or swresample required)'
335            ctx.msg(msg_check, resample_missing, color = 'YELLOW')
336        else:
337            ctx.msg(msg_check, 'yes')
338            if 'HAVE_SWRESAMPLE' in ctx.env:
339                ctx.define('HAVE_SWRESAMPLE', 1)
340            elif 'HAVE_AVRESAMPLE' in ctx.env:
341                ctx.define('HAVE_AVRESAMPLE', 1)
342            ctx.define('HAVE_LIBAV', 1)
343
344    if (ctx.options.enable_wavread != False):
345        ctx.define('HAVE_WAVREAD', 1)
346    ctx.msg('Checking if using source_wavread', ctx.options.enable_wavread and 'yes' or 'no')
347    if (ctx.options.enable_wavwrite!= False):
348        ctx.define('HAVE_WAVWRITE', 1)
349    ctx.msg('Checking if using sink_wavwrite', ctx.options.enable_wavwrite and 'yes' or 'no')
350
351    # use ATLAS
352    if (ctx.options.enable_atlas != False):
353        ctx.check(header_name = 'atlas/cblas.h', mandatory = ctx.options.enable_atlas)
354        #ctx.check(lib = 'lapack', uselib_store = 'LAPACK', mandatory = ctx.options.enable_atlas)
355        ctx.check(lib = 'cblas', uselib_store = 'BLAS', mandatory = ctx.options.enable_atlas)
356
357    # use memcpy hacks
358    if (ctx.options.enable_memcpy == True):
359        ctx.define('HAVE_MEMCPY_HACKS', 1)
360
361    # write configuration header
362    ctx.write_config_header('src/config.h')
363
364    # the following defines will be passed as arguments to the compiler
365    # instead of being written to src/config.h
366    ctx.define('HAVE_CONFIG_H', 1)
367
368    # add some defines used in examples
369    ctx.define('AUBIO_PREFIX', ctx.env['PREFIX'])
370    ctx.define('PACKAGE', APPNAME)
371
372    # double precision mode
373    if (ctx.options.enable_double == True):
374        ctx.define('HAVE_AUBIO_DOUBLE', 1)
375
376    if (ctx.options.enable_docs != False):
377        # check if txt2man is installed, optional
378        try:
379          ctx.find_program('txt2man', var='TXT2MAN')
380        except ctx.errors.ConfigurationError:
381          ctx.to_log('txt2man was not found (ignoring)')
382
383        # check if doxygen is installed, optional
384        try:
385          ctx.find_program('doxygen', var='DOXYGEN')
386        except ctx.errors.ConfigurationError:
387          ctx.to_log('doxygen was not found (ignoring)')
388
389        # check if sphinx-build is installed, optional
390        try:
391          ctx.find_program('sphinx-build', var='SPHINX')
392        except ctx.errors.ConfigurationError:
393          ctx.to_log('sphinx-build was not found (ignoring)')
394
395def build(bld):
396    bld.env['VERSION'] = VERSION
397    bld.env['LIB_VERSION'] = LIB_VERSION
398
399    # main source
400    bld.recurse('src')
401
402    # add sub directories
403    if bld.env['DEST_OS'] not in ['ios', 'iosimulator', 'android']:
404        bld.recurse('examples')
405        bld.recurse('tests')
406
407    # pkg-config template
408    bld( source = 'aubio.pc.in' )
409
410    # documentation
411    txt2man(bld)
412    doxygen(bld)
413    sphinx(bld)
414
415def txt2man(bld):
416    # build manpages from txt files using txt2man
417    if bld.env['TXT2MAN']:
418        from waflib import TaskGen
419        if 'MANDIR' not in bld.env:
420            bld.env['MANDIR'] = bld.env['DATAROOTDIR'] + '/man'
421        bld.env.VERSION = VERSION
422        rule_str = '${TXT2MAN} -t `basename ${TGT} | cut -f 1 -d . | tr a-z A-Z`'
423        rule_str += ' -r ${PACKAGE}\\ ${VERSION} -P ${PACKAGE}'
424        rule_str += ' -v ${PACKAGE}\\ User\\\'s\\ manual'
425        rule_str += ' -s 1 ${SRC} > ${TGT}'
426        TaskGen.declare_chain(
427                name      = 'txt2man',
428                rule      = rule_str,
429                ext_in    = '.txt',
430                ext_out   = '.1',
431                reentrant = False,
432                install_path =  '${MANDIR}/man1',
433                )
434        bld( source = bld.path.ant_glob('doc/*.txt') )
435
436def doxygen(bld):
437    # build documentation from source files using doxygen
438    if bld.env['DOXYGEN']:
439        bld( name = 'doxygen', rule = 'doxygen ${SRC} > /dev/null',
440                source = 'doc/web.cfg',
441                target = '../doc/web/html/index.html',
442                cwd = 'doc')
443        bld.install_files( '${DATAROOTDIR}' + '/doc/libaubio-doc',
444                bld.path.ant_glob('doc/web/html/**'),
445                cwd = bld.path.find_dir ('doc/web'),
446                relative_trick = True)
447
448def sphinx(bld):
449    # build documentation from source files using sphinx-build
450    # note: build in ../doc/_build/html, otherwise waf wont install unsigned files
451    if bld.env['SPHINX']:
452        bld.env.VERSION = VERSION
453        bld( name = 'sphinx',
454                rule = '${SPHINX} -b html -D release=${VERSION} -D version=${VERSION} -a -q `dirname ${SRC}` `dirname ${TGT}`',
455                source = 'doc/conf.py',
456                target = '../doc/_build/html/index.html')
457        bld.install_files( '${DATAROOTDIR}' + '/doc/libaubio-doc/sphinx',
458                bld.path.ant_glob('doc/_build/html/**'),
459                cwd = bld.path.find_dir('doc/_build/html'),
460                relative_trick = True)
461
462# register the previous rules as build rules
463from waflib.Build import BuildContext
464
465class build_txt2man(BuildContext):
466    cmd = 'txt2man'
467    fun = 'txt2man'
468
469class build_manpages(BuildContext):
470    cmd = 'manpages'
471    fun = 'txt2man'
472
473class build_sphinx(BuildContext):
474    cmd = 'sphinx'
475    fun = 'sphinx'
476
477class build_doxygen(BuildContext):
478    cmd = 'doxygen'
479    fun = 'doxygen'
480
481def shutdown(bld):
482    from waflib import Logs
483    if bld.options.target_platform in ['ios', 'iosimulator']:
484        msg ='building for %s, contact the author for a commercial license' % bld.options.target_platform
485        Logs.pprint('RED', msg)
486        msg ='   Paul Brossier <piem@aubio.org>'
487        Logs.pprint('RED', msg)
488
489def dist(ctx):
490    ctx.excl  = ' **/.waf* **/*~ **/*.pyc **/*.swp **/*.swo **/*.swn **/.lock-w* **/.git*'
491    ctx.excl += ' **/build/*'
492    ctx.excl += ' doc/_build'
493    ctx.excl += ' python/demos_*'
494    ctx.excl += ' **/python/gen **/python/build **/python/dist'
495    ctx.excl += ' **/python/ext/config.h'
496    ctx.excl += ' **/python/lib/aubio/_aubio.so'
497    ctx.excl += ' **.egg-info'
498    ctx.excl += ' **/**.zip **/**.tar.bz2'
499    ctx.excl += ' **.tar.bz2'
500    ctx.excl += ' **/doc/full/* **/doc/web/*'
501    ctx.excl += ' **/doc/full.cfg'
502    ctx.excl += ' **/python/*.db'
503    ctx.excl += ' **/python.old/*'
504    ctx.excl += ' **/python/*/*.old'
505    ctx.excl += ' **/python/tests/sounds'
506    ctx.excl += ' **/**.asc'
507    ctx.excl += ' **/dist*'
508    ctx.excl += ' **/.DS_Store'
509    ctx.excl += ' **/.travis.yml'
510    ctx.excl += ' **/.landscape.yml'
511    ctx.excl += ' **/.appveyor.yml'
Note: See TracBrowser for help on using the repository browser.