diff --git a/alsaaudio.c b/alsaaudio.c index 89ec8c3..80a8849 100644 --- a/alsaaudio.c +++ b/alsaaudio.c @@ -16,7 +16,8 @@ #include "Python.h" #if PY_MAJOR_VERSION < 3 #include "stringobject.h" -#define PyUnicode_FromString PyString_FromString +#define PyUnicode_AS_DATA PyString_AS_STRING +#define PyUnicode_Check PyString_Check #endif #include #include @@ -71,14 +72,98 @@ typedef struct { } alsamixer_t; -static PyObject *ALSAAudioError; +/* Translate a card id to a ALSA cardname + Returns a newly allocated string. +*/ +char *translate_cardname(char *name) +{ + static char dflt[] = "default"; + char *full = NULL; + + if (!name || !strcmp(name, dflt)) + return strdup(dflt); + + // If we find a colon, we assume it is a real ALSA cardname + if (strchr(name, ':')) + return strdup(name); + + full = malloc(strlen("default:CARD=") + strlen(name) + 1); + sprintf(full, "default:CARD=%s", name); + + return full; +} + +/* Translate a card index to a ALSA cardname + + Returns a newly allocated string. +*/ +char *translate_cardidx(int idx) +{ + char name[32]; + + sprintf(name, "hw:%d", idx); + + return strdup(name); +} /******************************************/ /* PCM object wrapper */ /******************************************/ static PyTypeObject ALSAPCMType; +static PyObject *ALSAAudioError; + +static PyObject * +alsacard_list(PyObject *self, PyObject *args) { + int rc; + int card = -1; + snd_ctl_card_info_t *info; + snd_ctl_t *handle; + PyObject *result = NULL; + + if (!PyArg_ParseTuple(args,":cards")) + return NULL; + + snd_ctl_card_info_alloca(&info); + result = PyList_New(0); + + for (rc = snd_card_next(&card); !rc && (card >= 0); + rc = snd_card_next(&card)) + { + char name[32]; + int err; + + /* One would be tempted to think that snd_card_get_name returns a name + that is actually meaningful for any further operations. + + Not in ALSA land. Here we need the id, not the name */ + + sprintf(name, "hw:%d", card); + if ((err = snd_ctl_open(&handle, name, 0)) < 0) { + PyErr_SetString(ALSAAudioError,snd_strerror(err)); + return NULL; + } + if ((err = snd_ctl_card_info(handle, info)) < 0) { + PyErr_SetString(ALSAAudioError,snd_strerror(err)); + snd_ctl_close(handle); + Py_DECREF(result); + return NULL; + } + + PyList_Append(result, + PyUnicode_FromString(snd_ctl_card_info_get_id(info))); + + snd_ctl_close(handle); + } + + return result; +} + +PyDoc_STRVAR(cards_doc, +"cards()\n\ +\n\ +List the available card ids."); static int alsapcm_setup(alsapcm_t *self) { int res,dir; @@ -87,18 +172,12 @@ static int alsapcm_setup(alsapcm_t *self) { snd_pcm_uframes_t frames; snd_pcm_hw_params_t *hwparams; - if (self->handle) { - snd_pcm_close(self->handle); - self->handle = 0; - } - res = snd_pcm_open(&(self->handle),self->cardname,self->pcmtype, - self->pcmmode); - if (res < 0) return res; - - /* Allocate a hwparam structure, and fill it in with configuration space */ + /* Allocate a hwparam structure on the stack, + and fill it in with configuration space */ snd_pcm_hw_params_alloca(&hwparams); res = snd_pcm_hw_params_any(self->handle, hwparams); - if (res < 0) return res; + if (res < 0) + return res; /* Fill it in with default values. */ snd_pcm_hw_params_any(self->handle, hwparams); @@ -110,7 +189,7 @@ static int alsapcm_setup(alsapcm_t *self) { snd_pcm_hw_params_set_rate(self->handle, hwparams, self->rate, dir); snd_pcm_hw_params_set_period_size(self->handle, hwparams, self->periodsize, dir); - snd_pcm_hw_params_set_periods(self->handle,hwparams,4,0); + snd_pcm_hw_params_set_periods(self->handle, hwparams, 4, 0); /* Write it to the device */ res = snd_pcm_hw_params(self->handle, hwparams); @@ -118,15 +197,16 @@ static int alsapcm_setup(alsapcm_t *self) { /* Query current settings. These may differ from the requested values, which should therefore be sync'ed with actual values */ - snd_pcm_hw_params_current(self->handle,hwparams); + snd_pcm_hw_params_current(self->handle, hwparams); - snd_pcm_hw_params_get_format(hwparams,&fmt); self->format = fmt; - snd_pcm_hw_params_get_channels(hwparams,&val); self->channels = val; - snd_pcm_hw_params_get_rate(hwparams,&val,&dir); self->rate = val; - snd_pcm_hw_params_get_period_size(hwparams,&frames,&dir); + snd_pcm_hw_params_get_format(hwparams, &fmt); self->format = fmt; + snd_pcm_hw_params_get_channels(hwparams, &val); self->channels = val; + snd_pcm_hw_params_get_rate(hwparams, &val, &dir); self->rate = val; + snd_pcm_hw_params_get_period_size(hwparams, &frames, &dir); self->periodsize = (int) frames; self->framesize = self->channels * snd_pcm_hw_params_get_sbits(hwparams)/8; + return res; } @@ -134,11 +214,15 @@ static PyObject * alsapcm_new(PyTypeObject *type, PyObject *args, PyObject *kwds) { int res; alsapcm_t *self; - int pcmtype=0; - int pcmmode=0; - char *cardname = "default"; - if (!PyArg_ParseTuple(args,"|iis",&pcmtype,&pcmmode,&cardname)) + int pcmtype = SND_PCM_STREAM_PLAYBACK; + int pcmmode = 0; + char *kw[] = { "type", "mode", "card", NULL }; + char *cardname = NULL; + + if (!PyArg_ParseTupleAndKeywords(args, kwds, "|iiz", kw, + &pcmtype, &pcmmode, &cardname)) return NULL; + if (!(self = (alsapcm_t *)PyObject_New(alsapcm_t, &ALSAPCMType))) return NULL; @@ -152,17 +236,20 @@ alsapcm_new(PyTypeObject *type, PyObject *args, PyObject *kwds) { PyErr_SetString(ALSAAudioError, "Invalid PCM mode"); return NULL; } + self->handle = 0; self->pcmtype = pcmtype; self->pcmmode = pcmmode; - self->cardname = strdup(cardname); - + self->cardname = translate_cardname(cardname); self->channels = 2; self->rate = 44100; self->format = SND_PCM_FORMAT_S16_LE; self->periodsize = 32; - self->handle = 0; - res = alsapcm_setup(self); + res = snd_pcm_open(&(self->handle), self->cardname, self->pcmtype, + self->pcmmode); + + if (res >= 0) + res = alsapcm_setup(self); if (res < 0) { if (self->handle) { @@ -175,7 +262,8 @@ alsapcm_new(PyTypeObject *type, PyObject *args, PyObject *kwds) { return (PyObject *)self; } -static void alsapcm_dealloc(alsapcm_t *self) { +static void alsapcm_dealloc(alsapcm_t *self) +{ if (self->handle) { snd_pcm_drain(self->handle); snd_pcm_close(self->handle); @@ -184,6 +272,30 @@ static void alsapcm_dealloc(alsapcm_t *self) { PyObject_Del(self); } +static PyObject * +alsapcm_close(alsapcm_t *self, PyObject *args) +{ + if (!PyArg_ParseTuple(args,":close")) + return NULL; + + if (self->handle) { + Py_BEGIN_ALLOW_THREADS + snd_pcm_drain(self->handle); + snd_pcm_close(self->handle); + Py_END_ALLOW_THREADS + + self->handle = 0; + } + + Py_INCREF(Py_None); + return Py_None; +} + +PyDoc_STRVAR(pcm_close_doc, +"close() -> None\n\ +\n\ +Close a PCM device."); + static PyObject * alsapcm_dumpinfo(alsapcm_t *self, PyObject *args) { unsigned int val,val2; @@ -194,8 +306,13 @@ alsapcm_dumpinfo(alsapcm_t *self, PyObject *args) { snd_pcm_hw_params_alloca(&hwparams); snd_pcm_hw_params_current(self->handle,hwparams); + if (!PyArg_ParseTuple(args,":dumpinfo")) + return NULL; - if (!PyArg_ParseTuple(args,":dumpinfo")) return NULL; + if (!self->handle) { + PyErr_SetString(ALSAAudioError, "PCM device is closed"); + return NULL; + } printf("PCM handle name = '%s'\n", snd_pcm_name(self->handle)); printf("PCM state = %s\n", snd_pcm_state_name(snd_pcm_state(self->handle))); @@ -280,7 +397,14 @@ alsapcm_dumpinfo(alsapcm_t *self, PyObject *args) { static PyObject * alsapcm_pcmtype(alsapcm_t *self, PyObject *args) { - if (!PyArg_ParseTuple(args,":pcmtype")) return NULL; + if (!PyArg_ParseTuple(args,":pcmtype")) + return NULL; + + if (!self->handle) { + PyErr_SetString(ALSAAudioError, "PCM device is closed"); + return NULL; + } + return PyLong_FromLong(self->pcmtype); } @@ -292,7 +416,14 @@ Returns either PCM_CAPTURE or PCM_PLAYBACK."); static PyObject * alsapcm_pcmmode(alsapcm_t *self, PyObject *args) { - if (!PyArg_ParseTuple(args,"pcmmode")) return NULL; + if (!PyArg_ParseTuple(args,":pcmmode")) + return NULL; + + if (!self->handle) { + PyErr_SetString(ALSAAudioError, "PCM device is closed"); + return NULL; + } + return PyLong_FromLong(self->pcmmode); } @@ -307,7 +438,14 @@ Returns the mode of the PCM object. One of:\n\ static PyObject * alsapcm_cardname(alsapcm_t *self, PyObject *args) { - if (!PyArg_ParseTuple(args,":cardname")) return NULL; + if (!PyArg_ParseTuple(args,":cardname")) + return NULL; + + if (!self->handle) { + PyErr_SetString(ALSAAudioError, "PCM device is closed"); + return NULL; + } + return PyUnicode_FromString(self->cardname); } @@ -321,7 +459,14 @@ static PyObject * alsapcm_setchannels(alsapcm_t *self, PyObject *args) { int channels; int res; - if (!PyArg_ParseTuple(args,"i:setchannels",&channels)) return NULL; + if (!PyArg_ParseTuple(args,"i:setchannels",&channels)) + return NULL; + + if (!self->handle) { + PyErr_SetString(ALSAAudioError, "PCM device is closed"); + return NULL; + } + self->channels = channels; res = alsapcm_setup(self); if (res < 0) { @@ -344,7 +489,14 @@ static PyObject * alsapcm_setrate(alsapcm_t *self, PyObject *args) { int rate; int res; - if (!PyArg_ParseTuple(args,"i:setrate",&rate)) return NULL; + if (!PyArg_ParseTuple(args,"i:setrate",&rate)) + return NULL; + + if (!self->handle) { + PyErr_SetString(ALSAAudioError, "PCM device is closed"); + return NULL; + } + self->rate = rate; res = alsapcm_setup(self); if (res < 0) { @@ -358,14 +510,21 @@ PyDoc_STRVAR(setrate_doc, "setrate(rate)\n\ \n\ Set the sample rate in Hz for the device. Typical values are\n\ -8000(telephony), 11025, 44100 (CD), 48000 (DVD audio) and 96000"); +8000 (telephony), 11025, 44100 (CD), 48000 (DVD audio) and 96000"); static PyObject * alsapcm_setformat(alsapcm_t *self, PyObject *args) { int format; int res; - if (!PyArg_ParseTuple(args,"i:setformat",&format)) return NULL; + if (!PyArg_ParseTuple(args,"i:setformat",&format)) + return NULL; + + if (!self->handle) { + PyErr_SetString(ALSAAudioError, "PCM device is closed"); + return NULL; + } + self->format = format; res = alsapcm_setup(self); if (res < 0) { @@ -383,7 +542,14 @@ static PyObject * alsapcm_setperiodsize(alsapcm_t *self, PyObject *args) { int periodsize; int res; - if (!PyArg_ParseTuple(args,"i:setperiodsize",&periodsize)) return NULL; + if (!PyArg_ParseTuple(args,"i:setperiodsize",&periodsize)) + return NULL; + + if (!self->handle) { + PyErr_SetString(ALSAAudioError, "PCM device is closed"); + return NULL; + } + self->periodsize = periodsize; res = alsapcm_setup(self); if (res < 0) { @@ -394,12 +560,12 @@ alsapcm_setperiodsize(alsapcm_t *self, PyObject *args) { } PyDoc_STRVAR(setperiodsize_doc, -"setperiodsize(period)\n\ +"setperiodsize(period) -> int\n\ \n\ Sets the actual period size in frames. Each write should consist of\n\ exactly this number of frames, and each read will return this number of\n\ frames (unless the device is in PCM_NONBLOCK mode, in which case it\n\ -may return nothing at all)"); +may return nothing at all)."); static PyObject * alsapcm_read(alsapcm_t *self, PyObject *args) { @@ -412,7 +578,14 @@ alsapcm_read(alsapcm_t *self, PyObject *args) { return NULL; } - if (!PyArg_ParseTuple(args,":read")) return NULL; + if (!PyArg_ParseTuple(args,":read")) + return NULL; + + if (!self->handle) { + PyErr_SetString(ALSAAudioError, "PCM device is closed"); + return NULL; + } + if (self->pcmtype != SND_PCM_STREAM_CAPTURE) { PyErr_SetString(ALSAAudioError,"Cannot read from playback PCM"); return NULL; @@ -476,6 +649,11 @@ static PyObject *alsapcm_write(alsapcm_t *self, PyObject *args) { datalen = buf.len; #endif + if (!self->handle) { + PyErr_SetString(ALSAAudioError, "PCM device is closed"); + return NULL; + } + if (datalen % self->framesize) { PyErr_SetString(ALSAAudioError, "Data size must be a multiple of framesize"); @@ -522,7 +700,14 @@ written at a later time."); static PyObject *alsapcm_pause(alsapcm_t *self, PyObject *args) { int enabled=1, res; - if (!PyArg_ParseTuple(args,"|i:pause",&enabled)) return NULL; + + if (!PyArg_ParseTuple(args,"|i:pause",&enabled)) + return NULL; + + if (!self->handle) { + PyErr_SetString(ALSAAudioError, "PCM device is closed"); + return NULL; + } Py_BEGIN_ALLOW_THREADS res = snd_pcm_pause(self->handle, enabled); @@ -558,6 +743,7 @@ static PyMethodDef alsapcm_methods[] = { {"read", (PyCFunction)alsapcm_read, METH_VARARGS, read_doc}, {"write", (PyCFunction)alsapcm_write, METH_VARARGS, write_doc}, {"pause", (PyCFunction)alsapcm_pause, METH_VARARGS, pause_doc}, + {"close", (PyCFunction)alsapcm_close, METH_VARARGS, pcm_close_doc}, {NULL, NULL} }; @@ -655,18 +841,25 @@ alsamixer_list(PyObject *self, PyObject *args) { snd_mixer_selem_id_t *sid; snd_mixer_elem_t *elem; int err; - char *cardname = "default"; - PyObject *result = PyList_New(0); + int cardidx = 0; + char cardname[32]; + PyObject *result; - if (!PyArg_ParseTuple(args,"|s:mixers",&cardname)) return NULL; + if (!PyArg_ParseTuple(args,"|i:mixers",&cardidx)) + return NULL; + sprintf(cardname, "hw:%d", cardidx); + snd_mixer_selem_id_alloca(&sid); - err = alsamixer_gethandle(cardname,&handle); + err = alsamixer_gethandle(cardname, &handle); if (err < 0) { PyErr_SetString(ALSAAudioError,snd_strerror(err)); snd_mixer_close(handle); return NULL; } + + result = PyList_New(0); + for (elem = snd_mixer_first_elem(handle); elem; elem = snd_mixer_elem_next(elem)) { @@ -703,23 +896,30 @@ static PyObject * alsamixer_new(PyTypeObject *type, PyObject *args, PyObject *kwds) { alsamixer_t *self; int err; - char *cardname = "default"; + int cardindex = 0; char *control = "Master"; int id = 0; snd_mixer_elem_t *elem; int channel; - - if (!PyArg_ParseTuple(args,"|sis",&control,&id,&cardname)) + char *kw[] = { "control", "id", "cardindex", NULL }; + + if (!PyArg_ParseTupleAndKeywords(args, kwds, "|sii", kw, + &control, &id, &cardindex)) return NULL; + if (!(self = (alsamixer_t *)PyObject_New(alsamixer_t, &ALSAMixerType))) return NULL; - err = alsamixer_gethandle(cardname,&self->handle); + self->handle = 0; + self->cardname = translate_cardidx(cardindex); + + err = alsamixer_gethandle(self->cardname, &self->handle); if (err<0) { PyErr_SetString(ALSAAudioError,snd_strerror(err)); + free(self->cardname); return NULL; - } - self->cardname = strdup(cardname); + } + self->controlname = strdup(control); self->controlid = id; @@ -811,8 +1011,37 @@ static void alsamixer_dealloc(alsamixer_t *self) { } static PyObject * -alsamixer_cardname(alsamixer_t *self, PyObject *args) { - if (!PyArg_ParseTuple(args,":cardname")) return NULL; +alsamixer_close(alsamixer_t *self, PyObject *args) +{ + if (!PyArg_ParseTuple(args,":close")) + return NULL; + + snd_mixer_close(self->handle); + free(self->cardname); + free(self->controlname); + self->handle = 0; + + Py_INCREF(Py_None); + return Py_None; +} + +PyDoc_STRVAR(mixer_close_doc, +"close() -> None\n\ +\n\ +Close a Mixer."); + +static PyObject * +alsamixer_cardname(alsamixer_t *self, PyObject *args) +{ + if (!PyArg_ParseTuple(args,":cardname")) + return NULL; + + if (!self->handle) + { + PyErr_SetString(ALSAAudioError, "Mixer is closed"); + return NULL; + } + return PyUnicode_FromString(self->cardname); } @@ -821,10 +1050,18 @@ PyDoc_STRVAR(mixer_cardname_doc, \n\ Returns the name of the sound card used by this Mixer object."); - static PyObject * -alsamixer_mixer(alsamixer_t *self, PyObject *args) { - if (!PyArg_ParseTuple(args,":mixer")) return NULL; +alsamixer_mixer(alsamixer_t *self, PyObject *args) +{ + if (!PyArg_ParseTuple(args,":mixer")) + return NULL; + + if (!self->handle) + { + PyErr_SetString(ALSAAudioError, "Mixer is closed"); + return NULL; + } + return PyUnicode_FromString(self->controlname); } @@ -837,7 +1074,15 @@ for example 'Master' or 'PCM'"); static PyObject * alsamixer_mixerid(alsamixer_t *self, PyObject *args) { - if (!PyArg_ParseTuple(args,":mixerid")) return NULL; + if (!PyArg_ParseTuple(args,":mixerid")) + return NULL; + + if (!self->handle) + { + PyErr_SetString(ALSAAudioError, "Mixer is closed"); + return NULL; + } + return PyLong_FromLong(self->controlid); } @@ -948,7 +1193,14 @@ alsamixer_getvolume(alsamixer_t *self, PyObject *args) { char *dirstr = 0; PyObject *result; - if (!PyArg_ParseTuple(args,"|s:getvolume",&dirstr)) return NULL; + if (!PyArg_ParseTuple(args,"|s:getvolume",&dirstr)) + return NULL; + + if (!self->handle) + { + PyErr_SetString(ALSAAudioError, "Mixer is closed"); + return NULL; + } elem = alsamixer_find_elem(self->handle,self->controlname,self->controlid); @@ -977,7 +1229,7 @@ alsamixer_getvolume(alsamixer_t *self, PyObject *args) { snd_mixer_selem_get_capture_volume(elem, channel, &ival); PyList_Append( result, PyLong_FromLong(alsamixer_getpercentage(self->cmin, - self->cmax, ival))); + self->cmax, ival))); } } return result; @@ -1001,7 +1253,14 @@ alsamixer_getrange(alsamixer_t *self, PyObject *args) { int direction; char *dirstr = 0; - if (!PyArg_ParseTuple(args,"|s:getrange",&dirstr)) return NULL; + if (!PyArg_ParseTuple(args,"|s:getrange",&dirstr)) + return NULL; + + if (!self->handle) + { + PyErr_SetString(ALSAAudioError, "Mixer is closed"); + return NULL; + } elem = alsamixer_find_elem(self->handle,self->controlname,self->controlid); @@ -1059,7 +1318,14 @@ alsamixer_getenum(alsamixer_t *self, PyObject *args) { char name[32]; PyObject *result; - if (!PyArg_ParseTuple(args, ":getenum")) return NULL; + if (!PyArg_ParseTuple(args, ":getenum")) + return NULL; + + if (!self->handle) + { + PyErr_SetString(ALSAAudioError, "Mixer is closed"); + return NULL; + } elem = alsamixer_find_elem(self->handle,self->controlname,self->controlid); if (!snd_mixer_selem_is_enumerated(elem)) { @@ -1127,7 +1393,14 @@ alsamixer_getmute(alsamixer_t *self, PyObject *args) { int i; int ival; PyObject *result; - if (!PyArg_ParseTuple(args,":getmute")) return NULL; + if (!PyArg_ParseTuple(args,":getmute")) + return NULL; + + if (!self->handle) + { + PyErr_SetString(ALSAAudioError, "Mixer is closed"); + return NULL; + } elem = alsamixer_find_elem(self->handle,self->controlname,self->controlid); if (!snd_mixer_selem_has_playback_switch(elem)) { @@ -1159,7 +1432,14 @@ alsamixer_getrec(alsamixer_t *self, PyObject *args) { int i; int ival; PyObject *result; - if (!PyArg_ParseTuple(args,":getrec")) return NULL; + if (!PyArg_ParseTuple(args,":getrec")) + return NULL; + + if (!self->handle) + { + PyErr_SetString(ALSAAudioError, "Mixer is closed"); + return NULL; + } elem = alsamixer_find_elem(self->handle,self->controlname,self->controlid); if (!snd_mixer_selem_has_capture_switch(elem)) { @@ -1202,6 +1482,12 @@ alsamixer_setvolume(alsamixer_t *self, PyObject *args) { PyErr_SetString(ALSAAudioError,"Volume must be between 0 and 100"); return NULL; } + + if (!self->handle) + { + PyErr_SetString(ALSAAudioError, "Mixer is closed"); + return NULL; + } elem = alsamixer_find_elem(self->handle,self->controlname,self->controlid); @@ -1263,7 +1549,14 @@ alsamixer_setmute(alsamixer_t *self, PyObject *args) { int mute = 0; int done = 0; int channel = MIXER_CHANNEL_ALL; - if (!PyArg_ParseTuple(args,"i|i:setmute",&mute,&channel)) return NULL; + if (!PyArg_ParseTuple(args,"i|i:setmute",&mute,&channel)) + return NULL; + + if (!self->handle) + { + PyErr_SetString(ALSAAudioError, "Mixer is closed"); + return NULL; + } elem = alsamixer_find_elem(self->handle,self->controlname,self->controlid); if (!snd_mixer_selem_has_playback_switch(elem)) { @@ -1304,7 +1597,15 @@ alsamixer_setrec(alsamixer_t *self, PyObject *args) { int rec = 0; int done = 0; int channel = MIXER_CHANNEL_ALL; - if (!PyArg_ParseTuple(args,"i|i:setrec",&rec,&channel)) return NULL; + + if (!PyArg_ParseTuple(args,"i|i:setrec",&rec,&channel)) + return NULL; + + if (!self->handle) + { + PyErr_SetString(ALSAAudioError, "Mixer is closed"); + return NULL; + } elem = alsamixer_find_elem(self->handle,self->controlname,self->controlid); if (!snd_mixer_selem_has_capture_switch(elem)) { @@ -1341,6 +1642,7 @@ This method will fail if the mixer has no capture switch capabilities"); static PyMethodDef alsamixer_methods[] = { {"cardname", (PyCFunction)alsamixer_cardname, METH_VARARGS, mixer_cardname_doc}, + {"close", (PyCFunction)alsamixer_close, METH_VARARGS, mixer_close_doc}, {"mixer", (PyCFunction)alsamixer_mixer, METH_VARARGS, mixer_doc}, {"mixerid", (PyCFunction)alsamixer_mixerid, METH_VARARGS, mixerid_doc}, {"switchcap", (PyCFunction)alsamixer_switchcap, METH_VARARGS, switchcap_doc}, @@ -1415,6 +1717,7 @@ static PyTypeObject ALSAMixerType = { /******************************************/ static PyMethodDef alsaaudio_methods[] = { + { "cards", alsacard_list, METH_VARARGS, cards_doc}, { "mixers", alsamixer_list, METH_VARARGS, mixers_doc}, { 0, 0 }, }; diff --git a/doc/Makefile b/doc/Makefile index e01e8b8..2b39d69 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -9,7 +9,7 @@ PAPER = # Internal variables. PAPEROPT_a4 = -D latex_paper_size=a4 PAPEROPT_letter = -D latex_paper_size=letter -ALLSPHINXOPTS = -d .build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +ALLSPHINXOPTS = -d doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . SFUSER = larsimmisch @@ -27,51 +27,51 @@ help: @echo " linkcheck to check all external links for integrity" clean: - -rm -rf .build/* + -rm -rf html doctrees pickle htmlhelp latex changes linkcheck html: - mkdir -p .build/html .build/doctrees - $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) .build/html + mkdir -p html doctrees + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) html @echo - @echo "Build finished. The HTML pages are in .build/html." + @echo "Build finished. The HTML pages are in html." pickle: - mkdir -p .build/pickle .build/doctrees - $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) .build/pickle + mkdir -p pickle doctrees + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) pickle @echo @echo "Build finished; now you can process the pickle files or run" - @echo " sphinx-web .build/pickle" + @echo " sphinx-web pickle" @echo "to start the sphinx-web server." web: pickle htmlhelp: - mkdir -p .build/htmlhelp .build/doctrees - $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) .build/htmlhelp + mkdir -p htmlhelp doctrees + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) htmlhelp @echo @echo "Build finished; now you can run HTML Help Workshop with the" \ - ".hhp project file in .build/htmlhelp." + ".hhp project file in htmlhelp." latex: - mkdir -p .build/latex .build/doctrees - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) .build/latex + mkdir -p latex doctrees + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) latex @echo @echo "Build finished; the LaTeX files are in .build/latex." @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \ "run these through (pdf)latex." changes: - mkdir -p .build/changes .build/doctrees - $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) .build/changes + mkdir -p changes doctrees + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) changes @echo - @echo "The overview file is in .build/changes." + @echo "The overview file is in changes." linkcheck: - mkdir -p .build/linkcheck .build/doctrees - $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) .build/linkcheck + mkdir -p linkcheck doctrees + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) linkcheck @echo @echo "Link check complete; look for any errors in the above output " \ - "or in .build/linkcheck/output.txt." + "or in linkcheck/output.txt." install: - scp -r .build/html/* $(SFUSER),pyalsaaudio@web.sourceforge.net:htdocs + scp -r ./html/* $(SFUSER),pyalsaaudio@web.sourceforge.net:htdocs diff --git a/doc/conf.py b/doc/conf.py new file mode 100644 index 0000000..53b4ade --- /dev/null +++ b/doc/conf.py @@ -0,0 +1,179 @@ +# -*- coding: utf-8 -*- +# +# alsaaudio documentation build configuration file, created by +# sphinx-quickstart on Sat Nov 22 00:17:09 2008. +# +# This file is execfile()d with the current directory set to its containing dir. +# +# The contents of this file are pickled, so don't put values in the namespace +# that aren't pickleable (module imports are okay, they're removed automatically). +# +# All configuration values have a default value; values that are commented out +# serve to show the default value. + +import sys, os + +# If your extensions are in another directory, add it here. If the directory +# is relative to the documentation root, use os.path.abspath to make it +# absolute, like shown here. +#sys.path.append(os.path.abspath('some/directory')) + +# General configuration +# --------------------- + +# Add any Sphinx extension module names here, as strings. They can be extensions +# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. +extensions = [] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['.templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The master toctree document. +master_doc = 'index' + +# General substitutions. +project = u'alsaaudio' +copyright = u'2008, Casper Wilstrup, Lars Immisch' + +# The default replacements for |version| and |release|, also used in various +# other places throughout the built documents. +# +# The short X.Y version. +version = '0.4' +# The full version, including alpha/beta/rc tags. +release = '0.4' + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +today_fmt = '%B %d, %Y' + +# List of documents that shouldn't be included in the build. +#unused_docs = [] + +# List of directories, relative to source directories, that shouldn't be searched +# for source files. +exclude_trees = ['.build'] + +# The reST default role (used for this markup: `text`) to use for all documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + + +# Options for HTML output +# ----------------------- + +# The style sheet to use for HTML and HTML Help pages. A file of that name +# must exist either in Sphinx' static/ path, or in one of the custom paths +# given in html_static_path. +html_style = 'default.css' + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +#html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +#html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +#html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +#html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['static'] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +#html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_use_modindex = True + +# If false, no index is generated. +#html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, the reST sources are included in the HTML build as _sources/. +#html_copy_source = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = '' + +# Output file base name for HTML help builder. +htmlhelp_basename = 'alsaaudiodoc' + + +# Options for LaTeX output +# ------------------------ + +# The paper size ('letter' or 'a4'). +#latex_paper_size = 'letter' + +# The font size ('10pt', '11pt' or '12pt'). +#latex_font_size = '10pt' + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, author, document class [howto/manual]). +latex_documents = [ + ('index', 'alsaaudio.tex', u'alsaaudio Documentation', + u'Casper Wilstrup, Lars Immisch', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +#latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# Additional stuff for the LaTeX preamble. +#latex_preamble = '' + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_use_modindex = True diff --git a/doc/index.rst b/doc/index.rst index b89500d..e5e7c6c 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -5,6 +5,7 @@ alsaaudio documentation :maxdepth: 2 pyalsaaudio + terminology libalsaaudio diff --git a/doc/libalsaaudio.rst b/doc/libalsaaudio.rst index 93fd7dc..74b7c1d 100644 --- a/doc/libalsaaudio.rst +++ b/doc/libalsaaudio.rst @@ -1,84 +1,6 @@ -**************************** -PCM Terminology and Concepts -**************************** - -In order to use PCM devices it is useful to be familiar with some concepts and -terminology. - -Sample - PCM audio, whether it is input or output, consists of *samples*. - A single sample represents the amplitude of one channel of sound - at a certain point in time. A lot of individual samples are - necessary to represent actual sound; for CD audio, 44100 samples - are taken every second. - - Samples can be of many different sizes, ranging from 8 bit to 64 - bit precision. The specific format of each sample can also vary - - they can be big endian byte integers, little endian byte integers, or - floating point numbers. - - Musically, the sample size determines the dynamic range. The - dynamic range is the difference between the quietest and the - loudest signal that can be resproduced. - -Frame - A frame consists of exactly one sample per channel. If there is only one - channel (Mono sound) a frame is simply a single sample. If the sound is - stereo, each frame consists of two samples, etc. - -Frame size - This is the size in bytes of each frame. This can vary a lot: if each sample - is 8 bits, and we're handling mono sound, the frame size is one byte. - Similarly in 6 channel audio with 64 bit floating point samples, the frame - size is 48 bytes - -Rate - PCM sound consists of a flow of sound frames. The sound rate controls how - often the current frame is replaced. For example, a rate of 8000 Hz - means that a new frame is played or captured 8000 times per second. - -Data rate - This is the number of bytes, which must be recorded or provided per - second at a certain frame size and rate. - - 8000 Hz mono sound with 8 bit (1 byte) samples has a data rate of - 8000 \* 1 \* 1 = 8 kb/s or 64kbit/s. This is typically used for telephony. - - At the other end of the scale, 96000 Hz, 6 channel sound with 64 - bit (8 bytes) samples has a data rate of 96000 \* 6 \* 8 = 4608 - kb/s (almost 5 Mb sound data per second) - -Period - When the hardware processes data this is done in chunks of frames. The time - interval between each processing (A/D or D/A conversion) is known - as the period. - The size of the period has direct implication on the latency of the - sound input or output. For low-latency the period size should be - very small, while low CPU resource usage would usually demand - larger period sizes. With ALSA, the CPU utilization is not impacted - much by the period size, since the kernel layer buffers multiple - periods internally, so each period generates an interrupt and a - memory copy, but userspace can be slower and read or write multiple - periods at the same time. - -Period size - This is the size of each period in Hz. *Not bytes, but Hz!.* In - :mod:`alsaaudio` the period size is set directly, and it is - therefore important to understand the significance of this - number. If the period size is configured to for example 32, - each write should contain exactly 32 frames of sound data, and each - read will return either 32 frames of data or nothing at all. - -Once you understand these concepts, you will be ready to use the PCM API. Read -on. - - -******************** -Module documentation -******************** - +**************** :mod:`alsaaudio` -================ +**************** .. module:: alsaaudio :platform: Linux @@ -112,75 +34,67 @@ The :mod:`alsaaudio` module defines functions and classes for using ALSA. .. % should be enclosed in \var{...}. -.. function:: mixers([cardname]) +.. function:: cards() - List the available mixers. The optional *cardname* specifies which card - should be queried (this is only relevant if you have more than one sound - card). Omit to use the default sound card. + List the available cards. +.. function:: mixers([cardindex]) -.. class:: PCM([type], [mode], [cardname]) + List the available mixers. The optional *cardindex* specifies which card + should be queried. The default is 0. - This class is used to represent a PCM device (both playback and capture - devices). The arguments are: --- *type* - can be either PCM_CAPTURE or - PCM_PLAYBACK (default). --- *mode* - can be either PCM_NONBLOCK, - PCM_ASYNC, or PCM_NORMAL (the default). --- *cardname* - specifies - which card should be used (this is only relevant if you have more - than one sound card). Omit to use the default sound card +.. class:: PCM(type=PCM_PLAYBACK, mode=PCM_NORMAL, card='default') + This class is used to represent a PCM device (both for playback and + recording - capture). The arguments are: -.. class:: Mixer([control], [id], [cardname]) + * *type* - can be either ``PCM_CAPTURE`` or ``PCM_PLAYBACK`` (default). + * *mode* - can be either ``PCM_NONBLOCK``, or ``PCM_NORMAL`` (default). + * *card* - specifies the name of the card that should be used. - This class is used to access a specific ALSA mixer. The arguments are: --- - *control* - Name of the chosen mixed (default is Master). --- *id* - id of - mixer (default is 0) -- More explanation needed here --- *cardname* - specifies which card should be used (this is only relevant if you have more - than one sound card). Omit to use the default sound card. +.. class:: Mixer(control='Master', id=0, cardindex=0) + This class is used to access a specific ALSA mixer. The arguments + are: + + * *control* - Name of the chosen mixed (default is 'Master'). + * *id* - id of mixer -- More explanation needed here + * *cardindex* specifies which card should be used. .. exception:: ALSAAudioError Exception raised when an operation fails for a ALSA specific reason. The exception argument is a string describing the reason of the failure. - .. _pcm-objects: PCM Objects ----------- -The acronym PCM is short for Pulse Code Modulation and is the method used in -ALSA and many other places to handle playback and capture of sampled -sound data. - -PCM objects in :mod:`alsaaudio` are used to do exactly that, either -play sample based sound or capture sound from some input source -(probably a microphone). The PCM object constructor takes the +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_CAPTURE, mode=PCM_NORMAL, card='default') -.. class:: PCM([type], [mode], [cardname]) + *type* - can be either ``PCM_CAPTURE`` or ``PCM_PLAYBACK`` (default). - *type* - can be either PCM_CAPTURE or PCM_PLAYBACK (default). + *mode* - can be either ``PCM_NONBLOCK``, or ``PCM_NORMAL`` (the + default). In ``PCM_NONBLOCK`` mode, calls to :func:`read` will return + immediately independent of whether there is any actual data to + read. Similarly, calls to :func:`write` will return immediately without + actually writing anything to the playout buffer if the buffer is + full [#f1]_. - *mode* - can be either PCM_NONBLOCK, PCM_ASYNC, or PCM_NORMAL (the - default). In PCM_NONBLOCK mode, calls to read will return - immediately independent of wether there is any actual data to - read. Similarly, write calls will return immediately without - actually writing anything to the playout buffer if the buffer is full. + *card* - specifies which card should be used. This can be a string + like 'default' or a name that was returned from the :func:`cards` function. - In the current version of :mod:`alsaaudio` PCM_ASYNC is useless, - since it relies on a callback procedure, which can't be specified - through this API yet. + This will construct a PCM object with these default settings: - *cardname* - specifies which card should be used (this is only - relevant if you have more than one sound card). Omit to use the - default sound card. - - This will construct a PCM object with default settings: - - Sample format: PCM_FORMAT_S16_LE --- Rate: 8000 Hz --- Channels: 2 --- - Period size: 32 frames --- + * Sample format: ``PCM_FORMAT_S16_LE`` + * Rate: 44100 Hz + * Channels: 2 + * Period size: 32 frames PCM objects have the following methods: @@ -304,7 +218,7 @@ ugly clicking sounds will occur. Conversely, of too much data is written to the device, the write function will either block (PCM_NORMAL mode) or return zero (PCM_NONBLOCK mode). -If your program does nothing, but play sound, the easiest way is to put the +If your program does nothing but play sound, the best strategy is to put the device in PCM_NORMAL mode, and just write as much data to the device as possible. This strategy can also be achieved by using a separate thread with the sole task of playing out sound. @@ -330,7 +244,7 @@ Mixer Objects Mixer objects provides access to the ALSA mixer API. -.. class:: Mixer([control], [id], [cardname]) +.. class:: Mixer([control], [id], [cardindex]) *control* - specifies which control to manipulate using this mixer object. The list of available controls can be found with the @@ -339,9 +253,12 @@ Mixer objects provides access to the ALSA mixer API. *id* - the id of the mixer control. Default is 0 - *cardname* - specifies which card should be used (this is only - relevant if you have more than one sound card). Omit to use the - default sound card. + *cardindex* - specifies which card should be used[#f3]_. 0 is the + first sound card. Default is 0. + + For a list of available controls, you can also use ``amixer``:: + + amixer -c 1 Mixer objects have the following methods: @@ -498,7 +415,7 @@ Mixer objects have the following methods: This method will fail if the mixer has no capture switch capabilities. -**A Note on the ALSA Mixer API** +**A rant on the ALSA Mixer API** The ALSA mixer API is extremely complicated - and hardly documented at all. :mod:`alsaaudio` implements a much simplified way to access this API. In @@ -525,9 +442,56 @@ painful trial and error process. .. _pcm-example: -ALSA Examples -------------- +Examples +-------- -For now, the only examples available are the 'playbacktest.py' and the -'recordtest.py' programs included. This will change in a future version. +The following examples are provided: +* playwav.py +* recordtest.py +* playbacktest.py + +All examples take the commandline option '-c '. + +To determine a valid card name, use the commandline ALSA player:: + + $ aplay -L + +or:: + + $ python + + >>> import alsaaudio + >>> alsaaudio.cards() + +playwav.py +~~~~~~~~~~ + +``playwav.py`` plays a wav file. A sample wav file is +provided in the source distribution. + +To test PCM playback (on your default soundcard), do:: + + $ python playwav.py foo.wav + +recordtest.py and playbacktest.py +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +``recordtest.py`` and ``playbacktest.py`` will record and play a raw +sound file in CD quality. + +To test PCM recordings (on your default soundcard), do:: + + $ python recordtest.py + +Speak into the microphone, and interrupt the recording at any time +with ``Ctl-C``. + +Play back the recording with:: + + $ python playbacktest.py + +.. rubric:: Footnotes + +.. [#f1] ALSA also allows ``PCM_ASYNC``, but this is not supported yet. +.. [#f2] But :mod:`alsaaudio` will leave any name alone that has a ':' (colon) in it. +.. [#f3] This is inconsistent with the PCM objects, which use names, but it is consistent with aplay and amixer. diff --git a/doc/mixer-objects.html b/doc/mixer-objects.html deleted file mode 100644 index 3da7473..0000000 --- a/doc/mixer-objects.html +++ /dev/null @@ -1,407 +0,0 @@ - - - - - - - - - - - - - - -4.3 Mixer Objects - - -
-
- - - - - - - - - -
Up one LevelPyAlsaAudioContents
-
-Previous: - -Up: -4 alsaaudio -Next: - -
-
-
- - -

