setup.py

# -*- coding: utf-8 -*-
"""
Copyright 2009-2018 Olivier Belanger

This file is part of pyo, a python module to help digital signal
processing script creation.

pyo is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.

pyo is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public
License along with pyo.  If not, see <http://www.gnu.org/licenses/>.
"""
from distutils.sysconfig import get_python_lib
from setuptools import setup, Extension
import os, sys, py_compile, subprocess, platform

if sys.version_info[0] < 3:

    def tobytes(strng, encoding=None):
        "Convert unicode string to bytes."
        return bytes(strng)


else:

    def tobytes(strng, encoding="utf-8"):
        "Convert unicode string to bytes."
        return bytes(strng, encoding=encoding)


def get_jack_api():
    try:
        output = subprocess.Popen(["jackd", "-V"], stdout=subprocess.PIPE)
    except:
        # jack2-dbus is probably installed instead of jackd.
        # If jack2-dbus version is >= 1.9.11, we need JACK_NEW_API.
        return "JACK_NEW_API"

    text = output.communicate()[0]
    if text != "":
        line = text.splitlines()[0]
        if tobytes("0.124") in line or tobytes("1.9.10") in line:
            return "JACK_OLD_API"
        else:
            return "JACK_NEW_API"
    else:
        return "JACK_NEW_API"


pyo_version = "1.0.3"
build_with_jack_support = False
compile_externals = False
win_arch = platform.architecture()[0]

macros = []
extension_names = ["pyo._pyo"]
extra_macros_per_extension = [[]]
packages = [
    "pyo",
    "pyo.lib",
    "pyo.lib.snds",
    "pyo.editor",
    "pyo.editor.styles",
    "pyo.editor.snippets",
    "pyo.editor.snippets.Audio",
    "pyo.editor.snippets.Control",
    "pyo.editor.snippets.Interface",
    "pyo.editor.snippets.Utilities",
    "pyo.examples",
    "pyo.examples.01-intro",
    "pyo.examples.02-controls",
    "pyo.examples.03-generators",
    "pyo.examples.04-soundfiles",
    "pyo.examples.05-envelopes",
    "pyo.examples.06-filters",
    "pyo.examples.07-effects",
    "pyo.examples.08-dynamics",
    "pyo.examples.09-callbacks",
    "pyo.examples.10-tables",
    "pyo.examples.16-midi",
    "pyo.examples.17-osc",
    "pyo.examples.19-multirate",
    "pyo.examples.20-multicore",
    "pyo.examples.21-utilities",
    "pyo.examples.22-events",
    "pyo.examples.23-expression",
    "pyo.examples.algorithmic",
    "pyo.examples.fft",
    "pyo.examples.matrix",
    "pyo.examples.sampling",
    "pyo.examples.sequencing",
    "pyo.examples.snds",
    "pyo.examples.synthesis",
    "pyo.examples.wxgui",
]

if "--use-double" in sys.argv:
    sys.argv.remove("--use-double")
    packages.append("pyo64")
    extension_names.append("pyo._pyo64")
    extra_macros_per_extension.append([("USE_DOUBLE", None)])

if "--no-messages" in sys.argv:
    sys.argv.remove("--no-messages")
    macros.append(("NO_MESSAGES", None))

if "--compile-externals" in sys.argv:
    compile_externals = True
    sys.argv.remove("--compile-externals")
    macros.append(("COMPILE_EXTERNALS", None))

if "--debug" in sys.argv:
    sys.argv.remove("--debug")
    gflag = ["-g3", "-UNDEBUG"]
else:
    gflag = ["-g0", "-DNDEBUG"]

if "--fast-compile" in sys.argv:
    sys.argv.remove("--fast-compile")
    oflag = ["-O0"]
else:
    oflag = ["-O3", "-march=native", "-mtune=native", "-ffast-math", "-flto"] #, "-fopt-info-vec-optimized"]

# Specific audio drivers source files to compile
ad_files = []
obj_files = []

