Linux Packages Manuals » alsa-lib-devel-1.1.1
ALSA project - the C library reference
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
pcm_ioplug.h
Go to the documentation of this file.
1 
10 /*
11  * ALSA external PCM plugin SDK
12  *
13  * Copyright (c) 2005 Takashi Iwai <tiwai@suse.de>
14  *
15  * This library is free software; you can redistribute it and/or modify
16  * it under the terms of the GNU Lesser General Public License as
17  * published by the Free Software Foundation; either version 2.1 of
18  * the License, or (at your option) any later version.
19  *
20  * This program is distributed in the hope that it will be useful,
21  * but WITHOUT ANY WARRANTY; without even the implied warranty of
22  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23  * GNU Lesser General Public License for more details.
24  *
25  * You should have received a copy of the GNU Lesser General Public
26  * License along with this library; if not, write to the Free Software
27  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
28  *
29  */
30 
31 #ifndef __ALSA_PCM_IOPLUG_H
32 #define __ALSA_PCM_IOPLUG_H
33 
42 enum {
51 };
52 
54 typedef struct snd_pcm_ioplug snd_pcm_ioplug_t;
57 #ifdef DOC_HIDDEN
58 /* redefine typedefs for stupid doxygen */
61 #endif
62 
63 /*
64  * bit flags for additional conditions
65  */
66 #define SND_PCM_IOPLUG_FLAG_LISTED (1<<0)
67 #define SND_PCM_IOPLUG_FLAG_MONOTONIC (1<<1)
69 /*
70  * Protocol version
71  */
72 #define SND_PCM_IOPLUG_VERSION_MAJOR 1
73 #define SND_PCM_IOPLUG_VERSION_MINOR 0
74 #define SND_PCM_IOPLUG_VERSION_TINY 2
78 #define SND_PCM_IOPLUG_VERSION ((SND_PCM_IOPLUG_VERSION_MAJOR<<16) |\
79  (SND_PCM_IOPLUG_VERSION_MINOR<<8) |\
80  (SND_PCM_IOPLUG_VERSION_TINY))
81 
88  unsigned int version;
92  const char *name;
93  unsigned int flags;
94  int poll_fd;
95  unsigned int poll_events;
96  unsigned int mmap_rw;
109 
114  int nonblock;
118  unsigned int channels;
119  unsigned int rate;
122 };
123 
129  int (*start)(snd_pcm_ioplug_t *io);
133  int (*stop)(snd_pcm_ioplug_t *io);
142  const snd_pcm_channel_area_t *areas,
143  snd_pcm_uframes_t offset,
144  snd_pcm_uframes_t size);
148  int (*close)(snd_pcm_ioplug_t *io);
168  int (*drain)(snd_pcm_ioplug_t *io);
172  int (*pause)(snd_pcm_ioplug_t *io, int enable);
184  int (*poll_descriptors)(snd_pcm_ioplug_t *io, struct pollfd *pfd, unsigned int space);
188  int (*poll_revents)(snd_pcm_ioplug_t *io, struct pollfd *pfd, unsigned int nfds, unsigned short *revents);
192  void (*dump)(snd_pcm_ioplug_t *io, snd_output_t *out);
200  snd_pcm_chmap_query_t **(*query_chmaps)(snd_pcm_ioplug_t *io);
204  snd_pcm_chmap_t *(*get_chmap)(snd_pcm_ioplug_t *io);
208  int (*set_chmap)(snd_pcm_ioplug_t *io, const snd_pcm_chmap_t *map);
209 };
210 
211 
212 int snd_pcm_ioplug_create(snd_pcm_ioplug_t *io, const char *name,
213  snd_pcm_stream_t stream, int mode);
215 
216 /* update poll_fd and mmap_rw */
218 
219 /* get a mmap area (for mmap_rw only) */
221 
222 /* clear hw_parameter setting */
224 
225 /* hw_parameter setting */
226 int snd_pcm_ioplug_set_param_minmax(snd_pcm_ioplug_t *io, int type, unsigned int min, unsigned int max);
227 int snd_pcm_ioplug_set_param_list(snd_pcm_ioplug_t *io, int type, unsigned int num_list, const unsigned int *list);
228 
229 /* change PCM status */
231 
234 #endif /* __ALSA_PCM_IOPLUG_H */
int snd_pcm_ioplug_set_param_list(snd_pcm_ioplug_t *io, int type, unsigned int num_list, const unsigned int *list)
Set parameter as the list.
Definition: pcm_ioplug.c:1019
void(* dump)(snd_pcm_ioplug_t *io, snd_output_t *out)
Definition: pcm_ioplug.h:192
int(* set_chmap)(snd_pcm_ioplug_t *io, const snd_pcm_chmap_t *map)
Definition: pcm_ioplug.h:208
struct _snd_pcm_sw_params snd_pcm_sw_params_t
Definition: pcm.h:65
volatile snd_pcm_uframes_t appl_ptr
Definition: pcm_ioplug.h:112
Definition: pcm_ioplug.h:44
Definition: pcm.h:594
snd_pcm_state_t
Definition: pcm.h:273
Definition: pcm_ioplug.h:43
int(* hw_params)(snd_pcm_ioplug_t *io, snd_pcm_hw_params_t *params)
Definition: pcm_ioplug.h:152
int snd_pcm_ioplug_set_state(snd_pcm_ioplug_t *ioplug, snd_pcm_state_t state)
Change the ioplug PCM status.
Definition: pcm_ioplug.c:1105
unsigned int poll_events
Definition: pcm_ioplug.h:95
const snd_pcm_channel_area_t * snd_pcm_ioplug_mmap_areas(snd_pcm_ioplug_t *ioplug)
Get mmap area of ioplug.
Definition: pcm_ioplug.c:1088
int snd_pcm_ioplug_delete(snd_pcm_ioplug_t *io)
Delete the ioplug instance.
Definition: pcm_ioplug.c:990
int(* poll_descriptors_count)(snd_pcm_ioplug_t *io)
Definition: pcm_ioplug.h:180
Definition: pcm.h:448
struct _snd_pcm_hw_params snd_pcm_hw_params_t
Definition: pcm.h:62
Definition: pcm.h:588
int(* pause)(snd_pcm_ioplug_t *io, int enable)
Definition: pcm_ioplug.h:172
const snd_pcm_ioplug_callback_t * callback
Definition: pcm_ioplug.h:100
int(* stop)(snd_pcm_ioplug_t *io)
Definition: pcm_ioplug.h:133
int(* resume)(snd_pcm_ioplug_t *io)
Definition: pcm_ioplug.h:176
int(* drain)(snd_pcm_ioplug_t *io)
Definition: pcm_ioplug.h:168
int(* poll_revents)(snd_pcm_ioplug_t *io, struct pollfd *pfd, unsigned int nfds, unsigned short *revents)
Definition: pcm_ioplug.h:188
int(* hw_free)(snd_pcm_ioplug_t *io)
Definition: pcm_ioplug.h:156
void * private_data
Definition: pcm_ioplug.h:104
Definition: pcm_ioplug.h:49
int nonblock
Definition: pcm_ioplug.h:114
int poll_fd
Definition: pcm_ioplug.h:94
Definition: pcm_ioplug.h:83
snd_pcm_format_t
Definition: pcm.h:123
long snd_pcm_sframes_t
Definition: pcm.h:356
Definition: pcm_ioplug.h:50
snd_pcm_uframes_t buffer_size
Definition: pcm_ioplug.h:121
Definition: pcm_ioplug.h:125
snd_pcm_uframes_t period_size
Definition: pcm_ioplug.h:120
unsigned int version
Definition: pcm_ioplug.h:88
int(* poll_descriptors)(snd_pcm_ioplug_t *io, struct pollfd *pfd, unsigned int space)
Definition: pcm_ioplug.h:184
struct _snd_output snd_output_t
Internal structure for an output object.
Definition: output.h:54
int(* sw_params)(snd_pcm_ioplug_t *io, snd_pcm_sw_params_t *params)
Definition: pcm_ioplug.h:160
snd_pcm_state_t state
Definition: pcm_ioplug.h:111
const char * name
Definition: pcm_ioplug.h:92
unsigned int rate
Definition: pcm_ioplug.h:119
snd_pcm_format_t format
Definition: pcm_ioplug.h:117
snd_pcm_ioplug_callback snd_pcm_ioplug_callback_t
Definition: pcm_ioplug.h:60
Definition: pcm_ioplug.h:48
int(* start)(snd_pcm_ioplug_t *io)
Definition: pcm_ioplug.h:129
snd_pcm_sframes_t(* pointer)(snd_pcm_ioplug_t *io)
Definition: pcm_ioplug.h:137
int snd_pcm_ioplug_set_param_minmax(snd_pcm_ioplug_t *io, int type, unsigned int min, unsigned int max)
Set parameter as the min/max values.
Definition: pcm_ioplug.c:1043
snd_pcm_sframes_t(* transfer)(snd_pcm_ioplug_t *io, const snd_pcm_channel_area_t *areas, snd_pcm_uframes_t offset, snd_pcm_uframes_t size)
Definition: pcm_ioplug.h:141
int(* delay)(snd_pcm_ioplug_t *io, snd_pcm_sframes_t *delayp)
Definition: pcm_ioplug.h:196
unsigned int flags
Definition: pcm_ioplug.h:93
snd_pcm_access_t access
Definition: pcm_ioplug.h:116
int snd_pcm_ioplug_create(snd_pcm_ioplug_t *io, const char *name, snd_pcm_stream_t stream, int mode)
Create an ioplug instance.
Definition: pcm_ioplug.c:938
int(* close)(snd_pcm_ioplug_t *io)
Definition: pcm_ioplug.h:148
void snd_pcm_ioplug_params_reset(snd_pcm_ioplug_t *io)
Reset ioplug parameters.
Definition: pcm_ioplug.c:1002
Definition: pcm_ioplug.h:45
Definition: pcm_ioplug.h:47
unsigned int channels
Definition: pcm_ioplug.h:118
snd_pcm_stream_t stream
Definition: pcm_ioplug.h:110
int snd_pcm_ioplug_reinit_status(snd_pcm_ioplug_t *ioplug)
Reinitialize the poll and mmap status.
Definition: pcm_ioplug.c:1068
unsigned long snd_pcm_uframes_t
Definition: pcm.h:354
snd_pcm_stream_t
Definition: pcm.h:99
snd_pcm_t * pcm
Definition: pcm_ioplug.h:108
int(* prepare)(snd_pcm_ioplug_t *io)
Definition: pcm_ioplug.h:164
Definition: pcm_ioplug.h:46
struct _snd_pcm snd_pcm_t
Definition: pcm.h:374
unsigned int mmap_rw
Definition: pcm_ioplug.h:96
volatile snd_pcm_uframes_t hw_ptr
Definition: pcm_ioplug.h:113
snd_pcm_access_t
Definition: pcm.h:108
snd_pcm_ioplug snd_pcm_ioplug_t
Definition: pcm_ioplug.h:59

Generated for ALSA project - the C library reference by doxygen 1.8.5