- -
-4.3 Mixer Objects -

- -

-Mixer objects provides access to the ALSA mixer API. - -

-

- -
class Mixer([control], [id], - [cardname])
-
- control - specifies which control to manipulate using this - mixer object. The list of available controls can be found with the - alsaaudio.mixers function. The default value is - 'Master' - other common controls include 'Master Mono', 'PCM', - 'Line', etc. - -

-id - the id of the mixer control. Default is 0 - -

-cardname - specifies which card should be used (this is only - relevant if you have more than one sound card). Omit to use the - default sound card -

- -

-Mixer objects have the following methods: - -

-

- -
cardname()
-
- Return the name of the sound card used by this Mixer object -
- -

-

- -
mixer()
-
- Return the name of the specific mixer controlled by this object, For - example 'Master' or 'PCM' -
- -

-

- -
mixerid()
-
- Return the ID of the ALSA mixer controlled by this object. -
- -

-

- -
switchcap()
-
- Returns a list of the switches which are defined by this specific - mixer. Possible values in this list are: - -

-

- - - - - - - - - - - - - - - - - - - - - -
SwitchDescription
'Mute'This mixer can be muted
'Joined Mute'This mixer can mute all channels at the same time
'Playback Mute'This mixer can mute the playback output
'Joined Playback Mute'Mute playback for all channels at the same time
'Capture Mute'Mute sound capture
'Joined Capture Mute'Mute sound capture for all channels at a time
'Capture Exclusive'Not quite sure what this is
- -

