/**
 * Copyright 2008 DFKI GmbH.
 * All Rights Reserved.  Use is subject to license terms.
 *
 * This file is part of MARY TTS.
 *
 * MARY TTS is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, version 3 of the License.
 *
 * 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */
package marytts.tools.voiceimport;

import java.io.File;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStreamWriter;
import java.io.Writer;
import java.util.Locale;
import java.util.SortedMap;
import java.util.TreeMap;

import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.transform.stream.StreamResult;
import javax.xml.xpath.XPathExpressionException;

import marytts.config.MaryConfig;
import marytts.exceptions.MaryConfigurationException;
import marytts.modules.phonemiser.AllophoneSet;
import marytts.tools.analysis.MaryTranscriptionAligner;

import org.w3c.dom.Document;
import org.xml.sax.SAXException;

public class TranscriptionAligner extends VoiceImportComponent {

	private DatabaseLayout db;
	private String locale;
	private int progress;
	DocumentBuilderFactory dbf;
	DocumentBuilder docBuilder;
	TransformerFactory tFactory;
	Transformer transformer;
	File xmlOutDir;

	private marytts.tools.analysis.MaryTranscriptionAligner aligner;

	public TranscriptionAligner() {
	}

	public String getName() {
		return "TranscriptionAligner";
	}

	@Override
	protected void initialiseComp() throws ParserConfigurationException, IOException, SAXException,
			TransformerConfigurationException, MaryConfigurationException {
		aligner = new MaryTranscriptionAligner(db.getAllophoneSet());
		aligner.SetEnsureInitialBoundary(true);
		xmlOutDir = new File((String) db.getProp(db.ALLOPHONESDIR));
		if (!xmlOutDir.exists()) {
			xmlOutDir.mkdir();
		}
		// for parsing xml files
		dbf = DocumentBuilderFactory.newInstance();
		dbf.setNamespaceAware(true);
		docBuilder = dbf.newDocumentBuilder();

		// for writing xml files
		tFactory = TransformerFactory.newInstance();
		transformer = tFactory.newTransformer();
	}

	public SortedMap<String, String> getDefaultProps(DatabaseLayout theDb) {
		this.db = theDb;
		locale = db.getProp(db.LOCALE);
		if (props == null) {
			props = new TreeMap<String, String>();
		}
		return props;
	}

	protected void setupHelp() {
		props2Help = new TreeMap<String, String>();
	}

	public int getProgress() {
		return progress;
	}

	/**
	 * align and change automatic transcriptions to manually corrected ones.
	 * 
	 * XML-Version: this changes mary xml-files (PHONEMISED)
	 * 
	 * @throws Exception
	 *             Exception
	 */
	public boolean compute() throws Exception {

		System.out.println("traversing through " + bnl.getLength() + " files");

		String promptAllophonesDir = db.getProp(db.PROMPTALLOPHONESDIR);
		for (int i = 0; i < bnl.getLength(); i++) {
			progress = 100 * i / bnl.getLength();
			System.out.println(bnl.getName(i));
			alignTranscription(bnl.getName(i));
		}

		return true;
	}

	public void alignTranscription(String baseName) throws Exception {
		String promptAllophonesDir = db.getProp(db.PROMPTALLOPHONESDIR);
		File nextFile = new File(promptAllophonesDir + System.getProperty("file.separator") + baseName + ".xml");
		// get original xml file
		Document doc = docBuilder.parse(nextFile);

		// open destination xml file
		Writer docDest = new OutputStreamWriter(new FileOutputStream(xmlOutDir.getAbsolutePath()
				+ System.getProperty("file.separator") + nextFile.getName()), "UTF-8");

		// open file with manual transcription that is to be aligned
		String manTransString;
		try {

			String trfdir = db.getProp(db.LABDIR);

			String trfname = trfdir + nextFile.getName().substring(0, nextFile.getName().length() - 4) + ".lab";

			System.out.println(trfname);

			manTransString = MaryTranscriptionAligner.readLabelFile(aligner.getEntrySeparator(),
					aligner.getEnsureInitialBoundary(), trfname);

			// align transcriptions
			aligner.alignXmlTranscriptions(doc, manTransString);
		} catch (FileNotFoundException e) {
			// transform the unchanged xml-structure to a file
			System.out.println("No manual transcription found, copy original ...");
		}

		// write results to output
		DOMSource source = new DOMSource(doc);
		StreamResult output = new StreamResult(docDest);
		transformer.transform(source, output);
	}

	/**
	 * @param args
	 *            args
	 * @throws Exception
	 *             Exception
	 */
	public static void main(String[] args) throws Exception {
		VoiceImportComponent vic = new TranscriptionAligner();
		DatabaseLayout db = new DatabaseLayout(vic);
		vic.compute();
	}
}