Browse files

Initial commit.

Working cache mechanism. Support for wide-band audio.
  • Loading branch information...
0 parents commit b82e9bf955c9c1eb335132ab89a46de900364c80 @zaf committed Mar 18, 2012
Showing with 862 additions and 0 deletions.
  1. +340 −0 COPYING
  2. +3 −0 ChangeLog
  3. +95 −0 README
  4. +1 −0 authors
  5. +177 −0 cli/mstts-cli.pl
  6. +246 −0 mstts.agi
340 COPYING
@@ -0,0 +1,340 @@
+ GNU GENERAL PUBLIC LICENSE
+ Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The licenses for most software are designed to take away your
+freedom to share and change it. By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users. This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it. (Some other Free Software Foundation software is covered by
+the GNU Lesser General Public License instead.) You can apply it to
+your programs, too.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+ To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have. You must make sure that they, too, receive or can get the
+source code. And you must show them these terms so they know their
+rights.
+
+ We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+ Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software. If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+ Finally, any free program is threatened constantly by software
+patents. We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary. To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ GNU GENERAL PUBLIC LICENSE
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+ 0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License. The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language. (Hereinafter, translation is included without limitation in
+the term "modification".) Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope. The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+ 1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+ 2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+ a) You must cause the modified files to carry prominent notices
+ stating that you changed the files and the date of any change.
+
+ b) You must cause any work that you distribute or publish, that in
+ whole or in part contains or is derived from the Program or any
+ part thereof, to be licensed as a whole at no charge to all third
+ parties under the terms of this License.
+
+ c) If the modified program normally reads commands interactively
+ when run, you must cause it, when started running for such
+ interactive use in the most ordinary way, to print or display an
+ announcement including an appropriate copyright notice and a
+ notice that there is no warranty (or else, saying that you provide
+ a warranty) and that users may redistribute the program under
+ these conditions, and telling the user how to view a copy of this
+ License. (Exception: if the Program itself is interactive but
+ does not normally print such an announcement, your work based on
+ the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole. If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works. But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+ 3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+ a) Accompany it with the complete corresponding machine-readable
+ source code, which must be distributed under the terms of Sections
+ 1 and 2 above on a medium customarily used for software interchange; or,
+
+ b) Accompany it with a written offer, valid for at least three
+ years, to give any third party, for a charge no more than your
+ cost of physically performing source distribution, a complete
+ machine-readable copy of the corresponding source code, to be
+ distributed under the terms of Sections 1 and 2 above on a medium
+ customarily used for software interchange; or,
+
+ c) Accompany it with the information you received as to the offer
+ to distribute corresponding source code. (This alternative is
+ allowed only for noncommercial distribution and only if you
+ received the program in object code or executable form with such
+ an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it. For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable. However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+ 4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License. Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+ 5. You are not required to accept this License, since you have not
+signed it. However, nothing else grants you permission to modify or
+distribute the Program or its derivative works. These actions are
+prohibited by law if you do not accept this License. Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+ 6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions. You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+ 7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all. For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices. Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+ 8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded. In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+ 9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number. If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation. If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+ 10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission. For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this. Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+ NO WARRANTY
+
+ 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+ 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+ END OF TERMS AND CONDITIONS
+
+ How to Apply These Terms to Your New Programs
+
+ If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+ To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+ <one line to give the program's name and a brief idea of what it does.>
+ Copyright (C) <year> <name of author>
+
+ This program is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 2 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License along
+ with this program; if not, write to the Free Software Foundation, Inc.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+ Gnomovision version 69, Copyright (C) year name of author
+ Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+ This is free software, and you are welcome to redistribute it
+ under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License. Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary. Here is a sample; alter the names:
+
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+ `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+ <signature of Ty Coon>, 1 April 1989
+ Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs. If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library. If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.
+
3 ChangeLog
@@ -0,0 +1,3 @@
+2012-03-18 Lefteris Zafiris <zaf.000@gmail.com> - 0.1
+ Initial release 0.1
+ Working cache mechanism. Support for wide-band audio.
95 README
@@ -0,0 +1,95 @@
+=============================================
+ Microsoft TTS script for Asterisk
+=============================================
+
+This script makes use of Microsoft Translator text to speech service
+in order to redner text to speech and play it back to the user.
+It supports a variety of different languages.
+
+------------
+Requirements
+------------
+Perl The Perl Programming Language
+perl-libwww The World-Wide Web library for Perl
+sox Sound eXchange, sound processing program
+API Key (appid) from http://www.bing.com/developers/appids.aspx
+Internet access in order to contact MS and get the voice data.
+
+------------
+Installation
+------------
+To install copy mstts.agi to your agi-bin directory.
+Usually this is /var/lib/asterisk/agi-bin/
+To make sure check your /etc/asterisk/asterisk.conf file
+
+-----
+Usage
+-----
+agi(mstts.agi,text,[language],[intkey]): This will invoke the MS Translator TTS engine,
+render the text string to speech and play it back to the user. If 'intkey' is set
+the script will wait for user input. Any given interrupt keys will cause the playback
+to immediately terminate and the dialplan to proceed to the matching extension (for use in IVR).
+
+The script contacts MS TTS service in order to get the voice data
+which then stores in a local cache (by default /tmp/) for future use.
+Parameters like default language, enabling or disabling caching and cache dir
+can be set up by editing the script.
+
+--------
+Examples
+--------
+sample dialplan code for your extensions.conf
+
+;MSTTS Demo
+;PLayback messages to user
+
+exten => 1234,1,Answer()
+ ;;Play mesage in English:
+exten => 1234,n,agi(mstts.agi,"This is a simple microsoft text to speech test in english.",en)
+ ;;Play message in Spanish
+exten => 1234,n,agi(mstts.agi,"Esta es una simple prueba en español.",es)
+ ;;Play message in Japanese
+exten => 1234,n,agi(mstts.agi,"これは、日本の簡単なテストです。良い一日を。",ja)
+
+;A simple dynamic IVR using MSTTS
+
+[my_ivr]
+exten => s,1,Answer()
+exten => s,n,Set(TIMEOUT(digit)=5)
+exten => s,n,agi(mstts.agi,"Welcome to my small interactive voice response menu.",en)
+ ;;Wait for digit:
+exten => s,n(start),agi(mstts.agi,"Please dial a digit.",en,any)
+exten => s,n,WaitExten()
+
+ ;;PLayback the name of the digit and wait for another one:
+exten => _X,1,agi(mstts.agi,"You just pressed ${EXTEN}. Try another one please.",en,any)
+exten => _X,n,WaitExten()
+
+exten => i,1,agi(mstts.agi,"Invalid extension.",en)
+exten => i,n,goto(s,start)
+
+exten => t,1,agi(mstts.agi,"Request timed out.",en)
+exten => t,n,goto(s,start)
+
+exten => h,1,Hangup()
+
+-------------------
+Supported Languages
+-------------------
+ca ca-es da da-dk
+de de-de en en-au
+en-ca en-gb en-in en-us
+es es-es es-mx fi
+fi-fi fr fr-ca fr-fr
+it it-it ja ja-jp
+ko ko-kr nb-no nl
+nl-nl no pl pl-pl
+pt pt-br pt-pt ru
+ru-ru sv sv-se zh-chs
+zh-cht zh-cn zh-hk zh-tw
+
+-------
+License
+-------
+The MStts script for asterisk is distributed under the GNU General Public
+License v2. See COPYING for details.
1 authors
@@ -0,0 +1 @@
+Lefteris Zafiris <zaf.000@gmail.com>
177 cli/mstts-cli.pl
@@ -0,0 +1,177 @@
+#!/usr/bin/env perl
+
+#
+# Script that uses Microsoft Translator for text to speech synthesis.
+#
+# In order to use this script an API Key (appid)
+# from http://www.bing.com/developers/appids.aspx is needed.
+#
+# Copyright (C) 2012, Lefteris Zafiris <zaf.000@gmail.com>
+#
+# This program is free software, distributed under the terms of
+# the GNU General Public License Version 2.
+#
+
+use warnings;
+use strict;
+use Getopt::Std;
+use File::Copy qw(move);
+use File::Temp qw(tempfile);
+use CGI::Util qw(escape);
+use LWP::UserAgent;
+
+# --------------------------------------- #
+# Here you can assign your App ID from MS #
+my $appid = "";
+# --------------------------------------- #
+my %options;
+my $input;
+my $ua;
+my $request;
+my $response;
+my $mp3fh;
+my $mp3name;
+my $lang = "en";
+my $format = "audio/mp3";
+my $tmpdir = "/tmp";
+my $timeout = 10;
+my $url = "http://api.microsofttranslator.com/V2/Http.svc";
+my $mpg123 = `/usr/bin/which mpg123`;
+
+VERSION_MESSAGE() if (!@ARGV);
+
+getopts('o:l:t:f:i:hqv', \%options);
+
+# Dislpay help messages #
+VERSION_MESSAGE() if (defined $options{h});
+lang_list() if (defined $options{v});
+
+if (!$mpg123) {
+ say_msg("mpg123 is missing. Aborting.");
+ exit 1;
+}
+chomp($mpg123);
+
+
+$appid = $options{i} if (defined $options{i});
+if (!$appid) {
+ say_msg("You must have an App ID from Microsoft to use this script.");
+ exit 1;
+}
+
+if (defined $options{l}) {
+# check if language setting is valid #
+ if ($options{l} =~ /\w+/) {
+ $lang = $options{l};
+ } else {
+ say_msg("Invalid language setting. Aborting.");
+ exit 1;
+ }
+}
+
+$format = "audio/wav" if (defined $options{o});
+
+# Get input text #
+if (defined $options{t}) {
+ $input = $options{t};
+} elsif (defined $options{f}) {
+ if (open(my $fh, "<", "$options{f}")) {
+ $input = do { local $/; <$fh> };
+ close($fh);
+ } else {
+ say_msg("Cant read file $options{f}");
+ exit 1;
+ }
+} else {
+ say_msg("No text passed for synthesis.");
+ exit 1;
+}
+
+for ($input) {
+ s/[\\|*~<>^\n\(\)\[\]\{\}[:cntrl:]]/ /g;
+ s/\s+/ /g;
+ s/^\s|\s$//g;
+ if (!length) {
+ say_msg("No text passed for synthesis.");
+ exit 1;
+ }
+ $_ = escape($_);
+}
+
+$ua = LWP::UserAgent->new;
+$ua->agent("Mozilla/5.0 (X11; Linux; rv:8.0) Gecko/20100101");
+$ua->timeout($timeout);
+
+$request = HTTP::Request->new(
+ 'GET' => "$url/Speak?text=$input&language=$lang&format=$format&options=MaxQuality&appid=$appid"
+);
+
+$response = $ua->request($request);
+if (!$response->is_success) {
+ say_msg("Failed to fetch speech data.");
+ exit 1;
+} else {
+ ($mp3fh, $mp3name) = tempfile(
+ "mstts_XXXXXX",
+ SUFFIX => ".mp3",
+ DIR => $tmpdir,
+ UNLINK => 1,
+ );
+ if (!open($mp3fh, ">", "$mp3name")) {
+ say_msg("Cant read temp file $mp3name");
+ exit 1;
+ }
+ print $mp3fh $response->content;
+ close $mp3fh;
+}
+
+# Set mpg123 args and process sound file #
+if (defined $options{o}) {
+ move("$mp3name", "$options{o}");
+} elsif (system($mpg123, "-q", "$mp3name")) {
+ say_msg("Failed to process sound file.");
+ exit 1;
+}
+exit 0;
+
+sub say_msg {
+# Print messages to user if 'quiet' flag is not set #
+ my $message = shift;
+ warn "$0: $message" if (!defined $options{q});
+ return;
+}
+
+sub VERSION_MESSAGE {
+# Help message #
+ print "Text to speech synthesis using Microsoft Translator API.\n\n",
+ "Supported options:\n",
+ " -t <text> text string to synthesize\n",
+ " -f <file> text file to synthesize\n",
+ " -l <lang> specify the language to use, defaults to 'en' (English)\n",
+ " -o <filename> write output as wav file\n",
+ " -i <appID> set the App ID from MS\n",
+ " -q quiet (Don't print any messages or warnings)\n",
+ " -h this help message\n",
+ " -v suppoted languages list\n\n",
+ "Examples:\n",
+ "$0 -l en -t \"Hello world\"\n Have the synthesized speech played back to the user.\n",
+ "$0 -o hello.wav -l en -t \"Hello world\"\n Save the synthesized speech as a wav file.\n\n";
+ exit 1;
+}
+
+sub lang_list {
+# Display the list of supported languages #
+ $ua = LWP::UserAgent->new;
+ $ua->agent("Mozilla/5.0 (X11; Linux; rv:8.0) Gecko/20100101");
+ $ua->timeout($timeout);
+ $request = HTTP::Request->new('GET' => "$url/GetLanguagesForSpeak?appid=$appid");
+ $response = $ua->request($request);
+ if (!$response->is_success) {
+ say_msg("Failed to fetch language list.");
+ } else {
+ my @list = split(/<string>([a-z\-]*?)<\/string>/,$response->content);
+ print "$_\t" foreach (@list[1..($#list-1)]);
+ print "\n";
+ }
+ exit 1;
+}
246 mstts.agi
@@ -0,0 +1,246 @@
+#!/usr/bin/env perl
+
+#
+# AGI script that uses Google's translate text to speech engine.
+#
+# Copyright (C) 2011 -2012, Lefteris Zafiris <zaf.000@gmail.com>
+#
+# This program is free software, distributed under the terms of
+# the GNU General Public License Version 2. See the COPYING file
+# at the top of the source tree.
+#
+# -----
+# Usage
+# -----
+# agi(mstts.agi,"text",[language],[intkey]): This will invoke the Microsoft TTS engine,
+# render the text string to speech and play it back to the user. If 'intkey' is set the
+# script will wait for user input. Any given interrupt keys will cause the playback
+# to immediately terminate and the dialplan to proceed to the matching extension
+# (this is mainly for use in IVR, see README for examples).
+#
+# The script contacts Microsoft Translate TTS service in order to get the voice data
+# which then stores in a local cache (by default /tmp/) for future use.
+#
+# An API Key (appid) from http://www.bing.com/developers/appids.aspx is required.
+# Parameters like default language, sample rate, caching and cache dir
+# can be set up by altering the following variables:
+# Default langeuage: $lang
+# Sample rate: $samplerate
+# Chace: $usecache
+# Chache directory: $cachedir
+#
+
+use warnings;
+use strict;
+use File::Temp qw(tempfile);
+use File::Copy qw(move);
+use File::Path qw(mkpath);
+use Digest::MD5 qw(md5_hex);
+use CGI::Util qw(escape);
+use LWP::UserAgent;
+$| = 1;
+
+# ----------------------------- #
+# User defined parameters: #
+# ----------------------------- #
+# App ID from MS #
+my $appid = "";
+
+# Default language #
+my $lang = "en";
+
+# Output audio sample rate #
+my $samplerate = 8000;
+
+# Use of cache mechanism #
+my $usecache = 1;
+
+# Cache directory path #
+my $cachedir = "/tmp";
+
+# Verbose debugging messages #
+my $debug = 0;
+
+# ----------------------------- #
+
+my %AGI;
+my $text;
+my $filename;
+my $fexten;
+my @result;
+my $name;
+my $format = "audio/wav";
+my $intkey = "";
+my $tmpdir = "/tmp";
+my $maxlen = 2048;
+my $url = "http://api.microsofttranslator.com/V2/Http.svc";
+my $sox = `/usr/bin/which sox`;
+
+# Store AGI input #
+while (<STDIN>) {
+ chomp;
+ last if (!length);
+ $AGI{$1} = $2 if (/^agi_(\w+)\:\s+(.*)$/);
+}
+($AGI{arg_1}, $AGI{arg_2}, $AGI{arg_3}) = @ARGV;
+
+$name = " -- $AGI{request}:";
+
+#if ($debug) {
+# warn "$name AGI Environment Dump:\n";
+# warn "$name $_ = $AGI{$_}\n" foreach (sort keys %AGI);
+#}
+
+# Abort if required programs not found. #
+die "$name sox is missing. Aborting.\n" if (!$sox);
+
+chomp($sox);
+warn "$name Found sox in: $sox\n" if ($debug);
+
+# Sanitising input #
+for ($AGI{arg_1}) {
+ s/[\\|*~<>^\(\)\[\]\{\}[:cntrl:]]/ /g;
+ s/\s+/ /g;
+ s/^\s|\s$//g;
+ die "$name No text passed for synthesis.\n" if (!length);
+ $text = $_;
+}
+
+# Setting language and interrupt keys #
+if (length($AGI{arg_2})) {
+ if ($AGI{arg_2} =~ /[a-z]{2}(-[a-z]{2,3})?/) {
+ $lang = $AGI{arg_2};
+ } else {
+ die "$name Invalid language setting.\n";
+ }
+}
+if (length($AGI{arg_3})) {
+ $intkey = "0123456789#*" if ($AGI{arg_3} eq "any");
+ $intkey = $AGI{arg_3} if ($AGI{arg_3} =~ /^[0-9*#]+$/);
+}
+
+# Setting filename extension according to sample rate. #
+if ($samplerate == 16000) {
+ $fexten = "wav16";
+} else {
+ $fexten = "wav";
+ $samplerate = 8000;
+}
+
+# Check cache path size: dir length + md5 + file extension #
+if ($usecache && ((length($cachedir) + 32 + 6) > $maxlen)) {
+ warn "$name Cache path size exceeds limit. Disabling cache.\n";
+ $usecache = 0;
+}
+
+# Answer channel if not already answered #
+print "CHANNEL STATUS\n";
+@result = checkresponse();
+if ($result[0] == 4) {
+ print "ANSWER\n";
+ checkresponse();
+}
+
+if ($debug) {
+ warn "$name Text passed for synthesis: $text\n",
+ "$name Language: $lang, Interrupt keys: $intkey, Sample rate: $samplerate\n",
+ "$name Caching: $usecache, Cache dir: $cachedir\n";
+}
+
+if ($usecache) {
+ $filename = md5_hex($text);
+ # Stream file from cache if it exists #
+ if (-r "$cachedir/$filename.$fexten") {
+ warn "$name File already in cache.\n" if ($debug);
+ playback("$cachedir/$filename", $intkey);
+ exit;
+ }
+}
+
+# Synthesize speech using MS Translator API #
+my $ua = LWP::UserAgent->new;
+$ua->agent("Mozilla/5.0 (X11; Linux; rv:8.0) Gecko/20100101");
+$ua->timeout(5);
+$text = escape($text);
+my $request = HTTP::Request->new(
+ 'GET' => "$url/Speak?text=$text&language=$lang&format=$format&options=MaxQuality&appid=$appid"
+);
+# Hnadle interrupts #
+$SIG{'INT'} = \&int_handler;
+$SIG{'HUP'} = \&int_handler;
+
+my $response = $ua->request($request);
+die "$name Failed to fetch file.\n" if (!$response->is_success);
+my ($tmpfh, $tmpname) = tempfile("mstts_XXXXXX", DIR => $tmpdir, UNLINK => 1);
+open($tmpfh, ">", "$tmpname") or die "$name Failed to open file: $!\n";
+print $tmpfh $response->content;
+close $tmpfh or warn "$name Failed to close file: $!\n";
+
+# Resample file if needed #
+if ($samplerate != 16000) {
+ system($sox, $tmpname, "-q", "-r", $samplerate, "$tmpname.$fexten");
+} else {
+ move($tmpname, "$tmpname.$fexten");
+}
+
+# Play back to the user and save in cache #
+playback($tmpname, $intkey);
+if ($usecache) {
+ mkpath("$cachedir") unless (-d "$cachedir");
+ warn "$name Saving file $filename to cache\n" if ($debug);
+ move("$tmpname.$fexten", "$cachedir/$filename.$fexten");
+}
+unlink glob "$tmpname*";
+exit;
+
+sub checkresponse {
+ my $input = <STDIN>;
+ my @values;
+
+ chomp $input;
+ if ($input =~ /^200/) {
+ $input =~ /result=(-?\d+)\s?(.*)$/;
+ if (!length($1)) {
+ warn "$name Command failed: $input\n";
+ @values = ("-1");
+ } else {
+ warn "$name Command returned: $input\n" if ($debug);
+ @values = ("$1", "$2");
+ }
+ } else {
+ warn "$name Unexpected result: $input\n";
+ @values = ("-1");
+ }
+ return @values;
+}
+
+sub playback {
+ my ($file, $keys) = @_;
+ my @response;
+
+ print "STREAM FILE $file \"$keys\"\n";
+ @response = checkresponse();
+ if ($response[0] >= 32 && chr($response[0]) =~ /[\w*#]/) {
+ warn "$name Got digit ", chr($response[0]), "\n" if ($debug);
+ print "SET EXTENSION ", chr($response[0]), "\n";
+ checkresponse();
+ print "SET PRIORITY 1\n";
+ checkresponse();
+ return $response[0];
+ } elsif ($response[0] == -1) {
+ warn "$name Failed to play $file\n";
+ return -1;
+ }
+ return 0;
+}
+
+sub int_handler {
+ die "$name Interrupt signal received, terminating...\n";
+}
+
+END {
+ if ($tmpname) {
+ warn "$name Cleaning temp files.\n" if ($debug);
+ unlink glob "$tmpname*";
+ }
+}

0 comments on commit b82e9bf

Please sign in to comment.