lavfi: add flite audio source
[ffmpeg.git] / libavfilter / asrc_flite.c
1 /*
2  * Copyright (c) 2012 Stefano Sabatini
3  *
4  * This file is part of FFmpeg.
5  *
6  * FFmpeg is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * FFmpeg 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 GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with FFmpeg; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20
21 /**
22  * @file
23  * flite voice synth source
24  */
25
26 #include <flite/flite.h>
27 #include "libavutil/audioconvert.h"
28 #include "libavutil/file.h"
29 #include "libavutil/opt.h"
30 #include "avfilter.h"
31 #include "audio.h"
32 #include "formats.h"
33 #include "internal.h"
34
35 typedef struct {
36     const AVClass *class;
37     char *voice_str;
38     char *textfile;
39     char *text;
40     cst_wave *wave;
41     int16_t *wave_samples;
42     int      wave_nb_samples;
43     int list_voices;
44     cst_voice *voice;
45     int64_t pts;
46     int frame_nb_samples; ///< number of samples per frame
47 } FliteContext;
48
49 #define OFFSET(x) offsetof(FliteContext, x)
50
51 static const AVOption flite_options[] = {
52     { "list_voices", "list voices and exit",              OFFSET(list_voices), AV_OPT_TYPE_INT, {.dbl=0}, 0, 1 },
53     { "nb_samples",  "set number of samples per frame",   OFFSET(frame_nb_samples), AV_OPT_TYPE_INT, {.dbl=512}, 0, INT_MAX },
54     { "n",           "set number of samples per frame",   OFFSET(frame_nb_samples), AV_OPT_TYPE_INT, {.dbl=512}, 0, INT_MAX },
55     { "text",        "set text to speak",                 OFFSET(text),      AV_OPT_TYPE_STRING, {.str=NULL}, CHAR_MIN, CHAR_MAX },
56     { "textfile",    "set filename of the text to speak", OFFSET(textfile),  AV_OPT_TYPE_STRING, {.str=NULL}, CHAR_MIN, CHAR_MAX },
57     { "v",           "set voice",                         OFFSET(voice_str), AV_OPT_TYPE_STRING, {.str="kal"}, CHAR_MIN, CHAR_MAX },
58     { "voice",       "set voice",                         OFFSET(voice_str), AV_OPT_TYPE_STRING, {.str="kal"}, CHAR_MIN, CHAR_MAX },
59     { NULL }
60 };
61
62 AVFILTER_DEFINE_CLASS(flite);
63
64 static volatile int flite_inited = 0;
65
66 /* declare functions for all the supported voices */
67 #define DECLARE_REGISTER_VOICE_FN(name) cst_voice *register_cmu_us_## name(const char *)
68 DECLARE_REGISTER_VOICE_FN(awb);
69 DECLARE_REGISTER_VOICE_FN(kal);
70 DECLARE_REGISTER_VOICE_FN(kal16);
71 DECLARE_REGISTER_VOICE_FN(rms);
72 DECLARE_REGISTER_VOICE_FN(slt);
73
74 struct voice_entry {
75     const char *name;
76     cst_voice * (*register_fn)(const char *);
77 } voice_entry;
78
79 static struct voice_entry voice_entries[] = {
80     { "awb",   register_cmu_us_awb },
81     { "kal",   register_cmu_us_kal },
82     { "kal16", register_cmu_us_kal16 },
83     { "rms",   register_cmu_us_rms },
84     { "slt",   register_cmu_us_slt },
85 };
86
87 static void list_voices(void *log_ctx, const char *sep)
88 {
89     int i, n = FF_ARRAY_ELEMS(voice_entries);
90     for (i = 0; i < n; i++)
91         av_log(log_ctx, AV_LOG_INFO, "%s%s",
92                voice_entries[i].name, i < (n-1) ? sep : "\n");
93 }
94
95 static int select_voice(cst_voice **voice, const char *voice_name, void *log_ctx)
96 {
97     int i;
98
99     for (i = 0; i < FF_ARRAY_ELEMS(voice_entries); i++) {
100         struct voice_entry *entry = &voice_entries[i];
101         if (!strcmp(entry->name, voice_name)) {
102             *voice = entry->register_fn(NULL);
103             if (!*voice) {
104                 av_log(log_ctx, AV_LOG_ERROR,
105                        "Could not register voice '%s'\n", voice_name);
106                 return AVERROR_UNKNOWN;
107             }
108             return 0;
109         }
110     }
111
112     av_log(log_ctx, AV_LOG_ERROR, "Could not find voice '%s'\n", voice_name);
113     av_log(log_ctx, AV_LOG_INFO, "Choose between the voices: ");
114     list_voices(log_ctx, ", ");
115
116     return AVERROR(EINVAL);
117 }
118
119 static av_cold int init(AVFilterContext *ctx, const char *args)
120 {
121     FliteContext *flite = ctx->priv;
122     int ret = 0;
123
124     flite->class = &flite_class;
125     av_opt_set_defaults(flite);
126
127     if ((ret = av_set_options_string(flite, args, "=", ":")) < 0) {
128         av_log(ctx, AV_LOG_ERROR, "Error parsing options string: '%s'\n", args);
129         return ret;
130     }
131
132     if (flite->list_voices) {
133         list_voices(ctx, "\n");
134         return AVERROR_EXIT;
135     }
136
137     if (!flite_inited) {
138         if (flite_init() < 0) {
139             av_log(ctx, AV_LOG_ERROR, "flite initialization failed\n");
140             return AVERROR_UNKNOWN;
141         }
142         flite_inited++;
143     }
144
145     if ((ret = select_voice(&flite->voice, flite->voice_str, ctx)) < 0)
146         return ret;
147
148     if (flite->textfile && flite->text) {
149         av_log(ctx, AV_LOG_ERROR,
150                "Both text and textfile options set: only one must be specified\n");
151         return AVERROR(EINVAL);
152     }
153
154     if (flite->textfile) {
155         uint8_t *textbuf;
156         size_t textbuf_size;
157
158         if ((ret = av_file_map(flite->textfile, &textbuf, &textbuf_size, 0, ctx)) < 0) {
159             av_log(ctx, AV_LOG_ERROR,
160                    "The text file '%s' could not be read: %s\n",
161                    flite->textfile, av_err2str(ret));
162             return ret;
163         }
164
165         if (!(flite->text = av_malloc(textbuf_size+1)))
166             return AVERROR(ENOMEM);
167         memcpy(flite->text, textbuf, textbuf_size);
168         flite->text[textbuf_size] = 0;
169         av_file_unmap(textbuf, textbuf_size);
170     }
171
172     if (!flite->text) {
173         av_log(ctx, AV_LOG_ERROR,
174                "No speech text specified, specify the 'text' or 'textfile' option\n");
175         return AVERROR(EINVAL);
176     }
177
178     /* synth all the file data in block */
179     flite->wave = flite_text_to_wave(flite->text, flite->voice);
180     flite->wave_samples    = flite->wave->samples;
181     flite->wave_nb_samples = flite->wave->num_samples;
182     return 0;
183 }
184
185 static av_cold void uninit(AVFilterContext *ctx)
186 {
187     FliteContext *flite = ctx->priv;
188
189     av_opt_free(flite);
190
191     delete_voice(flite->voice);
192     flite->voice = NULL;
193     delete_wave(flite->wave);
194     flite->wave = NULL;
195 }
196
197 static int query_formats(AVFilterContext *ctx)
198 {
199     FliteContext *flite = ctx->priv;
200
201     AVFilterChannelLayouts *chlayouts = NULL;
202     int64_t chlayout = av_get_default_channel_layout(flite->wave->num_channels);
203     AVFilterFormats *sample_formats = NULL;
204     AVFilterFormats *sample_rates = NULL;
205
206     ff_add_channel_layout(&chlayouts, chlayout);
207     ff_set_common_channel_layouts(ctx, chlayouts);
208     ff_add_format(&sample_formats, AV_SAMPLE_FMT_S16);
209     ff_set_common_formats(ctx, sample_formats);
210     ff_add_format(&sample_rates, flite->wave->sample_rate);
211     ff_set_common_samplerates (ctx, sample_rates);
212
213     return 0;
214 }
215
216 static int config_props(AVFilterLink *outlink)
217 {
218     AVFilterContext *ctx = outlink->src;
219     FliteContext *flite = ctx->priv;
220
221     outlink->sample_rate = flite->wave->sample_rate;
222     outlink->time_base = (AVRational){1, flite->wave->sample_rate};
223
224     av_log(ctx, AV_LOG_VERBOSE, "voice:%s fmt:%s sample_rate:%d\n",
225            flite->voice_str,
226            av_get_sample_fmt_name(outlink->format), outlink->sample_rate);
227     return 0;
228 }
229
230 static int request_frame(AVFilterLink *outlink)
231 {
232     AVFilterBufferRef *samplesref;
233     FliteContext *flite = outlink->src->priv;
234     int nb_samples = FFMIN(flite->wave_nb_samples, flite->frame_nb_samples);
235
236     if (!nb_samples)
237         return AVERROR_EOF;
238
239     samplesref = ff_get_audio_buffer(outlink, AV_PERM_WRITE, nb_samples);
240     if (!samplesref)
241         return AVERROR(ENOMEM);
242
243     memcpy(samplesref->data[0], flite->wave_samples,
244            nb_samples * flite->wave->num_channels * 2);
245     samplesref->pts = flite->pts;
246     samplesref->pos = -1;
247     samplesref->audio->sample_rate = flite->wave->sample_rate;
248     flite->pts += nb_samples;
249     flite->wave_samples += nb_samples * flite->wave->num_channels;
250     flite->wave_nb_samples -= nb_samples;
251
252     return ff_filter_samples(outlink, samplesref);
253 }
254
255 AVFilter avfilter_asrc_flite = {
256     .name        = "flite",
257     .description = NULL_IF_CONFIG_SMALL("Synthesize voice from text using libflite."),
258     .query_formats = query_formats,
259     .init        = init,
260     .uninit      = uninit,
261     .priv_size   = sizeof(FliteContext),
262
263     .inputs = (const AVFilterPad[]) {{ .name = NULL}},
264
265     .outputs = (const AVFilterPad[]) {
266         {
267             .name = "default",
268             .type = AVMEDIA_TYPE_AUDIO,
269             .config_props = config_props,
270             .request_frame = request_frame,
271         },
272         { .name = NULL }
273     },
274 };