Experimenting with autoapi

getchannels/setchannels should be together IMO

MANIFEST.in

@@ -1,4 +1,5 @@
 include *.py
+include *.pyi
 include CHANGES
 include TODO
 include LICENSE

alsaaudio.c

@@ -203,6 +203,12 @@ static bool is_value_volume_unit(long unit)
 	return false;
 }
 
+const char * const alsacard_list_doc = R"(.. function:: cards() -> list[str]
+
+   List the available ALSA cards by name. This function is only moderately
+   useful. If you want to see a list of available PCM devices, use :func:`pcms`
+   instead.)";
+
 static PyObject *
 alsacard_list(PyObject *self, PyObject *args)
 {
@@ -403,7 +409,7 @@ static int alsapcm_setup(alsapcm_t *self)
 	snd_pcm_hw_params_get_period_size(hwparams, &self->periodsize, &dir);
 	snd_pcm_hw_params_get_periods(hwparams, &self->periods, &dir);
 
-	self->framesize = self->channels * snd_pcm_hw_params_get_sbits(hwparams)/8;
+	self->framesize = self->channels * snd_pcm_format_physical_width(self->format)/8;
 
 	return res;
 }
@@ -598,6 +604,12 @@ alsapcm_dumpinfo(alsapcm_t *self, PyObject *args)
 	val = snd_pcm_hw_params_get_sbits(hwparams);
 	printf("significant bits = %d\n", val);
 
+	val = snd_pcm_format_width(self->format);
+	printf("nominal bits = %d\n", val);
+
+	val = snd_pcm_format_physical_width(self->format);
+	printf("physical bits = %d\n", val);
+
 	val = snd_pcm_hw_params_is_batch(hwparams);
 	printf("is batch = %d\n", val);
 
@@ -778,6 +790,16 @@ alsapcm_info(alsapcm_t *self, PyObject *args)
 	PyDict_SetItemString(info,"significant_bits", value);
 	Py_DECREF(value);
 
+	val = snd_pcm_format_width(self->format);
+	value=PyLong_FromUnsignedLong((unsigned long) val);
+	PyDict_SetItemString(info,"nominal_bits", value);
+	Py_DECREF(value);
+
+	val = snd_pcm_format_physical_width(self->format);
+	value=PyLong_FromUnsignedLong((unsigned long) val);
+	PyDict_SetItemString(info,"physical_bits", value);
+	Py_DECREF(value);
+
 	val = snd_pcm_hw_params_is_batch(hwparams);
 	value=PyBool_FromLong((unsigned long) val);
 	PyDict_SetItemString(info,"is_batch", value);
@@ -1154,6 +1176,37 @@ alsapcm_getchannels(alsapcm_t *self,PyObject *args)
 	return out;
 }
 
+static PyObject *
+alsapcm_setchannels(alsapcm_t *self, PyObject *args)
+{
+	int channels, saved;
+	int res;
+
+	if (!PyArg_ParseTuple(args,"i:setchannels", &channels))
+		return NULL;
+
+	if (!self->handle) {
+		PyErr_SetString(ALSAAudioError, "PCM device is closed");
+		return NULL;
+	}
+
+	PyErr_WarnEx(PyExc_DeprecationWarning,
+				 "This function is deprecated. "
+				 "Please use the named parameter `channels` to `PCM()` instead", 1);
+
+	saved = self->channels;
+	self->channels = channels;
+	res = alsapcm_setup(self);
+	if (res < 0)
+	{
+		self->channels = saved;
+		PyErr_Format(ALSAAudioError, "%s [%s]", snd_strerror(res),
+					 self->cardname);
+		return NULL;
+	}
+	return PyLong_FromLong(self->channels);
+}
+
 static PyObject *
 alsapcm_pcmtype(alsapcm_t *self, PyObject *args)
 {
@@ -1196,37 +1249,6 @@ alsapcm_cardname(alsapcm_t *self, PyObject *args)
 	return PyUnicode_FromString(self->cardname);
 }
 
