source: wscript @ 5a19f33

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

wscript: build sphinx in doc/_build, add a note on install trick

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