/*
 * PS3 Media Server, for streaming any medias to your PS3.
 * Copyright (C) 2008  A.Brochard
 *
 * 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; version 2
 * of the License only.
 *
 * 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.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
package net.pms.formats;

import java.util.ArrayList;
import java.util.StringTokenizer;

import net.pms.PMS;
import net.pms.configuration.RendererConfiguration;
import net.pms.dlna.DLNAMediaInfo;
import net.pms.dlna.InputFile;
import net.pms.encoders.Player;
import net.pms.network.HTTPResource;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Abstract class to store known information about a given format.
 */
public abstract class Format implements Cloneable {
	private static final Logger logger = LoggerFactory.getLogger(Format.class);

	public int getType() {
		return type;
	}

	public static final int ISO = 32;
	public static final int PLAYLIST = 16;
	public static final int UNKNOWN = 8;
	public static final int VIDEO = 4;
	public static final int AUDIO = 1;
	public static final int IMAGE = 2;

	/**
	 * The identifier (filename extension or protocol) that was matched for a
	 * particular filename or URL. Requires {@link #match(String)} to be called
	 * first.
	 */
	protected String matchedId;

	/**
	 * Returns the identifier (filename extension or protocol) that was matched
	 * for a particular filename or URL. Requires {@link #match(String)} to be
	 * called first.
	 *
	 * @return The matched identifier.
	 */
	public String getMatchedId() {
		return matchedId;
	}
	protected int type = UNKNOWN;
	protected Format secondaryFormat;

	public Format getSecondaryFormat() {
		return secondaryFormat;
	}

	public void setSecondaryFormat(Format secondaryFormat) {
		this.secondaryFormat = secondaryFormat;
	}

	public void setType(int type) {
		if (isUnknown()) {
			this.type = type;
		}
	}

	/**
	 * Returns the identifiers that can be used to identify a particular
	 * format. Valid identifiers are filename extensions or URL protocols,
	 * e.g. "mp3" or "http". Identifiers are expected to be in lower case.
	 *
	 * @return An array of identifiers.
	 */
	public abstract String[] getId();

	/**
	 * @deprecated Use {@link #isCompatible(DLNAMediaInfo, RendererConfiguration)} instead.
	 * <p>
	 * Returns whether or not a format can be handled by the PS3 natively.
	 * This means the format can be streamed to PS3 instead of having to be
	 * transcoded.
	 * 
	 * @return True if the format can be handled by PS3, false otherwise.
	 */
	@Deprecated
	public abstract boolean ps3compatible();
	
	/**
	 * Returns whether or not a format can be handled by the renderer natively.
	 * This means the format can be streamed instead of having to be transcoded.
	 * 
	 * @return True if the format can be handled by the renderer, false otherwise.
	 *
	 * @since 1.50.1
	 */
	public boolean isCompatible(DLNAMediaInfo media, RendererConfiguration renderer) {
		if (renderer != null) {
			// Let the renderer configuration decide on native compatibility
			return renderer.isCompatible(media, this);
		} else {
			// Is this format among the ones configured in PMS to be streamed?
			return skip(PMS.getConfiguration().getNoTranscode(), null);
		}
	}

	public abstract boolean transcodable();
	public abstract ArrayList<Class<? extends Player>> getProfiles();

	public String mimeType() {
		return HTTPResource.getDefaultMimeType(type);
	}

	public boolean match(String filename) {
		boolean match = false;
		if (filename == null) {
			return match;
		}
		filename = filename.toLowerCase();
		for (String singleid : getId()) {
			String id = singleid.toLowerCase();
			match = filename.endsWith("." + id) || filename.startsWith(id + "://");
			if (match) {
				matchedId = singleid;
				return true;
			}
		}
		return match;
	}

	public boolean isVideo() {
		return (type & VIDEO) == VIDEO;
	}

	public boolean isAudio() {
		return (type & AUDIO) == AUDIO;
	}

	public boolean isImage() {
		return (type & IMAGE) == IMAGE;
	}

	public boolean isUnknown() {
		return (type & UNKNOWN) == UNKNOWN;
	}

	@Override
	protected Object clone() {
		Object o = null;
		try {
			o = super.clone();
		} catch (CloneNotSupportedException e) {
			logger.error(null, e);
		}
		return o;
	}

	public Format duplicate() {
		return (Format) this.clone();
	}

	// method which allow us the fine tuning of parsing with different formats in the future
	public void parse(DLNAMediaInfo media, InputFile file, int type) {
		parse(media, file, type, null);
	}

	// 10/02/03 now this is useful :p
	public void parse(DLNAMediaInfo media, InputFile file, int type, RendererConfiguration renderer) {
		if (renderer != null && renderer.isMediaParserV2()) {
			renderer.getFormatConfiguration().parse(media, file, this, type);
		} else {
			media.parse(file, this, type, false);
		}
		logger.trace("Parsing results: " + file + " / " + media);
	}

	/**
	 * Returns whether or not the matched identifier of this format is among
	 * the list of supplied extensions.
	 *
	 * @param extensions String of comma separated extensions
	 * @param moreExtensions String of comma separated extensions
	 *
	 * @return True if this format matches any extension, false otherwise.
	 *
	 * @see #match(String)
	 */
	public boolean skip(String extensions, String moreExtensions) {
		if (extensions != null && extensions.length() > 0) {
			StringTokenizer st = new StringTokenizer(extensions, ",");

			while (st.hasMoreTokens()) {
				String id = st.nextToken().toLowerCase();

				if (matchedId != null && matchedId.toLowerCase().equals(id)) {
					return true;
				}
			}
		}

		if (moreExtensions != null && moreExtensions.length() > 0) {
			StringTokenizer st = new StringTokenizer(moreExtensions, ",");

			while (st.hasMoreTokens()) {
				String id = st.nextToken().toLowerCase();

				if (matchedId != null && matchedId.toLowerCase().equals(id)) {
					return true;
				}
			}
		}
		return false;
	}
}