-To manipulate these swithes use the setrec or -setmute methods -

- -

-

- -
volumecap()
-
- Returns a list of the volume control capabilities of this mixer. - Possible values in the list are: - -

-

- - - - - - - - - - - - - - - - - - - -
CapabilityDescription
'Volume'This mixer can control volume
'Joined Volume'This mixer can control volume for all channels at - the same time
'Playback Volume'This mixer can manipulate the playback volume
'Joined Playback Volume'Manipulate playback volumne for all - channels at the same time
'Capture Volume'Manipulate sound capture volume
'Joined Capture Volume'Manipulate sound capture volume for all - channels at a time
- -

-

- -

-

- -
getenum()
-
- For enumerated controls, return the currently selected item and - the list of items available. - -

-Returns a tuple (string, list of strings). - -

-For example, my soundcard has a Mixer called Mono Output Select. - Using amixer, I get: - -

-

-$ amixer get "Mono Output Select"
-Simple mixer control 'Mono Output Select',0
-  Capabilities: enum
-  Items: 'Mix' 'Mic'
-  Item0: 'Mix'
-
- -

-Using alsaaudio, one could do: -

->>> import alsaaudio
->>> m = alsaaudio.Mixer('Mono Output Select')
->>> m.getenum()
-('Mix', ['Mix', 'Mic'])
-
- -

