Song.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.util.Formatter;

import org.xbmc.android.jsonrpc.api.model.AudioModel.SongDetail;
import org.xbmc.api.type.MediaType;


/**
 * The song class contains everything to know about a song. It's basically a
 * data container with some smallish formatting methods
 *  
 * @author Team XBMC
 */
public class Song implements ICoverArt, INamedResource {
	
	/**
	 * Constructor
	 * @param title     Song title
	 * @param artist    Song artist
	 * @param album     Song artist
	 * @param track     XBMC track number format (first 2 bytes = disc, last 2 bytes = track)
	 * @param duration  Duration in seconds
	 * @param path      Path to song (without filename)
	 * @param filename  Filename
	 */
	public Song(int id, String title, String artist, String album, int track, int duration, String path, String filename, String thumbPath) {
		this(id, title, artist, album, track, duration, path + filename, thumbPath);
	}
	
	public Song(int id, String title, String artist, String album, int track, int duration, String file, String thumbPath) {
		this.id = id;
		this.title = title;
		this.artist = artist;
		this.album = album;
		this.track = track & 0xffff;
		this.disc = track >> 16;
		this.duration = duration;
		this.path = file;
		if (!"".equals(thumbPath) && !thumbPath.equals("NONE")) {
			try {
				this.thumbID = Long.parseLong(thumbPath.substring(thumbPath.lastIndexOf("/") + 1, thumbPath.length() - 4), 16);
			} catch (NumberFormatException e) {
				this.thumbID = 0L;
			}
		}
	}
	
	public Song(SongDetail detail) {
		this.id = detail.songid;
		this.title = detail.title;
		if(detail.artist.size() > 0) {
			this.artist = detail.artist.get(0);
		}
		this.album = detail.album;
		this.track = detail.track + 0xffff;
		this.disc = detail.disc;
		this.duration = detail.duration;
		this.path = detail.file;
		this.thumbnail = detail.thumbnail;
	}
	
	// this is for testing
	public Song(int id) {
		this.id = id;
	}
	
	
	/**
	 * Returns the duration in a nice format ([h:]mm:ss)
	 * @return Formatted duration
	 */
	public String getDuration() {
		return getDuration(duration);
	}
	
	/**
	 * Returns a formatted string (MM:SS) for a number of seconds.
	 * @param d Number of seconds
	 * @return Formatted time
	 */
	public static String getDuration(int d) {
		StringBuilder sb = new StringBuilder();
		if (d > 3600) {
			sb.append((int)d / 3600);
			sb.append(":");
			d %= 3600;
		}
		int min = (int)d / 60;
		Formatter f = new Formatter();
		if (sb.length() > 0) {
//			sb.append(f.format("%02d", min));
			if(min < 10)
				sb.append(0);
			sb.append(min);
			sb.append(":");
		} else {
			sb.append(min + ":");
		}
		d %= 60;
		sb.append(f.format("%02d", d));
		return sb.toString();
	}

	/**
	 * Something readable
	 */
	public String toString() {
		return "[" + track + "/" + disc + "] " + artist + " - " + title;
	}

	/**
	 * Returns the CRC of the song.
	 * @return CRC32
	 */
	public long getCrc() {
		return thumbID;
	}
	
	public int getId() {
		return id;
	}
	
	public String getName() {
		return title;
	}
	public String getPath() {
		return path;
	}
	public String getShortName() {
		return getName();
	}

	public int getFallbackCrc() {
		return 0;
	}	
	
	public int getMediaType() {
		return MediaType.MUSIC;
	}
	
	public String getThumbnail() {
		return thumbnail;
	}
	
	/**
	 * Database ID
	 */
	public int id;
	/**
	 * Song title
	 */
	public String title;
	/**
	 * Song artist
	 */
	public String artist;
	/**
	 * Song album (null if single)
	 */
	public String album;
	
	/**
	 * Track number
	 */
	public int track;
	/**
	 * Disc number
	 */
	public int disc;
	/**
	 * Song duration in seconds
	 */
	public int duration;
	/**
	 * Absolute path from XBMC (incl filename)
	 */
	public String path;
	/**
	 * CRC of the thumb
	 */
	public long thumbID = 0;
	
	public String thumbnail;
	
	private static final long serialVersionUID = 911367816075830385L;
}