ControlManager.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.android.remote.business;

import org.xbmc.api.business.DataResponse;
import org.xbmc.api.business.IControlManager;
import org.xbmc.api.business.INotifiableManager;
import org.xbmc.api.data.IControlClient;
import org.xbmc.api.data.IControlClient.ICurrentlyPlaying;
import org.xbmc.api.type.SeekType;

import android.content.Context;

/**
 * Asynchronously wraps the {@link org.xbmc.httpapi.client.InfoClient} class.
 * 
 * @author Team XBMC
 */
public class ControlManager extends AbstractManager implements IControlManager, INotifiableManager {
	
	/**
	 * Starts playing the media file <code>filename</code> .
	 * @param response Response object
	 * @param filename File to play
	 */
	public void playFile(final DataResponse<Boolean> response, final String filename, final int playlistType, final Context context) {
		mHandler.post(new Command<Boolean>(response, this){
			@Override
			public void doRun() throws Exception {
				response.value = control(context).playFile(ControlManager.this, filename, playlistType);
			}
		});
	}

	/**
	 * Starts playing a whole folder
	 * @param response Response object
	 * @param foldername Path to the folder to play
	 * @param context Context reference
	 */
	public void playFolder(final DataResponse<Boolean> response, final String foldername, final int playlistType, final Context context) {
		mHandler.post(new Command<Boolean>(response, this){
			@Override
			public void doRun() throws Exception {
				IControlClient cc = control(context);
				cc.stop(ControlManager.this);
				cc.clearPlaylist(ControlManager.this, playlistType);
				cc.addToPlaylist(ControlManager.this, foldername, playlistType);
				cc.setCurrentPlaylist(ControlManager.this, playlistType);
				response.value = cc.playNext(ControlManager.this);
			}
		});
	}
	
	/**
	 * Queues a whole folder
	 * @param response Response object
	 * @param foldername Path to the folder to play
	 * @param context Context reference
	 */
	public void queueFolder(final DataResponse<Boolean> response, final String foldername, final int playlistType, final Context context) {
		mHandler.post(new Command<Boolean>(response, this){
			@Override
			public void doRun() throws Exception {
				IControlClient cc = control(context);
				final boolean ret = cc.addToPlaylist(ControlManager.this, foldername, playlistType);
				if (!cc.getCurrentlyPlaying(ControlManager.this).isPlaying()) {
					cc.setCurrentPlaylist(ControlManager.this, playlistType);
					response.value = cc.playNext(ControlManager.this);
				} else {
					response.value = ret;
				}
			}
		});
	}
	
	/**
	 * Start playing the media file at the given URL
	 * @param response Response object
	 * @param url An URL pointing to a supported media file
	 * @return true on success, false otherwise.
	 */
	public void playUrl(final DataResponse<Boolean> response, final String url, final Context context) {
		mHandler.post(new Command<Boolean>(response, this){
			@Override
			public void doRun() throws Exception {
				response.value = control(context).playUrl(ControlManager.this, url);
			}
			
		});
	}
	
	/**
	 * Plays the next item in the playlist.
	 * @param response Response object
	 * @return true on success, false otherwise.
	 */
	public void playNext(final DataResponse<Boolean> response, final Context context) {
		mHandler.post(new Command<Boolean>(response, this){
			@Override
			public void doRun() throws Exception {
				response.value = control(context).playNext(ControlManager.this);
			}
		});
	}
	
	/**
	 * Adds a file or folder (<code>fileOrFolder</code> is either a file or a folder) to the current playlist.
	 * @param response Response object
	 * @param fileOrFolder File to play
	 */
	public void addToPlaylist(final DataResponse<Boolean> response, final String fileOrFolder, final int playlistType, final Context context) {
		mHandler.post(new Command<Boolean>(response, this){
			@Override
			public void doRun() throws Exception {
				response.value = control(context).addToPlaylist(ControlManager.this, fileOrFolder, playlistType);
			}
		});
	}
	
	/**
	 * Send the string <code>text</code> via keys on the virtual keyboard.
	 * @param response Response object
	 * @param text The text string to send.
	 * @return true on success, false otherwise.
	 */
	public void sendText(final DataResponse<Boolean> response, final String text, final Context context) {
		mHandler.post(new Command<Boolean>(response, this){
			@Override
			public void doRun() throws Exception {
				response.value = control(context).sendText(ControlManager.this, text);
			}	
		});
	}

