lib/Speak.pm

   1 =pod
   2
   3 =head1 NAME $RCSfile: Speak.pm,v $
   4
   5 Convert text to speach using Google's engine and play it on speakers
   6
   7 =head1 VERSION
   8
   9 =over
  10
  11 =item Author
  12
  13 Andrew DeFaria <Andrew@DeFaria.com>
  14
  15 =item Revision
  16
  17 $Revision: 1.0 $
  18
  19 =item Created
  20
  21 Wed 24 Feb 2021 11:05:36 AM PST
  22
  23 =item Modified
  24
  25
  26 =back
  27
  28 =head1 SYNOPSIS
  29
  30 This module offers subroutines to convert text into speach and speak them.
  31
  32 =head2 DESCRIPTION
  33
  34 This module exports subroutines to process text to speach and speak them.
  35
  36 =head1 ROUTINES
  37
  38 The following routines are exported:
  39
  40 =cut
  41
  42 package Speak;
  43
  44 use strict;
  45 use warnings;
  46
  47 use base 'Exporter';
  48
  49 use FindBin;
  50 use Clipboard;
  51
  52 use lib "$FindBin::Bin/../lib";
  53
  54 use Display;
  55 use Logger;
  56 use Utils;
  57
  58 our @EXPORT = qw(speak);
  59
  60 sub speak (;$$) {
  61   my ($msg, $log) = @_;
  62
  63 =pod
  64
  65 =head2 speak($msg, $log)
  66
  67 Convert $msg to speach.
  68
  69 Note this currently uses an external script to do the conversion. I intend to
  70 re-write that into Perl here eventually.
  71
  72 Parameters:
  73
  74 =for html <blockquote>
  75
  76 =over
  77
  78 =item $msg:
  79
  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.
  83
  84 =item $log
  85
  86 If provided, errors and messages will be logged to the logfile, otherwise to speak.log
  87
  88 =back
  89
  90 =for html </blockquote>
  91
  92 Returns:
  93
  94 =for html <blockquote>
  95
  96 =over
  97
  98 =item Nothing
  99
 100 =back
 101
 102 =for html </blockquote>
 103
 104 =cut
 105
 106   $log = Logger->new(
 107     path        => '/var/local/log',
 108     name        => 'speak',
 109     timestamped => 'yes',
 110     append      => 1,
 111   ) unless $log;
 112
 113   if (-f "$FindBin::Bin/../data/shh") {
 114     $msg .= ' [silent shh]';
 115     $log->msg($msg);
 116
 117     return;
 118   } # if
 119
 120   # Handle the case where $msg is not passed in. Then use the clipboard;
 121   $msg = Clipboard->paste unless $msg;
 122
 123   # Handle the case where $msg is a filehandle
 124   $msg = <$msg> if ref $msg eq 'GLOB';
 125
 126   # Log message to log file if $log was passed in.
 127   $log->msg($msg);
 128
 129   my ($status, @output) = Execute "/usr/local/bin/gt \"$msg\"";
 130
 131   if ($status) {
 132     my $errmsg = "Unable to speak (Status: $status) - " . join "\n", @output;
 133
 134     $log->err($errmsg);
 135   } # if
 136
 137   return;
 138 } # speak
 139
 140 1;
 141
 142 =pod
 143
 144 =head1 CONFIGURATION AND ENVIRONMENT
 145
 146 DEBUG: If set then $debug is set to this level.
 147
 148 VERBOSE: If set then $verbose is set to this level.
 149
 150 TRACE: If set then $trace is set to this level.
 151
 152 =head1 DEPENDENCIES
 153
 154 =head2 Perl Modules
 155
 156 L<File::Spec|File::Spec>
 157
 158 L<Term::ANSIColor|Term::ANSIColor>
 159
 160 =head1 INCOMPATABILITIES
 161
 162 None yet...
 163
 164 =head1 BUGS AND LIMITATIONS
 165
 166 There are no known bugs in this module.
 167
 168 Please report problems to Andrew DeFaria <Andrew@ClearSCM.com>.
 169
 170 =head1 LICENSE AND COPYRIGHT
 171
 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.
 176
 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
 181 details.
 182
 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.
 186 reserved.
 187
 188 =cut