-This method will return an empty tuple if the mixer is not an - enumerated control. -

- -

-

- -
getmute()
-
- 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. -

- -

-

- -
getrange([direction])
-
- Return the volume range of the ALSA mixer controlled by this object. - -

-The optional direction argument can be either 'playback' or - 'capture', which is relevant if the mixer can control both playback - and capture volume. The default value is 'playback' if the mixer - has this capability, otherwise 'capture' - -

-

- -

-

- -
getrec()
-
- 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. -

- -

-

- -
getvolume([direction])
-
- Returns a list with the current volume settings for each channel. - The list elements are integer percentages. - -

-The optional direction argument can be either 'playback' or - 'capture', which is relevant if the mixer can control both playback - and capture volume. The default value is 'playback' if the mixer has - this capability, otherwise 'capture' - -

-

- -

-

- -
setvolume(volume,[channel], - [direction])
-
- -

-Change the current volume settings for this mixer. The volume - argument controls the new volume setting as an integer percentage. - -

-If the optional argument channel is present, the volume is set - only for this channel. This assumes that the mixer can control the - volume for the channels independently. - -

-The optional direction argument can be either 'playback' or - 'capture' is relevant if the mixer has independent playback and - capture volume capabilities, and controls which of the volumes if - changed. The default is 'playback' if the mixer has this capability, - otherwise 'capture'. -