	/**
	 * Seeks to a position. If type is
	 * <ul>
	 * 	<li><code>absolute</code> - Sets the playing position of the currently 
	 *		playing media as a percentage of the media's length.</li>
	 *  <li><code>relative</code> - Adds/Subtracts the current percentage on to
	 *		the current position in the song</li>
	 * </ul> 
	 * 
	 * @param response Response object	 
	 * @param type     Seek type, relative or absolute
	 * @param progress Progress
	 * @return true on success, false otherwise.
	 */
	public void seek(final DataResponse<Boolean> response, final SeekType type, final int progress, final Context context) {
		mHandler.post(new Command<Boolean>(response, this){
			@Override
			public void doRun() throws Exception {
				response.value = control(context).seek(ControlManager.this, type, progress);
			}
		});
	}

	/**
	 * Takes either "video" or "music" as a parameter to begin updating the 
	 * corresponding database.
	 * 
	 * @param response Response object
	 * @param mediaType
	 */
	public void updateLibrary(final DataResponse<Boolean> response, final String mediaType, final Context context) {
		mHandler.post(new Command<Boolean>(response, this){
			@Override
			public void doRun() throws Exception {
				response.value = control(context).updateLibrary(ControlManager.this, mediaType);
			}
		});
	}
	
	/**
	 * Displays the image <code>filename</code> .
	 * @param response Response object
	 * @param filename File to show
	 */
	public void showPicture(final DataResponse<Boolean> response, final String filename, final Context context) {
		mHandler.post(new Command<Boolean>(response, this){
			@Override
			public void doRun() throws Exception {
				response.value = control(context).showPicture(ControlManager.this, filename);
			}
		});
	}
	

	/**
	 * Returns what's currently playing.
	 * @param response
	 */
	public void getCurrentlyPlaying(final DataResponse<ICurrentlyPlaying> response, final Context context) {
		mHandler.post(new Command<ICurrentlyPlaying>(response, this){
			@Override
			public void doRun() throws Exception {
				response.value = control(context).getCurrentlyPlaying(ControlManager.this);
			}
		});
	}
	
	
	/**
	 * Returns the current playlist identifier
	 * @param response Response object
	 */
	public void getPlaylistId(final DataResponse<Integer> response, final Context context) {
		mHandler.post(new Command<Integer>(response, this){
			@Override
			public void doRun() throws Exception {
				response.value = control(context).getPlaylistId(ControlManager.this);
			}
		});
	}
	
	
	/**
	 * Sets the current playlist identifier
	 * @param response Response object
	 * @param id Playlist identifier
	 */
	public void setPlaylistId(final DataResponse<Boolean> response, final int id, final Context context) {
		mHandler.post(new Command<Boolean>(response, this){
			@Override
			public void doRun() throws Exception {
				response.value = control(context).setPlaylistId(ControlManager.this, id);
			}
		});
	}
	
	/**
	 * Sets the current playlist position
	 * @param response Response object
	 * @param position New playlist position
	 */
	public void setPlaylistPos(final DataResponse<Boolean> response, final int playlistId, final int position, final Context context) {
		mHandler.post(new Command<Boolean>(response, this){
			@Override
			public void doRun() throws Exception {
				response.value = control(context).setPlaylistPos(ControlManager.this, playlistId, position);
			}
		});
	}

	/**
	 * Clears playlist
	 * @param response Response object
	 * @param playlistId Playlist ID (0 = music, 1 = video)
	 * @param context Context reference
	 */
	public void clearPlaylist(final DataResponse<Boolean> response, final int playlistId, final Context context) {
		mHandler.post(new Command<Boolean>(response, this){
			@Override
			public void doRun() throws Exception {
				response.value = control(context).clearPlaylist(ControlManager.this, playlistId);
			}
		});
	}
	
	/**
	 * Sets the gui setting of XBMC to value
	 * @param response Response object 
	 * @param setting see {@link org.xbmc.api.info.GuiSettings} for the available settings
	 * @param value the value to set
	 */
	public void setGuiSetting(final DataResponse<Boolean> response, final int setting, 
			final String value, final Context context) {
		mHandler.post(new Command<Boolean>(response, this) {
			@Override
			public void doRun() throws Exception {
				response.value = control(context).setGuiSetting(ControlManager.this, setting, value);
			}
		});
		
	}

	public void getVolume(final DataResponse<Integer> response, final Context context) {
		mHandler.post(new Command<Integer>(response, this) {
			@Override
			public void doRun() throws Exception {
				response.value = control(context).getVolume(ControlManager.this);
			}
		});
	}
}