Add "audio resampler" capability to resamplers
[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
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 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 General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
19  *****************************************************************************/
20
21 #ifdef HAVE_CONFIG_H
22 # include "config.h"
23 #endif
24
25 #include <vlc_common.h>
26 #include <vlc_plugin.h>
27 #include <vlc_aout.h>
28 #include <vlc_filter.h>
29 #include <samplerate.h>
30 #include <math.h>
31
32 #define SRC_CONV_TYPE_TEXT N_("Sample rate converter type")
33 #define SRC_CONV_TYPE_LONGTEXT N_( \
34     "Different resampling algorithms are supported. " \
35     "The best one is slower, while the fast one exhibits low quality.")
36 static const int conv_type_values[] = {
37     SRC_SINC_BEST_QUALITY, SRC_SINC_MEDIUM_QUALITY, SRC_SINC_FASTEST,
38     SRC_ZERO_ORDER_HOLD, SRC_LINEAR,
39 };
40 static const char *const conv_type_texts[] = {
41     N_("Sinc function (best quality)"), N_("Sinc function (medium quality)"),
42     N_("Sinc function (fast)"), N_("Zero Order Hold (fastest)"), N_("Linear (fastest)"),
43 };
44
45 static int Open (vlc_object_t *);
46 static void Close (vlc_object_t *);
47
48 vlc_module_begin ()
49     set_shortname (N_("SRC resampler"))
50     set_description (N_("Secret Rabbit Code (libsamplerate) resampler") )
51     set_category (CAT_AUDIO)
52     set_subcategory (SUBCAT_AUDIO_MISC)
53     add_integer ("src-converter-type", SRC_SINC_FASTEST,
54                  SRC_CONV_TYPE_TEXT, SRC_CONV_TYPE_LONGTEXT, true)
55         change_integer_list (conv_type_values, conv_type_texts)
56     set_capability ("audio filter", 50)
57     set_callbacks (Open, Close)
58
59     add_submodule ()
60     set_capability ("audio resampler", 50)
61     set_callbacks (Open, Close)
62 vlc_module_end ()
63
64 static block_t *Resample (filter_t *, block_t *);
65
66 static int Open (vlc_object_t *obj)
67 {
68     filter_t *filter = (filter_t *)obj;
69
70     /* Only float->float */
71     if (filter->fmt_in.audio.i_format != VLC_CODEC_FL32
72      || filter->fmt_out.audio.i_format != VLC_CODEC_FL32
73     /* No channels remapping */
74      || filter->fmt_in.audio.i_physical_channels
75                                   != filter->fmt_out.audio.i_physical_channels
76      || filter->fmt_in.audio.i_original_channels
77                                   != filter->fmt_out.audio.i_original_channels
78     /* Different sample rate */
79      || filter->fmt_in.audio.i_rate == filter->fmt_out.audio.i_rate)
80         return VLC_EGENERIC;
81
82     int type = var_InheritInteger (obj, "src-converter-type");
83     int channels = aout_FormatNbChannels (&filter->fmt_in.audio);
84     int err;
85
86     SRC_STATE *s = src_new (type, channels, &err);
87     if (s == NULL)
88     {
89         msg_Err (obj, "cannot initialize resampler: %s", src_strerror (err));
90         return VLC_EGENERIC;
91     }
92
93     filter->p_sys = (filter_sys_t *)s;
94     filter->pf_audio_filter = Resample;
95     return VLC_SUCCESS;
96 }
97
98 static void Close (vlc_object_t *obj)
99 {
100     filter_t *filter = (filter_t *)obj;
101     SRC_STATE *s = (SRC_STATE *)filter->p_sys;
102
103     src_delete (s);
104 }
105
106 static block_t *Resample (filter_t *filter, block_t *in)
107 {
108     block_t *out = NULL;
109     const size_t framesize = filter->fmt_out.audio.i_bytes_per_frame;
110
111     SRC_STATE *s = (SRC_STATE *)filter->p_sys;
112     SRC_DATA src;
113
114     src.src_ratio = (double)filter->fmt_out.audio.i_rate
115                   / (double)filter->fmt_in.audio.i_rate;
116
117     int err = src_set_ratio (s, src.src_ratio);
118     if (err != 0)
119     {
120         msg_Err (filter, "cannot update resampling ratio: %s",
121                  src_strerror (err));
122         goto error;
123     }
124
125     src.input_frames = in->i_nb_samples;
126     src.output_frames = ceil (src.src_ratio * src.input_frames);
127     src.end_of_input = 0;
128
129     out = block_Alloc (src.output_frames * framesize);
130     if (unlikely(out == NULL))
131         goto error;
132
133     src.data_in = (float *)in->p_buffer;
134     src.data_out = (float *)out->p_buffer;
135
136     err = src_process (s, &src);
137     if (err != 0)
138     {
139         msg_Err (filter, "cannot resample: %s", src_strerror (err));
140         block_Release (out);
141         out = NULL;
142         goto error;
143     }
144
145     if (src.input_frames_used < src.input_frames)
146         msg_Err (filter, "lost %ld of %ld input frames",
147                  src.input_frames - src.input_frames_used, src.input_frames);
148
149     out->i_buffer = src.output_frames_gen * framesize;
150     out->i_nb_samples = src.output_frames_gen;
151     out->i_pts = in->i_pts;
152     out->i_length = src.output_frames_gen * CLOCK_FREQ
153                   / filter->fmt_out.audio.i_rate;
154 error:
155     block_Release (in);
156     return out;
157 }