File Coverage

blib/lib/Speech/eSpeak.pm

Criterion	Covered	Total	%
statement	18	65	27.6
branch	0	16	0.0
condition	0	2	0.0
subroutine	6	19	31.5
pod			n/a
total	24	102	23.5

package Speech::eSpeak;

# use 5.008008;
use strict;
use warnings;
use Carp;

require Exporter;
use AutoLoader;

our @ISA = qw(Exporter);

# Items to export into callers namespace by default. Note: do not export
# names by default without a very good reason. Use EXPORT_OK instead.
# Do not simply export all your public functions/methods/constants.

# This allows declaration	use Speech::eSpeak ':all';
# If you do not need this, moving things directly into @EXPORT or @EXPORT_OK
# will save memory.
our %EXPORT_TAGS = ( 'all' => [ qw(
	AUDIO_OUTPUT_PLAYBACK
	AUDIO_OUTPUT_RETRIEVAL
	AUDIO_OUTPUT_SYNCHRONOUS
	EE_BUFFER_FULL
	EE_INTERNAL_ERROR
	EE_OK
	N_SPEECH_PARAM
	POS_CHARACTER
	POS_SENTENCE
	POS_WORD
	espeakCAPITALS
	espeakCHARS_8BIT
	espeakCHARS_AUTO
	espeakCHARS_UTF8
	espeakCHARS_WCHAR
	espeakEMPHASIS
	espeakENDPAUSE
	espeakEVENT_LIST_TERMINATED
	espeakEVENT_WORD
	espeakEVENT_SENTENCE
	espeakEVENT_MARK
	espeakEVENT_PLAY
	espeakEVENT_END
	espeakEVENT_MSG_TERMINATED
	espeakEVENT_PHONEME
	espeakKEEP_NAMEDATA
	espeakLINELENGTH
	espeakPHONEMES
	espeakPITCH
	espeakPUNCTUATION
	espeakPUNCT_ALL
	espeakPUNCT_NONE
	espeakPUNCT_SOME
	espeakRANGE
	espeakRATE
	espeakSILENCE
	espeakSSML
	espeakVOLUME

				   espeak_Initialize
				   espeak_SetSynthCallback
				   espeak_SetUriCallback
				   espeak_Synth
				   espeak_Synth_Mark
				   espeak_Key
				   espeak_Char
				   espeak_SetParameter
				   espeak_GetParameter
				   espeak_SetPunctuationList
				   espeak_SetPhonemeTrace
				   espeak_CompileDictionary
				   espeak_ListVoices
				   espeak_SetVoiceByName
				   espeak_SetVoiceByProperties
				   espeak_GetCurrentVoice
				   espeak_Cancel
				   espeak_IsPlaying
				   espeak_Synchronize
				   espeak_Terminate
				   espeak_Info
	set_male_voice
	set_female_voice
) ] );

our @EXPORT_OK = ( @{ $EXPORT_TAGS{'all'} } );

our @EXPORT = qw(
	AUDIO_OUTPUT_PLAYBACK
	AUDIO_OUTPUT_RETRIEVAL
	AUDIO_OUTPUT_SYNCHRONOUS
	Audio
	EE_BUFFER_FULL
	EE_INTERNAL_ERROR
	EE_OK
	End
	Mark
	N_SPEECH_PARAM
	POS_CHARACTER
	POS_SENTENCE
	POS_WORD
	Retrieval
	Start
	espeakCAPITALS
	espeakCHARS_8BIT
	espeakCHARS_AUTO
	espeakCHARS_UTF8
	espeakCHARS_WCHAR
	espeakEMPHASIS
	espeakENDPAUSE
	espeakEVENT_LIST_TERMINATED
        espeakEVENT_WORD
        espeakEVENT_SENTENCE
        espeakEVENT_MARK
        espeakEVENT_PLAY
        espeakEVENT_END
        espeakEVENT_MSG_TERMINATED
        espeakEVENT_PHONEME
	espeakKEEP_NAMEDATA
	espeakLINELENGTH
	espeakPHONEMES
	espeakPITCH
	espeakPUNCTUATION
	espeakPUNCT_ALL
	espeakPUNCT_NONE
	espeakPUNCT_SOME
	espeakRANGE
	espeakRATE
	espeakSILENCE
	espeakSSML
	espeakVOLUME
);

our $VERSION = '0.4';

sub AUTOLOAD {
    # This AUTOLOAD is used to 'autoload' constants from the constant()
    # XS function.

    my $constname;
    our $AUTOLOAD;
    ($constname = $AUTOLOAD) =~ s/.*:://;
    croak "&Speech::eSpeak::constant not defined" if $constname eq 'constant';
    my ($error, $val) = constant($constname);
    if ($error) { croak $error; }
    {
	no strict 'refs';
	# Fixed between 5.005_53 and 5.005_61
#XXX	if ($] >= 5.00561) {
#XXX	    *$AUTOLOAD = sub () { $val };
#XXX	}
#XXX	else {
	    *$AUTOLOAD = sub { $val };
#XXX	}
    }
    goto &$AUTOLOAD;
}

require XSLoader;
XSLoader::load('Speech::eSpeak', $VERSION);

# Preloaded methods go here.

sub new {
  my %args = @_;
  $args{datadir} ||= "/usr/share";

  espeak_Initialize(AUDIO_OUTPUT_PLAYBACK(), 0, $args{datadir}, 0);

  my $self = {};
  bless $self, __PACKAGE__;
  return $self;
}

sub DESTROY {
  espeak_Synchronize();
}

sub speak {
  my ($self, $text) = @_;

  if (defined $text) {
    espeak_Synth($text, do { use bytes; length($text) + 1 }, 0, POS_CHARACTER(), 0, espeakCHARS_AUTO() | espeakPHONEMES() | espeakENDPAUSE(), 0, 0);
  } else {
    carp('speaking text undefined!');
  }
}

sub stop {
  espeak_Cancel();
}

sub synchronize {
  espeak_Synchronize();
}

sub is_playing {
  return espeak_IsPlaying();
}

sub language {
  my ($self, $lang) = @_;

  if ($lang) {
    return espeak_SetVoiceByName($lang);
  } else {
    my $voice = espeak_GetCurrentVoice();
    return $voice->{identifier};
  }
}

sub pitch {
  my ($self, $pitch) = @_;

  if (defined $pitch) {
    espeak_SetParameter(espeakPITCH(), $pitch, 0);
  } else {
    espeak_GetParameter(espeakPITCH(), 1);
  }
}

sub range {
  my ($self, $range) = @_;
  if (defined $range) {
    espeak_SetParameter(espeakRANGE(), $range, 0);
  } else {
    espeak_GetParameter(espeakRANGE(), 1);
  }
}

sub rate {
  my ($self, $rate) = @_;
  if ($rate) {
    espeak_SetParameter(espeakRATE(), $rate, 0);
  } else {
    espeak_GetParameter(espeakRATE(), 1);
  }
}

sub volume {
  my ($self, $volume) = @_;
  if (defined $volume) {
    espeak_SetParameter(espeakVOLUME(), $volume, 0);
  } else {
    espeak_GetParameter(espeakVOLUME(), 1);
  }
}

# Autoload methods go after =cut, and are processed by the autosplit program.

1;
__END__