18b04028188dcf66d48f3fa2533a65d0695dcc11
[platform/upstream/pulseaudio.git] / 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 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
36 typedef struct pa_alsa_fdlist pa_alsa_fdlist;
37
38 struct pa_alsa_fdlist *pa_alsa_fdlist_new(void);
39 void pa_alsa_fdlist_free(struct pa_alsa_fdlist *fdl);
40 int pa_alsa_fdlist_set_mixer(struct pa_alsa_fdlist *fdl, snd_mixer_t *mixer_handle, pa_mainloop_api* m);
41
42 int pa_alsa_set_hw_params(
43         snd_pcm_t *pcm_handle,
44         pa_sample_spec *ss,
45         uint32_t *periods,
46         snd_pcm_uframes_t *period_size,
47         snd_pcm_uframes_t tsched_size,
48         pa_bool_t *use_mmap,
49         pa_bool_t *use_tsched,
50         pa_bool_t require_exact_channel_number);
51
52 int pa_alsa_set_sw_params(snd_pcm_t *pcm, snd_pcm_uframes_t avail_min);
53
54 int pa_alsa_prepare_mixer(snd_mixer_t *mixer, const char *dev);
55 snd_mixer_elem_t *pa_alsa_find_elem(snd_mixer_t *mixer, const char *name, const char *fallback, pa_bool_t playback);
56
57 typedef struct pa_alsa_profile_info {
58     pa_channel_map map;
59     const char *alsa_name;
60     const char *description;
61     const char *name;
62     unsigned priority;
63 } pa_alsa_profile_info;
64
65 /* Picks a working profile based on the specified ss/map */
66 snd_pcm_t *pa_alsa_open_by_device_id_auto(
67         const char *dev_id,
68         char **dev,
69         pa_sample_spec *ss,
70         pa_channel_map* map,
71         int mode,
72         uint32_t *nfrags,
73         snd_pcm_uframes_t *period_size,
74         snd_pcm_uframes_t tsched_size,
75         pa_bool_t *use_mmap,
76         pa_bool_t *use_tsched,
77         const pa_alsa_profile_info **profile);
78
79 /* Uses the specified profile */
80 snd_pcm_t *pa_alsa_open_by_device_id_profile(
81         const char *dev_id,
82         char **dev,
83         pa_sample_spec *ss,
84         pa_channel_map* map,
85         int mode,
86         uint32_t *nfrags,
87         snd_pcm_uframes_t *period_size,
88         snd_pcm_uframes_t tsched_size,
89         pa_bool_t *use_mmap,
90         pa_bool_t *use_tsched,
91         const pa_alsa_profile_info *profile);
92
93 /* Opens the explicit ALSA device */
94 snd_pcm_t *pa_alsa_open_by_device_string(
95         const char *device,
96         char **dev,
97         pa_sample_spec *ss,
98         pa_channel_map* map,
99         int mode,
100         uint32_t *nfrags,
101         snd_pcm_uframes_t *period_size,
102         snd_pcm_uframes_t tsched_size,
103         pa_bool_t *use_mmap,
104         pa_bool_t *use_tsched,
105         pa_bool_t require_exact_channel_number);
106
107 int pa_alsa_probe_profiles(
108         const char *dev_id,
109         const pa_sample_spec *ss,
110         void (*cb)(const pa_alsa_profile_info *sink, const pa_alsa_profile_info *source, void *userdata),
111         void *userdata);
112
113 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);
114
115 void pa_alsa_dump(snd_pcm_t *pcm);
116 void pa_alsa_dump_status(snd_pcm_t *pcm);
117
118 void pa_alsa_redirect_errors_inc(void);
119 void pa_alsa_redirect_errors_dec(void);
120
121 void pa_alsa_init_proplist_pcm(pa_proplist *p, snd_pcm_info_t *pcm_info);
122 void pa_alsa_init_proplist_card(pa_proplist *p, int card);
123
124 int pa_alsa_recover_from_poll(snd_pcm_t *pcm, int revents);
125
126 pa_rtpoll_item* pa_alsa_build_pollfd(snd_pcm_t *pcm, pa_rtpoll *rtpoll);
127
128 snd_pcm_sframes_t pa_alsa_safe_avail_update(snd_pcm_t *pcm, size_t hwbuf_size, const pa_sample_spec *ss);
129 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);
130
131 #endif