Media Project Phase2: SILK 8khz-24khz, SLINEAR 8khz-192khz, SPEEX 32khz, hd audio...
[asterisk/asterisk.git] / funcs / func_pitchshift.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2010, Digium, Inc.
5  *
6  * David Vossel <dvossel@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*! \file
20  *
21  * \brief Pitch Shift Audio Effect
22  *
23  * \author David Vossel <dvossel@digium.com>
24  *
25  * \ingroup functions
26  */
27
28 /************************* SMB FUNCTION LICENSE *********************************
29 *
30 * SYNOPSIS: Routine for doing pitch shifting while maintaining
31 * duration using the Short Time Fourier Transform.
32 *
33 * DESCRIPTION: The routine takes a pitchShift factor value which is between 0.5
34 * (one octave down) and 2. (one octave up). A value of exactly 1 does not change
35 * the pitch. num_samps_to_process tells the routine how many samples in indata[0...
36 * num_samps_to_process-1] should be pitch shifted and moved to outdata[0 ...
37 * num_samps_to_process-1]. The two buffers can be identical (ie. it can process the
38 * data in-place). fft_frame_size defines the FFT frame size used for the
39 * processing. Typical values are 1024, 2048 and 4096. It may be any value <=
40 * MAX_FRAME_LENGTH but it MUST be a power of 2. osamp is the STFT
41 * oversampling factor which also determines the overlap between adjacent STFT
42 * frames. It should at least be 4 for moderate scaling ratios. A value of 32 is
43 * recommended for best quality. sampleRate takes the sample rate for the signal
44 * in unit Hz, ie. 44100 for 44.1 kHz audio. The data passed to the routine in
45 * indata[] should be in the range [-1.0, 1.0), which is also the output range
46 * for the data, make sure you scale the data accordingly (for 16bit signed integers
47 * you would have to divide (and multiply) by 32768).
48 *
49 * COPYRIGHT 1999-2009 Stephan M. Bernsee <smb [AT] dspdimension [DOT] com>
50 *
51 *                        The Wide Open License (WOL)
52 *
53 * Permission to use, copy, modify, distribute and sell this software and its
54 * documentation for any purpose is hereby granted without fee, provided that
55 * the above copyright notice and this license appear in all source copies.
56 * THIS SOFTWARE IS PROVIDED "AS IS" WITHOUT EXPRESS OR IMPLIED WARRANTY OF
57 * ANY KIND. See http://www.dspguru.com/wol.htm for more information.
58 *
59 *****************************************************************************/
60
61 #include "asterisk.h"
62
63 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
64
65 #include "asterisk/module.h"
66 #include "asterisk/channel.h"
67 #include "asterisk/pbx.h"
68 #include "asterisk/utils.h"
69 #include "asterisk/audiohook.h"
70 #include <math.h>
71
72 /*** DOCUMENTATION
73         <function name="PITCH_SHIFT" language="en_US">
74                 <synopsis>
75                         Pitch shift both tx and rx audio streams on a channel.
76                 </synopsis>
77                 <syntax>
78                         <parameter name="channel direction" required="true">
79                                 <para>Direction can be either <literal>rx</literal>, <literal>tx</literal>, or
80                                 <literal>both</literal>.  The direction can either be set to a valid floating
81                                 point number between 0.1 and 4.0 or one of the enum values listed below. A value
82                                 of 1.0 has no effect.  Greater than 1 raises the pitch. Lower than 1 lowers
83                                 the pitch.</para>
84
85                                 <para>The pitch amount can also be set by the following values</para>
86                                 <enumlist>
87                                         <enum name = "highest" />
88                                         <enum name = "higher" />
89                                         <enum name = "high" />
90                                         <enum name = "low" />
91                                         <enum name = "lower" />
92                                         <enum name = "lowest" />
93                                 </enumlist>
94                         </parameter>
95                 </syntax>
96                 <description>
97                         <para>Examples:</para>
98                         <para>exten => 1,1,Set(PITCH_SHIFT(tx)=highest); raises pitch an octave </para>
99                         <para>exten => 1,1,Set(PITCH_SHIFT(rx)=higher) ; raises pitch more </para>
100                         <para>exten => 1,1,Set(PITCH_SHIFT(both)=high)   ; raises pitch </para>
101                         <para>exten => 1,1,Set(PITCH_SHIFT(rx)=low)    ; lowers pitch </para>
102                         <para>exten => 1,1,Set(PITCH_SHIFT(tx)=lower)  ; lowers pitch more </para>
103                         <para>exten => 1,1,Set(PITCH_SHIFT(both)=lowest) ; lowers pitch an octave </para>
104
105                         <para>exten => 1,1,Set(PITCH_SHIFT(rx)=0.8)    ; lowers pitch </para>
106                         <para>exten => 1,1,Set(PITCH_SHIFT(tx)=1.5)    ; raises pitch </para>
107                 </description>
108         </function>
109  ***/
110
111 #ifndef M_PI
112 #define M_PI 3.14159265358979323846
113 #endif
114 #define MAX_FRAME_LENGTH 256
115
116 #define HIGHEST 2
117 #define HIGHER 1.5
118 #define HIGH 1.25
119 #define LOW .85
120 #define LOWER .7
121 #define LOWEST .5
122
123 struct fft_data {
124         float in_fifo[MAX_FRAME_LENGTH];
125         float out_fifo[MAX_FRAME_LENGTH];
126         float fft_worksp[2*MAX_FRAME_LENGTH];
127         float last_phase[MAX_FRAME_LENGTH/2+1];
128         float sum_phase[MAX_FRAME_LENGTH/2+1];
129         float output_accum[2*MAX_FRAME_LENGTH];
130         float ana_freq[MAX_FRAME_LENGTH];
131         float ana_magn[MAX_FRAME_LENGTH];
132         float syn_freq[MAX_FRAME_LENGTH];
133         float sys_magn[MAX_FRAME_LENGTH];
134         long gRover;
135         float shift_amount;
136 };
137
138 struct pitchshift_data {
139         struct ast_audiohook audiohook;
140
141         struct fft_data rx;
142         struct fft_data tx;
143 };
144
145 static void smb_fft(float *fft_buffer, long fft_frame_size, long sign);
146 static void smb_pitch_shift(float pitchShift, long num_samps_to_process, long fft_frame_size, long osamp, float sample_rate, int16_t *indata, int16_t *outdata, struct fft_data *fft_data);
147 static int pitch_shift(struct ast_frame *f, float amount, struct fft_data *fft_data);
148
149 static void destroy_callback(void *data)
150 {
151         struct pitchshift_data *shift = data;
152
153         ast_audiohook_destroy(&shift->audiohook);
154         ast_free(shift);
155 };
156
157 static const struct ast_datastore_info pitchshift_datastore = {
158         .type = "pitchshift",
159         .destroy = destroy_callback
160 };
161
162 static int pitchshift_cb(struct ast_audiohook *audiohook, struct ast_channel *chan, struct ast_frame *f, enum ast_audiohook_direction direction)
163 {
164         struct ast_datastore *datastore = NULL;
165         struct pitchshift_data *shift = NULL;
166
167
168         if (!f) {
169                 return 0;
170         }
171         if ((audiohook->status == AST_AUDIOHOOK_STATUS_DONE) ||
172                 (f->frametype != AST_FRAME_VOICE) ||
173                 !(ast_format_is_slinear(&f->subclass.format))) {
174                 return -1;
175         }
176
177         if (!(datastore = ast_channel_datastore_find(chan, &pitchshift_datastore, NULL))) {
178                 return -1;
179         }
180
181         shift = datastore->data;
182
183         if (direction == AST_AUDIOHOOK_DIRECTION_WRITE) {
184                 pitch_shift(f, shift->tx.shift_amount, &shift->tx);
185         } else {
186                 pitch_shift(f, shift->rx.shift_amount, &shift->rx);
187         }
188
189         return 0;
190 }
191
192 static int pitchshift_helper(struct ast_channel *chan, const char *cmd, char *data, const char *value)
193 {
194         struct ast_datastore *datastore = NULL;
195         struct pitchshift_data *shift = NULL;
196         int new = 0;
197         float amount = 0;
198
199         ast_channel_lock(chan);
200         if (!(datastore = ast_channel_datastore_find(chan, &pitchshift_datastore, NULL))) {
201                 ast_channel_unlock(chan);
202
203                 if (!(datastore = ast_datastore_alloc(&pitchshift_datastore, NULL))) {
204                         return 0;
205                 }
206                 if (!(shift = ast_calloc(1, sizeof(*shift)))) {
207                         ast_datastore_free(datastore);
208                         return 0;
209                 }
210
211                 ast_audiohook_init(&shift->audiohook, AST_AUDIOHOOK_TYPE_MANIPULATE, "pitch_shift", AST_AUDIOHOOK_MANIPULATE_ALL_RATES);
212                 shift->audiohook.manipulate_callback = pitchshift_cb;
213                 datastore->data = shift;
214                 new = 1;
215         } else {
216                 ast_channel_unlock(chan);
217                 shift = datastore->data;
218         }
219
220
221         if (!strcasecmp(value, "highest")) {
222                 amount = HIGHEST;
223         } else if (!strcasecmp(value, "higher")) {
224                 amount = HIGHER;
225         } else if (!strcasecmp(value, "high")) {
226                 amount = HIGH;
227         } else if (!strcasecmp(value, "lowest")) {
228                 amount = LOWEST;
229         } else if (!strcasecmp(value, "lower")) {
230                 amount = LOWER;
231         } else if (!strcasecmp(value, "low")) {
232                 amount = LOW;
233         } else {
234                 if (!sscanf(value, "%30f", &amount) || (amount <= 0) || (amount > 4)) {
235                         goto cleanup_error;
236                 }
237         }
238
239         if (!strcasecmp(data, "rx")) {
240                 shift->rx.shift_amount = amount;
241         } else if (!strcasecmp(data, "tx")) {
242                 shift->tx.shift_amount = amount;
243         } else if (!strcasecmp(data, "both")) {
244                 shift->rx.shift_amount = amount;
245                 shift->tx.shift_amount = amount;
246         } else {
247                 goto cleanup_error;
248         }
249
250         if (new) {
251                 ast_channel_lock(chan);
252                 ast_channel_datastore_add(chan, datastore);
253                 ast_channel_unlock(chan);
254                 ast_audiohook_attach(chan, &shift->audiohook);
255         }
256
257         return 0;
258
259 cleanup_error:
260
261         ast_log(LOG_ERROR, "Invalid argument provided to the %s function\n", cmd);
262         if (new) {
263                 ast_datastore_free(datastore);
264         }
265         return -1;
266 }
267
268 static void smb_fft(float *fft_buffer, long fft_frame_size, long sign)
269 {
270         float wr, wi, arg, *p1, *p2, temp;
271         float tr, ti, ur, ui, *p1r, *p1i, *p2r, *p2i;
272         long i, bitm, j, le, le2, k;
273
274         for (i = 2; i < 2 * fft_frame_size - 2; i += 2) {
275                 for (bitm = 2, j = 0; bitm < 2 * fft_frame_size; bitm <<= 1) {
276                         if (i & bitm) {
277                                 j++;
278                         }
279                         j <<= 1;
280                 }
281                 if (i < j) {
282                         p1 = fft_buffer + i; p2 = fft_buffer + j;
283                         temp = *p1; *(p1++) = *p2;
284                         *(p2++) = temp; temp = *p1;
285                         *p1 = *p2; *p2 = temp;
286                 }
287         }
288         for (k = 0, le = 2; k < (long) (log(fft_frame_size) / log(2.) + .5); k++) {
289                 le <<= 1;
290                 le2 = le>>1;
291                 ur = 1.0;
292                 ui = 0.0;
293                 arg = M_PI / (le2>>1);
294                 wr = cos(arg);
295                 wi = sign * sin(arg);
296                 for (j = 0; j < le2; j += 2) {
297                         p1r = fft_buffer+j; p1i = p1r + 1;
298                         p2r = p1r + le2; p2i = p2r + 1;
299                         for (i = j; i < 2 * fft_frame_size; i += le) {
300                                 tr = *p2r * ur - *p2i * ui;
301                                 ti = *p2r * ui + *p2i * ur;
302                                 *p2r = *p1r - tr; *p2i = *p1i - ti;
303                                 *p1r += tr; *p1i += ti;
304                                 p1r += le; p1i += le;
305                                 p2r += le; p2i += le;
306                         }
307                         tr = ur * wr - ui * wi;
308                         ui = ur * wi + ui * wr;
309                         ur = tr;
310                 }
311         }
312 }
313
314 static void smb_pitch_shift(float pitchShift, long num_samps_to_process, long fft_frame_size, long osamp, float sample_rate, int16_t *indata, int16_t *outdata, struct fft_data *fft_data)
315 {
316         float *in_fifo = fft_data->in_fifo;
317         float *out_fifo = fft_data->out_fifo;
318         float *fft_worksp = fft_data->fft_worksp;
319         float *last_phase = fft_data->last_phase;
320         float *sum_phase = fft_data->sum_phase;
321         float *output_accum = fft_data->output_accum;
322         float *ana_freq = fft_data->ana_freq;
323         float *ana_magn = fft_data->ana_magn;
324         float *syn_freq = fft_data->syn_freq;
325         float *sys_magn = fft_data->sys_magn;
326
327         double magn, phase, tmp, window, real, imag;
328         double freq_per_bin, expct;
329         long i,k, qpd, index, in_fifo_latency, step_size, fft_frame_size2;
330
331         /* set up some handy variables */
332         fft_frame_size2 = fft_frame_size / 2;
333         step_size = fft_frame_size / osamp;
334         freq_per_bin = sample_rate / (double) fft_frame_size;
335         expct = 2. * M_PI * (double) step_size / (double) fft_frame_size;
336         in_fifo_latency = fft_frame_size-step_size;
337
338         if (fft_data->gRover == 0) {
339                 fft_data->gRover = in_fifo_latency;
340         }
341
342         /* main processing loop */
343         for (i = 0; i < num_samps_to_process; i++){
344
345                 /* As long as we have not yet collected enough data just read in */
346                 in_fifo[fft_data->gRover] = indata[i];
347                 outdata[i] = out_fifo[fft_data->gRover - in_fifo_latency];
348                 fft_data->gRover++;
349
350                 /* now we have enough data for processing */
351                 if (fft_data->gRover >= fft_frame_size) {
352                         fft_data->gRover = in_fifo_latency;
353
354                         /* do windowing and re,im interleave */
355                         for (k = 0; k < fft_frame_size;k++) {
356                                 window = -.5 * cos(2. * M_PI * (double) k / (double) fft_frame_size) + .5;
357                                 fft_worksp[2*k] = in_fifo[k] * window;
358                                 fft_worksp[2*k+1] = 0.;
359                         }
360
361                         /* ***************** ANALYSIS ******************* */
362                         /* do transform */
363                         smb_fft(fft_worksp, fft_frame_size, -1);
364
365                         /* this is the analysis step */
366                         for (k = 0; k <= fft_frame_size2; k++) {
367
368                                 /* de-interlace FFT buffer */
369                                 real = fft_worksp[2*k];
370                                 imag = fft_worksp[2*k+1];
371
372                                 /* compute magnitude and phase */
373                                 magn = 2. * sqrt(real * real + imag * imag);
374                                 phase = atan2(imag, real);
375
376                                 /* compute phase difference */
377                                 tmp = phase - last_phase[k];
378                                 last_phase[k] = phase;
379
380                                 /* subtract expected phase difference */
381                                 tmp -= (double) k * expct;
382
383                                 /* map delta phase into +/- Pi interval */
384                                 qpd = tmp / M_PI;
385                                 if (qpd >= 0) {
386                                         qpd += qpd & 1;
387                                 } else {
388                                         qpd -= qpd & 1;
389                                 }
390                                 tmp -= M_PI * (double) qpd;
391
392                                 /* get deviation from bin frequency from the +/- Pi interval */
393                                 tmp = osamp * tmp / (2. * M_PI);
394
395                                 /* compute the k-th partials' true frequency */
396                                 tmp = (double) k * freq_per_bin + tmp * freq_per_bin;
397
398                                 /* store magnitude and true frequency in analysis arrays */
399                                 ana_magn[k] = magn;
400                                 ana_freq[k] = tmp;
401
402                         }
403
404                         /* ***************** PROCESSING ******************* */
405                         /* this does the actual pitch shifting */
406                         memset(sys_magn, 0, fft_frame_size * sizeof(float));
407                         memset(syn_freq, 0, fft_frame_size * sizeof(float));
408                         for (k = 0; k <= fft_frame_size2; k++) {
409                                 index = k * pitchShift;
410                                 if (index <= fft_frame_size2) {
411                                         sys_magn[index] += ana_magn[k];
412                                         syn_freq[index] = ana_freq[k] * pitchShift;
413                                 }
414                         }
415
416                         /* ***************** SYNTHESIS ******************* */
417                         /* this is the synthesis step */
418                         for (k = 0; k <= fft_frame_size2; k++) {
419
420                                 /* get magnitude and true frequency from synthesis arrays */
421                                 magn = sys_magn[k];
422                                 tmp = syn_freq[k];
423
424                                 /* subtract bin mid frequency */
425                                 tmp -= (double) k * freq_per_bin;
426
427                                 /* get bin deviation from freq deviation */
428                                 tmp /= freq_per_bin;
429
430                                 /* take osamp into account */
431                                 tmp = 2. * M_PI * tmp / osamp;
432
433                                 /* add the overlap phase advance back in */
434                                 tmp += (double) k * expct;
435
436                                 /* accumulate delta phase to get bin phase */
437                                 sum_phase[k] += tmp;
438                                 phase = sum_phase[k];
439
440                                 /* get real and imag part and re-interleave */
441                                 fft_worksp[2*k] = magn * cos(phase);
442                                 fft_worksp[2*k+1] = magn * sin(phase);
443                         }
444
445                         /* zero negative frequencies */
446                         for (k = fft_frame_size + 2; k < 2 * fft_frame_size; k++) {
447                                 fft_worksp[k] = 0.;
448                         }
449
450                         /* do inverse transform */
451                         smb_fft(fft_worksp, fft_frame_size, 1);
452
453                         /* do windowing and add to output accumulator */
454                         for (k = 0; k < fft_frame_size; k++) {
455                                 window = -.5 * cos(2. * M_PI * (double) k / (double) fft_frame_size) + .5;
456                                 output_accum[k] += 2. * window * fft_worksp[2*k] / (fft_frame_size2 * osamp);
457                         }
458                         for (k = 0; k < step_size; k++) {
459                                 out_fifo[k] = output_accum[k];
460                         }
461
462                         /* shift accumulator */
463                         memmove(output_accum, output_accum+step_size, fft_frame_size * sizeof(float));
464
465                         /* move input FIFO */
466                         for (k = 0; k < in_fifo_latency; k++) {
467                                 in_fifo[k] = in_fifo[k+step_size];
468                         }
469                 }
470         }
471 }
472
473 static int pitch_shift(struct ast_frame *f, float amount, struct fft_data *fft)
474 {
475         int16_t *fun = (int16_t *) f->data.ptr;
476         int samples;
477
478         /* an amount of 1 has no effect */
479         if (!amount || amount == 1 || !fun || (f->samples % 32)) {
480                 return 0;
481         }
482         for (samples = 0; samples < f->samples; samples += 32) {
483                 smb_pitch_shift(amount, 32, MAX_FRAME_LENGTH, 32, ast_format_rate(&f->subclass.format), fun+samples, fun+samples, fft);
484         }
485
486         return 0;
487 }
488
489 static struct ast_custom_function pitch_shift_function = {
490         .name = "PITCH_SHIFT",
491         .write = pitchshift_helper,
492 };
493
494 static int unload_module(void)
495 {
496         return ast_custom_function_unregister(&pitch_shift_function);
497 }
498
499 static int load_module(void)
500 {
501         int res = ast_custom_function_register(&pitch_shift_function);
502         return res ? AST_MODULE_LOAD_DECLINE : AST_MODULE_LOAD_SUCCESS;
503 }
504
505 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Audio Effects Dialplan Functions");