-static PyObject *
-alsapcm_setchannels(alsapcm_t *self, PyObject *args)
-{
-	int channels, saved;
-	int res;
-
-	if (!PyArg_ParseTuple(args,"i:setchannels", &channels))
-		return NULL;
-
-	if (!self->handle) {
-		PyErr_SetString(ALSAAudioError, "PCM device is closed");
-		return NULL;
-	}
-
-	PyErr_WarnEx(PyExc_DeprecationWarning,
-				 "This function is deprecated. "
-				 "Please use the named parameter `channels` to `PCM()` instead", 1);
-
-	saved = self->channels;
-	self->channels = channels;
-	res = alsapcm_setup(self);
-	if (res < 0)
-	{
-		self->channels = saved;
-		PyErr_Format(ALSAAudioError, "%s [%s]", snd_strerror(res),
-					 self->cardname);
-		return NULL;
-	}
-	return PyLong_FromLong(self->channels);
-}
-
 static PyObject *
 alsapcm_setrate(alsapcm_t *self, PyObject *args)
 {
@@ -1734,6 +1756,7 @@ static PyMethodDef alsapcm_methods[] = {
 	{"pcmtype", (PyCFunction)alsapcm_pcmtype, METH_VARARGS},
 	{"pcmmode", (PyCFunction)alsapcm_pcmmode, METH_VARARGS},
 	{"cardname", (PyCFunction)alsapcm_cardname, METH_VARARGS},
+	{"getchannels", (PyCFunction)alsapcm_getchannels, METH_VARARGS},
 	{"setchannels", (PyCFunction)alsapcm_setchannels, METH_VARARGS},
 	{"setrate", (PyCFunction)alsapcm_setrate, METH_VARARGS},
 	{"setformat", (PyCFunction)alsapcm_setformat, METH_VARARGS},
@@ -1749,7 +1772,6 @@ static PyMethodDef alsapcm_methods[] = {
 	{"getformats", (PyCFunction)alsapcm_getformats, METH_VARARGS},
 	{"getratebounds", (PyCFunction)alsapcm_getratemaxmin, METH_VARARGS},
 	{"getrates", (PyCFunction)alsapcm_getrates, METH_VARARGS},
-	{"getchannels", (PyCFunction)alsapcm_getchannels, METH_VARARGS},
 	{"read", (PyCFunction)alsapcm_read, METH_VARARGS},
 	{"write", (PyCFunction)alsapcm_write, METH_VARARGS},
 	{"avail", (PyCFunction)alsapcm_avail, METH_VARARGS},
@@ -3063,7 +3085,7 @@ static PyTypeObject ALSAMixerType = {
 static PyMethodDef alsaaudio_methods[] = {
 	{ "card_indexes", (PyCFunction)alsacard_list_indexes, METH_VARARGS},
 	{ "card_name", (PyCFunction)alsacard_name, METH_VARARGS},
-	{ "cards", (PyCFunction)alsacard_list, METH_VARARGS},
+	{ "cards", (PyCFunction)alsacard_list, METH_VARARGS, alsacard_list_doc },
 	{ "pcms", (PyCFunction)alsapcm_list, METH_VARARGS|METH_KEYWORDS},
 	{ "mixers", (PyCFunction)alsamixer_list, METH_VARARGS|METH_KEYWORDS},
 	{ 0, 0 },

alsaaudio.pyi

@@ -0,0 +1,135 @@
+from typing import list
+
+PCM_PLAYBACK: int
+PCM_CAPTURE: int
+
+PCM_NORMAL: int
+PCM_NONBLOCK: int
+PCM_ASYNC: int
+
+PCM_FORMAT_S8: int
+PCM_FORMAT_U8: int
+PCM_FORMAT_S16_LE: int
+PCM_FORMAT_S16_BE: int
+PCM_FORMAT_U16_LE: int
+PCM_FORMAT_U16_BE: int
+PCM_FORMAT_S24_LE: int
+PCM_FORMAT_S24_BE: int
+PCM_FORMAT_U24_LE: int
+PCM_FORMAT_U24_BE: int
+PCM_FORMAT_S32_LE: int
+PCM_FORMAT_S32_BE: int
+PCM_FORMAT_U32_LE: int
+PCM_FORMAT_U32_BE: int
+PCM_FORMAT_FLOAT_LE: int
+PCM_FORMAT_FLOAT_BE: int
+PCM_FORMAT_FLOAT64_LE: int
+PCM_FORMAT_FLOAT64_BE: int
+PCM_FORMAT_MU_LAW: int
+PCM_FORMAT_A_LAW: int
+PCM_FORMAT_IMA_ADPCM: int
+PCM_FORMAT_MPEG: int
+PCM_FORMAT_GSM: int
+PCM_FORMAT_S24_3LE: int
+PCM_FORMAT_S24_3BE: int
+PCM_FORMAT_U24_3LE: int
+PCM_FORMAT_U24_3BE: int
+
+PCM_TSTAMP_NONE: int
+PCM_TSTAMP_ENABLE: int
+
+PCM_TSTAMP_TYPE_GETTIMEOFDAY: int
+PCM_TSTAMP_TYPE_MONOTONIC: int
+PCM_TSTAMP_TYPE_MONOTONIC_RAW: int
+
+PCM_FORMAT_DSD_U8: int
+PCM_FORMAT_DSD_U16_LE: int
+PCM_FORMAT_DSD_U32_LE: int
+PCM_FORMAT_DSD_U32_BE: int
+
+PCM_STATE_OPEN: int
+PCM_STATE_SETUP: int
+PCM_STATE_PREPARED: int
+PCM_STATE_RUNNING: int
+PCM_STATE_XRUN: int
+PCM_STATE_DRAINING: int
+PCM_STATE_PAUSED: int
+PCM_STATE_SUSPENDED: int
+PCM_STATE_DISCONNECTED: int
+
+MIXER_CHANNEL_ALL: int
+
+MIXER_SCHN_UNKNOWN: int
+MIXER_SCHN_FRONT_LEFT: int
+MIXER_SCHN_FRONT_RIGHT: int
+MIXER_SCHN_REAR_LEFT: int
+MIXER_SCHN_REAR_RIGHT: int
+MIXER_SCHN_FRONT_CENTER: int
+MIXER_SCHN_WOOFER: int
+MIXER_SCHN_SIDE_LEFT: int
+MIXER_SCHN_SIDE_RIGHT: int
+MIXER_SCHN_REAR_CENTER: int
+MIXER_SCHN_MONO: int
+
+VOLUME_UNITS_PERCENTAGE: int
+VOLUME_UNITS_RAW: int
+VOLUME_UNITS_DB: int
+
+def pcms(pcmtype: int) -> list[str]: ...
+def cards() -> list[str]: ...
+def mixers(cardindex: int = -1, device: str = 'default') -> list[str]: ...
+def asoundlib_version() -> str: ...
+
+class PCM:
+	def __init__(type: int = PCM_PLAYBACK, mode: int = PCM_NORMAL, rate: int = 44100, channels: int = 2,
+		format: int = PCM_FORMAT_S16_LE, periodsize: int = 32, periods: int = 4,
+		device: str = 'default', cardindex: int = -1) -> PCM: ...
+	def close() -> None: ...
+	def dumpinfo() -> None: ...
+	def info() -> dict: ...
+	def state() -> int: ...
+	def htimestamp() -> tuple[int, int, int]: ...
+	def set_tstamp_mode(mode: int = PCM_TSTAMP_ENABLE) -> None: ...
+	def get_tstamp_mode() -> int: ...
+	def set_tstamp_type(type: int = PCM_TSTAMP_TYPE_GETTIMEOFDAY) -> None: ...
+	def get_tstamp_type() -> int: ...
+	def getformats() -> dict: ...
+	def getratebounds() -> tuple[int, int]: ...
+	def getrates() -> int | tuple[int, int] | list[int]: ...
+	def getchannels() -> list[int]: ...
+	def setchannels(nchannels: int) -> None: ...
+	def pcmtype() -> int: ...
+	def pcmmode() -> int: ...
+	def cardname() -> str: ...
+	def setrate(rate: int) -> None: ...
+	def setformat(format: int) -> int: ...
+	def setperiodsize(period: int) -> int: ...
+	def read() -> tuple[int, bytes]: ...
+	def write(data: bytes) -> int: ...
+	def avail() -> int: ...
+	def pause(enable: bool = True) -> int: ...
+	def drop() -> int: ...
+	def drain() -> int: ...
+	def polldescriptors() -> list[tuple[int, int]]: ...
+	def polldescriptors_revents(descriptors: list[tuple[int, int]]) -> int: ...
+
+class Mixer:
+	def __init__(control: str = 'Master', id: int = 0, cardindex: int = -1, device: str = 'default') -> Mixer: ...
+	def cardname() -> str: ...
+	def close() -> None: ...
+	def mixer() -> str: ...
+	def mixerid() -> int: ...
+	def switchcap() -> int: ...
+	def volumecap() -> int: ...
+	def getvolume(pcmtype: int = PCM_PLAYBACK, units: int = VOLUME_UNITS_PERCENTAGE) -> int: ...
+	def getrange(pcmtype: int = PCM_PLAYBACK, units: int = VOLUME_UNITS_RAW) -> tuple[int, int]: ...
+	def getenum() -> tuple[str, list[str]]: ...
+	def getmute() -> list[int]: ...
+	def getrec() -> list[int]: ...
+	def setvolume(volume: int, pcmtype: int = PCM_PLAYBACK, units: int = VOLUME_UNITS_PERCENTAGE, channel: (int | None) = None) -> None: ...
+	def setenum(index: int) -> None: ...
+	def setmute(mute: bool, channel: (int | None) = None) -> None: ...
+	def setrec(capture: int, channel: (int | None) = None) -> None: ...
+	def polldescriptors() -> list[tuple[int, int]]: ...
+	def handleevents() -> int: ...
+

doc/conf.py

@@ -34,7 +34,9 @@ from setup import pyalsa_version
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = []
+extensions = ['autoapi.extension']
+
+autoapi_dirs = ['..']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -67,7 +69,7 @@ release = version
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = 'en'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.

doc/libalsaaudio.rst

@@ -10,7 +10,7 @@
 
 The :mod:`alsaaudio` module defines functions and classes for using ALSA.
 
-.. function:: pcms(pcmtype=PCM_PLAYBACK)
+.. function:: pcms(pcmtype: int = PCM_PLAYBACK) ->list[str]
 
    List available PCM devices by name.
 
@@ -34,19 +34,13 @@ The :mod:`alsaaudio` module defines functions and classes for using ALSA.
 
    *New in 0.8*
 
-.. function:: cards()
-
-   List the available ALSA cards by name. This function is only moderately
-   useful. If you want to see a list of available PCM devices, use :func:`pcms`
-   instead.
-
 ..
    Omitted by intention due to being superseded by cards():
 
    .. function:: card_indexes()
    .. function:: card_name()
 
-.. function:: mixers(cardindex=-1, device='default')
+.. function:: mixers(cardindex: int = -1, device: str = 'default') -> list[str]
 
    List the available mixers. The arguments are:
 
@@ -82,7 +76,7 @@ The :mod:`alsaaudio` module defines functions and classes for using ALSA.
      changed. Since 0.8, this functions returns the mixers for the default
      device, not the mixers for the first card.
 
-.. function:: asoundlib_version()
+.. function:: asoundlib_version() -> str
 
    Return a Python string containing the ALSA version found.
 
@@ -96,10 +90,12 @@ PCM objects in :mod:`alsaaudio` can play or capture (record) PCM
 sound through speakers or a microphone. The PCM constructor takes the
 following arguments:
 
-.. class:: PCM(type=PCM_PLAYBACK, mode=PCM_NORMAL, rate=44100, channels=2, format=PCM_FORMAT_S16_LE, periodsize=32, periods=4, device='default', cardindex=-1)
+.. class:: PCM(type: int = PCM_PLAYBACK, mode: int = PCM_NORMAL, rate: int = 44100, channels: int = 2,
+               format: int = PCM_FORMAT_S16_LE, periodsize: int = 32, periods: int = 4,
+               device: str = 'default', cardindex: int = -1) -> PCM
 
-   This class is used to represent a PCM device (either for playback and
-   recording). The arguments are:
+   This class is used to represent a PCM device (either for playback or
+   recording). The constructor's arguments are:
 
    * *type* - can be either :const:`PCM_CAPTURE` or :const:`PCM_PLAYBACK`
      (default).
@@ -157,7 +153,15 @@ following arguments:
 
      **Note:** This should not be used, as it bypasses most of ALSA's configuration.
 
-   This will construct a PCM object with the given settings.
+   The defaults mentioned above are values passed by :mod:alsaaudio
+   to ALSA, not anything internal to ALSA.
+
+   **Note:** For default and non-default values alike, there is no
+   guarantee that a PCM device supports the requested configuration,
+   and ALSA may pick realizable values which it believes to be closest
+   to the request. Therefore, after creating a PCM object, it is
+   necessary to verify whether its realized configuration is acceptable.
+   The :func:info method can be used to query it.
 
    *Changed in 0.10:*
 
@@ -179,13 +183,27 @@ following arguments:
 
 PCM objects have the following methods:
 
-.. method:: PCM.info()
+.. method:: PCM.info() -> dict
 
-   The info function returns a dictionary containing the configuration of a PCM device. As ALSA takes into account limitations of the hardware and software devices the configuration achieved might not correspond to the values used during creation. There is therefore a need to check the realised configuration before processing the sound coming from the device or before sending sound to a device. A small subset of parameters can be set, but cannot be queried. These parameters are stored by alsaaudio and returned as they were given by the user, to distinguish them from parameters retrieved from ALSA these parameters have a name prefixed with **" (call value) "**. Yet another set of properties derives directly from the hardware and can be obtained through ALSA.
+   Returns a dictionary containing the configuration of a PCM device.
 
-   ===========================  =============================  ==================================================================
+   A small subset of properties reflects fixed parameters given by the
+   user, stored within alsaaudio. To distinguish them from properties
+   retrieved from ALSA when the call is made, they have their name
+   prefixed with **" (call value) "**.
+
+   Descriptions of properties which can be directly set during PCM object
+   instantiation carry the prefix "PCM():", followed by the respective
+   constructor parameter. Note that due to device limitations, the values
+   may deviate from those originally requested.
+
+   Yet another set of properties cannot be set, and derives directly from
+   the hardware, possibly depending on other properties. Those properties'
+   descriptions are prefixed with "hw:" below.
+
+   ===========================  ====================================  ==================================================================
         Key                      Description (Reference)               Type
-   ===========================  =============================  ==================================================================
+   ===========================  ====================================  ==================================================================
    name                         PCM():device                          string
    card_no                      *index of card*                       integer  (negative indicates device not associable with a card)
    device_no                    *index of PCM device*                 integer
@@ -209,7 +227,9 @@ PCM objects have the following methods:
    buffer_size                  *buffer size*                         integer (frames) (negative indicates error)
    get_periods                  *approx. periods in buffer*           integer (negative indicates error)
    rate_numden                  *numerator, denominator*              tuple (integer (Hz), integer (Hz))
-   significant_bits             *significant bits in sample*      integer (negative indicates error)
+   significant_bits             *significant bits in sample* [#tss]_  integer (negative indicates error)
+   nominal_bits                 *nominal bits in sample* [#tss]_      integer (negative indicates error)
+   physical_bits                *sample width in bits* [#tss]_        integer (negative indicates error)
    is_batch                     *hw: double buffering*                boolean (True: hardware supported)
    is_block_transfer            *hw: block transfer*                  boolean (True: hardware supported)
    is_double                    *hw: double buffering*                boolean (True: hardware supported)
@@ -220,22 +240,32 @@ PCM objects have the following methods:
    can_pause                    *hw: pause*                           boolean (True: hardware supported)
    can_resume                   *hw: resume*                          boolean (True: hardware supported)
    can_sync_start               *hw: synchronized start*              boolean (True: hardware supported)
-   ===========================  =============================  ==================================================================
+   ===========================  ====================================  ==================================================================
+.. [#tss] More information in the :ref:`terminology section for sample size <term-sample-size>`
 
-   The italicized descriptions give a summary of the "full" description as it can be found in the  `ALSA documentation <https://www.alsa-project.org/alsa-doc>`_. "hw:": indicates that the property indicated relates to the hardware. Parameters passed to the PCM object during instantation are prefixed with "PCM():", they are described there for the keyword argument indicated after "PCM():".
+..
 
+   The italicized descriptions give a summary of the "full" description
+   as can be found in the
+   `ALSA documentation <https://www.alsa-project.org/alsa-doc>`_.
 
-.. method:: PCM.pcmtype()
+   *New in 0.9.1*
+
+.. method:: PCM.dumpinfo()
+
+   Dumps the PCM object's configured parameters to stdout.
+
+.. method:: PCM.pcmtype() -> int
 
    Returns the type of PCM object. Either :const:`PCM_CAPTURE` or
    :const:`PCM_PLAYBACK`.
 
-.. method:: PCM.pcmmode()
+.. method:: PCM.pcmmode() -> int
 
    Return the mode of the PCM object. One of :const:`PCM_NONBLOCK`,
    :const:`PCM_ASYNC`, or :const:`PCM_NORMAL`
 
-.. method:: PCM.cardname()
+.. method:: PCM.cardname() -> string
 
    Return the name of the sound card used by this PCM object.
 
@@ -267,37 +297,23 @@ PCM objects have the following methods:
    Returns a dictionary of supported format codes (integers) keyed by
    their standard ALSA names (strings).
 
-.. method:: PCM.setchannels(nchannels)
+.. method:: PCM.setchannels(nchannels: int) -> int
 
    .. deprecated:: 0.9 Use the `channels` named argument to :func:`PCM`.
 
-.. method:: PCM.setrate(rate)
+.. method:: PCM.setrate(rate: int) -> int
 
    .. deprecated:: 0.9 Use the `rate` named argument to :func:`PCM`.
 
-.. method:: PCM.setformat(format)
+.. method:: PCM.setformat(format: int) -> int
 
    .. deprecated:: 0.9 Use the `format` named argument to :func:`PCM`.
 
-.. method:: PCM.setperiodsize(period)
+.. method:: PCM.setperiodsize(period: int) -> int
 
    .. deprecated:: 0.9 Use the `periodsize` named argument to :func:`PCM`.
 
-.. method:: PCM.info()
-
-   Returns a dictionary with the PCM object's configured parameters.
-
-   Values are retrieved from the ALSA library if they are available;
-   otherwise they represent those stored by pyalsaaudio, and their keys
-   are prefixed with ' (call value) '.
-
-   *New in 0.9.1*
-
-.. method:: PCM.dumpinfo()
-
-   Dumps the PCM object's configured parameters to stdout.
-
-.. method:: PCM.state()
+.. method:: PCM.state() -> int
 
    Returs the current state of the stream, which can be one of
    :const:`PCM_STATE_OPEN` (this should not actually happen),
@@ -312,7 +328,21 @@ PCM objects have the following methods:
 
    *New in 0.10*
 
-.. method:: PCM.read()
+.. method:: PCM.avail() -> int
+
+   For :const:`PCM_PLAYBACK` PCM objects, returns the number of writable
+   (that is, free) frames in the buffer.
+
+   For :const:`PCM_CAPTURE` PCM objects, returns the number of readable
+   (that is, filled) frames in the buffer.
+
+   An attempt to read/write more frames than indicated will block (in
+   :const:`PCM_NORMAL` mode) or fail and return zero (in
+   :const:`PCM_NONBLOCK` mode).
+
+   *New in 0.11*
+
+.. method:: PCM.read() -> tuple[int, bytes]
 
    In :const:`PCM_NORMAL` mode, this function blocks until a full period is
    available, and then returns a tuple (length,data) where *length* is
@@ -331,7 +361,7 @@ PCM objects have the following methods:
    To avoid the problem in the future, try using a larger period size
    and/or more periods, at the cost of higher latency.
 
-.. method:: PCM.write(data)
+.. method:: PCM.write(data: bytes) -> int
 
    Writes (plays) the sound in data. The length of data *must* be a
    multiple of the frame size, and *should* be exactly the size of a
@@ -360,18 +390,18 @@ PCM objects have the following methods:
    in the kernel, and playout will continue afterwards. Make sure that the
    stream is drained before discarding the PCM handle.
 
-.. method:: PCM.pause([enable=True])
+.. method:: PCM.pause([enable: int = True]) -> int
 
    If *enable* is :const:`True`, playback or capture is paused.
    Otherwise, playback/capture is resumed.
 
-.. method:: PCM.drop()
+.. method:: PCM.drop() -> int
 
    Stop the stream and drop residual buffered frames.
 
    *New in 0.9*
 
-.. method:: PCM.drain()
+.. method:: PCM.drain() -> int
 
    For :const:`PCM_PLAYBACK` PCM objects, play residual buffered frames
    and then stop the stream. In :const:`PCM_NORMAL` mode,
@@ -381,14 +411,14 @@ PCM objects have the following methods:
 
    *New in 0.10*
 
-.. method:: PCM.close()
+.. method:: PCM.close() -> None
 
    Closes the PCM device.
 
    For :const:`PCM_PLAYBACK` PCM objects in :const:`PCM_NORMAL` mode,
    this function blocks until all pending playback is drained.
 
-.. method:: PCM.polldescriptors()
+.. method:: PCM.polldescriptors() -> list[tuple[int, int]]
 
    Returns a list of tuples of *(file descriptor, eventmask)* that can be
    used to wait for changes on the PCM with *select.poll*.
@@ -396,29 +426,38 @@ PCM objects have the following methods:
    The *eventmask* value is compatible with `poll.register`__ in the Python
    :const:`select` module.
 
-.. method:: PCM.set_tstamp_mode([mode=PCM_TSTAMP_ENABLE])
+.. method:: PCM.polldescriptors_revents(descriptors: list[tuple[int, int]]) -> int
+
+   Processes the descriptor list returned by :func:`polldescriptors` after
+   using it with *select.poll*, and returns a single *eventmask* value that
+   is meaningful for deciding whether :func:`read` or :func:`write` should
+   be called.
+
+   *New in 0.11*
+
+.. method:: PCM.set_tstamp_mode([mode: int = PCM_TSTAMP_ENABLE])
 
    Set the ALSA timestamp mode on the device. The mode argument can be set to
    either :const:`PCM_TSTAMP_NONE` or :const:`PCM_TSTAMP_ENABLE`.
 
-.. method:: PCM.get_tstamp_mode()
+.. method:: PCM.get_tstamp_mode() -> int
 
    Return the integer value corresponding to the ALSA timestamp mode. The
    return value can be either :const:`PCM_TSTAMP_NONE` or :const:`PCM_TSTAMP_ENABLE`.
 
-.. method:: PCM.set_tstamp_type([type=PCM_TSTAMP_TYPE_GETTIMEOFDAY])
+.. method:: PCM.set_tstamp_type([type: int = PCM_TSTAMP_TYPE_GETTIMEOFDAY]) -> None
 
    Set the ALSA timestamp mode on the device. The type argument
    can be set to either :const:`PCM_TSTAMP_TYPE_GETTIMEOFDAY`,
    :const:`PCM_TSTAMP_TYPE_MONOTONIC` or :const:`PCM_TSTAMP_TYPE_MONOTONIC_RAW`.
 
-.. method:: PCM.get_tstamp_type()
+.. method:: PCM.get_tstamp_type() -> int
 
    Return the integer value corresponding to the ALSA timestamp type. The
    return value can be either :const:`PCM_TSTAMP_TYPE_GETTIMEOFDAY`,
    :const:`PCM_TSTAMP_TYPE_MONOTONIC` or :const:`PCM_TSTAMP_TYPE_MONOTONIC_RAW`.
 
-.. method:: PCM.htimestamp()
+.. method:: PCM.htimestamp() -> tuple[int, int, int]
 
    Return a Python tuple *(seconds, nanoseconds, frames_available_in_buffer)*.
 
@@ -451,7 +490,7 @@ The most common reason for problems with playback of PCM audio is that writes
 to PCM devices must *exactly* match the data rate of the device.
 
 If too little data is written to the device, it will underrun, and
-ugly clicking sounds will occur. Conversely, of too much data is
+ugly clicking sounds will occur. Conversely, if too much data is
 written to the device, the write function will either block
 (:const:`PCM_NORMAL` mode) or return zero (:const:`PCM_NONBLOCK` mode).
 
@@ -480,7 +519,7 @@ Mixer Objects
 
 Mixer objects provides access to the ALSA mixer API.
 
-.. class:: Mixer(control='Master', id=0, cardindex=-1, device='default')
+.. class:: Mixer(control: str = 'Master', id: int = 0, cardindex: int = -1, device: str = 'default') -> Mixer
 
    Arguments are:
 
@@ -507,20 +546,20 @@ Mixer objects provides access to the ALSA mixer API.
 
 Mixer objects have the following methods:
 
-.. method:: Mixer.cardname()
+.. method:: Mixer.cardname() -> str
 
    Return the name of the sound card used by this Mixer object
 
-.. method:: Mixer.mixer()
+.. method:: Mixer.mixer() -> str
 
    Return the name of the specific mixer controlled by this object, For example
    ``'Master'`` or ``'PCM'``
 
-.. method:: Mixer.mixerid()
+.. method:: Mixer.mixerid() -> int
 
    Return the ID of the ALSA mixer controlled by this object.
 
-.. method:: Mixer.switchcap()
+.. method:: Mixer.switchcap() -> int
 
    Returns a list of the switches which are defined by this specific mixer.
    Possible values in this list are:
@@ -540,7 +579,7 @@ Mixer objects have the following methods:
    To manipulate these switches use the :meth:`setrec` or
    :meth:`setmute` methods
 
-.. method:: Mixer.volumecap()
+.. method:: Mixer.volumecap() -> int
 
    Returns a list of the volume control capabilities of this
    mixer. Possible values in the list are:
@@ -556,7 +595,7 @@ Mixer objects have the following methods:
    'Joined Capture Volume'   Manipulate sound capture volume for all channels at a time
    ========================  ================
 
-.. method:: Mixer.getenum()
+.. method:: Mixer.getenum() -> tuple[str, list[str]]
 
    For enumerated controls, return the currently selected item and  the list of
    items available.
@@ -582,13 +621,13 @@ Mixer objects have the following methods:
    This method will return an empty tuple if the mixer is not an  enumerated
    control.
 
-.. method:: Mixer.setenum(index)
+.. method:: Mixer.setenum(index: int) -> None
 
    For enumerated controls, sets the currently selected item.
    *index* is an index into the list of available enumerated items returned
    by :func:`getenum`.
 
-.. method:: Mixer.getrange(pcmtype=PCM_PLAYBACK, units=VOLUME_UNITS_RAW)
+.. method:: Mixer.getrange(pcmtype: int = PCM_PLAYBACK, units: int = VOLUME_UNITS_RAW) -> tuple[int, int]
 
    Return the volume range of the ALSA mixer controlled by this object.
    The value is a tuple of integers whose meaning is determined by the
@@ -602,7 +641,7 @@ Mixer objects have the following methods:
    The optional *units* argument can be one of :const:`VOLUME_UNITS_PERCENTAGE`,
    :const:`VOLUME_UNITS_RAW`, or :const:`VOLUME_UNITS_DB`.
 
-.. method:: Mixer.getvolume(pcmtype=PCM_PLAYBACK, units=VOLUME_UNITS_PERCENTAGE)
+.. method:: Mixer.getvolume(pcmtype: int = PCM_PLAYBACK, units: int = VOLUME_UNITS_PERCENTAGE) -> int
 
    Returns a list with the current volume settings for each channel. The list
    elements are integers whose meaning is determined by the *units* argument.
@@ -615,7 +654,7 @@ Mixer objects have the following methods:
    The optional *units* argument can be one of :const:`VOLUME_UNITS_PERCENTAGE`,
    :const:`VOLUME_UNITS_RAW`, or :const:`VOLUME_UNITS_DB`.
 
-.. method:: Mixer.setvolume(volume, channel=None, pcmtype=PCM_PLAYBACK, units=VOLUME_UNITS_PERCENTAGE)
+.. method:: Mixer.setvolume(volume: int, pcmtype: int = PCM_PLAYBACK, units: int = VOLUME_UNITS_PERCENTAGE, channel: (int | None) = None) -> None
 
    Change the current volume settings for this mixer. The *volume* argument
    is an integer whose meaning is determined by the *units* argument.
@@ -632,14 +671,14 @@ Mixer objects have the following methods:
    The optional *units* argument can be one of :const:`VOLUME_UNITS_PERCENTAGE`,
    :const:`VOLUME_UNITS_RAW`, or :const:`VOLUME_UNITS_DB`.
 
-.. method:: Mixer.getmute()
+.. method:: Mixer.getmute() -> list[int]
 
    Return a list indicating the current mute setting for each channel.
    0 means not muted, 1 means muted.
 
    This method will fail if the mixer has no playback switch capabilities.
 
-.. method:: Mixer.setmute(mute, [channel])
+.. method:: Mixer.setmute(mute: bool, channel: (int | None) = None) -> None
 
    Sets the mute flag to a new value. The *mute* argument is either 0 for not
    muted, or 1 for muted.
@@ -649,14 +688,14 @@ Mixer objects have the following methods:
 
    This method will fail if the mixer has no playback mute capabilities
 
-.. method:: Mixer.getrec()
+.. method:: Mixer.getrec() -> list[int]
 
    Return a list indicating the current record mute setting for each channel.
    0 means not recording, 1 means recording.
 
    This method will fail if the mixer has no capture switch capabilities.
 
-.. method:: Mixer.setrec(capture, [channel])
+.. method:: Mixer.setrec(capture: int, channel: (int | None) = None) -> None
 
    Sets the capture mute flag to a new value. The *capture* argument
    is either 0 for no capture, or 1 for capture.
@@ -666,7 +705,7 @@ Mixer objects have the following methods:
 
    This method will fail if the mixer has no capture switch capabilities.
 
-.. method:: Mixer.polldescriptors()
+.. method:: Mixer.polldescriptors() -> list[tuple[int, int]]
 
    Returns a list of tuples of *(file descriptor, eventmask)* that can be
    used to wait for changes on the mixer with *select.poll*.
@@ -674,13 +713,13 @@ Mixer objects have the following methods:
    The *eventmask* value is compatible with `poll.register`__ in the Python
    :const:`select` module.
 
-.. method:: Mixer.handleevents()
+.. method:: Mixer.handleevents() -> int
 
    Acknowledge events on the :func:`polldescriptors` file descriptors
    to prevent subsequent polls from returning the same events again.
    Returns the number of events that were acknowledged.
 
-.. method:: Mixer.close()
+.. method:: Mixer.close() -> None
 
    Closes the Mixer device.
 

doc/terminology.rst

@@ -85,6 +85,21 @@ Period size
    each write should contain exactly 32 frames of sound data, and each
    read will return either 32 frames of data or nothing at all.
 
+.. _term-sample-size:
+
+Sample size
+   Each sample takes *physical_bits* of space. *nominal_bits* tells
+   how many least significant bits are used. This is the bit depth
+   in the format name and sometimes called just *sample bits* or
+   *format width*. *significant_bits* tells how many most significant
+   bits of the *nominal_bits* are used by the sample. This can be thought
+   of as the *sample resolution*. This is visualized as follows::
+
+    MSB |00000000 XXXXXXXX XXXXXXXX 00000000| LSB
+                  |--significant--|
+                  |---------nominal---------|
+        |-------------physical--------------|
+
 Once you understand these concepts, you will be ready to use the PCM API. Read
 on.
 

isine.py

@@ -7,6 +7,7 @@
 from __future__ import print_function
 
 import sys
+import time
 from threading import Thread
 from multiprocessing import Queue
 
@@ -15,14 +16,15 @@ if sys.version_info[0] < 3:
 else:
     from queue import Empty
 
-from math import pi, sin
+from math import pi, sin, ceil
 import struct
+import itertools
 import alsaaudio
 
 sampling_rate = 48000
 
 format = alsaaudio.PCM_FORMAT_S16_LE
-framesize = 2 # bytes per frame for the values above
+pack_format = 'h'  # short int, matching S16
 channels = 2
 
 def nearest_frequency(frequency):
@@ -34,28 +36,28 @@ def generate(frequency, duration = 0.125):
     # generate a buffer with a sine wave of `frequency`
     # that is approximately `duration` seconds long
 
-    # the buffersize we approximately want
-    target_size = int(sampling_rate * channels * duration)
-
     # the length of a full sine wave at the frequency
     cycle_size = int(sampling_rate / frequency)
 
-    # number of full cycles we can fit into target_size
-    factor = int(target_size / cycle_size)
+    # number of full cycles we can fit into the duration
+    factor = int(ceil(duration * frequency))
 
-    size = max(int(cycle_size * factor), 1)
+    # total number of frames
+    size = cycle_size * factor
 
     sine = [ int(32767 * sin(2 * pi * frequency * i / sampling_rate)) \
              for i in range(size)]
 
-    return struct.pack('%dh' % size, *sine)
+    if channels > 1:
+        sine = list(itertools.chain.from_iterable(itertools.repeat(x, channels) for x in sine))
+
+    return struct.pack(str(size * channels) + pack_format, *sine)
 
 
 class SinePlayer(Thread):
 
     def __init__(self, frequency = 440.0):
-        Thread.__init__(self)
-        self.setDaemon(True)
+        Thread.__init__(self, daemon=True)
         self.device = alsaaudio.PCM(channels=channels, format=format, rate=sampling_rate)
         self.queue = Queue()
         self.change(frequency)
@@ -79,16 +81,17 @@ class SinePlayer(Thread):
         while True:
             try:
                 buffer = self.queue.get(False)
-                self.device.setperiodsize(int(len(buffer) / framesize))
-                self.device.write(buffer)
             except Empty:
+                pass
             if buffer:
-                    self.device.write(buffer)
+                if self.device.write(buffer) < 0:
+                    print("Playback buffer underrun! Continuing nonetheless ...")
 
 
 isine = SinePlayer()
 isine.start()
 
-def change(f):
-    isine.change(f)
+time.sleep(1)
+isine.change(1000)
+time.sleep(1)
 

loopback.py

@@ -70,7 +70,12 @@ class Loopback(object):
 		self.capture = capture
 		self.capture_pd = PollDescriptor.from_alsa_object('capture', capture)
 
+		self.run_after_stop = None
+		if run_after_stop:
 			self.run_after_stop = run_after_stop.split(' ')
+
+		self.run_before_start = None
+		if run_before_start:
 			self.run_before_start = run_before_start.split(' ')
 		self.run_after_stop_did_run = False
 
@@ -229,6 +234,7 @@ class VolumeForwarder(object):
 		self.playback_control = playback_control
 		self.capture_control = capture_control
 		self.active = True
+		self.volume = None
 
 	def start(self):
 		self.active = True

playbacktest.py

@@ -47,7 +47,8 @@ if __name__ == '__main__':
     # Read data from stdin
     data = f.read(320)
     while data:
-        out.write(data)
+        if out.write(data) < 0:
+            print("Playback buffer underrun! Continuing nonetheless ...")
         data = f.read(320)
     out.close()
 

playwav.py

@@ -39,7 +39,8 @@ def play(device, f):
 	data = f.readframes(periodsize)
 	while data:
 		# Read data from stdin
-		device.write(data)
+		if device.write(data) < 0:
+			print("Playback buffer underrun! Continuing nonetheless ...")
 		data = f.readframes(periodsize)
 
 

recordtest.py

@@ -59,6 +59,8 @@ if __name__ == '__main__':
 		# Read data from device
 		l, data = inp.read()
 
-		if l:
+		if l < 0:
+			print("Capture buffer overrun! Continuing nonetheless ...")
+		elif l:
 			f.write(data)
 			time.sleep(.001)