chiark / gitweb /
The command backend now supports the old (suspending) and new
[disorder] / lib / alsabg.h
... / ...
CommitLineData
1/*
2 * This file is part of DisOrder.
3 * Copyright (C) 2008 Richard Kettlewell
4 *
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation, either version 3 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program. If not, see <http://www.gnu.org/licenses/>.
17 */
18/** @file alsabg.h
19 * @brief Background-thread interface to ALSA
20 *
21 * This wraps ALSA with an interface which calls back to the client from a
22 * thread. It's not intended for completely general use, just what DisOrder
23 * needs.
24 */
25
26#ifndef ALSABG_H
27#define ALSABG_H
28
29/** @brief Supply audio callback
30 * @param dst Where to write audio data
31 * @param nsamples Number of samples to write
32 * @return Number of samples written
33 *
34 * This function should write up to @p *nsamples samples of data at
35 * @p dst, and return the number of samples written, or -1 if some error
36 * occurred. It will be called in a background thread.
37 */
38typedef int alsa_bg_supply(void *dst,
39 unsigned nsamples_max);
40
41void alsa_bg_init(const char *dev,
42 alsa_bg_supply *supply);
43
44void alsa_bg_enable(void);
45
46void alsa_bg_disable(void);
47
48void alsa_bg_close(void);
49
50#endif /* ALSABG_H */
51
52/*
53Local Variables:
54c-basic-offset:2
55comment-column:40
56fill-column:79
57indent-tabs-mode:nil
58End:
59*/