linuxaudiodev.c 13.8 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
/* Hey Emacs, this is -*-C-*- 
 ******************************************************************************
 * linuxaudiodev.c -- Linux audio device for python.
 * 
 * Author          : Peter Bosch
 * Created On      : Thu Mar  2 21:10:33 2000
 * Status          : Unknown, Use with caution!
 * 
 * Unless other notices are present in any part of this file
 * explicitly claiming copyrights for other people and/or 
 * organizations, the contents of this file is fully copyright 
 * (C) 2000 Peter Bosch, all rights reserved.
 ******************************************************************************
 */

#include "Python.h"
#include "structmember.h"

#ifdef HAVE_FCNTL_H
#include <fcntl.h>
Jeremy Hylton's avatar
Jeremy Hylton committed
21 22 23
#else
#define O_RDONLY 00
#define O_WRONLY 01
24 25
#endif

Jeremy Hylton's avatar
Jeremy Hylton committed
26

27
#include <sys/ioctl.h>
28
#if defined(linux)
29 30 31 32
#include <linux/soundcard.h>

typedef unsigned long uint32_t;

33 34 35 36 37 38 39 40 41
#elif defined(__FreeBSD__)
#include <machine/soundcard.h>

#ifndef SNDCTL_DSP_CHANNELS
#define SNDCTL_DSP_CHANNELS SOUND_PCM_WRITE_CHANNELS
#endif

#endif

42
typedef struct {
43 44
    PyObject_HEAD;
    int		x_fd;		/* The open file */
Jeremy Hylton's avatar
Jeremy Hylton committed
45
    int         x_mode;           /* file mode */
46 47
    int		x_icount;	/* Input count */
    int		x_ocount;	/* Output count */
Jeremy Hylton's avatar
Jeremy Hylton committed
48
    uint32_t	x_afmts;	/* Audio formats supported by hardware*/
49 50
} lad_t;

Jeremy Hylton's avatar
Jeremy Hylton committed
51 52 53 54
/* XXX several format defined in soundcard.h are not supported,
   including _NE (native endian) options and S32 options
*/

55
static struct {
56 57
    int		a_bps;
    uint32_t	a_fmt;
Jeremy Hylton's avatar
Jeremy Hylton committed
58
    char       *a_name;
59
} audio_types[] = {
60 61 62 63 64 65 66 67
    {  8, 	AFMT_MU_LAW, "logarithmic mu-law 8-bit audio" },
    {  8, 	AFMT_A_LAW,  "logarithmic A-law 8-bit audio" },
    {  8,	AFMT_U8,     "linear unsigned 8-bit audio" },
    {  8, 	AFMT_S8,     "linear signed 8-bit audio" },
    { 16, 	AFMT_U16_BE, "linear unsigned 16-bit big-endian audio" },
    { 16, 	AFMT_U16_LE, "linear unsigned 16-bit little-endian audio" },
    { 16, 	AFMT_S16_BE, "linear signed 16-bit big-endian audio" },
    { 16, 	AFMT_S16_LE, "linear signed 16-bit little-endian audio" },
68
    { 16, 	AFMT_S16_NE, "linear signed 16-bit native-endian audio" },
69 70
};

Jeremy Hylton's avatar
Jeremy Hylton committed
71
static int n_audio_types = sizeof(audio_types) / sizeof(audio_types[0]);
72

73
static PyTypeObject Ladtype;
74 75 76 77 78 79

static PyObject *LinuxAudioError;

