source: python/lib/moresetuptools.py @ f131ba8

feature/autosinkfeature/constantqfeature/pitchshiftfeature/pydocstringsfeature/timestretchsampleryinfft+
Last change on this file since f131ba8 was f131ba8, checked in by Paul Brossier <piem@piem.org>, 4 years ago

python/lib/moresetuptools.py: add comments, improve syntax

  • Property mode set to 100644
File size: 8.5 KB
Line 
1""" A collection of function used from setup.py distutils script """
2#
3import sys, os, glob, subprocess
4import distutils, distutils.command.clean, distutils.dir_util
5from .gen_external import generate_external, header, output_path
6
7def get_aubio_version():
8    # read from VERSION
9    this_file_dir = os.path.dirname(os.path.abspath(__file__))
10    version_file = os.path.join(this_file_dir, '..', '..', 'VERSION')
11
12    if not os.path.isfile(version_file):
13        raise SystemError("VERSION file not found.")
14
15    for l in open(version_file).readlines():
16        #exec (l.strip())
17        if l.startswith('AUBIO_MAJOR_VERSION'):
18            AUBIO_MAJOR_VERSION = int(l.split('=')[1])
19        if l.startswith('AUBIO_MINOR_VERSION'):
20            AUBIO_MINOR_VERSION = int(l.split('=')[1])
21        if l.startswith('AUBIO_PATCH_VERSION'):
22            AUBIO_PATCH_VERSION = int(l.split('=')[1])
23        if l.startswith('AUBIO_VERSION_STATUS'):
24            AUBIO_VERSION_STATUS = l.split('=')[1].strip()[1:-1]
25
26    if AUBIO_MAJOR_VERSION is None or AUBIO_MINOR_VERSION is None \
27            or AUBIO_PATCH_VERSION is None:
28        raise SystemError("Failed parsing VERSION file.")
29
30    verstr = '.'.join(map(str, [AUBIO_MAJOR_VERSION,
31                                     AUBIO_MINOR_VERSION,
32                                     AUBIO_PATCH_VERSION]))
33
34    if AUBIO_VERSION_STATUS is not None:
35        verstr += AUBIO_VERSION_STATUS
36    return verstr
37
38def get_aubio_pyversion():
39    # convert to version for python according to pep 440
40    # see https://www.python.org/dev/peps/pep-0440/
41    verstr = get_aubio_version()
42    if '~alpha' in verstr:
43        verstr = verstr.split('~')[0] + 'a1'
44    # TODO: add rc, .dev, and .post suffixes, add numbering
45    return verstr
46
47# inspired from https://gist.github.com/abergmeier/9488990
48def add_packages(packages, ext=None, **kw):
49    """ use pkg-config to search which of 'packages' are installed """
50    flag_map = {
51        '-I': 'include_dirs',
52        '-L': 'library_dirs',
53        '-l': 'libraries'}
54
55    # if a setuptools extension is passed, fill it with pkg-config results
56    if ext:
57        kw = {'include_dirs': ext.include_dirs,
58              'extra_link_args': ext.extra_link_args,
59              'library_dirs': ext.library_dirs,
60              'libraries': ext.libraries,
61             }
62
63    for package in packages:
64        print("checking for {:s}".format(package))
65        cmd = ['pkg-config', '--libs', '--cflags', package]
66        try:
67            tokens = subprocess.check_output(cmd)
68        except Exception as e:
69            print("Running \"{:s}\" failed: {:s}".format(' '.join(cmd), repr(e)))
70            continue
71        tokens = tokens.decode('utf8').split()
72        for token in tokens:
73            key = token[:2]
74            try:
75                arg = flag_map[key]
76                value = token[2:]
77            except KeyError:
78                arg = 'extra_link_args'
79                value = token
80            kw.setdefault(arg, []).append(value)
81    for key, value in iter(kw.items()): # remove duplicated
82        kw[key] = list(set(value))
83    return kw
84
85def add_local_aubio_header(ext):
86    """ use local "src/aubio.h", not <aubio/aubio.h>"""
87    ext.define_macros += [('USE_LOCAL_AUBIO', 1)]
88    ext.include_dirs += ['src'] # aubio.h
89
90def add_local_aubio_lib(ext):
91    """ add locally built libaubio from build/src """
92    print("Info: using locally built libaubio")
93    ext.library_dirs += [os.path.join('build', 'src')]
94    ext.libraries += ['aubio']
95
96def add_local_aubio_sources(ext, usedouble = False):
97    """ build aubio inside python module instead of linking against libaubio """
98    print("Info: libaubio was not installed or built locally with waf, adding src/")
99    aubio_sources = sorted(glob.glob(os.path.join('src', '**.c')))
100    aubio_sources += sorted(glob.glob(os.path.join('src', '*', '**.c')))
101    ext.sources += aubio_sources
102
103def add_local_macros(ext, usedouble = False):
104    # define macros (waf puts them in build/src/config.h)
105    for define_macro in ['HAVE_STDLIB_H', 'HAVE_STDIO_H',
106                         'HAVE_MATH_H', 'HAVE_STRING_H',
107                         'HAVE_C99_VARARGS_MACROS',
108                         'HAVE_LIMITS_H', 'HAVE_STDARG_H',
109                         'HAVE_MEMCPY_HACKS']:
110        ext.define_macros += [(define_macro, 1)]
111
112def add_external_deps(ext, usedouble = False):
113    # loof for additional packages
114    print("Info: looking for *optional* additional packages")
115    packages = ['libavcodec', 'libavformat', 'libavutil', 'libavresample',
116                'jack',
117                'jack',
118                'sndfile',
119                #'fftw3f',
120               ]
121    # samplerate only works with float
122    if usedouble is False:
123        packages += ['samplerate']
124    else:
125        print("Info: not adding libsamplerate in double precision mode")
126    add_packages(packages, ext=ext)
127    if 'avcodec' in ext.libraries \
128            and 'avformat' in ext.libraries \
129            and 'avutil' in ext.libraries \
130            and 'avresample' in ext.libraries:
131        ext.define_macros += [('HAVE_LIBAV', 1)]
132    if 'jack' in ext.libraries:
133        ext.define_macros += [('HAVE_JACK', 1)]
134    if 'sndfile' in ext.libraries:
135        ext.define_macros += [('HAVE_SNDFILE', 1)]
136    if 'samplerate' in ext.libraries:
137        ext.define_macros += [('HAVE_SAMPLERATE', 1)]
138    if 'fftw3f' in ext.libraries:
139        ext.define_macros += [('HAVE_FFTW3F', 1)]
140        ext.define_macros += [('HAVE_FFTW3', 1)]
141
142    # add accelerate on darwin
143    if sys.platform.startswith('darwin'):
144        ext.extra_link_args += ['-framework', 'Accelerate']
145        ext.define_macros += [('HAVE_ACCELERATE', 1)]
146        ext.define_macros += [('HAVE_SOURCE_APPLE_AUDIO', 1)]
147        ext.define_macros += [('HAVE_SINK_APPLE_AUDIO', 1)]
148
149    if sys.platform.startswith('win'):
150        ext.define_macros += [('HAVE_WIN_HACKS', 1)]
151
152    ext.define_macros += [('HAVE_WAVWRITE', 1)]
153    ext.define_macros += [('HAVE_WAVREAD', 1)]
154    # TODO:
155    # add cblas
156    if 0:
157        ext.libraries += ['cblas']
158        ext.define_macros += [('HAVE_ATLAS_CBLAS_H', 1)]
159
160def add_system_aubio(ext):
161    # use pkg-config to find aubio's location
162    aubio_version = get_aubio_version()
163    add_packages(['aubio = ' + aubio_version], ext)
164    if 'aubio' not in ext.libraries:
165        print("Info: aubio " + aubio_version + " was not found by pkg-config")
166    else:
167        print("Info: using system aubio " + aubio_version + " found in " + ' '.join(ext.library_dirs))
168
169class CleanGenerated(distutils.command.clean.clean):
170    def run(self):
171        if os.path.isdir(output_path):
172            distutils.dir_util.remove_tree(output_path)
173
174from distutils.command.build_ext import build_ext as _build_ext
175class build_ext(_build_ext):
176
177    user_options = _build_ext.user_options + [
178            # The format is (long option, short option, description).
179            ('enable-double', None, 'use HAVE_AUBIO_DOUBLE=1 (default: 0)'),
180            ]
181
182    def initialize_options(self):
183        _build_ext.initialize_options(self)
184        self.enable_double = False
185
186    def finalize_options(self):
187        _build_ext.finalize_options(self)
188        if self.enable_double:
189            self.announce(
190                    'will generate code for aubio compiled with HAVE_AUBIO_DOUBLE=1',
191                    level=distutils.log.INFO)
192
193    def build_extension(self, extension):
194        if self.enable_double or 'HAVE_AUBIO_DOUBLE' in os.environ:
195            extension.define_macros += [('HAVE_AUBIO_DOUBLE', 1)]
196            enable_double = True
197        else:
198            enable_double = False
199        # seack for aubio headers and lib in PKG_CONFIG_PATH
200        add_system_aubio(extension)
201        # the lib was not installed on this system
202        if 'aubio' not in extension.libraries:
203            # use local src/aubio.h
204            if os.path.isfile(os.path.join('src', 'aubio.h')):
205                add_local_aubio_header(extension)
206            add_local_macros(extension)
207            # look for a local waf build
208            if os.path.isfile(os.path.join('build','src', 'fvec.c.1.o')):
209                add_local_aubio_lib(extension)
210            else:
211                # check for external dependencies
212                add_external_deps(extension, usedouble=enable_double)
213                # add libaubio sources and look for optional deps with pkg-config
214                add_local_aubio_sources(extension, usedouble=enable_double)
215        # generate files python/gen/*.c, python/gen/aubio-generated.h
216        extension.sources += generate_external(header, output_path, overwrite = False,
217                usedouble=enable_double)
218        return _build_ext.build_extension(self, extension)
Note: See TracBrowser for help on using the repository browser.