1 /* ownCloud Android client application
2 * Copyright 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 as published by
6 * the Free Software Foundation, either version 3 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program. If not, see <http://www.gnu.org/licenses/>.
19 package com
.owncloud
.android
.media
;
21 import android
.accounts
.Account
;
22 import android
.app
.Notification
;
23 import android
.app
.NotificationManager
;
24 import android
.app
.PendingIntent
;
25 import android
.app
.Service
;
26 import android
.content
.Context
;
27 import android
.content
.Intent
;
28 import android
.media
.AudioManager
;
29 import android
.media
.MediaPlayer
;
30 import android
.media
.MediaPlayer
.OnCompletionListener
;
31 import android
.media
.MediaPlayer
.OnErrorListener
;
32 import android
.media
.MediaPlayer
.OnPreparedListener
;
33 import android
.net
.wifi
.WifiManager
;
34 import android
.net
.wifi
.WifiManager
.WifiLock
;
35 import android
.os
.IBinder
;
36 import android
.os
.PowerManager
;
37 import android
.util
.Log
;
38 import android
.widget
.MediaController
;
39 import android
.widget
.Toast
;
41 import java
.io
.IOException
;
43 import com
.owncloud
.android
.AccountUtils
;
44 import com
.owncloud
.android
.R
;
45 import com
.owncloud
.android
.datamodel
.OCFile
;
46 import com
.owncloud
.android
.ui
.activity
.FileDetailActivity
;
47 import com
.owncloud
.android
.ui
.fragment
.FileDetailFragment
;
50 * Service that handles media playback, both audio and video.
52 * Waits for Intents which signal the service to perform specific operations: Play, Pause,
55 * @author David A. Velasco
57 public class MediaService
extends Service
implements OnCompletionListener
, OnPreparedListener
,
58 OnErrorListener
, AudioManager
.OnAudioFocusChangeListener
{
60 private static final String TAG
= MediaService
.class.getSimpleName();
62 private static final String MY_PACKAGE
= MediaService
.class.getPackage() != null ? MediaService
.class.getPackage().getName() : "com.owncloud.android.media";
64 /// Intent actions that we are prepared to handle
65 public static final String ACTION_PLAY_FILE
= MY_PACKAGE
+ ".android.media.action.PLAY_FILE";
67 /// Keys to add extras to the action
68 public static final String EXTRA_FILE
= MY_PACKAGE
+ ".extra.FILE";
69 public static final String EXTRA_ACCOUNT
= MY_PACKAGE
+ ".extra.ACCOUNT";
71 /** Error code for specific messages - see regular error codes at {@link MediaPlayer} */
72 public static final int OC_MEDIA_ERROR
= 0;
74 /** Time To keep the control panel visible when the user does not use it */
75 public static final int MEDIA_CONTROL_SHORT_LIFE
= 5000;
77 /** Time To keep the control panel visible when the user does not use it */
78 public static final int MEDIA_CONTROL_PERMANENT
= 0;
80 /** Volume to set when audio focus is lost and ducking is allowed */
81 private static final float DUCK_VOLUME
= 0.1f
;
83 /** Media player instance */
84 private MediaPlayer mPlayer
= null
;
86 /** Reference to the system AudioManager */
87 private AudioManager mAudioManager
= null
;
90 /** Values to indicate the state of the service */
100 private State mState
= State
.STOPPED
;
102 /** Possible focus values */
109 /** Current focus state */
110 private AudioFocus mAudioFocus
= AudioFocus
.NO_FOCUS
;
113 /** 'True' when the current song is streaming from the network */
114 private boolean mIsStreaming
= false
;
116 /** Wifi lock kept to prevents the device from shutting off the radio when streaming a file. */
117 private WifiLock mWifiLock
;
119 private static final String MEDIA_WIFI_LOCK_TAG
= MY_PACKAGE
+ ".WIFI_LOCK";
121 /** Notification to keep in the notification bar while a song is playing */
122 private NotificationManager mNotificationManager
;
123 private Notification mNotification
= null
;
125 /** File being played */
126 private OCFile mFile
;
128 /** Account holding the file being played */
129 private Account mAccount
;
131 /** Interface to access the service through binding */
132 private IBinder mBinder
;
134 /** Control panel shown to the user to control the playback, to register through binding */
135 private MediaController mMediaController
;
140 * Helper method to get an error message suitable to show to users for errors occurred in media playback,
142 * @param context A context to access string resources.
143 * @param what See {@link MediaPlayer.OnErrorListener#onError(MediaPlayer, int, int)
144 * @param extra See {@link MediaPlayer.OnErrorListener#onError(MediaPlayer, int, int)
145 * @return Message suitable to users.
147 public static String
getMessageForMediaError(Context context
, int what
, int extra
) {
150 if (what
== OC_MEDIA_ERROR
) {
153 } else if (extra
== MediaPlayer
.MEDIA_ERROR_UNSUPPORTED
) {
154 /* Added in API level 17
155 Bitstream is conforming to the related coding standard or file spec, but the media framework does not support the feature.
156 Constant Value: -1010 (0xfffffc0e)
158 messageId
= R
.string
.media_err_unsupported
;
160 } else if (extra
== MediaPlayer
.MEDIA_ERROR_IO
) {
161 /* Added in API level 17
162 File or network related operation errors.
163 Constant Value: -1004 (0xfffffc14)
165 messageId
= R
.string
.media_err_io
;
167 } else if (extra
== MediaPlayer
.MEDIA_ERROR_MALFORMED
) {
168 /* Added in API level 17
169 Bitstream is not conforming to the related coding standard or file spec.
170 Constant Value: -1007 (0xfffffc11)
172 messageId
= R
.string
.media_err_malformed
;
174 } else if (extra
== MediaPlayer
.MEDIA_ERROR_TIMED_OUT
) {
175 /* Added in API level 17
176 Some operation takes too long to complete, usually more than 3-5 seconds.
177 Constant Value: -110 (0xffffff92)
179 messageId
= R
.string
.media_err_timeout
;
181 } else if (what
== MediaPlayer
.MEDIA_ERROR_NOT_VALID_FOR_PROGRESSIVE_PLAYBACK
) {
182 /* Added in API level 3
183 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.
184 Constant Value: 200 (0x000000c8)
186 messageId
= R
.string
.media_err_invalid_progressive_playback
;
189 /* MediaPlayer.MEDIA_ERROR_UNKNOWN
191 Unspecified media player error.
192 Constant Value: 1 (0x00000001)
194 /* MediaPlayer.MEDIA_ERROR_SERVER_DIED)
196 Media server died. In this case, the application must release the MediaPlayer object and instantiate a new one.
197 Constant Value: 100 (0x00000064)
199 messageId
= R
.string
.media_err_unknown
;
201 return context
.getString(messageId
);
207 * Initialize a service instance
212 public void onCreate() {
213 Log
.d(TAG
, "Creating ownCloud media service");
215 mWifiLock
= ((WifiManager
) getSystemService(Context
.WIFI_SERVICE
)).
216 createWifiLock(WifiManager
.WIFI_MODE_FULL
, MEDIA_WIFI_LOCK_TAG
);
218 mNotificationManager
= (NotificationManager
) getSystemService(NOTIFICATION_SERVICE
);
219 mAudioManager
= (AudioManager
) getSystemService(AUDIO_SERVICE
);
220 mBinder
= new MediaServiceBinder(this);
225 * Entry point for Intents requesting actions, sent here via startService.
230 public int onStartCommand(Intent intent
, int flags
, int startId
) {
231 String action
= intent
.getAction();
232 if (action
.equals(ACTION_PLAY_FILE
)) {
233 processPlayFileRequest(intent
);
236 return START_NOT_STICKY
; // don't want it to restart in case it's killed.
241 * Processes a request to play a media file received as a parameter
243 * TODO If a new request is received when a file is being prepared, it is ignored. Is this what we want?
245 * @param intent Intent received in the request with the data to identify the file to play.
247 private void processPlayFileRequest(Intent intent
) {
248 if (mState
!= State
.PREPARING
) {
249 mFile
= intent
.getExtras().getParcelable(EXTRA_FILE
);
250 mAccount
= intent
.getExtras().getParcelable(EXTRA_ACCOUNT
);
251 tryToGetAudioFocus();
258 * Processes a request to play a media file.
260 protected void processPlayRequest() {
261 // request audio focus
262 tryToGetAudioFocus();
264 // actually play the song
265 if (mState
== State
.STOPPED
) {
266 // (re)start playback
269 } else if (mState
== State
.PAUSED
) {
271 mState
= State
.PLAYING
;
272 setUpAsForeground(String
.format(getString(R
.string
.media_state_playing
), mFile
.getFileName()));
273 configAndStartMediaPlayer();
280 * Makes sure the media player exists and has been reset. This will create the media player
281 * if needed, or reset the existing media player if one already exists.
283 protected void createMediaPlayerIfNeeded() {
284 if (mPlayer
== null
) {
285 mPlayer
= new MediaPlayer();
287 // make sure the CPU won't go to sleep while media is playing
288 mPlayer
.setWakeMode(getApplicationContext(), PowerManager
.PARTIAL_WAKE_LOCK
);
290 // the media player will notify the service when it's ready preparing, and when it's done playing
291 mPlayer
.setOnPreparedListener(this);
292 mPlayer
.setOnCompletionListener(this);
293 mPlayer
.setOnErrorListener(this);
301 * Processes a request to pause the current playback
303 protected void processPauseRequest() {
304 if (mState
== State
.PLAYING
) {
305 mState
= State
.PAUSED
;
307 releaseResources(false
); // retain media player in pause
308 // TODO polite audio focus, instead of keep it owned; or not?
314 * Processes a request to stop the playback.
316 * @param force When 'true', the playback is stopped no matter the value of mState
318 protected void processStopRequest(boolean force
) {
319 if (mState
!= State
.PREPARING
|| force
) {
320 mState
= State
.STOPPED
;
323 releaseResources(true
);
325 stopSelf(); // service is no longer necessary
331 * Releases resources used by the service for playback. This includes the "foreground service"
332 * status and notification, the wake locks and possibly the MediaPlayer.
334 * @param releaseMediaPlayer Indicates whether the Media Player should also be released or not
336 protected void releaseResources(boolean releaseMediaPlayer
) {
337 // stop being a foreground service
338 stopForeground(true
);
340 // stop and release the Media Player, if it's available
341 if (releaseMediaPlayer
&& mPlayer
!= null
) {
347 // release the Wifi lock, if holding it
348 if (mWifiLock
.isHeld()) {
355 * Fully releases the audio focus.
357 private void giveUpAudioFocus() {
358 if (mAudioFocus
== AudioFocus
.FOCUS
359 && mAudioManager
!= null
360 && AudioManager
.AUDIOFOCUS_REQUEST_GRANTED
== mAudioManager
.abandonAudioFocus(this)) {
362 mAudioFocus
= AudioFocus
.NO_FOCUS
;
368 * Reconfigures MediaPlayer according to audio focus settings and starts/restarts it.
370 protected void configAndStartMediaPlayer() {
371 if (mPlayer
== null
) {
372 throw new IllegalStateException("mPlayer is NULL");
375 if (mAudioFocus
== AudioFocus
.NO_FOCUS
) {
376 if (mPlayer
.isPlaying()) {
377 mPlayer
.pause(); // have to be polite; but mState is not changed, to resume when focus is received again
381 if (mAudioFocus
== AudioFocus
.NO_FOCUS_CAN_DUCK
) {
382 mPlayer
.setVolume(DUCK_VOLUME
, DUCK_VOLUME
);
385 mPlayer
.setVolume(1.0f
, 1.0f
); // full volume
388 if (!mPlayer
.isPlaying()) {
396 * Requests the audio focus to the Audio Manager
398 private void tryToGetAudioFocus() {
399 if (mAudioFocus
!= AudioFocus
.FOCUS
400 && mAudioManager
!= null
401 && (AudioManager
.AUDIOFOCUS_REQUEST_GRANTED
== mAudioManager
.requestAudioFocus( this,
402 AudioManager
.STREAM_MUSIC
,
403 AudioManager
.AUDIOFOCUS_GAIN
))
405 mAudioFocus
= AudioFocus
.FOCUS
;
411 * Starts playing the current media file.
413 protected void playMedia() {
414 mState
= State
.STOPPED
;
415 releaseResources(false
); // release everything except MediaPlayer
419 Toast
.makeText(this, R
.string
.media_err_nothing_to_play
, Toast
.LENGTH_LONG
).show();
420 processStopRequest(true
);
423 } else if (mAccount
== null
) {
424 Toast
.makeText(this, R
.string
.media_err_not_in_owncloud
, Toast
.LENGTH_LONG
).show();
425 processStopRequest(true
);
429 createMediaPlayerIfNeeded();
430 mPlayer
.setAudioStreamType(AudioManager
.STREAM_MUSIC
);
431 String url
= mFile
.getStoragePath();
432 /* Streaming is not possible right now
433 if (url == null || url.length() <= 0) {
434 url = AccountUtils.constructFullURLForAccount(this, mAccount) + mFile.getRemotePath();
436 mIsStreaming = url.startsWith("http:") || url.startsWith("https:");
438 mIsStreaming
= false
;
440 mPlayer
.setDataSource(url
);
442 mState
= State
.PREPARING
;
443 setUpAsForeground(String
.format(getString(R
.string
.media_state_loading
), mFile
.getFileName()));
445 // starts preparing the media player in background
446 mPlayer
.prepareAsync();
448 // prevent the Wifi from going to sleep when streaming
451 } else if (mWifiLock
.isHeld()) {
455 } catch (SecurityException e
) {
456 Log
.e(TAG
, "SecurityException playing " + mAccount
.name
+ mFile
.getRemotePath(), e
);
457 Toast
.makeText(this, String
.format(getString(R
.string
.media_err_security_ex
), mFile
.getFileName()), Toast
.LENGTH_LONG
).show();
458 processStopRequest(true
);
460 } catch (IOException e
) {
461 Log
.e(TAG
, "IOException playing " + mAccount
.name
+ mFile
.getRemotePath(), e
);
462 Toast
.makeText(this, String
.format(getString(R
.string
.media_err_io_ex
), mFile
.getFileName()), Toast
.LENGTH_LONG
).show();
463 processStopRequest(true
);
465 } catch (IllegalStateException e
) {
466 Log
.e(TAG
, "IllegalStateException " + mAccount
.name
+ mFile
.getRemotePath(), e
);
467 Toast
.makeText(this, String
.format(getString(R
.string
.media_err_unexpected
), mFile
.getFileName()), Toast
.LENGTH_LONG
).show();
468 processStopRequest(true
);
470 } catch (IllegalArgumentException e
) {
471 Log
.e(TAG
, "IllegalArgumentException " + mAccount
.name
+ mFile
.getRemotePath(), e
);
472 Toast
.makeText(this, String
.format(getString(R
.string
.media_err_unexpected
), mFile
.getFileName()), Toast
.LENGTH_LONG
).show();
473 processStopRequest(true
);
478 /** Called when media player is done playing current song. */
479 public void onCompletion(MediaPlayer player
) {
480 if (mMediaController
!= null
) {
481 mMediaController
.hide();
483 Toast
.makeText(this, String
.format(getString(R
.string
.media_event_done
, mFile
.getFileName())), Toast
.LENGTH_LONG
).show();
484 processStopRequest(true
);
490 * Called when media player is done preparing.
494 public void onPrepared(MediaPlayer player
) {
495 mState
= State
.PLAYING
;
496 updateNotification(String
.format(getString(R
.string
.media_state_playing
), mFile
.getFileName()));
497 if (mMediaController
!= null
) {
498 mMediaController
.setEnabled(true
);
500 configAndStartMediaPlayer();
501 if (mMediaController
!= null
) {
502 mMediaController
.show(MEDIA_CONTROL_PERMANENT
);
508 * Updates the status notification
510 @SuppressWarnings("deprecation")
511 private void updateNotification(String content
) {
512 // TODO check if updating the Intent is really necessary
513 Intent showDetailsIntent
= new Intent(this, FileDetailActivity
.class);
514 showDetailsIntent
.putExtra(FileDetailFragment
.EXTRA_FILE
, mFile
);
515 showDetailsIntent
.putExtra(FileDetailFragment
.EXTRA_ACCOUNT
, mAccount
);
516 showDetailsIntent
.setFlags(Intent
.FLAG_ACTIVITY_CLEAR_TOP
);
517 mNotification
.contentIntent
= PendingIntent
.getActivity(getApplicationContext(),
518 (int)System
.currentTimeMillis(),
520 PendingIntent
.FLAG_UPDATE_CURRENT
);
521 mNotification
.when
= System
.currentTimeMillis();
522 //mNotification.contentView.setTextViewText(R.id.status_text, content);
523 String ticker
= String
.format(getString(R
.string
.media_notif_ticker
), getString(R
.string
.app_name
));
524 mNotification
.setLatestEventInfo(getApplicationContext(), ticker
, content
, mNotification
.contentIntent
);
525 mNotificationManager
.notify(R
.string
.media_notif_ticker
, mNotification
);
530 * Configures the service as a foreground service.
532 * The system will avoid finishing the service as much as possible when resources as low.
534 * A notification must be created to keep the user aware of the existance of the service.
536 @SuppressWarnings("deprecation")
537 private void setUpAsForeground(String content
) {
538 /// creates status notification
539 // TODO put a progress bar to follow the playback progress
540 mNotification
= new Notification();
541 mNotification
.icon
= android
.R
.drawable
.ic_media_play
;
542 //mNotification.tickerText = text;
543 mNotification
.when
= System
.currentTimeMillis();
544 mNotification
.flags
|= Notification
.FLAG_ONGOING_EVENT
;
545 //mNotification.contentView.setTextViewText(R.id.status_text, "ownCloud Music Player"); // NULL POINTER
546 //mNotification.contentView.setTextViewText(R.id.status_text, getString(R.string.downloader_download_in_progress_content));
549 /// includes a pending intent in the notification showing the details view of the file
550 Intent showDetailsIntent
= new Intent(this, FileDetailActivity
.class);
551 showDetailsIntent
.putExtra(FileDetailFragment
.EXTRA_FILE
, mFile
);
552 showDetailsIntent
.putExtra(FileDetailFragment
.EXTRA_ACCOUNT
, mAccount
);
553 showDetailsIntent
.setFlags(Intent
.FLAG_ACTIVITY_CLEAR_TOP
);
554 mNotification
.contentIntent
= PendingIntent
.getActivity(getApplicationContext(),
555 (int)System
.currentTimeMillis(),
557 PendingIntent
.FLAG_UPDATE_CURRENT
);
560 //mNotificationManager.notify(R.string.downloader_download_in_progress_ticker, mNotification);
561 String ticker
= String
.format(getString(R
.string
.media_notif_ticker
), getString(R
.string
.app_name
));
562 mNotification
.setLatestEventInfo(getApplicationContext(), ticker
, content
, mNotification
.contentIntent
);
563 startForeground(R
.string
.media_notif_ticker
, mNotification
);
568 * Called when there's an error playing media.
570 * Warns the user about the error and resets the media player.
572 public boolean onError(MediaPlayer mp
, int what
, int extra
) {
573 Log
.e(TAG
, "Error in audio playback, what = " + what
+ ", extra = " + extra
);
575 if (mMediaController
!= null
) {
576 mMediaController
.hide();
579 String message
= getMessageForMediaError(this, what
, extra
);
580 Toast
.makeText(getApplicationContext(), message
, Toast
.LENGTH_SHORT
).show();
582 processStopRequest(true
);
587 * Called by the system when another app tries to play some sound.
592 public void onAudioFocusChange(int focusChange
) {
593 if (focusChange
> 0) {
594 // focus gain; check AudioManager.AUDIOFOCUS_* values
595 mAudioFocus
= AudioFocus
.FOCUS
;
596 // restart media player with new focus settings
597 if (mState
== State
.PLAYING
)
598 configAndStartMediaPlayer();
600 } else if (focusChange
< 0) {
601 // focus loss; check AudioManager.AUDIOFOCUS_* values
602 boolean canDuck
= AudioManager
.AUDIOFOCUS_LOSS_TRANSIENT_CAN_DUCK
== focusChange
;
603 mAudioFocus
= canDuck ? AudioFocus
.NO_FOCUS_CAN_DUCK
: AudioFocus
.NO_FOCUS
;
604 // start/restart/pause media player with new focus settings
605 if (mPlayer
!= null
&& mPlayer
.isPlaying())
606 configAndStartMediaPlayer();
612 * Called when the service is finished for final clean-up.
617 public void onDestroy() {
618 mState
= State
.STOPPED
;
619 releaseResources(true
);
625 * Provides a binder object that clients can use to perform operations on the MediaPlayer managed by the MediaService.
628 public IBinder
onBind(Intent arg
) {
634 * Called when ALL the bound clients were onbound.
636 * The service is destroyed if playback stopped or paused
639 public boolean onUnbind(Intent intent
) {
640 if (mState
== State
.PAUSED
|| mState
== State
.STOPPED
) {
641 processStopRequest(false
);
643 return false
; // not accepting rebinding (default behaviour)
648 * Accesses the current MediaPlayer instance in the service.
650 * To be handled carefully. Visibility is protected to be accessed only
652 * @return Current MediaPlayer instance handled by MediaService.
654 protected MediaPlayer
getPlayer() {
660 * Accesses the current OCFile loaded in the service.
662 * @return The current OCFile loaded in the service.
664 protected OCFile
getCurrentFile() {
670 * Accesses the current {@link State} of the MediaService.
672 * @return The current {@link State} of the MediaService.
674 protected State
getState() {
679 protected void setMediaContoller(MediaController mediaController
) {
680 if (mMediaController
!= null
) {
681 mMediaController
.hide();
683 mMediaController
= mediaController
;
687 protected MediaController
getMediaController() {
688 return mMediaController
;