static lad_t *
newladobject(PyObject *arg)
{
80 81
    lad_t *xp;
    int fd, afmts, imode;
82 83 84 85 86 87 88 89 90 91 92 93 94 95
    char *basedev = NULL;
    char *mode = NULL;

    /* Two ways to call linuxaudiodev.open():
         open(device, mode) (for consistency with builtin open())
         open(mode)         (for backwards compatibility)
       because the *first* argument is optional, parsing args is
       a wee bit tricky. */
    if (!PyArg_ParseTuple(arg, "s|s:open", &basedev, &mode))
       return NULL;
    if (mode == NULL) {                 /* only one arg supplied */
       mode = basedev;
       basedev = NULL;
    }
96 97

    if (strcmp(mode, "r") == 0)
Jeremy Hylton's avatar
Jeremy Hylton committed
98
        imode = O_RDONLY;
99
    else if (strcmp(mode, "w") == 0)
Jeremy Hylton's avatar
Jeremy Hylton committed
100
        imode = O_WRONLY;
101
    else {
102
        PyErr_SetString(LinuxAudioError, "mode should be 'r' or 'w'");
103 104 105 106
        return NULL;
    }

    /* Open the correct device.  The base device name comes from the
Jeremy Hylton's avatar
Jeremy Hylton committed
107
     * AUDIODEV environment variable first, then /dev/dsp.  The
108
     * control device tacks "ctl" onto the base device name.
Jeremy Hylton's avatar
Jeremy Hylton committed
109 110 111 112
     * 
     * Note that the only difference between /dev/audio and /dev/dsp
     * is that the former uses logarithmic mu-law encoding and the
     * latter uses 8-bit unsigned encoding.
113
     */
Jeremy Hylton's avatar
Jeremy Hylton committed
114

115 116 117 118 119
    if (basedev == NULL) {              /* called with one arg */
       basedev = getenv("AUDIODEV");
       if (basedev == NULL)             /* $AUDIODEV not set */
          basedev = "/dev/dsp";
    }
120

Jeremy Hylton's avatar
Jeremy Hylton committed
121
    if ((fd = open(basedev, imode)) == -1) {
122 123 124
        PyErr_SetFromErrnoWithFilename(LinuxAudioError, basedev);
        return NULL;
    }
Jeremy Hylton's avatar
Jeremy Hylton committed
125
    if (imode == O_WRONLY && ioctl(fd, SNDCTL_DSP_NONBLOCK, NULL) == -1) {
126 127 128
        PyErr_SetFromErrnoWithFilename(LinuxAudioError, basedev);
        return NULL;
    }
Jeremy Hylton's avatar
Jeremy Hylton committed
129
    if (ioctl(fd, SNDCTL_DSP_GETFMTS, &afmts) == -1) {
130 131
        PyErr_SetFromErrnoWithFilename(LinuxAudioError, basedev);
        return NULL;
132
    }
133 134 135 136 137
    /* Create and initialize the object */
    if ((xp = PyObject_New(lad_t, &Ladtype)) == NULL) {
        close(fd);
        return NULL;
    }
Jeremy Hylton's avatar
Jeremy Hylton committed
138 139
    xp->x_fd = fd;
    xp->x_mode = imode;
140 141 142
    xp->x_icount = xp->x_ocount = 0;
    xp->x_afmts  = afmts;
    return xp;
143 144 145 146 147
}

static void
lad_dealloc(lad_t *xp)
{
148 149 150
    /* if already closed, don't reclose it */
    if (xp->x_fd != -1)
	close(xp->x_fd);
151
    PyObject_Del(xp);
152 153 154 155 156
}

static PyObject *
lad_read(lad_t *self, PyObject *args)
{
157 158 159
    int size, count;
    char *cp;
    PyObject *rv;
160
	
161 162 163 164 165
    if (!PyArg_ParseTuple(args, "i:read", &size))
        return NULL;
    rv = PyString_FromStringAndSize(NULL, size);
    if (rv == NULL)
        return NULL;
Jeremy Hylton's avatar
Jeremy Hylton committed
166
    cp = PyString_AS_STRING(rv);
167 168 169 170 171 172
    if ((count = read(self->x_fd, cp, size)) < 0) {
        PyErr_SetFromErrno(LinuxAudioError);
        Py_DECREF(rv);
        return NULL;
    }
    self->x_icount += count;
173
    _PyString_Resize(&rv, count);
174
    return rv;
175 176 177 178 179
}

static PyObject *
lad_write(lad_t *self, PyObject *args)
{
180 181
    char *cp;
    int rv, size;
182 183 184 185
    fd_set write_set_fds;
    struct timeval tv;
    int select_retval;
    
Jeremy Hylton's avatar
Jeremy Hylton committed
186 187
    if (!PyArg_ParseTuple(args, "s#:write", &cp, &size)) 
	return NULL;
188

189 190 191 192 193 194
    /* use select to wait for audio device to be available */
    FD_ZERO(&write_set_fds);
    FD_SET(self->x_fd, &write_set_fds);
    tv.tv_sec = 4; /* timeout values */
    tv.tv_usec = 0; 

195
    while (size > 0) {
196 197 198
      select_retval = select(self->x_fd+1, NULL, &write_set_fds, NULL, &tv);
      tv.tv_sec = 1; tv.tv_usec = 0; /* willing to wait this long next time*/
      if (select_retval) {
Jeremy Hylton's avatar
Jeremy Hylton committed
199
        if ((rv = write(self->x_fd, cp, size)) == -1) {
200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215
	  if (errno != EAGAIN) {
	    PyErr_SetFromErrno(LinuxAudioError);
	    return NULL;
	  } else {
	    errno = 0; /* EAGAIN: buffer is full, try again */
	  }
        } else {
	  self->x_ocount += rv;
	  size -= rv;
	  cp += rv;
	}
      } else {
	/* printf("Not able to write to linux audio device within %ld seconds\n", tv.tv_sec); */
	PyErr_SetFromErrno(LinuxAudioError);
	return NULL;
      }
216
    }
217 218
    Py_INCREF(Py_None);
    return Py_None;
219 220 221 222 223
}

