8eb611396c14ea3954fc3ac44fa4ce5d0f353935
[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 # inspired from https://gist.github.com/abergmeier/9488990
8 def add_packages(packages, ext=None, **kw):
9     """ use pkg-config to search which of 'packages' are installed """
10     flag_map = {
11         '-I': 'include_dirs',
12         '-L': 'library_dirs',
13         '-l': 'libraries'}
14
15     # if a setuptools extension is passed, fill it with pkg-config results
16     if ext:
17         kw = {'include_dirs': ext.include_dirs,
18               'extra_link_args': ext.extra_link_args,
19               'library_dirs': ext.library_dirs,
20               'libraries': ext.libraries,
21              }
22
23     for package in packages:
24         cmd = ['pkg-config', '--libs', '--cflags', package]
25         try:
26             tokens = subprocess.check_output(cmd)
27         except Exception as e:
28             print("Running \"{:s}\" failed: {:s}".format(' '.join(cmd), repr(e)))
29             continue
30         tokens = tokens.decode('utf8').split()
31         for token in tokens:
32             key = token[:2]
33             try:
34                 arg = flag_map[key]
35                 value = token[2:]
36             except KeyError:
37                 arg = 'extra_link_args'
38                 value = token
39             kw.setdefault(arg, []).append(value)
40     for key, value in iter(kw.items()): # remove duplicated
41         kw[key] = list(set(value))
42     return kw
43
44 def add_local_aubio_header(ext):
45     """ use local "src/aubio.h", not <aubio/aubio.h>"""
46     ext.define_macros += [('USE_LOCAL_AUBIO', 1)]
47     ext.include_dirs += ['src'] # aubio.h
48
49 def add_local_aubio_lib(ext):
50     """ add locally built libaubio from build/src """
51     print("Info: using locally built libaubio")
52     ext.library_dirs += [os.path.join('build', 'src')]
53     ext.libraries += ['aubio']
54
55 def add_local_aubio_sources(ext, usedouble = False):
56     """ build aubio inside python module instead of linking against libaubio """
57     print("Warning: libaubio was not built with waf, adding src/")
58     # create an empty header, macros will be passed on the command line
59     fake_config_header = os.path.join('python', 'ext', 'config.h')
60     distutils.file_util.write_file(fake_config_header, "")
61     aubio_sources = glob.glob(os.path.join('src', '**.c'))
62     aubio_sources += glob.glob(os.path.join('src', '*', '**.c'))
63     ext.sources += aubio_sources
64     # define macros (waf puts them in build/src/config.h)
65     for define_macro in ['HAVE_STDLIB_H', 'HAVE_STDIO_H',
66                          'HAVE_MATH_H', 'HAVE_STRING_H',
67                          'HAVE_C99_VARARGS_MACROS',
68                          'HAVE_LIMITS_H', 'HAVE_STDARG_H',
69                          'HAVE_MEMCPY_HACKS']:
70         ext.define_macros += [(define_macro, 1)]
71
72     # loof for additional packages
73     print("Info: looking for *optional* additional packages")
74     packages = ['libavcodec', 'libavformat', 'libavutil', 'libavresample',
75                 'jack',
76                 'jack',
77                 'sndfile',
78                 #'fftw3f',
79                ]
80     # samplerate only works with float
81     if usedouble == False:
82         packages += ['samplerate']
83     else:
84         print("Info: not adding libsamplerate in double precision mode")
85     add_packages(packages, ext=ext)
86     if 'avcodec' in ext.libraries \
87             and 'avformat' in ext.libraries \
88             and 'avutil' in ext.libraries \
89             and 'avresample' in ext.libraries:
90         ext.define_macros += [('HAVE_LIBAV', 1)]
91     if 'jack' in ext.libraries:
92         ext.define_macros += [('HAVE_JACK', 1)]
93     if 'sndfile' in ext.libraries:
94         ext.define_macros += [('HAVE_SNDFILE', 1)]
95     if 'samplerate' in ext.libraries:
96         ext.define_macros += [('HAVE_SAMPLERATE', 1)]
97     if 'fftw3f' in ext.libraries:
98         ext.define_macros += [('HAVE_FFTW3F', 1)]
99         ext.define_macros += [('HAVE_FFTW3', 1)]
100
101     # add accelerate on darwin
102     if sys.platform.startswith('darwin'):
103         ext.extra_link_args += ['-framework', 'Accelerate']
104         ext.define_macros += [('HAVE_ACCELERATE', 1)]
105         ext.define_macros += [('HAVE_SOURCE_APPLE_AUDIO', 1)]
106         ext.define_macros += [('HAVE_SINK_APPLE_AUDIO', 1)]
107
108     if sys.platform.startswith('win'):
109         ext.define_macros += [('HAVE_WIN_HACKS', 1)]
110
111     ext.define_macros += [('HAVE_WAVWRITE', 1)]
112     ext.define_macros += [('HAVE_WAVREAD', 1)]
113     # TODO:
114     # add cblas
115     if 0:
116         ext.libraries += ['cblas']
117         ext.define_macros += [('HAVE_ATLAS_CBLAS_H', 1)]
118
119 def add_system_aubio(ext):
120     # use pkg-config to find aubio's location
121     add_packages(['aubio'], ext)
122     if 'aubio' not in ext.libraries:
123         print("Error: libaubio not found")
124
125 class CleanGenerated(distutils.command.clean.clean):
126     def run(self):
127         distutils.dir_util.remove_tree(output_path)
128         distutils.command.clean.clean.run(self)
129
130 from distutils.command.build_ext import build_ext as _build_ext
131 class build_ext(_build_ext):
132
133     user_options = _build_ext.user_options + [
134             # The format is (long option, short option, description).
135             ('enable-double', None, 'use HAVE_AUBIO_DOUBLE=1 (default: 0)'),
136             ]
137
138     def initialize_options(self):
139         _build_ext.initialize_options(self)
140         self.enable_double = False
141
142     def finalize_options(self):
143         _build_ext.finalize_options(self)
144         if self.enable_double:
145             self.announce(
146                     'will generate code for aubio compiled with HAVE_AUBIO_DOUBLE=1',
147                     level=distutils.log.INFO)
148
149     def build_extension(self, extension):
150         if self.enable_double:
151             extension.define_macros += [('HAVE_AUBIO_DOUBLE', 1)]
152         if os.path.isfile('src/aubio.h'):
153             # if aubio headers are found in this directory
154             add_local_aubio_header(extension)
155             # was waf used to build the shared lib?
156             if os.path.isdir(os.path.join('build','src')):
157                 # link against build/src/libaubio, built with waf
158                 add_local_aubio_lib(extension)
159             else:
160                 # add libaubio sources and look for optional deps with pkg-config
161                 add_local_aubio_sources(extension, usedouble=self.enable_double)
162         else:
163             # look for aubio headers and lib using pkg-config
164             add_system_aubio(extension)
165         # generate files python/gen/*.c, python/gen/aubio-generated.h
166         extension.sources += generate_external(header, output_path, overwrite = False,
167                 usedouble=self.enable_double)
168         return _build_ext.build_extension(self, extension)