concatfiledatasource.java

It is the Speech recognition software. It is platform independent. To execute the source code,

/*
 * Copyright 1999-2002 Carnegie Mellon University.  
 * Portions Copyright 2002 Sun Microsystems, Inc.  
 * Portions Copyright 2002 Mitsubishi Electric Research Laboratories.
 * All Rights Reserved.  Use is subject to license terms.
 * 
 * See the file "license.terms" for information on usage and
 * redistribution of this file, and for a DISCLAIMER OF ALL 
 * WARRANTIES.
 *
 */
package edu.cmu.sphinx.frontend.util;

import java.io.BufferedReader;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileReader;
import java.io.FileWriter;
import java.io.IOException;
import java.io.SequenceInputStream;
import java.util.Enumeration;
import java.util.LinkedList;
import java.util.List;
import java.util.Random;

import edu.cmu.sphinx.util.BatchFile;
import edu.cmu.sphinx.util.ReferenceSource;
import edu.cmu.sphinx.util.props.PropertyException;
import edu.cmu.sphinx.util.props.PropertySheet;
import edu.cmu.sphinx.util.props.PropertyType;
import edu.cmu.sphinx.util.props.Registry;


/**
 * Concatenates a list of audio files as one continuous audio stream.
 * A {@link edu.cmu.sphinx.frontend.DataStartSignal DataStartSignal}
 * will be placed before the start of the first file, and a
 * {@link edu.cmu.sphinx.frontend.DataEndSignal DataEndSignal}
 * after the last file.
 * No DataStartSignal or DataEndSignal will be placed between them. 
 * Optionally, silence can be added in-between the audio files by setting
 * the property:
 * <pre>edu.cmu.sphinx.frontend.util.ConcatFileDataSource.silenceFile</pre>
 * to a audio file for silence. By default, no silence is added.
 * Moreover, one can also specify how many files to skip for every file read.
 * <p>
 * You can also specify the name of a transcript file to write
 * the transcription to. The transcription will be written in HUB-4 style.
 * A sample HUB-4 transcript looks like:
 * <pre>
 * bn99en_1 1 peter_jennings 0.806084 7.079850 <o,f4,male> Tonight this 
 * Thursday big pressure on the Clinton administration to do something about 
 * the latest killing in Yugoslavia
 * bn99en_1 1 peter_jennings 7.079850 14.007608 <o,fx,male> Airline passengers
 * and outrageous behavior at thirty thousand feet What can an airline do 
 * ...
 * bn99en_1 1 inter_segment_gap 23.097000 28.647000 <o,fx,>
 * ...
 * </pre>
 * The format of each line is:
 * <pre>
 * test_set_name category speaker_name start_time_in_seconds
 * end_time_in_seconds <category,hub4_focus_conditions,speaker_sex> transcript
 * </pre>
 * In our example above,
 * <pre>
 * test_set_name is "bn99en_1"
 * category is "1"
 * speaker_name is "peter_jennings"
 * start_time_in_seconds is "0.806084"
 * end_time_in_seconds is "7.079850"
 * category is "o" for "Overall"
 * hub4_focus_conditions is:
 *     "f0" for "Baseline//Broadcast//Speech"
 *     "f1" for "Spontaneous//Broadcast//Speech"
 *     "f2" for "Speech Over//Telephone//Channels"
 *     "f3" for "Speech in the//Presence of//Background Music"
 *     "f4" for "Speech Under//Degraded//Acoustic Conditions"
 *     "f5" for "Speech from//Non-Native//Speakers"
 *     "fx" for "All other speech"
 * speaker_sex is "male"
 * transcript is "Tonight this Thursday big pressure on the Clinton 
 * administration to do something about the latest killing in Yugoslavia
 * </pre>
 * The ConcatFileDataSource will produce such a transcript if the name
 * of the file to write to is supplied in the constructor. This transcript
 * file will be used in detected gap insertion errors, because it accurately
 * describes the "correct" sequence of speech and silences in the 
 * concatenated version of the audio files.
 */