static PyObject *
lad_close(lad_t *self, PyObject *args)
{
Jeremy Hylton's avatar
Jeremy Hylton committed
224 225 226
    if (!PyArg_ParseTuple(args, ":close"))
	return NULL;

227 228 229 230 231 232
    if (self->x_fd >= 0) {
        close(self->x_fd);
        self->x_fd = -1;
    }
    Py_INCREF(Py_None);
    return Py_None;
233 234 235 236 237
}

static PyObject *
lad_fileno(lad_t *self, PyObject *args)
{
Jeremy Hylton's avatar
Jeremy Hylton committed
238 239
    if (!PyArg_ParseTuple(args, ":fileno")) 
	return NULL;
240
    return PyInt_FromLong(self->x_fd);
241 242 243 244 245
}

static PyObject *
lad_setparameters(lad_t *self, PyObject *args)
{
Jeremy Hylton's avatar
Jeremy Hylton committed
246
    int rate, ssize, nchannels, n, fmt, emulate=0;
247

Jeremy Hylton's avatar
Jeremy Hylton committed
248 249
    if (!PyArg_ParseTuple(args, "iiii|i:setparameters",
                          &rate, &ssize, &nchannels, &fmt, &emulate))
250
        return NULL;
251
  
Jeremy Hylton's avatar
Jeremy Hylton committed
252 253 254 255
    if (rate < 0) {
	PyErr_Format(PyExc_ValueError, "expected rate >= 0, not %d",
		     rate); 
	return NULL;
256
    }
Jeremy Hylton's avatar
Jeremy Hylton committed
257 258 259 260 261 262 263 264 265
    if (ssize < 0) {
	PyErr_Format(PyExc_ValueError, "expected sample size >= 0, not %d",
		     ssize);
	return NULL;
    }
    if (nchannels != 1 && nchannels != 2) {
	PyErr_Format(PyExc_ValueError, "nchannels must be 1 or 2, not %d",
		     nchannels);
	return NULL;
266
    }
Jeremy Hylton's avatar
Jeremy Hylton committed
267 268

    for (n = 0; n < n_audio_types; n++)
269 270
        if (fmt == audio_types[n].a_fmt)
            break;
Jeremy Hylton's avatar
Jeremy Hylton committed
271 272 273 274 275 276
    if (n == n_audio_types) {
	PyErr_Format(PyExc_ValueError, "unknown audio encoding: %d", fmt);
	return NULL;
    }
    if (audio_types[n].a_bps != ssize) {
	PyErr_Format(PyExc_ValueError, 
277 278
		     "for %s, expected sample size %d, not %d",
		     audio_types[n].a_name, audio_types[n].a_bps, ssize);
Jeremy Hylton's avatar
Jeremy Hylton committed
279 280
	return NULL;
    }
281

Jeremy Hylton's avatar
Jeremy Hylton committed
282 283 284
    if (emulate == 0) {
	if ((self->x_afmts & audio_types[n].a_fmt) == 0) {
	    PyErr_Format(PyExc_ValueError, 
285
			 "%s format not supported by device",
Jeremy Hylton's avatar
Jeremy Hylton committed
286 287 288
			 audio_types[n].a_name);
	    return NULL;
	}
289
    }
Jeremy Hylton's avatar
Jeremy Hylton committed
290 291
    if (ioctl(self->x_fd, SNDCTL_DSP_SETFMT, 
	      &audio_types[n].a_fmt) == -1) {
292 293 294
        PyErr_SetFromErrno(LinuxAudioError);
        return NULL;
    }
295 296 297 298 299 300 301 302
    if (ioctl(self->x_fd, SNDCTL_DSP_CHANNELS, &nchannels) == -1) {
        PyErr_SetFromErrno(LinuxAudioError);
        return NULL;
    }
    if (ioctl(self->x_fd, SNDCTL_DSP_SPEED, &rate) == -1) {
        PyErr_SetFromErrno(LinuxAudioError);
        return NULL;
    }
Jeremy Hylton's avatar
Jeremy Hylton committed
303

304 305
    Py_INCREF(Py_None);
    return Py_None;
306 307 308 309 310
}

