switch to cffi out-of-line ABI mode

switch to out of line mode to improve sounddevice module import time.

this adds a separate sounddevice_build.py file that becomes part of
the setup.py build process and is only run once at install time rather
than everytime the module is imported

Author: tgarc

MANIFEST.in

@@ -1,5 +1,6 @@
 include LICENSE
 include *.rst
 include doc/requirements.txt
+include sounddevice_build.py
 recursive-include doc *.rst *.py
 recursive-include examples *.py

setup.py

@@ -71,8 +71,10 @@ def get_tag(self):
     packages=packages,
     package_data=package_data,
     zip_safe=zip_safe,
+    setup_requires=["CFFI>=1.0"],
     install_requires=['CFFI>=1.0'],
     extras_require={'NumPy': ['NumPy']},
+    cffi_modules=["sounddevice_build.py:ffibuilder"],
     author='Matthias Geier',
     author_email='[email protected]',
     description='Play and Record Sound with Python',

sounddevice.py

@@ -26,321 +26,15 @@
 __version__ = '0.3.8'
 
 import atexit as _atexit
-from cffi import FFI as _FFI
 import os as _os
 import platform as _platform
 import sys as _sys
+from ctypes.util import find_library as _find_library
+from _sounddevice import ffi as _ffi
 
-_ffi = _FFI()
-_ffi.cdef("""
-int Pa_GetVersion( void );
-const char* Pa_GetVersionText( void );
-typedef int PaError;
-typedef enum PaErrorCode
-{
-    paNoError = 0,
-    paNotInitialized = -10000,
-    paUnanticipatedHostError,
-    paInvalidChannelCount,
-    paInvalidSampleRate,
-    paInvalidDevice,
-    paInvalidFlag,
-    paSampleFormatNotSupported,
-    paBadIODeviceCombination,
-    paInsufficientMemory,
-    paBufferTooBig,
-    paBufferTooSmall,
-    paNullCallback,
-    paBadStreamPtr,
-    paTimedOut,
-    paInternalError,
-    paDeviceUnavailable,
-    paIncompatibleHostApiSpecificStreamInfo,
-    paStreamIsStopped,
-    paStreamIsNotStopped,
-    paInputOverflowed,
-    paOutputUnderflowed,
-    paHostApiNotFound,
-    paInvalidHostApi,
-    paCanNotReadFromACallbackStream,
-    paCanNotWriteToACallbackStream,
-    paCanNotReadFromAnOutputOnlyStream,
-    paCanNotWriteToAnInputOnlyStream,
-    paIncompatibleStreamHostApi,
-    paBadBufferPtr
-} PaErrorCode;
-const char *Pa_GetErrorText( PaError errorCode );
-PaError Pa_Initialize( void );
-PaError Pa_Terminate( void );
-typedef int PaDeviceIndex;
-#define paNoDevice -1
-#define paUseHostApiSpecificDeviceSpecification -2
-typedef int PaHostApiIndex;
-PaHostApiIndex Pa_GetHostApiCount( void );
-PaHostApiIndex Pa_GetDefaultHostApi( void );
-typedef enum PaHostApiTypeId
-{
-    paInDevelopment=0,
-    paDirectSound=1,
-    paMME=2,
-    paASIO=3,
-    paSoundManager=4,
-    paCoreAudio=5,
-    paOSS=7,
-    paALSA=8,
-    paAL=9,
-    paBeOS=10,
-    paWDMKS=11,
-    paJACK=12,
-    paWASAPI=13,
-    paAudioScienceHPI=14
-} PaHostApiTypeId;
-typedef struct PaHostApiInfo
-{
-    int structVersion;
-    PaHostApiTypeId type;
-    const char *name;
-    int deviceCount;
-    PaDeviceIndex defaultInputDevice;
-    PaDeviceIndex defaultOutputDevice;
-} PaHostApiInfo;
-const PaHostApiInfo * Pa_GetHostApiInfo( PaHostApiIndex hostApi );
-PaHostApiIndex Pa_HostApiTypeIdToHostApiIndex( PaHostApiTypeId type );
-PaDeviceIndex Pa_HostApiDeviceIndexToDeviceIndex( PaHostApiIndex hostApi,
-        int hostApiDeviceIndex );
-typedef struct PaHostErrorInfo{
-    PaHostApiTypeId hostApiType;
-    long errorCode;
-    const char *errorText;
-}PaHostErrorInfo;
-const PaHostErrorInfo* Pa_GetLastHostErrorInfo( void );
-PaDeviceIndex Pa_GetDeviceCount( void );
-PaDeviceIndex Pa_GetDefaultInputDevice( void );
-PaDeviceIndex Pa_GetDefaultOutputDevice( void );
-typedef double PaTime;
-typedef unsigned long PaSampleFormat;
-#define paFloat32        0x00000001
-#define paInt32          0x00000002
-#define paInt24          0x00000004
-#define paInt16          0x00000008
-#define paInt8           0x00000010
-#define paUInt8          0x00000020
-#define paCustomFormat   0x00010000
-#define paNonInterleaved 0x80000000
-typedef struct PaDeviceInfo
-{
-    int structVersion;
-    const char *name;
-    PaHostApiIndex hostApi;
-    int maxInputChannels;
-    int maxOutputChannels;
-    PaTime defaultLowInputLatency;
-    PaTime defaultLowOutputLatency;
-    PaTime defaultHighInputLatency;
-    PaTime defaultHighOutputLatency;
-    double defaultSampleRate;
-} PaDeviceInfo;
-const PaDeviceInfo* Pa_GetDeviceInfo( PaDeviceIndex device );
-typedef struct PaStreamParameters
-{
-    PaDeviceIndex device;
-    int channelCount;
-    PaSampleFormat sampleFormat;
-    PaTime suggestedLatency;
-    void *hostApiSpecificStreamInfo;
-} PaStreamParameters;
-#define paFormatIsSupported 0
-PaError Pa_IsFormatSupported( const PaStreamParameters *inputParameters,
-                              const PaStreamParameters *outputParameters,
-                              double sampleRate );
-typedef void PaStream;
-#define paFramesPerBufferUnspecified 0
-typedef unsigned long PaStreamFlags;
-#define   paNoFlag         0
-#define   paClipOff        0x00000001
-#define   paDitherOff      0x00000002
-#define   paNeverDropInput 0x00000004
-#define   paPrimeOutputBuffersUsingStreamCallback 0x00000008
-#define   paPlatformSpecificFlags 0xFFFF0000
-typedef struct PaStreamCallbackTimeInfo{
-    PaTime inputBufferAdcTime;
-    PaTime currentTime;
-    PaTime outputBufferDacTime;
-} PaStreamCallbackTimeInfo;
-typedef unsigned long PaStreamCallbackFlags;
-#define paInputUnderflow  0x00000001
-#define paInputOverflow   0x00000002
-#define paOutputUnderflow 0x00000004
-#define paOutputOverflow  0x00000008
-#define paPrimingOutput   0x00000010
-typedef enum PaStreamCallbackResult
-{
-    paContinue=0,
-    paComplete=1,
-    paAbort=2
-} PaStreamCallbackResult;
-typedef int PaStreamCallback(
-    const void *input, void *output,
-    unsigned long frameCount,
-    const PaStreamCallbackTimeInfo* timeInfo,
-    PaStreamCallbackFlags statusFlags,
-    void *userData );
-PaError Pa_OpenStream( PaStream** stream,
-                       const PaStreamParameters *inputParameters,
-                       const PaStreamParameters *outputParameters,
-                       double sampleRate,
-                       unsigned long framesPerBuffer,
-                       PaStreamFlags streamFlags,
-                       PaStreamCallback *streamCallback,
-                       void *userData );
-PaError Pa_OpenDefaultStream( PaStream** stream,
-                              int numInputChannels,
-                              int numOutputChannels,
-                              PaSampleFormat sampleFormat,
-                              double sampleRate,
-                              unsigned long framesPerBuffer,
-                              PaStreamCallback *streamCallback,
-                              void *userData );
-PaError Pa_CloseStream( PaStream *stream );
-typedef void PaStreamFinishedCallback( void *userData );
-PaError Pa_SetStreamFinishedCallback( PaStream *stream,
-    PaStreamFinishedCallback* streamFinishedCallback );
-PaError Pa_StartStream( PaStream *stream );
-PaError Pa_StopStream( PaStream *stream );
-PaError Pa_AbortStream( PaStream *stream );
-PaError Pa_IsStreamStopped( PaStream *stream );
-PaError Pa_IsStreamActive( PaStream *stream );
-typedef struct PaStreamInfo
-{
-    int structVersion;
-    PaTime inputLatency;
-    PaTime outputLatency;
-    double sampleRate;
-} PaStreamInfo;
-const PaStreamInfo* Pa_GetStreamInfo( PaStream *stream );
-PaTime Pa_GetStreamTime( PaStream *stream );
-double Pa_GetStreamCpuLoad( PaStream* stream );
-PaError Pa_ReadStream( PaStream* stream,
-                       void *buffer,
-                       unsigned long frames );
-PaError Pa_WriteStream( PaStream* stream,
-                        const void *buffer,
-                        unsigned long frames );
-signed long Pa_GetStreamReadAvailable( PaStream* stream );
-signed long Pa_GetStreamWriteAvailable( PaStream* stream );
-PaHostApiTypeId Pa_GetStreamHostApiType( PaStream* stream );
-PaError Pa_GetSampleSize( PaSampleFormat format );
-void Pa_Sleep( long msec );
-
-/* pa_mac_core.h */
-
-typedef int32_t SInt32;
-typedef struct
-{
-    unsigned long size;
-    PaHostApiTypeId hostApiType;
-    unsigned long version;
-    unsigned long flags;
-    SInt32 const * channelMap;
-    unsigned long channelMapSize;
-} PaMacCoreStreamInfo;
-void PaMacCore_SetupStreamInfo( PaMacCoreStreamInfo *data, unsigned long flags );
-void PaMacCore_SetupChannelMap( PaMacCoreStreamInfo *data, const SInt32 * const channelMap, unsigned long channelMapSize );
-const char *PaMacCore_GetChannelName( int device, int channelIndex, bool input );
-#define paMacCoreChangeDeviceParameters 0x01
-#define paMacCoreFailIfConversionRequired 0x02
-#define paMacCoreConversionQualityMin    0x0100
-#define paMacCoreConversionQualityMedium 0x0200
-#define paMacCoreConversionQualityLow    0x0300
-#define paMacCoreConversionQualityHigh   0x0400
-#define paMacCoreConversionQualityMax    0x0000
-#define paMacCorePlayNice                    0x00
-#define paMacCorePro                         0x01
-#define paMacCoreMinimizeCPUButPlayNice      0x0100
-#define paMacCoreMinimizeCPU                 0x0101
-
-/* pa_win_waveformat.h */
-
-typedef unsigned long PaWinWaveFormatChannelMask;
-
-/* pa_asio.h */
-
-#define paAsioUseChannelSelectors 0x01
-
-typedef struct PaAsioStreamInfo
-{
-    unsigned long size;
-    PaHostApiTypeId hostApiType;
-    unsigned long version;
-    unsigned long flags;
-    int *channelSelectors;
-} PaAsioStreamInfo;
-
-/* pa_win_wasapi.h */
-
-typedef enum PaWasapiFlags
-{
-    paWinWasapiExclusive                = 1,
-    paWinWasapiRedirectHostProcessor    = 2,
-    paWinWasapiUseChannelMask           = 4,
-    paWinWasapiPolling                  = 8,
-    paWinWasapiThreadPriority           = 16
-} PaWasapiFlags;
-
-typedef void (*PaWasapiHostProcessorCallback) (
-    void *inputBuffer,  long inputFrames,
-    void *outputBuffer, long outputFrames, void *userData);
-
-typedef enum PaWasapiThreadPriority
-{
-    eThreadPriorityNone = 0,
-    eThreadPriorityAudio,
-    eThreadPriorityCapture,
-    eThreadPriorityDistribution,
-    eThreadPriorityGames,
-    eThreadPriorityPlayback,
-    eThreadPriorityProAudio,
-    eThreadPriorityWindowManager
-} PaWasapiThreadPriority;
-
-typedef enum PaWasapiStreamCategory
-{
-    eAudioCategoryOther           = 0,
-    eAudioCategoryCommunications  = 3,
-    eAudioCategoryAlerts          = 4,
-    eAudioCategorySoundEffects    = 5,
-    eAudioCategoryGameEffects     = 6,
-    eAudioCategoryGameMedia       = 7,
-    eAudioCategoryGameChat        = 8,
-    eAudioCategorySpeech          = 9,
-    eAudioCategoryMovie           = 10,
-    eAudioCategoryMedia           = 11
-} PaWasapiStreamCategory;
-
-typedef enum PaWasapiStreamOption
-{
-    eStreamOptionNone        = 0,
-    eStreamOptionRaw         = 1,
-    eStreamOptionMatchFormat = 2
-} PaWasapiStreamOption;
-
-typedef struct PaWasapiStreamInfo
-{
-    unsigned long size;
-    PaHostApiTypeId hostApiType;
-    unsigned long version;
-    unsigned long flags;
-    PaWinWaveFormatChannelMask channelMask;
-    PaWasapiHostProcessorCallback hostProcessorOutput;
-    PaWasapiHostProcessorCallback hostProcessorInput;
-    PaWasapiThreadPriority threadPriority;
-    PaWasapiStreamCategory streamCategory;
-    PaWasapiStreamOption streamOption;
-} PaWasapiStreamInfo;
-""")
 
 try:
-    _lib = _ffi.dlopen('portaudio')
+    _lib = _ffi.dlopen(_find_library('portaudio'))
 except OSError:
     if _platform.system() == 'Darwin':
         _libname = 'libportaudio.dylib'
@@ -2935,25 +2629,17 @@ def _exit_handler():
 
 def _ignore_stderr():
     """Try to forward PortAudio messages from stderr to /dev/null."""
-    ffi = _FFI()
-    ffi.cdef("""
-    /* from stdio.h */
-    FILE* fopen(const char* path, const char* mode);
-    int fclose(FILE* fp);
-    FILE* stderr;  /* GNU C library */
-    FILE* __stderrp;  /* macOS */
-    """)
     try:
-        stdio = ffi.dlopen(None)
+        stdio = _ffi.dlopen(None)
         devnull = stdio.fopen(_os.devnull.encode(), b'w')
     except (OSError, AttributeError):
         return
     try:
         stdio.stderr = devnull
-    except KeyError:
+    except _ffi.error:
         try:
             stdio.__stderrp = devnull
-        except KeyError:
+        except _ffi.error:
             stdio.fclose(devnull)