Movie.java

/*
 *      Copyright (C) 2005-2009 Team XBMC
 *      http://xbmc.org
 *
 *  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, 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.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with XBMC Remote; see the file license.  If not, write to
 *  the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
 *  http://www.gnu.org/copyleft/gpl.html
 *
 */

package org.xbmc.api.object;

import java.io.Serializable;
import java.util.ArrayList;

import org.xbmc.android.util.Crc32;
import org.xbmc.api.type.MediaType;

/**
 * Stores what we can get from the movieview table.
 * 
 * @author Team XBMC
 */
public class Movie implements ICoverArt, Serializable, INamedResource {
	
	/**
	 * Points to where the movie thumbs are stored
	 */
	public final static String THUMB_PREFIX = "special://profile/Thumbnails/";

	/**
	 * Constructor
	 * @param id		Database ID
	 * @param name		Album name
	 * @param artist	Artist
	 */
	public Movie(int id, String title, int year, String path, String filename, String director, String runtime, String genres, double rating, int numWatched, String imdbId, String artUrl) {
		this.id = id;
		this.title = title;
		this.year = year;
		this.director = director;
		this.runtime = runtime;
		this.genres = genres;
		this.rating = rating;
		this.localPath = path;
		this.filename = filename;
		this.numWatched = numWatched;
		this.imdbId=imdbId;
		this.artUrl=artUrl;
	}
	
	public int getMediaType() {
		return MediaType.VIDEO_MOVIE;
	}
	
	/**
	 * Returns the path XBMC needs to play the movie. This can either
	 * localPath + filename or filename only (in case of stacks) 
	 * @return
	 */
	public String getPath() {
		if (filename.contains("://")) {
			return filename;
		} else {
			return localPath + filename;
		}
	}

	public String getShortName() {
		return this.title;
	}
	
	/**
	 * Composes the complete path to the movie's thumbnail
	 * @return Path to thumbnail
	 */
	public String getThumbUri() {
		return getThumbUri(this);
	}
	
	public static String getThumbUri(ICoverArt cover) {
		return cover.getThumbUrl();
	}
	
	public static String getFallbackThumbUri(ICoverArt cover) {
		final String hex = Crc32.formatAsHexLowerCase(cover.getCrc());
		return THUMB_PREFIX + hex.charAt(0) + "/" + hex + ".jpg";
	}
	
	/**
	 * Returns the CRC of the movie on which the thumb name is based upon.
	 * @return CRC32
	 */
	public long getCrc() {
		thumbID = Crc32.computeLowerCase(artUrl);
		return thumbID;
	}
	
	/**
	 * If no album thumb CRC is found, try to get the thumb of the album's
	 * directory.
	 * @return 0-char CRC32
	 */
	public int getFallbackCrc() {
		if (localPath != null && filename != null) {
			return Crc32.computeLowerCase(artUrl);
		} else {
			return 0;
		}
	}
	
	public String getThumbUrl() {
		return artUrl;
	}
	
	/**
	 * Returns database ID.
	 * @return
	 */
	public int getId() {
		return this.id;
	}
	
	/**
	 * @return The Movie's IMDbId
	 */
	public String getIMDbId(){
		return this.imdbId;
	}
	
	/**
	 * Returns database ID.
	 * @return
	 */
	public String getName() {
		return title + " (" + year + ")";
	}
	
	/**
	 * Something descriptive
	 */
	public String toString() {
		return "[" + id + "] " + title + " (" + year + ")";
	}
	
	/**
	 * Database ID
	 */
	private final int id;
	/**
	 * Movie title
	 */
	public final String title;
	/**
	 * Director(s), can be several separated by " / "
	 */
	public final String director;
	/**
	 * Runtime, can be several also, separated by " | "
	 */
	public final String runtime;
	/**
	 * Genre(s), can be several, normally separated by " / "
	 */
	public final String genres;
	/**
	 * Year released, -1 if unknown
	 */
	public final int year;
	
	/**
	 * Local path of the movie (without file name)
	 */
	public final String localPath;
	
	/**
	 * File name of the movie
	 */
	public final String filename;
	
	/**
	 * Rating
	 */
	public double rating = 0.0;
	
	/**
	 * URL to the trailer, if available.
	 */
	public String trailerUrl = null;
	/**
	 * Movie plot
	 */
	public String plot = null;
	/**
	 * Movie's tagline 
	 */
	public String tagline = null;
	/**
	 * Number of votes, -1 if not set.
	 */
	public int numVotes = -1;
	/**
	 * Parental Rating with description (e.g.: "Rated R for strong violence, sexuality, drug use and language.")
	 */
	public String rated = null;
	/**
	 * Studio
	 */
	public String studio = null;
	
	/**
	 * Number of watched, -1 if not set.
	 */
	public final int numWatched;
	
	/**
	 * List of actors; 
	 */
	public ArrayList<Actor> actors = null;
	
	/**
	 * The movie's imdbId
	 */
	private final String imdbId;

	public String artUrl;
	/**
	 * Save this once it's calculated
	 */
	public long thumbID = 0L;
	
	private static final long serialVersionUID = 4779827915067184250L;

}