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