core: always allow volume setting with single-channel pa_cvolume
[platform/upstream/pulseaudio.git] / src / pulsecore / sample-util.h
1 #ifndef foosampleutilhfoo
2 #define foosampleutilhfoo
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 <pulse/sample.h>
27 #include <pulse/volume.h>
28 #include <pulse/channelmap.h>
29 #include <pulsecore/memblock.h>
30 #include <pulsecore/memchunk.h>
31
32 typedef struct pa_silence_cache {
33     pa_memblock* blocks[PA_SAMPLE_MAX];
34 } pa_silence_cache;
35
36 void pa_silence_cache_init(pa_silence_cache *cache);
37 void pa_silence_cache_done(pa_silence_cache *cache);
38
39 void *pa_silence_memory(void *p, size_t length, const pa_sample_spec *spec);
40 pa_memchunk* pa_silence_memchunk(pa_memchunk *c, const pa_sample_spec *spec);
41 pa_memblock* pa_silence_memblock(pa_memblock *b, const pa_sample_spec *spec);
42
43 pa_memchunk* pa_silence_memchunk_get(pa_silence_cache *cache, pa_mempool *pool, pa_memchunk* ret, const pa_sample_spec *spec, size_t length);
44
45 typedef struct pa_mix_info {
46     pa_memchunk chunk;
47     pa_cvolume volume;
48     void *userdata;
49
50     /* The following fields are used internally by pa_mix(), should
51      * not be initialised by the caller of pa_mix(). */
52     void *ptr;
53     union {
54         int32_t i;
55         float f;
56     } linear[PA_CHANNELS_MAX];
57 } pa_mix_info;
58
59 size_t pa_mix(
60     pa_mix_info channels[],
61     unsigned nchannels,
62     void *data,
63     size_t length,
64     const pa_sample_spec *spec,
65     const pa_cvolume *volume,
66     pa_bool_t mute);
67
68 void pa_volume_memchunk(
69     pa_memchunk*c,
70     const pa_sample_spec *spec,
71     const pa_cvolume *volume);
72
73 size_t pa_frame_align(size_t l, const pa_sample_spec *ss) PA_GCC_PURE;
74
75 pa_bool_t pa_frame_aligned(size_t l, const pa_sample_spec *ss) PA_GCC_PURE;
76
77 void pa_interleave(const void *src[], unsigned channels, void *dst, size_t ss, unsigned n);
78 void pa_deinterleave(const void *src, void *dst[], unsigned channels, size_t ss, unsigned n);
79
80 void pa_sample_clamp(pa_sample_format_t format, void *dst, size_t dstr, const void *src, size_t sstr, unsigned n);
81
82 pa_usec_t pa_bytes_to_usec_round_up(uint64_t length, const pa_sample_spec *spec);
83 size_t pa_usec_to_bytes_round_up(pa_usec_t t, const pa_sample_spec *spec);
84
85 void pa_memchunk_dump_to_file(pa_memchunk *c, const char *fn);
86
87 void pa_memchunk_sine(pa_memchunk *c, pa_mempool *pool, unsigned rate, unsigned freq);
88
89 typedef void (*pa_do_volume_func_t) (void *samples, void *volumes, unsigned channels, unsigned length);
90
91 pa_do_volume_func_t pa_get_volume_func(pa_sample_format_t f);
92 void pa_set_volume_func(pa_sample_format_t f, pa_do_volume_func_t func);
93
94 #define PA_CHANNEL_POSITION_MASK_LEFT                                   \
95     (PA_CHANNEL_POSITION_MASK(PA_CHANNEL_POSITION_FRONT_LEFT)           \
96      | PA_CHANNEL_POSITION_MASK(PA_CHANNEL_POSITION_REAR_LEFT)          \
97      | PA_CHANNEL_POSITION_MASK(PA_CHANNEL_POSITION_FRONT_LEFT_OF_CENTER) \
98      | PA_CHANNEL_POSITION_MASK(PA_CHANNEL_POSITION_SIDE_LEFT)          \
99      | PA_CHANNEL_POSITION_MASK(PA_CHANNEL_POSITION_TOP_FRONT_LEFT)     \
100      | PA_CHANNEL_POSITION_MASK(PA_CHANNEL_POSITION_TOP_REAR_LEFT))     \
101
102 #define PA_CHANNEL_POSITION_MASK_RIGHT                                  \
103     (PA_CHANNEL_POSITION_MASK(PA_CHANNEL_POSITION_FRONT_RIGHT)          \
104      | PA_CHANNEL_POSITION_MASK(PA_CHANNEL_POSITION_REAR_RIGHT)         \
105      | PA_CHANNEL_POSITION_MASK(PA_CHANNEL_POSITION_FRONT_RIGHT_OF_CENTER) \
106      | PA_CHANNEL_POSITION_MASK(PA_CHANNEL_POSITION_SIDE_RIGHT)         \
107      | PA_CHANNEL_POSITION_MASK(PA_CHANNEL_POSITION_TOP_FRONT_RIGHT)    \
108      | PA_CHANNEL_POSITION_MASK(PA_CHANNEL_POSITION_TOP_REAR_RIGHT))
109
110 #define PA_CHANNEL_POSITION_MASK_CENTER                                 \
111     (PA_CHANNEL_POSITION_MASK(PA_CHANNEL_POSITION_FRONT_CENTER)         \
112      | PA_CHANNEL_POSITION_MASK(PA_CHANNEL_POSITION_REAR_CENTER)        \
113      | PA_CHANNEL_POSITION_MASK(PA_CHANNEL_POSITION_TOP_CENTER)         \
114      | PA_CHANNEL_POSITION_MASK(PA_CHANNEL_POSITION_TOP_FRONT_CENTER)   \
115      | PA_CHANNEL_POSITION_MASK(PA_CHANNEL_POSITION_TOP_REAR_CENTER))
116
117 #define PA_CHANNEL_POSITION_MASK_FRONT                                  \
118     (PA_CHANNEL_POSITION_MASK(PA_CHANNEL_POSITION_FRONT_LEFT)           \
119      | PA_CHANNEL_POSITION_MASK(PA_CHANNEL_POSITION_FRONT_RIGHT)        \
120      | PA_CHANNEL_POSITION_MASK(PA_CHANNEL_POSITION_FRONT_CENTER)       \
121      | PA_CHANNEL_POSITION_MASK(PA_CHANNEL_POSITION_FRONT_LEFT_OF_CENTER) \
122      | PA_CHANNEL_POSITION_MASK(PA_CHANNEL_POSITION_FRONT_RIGHT_OF_CENTER) \
123      | PA_CHANNEL_POSITION_MASK(PA_CHANNEL_POSITION_TOP_FRONT_LEFT)     \
124      | PA_CHANNEL_POSITION_MASK(PA_CHANNEL_POSITION_TOP_FRONT_RIGHT)    \
125      | PA_CHANNEL_POSITION_MASK(PA_CHANNEL_POSITION_TOP_FRONT_CENTER))
126
127 #define PA_CHANNEL_POSITION_MASK_REAR                                   \
128     (PA_CHANNEL_POSITION_MASK(PA_CHANNEL_POSITION_REAR_LEFT)            \
129      | PA_CHANNEL_POSITION_MASK(PA_CHANNEL_POSITION_REAR_RIGHT)         \
130      | PA_CHANNEL_POSITION_MASK(PA_CHANNEL_POSITION_REAR_CENTER)        \
131      | PA_CHANNEL_POSITION_MASK(PA_CHANNEL_POSITION_TOP_REAR_LEFT)      \
132      | PA_CHANNEL_POSITION_MASK(PA_CHANNEL_POSITION_TOP_REAR_RIGHT)     \
133      | PA_CHANNEL_POSITION_MASK(PA_CHANNEL_POSITION_TOP_REAR_CENTER))
134
135 #define PA_CHANNEL_POSITION_MASK_SIDE_OR_TOP_CENTER                     \
136     (PA_CHANNEL_POSITION_MASK(PA_CHANNEL_POSITION_SIDE_LEFT)            \
137      | PA_CHANNEL_POSITION_MASK(PA_CHANNEL_POSITION_SIDE_RIGHT)         \
138      | PA_CHANNEL_POSITION_MASK(PA_CHANNEL_POSITION_TOP_CENTER))
139
140 #define PA_CHANNEL_POSITION_MASK_TOP                                    \
141     (PA_CHANNEL_POSITION_MASK(PA_CHANNEL_POSITION_TOP_CENTER)           \
142      | PA_CHANNEL_POSITION_MASK(PA_CHANNEL_POSITION_TOP_FRONT_LEFT)     \
143      | PA_CHANNEL_POSITION_MASK(PA_CHANNEL_POSITION_TOP_FRONT_RIGHT)    \
144      | PA_CHANNEL_POSITION_MASK(PA_CHANNEL_POSITION_TOP_FRONT_CENTER)   \
145      | PA_CHANNEL_POSITION_MASK(PA_CHANNEL_POSITION_TOP_REAR_LEFT)      \
146      | PA_CHANNEL_POSITION_MASK(PA_CHANNEL_POSITION_TOP_REAR_RIGHT)     \
147      | PA_CHANNEL_POSITION_MASK(PA_CHANNEL_POSITION_TOP_REAR_CENTER))
148
149 #define PA_CHANNEL_POSITION_MASK_ALL            \
150     ((pa_channel_position_mask_t) (PA_CHANNEL_POSITION_MASK(PA_CHANNEL_POSITION_MAX)-1))
151
152 #endif