1 """ A collection of function used from setup.py distutils script """
3 import sys, os, glob, subprocess
4 import distutils, distutils.command.clean, distutils.dir_util
5 from .gen_external import generate_external, header, output_path
7 from this_version import get_aubio_version
9 # inspired from https://gist.github.com/abergmeier/9488990
10 def add_packages(packages, ext=None, **kw):
11 """ use pkg-config to search which of 'packages' are installed """
17 # if a setuptools extension is passed, fill it with pkg-config results
19 kw = {'include_dirs': ext.include_dirs,
20 'extra_link_args': ext.extra_link_args,
21 'library_dirs': ext.library_dirs,
22 'libraries': ext.libraries,
25 for package in packages:
26 print("checking for {:s}".format(package))
27 cmd = ['pkg-config', '--libs', '--cflags', package]
29 tokens = subprocess.check_output(cmd)
30 except Exception as e:
31 print("Running \"{:s}\" failed: {:s}".format(' '.join(cmd), repr(e)))
33 tokens = tokens.decode('utf8').split()
40 arg = 'extra_link_args'
42 kw.setdefault(arg, []).append(value)
43 for key, value in iter(kw.items()): # remove duplicated
44 kw[key] = list(set(value))
47 def add_local_aubio_header(ext):
48 """ use local "src/aubio.h", not <aubio/aubio.h>"""
49 ext.define_macros += [('USE_LOCAL_AUBIO', 1)]
50 ext.include_dirs += ['src'] # aubio.h
52 def add_local_aubio_lib(ext):
53 """ add locally built libaubio from build/src """
54 print("Info: using locally built libaubio")
55 ext.library_dirs += [os.path.join('build', 'src')]
56 ext.libraries += ['aubio']
58 def add_local_aubio_sources(ext):
59 """ build aubio inside python module instead of linking against libaubio """
60 print("Info: libaubio was not installed or built locally with waf, adding src/")
61 aubio_sources = sorted(glob.glob(os.path.join('src', '**.c')))
62 aubio_sources += sorted(glob.glob(os.path.join('src', '*', '**.c')))
63 ext.sources += aubio_sources
65 def add_local_macros(ext, usedouble = False):
67 ext.define_macros += [('HAVE_AUBIO_DOUBLE', 1)]
68 # define macros (waf puts them in build/src/config.h)
69 for define_macro in ['HAVE_STDLIB_H', 'HAVE_STDIO_H',
70 'HAVE_MATH_H', 'HAVE_STRING_H',
71 'HAVE_C99_VARARGS_MACROS',
72 'HAVE_LIMITS_H', 'HAVE_STDARG_H',
74 ext.define_macros += [(define_macro, 1)]
76 def add_external_deps(ext, usedouble = False):
77 # loof for additional packages
78 print("Info: looking for *optional* additional packages")
79 packages = ['libavcodec', 'libavformat', 'libavutil',
80 'libswresample', 'libavresample',
84 # samplerate only works with float
85 if usedouble is False:
86 packages += ['samplerate']
88 print("Info: not adding libsamplerate in double precision mode")
89 add_packages(packages, ext=ext)
90 if 'avcodec' in ext.libraries \
91 and 'avformat' in ext.libraries \
92 and 'avutil' in ext.libraries:
93 if 'swresample' in ext.libraries:
94 ext.define_macros += [('HAVE_SWRESAMPLE', 1)]
95 elif 'avresample' in ext.libraries:
96 ext.define_macros += [('HAVE_AVRESAMPLE', 1)]
97 if 'swresample' in ext.libraries or 'avresample' in ext.libraries:
98 ext.define_macros += [('HAVE_LIBAV', 1)]
99 if 'sndfile' in ext.libraries:
100 ext.define_macros += [('HAVE_SNDFILE', 1)]
101 if 'samplerate' in ext.libraries:
102 ext.define_macros += [('HAVE_SAMPLERATE', 1)]
103 if 'fftw3f' in ext.libraries:
104 ext.define_macros += [('HAVE_FFTW3F', 1)]
105 ext.define_macros += [('HAVE_FFTW3', 1)]
107 # add accelerate on darwin
108 if sys.platform.startswith('darwin'):
109 ext.extra_link_args += ['-framework', 'Accelerate']
110 ext.define_macros += [('HAVE_ACCELERATE', 1)]
111 ext.define_macros += [('HAVE_SOURCE_APPLE_AUDIO', 1)]
112 ext.define_macros += [('HAVE_SINK_APPLE_AUDIO', 1)]
114 if sys.platform.startswith('win'):
115 ext.define_macros += [('HAVE_WIN_HACKS', 1)]
117 ext.define_macros += [('HAVE_WAVWRITE', 1)]
118 ext.define_macros += [('HAVE_WAVREAD', 1)]
122 ext.libraries += ['cblas']
123 ext.define_macros += [('HAVE_ATLAS_CBLAS_H', 1)]
125 def add_system_aubio(ext):
126 # use pkg-config to find aubio's location
127 aubio_version = get_aubio_version()
128 add_packages(['aubio = ' + aubio_version], ext)
129 if 'aubio' not in ext.libraries:
130 print("Info: aubio " + aubio_version + " was not found by pkg-config")
132 print("Info: using system aubio " + aubio_version + " found in " + ' '.join(ext.library_dirs))
134 def add_libav_on_win(ext):
135 """ no pkg-config on windows, simply assume these libs are available """
136 ext.libraries += ['avformat', 'avutil', 'avcodec', 'swresample']
137 for define_macro in ['HAVE_LIBAV', 'HAVE_SWRESAMPLE']:
138 ext.define_macros += [(define_macro, 1)]
140 class CleanGenerated(distutils.command.clean.clean):
142 if os.path.isdir(output_path):
143 distutils.dir_util.remove_tree(output_path)
145 from distutils.command.build_ext import build_ext as _build_ext
146 class build_ext(_build_ext):
148 user_options = _build_ext.user_options + [
149 # The format is (long option, short option, description).
150 ('enable-double', None, 'use HAVE_AUBIO_DOUBLE=1 (default: 0)'),
153 def initialize_options(self):
154 _build_ext.initialize_options(self)
155 self.enable_double = False
157 def finalize_options(self):
158 _build_ext.finalize_options(self)
159 if self.enable_double:
161 'will generate code for aubio compiled with HAVE_AUBIO_DOUBLE=1',
162 level=distutils.log.INFO)
164 def build_extension(self, extension):
165 if self.enable_double or 'HAVE_AUBIO_DOUBLE' in os.environ:
168 enable_double = False
169 # seack for aubio headers and lib in PKG_CONFIG_PATH
170 add_system_aubio(extension)
171 # the lib was not installed on this system
172 if 'aubio' not in extension.libraries:
173 # use local src/aubio.h
174 if os.path.isfile(os.path.join('src', 'aubio.h')):
175 add_local_aubio_header(extension)
176 add_local_macros(extension, usedouble=enable_double)
177 # look for a local waf build
178 if os.path.isfile(os.path.join('build','src', 'fvec.c.1.o')):
179 add_local_aubio_lib(extension)
181 # check for external dependencies
182 add_external_deps(extension, usedouble=enable_double)
183 # force adding libav on windows
184 if os.name == 'nt' and ('WITH_LIBAV' in os.environ \
185 or 'CONDA_PREFIX' in os.environ):
186 add_libav_on_win(extension)
187 # add libaubio sources and look for optional deps with pkg-config
188 add_local_aubio_sources(extension)
189 # generate files python/gen/*.c, python/gen/aubio-generated.h
190 extension.include_dirs += [ output_path ]
191 extension.sources += generate_external(header, output_path, overwrite = False,
192 usedouble=enable_double)
193 return _build_ext.build_extension(self, extension)