1 /* ownCloud Android client application
2 * Copyright (C) 2012-2013 ownCloud Inc.
4 * This program is free software: you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License version 2,
6 * as published by the Free Software Foundation.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License
14 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18 package com
.owncloud
.android
.media
;
20 import android
.accounts
.Account
;
21 import android
.app
.Notification
;
22 import android
.app
.NotificationManager
;
23 import android
.app
.PendingIntent
;
24 import android
.app
.Service
;
25 import android
.content
.Context
;
26 import android
.content
.Intent
;
27 import android
.media
.AudioManager
;
28 import android
.media
.MediaPlayer
;
29 import android
.media
.MediaPlayer
.OnCompletionListener
;
30 import android
.media
.MediaPlayer
.OnErrorListener
;
31 import android
.media
.MediaPlayer
.OnPreparedListener
;
32 import android
.net
.wifi
.WifiManager
;
33 import android
.net
.wifi
.WifiManager
.WifiLock
;
34 import android
.os
.IBinder
;
35 import android
.os
.PowerManager
;
36 import android
.widget
.Toast
;
38 import java
.io
.IOException
;
40 import com
.owncloud
.android
.R
;
41 import com
.owncloud
.android
.datamodel
.OCFile
;
42 import com
.owncloud
.android
.lib
.common
.utils
.Log_OC
;
43 import com
.owncloud
.android
.ui
.activity
.FileActivity
;
44 import com
.owncloud
.android
.ui
.activity
.FileDisplayActivity
;
48 * Service that handles media playback, both audio and video.
50 * Waits for Intents which signal the service to perform specific operations: Play, Pause,
53 * @author David A. Velasco
55 public class MediaService
extends Service
implements OnCompletionListener
, OnPreparedListener
,
56 OnErrorListener
, AudioManager
.OnAudioFocusChangeListener
{
58 private static final String TAG
= MediaService
.class.getSimpleName();
60 private static final String MY_PACKAGE
= MediaService
.class.getPackage() != null ? MediaService
.class.getPackage().getName() : "com.owncloud.android.media";
62 /// Intent actions that we are prepared to handle
63 public static final String ACTION_PLAY_FILE
= MY_PACKAGE
+ ".action.PLAY_FILE";
64 public static final String ACTION_STOP_ALL
= MY_PACKAGE
+ ".action.STOP_ALL";
66 /// Keys to add extras to the action
67 public static final String EXTRA_FILE
= MY_PACKAGE
+ ".extra.FILE";
68 public static final String EXTRA_ACCOUNT
= MY_PACKAGE
+ ".extra.ACCOUNT";
69 public static String EXTRA_START_POSITION
= MY_PACKAGE
+ ".extra.START_POSITION";
70 public static final String EXTRA_PLAY_ON_LOAD
= MY_PACKAGE
+ ".extra.PLAY_ON_LOAD";
73 /** Error code for specific messages - see regular error codes at {@link MediaPlayer} */
74 public static final int OC_MEDIA_ERROR
= 0;
76 /** Time To keep the control panel visible when the user does not use it */
77 public static final int MEDIA_CONTROL_SHORT_LIFE
= 4000;
79 /** Time To keep the control panel visible when the user does not use it */
80 public static final int MEDIA_CONTROL_PERMANENT
= 0;
82 /** Volume to set when audio focus is lost and ducking is allowed */
83 private static final float DUCK_VOLUME
= 0.1f
;
85 /** Media player instance */
86 private MediaPlayer mPlayer
= null
;
88 /** Reference to the system AudioManager */
89 private AudioManager mAudioManager
= null
;
92 /** Values to indicate the state of the service */
102 private State mState
= State
.STOPPED
;
104 /** Possible focus values */
111 /** Current focus state */
112 private AudioFocus mAudioFocus
= AudioFocus
.NO_FOCUS
;
115 /** 'True' when the current song is streaming from the network */
116 private boolean mIsStreaming
= false
;
118 /** Wifi lock kept to prevents the device from shutting off the radio when streaming a file. */
119 private WifiLock mWifiLock
;
121 private static final String MEDIA_WIFI_LOCK_TAG
= MY_PACKAGE
+ ".WIFI_LOCK";
123 /** Notification to keep in the notification bar while a song is playing */
124 private NotificationManager mNotificationManager
;
125 private Notification mNotification
= null
;
127 /** File being played */
128 private OCFile mFile
;
130 /** Account holding the file being played */
131 private Account mAccount
;
133 /** Flag signaling if the audio should be played immediately when the file is prepared */
134 protected boolean mPlayOnPrepared
;
136 /** Position, in miliseconds, where the audio should be started */
137 private int mStartPosition
;
139 /** Interface to access the service through binding */
140 private IBinder mBinder
;
142 /** Control panel shown to the user to control the playback, to register through binding */
143 private MediaControlView mMediaController
;
148 * Helper method to get an error message suitable to show to users for errors occurred in media playback,
150 * @param context A context to access string resources.
151 * @param what See {@link MediaPlayer.OnErrorListener#onError(MediaPlayer, int, int)
152 * @param extra See {@link MediaPlayer.OnErrorListener#onError(MediaPlayer, int, int)
153 * @return Message suitable to users.
155 public static String
getMessageForMediaError(Context context
, int what
, int extra
) {
158 if (what
== OC_MEDIA_ERROR
) {
161 } else if (extra
== MediaPlayer
.MEDIA_ERROR_UNSUPPORTED
) {
162 /* Added in API level 17
163 Bitstream is conforming to the related coding standard or file spec, but the media framework does not support the feature.
164 Constant Value: -1010 (0xfffffc0e)
166 messageId
= R
.string
.media_err_unsupported
;
168 } else if (extra
== MediaPlayer
.MEDIA_ERROR_IO
) {
169 /* Added in API level 17
170 File or network related operation errors.
171 Constant Value: -1004 (0xfffffc14)
173 messageId
= R
.string
.media_err_io
;
175 } else if (extra
== MediaPlayer
.MEDIA_ERROR_MALFORMED
) {
176 /* Added in API level 17
177 Bitstream is not conforming to the related coding standard or file spec.
178 Constant Value: -1007 (0xfffffc11)
180 messageId
= R
.string
.media_err_malformed
;
182 } else if (extra
== MediaPlayer
.MEDIA_ERROR_TIMED_OUT
) {
183 /* Added in API level 17
184 Some operation takes too long to complete, usually more than 3-5 seconds.
185 Constant Value: -110 (0xffffff92)
187 messageId
= R
.string
.media_err_timeout
;
189 } else if (what
== MediaPlayer
.MEDIA_ERROR_NOT_VALID_FOR_PROGRESSIVE_PLAYBACK
) {
190 /* Added in API level 3
191 The video is streamed and its container is not valid for progressive playback i.e the video's index (e.g moov atom) is not at the start of the file.
192 Constant Value: 200 (0x000000c8)
194 messageId
= R
.string
.media_err_invalid_progressive_playback
;
197 /* MediaPlayer.MEDIA_ERROR_UNKNOWN
199 Unspecified media player error.
200 Constant Value: 1 (0x00000001)
202 /* MediaPlayer.MEDIA_ERROR_SERVER_DIED)
204 Media server died. In this case, the application must release the MediaPlayer object and instantiate a new one.
205 Constant Value: 100 (0x00000064)
207 messageId
= R
.string
.media_err_unknown
;
209 return context
.getString(messageId
);
215 * Initialize a service instance
220 public void onCreate() {
222 Log_OC
.d(TAG
, "Creating ownCloud media service");
224 mWifiLock
= ((WifiManager
) getSystemService(Context
.WIFI_SERVICE
)).
225 createWifiLock(WifiManager
.WIFI_MODE_FULL
, MEDIA_WIFI_LOCK_TAG
);
227 mNotificationManager
= (NotificationManager
) getSystemService(NOTIFICATION_SERVICE
);
228 mAudioManager
= (AudioManager
) getSystemService(AUDIO_SERVICE
);
229 mBinder
= new MediaServiceBinder(this);
234 * Entry point for Intents requesting actions, sent here via startService.
239 public int onStartCommand(Intent intent
, int flags
, int startId
) {
240 String action
= intent
.getAction();
241 if (action
.equals(ACTION_PLAY_FILE
)) {
242 processPlayFileRequest(intent
);
244 } else if (action
.equals(ACTION_STOP_ALL
)) {
245 processStopRequest(true
);
248 return START_NOT_STICKY
; // don't want it to restart in case it's killed.
253 * Processes a request to play a media file received as a parameter
255 * TODO If a new request is received when a file is being prepared, it is ignored. Is this what we want?
257 * @param intent Intent received in the request with the data to identify the file to play.
259 private void processPlayFileRequest(Intent intent
) {
260 if (mState
!= State
.PREPARING
) {
261 mFile
= intent
.getExtras().getParcelable(EXTRA_FILE
);
262 mAccount
= intent
.getExtras().getParcelable(EXTRA_ACCOUNT
);
263 mPlayOnPrepared
= intent
.getExtras().getBoolean(EXTRA_PLAY_ON_LOAD
, false
);
264 mStartPosition
= intent
.getExtras().getInt(EXTRA_START_POSITION
, 0);
265 tryToGetAudioFocus();
272 * Processes a request to play a media file.
274 protected void processPlayRequest() {
275 // request audio focus
276 tryToGetAudioFocus();
278 // actually play the song
279 if (mState
== State
.STOPPED
) {
280 // (re)start playback
283 } else if (mState
== State
.PAUSED
) {
285 mState
= State
.PLAYING
;
286 setUpAsForeground(String
.format(getString(R
.string
.media_state_playing
), mFile
.getFileName()));
287 configAndStartMediaPlayer();
294 * Makes sure the media player exists and has been reset. This will create the media player
295 * if needed. reset the existing media player if one already exists.
297 protected void createMediaPlayerIfNeeded() {
298 if (mPlayer
== null
) {
299 mPlayer
= new MediaPlayer();
301 // make sure the CPU won't go to sleep while media is playing
302 mPlayer
.setWakeMode(getApplicationContext(), PowerManager
.PARTIAL_WAKE_LOCK
);
304 // the media player will notify the service when it's ready preparing, and when it's done playing
305 mPlayer
.setOnPreparedListener(this);
306 mPlayer
.setOnCompletionListener(this);
307 mPlayer
.setOnErrorListener(this);
315 * Processes a request to pause the current playback
317 protected void processPauseRequest() {
318 if (mState
== State
.PLAYING
) {
319 mState
= State
.PAUSED
;
321 releaseResources(false
); // retain media player in pause
322 // TODO polite audio focus, instead of keep it owned; or not?
328 * Processes a request to stop the playback.
330 * @param force When 'true', the playback is stopped no matter the value of mState
332 protected void processStopRequest(boolean force
) {
333 if (mState
!= State
.PREPARING
|| force
) {
334 mState
= State
.STOPPED
;
337 releaseResources(true
);
339 stopSelf(); // service is no longer necessary
345 * Releases resources used by the service for playback. This includes the "foreground service"
346 * status and notification, the wake locks and possibly the MediaPlayer.
348 * @param releaseMediaPlayer Indicates whether the Media Player should also be released or not
350 protected void releaseResources(boolean releaseMediaPlayer
) {
351 // stop being a foreground service
352 stopForeground(true
);
354 // stop and release the Media Player, if it's available
355 if (releaseMediaPlayer
&& mPlayer
!= null
) {
361 // release the Wifi lock, if holding it
362 if (mWifiLock
.isHeld()) {
369 * Fully releases the audio focus.
371 private void giveUpAudioFocus() {
372 if (mAudioFocus
== AudioFocus
.FOCUS
373 && mAudioManager
!= null
374 && AudioManager
.AUDIOFOCUS_REQUEST_GRANTED
== mAudioManager
.abandonAudioFocus(this)) {
376 mAudioFocus
= AudioFocus
.NO_FOCUS
;
382 * Reconfigures MediaPlayer according to audio focus settings and starts/restarts it.
384 protected void configAndStartMediaPlayer() {
385 if (mPlayer
== null
) {
386 throw new IllegalStateException("mPlayer is NULL");
389 if (mAudioFocus
== AudioFocus
.NO_FOCUS
) {
390 if (mPlayer
.isPlaying()) {
391 mPlayer
.pause(); // have to be polite; but mState is not changed, to resume when focus is received again
395 if (mAudioFocus
== AudioFocus
.NO_FOCUS_CAN_DUCK
) {
396 mPlayer
.setVolume(DUCK_VOLUME
, DUCK_VOLUME
);
399 mPlayer
.setVolume(1.0f
, 1.0f
); // full volume
402 if (!mPlayer
.isPlaying()) {
410 * Requests the audio focus to the Audio Manager
412 private void tryToGetAudioFocus() {
413 if (mAudioFocus
!= AudioFocus
.FOCUS
414 && mAudioManager
!= null
415 && (AudioManager
.AUDIOFOCUS_REQUEST_GRANTED
== mAudioManager
.requestAudioFocus( this,
416 AudioManager
.STREAM_MUSIC
,
417 AudioManager
.AUDIOFOCUS_GAIN
))
419 mAudioFocus
= AudioFocus
.FOCUS
;
425 * Starts playing the current media file.
427 protected void playMedia() {
428 mState
= State
.STOPPED
;
429 releaseResources(false
); // release everything except MediaPlayer
433 Toast
.makeText(this, R
.string
.media_err_nothing_to_play
, Toast
.LENGTH_LONG
).show();
434 processStopRequest(true
);
437 } else if (mAccount
== null
) {
438 Toast
.makeText(this, R
.string
.media_err_not_in_owncloud
, Toast
.LENGTH_LONG
).show();
439 processStopRequest(true
);
443 createMediaPlayerIfNeeded();
444 mPlayer
.setAudioStreamType(AudioManager
.STREAM_MUSIC
);
445 String url
= mFile
.getStoragePath();
446 /* Streaming is not possible right now
447 if (url == null || url.length() <= 0) {
448 url = AccountUtils.constructFullURLForAccount(this, mAccount) + mFile.getRemotePath();
450 mIsStreaming = url.startsWith("http:") || url.startsWith("https:");
452 mIsStreaming
= false
;
454 mPlayer
.setDataSource(url
);
456 mState
= State
.PREPARING
;
457 setUpAsForeground(String
.format(getString(R
.string
.media_state_loading
), mFile
.getFileName()));
459 // starts preparing the media player in background
460 mPlayer
.prepareAsync();
462 // prevent the Wifi from going to sleep when streaming
465 } else if (mWifiLock
.isHeld()) {
469 } catch (SecurityException e
) {
470 Log_OC
.e(TAG
, "SecurityException playing " + mAccount
.name
+ mFile
.getRemotePath(), e
);
471 Toast
.makeText(this, String
.format(getString(R
.string
.media_err_security_ex
), mFile
.getFileName()), Toast
.LENGTH_LONG
).show();
472 processStopRequest(true
);
474 } catch (IOException e
) {
475 Log_OC
.e(TAG
, "IOException playing " + mAccount
.name
+ mFile
.getRemotePath(), e
);
476 Toast
.makeText(this, String
.format(getString(R
.string
.media_err_io_ex
), mFile
.getFileName()), Toast
.LENGTH_LONG
).show();
477 processStopRequest(true
);
479 } catch (IllegalStateException e
) {
480 Log_OC
.e(TAG
, "IllegalStateException " + mAccount
.name
+ mFile
.getRemotePath(), e
);
481 Toast
.makeText(this, String
.format(getString(R
.string
.media_err_unexpected
), mFile
.getFileName()), Toast
.LENGTH_LONG
).show();
482 processStopRequest(true
);
484 } catch (IllegalArgumentException e
) {
485 Log_OC
.e(TAG
, "IllegalArgumentException " + mAccount
.name
+ mFile
.getRemotePath(), e
);
486 Toast
.makeText(this, String
.format(getString(R
.string
.media_err_unexpected
), mFile
.getFileName()), Toast
.LENGTH_LONG
).show();
487 processStopRequest(true
);
492 /** Called when media player is done playing current song. */
493 public void onCompletion(MediaPlayer player
) {
494 Toast
.makeText(this, String
.format(getString(R
.string
.media_event_done
, mFile
.getFileName())), Toast
.LENGTH_LONG
).show();
495 if (mMediaController
!= null
) {
496 // somebody is still bound to the service
498 processPauseRequest();
499 mMediaController
.updatePausePlay();
502 processStopRequest(true
);
509 * Called when media player is done preparing.
513 public void onPrepared(MediaPlayer player
) {
514 mState
= State
.PLAYING
;
515 updateNotification(String
.format(getString(R
.string
.media_state_playing
), mFile
.getFileName()));
516 if (mMediaController
!= null
) {
517 mMediaController
.setEnabled(true
);
519 player
.seekTo(mStartPosition
);
520 configAndStartMediaPlayer();
521 if (!mPlayOnPrepared
) {
522 processPauseRequest();
525 if (mMediaController
!= null
) {
526 mMediaController
.updatePausePlay();
532 * Updates the status notification
534 @SuppressWarnings("deprecation")
535 private void updateNotification(String content
) {
536 // TODO check if updating the Intent is really necessary
537 Intent showDetailsIntent
= new Intent(this, FileDisplayActivity
.class);
538 showDetailsIntent
.putExtra(FileActivity
.EXTRA_FILE
, mFile
);
539 showDetailsIntent
.putExtra(FileActivity
.EXTRA_ACCOUNT
, mAccount
);
540 showDetailsIntent
.setFlags(Intent
.FLAG_ACTIVITY_CLEAR_TOP
);
541 mNotification
.contentIntent
= PendingIntent
.getActivity(getApplicationContext(),
542 (int)System
.currentTimeMillis(),
544 PendingIntent
.FLAG_UPDATE_CURRENT
);
545 mNotification
.when
= System
.currentTimeMillis();
546 //mNotification.contentView.setTextViewText(R.id.status_text, content);
547 String ticker
= String
.format(getString(R
.string
.media_notif_ticker
), getString(R
.string
.app_name
));
548 mNotification
.setLatestEventInfo(getApplicationContext(), ticker
, content
, mNotification
.contentIntent
);
549 mNotificationManager
.notify(R
.string
.media_notif_ticker
, mNotification
);
554 * Configures the service as a foreground service.
556 * The system will avoid finishing the service as much as possible when resources as low.
558 * A notification must be created to keep the user aware of the existance of the service.
560 @SuppressWarnings("deprecation")
561 private void setUpAsForeground(String content
) {
562 /// creates status notification
563 // TODO put a progress bar to follow the playback progress
564 mNotification
= new Notification();
565 mNotification
.icon
= android
.R
.drawable
.ic_media_play
;
566 //mNotification.tickerText = text;
567 mNotification
.when
= System
.currentTimeMillis();
568 mNotification
.flags
|= Notification
.FLAG_ONGOING_EVENT
;
569 //mNotification.contentView.setTextViewText(R.id.status_text, "ownCloud Music Player"); // NULL POINTER
570 //mNotification.contentView.setTextViewText(R.id.status_text, getString(R.string.downloader_download_in_progress_content));
573 /// includes a pending intent in the notification showing the details view of the file
574 Intent showDetailsIntent
= new Intent(this, FileDisplayActivity
.class);
575 showDetailsIntent
.putExtra(FileActivity
.EXTRA_FILE
, mFile
);
576 showDetailsIntent
.putExtra(FileActivity
.EXTRA_ACCOUNT
, mAccount
);
577 showDetailsIntent
.setFlags(Intent
.FLAG_ACTIVITY_CLEAR_TOP
);
578 mNotification
.contentIntent
= PendingIntent
.getActivity(getApplicationContext(),
579 (int)System
.currentTimeMillis(),
581 PendingIntent
.FLAG_UPDATE_CURRENT
);
584 //mNotificationManager.notify(R.string.downloader_download_in_progress_ticker, mNotification);
585 String ticker
= String
.format(getString(R
.string
.media_notif_ticker
), getString(R
.string
.app_name
));
586 mNotification
.setLatestEventInfo(getApplicationContext(), ticker
, content
, mNotification
.contentIntent
);
587 startForeground(R
.string
.media_notif_ticker
, mNotification
);
592 * Called when there's an error playing media.
594 * Warns the user about the error and resets the media player.
596 public boolean onError(MediaPlayer mp
, int what
, int extra
) {
597 Log_OC
.e(TAG
, "Error in audio playback, what = " + what
+ ", extra = " + extra
);
599 String message
= getMessageForMediaError(this, what
, extra
);
600 Toast
.makeText(getApplicationContext(), message
, Toast
.LENGTH_SHORT
).show();
602 processStopRequest(true
);
607 * Called by the system when another app tries to play some sound.
612 public void onAudioFocusChange(int focusChange
) {
613 if (focusChange
> 0) {
614 // focus gain; check AudioManager.AUDIOFOCUS_* values
615 mAudioFocus
= AudioFocus
.FOCUS
;
616 // restart media player with new focus settings
617 if (mState
== State
.PLAYING
)
618 configAndStartMediaPlayer();
620 } else if (focusChange
< 0) {
621 // focus loss; check AudioManager.AUDIOFOCUS_* values
622 boolean canDuck
= AudioManager
.AUDIOFOCUS_LOSS_TRANSIENT_CAN_DUCK
== focusChange
;
623 mAudioFocus
= canDuck ? AudioFocus
.NO_FOCUS_CAN_DUCK
: AudioFocus
.NO_FOCUS
;
624 // start/restart/pause media player with new focus settings
625 if (mPlayer
!= null
&& mPlayer
.isPlaying())
626 configAndStartMediaPlayer();
632 * Called when the service is finished for final clean-up.
637 public void onDestroy() {
638 mState
= State
.STOPPED
;
639 releaseResources(true
);
646 * Provides a binder object that clients can use to perform operations on the MediaPlayer managed by the MediaService.
649 public IBinder
onBind(Intent arg
) {
655 * Called when ALL the bound clients were onbound.
657 * The service is destroyed if playback stopped or paused
660 public boolean onUnbind(Intent intent
) {
661 if (mState
== State
.PAUSED
|| mState
== State
.STOPPED
) {
662 processStopRequest(false
);
664 return false
; // not accepting rebinding (default behaviour)
669 * Accesses the current MediaPlayer instance in the service.
671 * To be handled carefully. Visibility is protected to be accessed only
673 * @return Current MediaPlayer instance handled by MediaService.
675 protected MediaPlayer
getPlayer() {
681 * Accesses the current OCFile loaded in the service.
683 * @return The current OCFile loaded in the service.
685 protected OCFile
getCurrentFile() {
691 * Accesses the current {@link State} of the MediaService.
693 * @return The current {@link State} of the MediaService.
695 protected State
getState() {
700 protected void setMediaContoller(MediaControlView mediaController
) {
701 mMediaController
= mediaController
;
704 protected MediaControlView
getMediaController() {
705 return mMediaController
;