sbBaseMediaItemDownloadJob.h

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set sw=2 :miv */
/*
 *=BEGIN SONGBIRD GPL
 *
 * This file is part of the Songbird web player.
 *
 * Copyright(c) 2005-2010 POTI, Inc.
 * http://www.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 SB_BASE_MEDIA_ITEM_DOWNLOAD_JOB_H_
#define SB_BASE_MEDIA_ITEM_DOWNLOAD_JOB_H_

//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
//
// Base media item download job defs.
//
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------

//------------------------------------------------------------------------------
//
// Base media item download job imported services.
//
//------------------------------------------------------------------------------

// Songbird imports.
#include <sbIFileDownloader.h>
#include <sbIJobProgress.h>
#include <sbIJobCancelable.h>
#include <sbILibrary.h>
#include <sbIMediaItem.h>
#include <sbIMediaItemDownloadJob.h>
#include <sbIPropertyArray.h>
#include <sbITemporaryFileFactory.h>

// Mozilla imports.
#include <nsCOMPtr.h>
#include <nsTArray.h>


//------------------------------------------------------------------------------
//
// Base media item download job classes.
//
//------------------------------------------------------------------------------

// Class declarations.
class nsIURI;

class sbBaseMediaItemDownloadJob : public sbIMediaItemDownloadJob,
                                   public sbIJobCancelable,
                                   public sbIFileDownloaderListener
{
  //----------------------------------------------------------------------------
  //
  // Public interface.
  //
  //----------------------------------------------------------------------------

public:

  //
  // XPCOM interfaces.
  //

  NS_DECL_ISUPPORTS
  NS_DECL_SBIMEDIAITEMDOWNLOADJOB
  NS_DECL_SBIJOBPROGRESS
  NS_DECL_SBIJOBCANCELABLE
  NS_DECL_SBIFILEDOWNLOADERLISTENER


  //
  // Public Base media item download job services.
  //

  virtual ~sbBaseMediaItemDownloadJob();


  //----------------------------------------------------------------------------
  //
  // Protected interface.
  //
  //----------------------------------------------------------------------------

protected:

  //
  // mLock                      Lock used for thread support.
  // mMediaItem                 Media item to download.
  // mProperties                Downloaded media item properties array.
  // mTargetLibrary             Library for which the media item will be
  //                            downloaded.
  // mFileDownloader            File downloader object.
  // mTemporaryFileFactory      Temporary file factory to use for temporary
  //                            files.
  // mListenerList              List of download job listeners.
  // mStatus                    Download status.
  //

  PRLock*                       mLock;
  nsCOMPtr<sbIMediaItem>        mMediaItem;
  nsCOMPtr<sbIMutablePropertyArray>
                                mProperties;
  nsCOMPtr<sbILibrary>          mTargetLibrary;
  nsCOMPtr<sbIFileDownloader>   mFileDownloader;
  nsCOMPtr<sbITemporaryFileFactory>
                                mTemporaryFileFactory;
  nsTArray< nsCOMPtr<sbIJobProgressListener> >
                                mListenerList;
  PRUint16                      mStatus;


  virtual nsresult Start(nsIURI* aURI);

  virtual nsresult Stop();

  virtual nsresult GetDownloadURI(nsIURI** aURI);

  virtual nsresult Initialize();

  sbBaseMediaItemDownloadJob(sbIMediaItem* aMediaItem,
                             sbILibrary*   aTargetLibrary = nsnull);
};


#endif // SB_BASE_MEDIA_ITEM_DOWNLOAD_JOB_H_