# Special flag to build without portaudio, portmidi and liblo deps.
if "--minimal" in sys.argv:
    sys.argv.remove("--minimal")
    libraries = []
else:
    # portaudio
    macros.append(("USE_PORTAUDIO", None))
    ad_files.append("ad_portaudio.c")
    libraries = ["portaudio"]
    # portmidi
    macros.append(("USE_PORTMIDI", None))
    ad_files.append("md_portmidi.c")
    ad_files.append("midilistenermodule.c")
    libraries += ["portmidi"]
    # liblo
    macros.append(("USE_OSC", None))
    ad_files.append("osclistenermodule.c")
    obj_files.append("oscmodule.c")
    if sys.platform == "win32":
        libraries += ["liblo-7"]
    else:
        libraries += ["lo"]

# Optional Audio / Midi drivers
if "--use-jack" in sys.argv:
    sys.argv.remove("--use-jack")
    build_with_jack_support = True
    macros.append(("USE_JACK", None))
    if "--jack-force-old-api" in sys.argv:
        sys.argv.remove("--jack-force-old-api")
        macros.append(("JACK_OLD_API", None))
    else:
        macros.append((get_jack_api(), None))
    ad_files.append("ad_jack.c")

if "--use-coreaudio" in sys.argv:
    sys.argv.remove("--use-coreaudio")
    macros.append(("USE_COREAUDIO", None))
    ad_files.append("ad_coreaudio.c")

path = "src/engine"
files = [
    "pyomodule.c",
    "streammodule.c",
    "servermodule.c",
    "pvstreammodule.c",
    "dummymodule.c",
    "mixmodule.c",
    "inputfadermodule.c",
    "interpolation.c",
    "fft.c",
    "wind.c",
    "vbap.c",
] + ad_files
source_files = [os.path.join(path, f) for f in files]

path = "src/objects"
files = [
    "mmlmodule.c",
    "hrtfmodule.c",
    "filtremodule.c",
    "arithmeticmodule.c",
    "oscilmodule.c",
    "randommodule.c",
    "analysismodule.c",
    "sfplayermodule.c",
    "oscbankmodule.c",
    "lfomodule.c",
    "exprmodule.c",
    "utilsmodule.c",
    "granulatormodule.c",
    "matrixmodule.c",
    "noisemodule.c",
    "distomodule.c",
    "tablemodule.c",
    "wgverbmodule.c",
    "inputmodule.c",
    "fadermodule.c",
    "midimodule.c",
    "delaymodule.c",
    "recordmodule.c",
    "metromodule.c",
    "trigmodule.c",
    "patternmodule.c",
    "bandsplitmodule.c",
    "hilbertmodule.c",
    "panmodule.c",
    "selectmodule.c",
    "compressmodule.c",
    "freeverbmodule.c",
    "phasevocmodule.c",
    "fftmodule.c",
    "convolvemodule.c",
    "sigmodule.c",
    "matrixprocessmodule.c",
    "harmonizermodule.c",
    "chorusmodule.c",
    "MedianFilter.c"
] + obj_files

if compile_externals:
    source_files = source_files + ["externals/externalmodule.c"] + [os.path.join(path, f) for f in files]
else:
    source_files = source_files + [os.path.join(path, f) for f in files]