public class ConcatFileDataSource extends StreamDataSource
    implements ReferenceSource {

    /**
     * SphinxProperty for the sample rate.
     */
    public static final String PROP_SAMPLE_RATE =  "sampleRate";
    /**
     * Default value for PROP_SAMPLE_RATE.
     */
    public static final int PROP_SAMPLE_RATE_DEFAULT = 16000;

    /**
     * The SphinxProperty that specifies which file to start at.
     */
    public static final String PROP_START_FILE = "startFile";

    /**
     * The default value for PROP_START_FILE_DEFAULT.
     */
    public static final int PROP_START_FILE_DEFAULT = 1;

    /**
     * The SphinxProperty that specifies the number of files to skip
     * for every file read.
     */
    public static final String PROP_SKIP = "skip";

    /**
     * The default value for PROP_SKIP.
     */
    public static final int PROP_SKIP_DEFAULT = 0;

    /**
     * The SphinxProperty that specifies the total number of files to read.
     * The default value should be no limit.
     */
    public static final String PROP_TOTAL_FILES = "totalFiles";

    /**
     * The default value for PROP_TOTAL_FILES.
     */
    public static final int PROP_TOTAL_FILES_DEFAULT = -1;

    /**
     * The SphinxProperty that specifies the silence audio file, if any.
     * If this property is null, then no silences are added in between
     * files.
     */
    public static final String PROP_SILENCE_FILE =
        "silenceFile";

    /**
     * The default value for PROP_SILENCE_FILE.
     */
    public static final String PROP_SILENCE_FILE_DEFAULT = null;

    /**
     * The SphinxProperty that specifies whether to add random silence.
     */
    public static final String PROP_ADD_RANDOM_SILENCE = 
        "addRandomSilence";

    /**
     * The default value for PROP_ADD_RANDOM_SILENCE.
     */
    public static final boolean PROP_ADD_RANDOM_SILENCE_DEFAULT = false;

    /**
     * The SphinxProperty that specifies the maximum number of times the 
     * silence file is added  between files. 
     * If PROP_ADD_RANDOM_SILENCE is set to true, the number of times the
     * silence file is added is between 1 and this value.
     * If PROP_ADD_RANDOM_SILENCE is set to false, this value will be the
     * number of times the silence file is added. So if PROP_MAX_SILENCE
     * is set to 3, then the silence file will be added three times
     * between files.
     */
    public static final String PROP_MAX_SILENCE = 
        "maxSilence";

    /**
     * The default value of PROP_MAX_SILENCE.
     */
    public static final int PROP_MAX_SILENCE_DEFAULT = 3;

    /**
     * The SphinxProperty that specifies the name of the transcript file.
     * If this property is set, a transcript file will be created.
     * No transcript file will be created if this property is not set.
     */
    public static final String PROP_TRANSCRIPT_FILE = 
        "transcriptFile";

    /**
     * The default value of PROP_TRANSCRIPT_FILE.
     */
    public static final String PROP_TRANSCRIPT_FILE_DEFAULT = null;

    /**
     * SphinxProperty for the file containing a list of audio files 
     * to read from.
     */
    public static final String PROP_BATCH_FILE =
        "batchFile";

    /**
     * The default value of PROP_BATCH_FILE.
     */
    public static final String PROP_BATCH_FILE_DEFAULT = null;

    /**
     * SphinxProperty for the number of bits per value.
     */
    public static final String PROP_BITS_PER_SAMPLE =
        "bitsPerSample";

    /**
     * Default value for PROP_BITS_PER_SAMPLE.
     */
    public static final int PROP_BITS_PER_SAMPLE_DEFAULT = 16;


    private static final String GAP_LABEL = "inter_segment_gap";

    private boolean addRandomSilence;
    private boolean createTranscript;
    private int skip;
    private int maxSilence;
    private int silenceCount;
    private int bytesPerSecond;
    private long totalBytes;
    private long silenceFileLength;
    private String silenceFileName = null;
    private String nextFile = null;
    private String context;
    private String transcriptFile;
    private StreamDataSource streamDataSource;
    private List referenceList;
    private FileWriter transcript;
    private int startFile;
    private int totalFiles;
    private int sampleRate;
    private int bitsPerSample;
    private String batchFile;

    /*
     * (non-Javadoc)
     * 
     * @see edu.cmu.sphinx.util.props.Configurable#register(java.lang.String,
     *      edu.cmu.sphinx.util.props.Registry)
     */
    public void register(String name, Registry registry)
            throws PropertyException {
        super.register(name, registry);
        registry.register(PROP_ADD_RANDOM_SILENCE, PropertyType.BOOLEAN);
        registry.register(PROP_MAX_SILENCE, PropertyType.INT);
        registry.register(PROP_SKIP, PropertyType.INT);
        registry.register(PROP_SILENCE_FILE, PropertyType.STRING);
        registry.register(PROP_START_FILE, PropertyType.INT);
        registry.register(PROP_TOTAL_FILES, PropertyType.INT);
        registry.register(PROP_TRANSCRIPT_FILE, PropertyType.STRING);
        registry.register(PROP_BATCH_FILE, PropertyType.STRING);
    }

    /*
     * (non-Javadoc)
     * 
     * @see edu.cmu.sphinx.util.props.Configurable#newProperties(edu.cmu.sphinx.util.props.PropertySheet)
     */
    public void newProperties(PropertySheet ps) throws PropertyException {
        super.newProperties(ps);
        int sampleRate = ps.getInt ( PROP_SAMPLE_RATE, PROP_SAMPLE_RATE_DEFAULT);
        int bitsPerSample = ps.getInt
            (PROP_BITS_PER_SAMPLE, PROP_BITS_PER_SAMPLE_DEFAULT);
        bytesPerSecond = sampleRate * (bitsPerSample / 8);