static int
_ssize(lad_t *self, int *nchannels, int *ssize)
{
311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338
    int fmt;

    fmt = 0;
    if (ioctl(self->x_fd, SNDCTL_DSP_SETFMT, &fmt) < 0) 
        return -errno;

    switch (fmt) {
    case AFMT_MU_LAW:
    case AFMT_A_LAW:
    case AFMT_U8:
    case AFMT_S8:
        *ssize = sizeof(char);
        break;
    case AFMT_S16_LE:
    case AFMT_S16_BE:
    case AFMT_U16_LE:
    case AFMT_U16_BE:
        *ssize = sizeof(short);
        break;
    case AFMT_MPEG:
    case AFMT_IMA_ADPCM:
    default:
        return -EOPNOTSUPP;
    }
    *nchannels = 0;
    if (ioctl(self->x_fd, SNDCTL_DSP_CHANNELS, nchannels) < 0)
        return -errno;
    return 0;
339 340 341 342
}


/* bufsize returns the size of the hardware audio buffer in number 
343
   of samples */
344 345 346
static PyObject *
lad_bufsize(lad_t *self, PyObject *args)
{
347 348
    audio_buf_info ai;
    int nchannels, ssize;
349

350
    if (!PyArg_ParseTuple(args, ":bufsize")) return NULL;
351

352 353 354 355 356 357 358 359 360
    if (_ssize(self, &nchannels, &ssize) < 0) {
        PyErr_SetFromErrno(LinuxAudioError);
        return NULL;
    }
    if (ioctl(self->x_fd, SNDCTL_DSP_GETOSPACE, &ai) < 0) {
        PyErr_SetFromErrno(LinuxAudioError);
        return NULL;
    }
    return PyInt_FromLong((ai.fragstotal * ai.fragsize) / (nchannels * ssize));
361 362 363 364 365 366 367
}

/* obufcount returns the number of samples that are available in the 
   hardware for playing */
static PyObject *
lad_obufcount(lad_t *self, PyObject *args)
{
368 369
    audio_buf_info ai;
    int nchannels, ssize;
370

371 372
    if (!PyArg_ParseTuple(args, ":obufcount"))
        return NULL;
373

374 375 376 377 378 379 380 381 382 383
    if (_ssize(self, &nchannels, &ssize) < 0) {
        PyErr_SetFromErrno(LinuxAudioError);
        return NULL;
    }
    if (ioctl(self->x_fd, SNDCTL_DSP_GETOSPACE, &ai) < 0) {
        PyErr_SetFromErrno(LinuxAudioError);
        return NULL;
    }
    return PyInt_FromLong((ai.fragstotal * ai.fragsize - ai.bytes) / 
                          (ssize * nchannels));
384 385 386
}

/* obufcount returns the number of samples that can be played without
387
   blocking */
388 389 390
static PyObject *
lad_obuffree(lad_t *self, PyObject *args)
{
391 392
    audio_buf_info ai;
    int nchannels, ssize;
393

394 395
    if (!PyArg_ParseTuple(args, ":obuffree"))
        return NULL;
396

397 398 399 400 401 402 403 404 405
    if (_ssize(self, &nchannels, &ssize) < 0) {
        PyErr_SetFromErrno(LinuxAudioError);
        return NULL;
    }
    if (ioctl(self->x_fd, SNDCTL_DSP_GETOSPACE, &ai) < 0) {
        PyErr_SetFromErrno(LinuxAudioError);
        return NULL;
    }
    return PyInt_FromLong(ai.bytes / (ssize * nchannels));
406 407 408 409 410 411
}

/* Flush the device */
static PyObject *
lad_flush(lad_t *self, PyObject *args)
{
412
    if (!PyArg_ParseTuple(args, ":flush")) return NULL;
413

Jeremy Hylton's avatar
Jeremy Hylton committed
414
    if (ioctl(self->x_fd, SNDCTL_DSP_SYNC, NULL) == -1) {
415 416 417 418 419
        PyErr_SetFromErrno(LinuxAudioError);
        return NULL;
    }
    Py_INCREF(Py_None);
    return Py_None;
420 421
}

