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