This issue can be worked around by calling mixer.handleevents() before calling mixer.getvolume(), but it makes more sense to handle all events before returning the volume.
* fix draining/closing, take 2
commit 8abf06be introduced a pause() prior to draining, in an attempt
to work around clearly broken pulseaudio client behavior for capture
streams (drain() is supposed to imply a stop).
but as the workaround was also applied to playback streams, it would
cause nasty "clicks", as the stream would (obviously) stop before being
resumed for draining.
but draining is actually pointless for capture streams, as we're closing
right afterwards, so the samples are lost anyway.
what's more, destructors are not supposed to wait for anything, so
draining in alsapcm_dealloc() was wrong to start with. so we remove it.
note that this is a minor behavior change, which is reflected by the
adjustment of the playback test to have an explicit close() at the end.
finally, close() was also affected by the pulseaudio bug (which was not
addressed before), so there we make draining exclusive to playback
streams.
* fix memory leaks in *_polldescriptors()
the calloc'd pollfd arrays were not freed.
* fix memory handling in mixer access error paths
in case of error, alsamixer_new() would leak the object, while
alsamixer_list() might crash due to a null pointer.
as a drive-by, make alsamixer_gethandle() `static`.
* fix crashes when accessing already closed devices
PCM.htimestamp() gets the usual exception emission,
Mixer.close() gets a "double invocation" check like PCM.close() has.
* fix deprecation warning about PyEval_InitThreads()
PyEval_InitThreads is a no-op in since python 3.9.
* fix deprecation warning about PyUnicode_AsUnicode()
converting to ascii for the purpose of comparison is inefficient.
* remove redundant snd_pcm_hw_params_any() call
we just called it (and even error-checked it) a few lines above.
* add new high-speed samples rates
closes#89 (but alsa doesn't support 768khz yet).
* drop some pointless comments from the tex => sphinx conversion
amends 5c2a00655.
* remove bogus markup from the documentation
the poll objects are linked properly in a different way, and the
footnote appears outdated.
* unify line spacing in .rst files
one empty line, except for high-level sections, which get two.
while at it, trim whitespace on otherwise empty lines.
* formatting/language fixes in introduction document
* improve terminology document
mention xruns, and rework the definition of periods: concentrate on
relevant information, and remove the misinformation about period size
reduction being not that bad (pedantically, an application could run
somewhat asynchronously to the interrupts by using some timer, and
therefore actually save some of the overhead, but why would one use a
small period size in the first place then?).
also, language and formatting fixes.
* add missing and update incorrect/outdated documentation
for clarity, this includes docs which were previously omitted
(presumably) intentionally, but mark them as comments.
the getrec() and getmute() functions' docs are moved around, so they
appear in pairs with their set*() counterparts, like the *volume() ones
already did.
notably, this also fixes the docu of PCM_FORMAT_U8, which closes#104.
* add some best practices to the docu
addresses #110, among other things.
* purge pydoc from the source
it's been obsolete for a *long* time, and having it redundantly to the
rst sources is bad hygiene. it still contained some useful info, which
has been transplanted to the rst source in the previous commit.
* use data types closer to those of ALSA
this removes lots of casts around snd_pcm_hw_params_get_*() calls
we could go further with that to make the code clean if we enabled all
the warnings, but it doesn't seem worth the effort.
* reduce scope of GIL releases
it's pointless to enclose snd_pcm_close() and snd_pcm_pause(), as these
calls don't sleep.
* reshuffle XRUN recovery somewhat
perform it prior to invoking read()/write() if necessary, not right
after a failure event. this makes things more uniform and predictable.
we don't use snd_pcm_recover() any more, as we used it only for the
EPIPE case anyway, which boils down to snd_pcm_prepare() exactly.
handling ESTRPIPE as well might be desirable, but that's a separate
consideration.
* bump (minor) version
we're about to add new features.
* make period count configurable
the period count is just as important for playback latency as the period
size, so it makes no sense to have only one of them configurable.
as a drive-by, fix up the handling of periods in info() & dumpinfo().
* add PCM.drain()
for playback, this allows making sure that all written frames are
played, without using an external delay.
in principle, it's also usable for capture, but there isn't really a
practical reason to do so, as simply discarding excess captured frames
has no real cost.
* add PCM.state() and associated enum values
in principle, the state is already available from info(), but that's a
rather heavy function for something one might want to query often.
a practical use case might be checking whether a playback stream is done
draining, for example.
* First version documentation PCM.info() method.
* Add reference to documentation to docstring for PCM.info() method.
* Add extra fields to info dict:
card_no *index of card* integer (negative indicates device not associable with a card)
device_no *index of PCM device* integer
subdevice_no *index of PCM subdevice* integer
and update documentation accordingly.
Co-authored-by: Ronald van Elburg <Ronald@SoundAppraisal.eu>
* alsamixer_getvolume: Fix incorrect parenthesis
The pcmtypeobj check is overriding the pcmtype if the object is not NULL
or Py_None, making it impossible to get the playback volume. Fix the
paranthesis so that pcmtype is only overwritten when pcmtypeobj is not
set.
* Fix indentation format
Fix the indentation format to match the rest of the project.1
Co-authored-by: Portia <portia.stephens@biamp.com>
* Use `pcmtype` keyword for range
Update methods that accept a `direction` argument (i.e.
capture/playback) to get this via positional _or_ keyword arguments.
Code using keyword arguments can be more robust; however the main reason
for this change is to prepare the way for an extra `units` argument to
many of these methods.
Update documentation to consistently use `pcmtype` instead of
a mixture of that and `direction`.
* Support units
Currently, after recording audio using pyalsaaudio, the client is unable to close the device.
The reason is that PulseAudio client tries to drain the pipe to the PulseAudio server (presumably in order to prevent Broken Pipe error) on closing. That will never finish since new data will always arrive in the pipe.
Worse, the __del__ handler was auto-closing and thus auto-hanging.
Therefore, pause before de-allocating.
SND_PCM_FORMAT_S24_LE and similar are for 24bit ints packed in 4-bytes each.
There is a similar family of formats for 3-bytes packed data (as stored in 24bit wave files).
This commit:
- adds S24_3LE, S24_3BE, U24_3LE, U24_3BE PCM formats to the alsaaudio.c
- updates documentation
- updates playwav.py to correctly play typical 24Bit PCM wave files
Closes#38
The cards() method does not guarantee that the index in its return
value is the same as the actual card index. Provide a way to get this
information in the form of a card_indexes() function, returning a
list of available card indexes.
Add another method, card_name(), which, given a card index, returns
the short and long names of that card.
Add a method, setenum(), for setting the value of an enumerated mixer
element. The argument is an integer index into the list of possible
values returned by getenum().
