3 =head1 NAME $RCSfile: Speak.pm,v $
5 Convert text to speach using Google's engine and play it on speakers
13 Andrew DeFaria <Andrew@DeFaria.com>
21 Wed 24 Feb 2021 11:05:36 AM PST
30 This module offers subroutines to convert text into speach and speak them.
34 This module exports subroutines to process text to speach and speak them.
38 The following routines are exported:
52 use lib "$FindBin::Bin/../lib";
58 our @EXPORT = qw(speak);
65 =head2 speak($msg, $log)
67 Convert $msg to speach.
69 Note this currently uses an external script to do the conversion. I intend to
70 re-write that into Perl here eventually.
74 =for html <blockquote>
80 Message to speak. If $msg is defined and scalar then that is the message
81 to speak. If it is a file handle then the text will be read from that file.
82 Otherwise the text in the clipboard will be used.
86 If provided, errors and messages will be logged to the logfile, otherwise to speak.log
90 =for html </blockquote>
94 =for html <blockquote>
102 =for html </blockquote>
107 path => '/var/local/log',
109 timestamped => 'yes',
113 if (-f "$FindBin::Bin/../data/shh") {
114 $msg .= ' [silent shh]';
120 # Handle the case where $msg is not passed in. Then use the clipboard;
121 $msg = Clipboard->paste unless $msg;
123 # Handle the case where $msg is a filehandle
124 $msg = <$msg> if ref $msg eq 'GLOB';
126 # Log message to log file if $log was passed in.
129 my ($status, @output) = Execute "/usr/local/bin/gt \"$msg\"";
132 my $errmsg = "Unable to speak (Status: $status) - " . join "\n", @output;
144 =head1 CONFIGURATION AND ENVIRONMENT
146 DEBUG: If set then $debug is set to this level.
148 VERBOSE: If set then $verbose is set to this level.
150 TRACE: If set then $trace is set to this level.
156 L<File::Spec|File::Spec>
158 L<Term::ANSIColor|Term::ANSIColor>
160 =head1 INCOMPATABILITIES
164 =head1 BUGS AND LIMITATIONS
166 There are no known bugs in this module.
168 Please report problems to Andrew DeFaria <Andrew@ClearSCM.com>.
170 =head1 LICENSE AND COPYRIGHT
172 This Perl Module is freely available; you can redistribute it and/or
173 modify it under the terms of the GNU General Public License as
174 published by the Free Software Foundation; either version 2 of the
175 License, or (at your option) any later version.
177 This Perl Module is distributed in the hope that it will be useful,
178 but WITHOUT ANY WARRANTY; without even the implied warranty of
179 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
180 General Public License (L<http://www.gnu.org/copyleft/gpl.html>) for more
183 You should have received a copy of the GNU General Public License
184 along with this Perl Module; if not, write to the Free Software Foundation,
185 Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.