content/media/video/public/nsChannelReader.h

   1 /* vim:set ts=2 sw=2 sts=2 et cindent: */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is Mozilla code.
  16  *
  17  * The Initial Developer of the Original Code is the Mozilla Corporation.
  18  * Portions created by the Initial Developer are Copyright (C) 2007
  19  * the Initial Developer. All Rights Reserved.
  20  *
  21  * Contributor(s):
  22  *  Chris Double <chris.double@double.co.nz>
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either the GNU General Public License Version 2 or later (the "GPL"), or
  26  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37 #if !defined(nsChannelReader_h_)
  38 #define nsChannelReader_h_
  39
  40 #include "nsAutoPtr.h"
  41 #include "nsMediaStream.h"
  42 #include "nsMediaDecoder.h"
  43 #include "nsIPrincipal.h"
  44
  45 #include "oggplay/oggplay.h"
  46
  47 class nsIChannel;
  48 class nsIStreamListener;
  49
  50 class nsChannelReader : public OggPlayReader
  51 {
  52 public:
  53   nsChannelReader();
  54   ~nsChannelReader();
  55
  56   /**
  57    * Initialize the reader with the given decoder, URI, and
  58    * optional channel.
  59    * @param aChannel may be null
  60    * @param aStreamListener if aChannel is non-null, this will return
  61    * a stream listener which should be attached to the channel.
  62    */
  63   nsresult Init(nsMediaDecoder* aDecoder, nsIURI* aURI, nsIChannel* aChannel,
  64                 nsIStreamListener** aStreamListener);
  65
  66   // Cancel any blocking request currently in progress and cause that
  67   // request to return an error. Call on main thread only.
  68   void Cancel();
  69
  70   // Return the number of bytes buffered from the file. This can safely
  71   // be read without blocking.
  72   PRUint32 Available();
  73
  74   // Return average number of bytes per second that the
  75   // download of the media resource is achieving.
  76   float DownloadRate();
  77
  78   // Return average number of bytes per second that the
  79   // playback of the media resource is achieving.
  80   float PlaybackRate();
  81
  82   nsIPrincipal* GetCurrentPrincipal();
  83
  84   // Implementation of OggPlay Reader API.
  85   OggPlayErrorCode initialise(int aBlock);
  86   OggPlayErrorCode destroy();
  87   size_t io_read(char* aBuffer, size_t aCount);
  88   int io_seek(long aOffset, int aWhence);
  89   long io_tell();
  90
  91 public:
  92   nsMediaStream mStream;
  93   unsigned long mCurrentPosition;
  94 };
  95
  96 #endif