# Platform-specific build settings for the pyo extension(s).
if sys.platform == "win32":
    if win_arch == "32bit":
        include_dirs = [
            "C:\portaudio\include",
            "C:\portmidi\pm_common",
            "include",
            "C:\Program Files (x86)\Mega-Nerd\libsndfile\include",
            "C:\liblo-0.28",
            "C:\pthreads\include",
            "C:\portmidi\porttime",
        ]
        library_dirs = [
            "C:\portaudio",
            "C:\portmidi",
            "C:\liblo-0.28\src\.libs",
            "C:\pthreads\lib",
            "C:/Program Files (x86)/Mega-Nerd/libsndfile/bin",
        ]
        libraries += ["libsndfile-1", "pthreadGC2"]
        if "portmidi" in libraries:
            libraries.append("porttime")
    else:
        include_dirs = [
            "C:/Users/Admin/git/vcpkg/packages/portmidi_x64-windows/include",
            "C:\msys64\mingw64\include",
            "include",
            "C:\liblo-0.29",
            "C:\pthreads\include",
        ]
        library_dirs = [
            "C:/Users/Admin/git/vcpkg/packages/portmidi_x64-windows/bin",
            "C:/Users/Admin/git/vcpkg/packages/portmidi_x64-windows/lib",
            "C:\msys64\mingw64\\bin",
            "C:\liblo-0.29\src\.libs",
            "C:\pthreads\lib",
        ]
        libraries += ["libsndfile-1", "pthreadGC2"]
        macros.append(("MS_WIN64", None))
else:
    include_dirs = ["include", "/usr/include", "/usr/local/include"]
    if sys.platform == "darwin":
        include_dirs.append("/opt/local/include")
    library_dirs = ["/usr/lib", "/usr/local/lib"]
    libraries += ["sndfile"]
    if build_with_jack_support:
        libraries.append("jack")

# Platform-specific data files
if sys.platform == "win32":
    if "bdist_wheel" in sys.argv:
        data_files_dest = os.path.join("Lib", "site-packages", "pyo")
    else:
        data_files_dest = "pyo"
    if win_arch == "32bit":
        data_files_common_path = os.path.join("win32dlls", "win32_pyo_data_files_common")
        data_files_path = os.path.join("win32dlls", "win32_pyo_data_files_py%d" % sys.version_info.major)
        data_files = [
            (
                data_files_dest,
                [
                    os.path.join(data_files_common_path, f)
                    for f in os.listdir(data_files_common_path)
                    if f.endswith(".dll")
                ],
            ),
            (
                data_files_dest,
                [os.path.join(data_files_path, f) for f in os.listdir(data_files_path) if f.endswith(".dll")],
            ),
        ]
    else:
        data_files_common_path = os.path.join("win64dlls", "win64_pyo_data_files_common")
        data_files = [
            (
                data_files_dest,
                [
                    os.path.join(data_files_common_path, f)
                    for f in os.listdir(data_files_common_path)
                    if f.endswith(".dll")
                ],
            )
        ]
elif sys.platform == "darwin":
    if "bdist_wheel" in sys.argv:
        data_files = [
            (
                "/pyo",
                [
                    "temp_libs/liblo.7.dylib",
                    "temp_libs/libportaudio.2.dylib",
                    "temp_libs/libportmidi.dylib",
                    "temp_libs/libsndfile.1.dylib",
                    "temp_libs/libFLAC.8.dylib",
                    "temp_libs/libvorbisenc.2.dylib",
                    "temp_libs/libvorbis.0.dylib",
                    "temp_libs/libogg.0.dylib",
                    "temp_libs/libopus.0.dylib",
                ],
            )
        ]
    else:
        data_files = []
else:
    data_files = []

libraries += ["m"]
extra_compile_args = ["-Wno-strict-prototypes", "-Wno-strict-aliasing"] + oflag + gflag

extensions = []
for extension_name, extra_macros in zip(extension_names, extra_macros_per_extension):
    extensions.append(
        Extension(
            extension_name,
            source_files,
            libraries=libraries,
            library_dirs=library_dirs,
            include_dirs=include_dirs,
            extra_compile_args=extra_compile_args,
            define_macros=macros + extra_macros,
        )
    )

if compile_externals:
    include_dirs.append("externals")
    os.system("cp externals/external.py pyo/lib/")

