Changeset 2593 for Trunk/Scripts/Audio_scripts/AudioSegmentation/AudioBook/Text.pm

Timestamp:

05/26/08 14:11:03 (6 months ago)

Author:

kmaclean

Message:

AudioSegmentation scripts -add POD docs

Files:

• Trunk/Scripts/Audio_scripts/AudioSegmentation/AudioBook/Text.pm (modified) (12 diffs)

Trunk/Scripts/Audio_scripts/AudioSegmentation/AudioBook/Text.pm

@@ -1 +1 @@
-#! /usr/bin/perl
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
-package AudioBook::Text;
-use strict;
@@ -30 +15 @@
-use Lingua::EN::Numbers qw(num2en num2en_ordinal);
-use Lingua::EN::Numbers::Years;
-
-
-
+
+
+
+
+
+
+
+
+
+
+
-sub new {
-        my ($class,$super,$textFile) = @_; 
@@ -43 +36 @@
-        return \%self;
-}    
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-sub _clean { # private
-        my ($self) = @_;
@@ -151 +178 @@
-} 
-
+=head2 _processSingleQuote 
+
+Special logic to deal with single quotes
+
+=cut
+
-sub _processSingleQuote { #private
-        my ($self, $word, $quotelog)= @_;
@@ -173 +206 @@
-}
-
+=head2 _processPeriods 
+
+Special logic to deal with periods
+
+=cut
+
-sub _processPeriods { #private
-        my ($self,$wordarray, $word,$periodlog,$quotelog)= @_;
@@ -204 +243 @@
-        }
-}
+
+=head2 _processEmails 
+
+Special logic to deal with emails
+
+ convert a period to the word "DOT"
+ convert "@" sign to the word "AT"
+
+=cut
-
-sub _processEmails { #private
@@ -225 +273 @@
-}
-
+=head2 _processUrls 
+
+Special logic to deal with URLs
+
+ convert a period to the word "DOT"
+
+=head3 Notes
+
+Does not transcribe "http://" need to listen to the audio to confirm how the user says this.
+
+=cut
+
-sub _processUrls { #private
-        my ($self,$wordarray, $word)= @_;
@@ -260 +320 @@
-        }
-}
+
+=head2 _processWordsContainingNumbers 
+
+Special logic to deal with words that contain numbers
+
+For example, converts the word "day12" to the words "DAY ONE TWO".  
+
+Need to listen to the audio to confirm how the user says this.
+
+=cut
-
-sub _processWordsContainingNumbers { #private
@@ -295 +365 @@
-        }       
-}
+
+=head2 _processNumbers 
+
+Special logic to convert numbers to words
+
+uses: 
+ Lingua::EN::Numbers qw(num2en num2en_ordinal);
+ Lingua::EN::Numbers::Years;
+
+=cut
-        
-sub _processNumbers { #private
@@ -382 +462 @@
-}
-
+=head2 createWLISTFile 
+
+creates the word list file (called Wlist) for use by HTK tools
+
+=cut
+
-sub createWLISTFile { # public
-        my ($self, $WLISTFile)= @_;
@@ -400 +486 @@
-}
-
+=head2 createMLFFile 
+
+creates the Multi-Label File (called MLF file) for use by HTK tools
+
+=cut
+
-sub createMLFFile { # public
-        my ($self,$wavfilename,$MLFFile)= @_;
@@ -416 +508 @@
-        close (MLF);
-}
+
+=head1 Change Log    
+
+        2008/05/02 - 0.2 - Convert to class; major refacture; renamed from etext2wlist.pl to Text.pm
+
+=head1 AUTHOR
+    
+Ken MacLean
+contact@voxforge.org
+      
+=head1 COPYRIGHT AND LICENSE       
+      
+Copyright (C) 2007 Ken MacLean
+   
+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.
+    
+=cut
+
-1;