Jeremy Hylton's avatar
Jeremy Hylton committed
422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441
static PyObject *
lad_getptr(lad_t *self, PyObject *args)
{
    count_info info;
    int req;

    if (!PyArg_ParseTuple(args, ":getptr"))
	return NULL;
    
    if (self->x_mode == O_RDONLY)
	req = SNDCTL_DSP_GETIPTR;
    else
	req = SNDCTL_DSP_GETOPTR;
    if (ioctl(self->x_fd, req, &info) == -1) {
        PyErr_SetFromErrno(LinuxAudioError);
        return NULL;
    }
    return Py_BuildValue("iii", info.bytes, info.blocks, info.ptr);
}

442
static PyMethodDef lad_methods[] = {
443 444 445 446 447 448 449 450 451
    { "read",		(PyCFunction)lad_read, METH_VARARGS },
    { "write",		(PyCFunction)lad_write, METH_VARARGS },
    { "setparameters",	(PyCFunction)lad_setparameters, METH_VARARGS },
    { "bufsize",	(PyCFunction)lad_bufsize, METH_VARARGS },
    { "obufcount",	(PyCFunction)lad_obufcount, METH_VARARGS },
    { "obuffree",	(PyCFunction)lad_obuffree, METH_VARARGS },
    { "flush",		(PyCFunction)lad_flush, METH_VARARGS },
    { "close",		(PyCFunction)lad_close, METH_VARARGS },
    { "fileno",     	(PyCFunction)lad_fileno, METH_VARARGS },
Jeremy Hylton's avatar
Jeremy Hylton committed
452
    { "getptr",         (PyCFunction)lad_getptr, METH_VARARGS },
453
    { NULL,		NULL}		/* sentinel */
454 455 456 457 458
};

static PyObject *
lad_getattr(lad_t *xp, char *name)
{
459
    return Py_FindMethod(lad_methods, (PyObject *)xp, name);
460 461 462
}

static PyTypeObject Ladtype = {
463 464
    PyObject_HEAD_INIT(&PyType_Type)
    0,				/*ob_size*/
465
    "linuxaudiodev.linux_audio_device", /*tp_name*/
466 467 468 469 470 471 472 473 474
    sizeof(lad_t),		/*tp_size*/
    0,				/*tp_itemsize*/
    /* methods */
    (destructor)lad_dealloc,	/*tp_dealloc*/
    0,				/*tp_print*/
    (getattrfunc)lad_getattr,	/*tp_getattr*/
    0,				/*tp_setattr*/
    0,				/*tp_compare*/
    0,				/*tp_repr*/
475 476 477 478 479
};

static PyObject *
ladopen(PyObject *self, PyObject *args)
{
480
    return (PyObject *)newladobject(args);
481 482 483
}

static PyMethodDef linuxaudiodev_methods[] = {
484 485
    { "open", ladopen, METH_VARARGS },
    { 0, 0 },
486 487 488
};

void
489
initlinuxaudiodev(void)
490
{
Jeremy Hylton's avatar
Jeremy Hylton committed
491
    PyObject *m;
492
  
493 494 495 496
    m = Py_InitModule("linuxaudiodev", linuxaudiodev_methods);

    LinuxAudioError = PyErr_NewException("linuxaudiodev.error", NULL, NULL);
    if (LinuxAudioError)
Jeremy Hylton's avatar
Jeremy Hylton committed
497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514
	PyModule_AddObject(m, "error", LinuxAudioError);

    if (PyModule_AddIntConstant(m, "AFMT_MU_LAW", (long)AFMT_MU_LAW) == -1)
	return;
    if (PyModule_AddIntConstant(m, "AFMT_A_LAW", (long)AFMT_A_LAW) == -1)
	return;
    if (PyModule_AddIntConstant(m, "AFMT_U8", (long)AFMT_U8) == -1)
	return;
    if (PyModule_AddIntConstant(m, "AFMT_S8", (long)AFMT_S8) == -1)
	return;
    if (PyModule_AddIntConstant(m, "AFMT_U16_BE", (long)AFMT_U16_BE) == -1)
	return;
    if (PyModule_AddIntConstant(m, "AFMT_U16_LE", (long)AFMT_U16_LE) == -1)
	return;
    if (PyModule_AddIntConstant(m, "AFMT_S16_BE", (long)AFMT_S16_BE) == -1)
	return;
    if (PyModule_AddIntConstant(m, "AFMT_S16_LE", (long)AFMT_S16_LE) == -1)
	return;
515 516
    if (PyModule_AddIntConstant(m, "AFMT_S16_NE", (long)AFMT_S16_NE) == -1)
	return;
Jeremy Hylton's avatar
Jeremy Hylton committed
517

518
    return;
519
}