- -

-

- -
setmute(mute, [channel])
-
- Sets the mute flag to a new value. The mute argument is either - 0 for not muted, or 1 for muted. - -

-The optional channel argument controls which channel is muted. - The default is to set the mute flag for all channels. - -

-This method will fail if the mixer has no playback mute capabilities -

- -

-

- -
setrec(capture,[channel])
-
- Sets the capture mute flag to a new value. The capture - argument is either 0 for no capture, or 1 for capture. - -

-The optional channel argument controls which channel is - changed. The default is to set the capture flag for all channels. - -

-This method will fail if the mixer has no capture switch - capabilities. -

- -

-A Note on the ALSA Mixer API - -

-The ALSA mixer API is extremely complicated - and hardly documented at -all. alsaaudio implements a much simplified way to access -this API. In designing the API I've had to make some choices which may -limit what can and cannot be controlled through the API. However, If I -had chosen to implement the full API, I would have reexposed the -horrible complexity/documentation ratio of the underlying API. At -least the alsaaudio API is easy to understand and use. - -

-If my design choises prevents you from doing something that the -underlying API would have allowed, please let me know, so I can -incorporate these need into future versions. - -

-If the current state of affairs annoy you, the best you can do is to -write a HOWTO on the API and make this available on the net. Until -somebody does this, the availability of ALSA mixer capable devices -will stay quite limited. - -

