yading@10: /*
yading@10:  * Copyright (c) 2012 Stefano Sabatini
yading@10:  *
yading@10:  * This file is part of FFmpeg.
yading@10:  *
yading@10:  * FFmpeg is free software; you can redistribute it and/or
yading@10:  * modify it under the terms of the GNU Lesser General Public
yading@10:  * License as published by the Free Software Foundation; either
yading@10:  * version 2.1 of the License, or (at your option) any later version.
yading@10:  *
yading@10:  * FFmpeg is distributed in the hope that it will be useful,
yading@10:  * but WITHOUT ANY WARRANTY; without even the implied warranty of
yading@10:  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
yading@10:  * Lesser General Public License for more details.
yading@10:  *
yading@10:  * You should have received a copy of the GNU Lesser General Public
yading@10:  * License along with FFmpeg; if not, write to the Free Software
yading@10:  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
yading@10:  */
yading@10: 
yading@10: /**
yading@10:  * @file
yading@10:  * flite voice synth source
yading@10:  */
yading@10: 
yading@10: #include <flite/flite.h>
yading@10: #include "libavutil/channel_layout.h"
yading@10: #include "libavutil/file.h"
yading@10: #include "libavutil/opt.h"
yading@10: #include "avfilter.h"
yading@10: #include "audio.h"
yading@10: #include "formats.h"
yading@10: #include "internal.h"
yading@10: 
yading@10: typedef struct {
yading@10:     const AVClass *class;
yading@10:     char *voice_str;
yading@10:     char *textfile;
yading@10:     char *text;
yading@10:     cst_wave *wave;
yading@10:     int16_t *wave_samples;
yading@10:     int      wave_nb_samples;
yading@10:     int list_voices;
yading@10:     cst_voice *voice;
yading@10:     struct voice_entry *voice_entry;
yading@10:     int64_t pts;
yading@10:     int frame_nb_samples; ///< number of samples per frame
yading@10: } FliteContext;
yading@10: 
yading@10: #define OFFSET(x) offsetof(FliteContext, x)
yading@10: #define FLAGS AV_OPT_FLAG_AUDIO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
yading@10: 
yading@10: static const AVOption flite_options[] = {
yading@10:     { "list_voices", "list voices and exit",              OFFSET(list_voices), AV_OPT_TYPE_INT, {.i64=0}, 0, 1, FLAGS },
yading@10:     { "nb_samples",  "set number of samples per frame",   OFFSET(frame_nb_samples), AV_OPT_TYPE_INT, {.i64=512}, 0, INT_MAX, FLAGS },
yading@10:     { "n",           "set number of samples per frame",   OFFSET(frame_nb_samples), AV_OPT_TYPE_INT, {.i64=512}, 0, INT_MAX, FLAGS },
yading@10:     { "text",        "set text to speak",                 OFFSET(text),      AV_OPT_TYPE_STRING, {.str=NULL}, CHAR_MIN, CHAR_MAX, FLAGS },
yading@10:     { "textfile",    "set filename of the text to speak", OFFSET(textfile),  AV_OPT_TYPE_STRING, {.str=NULL}, CHAR_MIN, CHAR_MAX, FLAGS },
yading@10:     { "v",           "set voice",                         OFFSET(voice_str), AV_OPT_TYPE_STRING, {.str="kal"}, CHAR_MIN, CHAR_MAX, FLAGS },
yading@10:     { "voice",       "set voice",                         OFFSET(voice_str), AV_OPT_TYPE_STRING, {.str="kal"}, CHAR_MIN, CHAR_MAX, FLAGS },
yading@10:     { NULL }
yading@10: };
yading@10: 
yading@10: AVFILTER_DEFINE_CLASS(flite);
yading@10: 
yading@10: static volatile int flite_inited = 0;
yading@10: 
yading@10: /* declare functions for all the supported voices */
yading@10: #define DECLARE_REGISTER_VOICE_FN(name) \
yading@10:     cst_voice *register_cmu_us_## name(const char *); \
yading@10:     void     unregister_cmu_us_## name(cst_voice *);
yading@10: DECLARE_REGISTER_VOICE_FN(awb);
yading@10: DECLARE_REGISTER_VOICE_FN(kal);
yading@10: DECLARE_REGISTER_VOICE_FN(kal16);
yading@10: DECLARE_REGISTER_VOICE_FN(rms);
yading@10: DECLARE_REGISTER_VOICE_FN(slt);
yading@10: 
yading@10: struct voice_entry {
yading@10:     const char *name;
yading@10:     cst_voice * (*register_fn)(const char *);
yading@10:     void (*unregister_fn)(cst_voice *);
yading@10:     cst_voice *voice;
yading@10:     unsigned usage_count;
yading@10: } voice_entry;
yading@10: 
yading@10: #define MAKE_VOICE_STRUCTURE(voice_name) {             \
yading@10:     .name          =                      #voice_name, \
yading@10:     .register_fn   =   register_cmu_us_ ## voice_name, \
yading@10:     .unregister_fn = unregister_cmu_us_ ## voice_name, \
yading@10: }
yading@10: static struct voice_entry voice_entries[] = {
yading@10:     MAKE_VOICE_STRUCTURE(awb),
yading@10:     MAKE_VOICE_STRUCTURE(kal),
yading@10:     MAKE_VOICE_STRUCTURE(kal16),
yading@10:     MAKE_VOICE_STRUCTURE(rms),
yading@10:     MAKE_VOICE_STRUCTURE(slt),
yading@10: };
yading@10: 
yading@10: static void list_voices(void *log_ctx, const char *sep)
yading@10: {
yading@10:     int i, n = FF_ARRAY_ELEMS(voice_entries);
yading@10:     for (i = 0; i < n; i++)
yading@10:         av_log(log_ctx, AV_LOG_INFO, "%s%s",
yading@10:                voice_entries[i].name, i < (n-1) ? sep : "\n");
yading@10: }
yading@10: 
yading@10: static int select_voice(struct voice_entry **entry_ret, const char *voice_name, void *log_ctx)
yading@10: {
yading@10:     int i;
yading@10: 
yading@10:     for (i = 0; i < FF_ARRAY_ELEMS(voice_entries); i++) {
yading@10:         struct voice_entry *entry = &voice_entries[i];
yading@10:         if (!strcmp(entry->name, voice_name)) {
yading@10:             if (!entry->voice)
yading@10:                 entry->voice = entry->register_fn(NULL);
yading@10:             if (!entry->voice) {
yading@10:                 av_log(log_ctx, AV_LOG_ERROR,
yading@10:                        "Could not register voice '%s'\n", voice_name);
yading@10:                 return AVERROR_UNKNOWN;
yading@10:             }
yading@10:             entry->usage_count++;
yading@10:             *entry_ret = entry;
yading@10:             return 0;
yading@10:         }
yading@10:     }
yading@10: 
yading@10:     av_log(log_ctx, AV_LOG_ERROR, "Could not find voice '%s'\n", voice_name);
yading@10:     av_log(log_ctx, AV_LOG_INFO, "Choose between the voices: ");
yading@10:     list_voices(log_ctx, ", ");
yading@10: 
yading@10:     return AVERROR(EINVAL);
yading@10: }
yading@10: 
yading@10: static av_cold int init(AVFilterContext *ctx)
yading@10: {
yading@10:     FliteContext *flite = ctx->priv;
yading@10:     int ret = 0;
yading@10: 
yading@10:     if (flite->list_voices) {
yading@10:         list_voices(ctx, "\n");
yading@10:         return AVERROR_EXIT;
yading@10:     }
yading@10: 
yading@10:     if (!flite_inited) {
yading@10:         if (flite_init() < 0) {
yading@10:             av_log(ctx, AV_LOG_ERROR, "flite initialization failed\n");
yading@10:             return AVERROR_UNKNOWN;
yading@10:         }
yading@10:         flite_inited++;
yading@10:     }
yading@10: 
yading@10:     if ((ret = select_voice(&flite->voice_entry, flite->voice_str, ctx)) < 0)
yading@10:         return ret;
yading@10:     flite->voice = flite->voice_entry->voice;
yading@10: 
yading@10:     if (flite->textfile && flite->text) {
yading@10:         av_log(ctx, AV_LOG_ERROR,
yading@10:                "Both text and textfile options set: only one must be specified\n");
yading@10:         return AVERROR(EINVAL);
yading@10:     }
yading@10: 
yading@10:     if (flite->textfile) {
yading@10:         uint8_t *textbuf;
yading@10:         size_t textbuf_size;
yading@10: 
yading@10:         if ((ret = av_file_map(flite->textfile, &textbuf, &textbuf_size, 0, ctx)) < 0) {
yading@10:             av_log(ctx, AV_LOG_ERROR,
yading@10:                    "The text file '%s' could not be read: %s\n",
yading@10:                    flite->textfile, av_err2str(ret));
yading@10:             return ret;
yading@10:         }
yading@10: 
yading@10:         if (!(flite->text = av_malloc(textbuf_size+1)))
yading@10:             return AVERROR(ENOMEM);
yading@10:         memcpy(flite->text, textbuf, textbuf_size);
yading@10:         flite->text[textbuf_size] = 0;
yading@10:         av_file_unmap(textbuf, textbuf_size);
yading@10:     }
yading@10: 
yading@10:     if (!flite->text) {
yading@10:         av_log(ctx, AV_LOG_ERROR,
yading@10:                "No speech text specified, specify the 'text' or 'textfile' option\n");
yading@10:         return AVERROR(EINVAL);
yading@10:     }
yading@10: 
yading@10:     /* synth all the file data in block */
yading@10:     flite->wave = flite_text_to_wave(flite->text, flite->voice);
yading@10:     flite->wave_samples    = flite->wave->samples;
yading@10:     flite->wave_nb_samples = flite->wave->num_samples;
yading@10:     return 0;
yading@10: }
yading@10: 
yading@10: static av_cold void uninit(AVFilterContext *ctx)
yading@10: {
yading@10:     FliteContext *flite = ctx->priv;
yading@10: 
yading@10:     if (!--flite->voice_entry->usage_count)
yading@10:         flite->voice_entry->unregister_fn(flite->voice);
yading@10:     flite->voice = NULL;
yading@10:     flite->voice_entry = NULL;
yading@10:     delete_wave(flite->wave);
yading@10:     flite->wave = NULL;
yading@10: }
yading@10: 
yading@10: static int query_formats(AVFilterContext *ctx)
yading@10: {
yading@10:     FliteContext *flite = ctx->priv;
yading@10: 
yading@10:     AVFilterChannelLayouts *chlayouts = NULL;
yading@10:     int64_t chlayout = av_get_default_channel_layout(flite->wave->num_channels);
yading@10:     AVFilterFormats *sample_formats = NULL;
yading@10:     AVFilterFormats *sample_rates = NULL;
yading@10: 
yading@10:     ff_add_channel_layout(&chlayouts, chlayout);
yading@10:     ff_set_common_channel_layouts(ctx, chlayouts);
yading@10:     ff_add_format(&sample_formats, AV_SAMPLE_FMT_S16);
yading@10:     ff_set_common_formats(ctx, sample_formats);
yading@10:     ff_add_format(&sample_rates, flite->wave->sample_rate);
yading@10:     ff_set_common_samplerates (ctx, sample_rates);
yading@10: 
yading@10:     return 0;
yading@10: }
yading@10: 
yading@10: static int config_props(AVFilterLink *outlink)
yading@10: {
yading@10:     AVFilterContext *ctx = outlink->src;
yading@10:     FliteContext *flite = ctx->priv;
yading@10: 
yading@10:     outlink->sample_rate = flite->wave->sample_rate;
yading@10:     outlink->time_base = (AVRational){1, flite->wave->sample_rate};
yading@10: 
yading@10:     av_log(ctx, AV_LOG_VERBOSE, "voice:%s fmt:%s sample_rate:%d\n",
yading@10:            flite->voice_str,
yading@10:            av_get_sample_fmt_name(outlink->format), outlink->sample_rate);
yading@10:     return 0;
yading@10: }
yading@10: 
yading@10: static int request_frame(AVFilterLink *outlink)
yading@10: {
yading@10:     AVFrame *samplesref;
yading@10:     FliteContext *flite = outlink->src->priv;
yading@10:     int nb_samples = FFMIN(flite->wave_nb_samples, flite->frame_nb_samples);
yading@10: 
yading@10:     if (!nb_samples)
yading@10:         return AVERROR_EOF;
yading@10: 
yading@10:     samplesref = ff_get_audio_buffer(outlink, nb_samples);
yading@10:     if (!samplesref)
yading@10:         return AVERROR(ENOMEM);
yading@10: 
yading@10:     memcpy(samplesref->data[0], flite->wave_samples,
yading@10:            nb_samples * flite->wave->num_channels * 2);
yading@10:     samplesref->pts = flite->pts;
yading@10:     av_frame_set_pkt_pos(samplesref, -1);
yading@10:     av_frame_set_sample_rate(samplesref, flite->wave->sample_rate);
yading@10:     flite->pts += nb_samples;
yading@10:     flite->wave_samples += nb_samples * flite->wave->num_channels;
yading@10:     flite->wave_nb_samples -= nb_samples;
yading@10: 
yading@10:     return ff_filter_frame(outlink, samplesref);
yading@10: }
yading@10: 
yading@10: static const AVFilterPad flite_outputs[] = {
yading@10:     {
yading@10:         .name          = "default",
yading@10:         .type          = AVMEDIA_TYPE_AUDIO,
yading@10:         .config_props  = config_props,
yading@10:         .request_frame = request_frame,
yading@10:     },
yading@10:     { NULL }
yading@10: };
yading@10: 
yading@10: AVFilter avfilter_asrc_flite = {
yading@10:     .name        = "flite",
yading@10:     .description = NULL_IF_CONFIG_SMALL("Synthesize voice from text using libflite."),
yading@10:     .query_formats = query_formats,
yading@10:     .init        = init,
yading@10:     .uninit      = uninit,
yading@10:     .priv_size   = sizeof(FliteContext),
yading@10:     .inputs      = NULL,
yading@10:     .outputs     = flite_outputs,
yading@10:     .priv_class  = &flite_class,
yading@10: };