this_version.py: simplify git clean check
[aubio.git] / python / lib / moresetuptools.py
1 """ A collection of function used from setup.py distutils script """
2 #
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
6
7 from this_version import get_aubio_version
8
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 """
12     flag_map = {
13         '-I': 'include_dirs',
14         '-L': 'library_dirs',
15         '-l': 'libraries'}
16
17     # if a setuptools extension is passed, fill it with pkg-config results
18     if ext:
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,
23              }
24
25     for package in packages:
26         print("checking for {:s}".format(package))
27         cmd = ['pkg-config', '--libs', '--cflags', package]
28         try:
29             tokens = subprocess.check_output(cmd)
30         except Exception as e:
31             print("Running \"{:s}\" failed: {:s}".format(' '.join(cmd), repr(e)))
32             continue
33         tokens = tokens.decode('utf8').split()
34         for token in tokens:
35             key = token[:2]
36             try:
37                 arg = flag_map[key]
38                 value = token[2:]
39             except KeyError:
40                 arg = 'extra_link_args'
41                 value = token
42             kw.setdefault(arg, []).append(value)
43     for key, value in iter(kw.items()): # remove duplicated
44         kw[key] = list(set(value))
45     return kw
46
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
51
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']
57
58 def add_local_aubio_sources(ext, usedouble = False):
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
64
65 def add_local_macros(ext, usedouble = False):
66     # define macros (waf puts them in build/src/config.h)
67     for define_macro in ['HAVE_STDLIB_H', 'HAVE_STDIO_H',
68                          'HAVE_MATH_H', 'HAVE_STRING_H',
69                          'HAVE_C99_VARARGS_MACROS',
70                          'HAVE_LIMITS_H', 'HAVE_STDARG_H',
71                          'HAVE_MEMCPY_HACKS']:
72         ext.define_macros += [(define_macro, 1)]
73
74 def add_external_deps(ext, usedouble = False):
75     # loof for additional packages
76     print("Info: looking for *optional* additional packages")
77     packages = ['libavcodec', 'libavformat', 'libavutil',
78                 'libswresample', 'libavresample',
79                 'sndfile',
80                 #'fftw3f',
81                ]
82     # samplerate only works with float
83     if usedouble is False:
84         packages += ['samplerate']
85     else:
86         print("Info: not adding libsamplerate in double precision mode")
87     add_packages(packages, ext=ext)
88     if 'avcodec' in ext.libraries \
89             and 'avformat' in ext.libraries \
90             and 'avutil' in ext.libraries:
91         if 'swresample' in ext.libraries:
92             ext.define_macros += [('HAVE_SWRESAMPLE', 1)]
93         elif 'avresample' in ext.libraries:
94             ext.define_macros += [('HAVE_AVRESAMPLE', 1)]
95         if 'swresample' in ext.libraries or 'avresample' in ext.libraries:
96             ext.define_macros += [('HAVE_LIBAV', 1)]
97     if 'sndfile' in ext.libraries:
98         ext.define_macros += [('HAVE_SNDFILE', 1)]
99     if 'samplerate' in ext.libraries:
100         ext.define_macros += [('HAVE_SAMPLERATE', 1)]
101     if 'fftw3f' in ext.libraries:
102         ext.define_macros += [('HAVE_FFTW3F', 1)]
103         ext.define_macros += [('HAVE_FFTW3', 1)]
104
105     # add accelerate on darwin
106     if sys.platform.startswith('darwin'):
107         ext.extra_link_args += ['-framework', 'Accelerate']
108         ext.define_macros += [('HAVE_ACCELERATE', 1)]
109         ext.define_macros += [('HAVE_SOURCE_APPLE_AUDIO', 1)]
110         ext.define_macros += [('HAVE_SINK_APPLE_AUDIO', 1)]
111
112     if sys.platform.startswith('win'):
113         ext.define_macros += [('HAVE_WIN_HACKS', 1)]
114
115     ext.define_macros += [('HAVE_WAVWRITE', 1)]
116     ext.define_macros += [('HAVE_WAVREAD', 1)]
117     # TODO:
118     # add cblas
119     if 0:
120         ext.libraries += ['cblas']
121         ext.define_macros += [('HAVE_ATLAS_CBLAS_H', 1)]
122
123 def add_system_aubio(ext):
124     # use pkg-config to find aubio's location
125     aubio_version = get_aubio_version()
126     add_packages(['aubio = ' + aubio_version], ext)
127     if 'aubio' not in ext.libraries:
128         print("Info: aubio " + aubio_version + " was not found by pkg-config")
129     else:
130         print("Info: using system aubio " + aubio_version + " found in " + ' '.join(ext.library_dirs))
131
132 class CleanGenerated(distutils.command.clean.clean):
133     def run(self):
134         if os.path.isdir(output_path):
135             distutils.dir_util.remove_tree(output_path)
136
137 from distutils.command.build_ext import build_ext as _build_ext
138 class build_ext(_build_ext):
139
140     user_options = _build_ext.user_options + [
141             # The format is (long option, short option, description).
142             ('enable-double', None, 'use HAVE_AUBIO_DOUBLE=1 (default: 0)'),
143             ]
144
145     def initialize_options(self):
146         _build_ext.initialize_options(self)
147         self.enable_double = False
148
149     def finalize_options(self):
150         _build_ext.finalize_options(self)
151         if self.enable_double:
152             self.announce(
153                     'will generate code for aubio compiled with HAVE_AUBIO_DOUBLE=1',
154                     level=distutils.log.INFO)
155
156     def build_extension(self, extension):
157         if self.enable_double or 'HAVE_AUBIO_DOUBLE' in os.environ:
158             extension.define_macros += [('HAVE_AUBIO_DOUBLE', 1)]
159             enable_double = True
160         else:
161             enable_double = False
162         # seack for aubio headers and lib in PKG_CONFIG_PATH
163         add_system_aubio(extension)
164         # the lib was not installed on this system
165         if 'aubio' not in extension.libraries:
166             # use local src/aubio.h
167             if os.path.isfile(os.path.join('src', 'aubio.h')):
168                 add_local_aubio_header(extension)
169             add_local_macros(extension)
170             # look for a local waf build
171             if os.path.isfile(os.path.join('build','src', 'fvec.c.1.o')):
172                 add_local_aubio_lib(extension)
173             else:
174                 # check for external dependencies
175                 add_external_deps(extension, usedouble=enable_double)
176                 # add libaubio sources and look for optional deps with pkg-config
177                 add_local_aubio_sources(extension, usedouble=enable_double)
178         # generate files python/gen/*.c, python/gen/aubio-generated.h
179         extension.include_dirs += [ output_path ]
180         extension.sources += generate_external(header, output_path, overwrite = False,
181                 usedouble=enable_double)
182         return _build_ext.build_extension(self, extension)