source: wscript @ 429ff6c

feature/autosinkfeature/constantqfeature/pitchshiftfeature/pydocstringsfeature/timestretch
Last change on this file since 429ff6c was 429ff6c, checked in by Paul Brossier <piem@piem.org>, 10 months ago

[waf] exclude more generated files from tarball

  • Property mode set to 100644
File size: 25.6 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)' \
46                    ' or without (--build-type=debug)' \
47                    ' compiler opimizations [default: release]')
48    add_option_enable_disable(ctx, 'fftw3f', default = False,
49            help_str = 'compile with fftw3f instead of ooura (recommended)',
50            help_disable_str = 'do not compile with fftw3f')
51    add_option_enable_disable(ctx, 'fftw3', default = False,
52            help_str = 'compile with fftw3 instead of ooura',
53            help_disable_str = 'do not compile with fftw3')
54    add_option_enable_disable(ctx, 'intelipp', default = False,
55            help_str = 'use Intel IPP libraries (auto)',
56            help_disable_str = 'do not use Intel IPP libraries')
57    add_option_enable_disable(ctx, 'complex', default = False,
58            help_str ='compile with C99 complex',
59            help_disable_str = 'do not use C99 complex (default)' )
60    add_option_enable_disable(ctx, 'jack', default = None,
61            help_str = 'compile with jack (auto)',
62            help_disable_str = 'disable jack support')
63    add_option_enable_disable(ctx, 'sndfile', default = None,
64            help_str = 'compile with sndfile (auto)',
65            help_disable_str = 'disable sndfile')
66    add_option_enable_disable(ctx, 'avcodec', default = None,
67            help_str = 'compile with libavcodec (auto)',
68            help_disable_str = 'disable libavcodec')
69    add_option_enable_disable(ctx, 'samplerate', default = None,
70            help_str = 'compile with samplerate (auto)',
71            help_disable_str = 'disable samplerate')
72    add_option_enable_disable(ctx, 'memcpy', default = True,
73            help_str = 'use memcpy hacks (default)',
74            help_disable_str = 'do not use memcpy hacks')
75    add_option_enable_disable(ctx, 'double', default = False,
76            help_str = 'compile in double precision mode',
77            help_disable_str = 'compile in single precision mode (default)')
78    add_option_enable_disable(ctx, 'fat', default = False,
79            help_str = 'build fat binaries (darwin only)',
80            help_disable_str = 'do not build fat binaries (default)')
81    add_option_enable_disable(ctx, 'accelerate', default = None,
82            help_str = 'use Accelerate framework (darwin only) (auto)',
83            help_disable_str = 'do not use Accelerate framework')
84    add_option_enable_disable(ctx, 'apple-audio', default = None,
85            help_str = 'use CoreFoundation (darwin only) (auto)',
86            help_disable_str = 'do not use CoreFoundation framework')
87    add_option_enable_disable(ctx, 'blas', default = False,
88            help_str = 'use BLAS acceleration library (no)',
89            help_disable_str = 'do not use BLAS library')
90    add_option_enable_disable(ctx, 'atlas', default = False,
91            help_str = 'use ATLAS acceleration library (no)',
92            help_disable_str = 'do not use ATLAS library')
93    add_option_enable_disable(ctx, 'wavread', default = True,
94            help_str = 'compile with source_wavread (default)',
95            help_disable_str = 'do not compile source_wavread')
96    add_option_enable_disable(ctx, 'wavwrite', default = True,
97            help_str = 'compile with source_wavwrite (default)',
98            help_disable_str = 'do not compile source_wavwrite')
99
100    add_option_enable_disable(ctx, 'docs', default = None,
101            help_str = 'build documentation (auto)',
102            help_disable_str = 'do not build documentation')
103
104    add_option_enable_disable(ctx, 'tests', default = True,
105            help_str = 'build tests (true)',
106            help_disable_str = 'do not build or run tests')
107
108    add_option_enable_disable(ctx, 'examples', default = True,
109            help_str = 'build examples (true)',
110            help_disable_str = 'do not build examples')
111
112    ctx.add_option('--with-target-platform', type='string',
113            help='set target platform for cross-compilation',
114            dest='target_platform')
115
116    ctx.load('compiler_c')
117    ctx.load('waf_unit_test')
118    ctx.load('gnu_dirs')
119    ctx.load('waf_gensyms', tooldir='.')
120
121def configure(ctx):
122    target_platform = sys.platform
123    if ctx.options.target_platform:
124        target_platform = ctx.options.target_platform
125
126    from waflib import Options
127
128    if target_platform=='emscripten':
129        ctx.load('c_emscripten')
130    else:
131        ctx.load('compiler_c')
132
133    ctx.load('waf_unit_test')
134    ctx.load('gnu_dirs')
135    ctx.load('waf_gensyms', tooldir='.')
136
137    # check for common headers
138    ctx.check(header_name='stdlib.h')
139    ctx.check(header_name='stdio.h')
140    ctx.check(header_name='math.h')
141    ctx.check(header_name='string.h')
142    ctx.check(header_name='limits.h')
143    ctx.check(header_name='stdarg.h')
144    ctx.check(header_name='getopt.h', mandatory = False)
145    ctx.check(header_name='unistd.h', mandatory = False)
146
147    ctx.env['DEST_OS'] = target_platform
148
149    if ctx.options.build_type == "debug":
150        ctx.define('DEBUG', 1)
151    else:
152        ctx.define('NDEBUG', 1)
153
154    if ctx.env.CC_NAME != 'msvc':
155        if ctx.options.build_type == "debug":
156            # no optimization in debug mode
157            ctx.env.prepend_value('CFLAGS', ['-O0'])
158        else:
159            if target_platform == 'emscripten':
160                # -Oz for small js file generation
161                ctx.env.prepend_value('CFLAGS', ['-Oz'])
162            else:
163                # default to -O2 in release mode
164                ctx.env.prepend_value('CFLAGS', ['-O2'])
165        # enable debug symbols and configure warnings
166        ctx.env.prepend_value('CFLAGS', ['-g', '-Wall', '-Wextra'])
167    else:
168        # enable debug symbols
169        ctx.env.CFLAGS += ['/Z7']
170        # /FS flag available in msvc >= 12 (2013)
171        if 'MSVC_VERSION' in ctx.env and ctx.env.MSVC_VERSION >= 12:
172            ctx.env.CFLAGS += ['/FS']
173        ctx.env.LINKFLAGS += ['/DEBUG', '/INCREMENTAL:NO']
174        # configure warnings
175        ctx.env.CFLAGS += ['/W4', '/D_CRT_SECURE_NO_WARNINGS']
176        # ignore "possible loss of data" warnings
177        ctx.env.CFLAGS += ['/wd4305', '/wd4244', '/wd4245', '/wd4267']
178        # ignore "unreferenced formal parameter" warnings
179        ctx.env.CFLAGS += ['/wd4100']
180        # set optimization level and runtime libs
181        if (ctx.options.build_type == "release"):
182            ctx.env.CFLAGS += ['/Ox']
183            ctx.env.CFLAGS += ['/MD']
184        else:
185            assert(ctx.options.build_type == "debug")
186            ctx.env.CFLAGS += ['/MDd']
187
188    ctx.check_cc(lib='m', uselib_store='M', mandatory=False)
189
190    if target_platform not in ['win32', 'win64']:
191        ctx.env.CFLAGS += ['-fPIC']
192    else:
193        ctx.define('HAVE_WIN_HACKS', 1)
194        ctx.env['cshlib_PATTERN'] = 'lib%s.dll'
195
196    if target_platform == 'darwin' and ctx.options.enable_fat:
197        ctx.env.CFLAGS += ['-arch', 'i386', '-arch', 'x86_64']
198        ctx.env.LINKFLAGS += ['-arch', 'i386', '-arch', 'x86_64']
199        MINSDKVER="10.4"
200        ctx.env.CFLAGS += [ '-mmacosx-version-min=' + MINSDKVER ]
201        ctx.env.LINKFLAGS += [ '-mmacosx-version-min=' + MINSDKVER ]
202
203    if target_platform in [ 'darwin', 'ios', 'iosimulator']:
204        if (ctx.options.enable_apple_audio != False):
205            ctx.env.FRAMEWORK += ['CoreFoundation', 'AudioToolbox']
206            ctx.define('HAVE_SOURCE_APPLE_AUDIO', 1)
207            ctx.define('HAVE_SINK_APPLE_AUDIO', 1)
208            ctx.msg('Checking for AudioToolbox.framework', 'yes')
209        else:
210            ctx.msg('Checking for AudioToolbox.framework', 'no (disabled)',
211                    color = 'YELLOW')
212        if (ctx.options.enable_accelerate != False):
213            ctx.define('HAVE_ACCELERATE', 1)
214            ctx.env.FRAMEWORK += ['Accelerate']
215            ctx.msg('Checking for Accelerate framework', 'yes')
216        else:
217            ctx.msg('Checking for Accelerate framework', 'no (disabled)',
218                    color = 'YELLOW')
219
220    if target_platform in [ 'ios', 'iosimulator' ]:
221        MINSDKVER="6.1"
222        ctx.env.CFLAGS += ['-std=c99']
223        if (ctx.options.enable_apple_audio != False):
224            ctx.define('HAVE_AUDIO_UNIT', 1)
225            #ctx.env.FRAMEWORK += ['CoreFoundation', 'AudioToolbox']
226        if target_platform == 'ios':
227            DEVROOT = "/Applications/Xcode.app/Contents"
228            DEVROOT += "/Developer/Platforms/iPhoneOS.platform/Developer"
229            SDKROOT = "%(DEVROOT)s/SDKs/iPhoneOS.sdk" % locals()
230            ctx.env.CFLAGS += [ '-fembed-bitcode' ]
231            ctx.env.CFLAGS += [ '-arch', 'arm64' ]
232            ctx.env.CFLAGS += [ '-arch', 'armv7' ]
233            ctx.env.CFLAGS += [ '-arch', 'armv7s' ]
234            ctx.env.LINKFLAGS += [ '-arch', 'arm64' ]
235            ctx.env.LINKFLAGS += ['-arch', 'armv7']
236            ctx.env.LINKFLAGS += ['-arch', 'armv7s']
237            ctx.env.CFLAGS += [ '-miphoneos-version-min=' + MINSDKVER ]
238            ctx.env.LINKFLAGS += [ '-miphoneos-version-min=' + MINSDKVER ]
239        else:
240            DEVROOT = "/Applications/Xcode.app/Contents"
241            DEVROOT += "/Developer/Platforms/iPhoneSimulator.platform/Developer"
242            SDKROOT = "%(DEVROOT)s/SDKs/iPhoneSimulator.sdk" % locals()
243            ctx.env.CFLAGS += [ '-arch', 'i386' ]
244            ctx.env.CFLAGS += [ '-arch', 'x86_64' ]
245            ctx.env.LINKFLAGS += ['-arch', 'i386']
246            ctx.env.LINKFLAGS += ['-arch', 'x86_64']
247            ctx.env.CFLAGS += [ '-mios-simulator-version-min=' + MINSDKVER ]
248            ctx.env.LINKFLAGS += [ '-mios-simulator-version-min=' + MINSDKVER ]
249        ctx.env.CFLAGS += [ '-isysroot' , SDKROOT]
250        ctx.env.LINKFLAGS += [ '-isysroot' , SDKROOT]
251
252    if target_platform == 'emscripten':
253        if ctx.options.build_type == "debug":
254            ctx.env.cshlib_PATTERN = '%s.js'
255            ctx.env.LINKFLAGS += ['-s','ASSERTIONS=2']
256            ctx.env.LINKFLAGS += ['-s','SAFE_HEAP=1']
257            ctx.env.LINKFLAGS += ['-s','ALIASING_FUNCTION_POINTERS=0']
258            ctx.env.LINKFLAGS += ['-O0']
259        else:
260            ctx.env.LINKFLAGS += ['-Oz']
261            ctx.env.cshlib_PATTERN = '%s.min.js'
262
263        # doesnt ship file system support in lib
264        ctx.env.LINKFLAGS_cshlib += ['-s', 'NO_FILESYSTEM=1']
265        # put memory file inside generated js files for easier portability
266        ctx.env.LINKFLAGS += ['--memory-init-file', '0']
267        ctx.env.cprogram_PATTERN = "%s.js"
268        ctx.env.cstlib_PATTERN = '%s.a'
269
270        # tell emscripten functions we want to expose
271        from python.lib.gen_external import get_c_declarations, \
272                get_cpp_objects_from_c_declarations, \
273                get_all_func_names_from_lib, \
274                generate_lib_from_c_declarations
275        # emscripten can't use double
276        c_decls = get_c_declarations(usedouble=False)
277        objects = list(get_cpp_objects_from_c_declarations(c_decls))
278        # ensure that aubio structs are exported
279        objects += ['fvec_t', 'cvec_t', 'fmat_t']
280        lib = generate_lib_from_c_declarations(objects, c_decls)
281        exported_funcnames = get_all_func_names_from_lib(lib)
282        c_mangled_names = ['_' + s for s in exported_funcnames]
283        ctx.env.LINKFLAGS_cshlib += ['-s',
284                'EXPORTED_FUNCTIONS=%s' % c_mangled_names]
285
286    # check support for C99 __VA_ARGS__ macros
287    check_c99_varargs = '''
288#include <stdio.h>
289#define AUBIO_ERR(...) fprintf(stderr, __VA_ARGS__)
290'''
291
292    if ctx.check_cc(fragment = check_c99_varargs,
293            type='cstlib',
294            msg = 'Checking for C99 __VA_ARGS__ macro',
295            mandatory = False):
296        ctx.define('HAVE_C99_VARARGS_MACROS', 1)
297
298    # show a message about enable_double status
299    if (ctx.options.enable_double == True):
300        ctx.msg('Checking for size of smpl_t', 'double')
301        ctx.msg('Checking for size of lsmp_t', 'long double')
302    else:
303        ctx.msg('Checking for size of smpl_t', 'float')
304        ctx.msg('Checking for size of lsmp_t', 'double')
305
306    # optionally use complex.h
307    if (ctx.options.enable_complex == True):
308        ctx.check(header_name='complex.h')
309    else:
310        ctx.msg('Checking if complex.h is enabled', 'no')
311
312    # check for Intel IPP
313    if (ctx.options.enable_intelipp != False):
314        has_ipp_headers = ctx.check(header_name=['ippcore.h', 'ippvm.h',
315            'ipps.h'], mandatory = False)
316        has_ipp_libs = ctx.check(lib=['ippcore', 'ippvm', 'ipps'],
317                uselib_store='INTEL_IPP', mandatory = False)
318        if (has_ipp_headers and has_ipp_libs):
319            ctx.msg('Checking if Intel IPP is available', 'yes')
320            ctx.define('HAVE_INTEL_IPP', 1)
321            if ctx.env.CC_NAME == 'msvc':
322                # force linking multi-threaded static IPP libraries on Windows
323                # with msvc
324                ctx.define('_IPP_SEQUENTIAL_STATIC', 1)
325        else:
326            ctx.msg('Checking if Intel IPP is available', 'no')
327
328    # check for fftw3
329    if (ctx.options.enable_fftw3 != False or ctx.options.enable_fftw3f != False):
330        # one of fftwf or fftw3f
331        if (ctx.options.enable_fftw3f != False):
332            ctx.check_cfg(package = 'fftw3f',
333                    args = '--cflags --libs fftw3f >= 3.0.0',
334                    mandatory = ctx.options.enable_fftw3f)
335            if (ctx.options.enable_double == True):
336                ctx.msg('Warning',
337                        'fftw3f enabled, but compiling in double precision!')
338        else:
339            # fftw3f disabled, take most sensible one according to
340            # enable_double
341            if (ctx.options.enable_double == True):
342                ctx.check_cfg(package = 'fftw3',
343                        args = '--cflags --libs fftw3 >= 3.0.0.',
344                        mandatory = ctx.options.enable_fftw3)
345            else:
346                ctx.check_cfg(package = 'fftw3f',
347                        args = '--cflags --libs fftw3f >= 3.0.0',
348                        mandatory = ctx.options.enable_fftw3)
349        ctx.define('HAVE_FFTW3', 1)
350
351    # fftw not enabled, use vDSP, intelIPP or ooura
352    if 'HAVE_FFTW3F' in ctx.env.define_key:
353        ctx.msg('Checking for FFT implementation', 'fftw3f')
354    elif 'HAVE_FFTW3' in ctx.env.define_key:
355        ctx.msg('Checking for FFT implementation', 'fftw3')
356    elif 'HAVE_ACCELERATE' in ctx.env.define_key:
357        ctx.msg('Checking for FFT implementation', 'vDSP')
358    elif 'HAVE_INTEL_IPP' in ctx.env.define_key:
359        ctx.msg('Checking for FFT implementation', 'Intel IPP')
360    else:
361        ctx.msg('Checking for FFT implementation', 'ooura')
362
363    # check for libsndfile
364    if (ctx.options.enable_sndfile != False):
365        ctx.check_cfg(package = 'sndfile',
366                args = '--cflags --libs sndfile >= 1.0.4',
367                mandatory = ctx.options.enable_sndfile)
368
369    # check for libsamplerate
370    if (ctx.options.enable_double):
371        if (ctx.options.enable_samplerate):
372            ctx.fatal("Could not compile aubio in double precision mode' \
373                    ' with libsamplerate")
374        else:
375            ctx.options.enable_samplerate = False
376            ctx.msg('Checking if using samplerate',
377                    'no (disabled in double precision mode)', color = 'YELLOW')
378    if (ctx.options.enable_samplerate != False):
379        ctx.check_cfg(package = 'samplerate',
380                args = '--cflags --libs samplerate >= 0.0.15',
381                mandatory = ctx.options.enable_samplerate)
382
383    # check for jack
384    if (ctx.options.enable_jack != False):
385        ctx.check_cfg(package = 'jack',
386                args = '--cflags --libs',
387                mandatory = ctx.options.enable_jack)
388
389    # check for libav
390    if (ctx.options.enable_avcodec != False):
391        ctx.check_cfg(package = 'libavcodec',
392                args = '--cflags --libs libavcodec >= 54.35.0',
393                uselib_store = 'AVCODEC',
394                mandatory = ctx.options.enable_avcodec)
395        ctx.check_cfg(package = 'libavformat',
396                args = '--cflags --libs libavformat >= 52.3.0',
397                uselib_store = 'AVFORMAT',
398                mandatory = ctx.options.enable_avcodec)
399        ctx.check_cfg(package = 'libavutil',
400                args = '--cflags --libs libavutil >= 52.3.0',
401                uselib_store = 'AVUTIL',
402                mandatory = ctx.options.enable_avcodec)
403        ctx.check_cfg(package = 'libswresample',
404                args = '--cflags --libs libswresample >= 1.2.0',
405                uselib_store = 'SWRESAMPLE',
406                mandatory = False)
407        if 'HAVE_SWRESAMPLE' not in ctx.env:
408            ctx.check_cfg(package = 'libavresample',
409                    args = '--cflags --libs libavresample >= 1.0.1',
410                    uselib_store = 'AVRESAMPLE',
411                    mandatory = False)
412
413        msg_check = 'Checking for all libav libraries'
414        if 'HAVE_AVCODEC' not in ctx.env:
415            ctx.msg(msg_check, 'not found (missing avcodec)', color = 'YELLOW')
416        elif 'HAVE_AVFORMAT' not in ctx.env:
417            ctx.msg(msg_check, 'not found (missing avformat)', color = 'YELLOW')
418        elif 'HAVE_AVUTIL' not in ctx.env:
419            ctx.msg(msg_check, 'not found (missing avutil)', color = 'YELLOW')
420        elif 'HAVE_SWRESAMPLE' not in ctx.env \
421                and 'HAVE_AVRESAMPLE' not in ctx.env:
422            resample_missing = 'not found (avresample or swresample required)'
423            ctx.msg(msg_check, resample_missing, color = 'YELLOW')
424        else:
425            ctx.msg(msg_check, 'yes')
426            if 'HAVE_SWRESAMPLE' in ctx.env:
427                ctx.define('HAVE_SWRESAMPLE', 1)
428            elif 'HAVE_AVRESAMPLE' in ctx.env:
429                ctx.define('HAVE_AVRESAMPLE', 1)
430            ctx.define('HAVE_LIBAV', 1)
431
432    if (ctx.options.enable_wavread != False):
433        ctx.define('HAVE_WAVREAD', 1)
434    ctx.msg('Checking if using source_wavread',
435            ctx.options.enable_wavread and 'yes' or 'no')
436    if (ctx.options.enable_wavwrite!= False):
437        ctx.define('HAVE_WAVWRITE', 1)
438    ctx.msg('Checking if using sink_wavwrite',
439            ctx.options.enable_wavwrite and 'yes' or 'no')
440
441    # use BLAS/ATLAS
442    if (ctx.options.enable_blas != False):
443        ctx.check_cfg(package = 'blas',
444                args = '--cflags --libs',
445                uselib_store='BLAS', mandatory = ctx.options.enable_blas)
446        if 'LIB_BLAS' in ctx.env:
447            blas_header = None
448            if ctx.env['LIBPATH_BLAS']:
449                if 'atlas' in ctx.env['LIBPATH_BLAS'][0]:
450                    blas_header = 'atlas/cblas.h'
451                elif 'openblas' in ctx.env['LIBPATH_BLAS'][0]:
452                    blas_header = 'openblas/cblas.h'
453            else:
454                blas_header = 'cblas.h'
455            ctx.check(header_name = blas_header, mandatory =
456                    ctx.options.enable_atlas)
457
458    # use memcpy hacks
459    if (ctx.options.enable_memcpy == True):
460        ctx.define('HAVE_MEMCPY_HACKS', 1)
461
462    # write configuration header
463    ctx.write_config_header('src/config.h')
464
465    # the following defines will be passed as arguments to the compiler
466    # instead of being written to src/config.h
467    ctx.define('HAVE_CONFIG_H', 1)
468
469    # add some defines used in examples
470    ctx.define('AUBIO_PREFIX', ctx.env['PREFIX'])
471    ctx.define('PACKAGE', APPNAME)
472
473    # double precision mode
474    if (ctx.options.enable_double == True):
475        ctx.define('HAVE_AUBIO_DOUBLE', 1)
476
477    if (ctx.options.enable_docs != False):
478        # check if txt2man is installed, optional
479        try:
480          ctx.find_program('txt2man', var='TXT2MAN')
481        except ctx.errors.ConfigurationError:
482          ctx.to_log('txt2man was not found (ignoring)')
483
484        # check if doxygen is installed, optional
485        try:
486          ctx.find_program('doxygen', var='DOXYGEN')
487        except ctx.errors.ConfigurationError:
488          ctx.to_log('doxygen was not found (ignoring)')
489
490        # check if sphinx-build is installed, optional
491        try:
492          ctx.find_program('sphinx-build', var='SPHINX')
493        except ctx.errors.ConfigurationError:
494          ctx.to_log('sphinx-build was not found (ignoring)')
495
496def build(bld):
497    bld.env['VERSION'] = VERSION
498    bld.env['LIB_VERSION'] = LIB_VERSION
499
500    # main source
501    bld.recurse('src')
502
503    # add sub directories
504    if bld.env['DEST_OS'] not in ['ios', 'iosimulator', 'android']:
505        if bld.env['DEST_OS']=='emscripten' and not bld.options.testcmd:
506            bld.options.testcmd = 'node %s'
507        if bld.options.enable_examples:
508            bld.recurse('examples')
509        if bld.options.enable_tests:
510            bld.recurse('tests')
511
512    # pkg-config template
513    bld( source = 'aubio.pc.in' )
514
515    # documentation
516    txt2man(bld)
517    doxygen(bld)
518    sphinx(bld)
519
520def txt2man(bld):
521    # build manpages from txt files using txt2man
522    if bld.env['TXT2MAN']:
523        from waflib import TaskGen
524        if 'MANDIR' not in bld.env:
525            bld.env['MANDIR'] = bld.env['DATAROOTDIR'] + '/man'
526        bld.env.VERSION = VERSION
527        rule_str = '${TXT2MAN} -t `basename ${TGT} | cut -f 1 -d . | tr a-z A-Z`'
528        rule_str += ' -r ${PACKAGE}\\ ${VERSION} -P ${PACKAGE}'
529        rule_str += ' -v ${PACKAGE}\\ User\\\'s\\ manual'
530        rule_str += ' -s 1 ${SRC} > ${TGT}'
531        TaskGen.declare_chain(
532                name      = 'txt2man',
533                rule      = rule_str,
534                ext_in    = '.txt',
535                ext_out   = '.1',
536                reentrant = False,
537                install_path =  '${MANDIR}/man1',
538                )
539        bld( source = bld.path.ant_glob('doc/*.txt') )
540
541def doxygen(bld):
542    # build documentation from source files using doxygen
543    if bld.env['DOXYGEN']:
544        bld.env.VERSION = VERSION
545        rule = '( cat ${SRC} && echo PROJECT_NUMBER=${VERSION}; )'
546        rule += ' | doxygen - > /dev/null'
547        bld( name = 'doxygen', rule = rule,
548                source = 'doc/web.cfg',
549                target = '../doc/web/html/index.html',
550                cwd = 'doc')
551        bld.install_files( '${DATAROOTDIR}' + '/doc/libaubio-doc',
552                bld.path.ant_glob('doc/web/html/**'),
553                cwd = bld.path.find_dir ('doc/web'),
554                relative_trick = True)
555
556def sphinx(bld):
557    # build documentation from source files using sphinx-build note: build in
558    # ../doc/_build/html, otherwise waf wont install unsigned files
559    if bld.env['SPHINX']:
560        bld.env.VERSION = VERSION
561        bld( name = 'sphinx',
562                rule = '${SPHINX} -b html -D release=${VERSION}' \
563                        ' -D version=${VERSION} -a -q' \
564                        ' `dirname ${SRC}` `dirname ${TGT}`',
565                source = 'doc/conf.py',
566                target = '../doc/_build/html/index.html')
567        bld.install_files( '${DATAROOTDIR}' + '/doc/libaubio-doc/sphinx',
568                bld.path.ant_glob('doc/_build/html/**'),
569                cwd = bld.path.find_dir('doc/_build/html'),
570                relative_trick = True)
571
572# register the previous rules as build rules
573from waflib.Build import BuildContext
574
575class build_txt2man(BuildContext):
576    cmd = 'txt2man'
577    fun = 'txt2man'
578
579class build_manpages(BuildContext):
580    cmd = 'manpages'
581    fun = 'txt2man'
582
583class build_sphinx(BuildContext):
584    cmd = 'sphinx'
585    fun = 'sphinx'
586
587class build_doxygen(BuildContext):
588    cmd = 'doxygen'
589    fun = 'doxygen'
590
591def shutdown(bld):
592    from waflib import Logs
593    if bld.options.target_platform in ['ios', 'iosimulator']:
594        msg ='building for %s, contact the author for a commercial license' \
595                % bld.options.target_platform
596        Logs.pprint('RED', msg)
597        msg ='   Paul Brossier <piem@aubio.org>'
598        Logs.pprint('RED', msg)
599
600def dist(ctx):
601    ctx.excl  = ' **/.waf*'
602    ctx.excl += ' **/.git*'
603    ctx.excl += ' **/*~ **/*.pyc **/*.swp **/*.swo **/*.swn **/.lock-w*'
604    ctx.excl += ' **/build/*'
605    ctx.excl += ' doc/_build'
606    ctx.excl += ' python/demos_*'
607    ctx.excl += ' **/python/gen **/python/build **/python/dist'
608    ctx.excl += ' **/python/ext/config.h'
609    ctx.excl += ' **/python/lib/aubio/_aubio.so'
610    ctx.excl += ' **.egg-info'
611    ctx.excl += ' **/.eggs'
612    ctx.excl += ' **/.pytest_cache'
613    ctx.excl += ' **/.cache'
614    ctx.excl += ' **/**.zip **/**.tar.bz2'
615    ctx.excl += ' **.tar.bz2'
616    ctx.excl += ' **/doc/full/* **/doc/web/*'
617    ctx.excl += ' **/doc/full.cfg'
618    ctx.excl += ' **/python/*.db'
619    ctx.excl += ' **/python.old/*'
620    ctx.excl += ' **/python/*/*.old'
621    ctx.excl += ' **/python/lib/aubio/*.so'
622    ctx.excl += ' **/python/tests/sounds'
623    ctx.excl += ' **/**.asc'
624    ctx.excl += ' **/dist*'
625    ctx.excl += ' **/.DS_Store'
626    ctx.excl += ' **/.travis.yml'
627    ctx.excl += ' **/.landscape.yml'
628    ctx.excl += ' **/.appveyor.yml'
629    ctx.excl += ' **/.circleci/*'
630    ctx.excl += ' **/azure-pipelines.yml'
631    ctx.excl += ' **/.coverage*'
Note: See TracBrowser for help on using the repository browser.