]> code.delx.au - pulseaudio/blob - src/pulsecore/resampler.c
resampler: Implement leftover handling in convert_to_work_format()
[pulseaudio] / src / pulsecore / resampler.c
1 /***
2 This file is part of PulseAudio.
3
4 Copyright 2004-2006 Lennart Poettering
5
6 PulseAudio is free software; you can redistribute it and/or modify
7 it under the terms of the GNU Lesser General Public License as published
8 by the Free Software Foundation; either version 2.1 of the License,
9 or (at your option) any later version.
10
11 PulseAudio is distributed in the hope that it will be useful, but
12 WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 General Public License for more details.
15
16 You should have received a copy of the GNU Lesser General Public License
17 along with PulseAudio; if not, write to the Free Software
18 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
19 USA.
20 ***/
21
22 #ifdef HAVE_CONFIG_H
23 #include <config.h>
24 #endif
25
26 #include <string.h>
27
28 #ifdef HAVE_LIBSAMPLERATE
29 #include <samplerate.h>
30 #endif
31
32 #ifdef HAVE_SPEEX
33 #include <speex/speex_resampler.h>
34 #endif
35
36 #include <pulse/xmalloc.h>
37 #include <pulsecore/sconv.h>
38 #include <pulsecore/log.h>
39 #include <pulsecore/macro.h>
40 #include <pulsecore/strbuf.h>
41 #include <pulsecore/remap.h>
42 #include <pulsecore/core-util.h>
43 #include "ffmpeg/avcodec.h"
44
45 #include "resampler.h"
46
47 /* Number of samples of extra space we allow the resamplers to return */
48 #define EXTRA_FRAMES 128
49
50 struct pa_resampler {
51 pa_resample_method_t method;
52 pa_resample_flags_t flags;
53
54 pa_sample_spec i_ss, o_ss;
55 pa_channel_map i_cm, o_cm;
56 size_t i_fz, o_fz, w_fz, w_sz;
57 pa_mempool *mempool;
58
59 pa_memchunk to_work_format_buf;
60 pa_memchunk remap_buf;
61 pa_memchunk resample_buf;
62 pa_memchunk from_work_format_buf;
63 size_t to_work_format_buf_size;
64 size_t remap_buf_size;
65 size_t resample_buf_size;
66 size_t from_work_format_buf_size;
67
68 /* points to buffer before resampling stage, remap or to_work */
69 pa_memchunk *leftover_buf;
70 size_t *leftover_buf_size;
71
72 /* have_leftover points to leftover_in_remap or leftover_in_to_work */
73 bool *have_leftover;
74 bool leftover_in_remap;
75 bool leftover_in_to_work;
76
77 pa_sample_format_t work_format;
78 uint8_t work_channels;
79
80 pa_convert_func_t to_work_format_func;
81 pa_convert_func_t from_work_format_func;
82
83 pa_remap_t remap;
84 bool map_required;
85
86 pa_resampler_impl impl;
87 };
88
89 struct trivial_data { /* data specific to the trivial resampler */
90 unsigned o_counter;
91 unsigned i_counter;
92 };
93
94 struct peaks_data { /* data specific to the peak finder pseudo resampler */
95 unsigned o_counter;
96 unsigned i_counter;
97
98 float max_f[PA_CHANNELS_MAX];
99 int16_t max_i[PA_CHANNELS_MAX];
100 };
101
102 struct ffmpeg_data { /* data specific to ffmpeg */
103 struct AVResampleContext *state;
104 };
105
106 static int copy_init(pa_resampler *r);
107 static int trivial_init(pa_resampler*r);
108 #ifdef HAVE_SPEEX
109 static int speex_init(pa_resampler*r);
110 #endif
111 static int ffmpeg_init(pa_resampler*r);
112 static int peaks_init(pa_resampler*r);
113 #ifdef HAVE_LIBSAMPLERATE
114 static int libsamplerate_init(pa_resampler*r);
115 #endif
116
117 static void calc_map_table(pa_resampler *r);
118
119 static int (* const init_table[])(pa_resampler*r) = {
120 #ifdef HAVE_LIBSAMPLERATE
121 [PA_RESAMPLER_SRC_SINC_BEST_QUALITY] = libsamplerate_init,
122 [PA_RESAMPLER_SRC_SINC_MEDIUM_QUALITY] = libsamplerate_init,
123 [PA_RESAMPLER_SRC_SINC_FASTEST] = libsamplerate_init,
124 [PA_RESAMPLER_SRC_ZERO_ORDER_HOLD] = libsamplerate_init,
125 [PA_RESAMPLER_SRC_LINEAR] = libsamplerate_init,
126 #else
127 [PA_RESAMPLER_SRC_SINC_BEST_QUALITY] = NULL,
128 [PA_RESAMPLER_SRC_SINC_MEDIUM_QUALITY] = NULL,
129 [PA_RESAMPLER_SRC_SINC_FASTEST] = NULL,
130 [PA_RESAMPLER_SRC_ZERO_ORDER_HOLD] = NULL,
131 [PA_RESAMPLER_SRC_LINEAR] = NULL,
132 #endif
133 [PA_RESAMPLER_TRIVIAL] = trivial_init,
134 #ifdef HAVE_SPEEX
135 [PA_RESAMPLER_SPEEX_FLOAT_BASE+0] = speex_init,
136 [PA_RESAMPLER_SPEEX_FLOAT_BASE+1] = speex_init,
137 [PA_RESAMPLER_SPEEX_FLOAT_BASE+2] = speex_init,
138 [PA_RESAMPLER_SPEEX_FLOAT_BASE+3] = speex_init,
139 [PA_RESAMPLER_SPEEX_FLOAT_BASE+4] = speex_init,
140 [PA_RESAMPLER_SPEEX_FLOAT_BASE+5] = speex_init,
141 [PA_RESAMPLER_SPEEX_FLOAT_BASE+6] = speex_init,
142 [PA_RESAMPLER_SPEEX_FLOAT_BASE+7] = speex_init,
143 [PA_RESAMPLER_SPEEX_FLOAT_BASE+8] = speex_init,
144 [PA_RESAMPLER_SPEEX_FLOAT_BASE+9] = speex_init,
145 [PA_RESAMPLER_SPEEX_FLOAT_BASE+10] = speex_init,
146 [PA_RESAMPLER_SPEEX_FIXED_BASE+0] = speex_init,
147 [PA_RESAMPLER_SPEEX_FIXED_BASE+1] = speex_init,
148 [PA_RESAMPLER_SPEEX_FIXED_BASE+2] = speex_init,
149 [PA_RESAMPLER_SPEEX_FIXED_BASE+3] = speex_init,
150 [PA_RESAMPLER_SPEEX_FIXED_BASE+4] = speex_init,
151 [PA_RESAMPLER_SPEEX_FIXED_BASE+5] = speex_init,
152 [PA_RESAMPLER_SPEEX_FIXED_BASE+6] = speex_init,
153 [PA_RESAMPLER_SPEEX_FIXED_BASE+7] = speex_init,
154 [PA_RESAMPLER_SPEEX_FIXED_BASE+8] = speex_init,
155 [PA_RESAMPLER_SPEEX_FIXED_BASE+9] = speex_init,
156 [PA_RESAMPLER_SPEEX_FIXED_BASE+10] = speex_init,
157 #else
158 [PA_RESAMPLER_SPEEX_FLOAT_BASE+0] = NULL,
159 [PA_RESAMPLER_SPEEX_FLOAT_BASE+1] = NULL,
160 [PA_RESAMPLER_SPEEX_FLOAT_BASE+2] = NULL,
161 [PA_RESAMPLER_SPEEX_FLOAT_BASE+3] = NULL,
162 [PA_RESAMPLER_SPEEX_FLOAT_BASE+4] = NULL,
163 [PA_RESAMPLER_SPEEX_FLOAT_BASE+5] = NULL,
164 [PA_RESAMPLER_SPEEX_FLOAT_BASE+6] = NULL,
165 [PA_RESAMPLER_SPEEX_FLOAT_BASE+7] = NULL,
166 [PA_RESAMPLER_SPEEX_FLOAT_BASE+8] = NULL,
167 [PA_RESAMPLER_SPEEX_FLOAT_BASE+9] = NULL,
168 [PA_RESAMPLER_SPEEX_FLOAT_BASE+10] = NULL,
169 [PA_RESAMPLER_SPEEX_FIXED_BASE+0] = NULL,
170 [PA_RESAMPLER_SPEEX_FIXED_BASE+1] = NULL,
171 [PA_RESAMPLER_SPEEX_FIXED_BASE+2] = NULL,
172 [PA_RESAMPLER_SPEEX_FIXED_BASE+3] = NULL,
173 [PA_RESAMPLER_SPEEX_FIXED_BASE+4] = NULL,
174 [PA_RESAMPLER_SPEEX_FIXED_BASE+5] = NULL,
175 [PA_RESAMPLER_SPEEX_FIXED_BASE+6] = NULL,
176 [PA_RESAMPLER_SPEEX_FIXED_BASE+7] = NULL,
177 [PA_RESAMPLER_SPEEX_FIXED_BASE+8] = NULL,
178 [PA_RESAMPLER_SPEEX_FIXED_BASE+9] = NULL,
179 [PA_RESAMPLER_SPEEX_FIXED_BASE+10] = NULL,
180 #endif
181 [PA_RESAMPLER_FFMPEG] = ffmpeg_init,
182 [PA_RESAMPLER_AUTO] = NULL,
183 [PA_RESAMPLER_COPY] = copy_init,
184 [PA_RESAMPLER_PEAKS] = peaks_init,
185 };
186
187 static pa_resample_method_t choose_auto_resampler(pa_resample_flags_t flags) {
188 pa_resample_method_t method;
189
190 if (pa_resample_method_supported(PA_RESAMPLER_SPEEX_FLOAT_BASE + 1))
191 method = PA_RESAMPLER_SPEEX_FLOAT_BASE + 1;
192 else if (flags & PA_RESAMPLER_VARIABLE_RATE)
193 method = PA_RESAMPLER_TRIVIAL;
194 else
195 method = PA_RESAMPLER_FFMPEG;
196
197 return method;
198 }
199
200 static pa_resample_method_t pa_resampler_fix_method(
201 pa_resample_flags_t flags,
202 pa_resample_method_t method,
203 const uint32_t rate_a,
204 const uint32_t rate_b) {
205
206 pa_assert(pa_sample_rate_valid(rate_a));
207 pa_assert(pa_sample_rate_valid(rate_b));
208 pa_assert(method >= 0);
209 pa_assert(method < PA_RESAMPLER_MAX);
210
211 if (!(flags & PA_RESAMPLER_VARIABLE_RATE) && rate_a == rate_b) {
212 pa_log_info("Forcing resampler 'copy', because of fixed, identical sample rates.");
213 method = PA_RESAMPLER_COPY;
214 }
215
216 if (!pa_resample_method_supported(method)) {
217 pa_log_warn("Support for resampler '%s' not compiled in, reverting to 'auto'.", pa_resample_method_to_string(method));
218 method = PA_RESAMPLER_AUTO;
219 }
220
221 switch (method) {
222 case PA_RESAMPLER_COPY:
223 if (rate_a != rate_b) {
224 pa_log_info("Resampler 'copy' cannot change sampling rate, reverting to resampler 'auto'.");
225 method = PA_RESAMPLER_AUTO;
226 break;
227 }
228 /* Else fall through */
229 case PA_RESAMPLER_FFMPEG:
230 if (flags & PA_RESAMPLER_VARIABLE_RATE) {
231 pa_log_info("Resampler '%s' cannot do variable rate, reverting to resampler 'auto'.", pa_resample_method_to_string(method));
232 method = PA_RESAMPLER_AUTO;
233 }
234 break;
235
236 /* The Peaks resampler only supports downsampling.
237 * Revert to auto if we are upsampling */
238 case PA_RESAMPLER_PEAKS:
239 if (rate_a < rate_b) {
240 pa_log_warn("The 'peaks' resampler only supports downsampling, reverting to resampler 'auto'.");
241 method = PA_RESAMPLER_AUTO;
242 }
243 break;
244
245 default:
246 break;
247 }
248
249 if (method == PA_RESAMPLER_AUTO)
250 method = choose_auto_resampler(flags);
251
252 return method;
253 }
254
255 /* Return true if a is a more precise sample format than b, else return false */
256 static bool sample_format_more_precise(pa_sample_format_t a, pa_sample_format_t b) {
257 pa_assert(pa_sample_format_valid(a));
258 pa_assert(pa_sample_format_valid(b));
259
260 switch (a) {
261 case PA_SAMPLE_U8:
262 case PA_SAMPLE_ALAW:
263 case PA_SAMPLE_ULAW:
264 return false;
265 break;
266
267 case PA_SAMPLE_S16LE:
268 case PA_SAMPLE_S16BE:
269 if (b == PA_SAMPLE_ULAW || b == PA_SAMPLE_ALAW || b == PA_SAMPLE_U8)
270 return true;
271 else
272 return false;
273 break;
274
275 case PA_SAMPLE_S24LE:
276 case PA_SAMPLE_S24BE:
277 case PA_SAMPLE_S24_32LE:
278 case PA_SAMPLE_S24_32BE:
279 if (b == PA_SAMPLE_ULAW || b == PA_SAMPLE_ALAW || b == PA_SAMPLE_U8 ||
280 b == PA_SAMPLE_S16LE || b == PA_SAMPLE_S16BE)
281 return true;
282 else
283 return false;
284 break;
285
286 case PA_SAMPLE_FLOAT32LE:
287 case PA_SAMPLE_FLOAT32BE:
288 case PA_SAMPLE_S32LE:
289 case PA_SAMPLE_S32BE:
290 if (b == PA_SAMPLE_FLOAT32LE || b == PA_SAMPLE_FLOAT32BE ||
291 b == PA_SAMPLE_S32LE || b == PA_SAMPLE_FLOAT32BE)
292 return false;
293 else
294 return true;
295 break;
296
297 default:
298 return false;
299 }
300 }
301
302 static pa_sample_format_t pa_resampler_choose_work_format(
303 pa_resample_method_t method,
304 pa_sample_format_t a,
305 pa_sample_format_t b,
306 bool map_required) {
307 pa_sample_format_t work_format;
308
309 pa_assert(pa_sample_format_valid(a));
310 pa_assert(pa_sample_format_valid(b));
311 pa_assert(method >= 0);
312 pa_assert(method < PA_RESAMPLER_MAX);
313
314 if (method >= PA_RESAMPLER_SPEEX_FIXED_BASE && method <= PA_RESAMPLER_SPEEX_FIXED_MAX)
315 method = PA_RESAMPLER_SPEEX_FIXED_BASE;
316
317 switch (method) {
318 /* This block is for resampling functions that only
319 * support the S16 sample format. */
320 case PA_RESAMPLER_SPEEX_FIXED_BASE: /* fall through */
321 case PA_RESAMPLER_FFMPEG:
322 work_format = PA_SAMPLE_S16NE;
323 break;
324
325 /* This block is for resampling functions that support
326 * any sample format. */
327 case PA_RESAMPLER_COPY: /* fall through */
328 case PA_RESAMPLER_TRIVIAL:
329 if (!map_required && a == b) {
330 work_format = a;
331 break;
332 }
333 /* Else fall trough */
334 case PA_RESAMPLER_PEAKS:
335 if (a == PA_SAMPLE_S16NE || b == PA_SAMPLE_S16NE)
336 work_format = PA_SAMPLE_S16NE;
337 else if (sample_format_more_precise(a, PA_SAMPLE_S16NE) ||
338 sample_format_more_precise(b, PA_SAMPLE_S16NE))
339 work_format = PA_SAMPLE_FLOAT32NE;
340 else
341 work_format = PA_SAMPLE_S16NE;
342 break;
343
344 default:
345 work_format = PA_SAMPLE_FLOAT32NE;
346 }
347
348 return work_format;
349 }
350
351 pa_resampler* pa_resampler_new(
352 pa_mempool *pool,
353 const pa_sample_spec *a,
354 const pa_channel_map *am,
355 const pa_sample_spec *b,
356 const pa_channel_map *bm,
357 pa_resample_method_t method,
358 pa_resample_flags_t flags) {
359
360 pa_resampler *r = NULL;
361
362 pa_assert(pool);
363 pa_assert(a);
364 pa_assert(b);
365 pa_assert(pa_sample_spec_valid(a));
366 pa_assert(pa_sample_spec_valid(b));
367 pa_assert(method >= 0);
368 pa_assert(method < PA_RESAMPLER_MAX);
369
370 method = pa_resampler_fix_method(flags, method, a->rate, b->rate);
371
372 r = pa_xnew0(pa_resampler, 1);
373 r->mempool = pool;
374 r->method = method;
375 r->flags = flags;
376
377 /* Fill sample specs */
378 r->i_ss = *a;
379 r->o_ss = *b;
380
381 /* set up the remap structure */
382 r->remap.i_ss = &r->i_ss;
383 r->remap.o_ss = &r->o_ss;
384 r->remap.format = &r->work_format;
385
386 if (am)
387 r->i_cm = *am;
388 else if (!pa_channel_map_init_auto(&r->i_cm, r->i_ss.channels, PA_CHANNEL_MAP_DEFAULT))
389 goto fail;
390
391 if (bm)
392 r->o_cm = *bm;
393 else if (!pa_channel_map_init_auto(&r->o_cm, r->o_ss.channels, PA_CHANNEL_MAP_DEFAULT))
394 goto fail;
395
396 r->i_fz = pa_frame_size(a);
397 r->o_fz = pa_frame_size(b);
398
399 calc_map_table(r);
400
401 pa_log_info("Using resampler '%s'", pa_resample_method_to_string(method));
402
403 r->work_format = pa_resampler_choose_work_format(method, a->format, b->format, r->map_required);
404
405 pa_log_info("Using %s as working format.", pa_sample_format_to_string(r->work_format));
406
407 r->w_sz = pa_sample_size_of_format(r->work_format);
408
409 if (r->i_ss.format != r->work_format) {
410 if (r->work_format == PA_SAMPLE_FLOAT32NE) {
411 if (!(r->to_work_format_func = pa_get_convert_to_float32ne_function(r->i_ss.format)))
412 goto fail;
413 } else {
414 pa_assert(r->work_format == PA_SAMPLE_S16NE);
415 if (!(r->to_work_format_func = pa_get_convert_to_s16ne_function(r->i_ss.format)))
416 goto fail;
417 }
418 }
419
420 if (r->o_ss.format != r->work_format) {
421 if (r->work_format == PA_SAMPLE_FLOAT32NE) {
422 if (!(r->from_work_format_func = pa_get_convert_from_float32ne_function(r->o_ss.format)))
423 goto fail;
424 } else {
425 pa_assert(r->work_format == PA_SAMPLE_S16NE);
426 if (!(r->from_work_format_func = pa_get_convert_from_s16ne_function(r->o_ss.format)))
427 goto fail;
428 }
429 }
430
431 /* leftover buffer is the buffer before the resampling stage */
432 r->leftover_buf = &r->remap_buf;
433 r->leftover_buf_size = &r->remap_buf_size;
434 r->have_leftover = &r->leftover_in_remap;
435
436 r->work_channels = r->o_ss.channels;
437 r->w_fz = pa_sample_size_of_format(r->work_format) * r->work_channels;
438
439 /* initialize implementation */
440 if (init_table[method](r) < 0)
441 goto fail;
442
443 return r;
444
445 fail:
446 pa_xfree(r);
447
448 return NULL;
449 }
450
451 void pa_resampler_free(pa_resampler *r) {
452 pa_assert(r);
453
454 if (r->impl.free)
455 r->impl.free(r);
456 else
457 pa_xfree(r->impl.data);
458
459 if (r->to_work_format_buf.memblock)
460 pa_memblock_unref(r->to_work_format_buf.memblock);
461 if (r->remap_buf.memblock)
462 pa_memblock_unref(r->remap_buf.memblock);
463 if (r->resample_buf.memblock)
464 pa_memblock_unref(r->resample_buf.memblock);
465 if (r->from_work_format_buf.memblock)
466 pa_memblock_unref(r->from_work_format_buf.memblock);
467
468 pa_xfree(r);
469 }
470
471 void pa_resampler_set_input_rate(pa_resampler *r, uint32_t rate) {
472 pa_assert(r);
473 pa_assert(rate > 0);
474 pa_assert(r->impl.update_rates);
475
476 if (r->i_ss.rate == rate)
477 return;
478
479 r->i_ss.rate = rate;
480
481 r->impl.update_rates(r);
482 }
483
484 void pa_resampler_set_output_rate(pa_resampler *r, uint32_t rate) {
485 pa_assert(r);
486 pa_assert(rate > 0);
487 pa_assert(r->impl.update_rates);
488
489 if (r->o_ss.rate == rate)
490 return;
491
492 r->o_ss.rate = rate;
493
494 r->impl.update_rates(r);
495 }
496
497 size_t pa_resampler_request(pa_resampler *r, size_t out_length) {
498 pa_assert(r);
499
500 /* Let's round up here to make it more likely that the caller will get at
501 * least out_length amount of data from pa_resampler_run().
502 *
503 * We don't take the leftover into account here. If we did, then it might
504 * be in theory possible that this function would return 0 and
505 * pa_resampler_run() would also return 0. That could lead to infinite
506 * loops. When the leftover is ignored here, such loops would eventually
507 * terminate, because the leftover would grow each round, finally
508 * surpassing the minimum input threshold of the resampler. */
509 return ((((uint64_t) ((out_length + r->o_fz-1) / r->o_fz) * r->i_ss.rate) + r->o_ss.rate-1) / r->o_ss.rate) * r->i_fz;
510 }
511
512 size_t pa_resampler_result(pa_resampler *r, size_t in_length) {
513 size_t frames;
514
515 pa_assert(r);
516
517 /* Let's round up here to ensure that the caller will always allocate big
518 * enough output buffer. */
519
520 frames = (in_length + r->i_fz - 1) / r->i_fz;
521 if (*r->have_leftover)
522 frames += r->leftover_buf->length / r->w_fz;
523
524 return (((uint64_t) frames * r->o_ss.rate + r->i_ss.rate - 1) / r->i_ss.rate) * r->o_fz;
525 }
526
527 size_t pa_resampler_max_block_size(pa_resampler *r) {
528 size_t block_size_max;
529 pa_sample_spec max_ss;
530 size_t max_fs;
531 size_t frames;
532
533 pa_assert(r);
534
535 block_size_max = pa_mempool_block_size_max(r->mempool);
536
537 /* We deduce the "largest" sample spec we're using during the
538 * conversion */
539 max_ss.channels = (uint8_t) (PA_MAX(r->i_ss.channels, r->o_ss.channels));
540
541 /* We silently assume that the format enum is ordered by size */
542 max_ss.format = PA_MAX(r->i_ss.format, r->o_ss.format);
543 max_ss.format = PA_MAX(max_ss.format, r->work_format);
544
545 max_ss.rate = PA_MAX(r->i_ss.rate, r->o_ss.rate);
546
547 max_fs = pa_frame_size(&max_ss);
548 frames = block_size_max / max_fs - EXTRA_FRAMES;
549
550 pa_assert(frames >= (r->leftover_buf->length / r->w_fz));
551 if (*r->have_leftover)
552 frames -= r->leftover_buf->length / r->w_fz;
553
554 block_size_max = ((uint64_t) frames * r->i_ss.rate / max_ss.rate) * r->i_fz;
555
556 if (block_size_max > 0)
557 return block_size_max;
558 else
559 /* A single input frame may result in so much output that it doesn't
560 * fit in one standard memblock (e.g. converting 1 Hz to 44100 Hz). In
561 * this case the max block size will be set to one frame, and some
562 * memory will be probably be allocated with malloc() instead of using
563 * the memory pool.
564 *
565 * XXX: Should we support this case at all? We could also refuse to
566 * create resamplers whose max block size would exceed the memory pool
567 * block size. In this case also updating the resampler rate should
568 * fail if the new rate would cause an excessive max block size (in
569 * which case the stream would probably have to be killed). */
570 return r->i_fz;
571 }
572
573 void pa_resampler_reset(pa_resampler *r) {
574 pa_assert(r);
575
576 if (r->impl.reset)
577 r->impl.reset(r);
578
579 *r->have_leftover = false;
580 }
581
582 pa_resample_method_t pa_resampler_get_method(pa_resampler *r) {
583 pa_assert(r);
584
585 return r->method;
586 }
587
588 const pa_channel_map* pa_resampler_input_channel_map(pa_resampler *r) {
589 pa_assert(r);
590
591 return &r->i_cm;
592 }
593
594 const pa_sample_spec* pa_resampler_input_sample_spec(pa_resampler *r) {
595 pa_assert(r);
596
597 return &r->i_ss;
598 }
599
600 const pa_channel_map* pa_resampler_output_channel_map(pa_resampler *r) {
601 pa_assert(r);
602
603 return &r->o_cm;
604 }
605
606 const pa_sample_spec* pa_resampler_output_sample_spec(pa_resampler *r) {
607 pa_assert(r);
608
609 return &r->o_ss;
610 }
611
612 static const char * const resample_methods[] = {
613 "src-sinc-best-quality",
614 "src-sinc-medium-quality",
615 "src-sinc-fastest",
616 "src-zero-order-hold",
617 "src-linear",
618 "trivial",
619 "speex-float-0",
620 "speex-float-1",
621 "speex-float-2",
622 "speex-float-3",
623 "speex-float-4",
624 "speex-float-5",
625 "speex-float-6",
626 "speex-float-7",
627 "speex-float-8",
628 "speex-float-9",
629 "speex-float-10",
630 "speex-fixed-0",
631 "speex-fixed-1",
632 "speex-fixed-2",
633 "speex-fixed-3",
634 "speex-fixed-4",
635 "speex-fixed-5",
636 "speex-fixed-6",
637 "speex-fixed-7",
638 "speex-fixed-8",
639 "speex-fixed-9",
640 "speex-fixed-10",
641 "ffmpeg",
642 "auto",
643 "copy",
644 "peaks"
645 };
646
647 const char *pa_resample_method_to_string(pa_resample_method_t m) {
648
649 if (m < 0 || m >= PA_RESAMPLER_MAX)
650 return NULL;
651
652 return resample_methods[m];
653 }
654
655 int pa_resample_method_supported(pa_resample_method_t m) {
656
657 if (m < 0 || m >= PA_RESAMPLER_MAX)
658 return 0;
659
660 #ifndef HAVE_LIBSAMPLERATE
661 if (m <= PA_RESAMPLER_SRC_LINEAR)
662 return 0;
663 #endif
664
665 #ifndef HAVE_SPEEX
666 if (m >= PA_RESAMPLER_SPEEX_FLOAT_BASE && m <= PA_RESAMPLER_SPEEX_FLOAT_MAX)
667 return 0;
668 if (m >= PA_RESAMPLER_SPEEX_FIXED_BASE && m <= PA_RESAMPLER_SPEEX_FIXED_MAX)
669 return 0;
670 #endif
671
672 return 1;
673 }
674
675 pa_resample_method_t pa_parse_resample_method(const char *string) {
676 pa_resample_method_t m;
677
678 pa_assert(string);
679
680 for (m = 0; m < PA_RESAMPLER_MAX; m++)
681 if (pa_streq(string, resample_methods[m]))
682 return m;
683
684 if (pa_streq(string, "speex-fixed"))
685 return PA_RESAMPLER_SPEEX_FIXED_BASE + 1;
686
687 if (pa_streq(string, "speex-float"))
688 return PA_RESAMPLER_SPEEX_FLOAT_BASE + 1;
689
690 return PA_RESAMPLER_INVALID;
691 }
692
693 static bool on_left(pa_channel_position_t p) {
694
695 return
696 p == PA_CHANNEL_POSITION_FRONT_LEFT ||
697 p == PA_CHANNEL_POSITION_REAR_LEFT ||
698 p == PA_CHANNEL_POSITION_FRONT_LEFT_OF_CENTER ||
699 p == PA_CHANNEL_POSITION_SIDE_LEFT ||
700 p == PA_CHANNEL_POSITION_TOP_FRONT_LEFT ||
701 p == PA_CHANNEL_POSITION_TOP_REAR_LEFT;
702 }
703
704 static bool on_right(pa_channel_position_t p) {
705
706 return
707 p == PA_CHANNEL_POSITION_FRONT_RIGHT ||
708 p == PA_CHANNEL_POSITION_REAR_RIGHT ||
709 p == PA_CHANNEL_POSITION_FRONT_RIGHT_OF_CENTER ||
710 p == PA_CHANNEL_POSITION_SIDE_RIGHT ||
711 p == PA_CHANNEL_POSITION_TOP_FRONT_RIGHT ||
712 p == PA_CHANNEL_POSITION_TOP_REAR_RIGHT;
713 }
714
715 static bool on_center(pa_channel_position_t p) {
716
717 return
718 p == PA_CHANNEL_POSITION_FRONT_CENTER ||
719 p == PA_CHANNEL_POSITION_REAR_CENTER ||
720 p == PA_CHANNEL_POSITION_TOP_CENTER ||
721 p == PA_CHANNEL_POSITION_TOP_FRONT_CENTER ||
722 p == PA_CHANNEL_POSITION_TOP_REAR_CENTER;
723 }
724
725 static bool on_lfe(pa_channel_position_t p) {
726 return
727 p == PA_CHANNEL_POSITION_LFE;
728 }
729
730 static bool on_front(pa_channel_position_t p) {
731 return
732 p == PA_CHANNEL_POSITION_FRONT_LEFT ||
733 p == PA_CHANNEL_POSITION_FRONT_RIGHT ||
734 p == PA_CHANNEL_POSITION_FRONT_CENTER ||
735 p == PA_CHANNEL_POSITION_TOP_FRONT_LEFT ||
736 p == PA_CHANNEL_POSITION_TOP_FRONT_RIGHT ||
737 p == PA_CHANNEL_POSITION_TOP_FRONT_CENTER ||
738 p == PA_CHANNEL_POSITION_FRONT_LEFT_OF_CENTER ||
739 p == PA_CHANNEL_POSITION_FRONT_RIGHT_OF_CENTER;
740 }
741
742 static bool on_rear(pa_channel_position_t p) {
743 return
744 p == PA_CHANNEL_POSITION_REAR_LEFT ||
745 p == PA_CHANNEL_POSITION_REAR_RIGHT ||
746 p == PA_CHANNEL_POSITION_REAR_CENTER ||
747 p == PA_CHANNEL_POSITION_TOP_REAR_LEFT ||
748 p == PA_CHANNEL_POSITION_TOP_REAR_RIGHT ||
749 p == PA_CHANNEL_POSITION_TOP_REAR_CENTER;
750 }
751
752 static bool on_side(pa_channel_position_t p) {
753 return
754 p == PA_CHANNEL_POSITION_SIDE_LEFT ||
755 p == PA_CHANNEL_POSITION_SIDE_RIGHT ||
756 p == PA_CHANNEL_POSITION_TOP_CENTER;
757 }
758
759 enum {
760 ON_FRONT,
761 ON_REAR,
762 ON_SIDE,
763 ON_OTHER
764 };
765
766 static int front_rear_side(pa_channel_position_t p) {
767 if (on_front(p))
768 return ON_FRONT;
769 if (on_rear(p))
770 return ON_REAR;
771 if (on_side(p))
772 return ON_SIDE;
773 return ON_OTHER;
774 }
775
776 static void calc_map_table(pa_resampler *r) {
777 unsigned oc, ic;
778 unsigned n_oc, n_ic;
779 bool ic_connected[PA_CHANNELS_MAX];
780 bool remix;
781 pa_strbuf *s;
782 char *t;
783 pa_remap_t *m;
784
785 pa_assert(r);
786
787 if (!(r->map_required = (r->i_ss.channels != r->o_ss.channels || (!(r->flags & PA_RESAMPLER_NO_REMAP) && !pa_channel_map_equal(&r->i_cm, &r->o_cm)))))
788 return;
789
790 m = &r->remap;
791
792 n_oc = r->o_ss.channels;
793 n_ic = r->i_ss.channels;
794
795 memset(m->map_table_f, 0, sizeof(m->map_table_f));
796 memset(m->map_table_i, 0, sizeof(m->map_table_i));
797
798 memset(ic_connected, 0, sizeof(ic_connected));
799 remix = (r->flags & (PA_RESAMPLER_NO_REMAP | PA_RESAMPLER_NO_REMIX)) == 0;
800
801 if (r->flags & PA_RESAMPLER_NO_REMAP) {
802 pa_assert(!remix);
803
804 for (oc = 0; oc < PA_MIN(n_ic, n_oc); oc++)
805 m->map_table_f[oc][oc] = 1.0f;
806
807 } else if (r->flags & PA_RESAMPLER_NO_REMIX) {
808 pa_assert(!remix);
809 for (oc = 0; oc < n_oc; oc++) {
810 pa_channel_position_t b = r->o_cm.map[oc];
811
812 for (ic = 0; ic < n_ic; ic++) {
813 pa_channel_position_t a = r->i_cm.map[ic];
814
815 /* We shall not do any remixing. Hence, just check by name */
816 if (a == b)
817 m->map_table_f[oc][ic] = 1.0f;
818 }
819 }
820 } else {
821
822 /* OK, we shall do the full monty: upmixing and downmixing. Our
823 * algorithm is relatively simple, does not do spacialization, delay
824 * elements or apply lowpass filters for LFE. Patches are always
825 * welcome, though. Oh, and it doesn't do any matrix decoding. (Which
826 * probably wouldn't make any sense anyway.)
827 *
828 * This code is not idempotent: downmixing an upmixed stereo stream is
829 * not identical to the original. The volume will not match, and the
830 * two channels will be a linear combination of both.
831 *
832 * This is loosely based on random suggestions found on the Internet,
833 * such as this:
834 * http://www.halfgaar.net/surround-sound-in-linux and the alsa upmix
835 * plugin.
836 *
837 * The algorithm works basically like this:
838 *
839 * 1) Connect all channels with matching names.
840 *
841 * 2) Mono Handling:
842 * S:Mono: Copy into all D:channels
843 * D:Mono: Avg all S:channels
844 *
845 * 3) Mix D:Left, D:Right:
846 * D:Left: If not connected, avg all S:Left
847 * D:Right: If not connected, avg all S:Right
848 *
849 * 4) Mix D:Center
850 * If not connected, avg all S:Center
851 * If still not connected, avg all S:Left, S:Right
852 *
853 * 5) Mix D:LFE
854 * If not connected, avg all S:*
855 *
856 * 6) Make sure S:Left/S:Right is used: S:Left/S:Right: If not
857 * connected, mix into all D:left and all D:right channels. Gain is
858 * 1/9.
859 *
860 * 7) Make sure S:Center, S:LFE is used:
861 *
862 * S:Center, S:LFE: If not connected, mix into all D:left, all
863 * D:right, all D:center channels. Gain is 0.5 for center and 0.375
864 * for LFE. C-front is only mixed into L-front/R-front if available,
865 * otherwise into all L/R channels. Similarly for C-rear.
866 *
867 * 8) Normalize each row in the matrix such that the sum for each row is
868 * not larger than 1.0 in order to avoid clipping.
869 *
870 * S: and D: shall relate to the source resp. destination channels.
871 *
872 * Rationale: 1, 2 are probably obvious. For 3: this copies front to
873 * rear if needed. For 4: we try to find some suitable C source for C,
874 * if we don't find any, we avg L and R. For 5: LFE is mixed from all
875 * channels. For 6: the rear channels should not be dropped entirely,
876 * however have only minimal impact. For 7: movies usually encode
877 * speech on the center channel. Thus we have to make sure this channel
878 * is distributed to L and R if not available in the output. Also, LFE
879 * is used to achieve a greater dynamic range, and thus we should try
880 * to do our best to pass it to L+R.
881 */
882
883 unsigned
884 ic_left = 0,
885 ic_right = 0,
886 ic_center = 0,
887 ic_unconnected_left = 0,
888 ic_unconnected_right = 0,
889 ic_unconnected_center = 0,
890 ic_unconnected_lfe = 0;
891 bool ic_unconnected_center_mixed_in = 0;
892
893 pa_assert(remix);
894
895 for (ic = 0; ic < n_ic; ic++) {
896 if (on_left(r->i_cm.map[ic]))
897 ic_left++;
898 if (on_right(r->i_cm.map[ic]))
899 ic_right++;
900 if (on_center(r->i_cm.map[ic]))
901 ic_center++;
902 }
903
904 for (oc = 0; oc < n_oc; oc++) {
905 bool oc_connected = false;
906 pa_channel_position_t b = r->o_cm.map[oc];
907
908 for (ic = 0; ic < n_ic; ic++) {
909 pa_channel_position_t a = r->i_cm.map[ic];
910
911 if (a == b || a == PA_CHANNEL_POSITION_MONO) {
912 m->map_table_f[oc][ic] = 1.0f;
913
914 oc_connected = true;
915 ic_connected[ic] = true;
916 }
917 else if (b == PA_CHANNEL_POSITION_MONO) {
918 m->map_table_f[oc][ic] = 1.0f / (float) n_ic;
919
920 oc_connected = true;
921 ic_connected[ic] = true;
922 }
923 }
924
925 if (!oc_connected) {
926 /* Try to find matching input ports for this output port */
927
928 if (on_left(b)) {
929
930 /* We are not connected and on the left side, let's
931 * average all left side input channels. */
932
933 if (ic_left > 0)
934 for (ic = 0; ic < n_ic; ic++)
935 if (on_left(r->i_cm.map[ic])) {
936 m->map_table_f[oc][ic] = 1.0f / (float) ic_left;
937 ic_connected[ic] = true;
938 }
939
940 /* We ignore the case where there is no left input channel.
941 * Something is really wrong in this case anyway. */
942
943 } else if (on_right(b)) {
944
945 /* We are not connected and on the right side, let's
946 * average all right side input channels. */
947
948 if (ic_right > 0)
949 for (ic = 0; ic < n_ic; ic++)
950 if (on_right(r->i_cm.map[ic])) {
951 m->map_table_f[oc][ic] = 1.0f / (float) ic_right;
952 ic_connected[ic] = true;
953 }
954
955 /* We ignore the case where there is no right input
956 * channel. Something is really wrong in this case anyway.
957 * */
958
959 } else if (on_center(b)) {
960
961 if (ic_center > 0) {
962
963 /* We are not connected and at the center. Let's average
964 * all center input channels. */
965
966 for (ic = 0; ic < n_ic; ic++)
967 if (on_center(r->i_cm.map[ic])) {
968 m->map_table_f[oc][ic] = 1.0f / (float) ic_center;
969 ic_connected[ic] = true;
970 }
971
972 } else if (ic_left + ic_right > 0) {
973
974 /* Hmm, no center channel around, let's synthesize it
975 * by mixing L and R.*/
976
977 for (ic = 0; ic < n_ic; ic++)
978 if (on_left(r->i_cm.map[ic]) || on_right(r->i_cm.map[ic])) {
979 m->map_table_f[oc][ic] = 1.0f / (float) (ic_left + ic_right);
980 ic_connected[ic] = true;
981 }
982 }
983
984 /* We ignore the case where there is not even a left or
985 * right input channel. Something is really wrong in this
986 * case anyway. */
987
988 } else if (on_lfe(b) && !(r->flags & PA_RESAMPLER_NO_LFE)) {
989
990 /* We are not connected and an LFE. Let's average all
991 * channels for LFE. */
992
993 for (ic = 0; ic < n_ic; ic++)
994 m->map_table_f[oc][ic] = 1.0f / (float) n_ic;
995
996 /* Please note that a channel connected to LFE doesn't
997 * really count as connected. */
998 }
999 }
1000 }
1001
1002 for (ic = 0; ic < n_ic; ic++) {
1003 pa_channel_position_t a = r->i_cm.map[ic];
1004
1005 if (ic_connected[ic])
1006 continue;
1007
1008 if (on_left(a))
1009 ic_unconnected_left++;
1010 else if (on_right(a))
1011 ic_unconnected_right++;
1012 else if (on_center(a))
1013 ic_unconnected_center++;
1014 else if (on_lfe(a))
1015 ic_unconnected_lfe++;
1016 }
1017
1018 for (ic = 0; ic < n_ic; ic++) {
1019 pa_channel_position_t a = r->i_cm.map[ic];
1020
1021 if (ic_connected[ic])
1022 continue;
1023
1024 for (oc = 0; oc < n_oc; oc++) {
1025 pa_channel_position_t b = r->o_cm.map[oc];
1026
1027 if (on_left(a) && on_left(b))
1028 m->map_table_f[oc][ic] = (1.f/9.f) / (float) ic_unconnected_left;
1029
1030 else if (on_right(a) && on_right(b))
1031 m->map_table_f[oc][ic] = (1.f/9.f) / (float) ic_unconnected_right;
1032
1033 else if (on_center(a) && on_center(b)) {
1034 m->map_table_f[oc][ic] = (1.f/9.f) / (float) ic_unconnected_center;
1035 ic_unconnected_center_mixed_in = true;
1036
1037 } else if (on_lfe(a) && !(r->flags & PA_RESAMPLER_NO_LFE))
1038 m->map_table_f[oc][ic] = .375f / (float) ic_unconnected_lfe;
1039 }
1040 }
1041
1042 if (ic_unconnected_center > 0 && !ic_unconnected_center_mixed_in) {
1043 unsigned ncenter[PA_CHANNELS_MAX];
1044 bool found_frs[PA_CHANNELS_MAX];
1045
1046 memset(ncenter, 0, sizeof(ncenter));
1047 memset(found_frs, 0, sizeof(found_frs));
1048
1049 /* Hmm, as it appears there was no center channel we
1050 could mix our center channel in. In this case, mix it into
1051 left and right. Using .5 as the factor. */
1052
1053 for (ic = 0; ic < n_ic; ic++) {
1054
1055 if (ic_connected[ic])
1056 continue;
1057
1058 if (!on_center(r->i_cm.map[ic]))
1059 continue;
1060
1061 for (oc = 0; oc < n_oc; oc++) {
1062
1063 if (!on_left(r->o_cm.map[oc]) && !on_right(r->o_cm.map[oc]))
1064 continue;
1065
1066 if (front_rear_side(r->i_cm.map[ic]) == front_rear_side(r->o_cm.map[oc])) {
1067 found_frs[ic] = true;
1068 break;
1069 }
1070 }
1071
1072 for (oc = 0; oc < n_oc; oc++) {
1073
1074 if (!on_left(r->o_cm.map[oc]) && !on_right(r->o_cm.map[oc]))
1075 continue;
1076
1077 if (!found_frs[ic] || front_rear_side(r->i_cm.map[ic]) == front_rear_side(r->o_cm.map[oc]))
1078 ncenter[oc]++;
1079 }
1080 }
1081
1082 for (oc = 0; oc < n_oc; oc++) {
1083
1084 if (!on_left(r->o_cm.map[oc]) && !on_right(r->o_cm.map[oc]))
1085 continue;
1086
1087 if (ncenter[oc] <= 0)
1088 continue;
1089
1090 for (ic = 0; ic < n_ic; ic++) {
1091
1092 if (!on_center(r->i_cm.map[ic]))
1093 continue;
1094
1095 if (!found_frs[ic] || front_rear_side(r->i_cm.map[ic]) == front_rear_side(r->o_cm.map[oc]))
1096 m->map_table_f[oc][ic] = .5f / (float) ncenter[oc];
1097 }
1098 }
1099 }
1100 }
1101
1102 for (oc = 0; oc < n_oc; oc++) {
1103 float sum = 0.0f;
1104 for (ic = 0; ic < n_ic; ic++)
1105 sum += m->map_table_f[oc][ic];
1106
1107 if (sum > 1.0f)
1108 for (ic = 0; ic < n_ic; ic++)
1109 m->map_table_f[oc][ic] /= sum;
1110 }
1111
1112 /* make an 16:16 int version of the matrix */
1113 for (oc = 0; oc < n_oc; oc++)
1114 for (ic = 0; ic < n_ic; ic++)
1115 m->map_table_i[oc][ic] = (int32_t) (m->map_table_f[oc][ic] * 0x10000);
1116
1117 s = pa_strbuf_new();
1118
1119 pa_strbuf_printf(s, " ");
1120 for (ic = 0; ic < n_ic; ic++)
1121 pa_strbuf_printf(s, " I%02u ", ic);
1122 pa_strbuf_puts(s, "\n +");
1123
1124 for (ic = 0; ic < n_ic; ic++)
1125 pa_strbuf_printf(s, "------");
1126 pa_strbuf_puts(s, "\n");
1127
1128 for (oc = 0; oc < n_oc; oc++) {
1129 pa_strbuf_printf(s, "O%02u |", oc);
1130
1131 for (ic = 0; ic < n_ic; ic++)
1132 pa_strbuf_printf(s, " %1.3f", m->map_table_f[oc][ic]);
1133
1134 pa_strbuf_puts(s, "\n");
1135 }
1136
1137 pa_log_debug("Channel matrix:\n%s", t = pa_strbuf_tostring_free(s));
1138 pa_xfree(t);
1139
1140 /* initialize the remapping function */
1141 pa_init_remap(m);
1142 }
1143
1144 /* check if buf's memblock is large enough to hold 'len' bytes; create a
1145 * new memblock if necessary and optionally preserve 'copy' data bytes */
1146 static void fit_buf(pa_resampler *r, pa_memchunk *buf, size_t len, size_t *size, size_t copy) {
1147 pa_assert(size);
1148
1149 if (!buf->memblock || len > *size) {
1150 pa_memblock *new_block = pa_memblock_new(r->mempool, len);
1151
1152 if (buf->memblock) {
1153 if (copy > 0) {
1154 void *src = pa_memblock_acquire(buf->memblock);
1155 void *dst = pa_memblock_acquire(new_block);
1156 pa_assert(copy <= len);
1157 memcpy(dst, src, copy);
1158 pa_memblock_release(new_block);
1159 pa_memblock_release(buf->memblock);
1160 }
1161
1162 pa_memblock_unref(buf->memblock);
1163 }
1164
1165 buf->memblock = new_block;
1166 *size = len;
1167 }
1168
1169 buf->length = len;
1170 }
1171
1172 static pa_memchunk* convert_to_work_format(pa_resampler *r, pa_memchunk *input) {
1173 unsigned in_n_samples, out_n_samples;
1174 void *src, *dst;
1175 bool have_leftover;
1176 size_t leftover_length = 0;
1177
1178 pa_assert(r);
1179 pa_assert(input);
1180 pa_assert(input->memblock);
1181
1182 /* Convert the incoming sample into the work sample format and place them
1183 * in to_work_format_buf. The leftover data is already converted, so it's
1184 * part of the output buffer. */
1185
1186 have_leftover = r->leftover_in_to_work;
1187 r->leftover_in_to_work = false;
1188
1189 if (!have_leftover && (!r->to_work_format_func || !input->length))
1190 return input;
1191 else if (input->length <= 0)
1192 return &r->to_work_format_buf;
1193
1194 in_n_samples = out_n_samples = (unsigned) ((input->length / r->i_fz) * r->i_ss.channels);
1195
1196 if (have_leftover) {
1197 leftover_length = r->to_work_format_buf.length;
1198 out_n_samples += (unsigned) (leftover_length / r->w_sz);
1199 }
1200
1201 fit_buf(r, &r->to_work_format_buf, r->w_sz * out_n_samples, &r->to_work_format_buf_size, leftover_length);
1202
1203 src = pa_memblock_acquire_chunk(input);
1204 dst = (uint8_t *) pa_memblock_acquire(r->to_work_format_buf.memblock) + leftover_length;
1205
1206 if (r->to_work_format_func)
1207 r->to_work_format_func(in_n_samples, src, dst);
1208 else
1209 memcpy(dst, src, input->length);
1210
1211 pa_memblock_release(input->memblock);
1212 pa_memblock_release(r->to_work_format_buf.memblock);
1213
1214 return &r->to_work_format_buf;
1215 }
1216
1217 static pa_memchunk *remap_channels(pa_resampler *r, pa_memchunk *input) {
1218 unsigned in_n_samples, out_n_samples, in_n_frames, out_n_frames;
1219 void *src, *dst;
1220 size_t leftover_length = 0;
1221 bool have_leftover;
1222
1223 pa_assert(r);
1224 pa_assert(input);
1225 pa_assert(input->memblock);
1226
1227 /* Remap channels and place the result in remap_buf. There may be leftover
1228 * data in the beginning of remap_buf. The leftover data is already
1229 * remapped, so it's not part of the input, it's part of the output. */
1230
1231 have_leftover = r->leftover_in_remap;
1232 r->leftover_in_remap = false;
1233
1234 if (!have_leftover && (!r->map_required || input->length <= 0))
1235 return input;
1236 else if (input->length <= 0)
1237 return &r->remap_buf;
1238
1239 in_n_samples = (unsigned) (input->length / r->w_sz);
1240 in_n_frames = out_n_frames = in_n_samples / r->i_ss.channels;
1241
1242 if (have_leftover) {
1243 leftover_length = r->remap_buf.length;
1244 out_n_frames += leftover_length / r->w_fz;
1245 }
1246
1247 out_n_samples = out_n_frames * r->o_ss.channels;
1248 fit_buf(r, &r->remap_buf, out_n_samples * r->w_sz, &r->remap_buf_size, leftover_length);
1249
1250 src = pa_memblock_acquire_chunk(input);
1251 dst = (uint8_t *) pa_memblock_acquire(r->remap_buf.memblock) + leftover_length;
1252
1253 if (r->map_required) {
1254 pa_remap_t *remap = &r->remap;
1255
1256 pa_assert(remap->do_remap);
1257 remap->do_remap(remap, dst, src, in_n_frames);
1258
1259 } else
1260 memcpy(dst, src, input->length);
1261
1262 pa_memblock_release(input->memblock);
1263 pa_memblock_release(r->remap_buf.memblock);
1264
1265 return &r->remap_buf;
1266 }
1267
1268 static void save_leftover(pa_resampler *r, void *buf, size_t len) {
1269 void *dst;
1270
1271 pa_assert(r);
1272 pa_assert(buf);
1273 pa_assert(len > 0);
1274
1275 /* Store the leftover data. */
1276 fit_buf(r, r->leftover_buf, len, r->leftover_buf_size, 0);
1277 *r->have_leftover = true;
1278
1279 dst = pa_memblock_acquire(r->leftover_buf->memblock);
1280 memmove(dst, buf, len);
1281 pa_memblock_release(r->leftover_buf->memblock);
1282 }
1283
1284 static pa_memchunk *resample(pa_resampler *r, pa_memchunk *input) {
1285 unsigned in_n_frames, out_n_frames, leftover_n_frames;
1286
1287 pa_assert(r);
1288 pa_assert(input);
1289
1290 /* Resample the data and place the result in resample_buf. */
1291
1292 if (!r->impl.resample || !input->length)
1293 return input;
1294
1295 in_n_frames = (unsigned) (input->length / r->w_fz);
1296
1297 out_n_frames = ((in_n_frames*r->o_ss.rate)/r->i_ss.rate)+EXTRA_FRAMES;
1298 fit_buf(r, &r->resample_buf, r->w_fz * out_n_frames, &r->resample_buf_size, 0);
1299
1300 leftover_n_frames = r->impl.resample(r, input, in_n_frames, &r->resample_buf, &out_n_frames);
1301
1302 if (leftover_n_frames > 0) {
1303 void *leftover_data = (uint8_t *) pa_memblock_acquire_chunk(input) + (in_n_frames - leftover_n_frames) * r->w_fz;
1304 save_leftover(r, leftover_data, leftover_n_frames * r->w_fz);
1305 pa_memblock_release(input->memblock);
1306 }
1307
1308 r->resample_buf.length = out_n_frames * r->w_fz;
1309
1310 return &r->resample_buf;
1311 }
1312
1313 static pa_memchunk *convert_from_work_format(pa_resampler *r, pa_memchunk *input) {
1314 unsigned n_samples, n_frames;
1315 void *src, *dst;
1316
1317 pa_assert(r);
1318 pa_assert(input);
1319
1320 /* Convert the data into the correct sample type and place the result in
1321 * from_work_format_buf. */
1322
1323 if (!r->from_work_format_func || !input->length)
1324 return input;
1325
1326 n_samples = (unsigned) (input->length / r->w_sz);
1327 n_frames = n_samples / r->o_ss.channels;
1328 fit_buf(r, &r->from_work_format_buf, r->o_fz * n_frames, &r->from_work_format_buf_size, 0);
1329
1330 src = pa_memblock_acquire_chunk(input);
1331 dst = pa_memblock_acquire(r->from_work_format_buf.memblock);
1332 r->from_work_format_func(n_samples, src, dst);
1333 pa_memblock_release(input->memblock);
1334 pa_memblock_release(r->from_work_format_buf.memblock);
1335
1336 return &r->from_work_format_buf;
1337 }
1338
1339 void pa_resampler_run(pa_resampler *r, const pa_memchunk *in, pa_memchunk *out) {
1340 pa_memchunk *buf;
1341
1342 pa_assert(r);
1343 pa_assert(in);
1344 pa_assert(out);
1345 pa_assert(in->length);
1346 pa_assert(in->memblock);
1347 pa_assert(in->length % r->i_fz == 0);
1348
1349 buf = (pa_memchunk*) in;
1350 buf = convert_to_work_format(r, buf);
1351 buf = remap_channels(r, buf);
1352 buf = resample(r, buf);
1353
1354 if (buf->length) {
1355 buf = convert_from_work_format(r, buf);
1356 *out = *buf;
1357
1358 if (buf == in)
1359 pa_memblock_ref(buf->memblock);
1360 else
1361 pa_memchunk_reset(buf);
1362 } else
1363 pa_memchunk_reset(out);
1364 }
1365
1366 /*** libsamplerate based implementation ***/
1367
1368 #ifdef HAVE_LIBSAMPLERATE
1369 static unsigned libsamplerate_resample(pa_resampler *r, const pa_memchunk *input, unsigned in_n_frames, pa_memchunk *output, unsigned *out_n_frames) {
1370 SRC_DATA data;
1371 SRC_STATE *state;
1372
1373 pa_assert(r);
1374 pa_assert(input);
1375 pa_assert(output);
1376 pa_assert(out_n_frames);
1377
1378 state = r->impl.data;
1379 memset(&data, 0, sizeof(data));
1380
1381 data.data_in = pa_memblock_acquire_chunk(input);
1382 data.input_frames = (long int) in_n_frames;
1383
1384 data.data_out = pa_memblock_acquire_chunk(output);
1385 data.output_frames = (long int) *out_n_frames;
1386
1387 data.src_ratio = (double) r->o_ss.rate / r->i_ss.rate;
1388 data.end_of_input = 0;
1389
1390 pa_assert_se(src_process(state, &data) == 0);
1391
1392 pa_memblock_release(input->memblock);
1393 pa_memblock_release(output->memblock);
1394
1395 *out_n_frames = (unsigned) data.output_frames_gen;
1396
1397 return in_n_frames - data.input_frames_used;
1398 }
1399
1400 static void libsamplerate_update_rates(pa_resampler *r) {
1401 SRC_STATE *state;
1402 pa_assert(r);
1403
1404 state = r->impl.data;
1405 pa_assert_se(src_set_ratio(state, (double) r->o_ss.rate / r->i_ss.rate) == 0);
1406 }
1407
1408 static void libsamplerate_reset(pa_resampler *r) {
1409 SRC_STATE *state;
1410 pa_assert(r);
1411
1412 state = r->impl.data;
1413 pa_assert_se(src_reset(state) == 0);
1414 }
1415
1416 static void libsamplerate_free(pa_resampler *r) {
1417 SRC_STATE *state;
1418 pa_assert(r);
1419
1420 state = r->impl.data;
1421 if (state)
1422 src_delete(state);
1423 }
1424
1425 static int libsamplerate_init(pa_resampler *r) {
1426 int err;
1427 SRC_STATE *state;
1428
1429 pa_assert(r);
1430
1431 if (!(state = src_new(r->method, r->work_channels, &err)))
1432 return -1;
1433
1434 r->impl.free = libsamplerate_free;
1435 r->impl.update_rates = libsamplerate_update_rates;
1436 r->impl.resample = libsamplerate_resample;
1437 r->impl.reset = libsamplerate_reset;
1438 r->impl.data = state;
1439
1440 return 0;
1441 }
1442 #endif
1443
1444 #ifdef HAVE_SPEEX
1445 /*** speex based implementation ***/
1446
1447 static unsigned speex_resample_float(pa_resampler *r, const pa_memchunk *input, unsigned in_n_frames, pa_memchunk *output, unsigned *out_n_frames) {
1448 float *in, *out;
1449 uint32_t inf = in_n_frames, outf = *out_n_frames;
1450 SpeexResamplerState *state;
1451
1452 pa_assert(r);
1453 pa_assert(input);
1454 pa_assert(output);
1455 pa_assert(out_n_frames);
1456
1457 state = r->impl.data;
1458
1459 in = pa_memblock_acquire_chunk(input);
1460 out = pa_memblock_acquire_chunk(output);
1461
1462 pa_assert_se(speex_resampler_process_interleaved_float(state, in, &inf, out, &outf) == 0);
1463
1464 pa_memblock_release(input->memblock);
1465 pa_memblock_release(output->memblock);
1466
1467 pa_assert(inf == in_n_frames);
1468 *out_n_frames = outf;
1469
1470 return 0;
1471 }
1472
1473 static unsigned speex_resample_int(pa_resampler *r, const pa_memchunk *input, unsigned in_n_frames, pa_memchunk *output, unsigned *out_n_frames) {
1474 int16_t *in, *out;
1475 uint32_t inf = in_n_frames, outf = *out_n_frames;
1476 SpeexResamplerState *state;
1477
1478 pa_assert(r);
1479 pa_assert(input);
1480 pa_assert(output);
1481 pa_assert(out_n_frames);
1482
1483 state = r->impl.data;
1484
1485 in = pa_memblock_acquire_chunk(input);
1486 out = pa_memblock_acquire_chunk(output);
1487
1488 pa_assert_se(speex_resampler_process_interleaved_int(state, in, &inf, out, &outf) == 0);
1489
1490 pa_memblock_release(input->memblock);
1491 pa_memblock_release(output->memblock);
1492
1493 pa_assert(inf == in_n_frames);
1494 *out_n_frames = outf;
1495
1496 return 0;
1497 }
1498
1499 static void speex_update_rates(pa_resampler *r) {
1500 SpeexResamplerState *state;
1501 pa_assert(r);
1502
1503 state = r->impl.data;
1504
1505 pa_assert_se(speex_resampler_set_rate(state, r->i_ss.rate, r->o_ss.rate) == 0);
1506 }
1507
1508 static void speex_reset(pa_resampler *r) {
1509 SpeexResamplerState *state;
1510 pa_assert(r);
1511
1512 state = r->impl.data;
1513
1514 pa_assert_se(speex_resampler_reset_mem(state) == 0);
1515 }
1516
1517 static void speex_free(pa_resampler *r) {
1518 SpeexResamplerState *state;
1519 pa_assert(r);
1520
1521 state = r->impl.data;
1522 if (!state)
1523 return;
1524
1525 speex_resampler_destroy(state);
1526 }
1527
1528 static int speex_init(pa_resampler *r) {
1529 int q, err;
1530 SpeexResamplerState *state;
1531
1532 pa_assert(r);
1533
1534 r->impl.free = speex_free;
1535 r->impl.update_rates = speex_update_rates;
1536 r->impl.reset = speex_reset;
1537
1538 if (r->method >= PA_RESAMPLER_SPEEX_FIXED_BASE && r->method <= PA_RESAMPLER_SPEEX_FIXED_MAX) {
1539
1540 q = r->method - PA_RESAMPLER_SPEEX_FIXED_BASE;
1541 r->impl.resample = speex_resample_int;
1542
1543 } else {
1544 pa_assert(r->method >= PA_RESAMPLER_SPEEX_FLOAT_BASE && r->method <= PA_RESAMPLER_SPEEX_FLOAT_MAX);
1545
1546 q = r->method - PA_RESAMPLER_SPEEX_FLOAT_BASE;
1547 r->impl.resample = speex_resample_float;
1548 }
1549
1550 pa_log_info("Choosing speex quality setting %i.", q);
1551
1552 if (!(state = speex_resampler_init(r->work_channels, r->i_ss.rate, r->o_ss.rate, q, &err)))
1553 return -1;
1554
1555 r->impl.data = state;
1556
1557 return 0;
1558 }
1559 #endif
1560
1561 /* Trivial implementation */
1562
1563 static unsigned trivial_resample(pa_resampler *r, const pa_memchunk *input, unsigned in_n_frames, pa_memchunk *output, unsigned *out_n_frames) {
1564 unsigned i_index, o_index;
1565 void *src, *dst;
1566 struct trivial_data *trivial_data;
1567
1568 pa_assert(r);
1569 pa_assert(input);
1570 pa_assert(output);
1571 pa_assert(out_n_frames);
1572
1573 trivial_data = r->impl.data;
1574
1575 src = pa_memblock_acquire_chunk(input);
1576 dst = pa_memblock_acquire_chunk(output);
1577
1578 for (o_index = 0;; o_index++, trivial_data->o_counter++) {
1579 i_index = ((uint64_t) trivial_data->o_counter * r->i_ss.rate) / r->o_ss.rate;
1580 i_index = i_index > trivial_data->i_counter ? i_index - trivial_data->i_counter : 0;
1581
1582 if (i_index >= in_n_frames)
1583 break;
1584
1585 pa_assert_fp(o_index * r->w_fz < pa_memblock_get_length(output->memblock));
1586
1587 memcpy((uint8_t*) dst + r->w_fz * o_index, (uint8_t*) src + r->w_fz * i_index, (int) r->w_fz);
1588 }
1589
1590 pa_memblock_release(input->memblock);
1591 pa_memblock_release(output->memblock);
1592
1593 *out_n_frames = o_index;
1594
1595 trivial_data->i_counter += in_n_frames;
1596
1597 /* Normalize counters */
1598 while (trivial_data->i_counter >= r->i_ss.rate) {
1599 pa_assert(trivial_data->o_counter >= r->o_ss.rate);
1600
1601 trivial_data->i_counter -= r->i_ss.rate;
1602 trivial_data->o_counter -= r->o_ss.rate;
1603 }
1604
1605 return 0;
1606 }
1607
1608 static void trivial_update_rates_or_reset(pa_resampler *r) {
1609 struct trivial_data *trivial_data;
1610 pa_assert(r);
1611
1612 trivial_data = r->impl.data;
1613
1614 trivial_data->i_counter = 0;
1615 trivial_data->o_counter = 0;
1616 }
1617
1618 static int trivial_init(pa_resampler*r) {
1619 struct trivial_data *trivial_data;
1620 pa_assert(r);
1621
1622 trivial_data = pa_xnew0(struct trivial_data, 1);
1623
1624 r->impl.resample = trivial_resample;
1625 r->impl.update_rates = trivial_update_rates_or_reset;
1626 r->impl.reset = trivial_update_rates_or_reset;
1627 r->impl.data = trivial_data;
1628
1629 return 0;
1630 }
1631
1632 /* Peak finder implementation */
1633
1634 static unsigned peaks_resample(pa_resampler *r, const pa_memchunk *input, unsigned in_n_frames, pa_memchunk *output, unsigned *out_n_frames) {
1635 unsigned c, o_index = 0;
1636 unsigned i, i_end = 0;
1637 void *src, *dst;
1638 struct peaks_data *peaks_data;
1639
1640 pa_assert(r);
1641 pa_assert(input);
1642 pa_assert(output);
1643 pa_assert(out_n_frames);
1644
1645 peaks_data = r->impl.data;
1646 src = pa_memblock_acquire_chunk(input);
1647 dst = pa_memblock_acquire_chunk(output);
1648
1649 i = ((uint64_t) peaks_data->o_counter * r->i_ss.rate) / r->o_ss.rate;
1650 i = i > peaks_data->i_counter ? i - peaks_data->i_counter : 0;
1651
1652 while (i_end < in_n_frames) {
1653 i_end = ((uint64_t) (peaks_data->o_counter + 1) * r->i_ss.rate) / r->o_ss.rate;
1654 i_end = i_end > peaks_data->i_counter ? i_end - peaks_data->i_counter : 0;
1655
1656 pa_assert_fp(o_index * r->w_fz < pa_memblock_get_length(output->memblock));
1657
1658 /* 1ch float is treated separately, because that is the common case */
1659 if (r->work_channels == 1 && r->work_format == PA_SAMPLE_FLOAT32NE) {
1660 float *s = (float*) src + i;
1661 float *d = (float*) dst + o_index;
1662
1663 for (; i < i_end && i < in_n_frames; i++) {
1664 float n = fabsf(*s++);
1665
1666 if (n > peaks_data->max_f[0])
1667 peaks_data->max_f[0] = n;
1668 }
1669
1670 if (i == i_end) {
1671 *d = peaks_data->max_f[0];
1672 peaks_data->max_f[0] = 0;
1673 o_index++, peaks_data->o_counter++;
1674 }
1675 } else if (r->work_format == PA_SAMPLE_S16NE) {
1676 int16_t *s = (int16_t*) src + r->work_channels * i;
1677 int16_t *d = (int16_t*) dst + r->work_channels * o_index;
1678
1679 for (; i < i_end && i < in_n_frames; i++)
1680 for (c = 0; c < r->work_channels; c++) {
1681 int16_t n = abs(*s++);
1682
1683 if (n > peaks_data->max_i[c])
1684 peaks_data->max_i[c] = n;
1685 }
1686
1687 if (i == i_end) {
1688 for (c = 0; c < r->work_channels; c++, d++) {
1689 *d = peaks_data->max_i[c];
1690 peaks_data->max_i[c] = 0;
1691 }
1692 o_index++, peaks_data->o_counter++;
1693 }
1694 } else {
1695 float *s = (float*) src + r->work_channels * i;
1696 float *d = (float*) dst + r->work_channels * o_index;
1697
1698 for (; i < i_end && i < in_n_frames; i++)
1699 for (c = 0; c < r->work_channels; c++) {
1700 float n = fabsf(*s++);
1701
1702 if (n > peaks_data->max_f[c])
1703 peaks_data->max_f[c] = n;
1704 }
1705
1706 if (i == i_end) {
1707 for (c = 0; c < r->work_channels; c++, d++) {
1708 *d = peaks_data->max_f[c];
1709 peaks_data->max_f[c] = 0;
1710 }
1711 o_index++, peaks_data->o_counter++;
1712 }
1713 }
1714 }
1715
1716 pa_memblock_release(input->memblock);
1717 pa_memblock_release(output->memblock);
1718
1719 *out_n_frames = o_index;
1720
1721 peaks_data->i_counter += in_n_frames;
1722
1723 /* Normalize counters */
1724 while (peaks_data->i_counter >= r->i_ss.rate) {
1725 pa_assert(peaks_data->o_counter >= r->o_ss.rate);
1726
1727 peaks_data->i_counter -= r->i_ss.rate;
1728 peaks_data->o_counter -= r->o_ss.rate;
1729 }
1730
1731 return 0;
1732 }
1733
1734 static void peaks_update_rates_or_reset(pa_resampler *r) {
1735 struct peaks_data *peaks_data;
1736 pa_assert(r);
1737
1738 peaks_data = r->impl.data;
1739
1740 peaks_data->i_counter = 0;
1741 peaks_data->o_counter = 0;
1742 }
1743
1744 static int peaks_init(pa_resampler*r) {
1745 struct peaks_data *peaks_data;
1746 pa_assert(r);
1747 pa_assert(r->i_ss.rate >= r->o_ss.rate);
1748 pa_assert(r->work_format == PA_SAMPLE_S16NE || r->work_format == PA_SAMPLE_FLOAT32NE);
1749
1750 peaks_data = pa_xnew0(struct peaks_data, 1);
1751
1752 r->impl.resample = peaks_resample;
1753 r->impl.update_rates = peaks_update_rates_or_reset;
1754 r->impl.reset = peaks_update_rates_or_reset;
1755 r->impl.data = peaks_data;
1756
1757 return 0;
1758 }
1759
1760 /*** ffmpeg based implementation ***/
1761
1762 static unsigned ffmpeg_resample(pa_resampler *r, const pa_memchunk *input, unsigned in_n_frames, pa_memchunk *output, unsigned *out_n_frames) {
1763 unsigned used_frames = 0, c;
1764 int previous_consumed_frames = -1;
1765 struct ffmpeg_data *ffmpeg_data;
1766
1767 pa_assert(r);
1768 pa_assert(input);
1769 pa_assert(output);
1770 pa_assert(out_n_frames);
1771
1772 ffmpeg_data = r->impl.data;
1773
1774 for (c = 0; c < r->work_channels; c++) {
1775 unsigned u;
1776 pa_memblock *b, *w;
1777 int16_t *p, *t, *k, *q, *s;
1778 int consumed_frames;
1779
1780 /* Allocate a new block */
1781 b = pa_memblock_new(r->mempool, in_n_frames * sizeof(int16_t));
1782 p = pa_memblock_acquire(b);
1783
1784 /* Now copy the input data, splitting up channels */
1785 t = (int16_t*) pa_memblock_acquire_chunk(input) + c;
1786 k = p;
1787 for (u = 0; u < in_n_frames; u++) {
1788 *k = *t;
1789 t += r->work_channels;
1790 k ++;
1791 }
1792 pa_memblock_release(input->memblock);
1793
1794 /* Allocate buffer for the result */
1795 w = pa_memblock_new(r->mempool, *out_n_frames * sizeof(int16_t));
1796 q = pa_memblock_acquire(w);
1797
1798 /* Now, resample */
1799 used_frames = (unsigned) av_resample(ffmpeg_data->state,
1800 q, p,
1801 &consumed_frames,
1802 (int) in_n_frames, (int) *out_n_frames,
1803 c >= (unsigned) (r->work_channels-1));
1804
1805 pa_memblock_release(b);
1806 pa_memblock_unref(b);
1807
1808 pa_assert(consumed_frames <= (int) in_n_frames);
1809 pa_assert(previous_consumed_frames == -1 || consumed_frames == previous_consumed_frames);
1810 previous_consumed_frames = consumed_frames;
1811
1812 /* And place the results in the output buffer */
1813 s = (int16_t *) pa_memblock_acquire_chunk(output) + c;
1814 for (u = 0; u < used_frames; u++) {
1815 *s = *q;
1816 q++;
1817 s += r->work_channels;
1818 }
1819 pa_memblock_release(output->memblock);
1820 pa_memblock_release(w);
1821 pa_memblock_unref(w);
1822 }
1823
1824 *out_n_frames = used_frames;
1825
1826 return in_n_frames - previous_consumed_frames;
1827 }
1828
1829 static void ffmpeg_free(pa_resampler *r) {
1830 struct ffmpeg_data *ffmpeg_data;
1831
1832 pa_assert(r);
1833
1834 ffmpeg_data = r->impl.data;
1835 if (ffmpeg_data->state)
1836 av_resample_close(ffmpeg_data->state);
1837 }
1838
1839 static int ffmpeg_init(pa_resampler *r) {
1840 struct ffmpeg_data *ffmpeg_data;
1841
1842 pa_assert(r);
1843
1844 ffmpeg_data = pa_xnew(struct ffmpeg_data, 1);
1845
1846 /* We could probably implement different quality levels by
1847 * adjusting the filter parameters here. However, ffmpeg
1848 * internally only uses these hardcoded values, so let's use them
1849 * here for now as well until ffmpeg makes this configurable. */
1850
1851 if (!(ffmpeg_data->state = av_resample_init((int) r->o_ss.rate, (int) r->i_ss.rate, 16, 10, 0, 0.8)))
1852 return -1;
1853
1854 r->impl.free = ffmpeg_free;
1855 r->impl.resample = ffmpeg_resample;
1856 r->impl.data = (void *) ffmpeg_data;
1857
1858 return 0;
1859 }
1860
1861 /*** copy (noop) implementation ***/
1862
1863 static int copy_init(pa_resampler *r) {
1864 pa_assert(r);
1865
1866 pa_assert(r->o_ss.rate == r->i_ss.rate);
1867
1868 return 0;
1869 }