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):
  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     if usedouble:
  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_ERRNO_H', 'HAVE_C99_VARARGS_MACROS',
  72                          'HAVE_LIMITS_H', 'HAVE_STDARG_H',
  73                          'HAVE_MEMCPY_HACKS']:
  74         ext.define_macros += [(define_macro, 1)]
  75
  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', 'libswresample',
  80                 'jack',
  81                 'sndfile',
  82                 'rubberband',
  83                 #'fftw3f',
  84                ]
  85     # samplerate only works with float
  86     if usedouble is False:
  87         packages += ['samplerate']
  88     else:
  89         print("Info: not adding libsamplerate in double precision mode")
  90     add_packages(packages, ext=ext)
  91     if 'avcodec' in ext.libraries \
  92             and 'avformat' in ext.libraries \
  93             and 'avutil' in ext.libraries \
  94             and 'swresample' in ext.libraries:
  95         ext.define_macros += [('HAVE_LIBAV', 1)]
  96     if 'sndfile' in ext.libraries:
  97         ext.define_macros += [('HAVE_SNDFILE', 1)]
  98     if 'samplerate' in ext.libraries:
  99         ext.define_macros += [('HAVE_SAMPLERATE', 1)]
 100     if 'rubberband' in ext.libraries:
 101         ext.define_macros += [('HAVE_RUBBERBAND', 1)]
 102     if 'fftw3f' in ext.libraries:
 103         ext.define_macros += [('HAVE_FFTW3F', 1)]
 104         ext.define_macros += [('HAVE_FFTW3', 1)]
 105
 106     # add accelerate on darwin
 107     if sys.platform.startswith('darwin'):
 108         ext.extra_link_args += ['-framework', 'Accelerate']
 109         ext.define_macros += [('HAVE_ACCELERATE', 1)]
 110         ext.define_macros += [('HAVE_SOURCE_APPLE_AUDIO', 1)]
 111         ext.define_macros += [('HAVE_SINK_APPLE_AUDIO', 1)]
 112
 113     if sys.platform.startswith('win'):
 114         ext.define_macros += [('HAVE_WIN_HACKS', 1)]
 115
 116     ext.define_macros += [('HAVE_WAVWRITE', 1)]
 117     ext.define_macros += [('HAVE_WAVREAD', 1)]
 118
 119     # TODO: add cblas
 120     if 0:
 121         ext.libraries += ['cblas']
 122         ext.define_macros += [('HAVE_ATLAS_CBLAS_H', 1)]
 123
 124 def add_system_aubio(ext):
 125     # use pkg-config to find aubio's location
 126     aubio_version = get_aubio_version()
 127     add_packages(['aubio = ' + aubio_version], ext)
 128     if 'aubio' not in ext.libraries:
 129         print("Info: aubio " + aubio_version + " was not found by pkg-config")
 130     else:
 131         print("Info: using system aubio " + aubio_version + " found in " + ' '.join(ext.library_dirs))
 132
 133 def add_libav_on_win(ext):
 134     """ no pkg-config on windows, simply assume these libs are available """
 135     ext.libraries += ['avformat', 'avutil', 'avcodec', 'swresample']
 136     for define_macro in ['HAVE_LIBAV', 'HAVE_SWRESAMPLE']:
 137         ext.define_macros += [(define_macro, 1)]
 138
 139 class CleanGenerated(distutils.command.clean.clean):
 140     def run(self):
 141         if os.path.isdir(output_path):
 142             distutils.dir_util.remove_tree(output_path)
 143
 144 from distutils.command.build_ext import build_ext as _build_ext
 145 class build_ext(_build_ext):
 146
 147     user_options = _build_ext.user_options + [
 148             # The format is (long option, short option, description).
 149             ('enable-double', None, 'use HAVE_AUBIO_DOUBLE=1 (default: 0)'),
 150             ]
 151
 152     def initialize_options(self):
 153         _build_ext.initialize_options(self)
 154         self.enable_double = False
 155
 156     def finalize_options(self):
 157         _build_ext.finalize_options(self)
 158         if self.enable_double:
 159             self.announce(
 160                     'will generate code for aubio compiled with HAVE_AUBIO_DOUBLE=1',
 161                     level=distutils.log.INFO)
 162
 163     def build_extension(self, extension):
 164         if self.enable_double or 'HAVE_AUBIO_DOUBLE' in os.environ:
 165             enable_double = True
 166         else:
 167             enable_double = False
 168         # seack for aubio headers and lib in PKG_CONFIG_PATH
 169         add_system_aubio(extension)
 170         # the lib was not installed on this system
 171         if 'aubio' not in extension.libraries:
 172             # use local src/aubio.h
 173             if os.path.isfile(os.path.join('src', 'aubio.h')):
 174                 add_local_aubio_header(extension)
 175             add_local_macros(extension, usedouble=enable_double)
 176             # look for a local waf build
 177             if os.path.isfile(os.path.join('build','src', 'fvec.c.1.o')):
 178                 add_local_aubio_lib(extension)
 179             else:
 180                 # check for external dependencies
 181                 add_external_deps(extension, usedouble=enable_double)
 182                 # force adding libav on windows
 183                 if os.name == 'nt' and ('WITH_LIBAV' in os.environ \
 184                         or 'CONDA_PREFIX' in os.environ):
 185                     add_libav_on_win(extension)
 186                 # add libaubio sources and look for optional deps with pkg-config
 187                 add_local_aubio_sources(extension)
 188         # generate files python/gen/*.c, python/gen/aubio-generated.h
 189         extension.include_dirs += [ output_path ]
 190         extension.sources += generate_external(header, output_path, overwrite = False,
 191                 usedouble=enable_double)
 192         return _build_ext.build_extension(self, extension)