-Unfortunately, I'm not able to create such a HOWTO myself, since I -only understand half of the API, and that which I do understand has -come from a painful trial and error process. - -

- -

-
-

- - - - - - - - - -
Up one LevelPyAlsaAudioContents
-
-Previous: - -Up: -4 alsaaudio -Next: - -
-
-
-Release 0.4. -
- - - - diff --git a/doc/module-alsaaudio.html b/doc/module-alsaaudio.html deleted file mode 100644 index e96d838..0000000 --- a/doc/module-alsaaudio.html +++ /dev/null @@ -1,170 +0,0 @@ - - - - - - - - - - - - - -4 alsaaudio - - -
-
- - - - - - - - - -
Up one LevelPyAlsaAudioContents
-
-Previous: - -Up: -Contents -Next: - -
-
-
- - -

-4 alsaaudio -

- -

- -

- -

Availability: Linux.

- -

- -

- -

-The alsaaudio module defines functions and classes for using -ALSA. - -

-

- -
mixers([cardname])
-
-List the available mixers. The optional cardname specifies which -card should be queried (this is only relevant if you have more than one -sound card). Omit to use the default sound card. -
- -

-

- -
class PCM([type], [mode], [cardname])
-
- This class is used to represent a PCM device (both playback and - capture devices). - The arguments are: -
type - can be either PCM_CAPTURE or PCM_PLAYBACK (default). -
mode - can be either PCM_NONBLOCK, PCM_ASYNC, or PCM_NORMAL (the default). -
cardname - specifies which card should be used (this is only - relevant if you have more than one sound card). Omit to use the - default sound card -
- -

-

- -
class Mixer([control], [id], [cardname])
-
-This class is used to access a specific ALSA mixer. -The arguments are: -
control - Name of the chosen mixed (default is Master). -
id - id of mixer (default is 0) - More explanation needed here -
cardname specifies which card should be used (this is only relevant -if you have more than one sound card). Omit to use the default sound card -
- -

-

exception ALSAAudioError
-
- Exception raised when an operation fails for a ALSA specific reason. - The exception argument is a string describing the reason of the - failure. -
- -

- -


-
- -Subsections - - - -
- -
-
-

- - - - - - - - - -
Up one LevelPyAlsaAudioContents
-
-Previous: - -Up: -Contents -Next: - -
-
-
-Release 0.4. -
- - - - diff --git a/doc/node3.html b/doc/node3.html deleted file mode 100644 index 22c3c01..0000000 --- a/doc/node3.html +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - - - - - - - - - -1 What is ALSA - - -
-
- - - - - - - - - -
Up one LevelPyAlsaAudioContents
-
-Previous: - -Up: -Contents -Next: - -
-
-
- - -

-1 What is ALSA -

- -

-The Advanced Linux Sound Architecture (ALSA) provides audio and MIDI -functionality to the Linux operating system. - -

-Logically ALSA consists of these components: - -

    -
  • A set of kernel drivers. -
    -These drivers are responsible for handling the physical sound - hardware from within the Linux kernel, and have been the standard - sound implementation in Linux since kernel version 2.5 -
    • -
  • A kernel level API for manipulating the ALSA devices. -
    • -
  • A user-space C library for simplified access to the sound hardware - from userspace applications. This library is called libasound - and is required by all ALSA capable applications. -
    • -
- -

-More information about ALSA may be found on the project homepage -http://www.alsa-project.org -

- -

-
-

- - - - - - - - - -
Up one LevelPyAlsaAudioContents
-
-Previous: - -Up: -Contents -Next: - -
-
-
-Release 0.4. -
- - - - diff --git a/doc/node4.html b/doc/node4.html deleted file mode 100644 index 178e031..0000000 --- a/doc/node4.html +++ /dev/null @@ -1,119 +0,0 @@ - - - - - - - - - - - - - - -2 ALSA and Python - - -
-
- - - - - - - - - -
Up one LevelPyAlsaAudioContents
-
-Previous: - -Up: -Contents -Next: - -
-
-
- - -

-2 ALSA and Python -

- -

-The older Linux sound API (OSS) which is now deprecated is well -supported from the standard Python library, through the ossaudiodev -module. No native ALSA support exists in the standard library (yet). - -

-There are a few other ``ALSA for Python'' projects available, -including at least two different projects called pyAlsa. Neither of -these seem to be under active development at the time - and neither -are very feature complete. - -

-I wrote PyAlsaAudio to fill this gap. My long term goal is to have the -module included in the standard Python library, but that is probably a -while off yet. - -

-PyAlsaAudio hass full support for sound capture, playback of sound, as -well as the ALSA Mixer API. - -

-MIDI support is not available, and since I don't own any MIDI -hardware, it's difficult for me to implement it. Volunteers to work on -this would be greatly appreciated - -

-
-

- - - - - - - - - -
Up one LevelPyAlsaAudioContents
-
-Previous: - -Up: -Contents -Next: - -
-
-
-Release 0.4. -
- - - - diff --git a/doc/node5.html b/doc/node5.html deleted file mode 100644 index 49507bb..0000000 --- a/doc/node5.html +++ /dev/null @@ -1,123 +0,0 @@ - - - - - - - - - - - - - - -3 Installation - - -
-
- - - - - - - - - -
Up one LevelPyAlsaAudioContents
-
-Previous: - -Up: -Contents -Next: - -
-
-
- - -

