marytts.config.MaryConfig Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of marytts-runtime Show documentation
The newest version!
/**
 * Copyright 2011 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 .
 *
 */
package marytts.config;

import java.io.InputStream;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.Properties;
import java.util.ServiceLoader;
import java.util.Set;

import org.apache.commons.lang.StringUtils;

import marytts.exceptions.MaryConfigurationException;
import marytts.modules.phonemiser.AllophoneSet;
import marytts.server.MaryProperties;
import marytts.util.io.PropertiesAccessor;
import marytts.util.io.PropertiesTrimTrailingWhitespace;

/**
 * @author marc
 *
 */
public abstract class MaryConfig {
	private static final ServiceLoader configLoader = ServiceLoader.load(MaryConfig.class);

	/**
	 * This method will try to check that the available configs are consistent and will spot obvious reasons why they might not
	 * work together as a full system. Reasons that are detected include:
	 * 
	 * There is no main config;
	 * There is a voice with a certain locale but no language component has that locale.
	 * 
	 * This method will return allright if everything is OK; if there is a problem, it will throw an Exception with a message
	 * indicating the problem.
	 * 
	 * @throws MaryConfigurationException
	 *             if the configuration cannot work as it is now.
	 */
	public static void checkConsistency() throws MaryConfigurationException {
		// Check that we have a main config
		if (getMainConfig() == null) {
			throw new MaryConfigurationException("No main config");
		}
		// Check that for each voice, we have a matching language config
		for (VoiceConfig vc : getVoiceConfigs()) {
			if (getLanguageConfig(vc.getLocale()) == null) {
				throw new MaryConfigurationException("Voice '" + vc.getName() + "' has locale '" + vc.getLocale()
						+ "', but there is no corresponding language config.");
			}
		}
	}

	public static int countConfigs() {
		int num = 0;
		for (@SuppressWarnings("unused")
		MaryConfig mc : configLoader) {
			num++;
		}
		return num;
	}

	public static int countLanguageConfigs() {
		int num = 0;
		for (MaryConfig mc : configLoader) {
			if (mc.isLanguageConfig()) {
				num++;
			}
		}
		return num;
	}

	public static int countVoiceConfigs() {
		int num = 0;
		for (MaryConfig mc : configLoader) {
			if (mc.isVoiceConfig()) {
				num++;
			}
		}
		return num;
	}

	public static MaryConfig getMainConfig() {
		for (MaryConfig mc : configLoader) {
			if (mc.isMainConfig()) {
				return mc;
			}
		}
		return null;
	}

	public static Iterable getLanguageConfigs() {
		Set lcs = new HashSet();
		for (MaryConfig mc : configLoader) {
			if (mc.isLanguageConfig()) {
				LanguageConfig lc = (LanguageConfig) mc;
				lcs.add(lc);
			}
		}
		return lcs;
	}

	public static Iterable getVoiceConfigs() {
		Set vcs = new HashSet();
		for (MaryConfig mc : configLoader) {
			if (mc.isVoiceConfig()) {
				VoiceConfig lc = (VoiceConfig) mc;
				vcs.add(lc);
			}
		}
		return vcs;
	}

	public static LanguageConfig getLanguageConfig(Locale locale) {
		for (MaryConfig mc : configLoader) {
			if (mc.isLanguageConfig()) {
				LanguageConfig lc = (LanguageConfig) mc;
				if (lc.getLocales().contains(locale)) {
					return lc;
				}
			}
		}
		return null;
	}

	/**
	 * Get the voice config for the given voice name, or null if there is no such voice config.
	 * 
	 * @param voiceName
	 *            voiceName
	 * @return vc if vc.getName().equals(voiceName), null otherwise
	 */
	public static VoiceConfig getVoiceConfig(String voiceName) {
		for (MaryConfig mc : configLoader) {
			if (mc.isVoiceConfig()) {
				VoiceConfig vc = (VoiceConfig) mc;
				if (vc.getName().equals(voiceName)) {
					return vc;
				}
			}
		}
		return null;
	}

	public static Iterable getConfigs() {
		return configLoader;
	}

	/**
	 * Get the allophone set for the given locale, or null if it cannot be retrieved.
	 * 
	 * @param locale
	 *            locale
	 * @return the allophone set for the given locale, or null of the locale is not supported.
	 * @throws MaryConfigurationException
	 *             if the locale is supported in principle but no allophone set can be retrieved.
	 */
	public static AllophoneSet getAllophoneSet(Locale locale) throws MaryConfigurationException {
		LanguageConfig lc = getLanguageConfig(locale);
		if (lc == null) {
			return null;
		}
		return lc.getAllophoneSetFor(locale);
	}

	// ////////// Non-static / base class methods //////////////

	private Properties props;

	protected MaryConfig(InputStream propertyStream) throws MaryConfigurationException {
		props = new PropertiesTrimTrailingWhitespace();
		try {
			props.load(propertyStream);
		} catch (Exception e) {
			throw new MaryConfigurationException("cannot load properties", e);
		}
	}

	public boolean isMainConfig() {
		return false;
	}

	public boolean isLanguageConfig() {
		return false;
	}

	public boolean isVoiceConfig() {
		return false;
	}

	public boolean isSynthesisConfig() {
		return false;
	}

	public Properties getProperties() {
		return props;
	}

	/**
	 * Convenience access to this config's properties.
	 * 
	 * @param systemPropertiesOverride
	 *            whether to use system properties in priority if they exist. If true, any property requested from this properties
	 *            accessor will first be looked up in the system properties, and only if it is not defined there, it will be
	 *            looked up in this config's properties.
	 * @return PropertiesAccessor(props, systemPropertiesOverride, maryBaseMap)
	 */
	public PropertiesAccessor getPropertiesAccessor(boolean systemPropertiesOverride) {
		Map maryBaseMap = new HashMap();
		maryBaseMap.put("MARY_BASE", MaryProperties.maryBase());
		return new PropertiesAccessor(props, systemPropertiesOverride, maryBaseMap);
	}

	/**
	 * Get the given property. If it is not defined, the defaultValue is returned.
	 * 
	 * @param property
	 *            name of the property to retrieve
	 * @param defaultValue
	 *            value to return if the property is not defined.
	 * @return props.getProperty(property, defaultValue)
	 */
	public String getProperty(String property, String defaultValue) {
		return props.getProperty(property, defaultValue);
	}

	/**
	 * For the given property name, return the value of that property as a list of items (interpreting the property value as a
	 * space-separated list).
	 * 
	 * @param propertyName
	 *            propertyName
	 * @return the list of items, or an empty list if the property is not defined or contains no items
	 */
	public List getList(String propertyName) {
		String val = props.getProperty(propertyName);
		if (val == null)
			return new ArrayList();
		return Arrays.asList(StringUtils.split(val));

	}
}