LGPL
[vlc.git] / modules / audio_filter / resampler / src.c
1 /*****************************************************************************
2  * src.c : Secret Rabbit Code (a.k.a. libsamplerate) resampler
3  *****************************************************************************
4  * Copyright (C) 2011 RĂ©mi Denis-Courmont
5  *
6  * This program is free software; you can redistribute it and/or modify it
7  * under the terms of the GNU Lesser General Public License as published by
8  * the Free Software Foundation; either version 2.1 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
19  *****************************************************************************/
20
21 /*****************************************************************************
22  * NOTA BENE: this module requires the linking against a library which is
23  * known to require licensing under the GNU General Public License version 2
24  * (or later). Therefore, the result of compiling this module will normally
25  * be subject to the terms of that later license.
26  *****************************************************************************/
27
28
29 #ifdef HAVE_CONFIG_H
30 # include "config.h"
31 #endif
32
33 #include <vlc_common.h>
34 #include <vlc_plugin.h>
35 #include <vlc_aout.h>
36 #include <vlc_filter.h>
37 #include <samplerate.h>
38 #include <math.h>
39
40 #define SRC_CONV_TYPE_TEXT N_("Sample rate converter type")
41 #define SRC_CONV_TYPE_LONGTEXT N_( \
42     "Different resampling algorithms are supported. " \
43     "The best one is slower, while the fast one exhibits low quality.")
44 static const int conv_type_values[] = {
45     SRC_SINC_BEST_QUALITY, SRC_SINC_MEDIUM_QUALITY, SRC_SINC_FASTEST,
46     SRC_ZERO_ORDER_HOLD, SRC_LINEAR,
47 };
48 static const char *const conv_type_texts[] = {
49     N_("Sinc function (best quality)"), N_("Sinc function (medium quality)"),
50     N_("Sinc function (fast)"), N_("Zero Order Hold (fastest)"), N_("Linear (fastest)"),
51 };
52
53 static int Open (vlc_object_t *);
54 static void Close (vlc_object_t *);
55
56 vlc_module_begin ()
57     set_shortname (N_("SRC resampler"))
58     set_description (N_("Secret Rabbit Code (libsamplerate) resampler") )
59     set_category (CAT_AUDIO)
60     set_subcategory (SUBCAT_AUDIO_MISC)
61     add_integer ("src-converter-type", SRC_SINC_FASTEST,
62                  SRC_CONV_TYPE_TEXT, SRC_CONV_TYPE_LONGTEXT, true)
63         change_integer_list (conv_type_values, conv_type_texts)
64     set_capability ("audio converter", 50)
65     set_callbacks (Open, Close)
66
67     add_submodule ()
68     set_capability ("audio resampler", 50)
69     set_callbacks (Open, Close)
70 vlc_module_end ()
71
72 static block_t *Resample (filter_t *, block_t *);
73
74 static int Open (vlc_object_t *obj)
75 {
76     filter_t *filter = (filter_t *)obj;
77
78     /* Only float->float */
79     if (filter->fmt_in.audio.i_format != VLC_CODEC_FL32
80      || filter->fmt_out.audio.i_format != VLC_CODEC_FL32
81     /* No channels remapping */
82      || filter->fmt_in.audio.i_physical_channels
83                                   != filter->fmt_out.audio.i_physical_channels
84      || filter->fmt_in.audio.i_original_channels
85                                   != filter->fmt_out.audio.i_original_channels
86     /* Different sample rate */
87      || filter->fmt_in.audio.i_rate == filter->fmt_out.audio.i_rate)
88         return VLC_EGENERIC;
89
90     int type = var_InheritInteger (obj, "src-converter-type");
91     int channels = aout_FormatNbChannels (&filter->fmt_in.audio);
92     int err;
93
94     SRC_STATE *s = src_new (type, channels, &err);
95     if (s == NULL)
96     {
97         msg_Err (obj, "cannot initialize resampler: %s", src_strerror (err));
98         return VLC_EGENERIC;
99     }
100
101     filter->p_sys = (filter_sys_t *)s;
102     filter->pf_audio_filter = Resample;
103     return VLC_SUCCESS;
104 }
105
106 static void Close (vlc_object_t *obj)
107 {
108     filter_t *filter = (filter_t *)obj;
109     SRC_STATE *s = (SRC_STATE *)filter->p_sys;
110
111     src_delete (s);
112 }
113
114 static block_t *Resample (filter_t *filter, block_t *in)
115 {
116     block_t *out = NULL;
117     const size_t framesize = filter->fmt_out.audio.i_bytes_per_frame;
118
119     SRC_STATE *s = (SRC_STATE *)filter->p_sys;
120     SRC_DATA src;
121
122     src.src_ratio = (double)filter->fmt_out.audio.i_rate
123                   / (double)filter->fmt_in.audio.i_rate;
124
125     int err = src_set_ratio (s, src.src_ratio);
126     if (err != 0)
127     {
128         msg_Err (filter, "cannot update resampling ratio: %s",
129                  src_strerror (err));
130         goto error;
131     }
132
133     src.input_frames = in->i_nb_samples;
134     src.output_frames = ceil (src.src_ratio * src.input_frames);
135     src.end_of_input = 0;
136
137     out = block_Alloc (src.output_frames * framesize);
138     if (unlikely(out == NULL))
139         goto error;
140
141     src.data_in = (float *)in->p_buffer;
142     src.data_out = (float *)out->p_buffer;
143
144     err = src_process (s, &src);
145     if (err != 0)
146     {
147         msg_Err (filter, "cannot resample: %s", src_strerror (err));
148         block_Release (out);
149         out = NULL;
150         goto error;
151     }
152
153     if (src.input_frames_used < src.input_frames)
154         msg_Err (filter, "lost %ld of %ld input frames",
155                  src.input_frames - src.input_frames_used, src.input_frames);
156
157     out->i_buffer = src.output_frames_gen * framesize;
158     out->i_nb_samples = src.output_frames_gen;
159     out->i_pts = in->i_pts;
160     out->i_length = src.output_frames_gen * CLOCK_FREQ
161                   / filter->fmt_out.audio.i_rate;
162 error:
163     block_Release (in);
164     return out;
165 }