-3 Installation -

- -

-Note: the wrappers link with the alsasound library (from the alsa-lib -package) and need the ALSA headers for compilation. Verify that you -have /usr/lib/libasound.so and /usr/include/alsa (or -similar paths) before building. - -

-On Debian (and probably Ubuntu), make sure you have libasound2-dev installed. - -

-Naturally you also need to use a kernel with proper ALSA support. This -is the default in Linux kernel 2.6 and later. If you are using kernel -version 2.4 you may need to install the ALSA patches yourself - -although most distributions ship with ALSA kernels. - -

-To install, execute the following: -

-$ python setup.py build
-
- -

-And then as root: -

-# python setup.py install
-
- -

- -

-
-

- - - - - - - - - -
Up one LevelPyAlsaAudioContents
-
-Previous: - -Up: -Contents -Next: - -
-
-
-Release 0.4. -
- - - - diff --git a/doc/node7.html b/doc/node7.html deleted file mode 100644 index 0dc008a..0000000 --- a/doc/node7.html +++ /dev/null @@ -1,184 +0,0 @@ - - - - - - - - - - - - - - -4.1 PCM Terminology and Concepts - - -
-
- - - - - - - - - -
Up one LevelPyAlsaAudioContents
-
-Previous: - -Up: -4 alsaaudio -Next: - -
-
-
- - -

-4.1 PCM Terminology and Concepts -

- -

-In order to use PCM devices it is useful to be familiar with some concepts and -terminology. - -

-

-
Sample
-
PCM audio, whether it is input or output, consists at - the lowest level of a number of single samples. A sample represents - the sound in a single channel in a brief interval. If more than one - channel is in use, more than one sample is required for each - interval to describe the sound. Samples can be of many different - sizes, ranging from 8 bit to 64 bit presition. The specific format - of each sample can also vary - they can be big endian byte order, - little endian byte order, or even floats. - -

-

-
Frame
-
A frame consists of exactly one sample per channel. If - there is only one channel (Mono sound) a frame is simply a single - sample. If the sound is stereo, each frame consists of two samples, - etc. - -

-

-
Frame size
-
This is the size in bytes of each frame. This can - vary a lot: if each sample is 8 bits, and we're handling mono sound, - the frame size is one byte. Similarly in 6 channel audio with 64 bit - floating point samples, the frame size is 48 bytes - -

-

-
Rate
-
PCM sound consists of a flow of sound frames. The sound - rate controls how often the current frame is replaced. For example, - a rate of 8000 Hz means that a new frame is played or captured 8000 - times per second. - -

-

-
Data rate
-
This is the number of bytes, which must be recorded - or provided per second at a certain frame size and rate. - -

-8000 Hz mono sound with 8 bit (1 byte) samples has a data rate of - 8000 * 1 * 1 = 8 kb/s - -

-At the other end of the scale, 96000 Hz, 6 channel sound with 64 bit - (8 bytes) samples has a data rate of 96000 * 6 * 8 = 4608 kb/s - (almost 5 Mb sound data per second) - -

-

-
Period
-
When the hardware processes data this is done in chunks - of frames. The time interval between each processing (A/D or D/A - conversion) is known as the period. The size of the period has - direct implication on the latency of the sound input or output. For - low-latency the period size should be very small, while low CPU - resource usage would usually demand larger period sizes. With ALSA, - the CPU utilization is not impacted much by the period size, since - the kernel layer buffers multiple periods internally, so each period - generates an interrupt and a memory copy, but userspace can be - slower and read or write multiple periods at the same time. - -

-

-
Period size
-
This is the size of each period in Hz. Not - bytes, but Hz!. In alsaaudio the period size is set - directly, and it is therefore important to understand the - significance of this number. If the period size is configured to for - example 32, each write should contain exactly 32 frames of sound - data, and each read will return either 32 frames of data or nothing - at all. - -

-

-
- -

-Once you understand these concepts, you will be ready to use the PCM -API. Read on. - -

- -

-
-

- - - - - - - - - -
Up one LevelPyAlsaAudioContents
-
-Previous: - -Up: -4 alsaaudio -Next: - -
-
-
-Release 0.4. -
- - - - diff --git a/doc/pcm-example.html b/doc/pcm-example.html deleted file mode 100644 index 917f370..0000000 --- a/doc/pcm-example.html +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - - - - - - - - -4.4 ALSA Examples - - -
-
- - - - - - - - - -
Up one LevelPyAlsaAudioContents
-
-Previous: - -Up: -4 alsaaudio -Next: - -
-
-
- - -

-
-4.4 ALSA Examples -

- -

-For now, the only examples available are the 'playbacktest.py' and the -'recordtest.py' programs included. This will change in a future -version. - -

- -

-
-

- - - - - - - - - -
Up one LevelPyAlsaAudioContents
-
-Previous: - -Up: -4 alsaaudio -Next: - -
-
-
-Release 0.4. -
- - - - diff --git a/doc/pcm-objects.html b/doc/pcm-objects.html deleted file mode 100644 index bd53687..0000000 --- a/doc/pcm-objects.html +++ /dev/null @@ -1,379 +0,0 @@ - - - - - - - - - - - - - - -4.2 PCM Objects - - -
-
- - - - - - - - - -
Up one LevelPyAlsaAudioContents
-
-Previous: - -Up: -4 alsaaudio -Next: - -
-
-
- - -

- -
-4.2 PCM Objects -

- -

-The acronym PCM is short for Pulse Code Modulation and is the method -used in ALSA and many other places to handle playback and capture of -sampled sound data. - -

-PCM objects in alsaaudio are used to do exactly that, either -play sample based sound or capture sound from some input source -(probably a microphone). The PCM object constructor takes the following -arguments: - -

-

- -
class PCM([type], [mode], [cardname])
-
- -

-type - can be either PCM_CAPTURE or PCM_PLAYBACK (default). - -

-mode - can be either PCM_NONBLOCK, PCM_ASYNC, or PCM_NORMAL (the -default). In PCM_NONBLOCK mode, calls to read will return immediately -independent of wether there is any actual data to read. Similarly, -write calls will return immediately without actually writing anything -to the playout buffer if the buffer is full. - -

-In the current version of alsaaudio PCM_ASYNC is useless, -since it relies on a callback procedure, which can't be specified through -this API yet. - -

-cardname - specifies which card should be used (this is only -relevant if you have more than one sound card). Omit to use the -default sound card - -

-This will construct a PCM object with default settings: - -

-Sample format: PCM_FORMAT_S16_LE -
-Rate: 8000 Hz -
-Channels: 2 -
-Period size: 32 frames -

- -

-PCM objects have the following methods: - -

-

- -
pcmtype()
-
- Returns the type of PCM object. Either PCM_CAPTURE or PCM_PLAYBACK. -
- -

-

- -
pcmmode()
-
- Return the mode of the PCM object. One of PCM_NONBLOCK, PCM_ASYNC, - or PCM_NORMAL -
- -

-

- -
cardname()
-
- Return the name of the sound card used by this PCM object. -
- -

-

- -
setchannels(nchannels)
-
- Used to set the number of capture or playback channels. Common - values are: 1 = mono, 2 = stereo, and 6 = full 6 channel audio. Few - sound cards support more than 2 channels -
- -

-

- -
setrate(rate)
-
- Set the sample rate in Hz for the device. Typical values are 8000 - (poor sound), 16000, 44100 (cd quality), and 96000 -
- -

-

- -
setformat(format)
-
- The sound format of the device. Sound format controls how the PCM - device interpret data for playback, and how data is encoded in - captures. - -

