]> code.delx.au - pulseaudio/blob - src/modules/alsa/alsa-util.h
alsa: allow configuration of fallback device strings in profiles
[pulseaudio] / src / modules / alsa / alsa-util.h
1 #ifndef fooalsautilhfoo
2 #define fooalsautilhfoo
3
4 /***
5 This file is part of PulseAudio.
6
7 Copyright 2004-2006 Lennart Poettering
8 Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB
9
10 PulseAudio is free software; you can redistribute it and/or modify
11 it under the terms of the GNU Lesser General Public License as published
12 by the Free Software Foundation; either version 2.1 of the License,
13 or (at your option) any later version.
14
15 PulseAudio is distributed in the hope that it will be useful, but
16 WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 General Public License for more details.
19
20 You should have received a copy of the GNU Lesser General Public License
21 along with PulseAudio; if not, write to the Free Software
22 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
23 USA.
24 ***/
25
26 #include <asoundlib.h>
27
28 #include <pulse/sample.h>
29 #include <pulse/volume.h>
30 #include <pulse/mainloop-api.h>
31 #include <pulse/channelmap.h>
32 #include <pulse/proplist.h>
33
34 #include <pulsecore/rtpoll.h>
35 #include <pulsecore/core.h>
36 #include <pulsecore/log.h>
37
38 typedef struct pa_alsa_fdlist pa_alsa_fdlist;
39
40 struct pa_alsa_fdlist *pa_alsa_fdlist_new(void);
41 void pa_alsa_fdlist_free(struct pa_alsa_fdlist *fdl);
42 int pa_alsa_fdlist_set_mixer(struct pa_alsa_fdlist *fdl, snd_mixer_t *mixer_handle, pa_mainloop_api* m);
43
44 int pa_alsa_set_hw_params(
45 snd_pcm_t *pcm_handle,
46 pa_sample_spec *ss,
47 uint32_t *periods,
48 snd_pcm_uframes_t *period_size,
49 snd_pcm_uframes_t tsched_size,
50 pa_bool_t *use_mmap,
51 pa_bool_t *use_tsched,
52 pa_bool_t require_exact_channel_number);
53
54 int pa_alsa_set_sw_params(snd_pcm_t *pcm, snd_pcm_uframes_t avail_min);
55
56 typedef struct pa_alsa_profile_info {
57 pa_channel_map map;
58 const char *alsa_name;
59 const char *alsa_name_fallback;
60 const char *description; /* internationalized */
61 const char *name;
62 unsigned priority;
63 const char *playback_control_name, *playback_control_fallback;
64 const char *record_control_name, *record_control_fallback;
65 } pa_alsa_profile_info;
66
67 int pa_alsa_prepare_mixer(snd_mixer_t *mixer, const char *dev);
68 snd_mixer_elem_t *pa_alsa_find_elem(snd_mixer_t *mixer, const char *name, const char *fallback, pa_bool_t playback);
69 int pa_alsa_find_mixer_and_elem(snd_pcm_t *pcm, snd_mixer_t **_m, snd_mixer_elem_t **_e, const char *control_name, const pa_alsa_profile_info*profile);
70
71 /* Picks a working profile based on the specified ss/map */
72 snd_pcm_t *pa_alsa_open_by_device_id_auto(
73 const char *dev_id,
74 char **dev,
75 pa_sample_spec *ss,
76 pa_channel_map* map,
77 int mode,
78 uint32_t *nfrags,
79 snd_pcm_uframes_t *period_size,
80 snd_pcm_uframes_t tsched_size,
81 pa_bool_t *use_mmap,
82 pa_bool_t *use_tsched,
83 const pa_alsa_profile_info **profile);
84
85 /* Uses the specified profile */
86 snd_pcm_t *pa_alsa_open_by_device_id_profile(
87 const char *dev_id,
88 char **dev,
89 pa_sample_spec *ss,
90 pa_channel_map* map,
91 int mode,
92 uint32_t *nfrags,
93 snd_pcm_uframes_t *period_size,
94 snd_pcm_uframes_t tsched_size,
95 pa_bool_t *use_mmap,
96 pa_bool_t *use_tsched,
97 const pa_alsa_profile_info *profile);
98
99 /* Opens the explicit ALSA device */
100 snd_pcm_t *pa_alsa_open_by_device_string(
101 const char *device,
102 char **dev,
103 pa_sample_spec *ss,
104 pa_channel_map* map,
105 int mode,
106 uint32_t *nfrags,
107 snd_pcm_uframes_t *period_size,
108 snd_pcm_uframes_t tsched_size,
109 pa_bool_t *use_mmap,
110 pa_bool_t *use_tsched,
111 pa_bool_t require_exact_channel_number);
112
113 int pa_alsa_probe_profiles(
114 const char *dev_id,
115 const pa_sample_spec *ss,
116 void (*cb)(const pa_alsa_profile_info *sink, const pa_alsa_profile_info *source, void *userdata),
117 void *userdata);
118
119 int pa_alsa_calc_mixer_map(snd_mixer_elem_t *elem, const pa_channel_map *channel_map, snd_mixer_selem_channel_id_t mixer_map[], pa_bool_t playback);
120
121 void pa_alsa_dump(pa_log_level_t level, snd_pcm_t *pcm);
122 void pa_alsa_dump_status(snd_pcm_t *pcm);
123
124 void pa_alsa_redirect_errors_inc(void);
125 void pa_alsa_redirect_errors_dec(void);
126
127 void pa_alsa_init_proplist_pcm_info(pa_core *c, pa_proplist *p, snd_pcm_info_t *pcm_info);
128 void pa_alsa_init_proplist_card(pa_core *c, pa_proplist *p, int card);
129 void pa_alsa_init_proplist_pcm(pa_core *c, pa_proplist *p, snd_pcm_t *pcm, snd_mixer_elem_t *elem);
130 pa_bool_t pa_alsa_init_description(pa_proplist *p);
131
132 int pa_alsa_recover_from_poll(snd_pcm_t *pcm, int revents);
133
134 pa_rtpoll_item* pa_alsa_build_pollfd(snd_pcm_t *pcm, pa_rtpoll *rtpoll);
135
136 snd_pcm_sframes_t pa_alsa_safe_avail(snd_pcm_t *pcm, size_t hwbuf_size, const pa_sample_spec *ss);
137 int pa_alsa_safe_delay(snd_pcm_t *pcm, snd_pcm_sframes_t *delay, size_t hwbuf_size, const pa_sample_spec *ss);
138 int pa_alsa_safe_mmap_begin(snd_pcm_t *pcm, const snd_pcm_channel_area_t **areas, snd_pcm_uframes_t *offset, snd_pcm_uframes_t *frames, size_t hwbuf_size, const pa_sample_spec *ss);
139
140 char *pa_alsa_get_driver_name(int card);
141
142 char *pa_alsa_get_driver_name_by_pcm(snd_pcm_t *pcm);
143
144 char *pa_alsa_get_reserve_name(const char *device);
145
146 pa_bool_t pa_alsa_pcm_is_hw(snd_pcm_t *pcm);
147
148 pa_bool_t pa_alsa_pcm_is_modem(snd_pcm_t *pcm);
149
150 const char* pa_alsa_strerror(int errnum);
151
152 #endif