Error messages for video playback reviewed

res/values/strings.xml

@@ -146,6 +146,7 @@
     <string name="media_state_loading">"%1$s (loading)"</string>
     <string name="media_event_done">"%1$s playback finished"</string>
     <string name="media_err_nothing_to_play">No media file found</string>
+	<string name="media_err_no_account">No account provided</string>
     <string name="media_err_not_in_owncloud">File not in a valid account</string>
     
     <string-array name="prefs_trackmydevice_intervall_keys">

src/com/owncloud/android/ui/activity/VideoActivity.java

@@ -1,61 +1,263 @@
+/* ownCloud Android client application
+ *   Copyright (C) 2012-2013 ownCloud Inc.
+ *
+ *   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 of the License, 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 this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
 package com.owncloud.android.ui.activity;
 
+import android.accounts.Account;
 import android.app.Activity;
+import android.app.AlertDialog;
+import android.content.DialogInterface;
+import android.content.Intent;
 import android.media.MediaPlayer;
 import android.media.MediaPlayer.OnCompletionListener;
+import android.media.MediaPlayer.OnErrorListener;
 import android.media.MediaPlayer.OnPreparedListener;
+import android.net.Uri;
 import android.os.Bundle;
+import android.util.Log;
 import android.view.MotionEvent;
+import android.widget.MediaController;
 import android.widget.VideoView;
 
+import com.owncloud.android.AccountUtils;
 import com.owncloud.android.R;
+import com.owncloud.android.datamodel.OCFile;
 
-public class VideoActivity extends Activity implements OnCompletionListener, OnPreparedListener {
+/**
+ *  Activity implementing a basic video player.
+ * 
+ *  Used as an utility to preview video files contained in an ownCloud account.
+ *  
+ *  Currently, it always plays in landscape mode, full screen. When the playback ends,
+ *  the activity is finished. 
+ *  
+ *  @author David A. Velasco
+ */
+public class VideoActivity extends Activity implements OnCompletionListener, OnPreparedListener, OnErrorListener {
 
-   public static final String EXTRA_PATH = "PATH";
+    /** Key to receive an {@link OCFile} to play as an extra value in an {@link Intent} */
+    public static final String EXTRA_FILE = "FILE";
+    /** Key to receive the ownCloud {@link Account} where the file to play is saved as an extra value in an {@link Intent} */
+    public static final String EXTRA_ACCOUNT = "ACCOUNT";
     
-   private VideoView mVideoPlayer;
+    // Time To keep the control panel visible when the user does not use it
-   private String mPathToFile;
+    private static final int MEDIA_CONTOL_LIFE = 5000;
     
-   /** Called when the activity is first created. */
+    private static final int OC_MEDIA_ERROR = 0;
+    private static final String TAG = null;
+
+    private OCFile mFile;                       // video file to play
+    private Account mAccount;                   // ownCloud account holding mFile
+    private VideoView mVideoPlayer;             // view to play the file; both performs and show the playback
+    private MediaController mMediaController;   // panel control used by the user to control the playback
+          
+    /** 
+     *  Called when the activity is first created.
+     *  
+     *  Searches for an {@link OCFile} and ownCloud {@link Account} holding it in the starting {@link Intent}.
+     *  
+     *  The {@link Account} is unnecessary if the file is downloaded; else, the {@link Account} is used to 
+     *  try to stream the remote file - TODO get the streaming works
+     * 
+     *  {@inheritDoc}
+     */
     @Override
     public void onCreate(Bundle savedInstanceState) {
         super.onCreate(savedInstanceState);
+        
         setContentView(R.layout.video_layout);
     
-      mPathToFile = getIntent().getExtras().getString(EXTRA_PATH);
+        mFile = getIntent().getExtras().getParcelable(EXTRA_FILE);
+        mAccount = getIntent().getExtras().getParcelable(EXTRA_ACCOUNT);
           
         mVideoPlayer = (VideoView) findViewById(R.id.videoPlayer);
+
+        // set listeners to get more contol on the playback
         mVideoPlayer.setOnPreparedListener(this);
         mVideoPlayer.setOnCompletionListener(this);
+        mVideoPlayer.setOnErrorListener(this);
+          
+        // keep the screen on while the playback is performed (prevents screen off by battery save)
         mVideoPlayer.setKeepScreenOn(true);
-      mVideoPlayer.setVideoPath(mPathToFile);
+        
+        if (mFile != null) {
+            if (mFile.isDown()) {
+                mVideoPlayer.setVideoPath(mFile.getStoragePath());
+                
+            } else if (mAccount != null) {
+                String url = AccountUtils.constructFullURLForAccount(this, mAccount) + mFile.getRemotePath();
+                mVideoPlayer.setVideoURI(Uri.parse(url));
+                
+            } else {
+                onError(null, OC_MEDIA_ERROR, R.string.media_err_no_account);
             }
             
-   /** This callback will be invoked when the file is ready to play */
+            // create and prepare control panel for the user
+            mMediaController = new MediaController(this);
+            mMediaController.setMediaPlayer(mVideoPlayer);
+            mMediaController.setAnchorView(mVideoPlayer);
+            mVideoPlayer.setMediaController(mMediaController);
+            
+        } else {
+            onError(null, OC_MEDIA_ERROR, R.string.media_err_nothing_to_play);
+        }
+    }    
+    
+    
+    /** 
+     * Called when the file is ready to be played.
+     * 
+     * Just starts the playback.
+     * 
+     * @param   mp    {@link MediaPlayer} instance performing the playback.
+     */
     @Override
     public void onPrepared(MediaPlayer vp) {
-      mVideoPlayer.start();
+        mVideoPlayer.start();   // TODO maybe unnecessary
+        //mMediaController.show(5000);  // TODO maybe unnecessary; maybe not, it's up when the Surface notifies the VideoView about creation
     }
     
-   /** This callback will be invoked when the file is finished playing */
+    
+    /**
+     * Called when the file is finished playing.
+     *  
+     * Finishes the activity.
+     * 
+     * @param   mp    {@link MediaPlayer} instance performing the playback.
+     */
     @Override
     public void onCompletion(MediaPlayer  mp) {
         this.finish(); 
     }
     
-   /**  Use screen touches to toggle the video between playing and paused. */
+    
+    /**
+     * Called when an error in playback occurs.
+     * 
+     * @param   mp      {@link MediaPlayer} instance performing the playback.
+     * @param   what    Type of error
+     * @param   extra   Extra code specific to the error
+     */
+    @Override
+    public boolean onError(MediaPlayer mp, int what, int extra) {
+        Log.e(TAG, "Error in video playback, what = " + what + ", extra = " + extra);
+        
+        if (mMediaController != null) {
+            mMediaController.hide();
+        }
+        
+        if (mVideoPlayer.getWindowToken() != null) {
+            int messageId;
+            if (what == OC_MEDIA_ERROR) {
+                messageId = extra;
+                
+            } else if (what == MediaPlayer.MEDIA_ERROR_NOT_VALID_FOR_PROGRESSIVE_PLAYBACK) {
+                messageId = android.R.string.VideoView_error_text_invalid_progressive_playback;
+                
+            } else {
+                // what == MediaPlayer.MEDIA_ERROR_UNKNOWN or MEDIA_ERROR_SERVER_DIED
+                messageId = android.R.string.VideoView_error_text_unknown;
+                
+            }
+            new AlertDialog.Builder(this)
+                    .setMessage(messageId)
+                    .setPositiveButton(android.R.string.VideoView_error_button,
+                            new DialogInterface.OnClickListener() {
+                                public void onClick(DialogInterface dialog, int whichButton) {
+                                    VideoActivity.this.onCompletion(null);
+                                }
+                            })
+                    .setCancelable(false)
+                    .show();
+        }
+        
+
+        /*
+        switch (what) {
+            case MediaPlayer.MEDIA_ERROR_UNKNOWN:
+                /*Added in API level 1
+                Unspecified media player error.
+                Constant Value: 1 (0x00000001)
+                *-/
+                break;
+                
+            case MediaPlayer.MEDIA_ERROR_SERVER_DIED:
+                /* Added in API level 1
+                Media server died. In this case, the application must release the MediaPlayer object and instantiate a new one.
+                Constant Value: 100 (0x00000064) *-/
+                break;
+            
+            case MediaPlayer.MEDIA_ERROR_NOT_VALID_FOR_PROGRESSIVE_PLAYBACK:
+                /* Added in API level 3
+                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.
+                See Also
+                MediaPlayer.OnErrorListener
+                Constant Value: 200 (0x000000c8)
+                *-/
+                break;
+
+            /// under this, seems they are values for  extra
+            case MediaPlayer.MEDIA_ERROR_UNSUPPORTED:
+                /* Added in API level 17
+                    Bitstream is conforming to the related coding standard or file spec, but the media framework does not support the feature.
+                    Constant Value: -1010 (0xfffffc0e)
+                 *-/
+                break;
+        
+            case MediaPlayer.MEDIA_ERROR_IO:
+                /* Added in API level 17
+                File or network related operation errors.
+                Constant Value: -1004 (0xfffffc14) *-/
+                break;
+
+            case MediaPlayer.MEDIA_ERROR_MALFORMED:
+                /* Added in API level 17
+                Bitstream is not conforming to the related coding standard or file spec.
+                Constant Value: -1007 (0xfffffc11) *-/
+                break;
+                
+            case MediaPlayer.MEDIA_ERROR_TIMED_OUT:
+                /*Added in API level 17
+                Some operation takes too long to complete, usually more than 3-5 seconds.
+                Constant Value: -110 (0xffffff92)
+                *-/
+                break;
+        }
+                */
+        
+        return true;
+    }
+    
+    
+    /**  
+     * Screen touches trigger the appearance of the control panel for a limited time.
+     *
+     * {@inheritDoc}
+     */
     @Override
     public boolean onTouchEvent (MotionEvent ev){ 
         if (ev.getAction() == MotionEvent.ACTION_DOWN) {
-         if(mVideoPlayer.isPlaying()){
+            mMediaController.show(MEDIA_CONTOL_LIFE);
-                  mVideoPlayer.pause();
-         } else {
-                  mVideoPlayer.start();
-         }
             return true;        
         } else {
             return false;
         }
     }
+
+
 }

