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         print("checking for {:s}".format(package))
  25         cmd = ['pkg-config', '--libs', '--cflags', package]
  26         try:
  27             tokens = subprocess.check_output(cmd)
  28         except Exception as e:
  29             print("Running \"{:s}\" failed: {:s}".format(' '.join(cmd), repr(e)))
  30             continue
  31         tokens = tokens.decode('utf8').split()
  32         for token in tokens:
  33             key = token[:2]
  34             try:
  35                 arg = flag_map[key]
  36                 value = token[2:]
  37             except KeyError:
  38                 arg = 'extra_link_args'
  39                 value = token
  40             kw.setdefault(arg, []).append(value)
  41     for key, value in iter(kw.items()): # remove duplicated
  42         kw[key] = list(set(value))
  43     return kw
  44
  45 def add_local_aubio_header(ext):
  46     """ use local "src/aubio.h", not <aubio/aubio.h>"""
  47     ext.define_macros += [('USE_LOCAL_AUBIO', 1)]
  48     ext.include_dirs += ['src'] # aubio.h
  49
  50 def add_local_aubio_lib(ext):
  51     """ add locally built libaubio from build/src """
  52     print("Info: using locally built libaubio")
  53     ext.library_dirs += [os.path.join('build', 'src')]
  54     ext.libraries += ['aubio']
  55
  56 def add_local_aubio_sources(ext, usedouble = False):
  57     """ build aubio inside python module instead of linking against libaubio """
  58     print("Info: libaubio was not installed or built locally with waf, adding src/")
  59     aubio_sources = sorted(glob.glob(os.path.join('src', '**.c')))
  60     aubio_sources += sorted(glob.glob(os.path.join('src', '*', '**.c')))
  61     ext.sources += aubio_sources
  62
  63 def add_local_macros(ext, usedouble = False):
  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 def add_external_deps(ext, usedouble = False):
  73     # loof for additional packages
  74     print("Info: looking for *optional* additional packages")
  75     packages = ['libavcodec', 'libavformat', 'libavutil', 'libavresample',
  76                 'jack',
  77                 'jack',
  78                 'sndfile',
  79                 #'fftw3f',
  80                ]
  81     # samplerate only works with float
  82     if usedouble == False:
  83         packages += ['samplerate']
  84     else:
  85         print("Info: not adding libsamplerate in double precision mode")
  86     add_packages(packages, ext=ext)
  87     if 'avcodec' in ext.libraries \
  88             and 'avformat' in ext.libraries \
  89             and 'avutil' in ext.libraries \
  90             and 'avresample' in ext.libraries:
  91         ext.define_macros += [('HAVE_LIBAV', 1)]
  92     if 'jack' in ext.libraries:
  93         ext.define_macros += [('HAVE_JACK', 1)]
  94     if 'sndfile' in ext.libraries:
  95         ext.define_macros += [('HAVE_SNDFILE', 1)]
  96     if 'samplerate' in ext.libraries:
  97         ext.define_macros += [('HAVE_SAMPLERATE', 1)]
  98     if 'fftw3f' in ext.libraries:
  99         ext.define_macros += [('HAVE_FFTW3F', 1)]
 100         ext.define_macros += [('HAVE_FFTW3', 1)]
 101
 102     # add accelerate on darwin
 103     if sys.platform.startswith('darwin'):
 104         ext.extra_link_args += ['-framework', 'Accelerate']
 105         ext.define_macros += [('HAVE_ACCELERATE', 1)]
 106         ext.define_macros += [('HAVE_SOURCE_APPLE_AUDIO', 1)]
 107         ext.define_macros += [('HAVE_SINK_APPLE_AUDIO', 1)]
 108
 109     if sys.platform.startswith('win'):
 110         ext.define_macros += [('HAVE_WIN_HACKS', 1)]
 111
 112     ext.define_macros += [('HAVE_WAVWRITE', 1)]
 113     ext.define_macros += [('HAVE_WAVREAD', 1)]
 114     # TODO:
 115     # add cblas
 116     if 0:
 117         ext.libraries += ['cblas']
 118         ext.define_macros += [('HAVE_ATLAS_CBLAS_H', 1)]
 119
 120 def add_system_aubio(ext):
 121     # use pkg-config to find aubio's location
 122     add_packages(['aubio'], ext)
 123     if 'aubio' not in ext.libraries:
 124         print("Error: libaubio not found")
 125
 126 class CleanGenerated(distutils.command.clean.clean):
 127     def run(self):
 128         if os.path.isdir(output_path):
 129             distutils.dir_util.remove_tree(output_path)
 130
 131 from distutils.command.build_ext import build_ext as _build_ext
 132 class build_ext(_build_ext):
 133
 134     user_options = _build_ext.user_options + [
 135             # The format is (long option, short option, description).
 136             ('enable-double', None, 'use HAVE_AUBIO_DOUBLE=1 (default: 0)'),
 137             ]
 138
 139     def initialize_options(self):
 140         _build_ext.initialize_options(self)
 141         self.enable_double = False
 142
 143     def finalize_options(self):
 144         _build_ext.finalize_options(self)
 145         if self.enable_double:
 146             self.announce(
 147                     'will generate code for aubio compiled with HAVE_AUBIO_DOUBLE=1',
 148                     level=distutils.log.INFO)
 149
 150     def build_extension(self, extension):
 151         if self.enable_double or 'HAVE_AUBIO_DOUBLE' in os.environ:
 152             extension.define_macros += [('HAVE_AUBIO_DOUBLE', 1)]
 153             enable_double = True
 154         else:
 155             enable_double = False
 156         # seack for aubio headers and lib in PKG_CONFIG_PATH
 157         add_system_aubio(extension)
 158         # the lib was not installed on this system
 159         if 'aubio' not in extension.libraries:
 160             # use local src/aubio.h
 161             if os.path.isfile(os.path.join('src', 'aubio.h')):
 162                 add_local_aubio_header(extension)
 163             add_local_macros(extension)
 164             # look for a local waf build
 165             if os.path.isfile(os.path.join('build','src', 'fvec.c.1.o')):
 166                 add_local_aubio_lib(extension)
 167             else:
 168                 # check for external dependencies
 169                 add_external_deps(extension, usedouble=enable_double)
 170                 # add libaubio sources and look for optional deps with pkg-config
 171                 add_local_aubio_sources(extension, usedouble=enable_double)
 172         # generate files python/gen/*.c, python/gen/aubio-generated.h
 173         extension.sources += generate_external(header, output_path, overwrite = False,
 174                 usedouble=enable_double)
 175         return _build_ext.build_extension(self, extension)