content/media/video/public/nsChannelToPipeListener.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(nsChannelToPipeListener_h_)
  38 #define nsChannelToPipeListener_h_
  39
  40 #include "nsCOMPtr.h"
  41 #include "nsIInputStream.h"
  42 #include "nsIOutputStream.h"
  43 #include "nsIRequestObserver.h"
  44 #include "nsIStreamListener.h"
  45 #include "nsIPrincipal.h"
  46
  47 // Constant for download and playback rates that are unknown, or otherwise
  48 // unable to be computed.
  49 #define NS_MEDIA_UNKNOWN_RATE -1.0
  50
  51 class nsMediaDecoder;
  52
  53 /*
  54    Reads all data on the input stream of a channel and
  55    writes it to a pipe. This allows a seperate thread to
  56    read data from a channel running on the main thread
  57 */
  58 class nsChannelToPipeListener : public nsIStreamListener
  59 {
  60   // ISupports
  61   NS_DECL_ISUPPORTS
  62
  63   // IRequestObserver
  64   NS_DECL_NSIREQUESTOBSERVER
  65
  66   // IStreamListener
  67   NS_DECL_NSISTREAMLISTENER
  68
  69   public:
  70   // If aSeeking is PR_TRUE then this listener was created as part of a
  71   // seek request and is expecting a byte range partial result.
  72   nsChannelToPipeListener(nsMediaDecoder* aDecoder, PRBool aSeeking = PR_FALSE);
  73   nsresult Init();
  74   nsresult GetInputStream(nsIInputStream** aStream);
  75   void Stop();
  76   void Cancel();
  77
  78   // Return the download rate in bytes per second. Returns
  79   // less than zero if the download has complated.
  80   double BytesPerSecond() const;
  81
  82   nsIPrincipal* GetCurrentPrincipal();
  83
  84 private:
  85   nsCOMPtr<nsIInputStream> mInput;
  86   nsCOMPtr<nsIOutputStream> mOutput;
  87   nsCOMPtr<nsIPrincipal> mPrincipal;
  88   nsRefPtr<nsMediaDecoder> mDecoder;
  89
  90   // Interval when download started. Used in
  91   // computing bytes per second download rate.
  92   PRIntervalTime mIntervalStart;
  93
  94   // Interval when last downloaded bytes occurred. Used in computer
  95   // bytes per second download rate.
  96   PRIntervalTime mIntervalEnd;
  97
  98   // Total bytes transferred so far
  99   PRInt64 mTotalBytes;
 100
 101   // PR_TRUE if this listener is expecting a byte range request result
 102   PRPackedBool mSeeking;
 103 };
 104
 105 #endif