Add sounddevice as an audio input source. (#75)

This change introduces `SoundDeviceInput` to the `io` module. Sounddevice is now the preferred method of capturing audio input, due to better multi-platform distribution support than PyAudio. However, PyAudio will continue to be supported for the forseeable future.

Author: will-rice

docs/source/spokestack.io.rst

@@ -6,3 +6,8 @@ spokestack.io.pyaudio
 
 .. automodule:: spokestack.io.pyaudio
    :members:
+
+spokestack.io.sound_device
+----------------------------
+.. automodule:: spokestack.io.sound_device
+   :members:

mypy.ini

@@ -31,3 +31,5 @@ ignore_missing_imports = True
 ignore_missing_imports = True
 [mypy-Cython.*]
 ignore_missing_imports = True
+[mypy-sounddevice]
+ignore_missing_imports = True

requirements.in

@@ -34,3 +34,4 @@ requests
 streamp3
 google-cloud-speech
 cython
+sounddevice

requirements.txt

@@ -2,84 +2,216 @@
 # This file is autogenerated by pip-compile
 # To update, run:
 #
-#    pip-compile
+#    pip-compile requirements.in
 #
-appdirs==1.4.4            # via black, virtualenv
-attrs==19.3.0             # via black, flake8-mypy, pytest
-black==19.10b0            # via -r requirements.in
-cachetools==4.1.1         # via google-auth
-certifi==2020.6.20        # via requests
-cfgv==3.1.0               # via pre-commit
-chardet==3.0.4            # via requests
-click==7.1.2              # via black, pip-tools
-colorama==0.4.3           # via pytest-watch
-coverage==5.2             # via coveralls, pytest-cov
-coveralls==2.1.1          # via -r requirements.in
-cython==0.29.21           # via -r requirements.in, streamp3
-distlib==0.3.1            # via virtualenv
-docopt==0.6.2             # via coveralls, pytest-watch
-filelock==3.0.12          # via virtualenv
-flake8==3.8.3             # via -r requirements.in, flake8-mypy
-flake8-mypy==17.8.0       # via -r requirements.in
-gevent==20.6.2            # via websocket
-google-api-core[grpc]==1.23.0  # via google-cloud-speech
-google-auth==1.22.1       # via google-api-core
-google-cloud-speech==2.0.0  # via -r requirements.in
-googleapis-common-protos==1.52.0  # via google-api-core
-greenlet==0.4.16          # via gevent, websocket
-grpcio==1.33.1            # via google-api-core
-identify==1.4.25          # via pre-commit
-idna==2.10                # via requests
-isort==4.3.21             # via -r requirements.in
-libcst==0.3.13            # via google-cloud-speech
-mccabe==0.6.1             # via flake8
-more-itertools==8.4.0     # via pytest
-mypy==0.782               # via -r requirements.in, flake8-mypy
-mypy-extensions==0.4.3    # via mypy, typing-inspect
-nodeenv==1.4.0            # via pre-commit
-numpy==1.19.1             # via -r requirements.in
-packaging==20.4           # via pytest
-pathspec==0.8.0           # via black
-pathtools==0.1.2          # via watchdog
-pip-tools==5.2.1          # via -r requirements.in
-pluggy==0.13.1            # via pytest
-pre-commit==2.6.0         # via -r requirements.in
-proto-plus==1.11.0        # via google-cloud-speech
-protobuf==3.13.0          # via google-api-core, googleapis-common-protos, proto-plus
-py==1.9.0                 # via pytest
-py-cpuinfo==7.0.0         # via pytest-benchmark
-pyasn1==0.4.8             # via pyasn1-modules, rsa
-pyasn1-modules==0.2.8     # via google-auth
-pyaudio==0.2.11           # via -r requirements.in
-pycodestyle==2.6.0        # via flake8
-pyfakefs==4.1.0           # via -r requirements.in
-pyflakes==2.2.0           # via flake8
-pyparsing==2.4.7          # via packaging
-pytest==5.4.3             # via -r requirements.in, pytest-benchmark, pytest-cov, pytest-mock, pytest-watch
-pytest-benchmark==3.2.3   # via -r requirements.in
-pytest-cov==2.10.0        # via -r requirements.in
-pytest-mock==3.2.0        # via -r requirements.in
-pytest-watch==4.2.0       # via -r requirements.in
-pytz==2020.1              # via google-api-core
-pyyaml==5.3.1             # via libcst, pre-commit
-regex==2020.7.14          # via black
-requests==2.24.0          # via -r requirements.in, coveralls, google-api-core
-rsa==4.6                  # via google-auth
-six==1.15.0               # via google-api-core, google-auth, grpcio, packaging, pip-tools, protobuf, virtualenv
-streamp3==0.1.7           # via -r requirements.in
-tokenizers==0.8.1         # via -r requirements.in
-toml==0.10.1              # via black, pre-commit
-typed-ast==1.4.1          # via black, mypy
-typing-extensions==3.7.4.2  # via libcst, mypy, typing-inspect
-typing-inspect==0.6.0     # via libcst
-urllib3==1.25.10          # via requests
-virtualenv==20.0.27       # via pre-commit
-watchdog==0.10.3          # via pytest-watch
-wcwidth==0.2.5            # via pytest
-websocket==0.2.1          # via -r requirements.in
-wheel==0.34.2             # via -r requirements.in
-zope.event==4.4           # via gevent
-zope.interface==5.1.0     # via gevent
+appdirs==1.4.4
+# via
+#   black
+#   virtualenv
+attrs==19.3.0
+# via
+#   black
+#   flake8-mypy
+#   pytest
+black==19.10b0
+# via -r requirements.in
+cachetools==4.1.1
+# via google-auth
+certifi==2020.6.20
+# via requests
+cffi==1.14.5
+# via sounddevice
+cfgv==3.1.0
+# via pre-commit
+chardet==3.0.4
+# via requests
+click==7.1.2
+# via
+#   black
+#   pip-tools
+colorama==0.4.3
+# via pytest-watch
+coverage==5.2
+# via
+#   coveralls
+#   pytest-cov
+coveralls==2.1.1
+# via -r requirements.in
+cython==0.29.21
+# via
+#   -r requirements.in
+#   streamp3
+distlib==0.3.1
+# via virtualenv
+docopt==0.6.2
+# via
+#   coveralls
+#   pytest-watch
+filelock==3.0.12
+# via -r requirements.in
+flake8==3.8.3
+# via virtualenv
+flake8-mypy==17.8.0
+# via
+#   -r requirements.in
+#   flake8-mypy
+gevent==20.6.2
+# via websocket
+google-api-core[grpc]==1.23.0
+# via google-cloud-speech
+google-auth==1.22.1
+# via google-api-core
+google-cloud-speech==2.0.0
+# via -r requirements.in
+googleapis-common-protos==1.52.0
+# via google-api-core
+greenlet==0.4.16
+# via
+#   gevent
+#   websocket
+grpcio==1.33.1
+# via google-api-core
+identify==1.4.25
+# via pre-commit
+idna==2.10
+# via requests
+isort==4.3.21
+# via -r requirements.in
+libcst==0.3.13
+# via google-cloud-speech
+mccabe==0.6.1
+# via flake8
+more-itertools==8.4.0
+# via
+#   mypy
+#   typing-inspect
+mypy==0.782
+# via pytest
+mypy-extensions==0.4.3
+# via
+#   -r requirements.in
+#   flake8-mypy
+nodeenv==1.4.0
+# via pre-commit
+numpy==1.19.1
+# via -r requirements.in
+packaging==20.4
+# via pytest
+pathspec==0.8.0
+# via black
+pathtools==0.1.2
+# via watchdog
+pip-tools==5.2.1
+# via -r requirements.in
+pluggy==0.13.1
+# via pytest
+pre-commit==2.6.0
+# via -r requirements.in
+proto-plus==1.11.0
+# via google-cloud-speech
+protobuf==3.13.0
+# via pytest-benchmark
+py==1.9.0
+# via
+#   google-api-core
+#   googleapis-common-protos
+#   proto-plus
+py-cpuinfo==7.0.0
+# via google-auth
+pyasn1==0.4.8
+# via pytest
+pyasn1-modules==0.2.8
+# via
+#   pyasn1-modules
+#   rsa
+pyaudio==0.2.11
+# via -r requirements.in
+pycodestyle==2.6.0
+# via flake8
+pycparser==2.20
+# via cffi
+pyfakefs==4.1.0
+# via -r requirements.in
+pyflakes==2.2.0
+# via flake8
+pyparsing==2.4.7
+# via -r requirements.in
+pytest==5.4.3
+# via packaging
+pytest-benchmark==3.2.3
+# via -r requirements.in
+pytest-cov==2.10.0
+# via -r requirements.in
+pytest-mock==3.2.0
+# via -r requirements.in
+pytest-watch==4.2.0
+# via
+#   -r requirements.in
+#   pytest-benchmark
+#   pytest-cov
+#   pytest-mock
+#   pytest-watch
+pytz==2020.1
+# via google-api-core
+pyyaml==5.3.1
+# via
+#   libcst
+#   pre-commit
+regex==2020.7.14
+# via black
+requests==2.24.0
+# via
+#   -r requirements.in
+#   coveralls
+#   google-api-core
+rsa==4.6
+# via google-auth
+six==1.15.0
+# via
+#   google-api-core
+#   google-auth
+#   grpcio
+#   packaging
+#   pip-tools
+#   protobuf
+#   virtualenv
+sounddevice==0.4.1
+# via -r requirements.in
+streamp3==0.1.7
+# via -r requirements.in
+tokenizers==0.8.1
+# via -r requirements.in
+toml==0.10.1
+# via
+#   black
+#   pre-commit
+typed-ast==1.4.1
+# via
+#   black
+#   mypy
+typing-extensions==3.7.4.2
+# via
+#   libcst
+#   mypy
+#   typing-inspect
+typing-inspect==0.6.0
+# via libcst
+urllib3==1.25.10
+# via requests
+virtualenv==20.0.27
+# via pre-commit
+watchdog==0.10.3
+# via pytest-watch
+wcwidth==0.2.5
+# via pytest
+websocket==0.2.1
+# via -r requirements.in
+wheel==0.34.2
+# via -r requirements.in
+zope.event==4.4
+# via gevent
+zope.interface==5.1.0
+# via gevent
 
 # The following packages are considered to be unsafe in a requirements file:
 # pip

spokestack/io/sound_device.py

@@ -0,0 +1,73 @@
+"""Audio input component based on the sounddevice library."""
+from typing import Any
+
+import numpy as np
+import sounddevice as sd
+
+
+class SoundDeviceInput:
+    """
+    Audio input source using sounddevice.
+
+    Parameters
+    ----------
+    sample_rate (Hz): int, optional
+        audio sample rate, by default 16000
+    frame_width (ms): int, optional
+        size of the audio frame, by default 20
+    """
+
+    def __init__(
+        self, sample_rate: int = 16000, frame_width: int = 20, **kwargs: Any
+    ) -> None:
+
+        self._frame_size = int(sample_rate / 1000 * frame_width)
+        self._sample_rate = sample_rate
+        self._stream = sd.Stream(samplerate=sample_rate)
+
+    def read(self) -> np.array:
+        """
+        Read audio from input source.
+
+        Returns
+        -------
+        np.array
+            NumPy array of audio
+        """
+        return self._stream.read(self._frame_size)
+
+    def start(self) -> None:
+        """Start the audio stream."""
+        self._stream.start()
+
+    def stop(self) -> None:
+        """Stop the audio stream."""
+        self._stream.stop()
+
+    def close(self) -> None:
+        """Close the audio stream."""
+        self._stream.close()
+
+    @property
+    def is_active(self) -> bool:
+        """
+        Active status of the audio stream.
+
+        Returns
+        -------
+        bool
+            True if active, False otherwise
+        """
+        return self._stream.active
+
+    @property
+    def is_stopped(self) -> bool:
+        """
+        Stop status of the audio stream.
+
+        Returns
+        -------
+        bool
+            True if stopped, False otherwise
+        """
+        return self._stream.stopped