f65451dd4a32af9e6c0dded41fd7c3d454336245
[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 'CL.exe' not in ctx.env.CC[0]:
120         ctx.env.CFLAGS += ['-g', '-Wall', '-Wextra']
121     else:
122         ctx.env.CFLAGS += ['/W4']
123
124     if target_platform not in ['win32', 'win64']:
125         ctx.env.CFLAGS += ['-fPIC']
126     else:
127         ctx.define('HAVE_WIN_HACKS', 1)
128         ctx.env['cshlib_PATTERN'] = 'lib%s.dll'
129
130     if target_platform == 'darwin' and ctx.options.enable_fat:
131         ctx.env.CFLAGS += ['-arch', 'i386', '-arch', 'x86_64']
132         ctx.env.LINKFLAGS += ['-arch', 'i386', '-arch', 'x86_64']
133         MINSDKVER="10.4"
134         ctx.env.CFLAGS += [ '-mmacosx-version-min=' + MINSDKVER ]
135         ctx.env.LINKFLAGS += [ '-mmacosx-version-min=' + MINSDKVER ]
136
137     if target_platform in [ 'darwin', 'ios', 'iosimulator']:
138         if (ctx.options.enable_apple_audio != False):
139             ctx.env.FRAMEWORK += ['CoreFoundation', 'AudioToolbox']
140             ctx.define('HAVE_SOURCE_APPLE_AUDIO', 1)
141             ctx.define('HAVE_SINK_APPLE_AUDIO', 1)
142         if (ctx.options.enable_accelerate != False):
143             ctx.define('HAVE_ACCELERATE', 1)
144             ctx.env.FRAMEWORK += ['Accelerate']
145
146     if target_platform in [ 'ios', 'iosimulator' ]:
147         MINSDKVER="6.1"
148         ctx.env.CFLAGS += ['-std=c99']
149         if (ctx.options.enable_apple_audio != False):
150             ctx.define('HAVE_AUDIO_UNIT', 1)
151             #ctx.env.FRAMEWORK += ['CoreFoundation', 'AudioToolbox']
152         if target_platform == 'ios':
153             DEVROOT = "/Applications/Xcode.app/Contents"
154             DEVROOT += "/Developer/Platforms/iPhoneOS.platform/Developer"
155             SDKROOT = "%(DEVROOT)s/SDKs/iPhoneOS.sdk" % locals()
156             ctx.env.CFLAGS += [ '-fembed-bitcode' ]
157             ctx.env.CFLAGS += [ '-arch', 'arm64' ]
158             ctx.env.CFLAGS += [ '-arch', 'armv7' ]
159             ctx.env.CFLAGS += [ '-arch', 'armv7s' ]
160             ctx.env.LINKFLAGS += [ '-arch', 'arm64' ]
161             ctx.env.LINKFLAGS += ['-arch', 'armv7']
162             ctx.env.LINKFLAGS += ['-arch', 'armv7s']
163             ctx.env.CFLAGS += [ '-miphoneos-version-min=' + MINSDKVER ]
164             ctx.env.LINKFLAGS += [ '-miphoneos-version-min=' + MINSDKVER ]
165         else:
166             DEVROOT = "/Applications/Xcode.app/Contents"
167             DEVROOT += "/Developer/Platforms/iPhoneSimulator.platform/Developer"
168             SDKROOT = "%(DEVROOT)s/SDKs/iPhoneSimulator.sdk" % locals()
169             ctx.env.CFLAGS += [ '-arch', 'i386' ]
170             ctx.env.CFLAGS += [ '-arch', 'x86_64' ]
171             ctx.env.LINKFLAGS += ['-arch', 'i386']
172             ctx.env.LINKFLAGS += ['-arch', 'x86_64']
173             ctx.env.CFLAGS += [ '-mios-simulator-version-min=' + MINSDKVER ]
174             ctx.env.LINKFLAGS += [ '-mios-simulator-version-min=' + MINSDKVER ]
175         ctx.env.CFLAGS += [ '-isysroot' , SDKROOT]
176         ctx.env.LINKFLAGS += [ '-isysroot' , SDKROOT]
177
178     if target_platform == 'emscripten':
179         import os.path
180         ctx.env.CFLAGS += [ '-I' + os.path.join(os.environ['EMSCRIPTEN'], 'system', 'include') ]
181         ctx.env.CFLAGS += ['-Oz']
182         ctx.env.cprogram_PATTERN = "%s.js"
183         if (ctx.options.enable_atlas != True):
184             ctx.options.enable_atlas = False
185
186     # check support for C99 __VA_ARGS__ macros
187     check_c99_varargs = '''
188 #include <stdio.h>
189 #define AUBIO_ERR(...) fprintf(stderr, __VA_ARGS__)
190 '''
191
192     if ctx.check_cc(fragment = check_c99_varargs,
193             type='cstlib',
194             msg = 'Checking for C99 __VA_ARGS__ macro',
195             mandatory = False):
196         ctx.define('HAVE_C99_VARARGS_MACROS', 1)
197
198     # show a message about enable_double status
199     if (ctx.options.enable_double == True):
200         ctx.msg('Checking for size of smpl_t', 'double')
201         ctx.msg('Checking for size of lsmp_t', 'long double')
202     else:
203         ctx.msg('Checking for size of smpl_t', 'float')
204         ctx.msg('Checking for size of lsmp_t', 'double')
205
206     # optionally use complex.h
207     if (ctx.options.enable_complex == True):
208         ctx.check(header_name='complex.h')
209     else:
210         ctx.msg('Checking if complex.h is enabled', 'no')
211
212     # check for fftw3
213     if (ctx.options.enable_fftw3 != False or ctx.options.enable_fftw3f != False):
214         # one of fftwf or fftw3f
215         if (ctx.options.enable_fftw3f != False):
216             ctx.check_cfg(package = 'fftw3f', atleast_version = '3.0.0',
217                     args = '--cflags --libs',
218                     mandatory = ctx.options.enable_fftw3f)
219             if (ctx.options.enable_double == True):
220                 ctx.msg('Warning',
221                         'fftw3f enabled, but compiling in double precision!')
222         else:
223             # fftw3f disabled, take most sensible one according to
224             # enable_double
225             if (ctx.options.enable_double == True):
226                 ctx.check_cfg(package = 'fftw3', atleast_version = '3.0.0',
227                         args = '--cflags --libs', mandatory =
228                         ctx.options.enable_fftw3)
229             else:
230                 ctx.check_cfg(package = 'fftw3f', atleast_version = '3.0.0',
231                         args = '--cflags --libs',
232                         mandatory = ctx.options.enable_fftw3)
233         ctx.define('HAVE_FFTW3', 1)
234
235     # fftw not enabled, use vDSP or ooura
236     if 'HAVE_FFTW3F' in ctx.env.define_key:
237         ctx.msg('Checking for FFT implementation', 'fftw3f')
238     elif 'HAVE_FFTW3' in ctx.env.define_key:
239         ctx.msg('Checking for FFT implementation', 'fftw3')
240     elif 'HAVE_ACCELERATE' in ctx.env.define_key:
241         ctx.msg('Checking for FFT implementation', 'vDSP')
242     else:
243         ctx.msg('Checking for FFT implementation', 'ooura')
244
245     # check for libsndfile
246     if (ctx.options.enable_sndfile != False):
247         ctx.check_cfg(package = 'sndfile', atleast_version = '1.0.4',
248                 args = '--cflags --libs',
249                 mandatory = ctx.options.enable_sndfile)
250
251     # check for libsamplerate
252     if (ctx.options.enable_samplerate != False):
253         ctx.check_cfg(package = 'samplerate', atleast_version = '0.0.15',
254                 args = '--cflags --libs',
255                 mandatory = ctx.options.enable_samplerate)
256
257     # check for jack
258     if (ctx.options.enable_jack != False):
259         ctx.check_cfg(package = 'jack',
260                 args = '--cflags --libs',
261                 mandatory = ctx.options.enable_jack)
262
263     # check for libav
264     if (ctx.options.enable_avcodec != False):
265         ctx.check_cfg(package = 'libavcodec', atleast_version = '54.35.0',
266                 args = '--cflags --libs', uselib_store = 'AVCODEC',
267                 mandatory = ctx.options.enable_avcodec)
268         ctx.check_cfg(package = 'libavformat', atleast_version = '52.3.0',
269                 args = '--cflags --libs', uselib_store = 'AVFORMAT',
270                 mandatory = ctx.options.enable_avcodec)
271         ctx.check_cfg(package = 'libavutil', atleast_version = '52.3.0',
272                 args = '--cflags --libs', uselib_store = 'AVUTIL',
273                 mandatory = ctx.options.enable_avcodec)
274         ctx.check_cfg(package = 'libavresample', atleast_version = '1.0.1',
275                 args = '--cflags --libs', uselib_store = 'AVRESAMPLE',
276                 mandatory = ctx.options.enable_avcodec)
277         if all ( 'HAVE_' + i in ctx.env
278                 for i in ['AVCODEC', 'AVFORMAT', 'AVUTIL', 'AVRESAMPLE'] ):
279             ctx.define('HAVE_LIBAV', 1)
280             ctx.msg('Checking for all libav libraries', 'yes')
281         else:
282             ctx.msg('Checking for all libav libraries', 'not found', color = 'YELLOW')
283
284     ctx.define('HAVE_WAVREAD', 1)
285     ctx.define('HAVE_WAVWRITE', 1)
286
287     # use ATLAS
288     if (ctx.options.enable_atlas != False):
289         ctx.check(header_name = 'atlas/cblas.h', mandatory = ctx.options.enable_atlas)
290         #ctx.check(lib = 'lapack', uselib_store = 'LAPACK', mandatory = ctx.options.enable_atlas)
291         ctx.check(lib = 'cblas', uselib_store = 'BLAS', mandatory = ctx.options.enable_atlas)
292
293     # use memcpy hacks
294     if (ctx.options.enable_memcpy == True):
295         ctx.define('HAVE_MEMCPY_HACKS', 1)
296
297     # write configuration header
298     ctx.write_config_header('src/config.h')
299
300     # the following defines will be passed as arguments to the compiler
301     # instead of being written to src/config.h
302
303     # add some defines used in examples
304     ctx.define('AUBIO_PREFIX', ctx.env['PREFIX'])
305     ctx.define('PACKAGE', APPNAME)
306
307     # double precision mode
308     if (ctx.options.enable_double == True):
309         ctx.define('HAVE_AUBIO_DOUBLE', 1)
310
311     if (ctx.options.enable_docs != False):
312         # check if txt2man is installed, optional
313         try:
314           ctx.find_program('txt2man', var='TXT2MAN')
315         except ctx.errors.ConfigurationError:
316           ctx.to_log('txt2man was not found (ignoring)')
317
318         # check if doxygen is installed, optional
319         try:
320           ctx.find_program('doxygen', var='DOXYGEN')
321         except ctx.errors.ConfigurationError:
322           ctx.to_log('doxygen was not found (ignoring)')
323
324 def build(bld):
325     bld.env['VERSION'] = VERSION
326     bld.env['LIB_VERSION'] = LIB_VERSION
327
328     # add sub directories
329     bld.recurse('src')
330     if bld.env['DEST_OS'] not in ['ios', 'iosimulator', 'android']:
331         bld.recurse('examples')
332         bld.recurse('tests')
333
334     bld( source = 'aubio.pc.in' )
335
336     # build manpages from txt files using txt2man
337     if bld.env['TXT2MAN']:
338         from waflib import TaskGen
339         if 'MANDIR' not in bld.env:
340             bld.env['MANDIR'] = bld.env['PREFIX'] + '/share/man'
341         rule_str = '${TXT2MAN} -t `basename ${TGT} | cut -f 1 -d . | tr a-z A-Z`'
342         rule_str += ' -r ${PACKAGE}\\ ${VERSION} -P ${PACKAGE}'
343         rule_str += ' -v ${PACKAGE}\\ User\\\'s\\ manual'
344         rule_str += ' -s 1 ${SRC} > ${TGT}'
345         TaskGen.declare_chain(
346                 name      = 'txt2man',
347                 rule      = rule_str,
348                 ext_in    = '.txt',
349                 ext_out   = '.1',
350                 reentrant = False,
351                 install_path =  '${MANDIR}/man1',
352                 )
353         bld( source = bld.path.ant_glob('doc/*.txt') )
354
355     # build documentation from source files using doxygen
356     if bld.env['DOXYGEN']:
357         bld( name = 'doxygen', rule = 'doxygen ${SRC} > /dev/null',
358                 source = 'doc/web.cfg',
359                 cwd = 'doc')
360         bld.install_files( '${PREFIX}' + '/share/doc/libaubio-doc',
361                 bld.path.ant_glob('doc/web/html/**'),
362                 cwd = bld.path.find_dir ('doc/web'),
363                 relative_trick = True)
364
365 def shutdown(bld):
366     from waflib import Logs
367     if bld.options.target_platform in ['ios', 'iosimulator']:
368         msg ='building for %s, contact the author for a commercial license' % bld.options.target_platform
369         Logs.pprint('RED', msg)
370         msg ='   Paul Brossier <piem@aubio.org>'
371         Logs.pprint('RED', msg)
372
373 def dist(ctx):
374     ctx.excl  = ' **/.waf-1* **/*~ **/*.pyc **/*.swp **/.lock-w* **/.git*'
375     ctx.excl += ' **/build/*'
376     ctx.excl += ' **/python/gen **/python/build **/python/dist'
377     ctx.excl += ' **/**.zip **/**.tar.bz2'
378     ctx.excl += ' **/doc/full/* **/doc/web/*'
379     ctx.excl += ' **/python/*.db'
380     ctx.excl += ' **/python.old/*'
381     ctx.excl += ' **/python/tests/sounds'
382     ctx.excl += ' **/**.asc'
383     ctx.excl += ' **/.DS_Store'
384     ctx.excl += ' **/.travis.yml'