soundfiles = [f for f in os.listdir(os.path.join("pyo", "lib", "snds")) if f[-3:] in ["aif", "wav"]]
short_desc = "Python module to build digital signal processing program."
long_desc = """
pyo is a Python module containing classes for a wide variety of audio signal processing types.
With pyo, user will be able to include signal processing chains directly in Python scripts or
projects, and to manipulate them in real time through the interpreter. Tools in pyo module offer
primitives, like mathematical operations on audio signal, basic signal processing (filters,
delays, synthesis generators, etc.), but also complex algorithms to create sound granulation
and others creative audio manipulations. pyo supports OSC protocol (Open Sound Control), to ease
communications between softwares, and MIDI protocol, for generating sound events and controlling
process parameters. pyo allows creation of sophisticated signal processing chains with all the
benefits of a mature, and widely used, general programming language.
"""

classifiers = [
    # How mature is this project? Common values are
    #   3 - Alpha
    #   4 - Beta
    #   5 - Production/Stable
    "Development Status :: 5 - Production/Stable",
    # Indicate who your project is intended for
    "Intended Audience :: Developers",
    "Intended Audience :: End Users/Desktop",
    "Intended Audience :: Science/Research",
    "Intended Audience :: Other Audience",
    # Operating systems
    "Operating System :: MacOS :: MacOS X",
    "Operating System :: Microsoft :: Windows",
    "Operating System :: POSIX :: Linux",
    # Pick your license as you wish (should match "license" above)
    "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)",
    # Topics
    "Topic :: Multimedia :: Sound/Audio",
    "Topic :: Multimedia :: Sound/Audio :: Analysis",
    "Topic :: Multimedia :: Sound/Audio :: Capture/Recording",
    "Topic :: Multimedia :: Sound/Audio :: Sound Synthesis",
    # Specify the Python versions you support here. In particular, ensure
    # that you indicate whether you support Python 2, Python 3 or both.
    "Programming Language :: Python :: 3",
    "Programming Language :: Python :: 3.6",
    "Programming Language :: Python :: 3.7",
    "Programming Language :: Python :: 3.8",
]

setup(
    name="pyo",
    author="Olivier Belanger",
    author_email="belangeo@gmail.com",
    version=pyo_version,
    description=short_desc,
    long_description=long_desc,
    url="http://ajaxsoundstudio.com/software/pyo/",
    project_urls={
        "Bug Tracker": "https://github.com/belangeo/pyo/issues",
        "Documentation": "http://ajaxsoundstudio.com/pyodoc/",
        "Source Code": "https://github.com/belangeo/pyo",
    },
    classifiers=classifiers,
    keywords="audio sound dsp synthesis signal-processing music",
    license="LGPLv3+",
    python_requires=">=3.6, <4",
    zip_safe=False,
    packages=packages,
    package_data={
        "pyo.lib.snds": soundfiles,
        "pyo.editor.styles": [
            "Custom",
            "Default",
            "Espresso",
            "Smooth",
            "Soft",
            "Monokai-Soda",
            "Solarized (dark)",
            "Solarized (light)",
        ],
        "pyo.editor.snippets.Audio": ["SoundPlayer", "TableOsc"],
        "pyo.editor.snippets.Control": ["ChorusJit", "Vibrato"],
        "pyo.editor.snippets.Interface": ["NewFrame", "PaintPanel"],
        "pyo.editor.snippets.Utilities": ["ChooseAudioDev", "Incrementor"],
        "pyo.examples.23-expression": ["utils.expr", "filters.expr", "generators.expr"],
        "pyo.examples.snds": [
            "alum1.wav",
            "alum2.wav",
            "alum3.wav",
            "alum4.wav",
            "baseballmajeur_m.aif",
            "drumloop.wav",
            "flute.aif",
            "ounkmaster.aif",
            "snd_1.aif",
            "snd_2.aif",
            "snd_3.aif",
            "snd_4.aif",
            "snd_5.aif",
            "snd_6.aif",
            "mapleleafrag.mid",
        ],
    },
    ext_modules=extensions,
    # To install files outside the package (third-party libs).
    data_files=data_files,
    entry_points={"console_scripts": ["epyo = pyo.editor.EPyo:main"]},
)

if compile_externals:
    os.system("rm pyo/lib/external.py")