src/com/owncloud/android/ui/fragment/FileDetailFragment.java

@@ -421,7 +421,7 @@ public class FileDetailFragment extends SherlockFragment implements
     
     @Override
     public boolean onTouch(View v, MotionEvent event) {
-        if (v == mPreview && event.getAction() == MotionEvent.ACTION_DOWN && mFile != null && mFile.isDown()) {
+        if (v == mPreview && event.getAction() == MotionEvent.ACTION_DOWN && mFile != null) {
             if (mFile.isAudio()) {
                 if (!mMediaServiceBinder.isPlaying(mFile)) {
                     Log.d(TAG, "starting playback of " + mFile.getStoragePath());
@@ -447,7 +447,8 @@ public class FileDetailFragment extends SherlockFragment implements
     
     private void startVideoActivity() {
         Intent i = new Intent(getActivity(), VideoActivity.class);
-        i.putExtra(VideoActivity.EXTRA_PATH, mFile.getStoragePath());
+        i.putExtra(VideoActivity.EXTRA_FILE, mFile);
+        i.putExtra(VideoActivity.EXTRA_ACCOUNT, mAccount);
         startActivity(i);
         
         // TODO THROW AN ACTIVTIY JUST FOR PREVIEW VIDEO
@@ -480,6 +481,7 @@ public class FileDetailFragment extends SherlockFragment implements
                                     MediaService.class),
                                     mMediaServiceConnection, 
                                     Context.BIND_AUTO_CREATE);
+            // follow the flow in MediaServiceConnection#onServiceConnected(...)
     }
     
     /** Defines callbacks for service binding, passed to bindService() */