-The following formats are provided by ALSA: -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FormatDescription
PCM_FORMAT_S8Signed 8 bit samples for each channel
PCM_FORMAT_U8Signed 8 bit samples for each channel
PCM_FORMAT_S16_LESigned 16 bit samples for each channel - (Little Endian byte order)
PCM_FORMAT_S16_BESigned 16 - bit samples for each channel (Big Endian byte order)
PCM_FORMAT_U16_LEUnsigned 16 bit samples for each channel - (Little Endian byte order)
PCM_FORMAT_U16_BEUnsigned 16 - bit samples for each channel (Big Endian byte order)
PCM_FORMAT_S24_LESigned 24 bit samples for each channel - (Little Endian byte order)
PCM_FORMAT_S24_BESigned 24 - bit samples for each channel (Big Endian byte order)
PCM_FORMAT_U24_LEUnsigned 24 bit samples for each channel - (Little Endian byte order)
PCM_FORMAT_U24_BEUnsigned 24 - bit samples for each channel (Big Endian byte order)
PCM_FORMAT_S32_LESigned 32 bit samples for each channel - (Little Endian byte order)
PCM_FORMAT_S32_BESigned 32 - bit samples for each channel (Big Endian byte order)
PCM_FORMAT_U32_LEUnsigned 32 bit samples for each channel - (Little Endian byte order)
PCM_FORMAT_U32_BEUnsigned 32 - bit samples for each channel (Big Endian byte order)
PCM_FORMAT_FLOAT_LE32 bit samples encoded as float. - (Little Endian byte order)
PCM_FORMAT_FLOAT_BE32 bit - samples encoded as float (Big Endian byte order)
PCM_FORMAT_FLOAT64_LE64 bit samples encoded as float. - (Little Endian byte order)
PCM_FORMAT_FLOAT64_BE64 bit - samples encoded as float. (Big Endian byte order)
PCM_FORMAT_MU_LAWA logarithmic encoding (used by Sun .au - files)
PCM_FORMAT_A_LAWAnother logarithmic encoding
PCM_FORMAT_IMA_ADPCMa 4:1 compressed format defined by the - Interactive Multimedia Association
PCM_FORMAT_MPEGMPEG - encoded audio?
PCM_FORMAT_GSM9600 bits/s constant rate encoding for speech
- -

-

- -

-

- -
setperiodsize(period)
-
- Sets the actual period size in frames. Each write should consist of - exactly this number of frames, and each read will return this number - of frames (unless the device is in PCM_NONBLOCK mode, in which case - it may return nothing at all) -
- -

-

- -
read()
-
- In PCM_NORMAL mode, this function blocks until a full period is - available, and then returns a tuple (length,data) where - length is the number of frames of captured data, and - data is the captured sound frames as a string. The length of - the returned data will be periodsize*framesize bytes. - -

-In PCM_NONBLOCK mode, the call will not block, but will return - (0,'') if no new period has become available since the last - call to read. -

- -

-

- -
write(data)
-
- 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 period. If less than 'period size' frames are provided, the - actual playout will not happen until more data is written. - -

-If the device is not in PCM_NONBLOCK mode, this call will block if - the kernel buffer is full, and until enough sound has been played to - allow the sound data to be buffered. The call always returns the - size of the data provided - -

-In PCM_NONBLOCK mode, the call will return immediately, with a - return value of zero, if the buffer is full. In this case, the data - should be written at a later time. -

- -

-

- -
pause([enable=1])
-
- If enable is 1, playback or capture is paused. If enable is 0, - playback/capture is resumed. -
- -

-A few hints on using PCM devices for playback - -

-The most common reason for problems with playback of PCM audio, is -that the people don't properly understand that writes to PCM devices -must match exactly 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 -written to the device, the write function will either block -(PCM_NORMAL mode) or return zero (PCM_NONBLOCK mode). - -

-If your program does nothing, but play sound, the easiest way is to -put the device in PCM_NORMAL mode, and just write as much data to the -device as possible. This strategy can also be achieved by using a -separate thread with the sole task of playing out sound. - -

-In GUI programs, however, it may be a better strategy to setup the -device, preload the buffer with a few periods by calling write a -couple of times, and then use some timer method to write one period -size of data to the device every period. The purpose of the preloading -is to avoid underrun clicks if the used timer doesn't expire exactly -on time. - -

-Also note, that most timer APIs that you can find for Python will -cummulate time delays: If you set the timer to expire after 1/10'th of -a second, the actual timeout will happen slightly later, which will -accumulate to quite a lot after a few seconds. Hint: use time.time() -to check how much time has really passed, and add extra writes as -nessecary. - -

- -

-
-

- - - - - - - - - -
Up one LevelPyAlsaAudioContents
-
-Previous: - -Up: -4 alsaaudio -Next: - -
-
-
-Release 0.4. -
- - - - diff --git a/doc/pyalsaaudio.html b/doc/pyalsaaudio.html deleted file mode 100644 index bb14cee..0000000 --- a/doc/pyalsaaudio.html +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - - - - - - -PyAlsaAudio - - -
-
- - - - - - - - - -
Previous PageUp one LevelPyAlsaAudioContents
-
-Next: - -
-
-
- - -
-
-

PyAlsaAudio

-

Casper Wilstrup

-

cwi@aves.dk

-

-
-
- -

- -


-
- - - - - -
- -
-
-

- - - - - - - - - -
Previous PageUp one LevelPyAlsaAudioContents
-
-Next: - -
-
-
-Release 0.4. -
- - - - diff --git a/doc/pyalsaaudio.rst b/doc/pyalsaaudio.rst index 0cda8e0..ea584c8 100644 --- a/doc/pyalsaaudio.rst +++ b/doc/pyalsaaudio.rst @@ -1,6 +1,6 @@ -*************** - PyAlsaAudio -*************** +************ +Introduction +************ :Author: Casper Wilstrup :Author: Lars Immisch @@ -91,7 +91,7 @@ Note: the wrappers link with the alsasound library (from the alsa-lib package) and need the ALSA headers for compilation. Verify that you have /usr/lib/libasound.so and /usr/include/alsa (or similar paths) before building. -On Debian (and probably Ubuntu), make sure you have libasound2-dev installed. +*On Debian (and probably Ubuntu), install libasound2-dev.* Naturally you also need to use a kernel with proper ALSA support. This is the default in Linux kernel 2.6 and later. If you are using kernel version 2.4 you @@ -105,3 +105,30 @@ To install, execute the following: --- :: And then as root: --- :: # python setup.py install + +******* +Testing +******* + +First of all, run:: + + $ python test.py + +This is a small test suite that mostly performs consistency tests. If +it fails, please file a `bug report +`_. + +To test PCM recordings (on your default soundcard), verify your +microphone works, then do:: + + $ python recordtest.py + +Speak into the microphone, and interrupt the recording at any time +with ``Ctl-C``. + +Play back the recording with:: + + $ python playbacktest.py + + + diff --git a/doc/terminology.rst b/doc/terminology.rst new file mode 100644 index 0000000..52132b1 --- /dev/null +++ b/doc/terminology.rst @@ -0,0 +1,75 @@ +**************************** +PCM Terminology and Concepts +**************************** + +In order to use PCM devices it is useful to be familiar with some concepts and +terminology. + +Sample + PCM audio, whether it is input or output, consists of *samples*. + A single sample represents the amplitude of one channel of sound + at a certain point in time. A lot of individual samples are + necessary to represent actual sound; for CD audio, 44100 samples + are taken every second. + + Samples can be of many different sizes, ranging from 8 bit to 64 + bit precision. The specific format of each sample can also vary - + they can be big endian byte integers, little endian byte integers, or + floating point numbers. + + Musically, the sample size determines the dynamic range. The + dynamic range is the difference between the quietest and the + loudest signal that can be resproduced. + +Frame + A frame consists of exactly one sample per channel. If there is only one + channel (Mono sound) a frame is simply a single sample. If the sound is + stereo, each frame consists of two samples, etc. + +Frame size + This is the size in bytes of each frame. This can vary a lot: if each sample + is 8 bits, and we're handling mono sound, the frame size is one byte. + Similarly in 6 channel audio with 64 bit floating point samples, the frame + size is 48 bytes + +Rate + PCM sound consists of a flow of sound frames. The sound rate controls how + often the current frame is replaced. For example, a rate of 8000 Hz + means that a new frame is played or captured 8000 times per second. + +Data rate + This is the number of bytes, which must be recorded or provided per + second at a certain frame size and rate. + + 8000 Hz mono sound with 8 bit (1 byte) samples has a data rate of + 8000 \* 1 \* 1 = 8 kb/s or 64kbit/s. This is typically used for telephony. + + At the other end of the scale, 96000 Hz, 6 channel sound with 64 + bit (8 bytes) samples has a data rate of 96000 \* 6 \* 8 = 4608 + kb/s (almost 5 Mb sound data per second) + +Period + When the hardware processes data this is done in chunks of frames. The time + interval between each processing (A/D or D/A conversion) is known + as the period. + The size of the period has direct implication on the latency of the + sound input or output. For low-latency the period size should be + very small, while low CPU resource usage would usually demand + larger period sizes. With ALSA, the CPU utilization is not impacted + much by the period size, since the kernel layer buffers multiple + periods internally, so each period generates an interrupt and a + memory copy, but userspace can be slower and read or write multiple + periods at the same time. + +Period size + This is the size of each period in Hz. *Not bytes, but Hz!.* In + :mod:`alsaaudio` the period size is set directly, and it is + therefore important to understand the significance of this + number. If the period size is configured to for example 32, + each write should contain exactly 32 frames of sound data, and each + read will return either 32 frames of data or nothing at all. + +Once you understand these concepts, you will be ready to use the PCM API. Read +on. + +