sbTranscodeProgressListener.h

Go to the documentation of this file.

/* vim: set sw=2 :miv */
/*
//
// BEGIN SONGBIRD GPL
//
// This file is part of the Songbird web player.
//
// Copyright(c) 2005-2009 POTI, Inc.
// http://songbirdnest.com
//
// This file may be licensed under the terms of of the
// GNU General Public License Version 2 (the "GPL").
//
// Software distributed under the License is distributed
// on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either
// express or implied. See the GPL for the specific language
// governing rights and limitations.
//
// You should have received a copy of the GPL along with this
// program. If not, go to http://www.gnu.org/licenses/gpl.html
// or write to the Free Software Foundation, Inc.,
// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
//
// END SONGBIRD GPL
//
*/

#ifndef sbTranscodeProgressListener_H_
#define sbTranscodeProgressListener_H_

// Songbird includes
#include "sbBaseDevice.h"
#include <sbIJobProgress.h>
#include <sbIMediacoreEventListener.h>
// Forward class declarations

class sbIJobCancelable;
class sbDeviceStatusAutoOperationComplete;
class sbDeviceStatusHelper;
class sbStatusPropertyValue;

class sbTranscodeProgressListener : public sbIJobProgressListener,
                                    public sbIMediacoreEventListener
{
public:
  NS_DECL_ISUPPORTS
  NS_DECL_SBIJOBPROGRESSLISTENER
  NS_DECL_SBIMEDIACOREEVENTLISTENER

  class StatusProperty
  {
  public:
    StatusProperty(sbIMediaItem * aSourceItem = nsnull,
                   nsAString const & aPropertyName = nsString()) :
      mSourceItem(aSourceItem),
      mPropertyName(aPropertyName)
    {
    }
    nsresult SetValue(nsAString const & aValue)
    {
      if (!mPropertyName.IsEmpty() && mSourceItem) {
        nsresult rv = mSourceItem->SetProperty(mPropertyName, aValue);
        NS_ENSURE_SUCCESS(rv, rv);
      }
      return NS_OK;
    }
  private:
    nsCOMPtr<sbIMediaItem> mSourceItem;
    nsString mPropertyName;
  };
  static sbTranscodeProgressListener *
  New(sbBaseDevice * aDeviceBase,
      sbDeviceStatusHelper * aDeviceStatusHelper,
      sbIMediaItem *aItem,
      PRMonitor * aCompleteNotifyMonitor = nsnull,
      StatusProperty const & aStatusProperty = StatusProperty(),
      sbIJobCancelable * aCancel = nsnull);

  PRBool IsComplete() const { return mIsComplete; };
  PRBool IsAborted() const { return mAborted; }
private:
  inline
  sbTranscodeProgressListener(sbBaseDevice * aDeviceBase,
                              sbDeviceStatusHelper * aDeviceStatusHelper,
                              sbIMediaItem *aItem,
                              PRMonitor * aCompleteNotifyMonitor,
                              StatusProperty const & aStatusProperty,
                              sbIJobCancelable * aCancel);

  ~sbTranscodeProgressListener();
  nsresult Completed(sbIJobProgress * aJobProgress);

  nsresult SetProgress(sbIJobProgress * aJobProgress);

  inline
  nsresult SetStatusProperty(sbStatusPropertyValue const & aValue);

  // Raw manually ref counted pointer because nsISupports is ambiguous
  sbBaseDevice * mBaseDevice;

  // Non-owning reference, reference to mBaseDevice will keep this alive
  sbDeviceStatusHelper * mStatus;

  nsCOMPtr<sbIMediaItem> mItem;
  PRMonitor *mCompleteNotifyMonitor;
  PRInt32 mIsComplete;
  PRUint32 mTotal;
  StatusProperty mStatusProperty;
  nsCOMPtr<sbIJobCancelable> mCancel;
  PRBool mAborted;
};


#endif /* sbTranscodeProgressListener_H_ */