sbAlbumArtFetcherSet.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_ALBUMARTFETCHERSET_H__
#define __SB_ALBUMARTFETCHERSET_H__

//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
//
// Songbird album art fetcher set.
//
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------

//------------------------------------------------------------------------------
//
// Songbird album art fetcher set imported services.
//
//------------------------------------------------------------------------------

// Songbird imports.
#include <sbIAlbumArtFetcherSet.h>
#include <sbIAlbumArtService.h>
#include <sbIAlbumArtListener.h>
#include <sbIMediaItem.h>

// Mozilla imports.
#include <nsCOMPtr.h>
#include <nsIConsoleService.h>
#include <nsIArray.h>
#include <nsIMutableArray.h>
#include <nsIThreadManager.h>
#include <nsITimer.h>


//------------------------------------------------------------------------------
//
// Songbird album art fetcher set defs.
//
//------------------------------------------------------------------------------

//
// Songbird album art fetcher set component defs.
//

#define SB_ALBUMARTFETCHERSET_CLASSNAME "sbAlbumArtFetcherSet"
#define SB_ALBUMARTFETCHERSET_CID                                              \
  /* {5da41a79-0ed6-4876-bbd7-348a447c784f} */                                 \
  {                                                                            \
    0x5da41a79,                                                                \
    0x0ed6,                                                                    \
    0x4876,                                                                    \
    { 0xbb, 0xd7, 0x34, 0x8a, 0x44, 0x7c, 0x78, 0x4f }                         \
  }

// Default values for the timers (milliseconds)
#define ALBUMART_SCANNER_TIMEOUT  10000

// Preference keys
#define PREF_ALBUMART_SCANNER_BRANCH    "songbird.albumart.scanner."
#define PREF_ALBUMART_SCANNER_TIMEOUT   "timeout"

//------------------------------------------------------------------------------
//
// Songbird album art fetcher set classes.
//
//------------------------------------------------------------------------------

class sbAlbumArtFetcherSet : public sbIAlbumArtFetcherSet,
                             public nsITimerCallback,
                             public sbIAlbumArtListener
{
  //----------------------------------------------------------------------------
  //
  // Public interface.
  //
  //----------------------------------------------------------------------------

public:

  //
  // Inherited interfaces.
  //

  NS_DECL_ISUPPORTS
  NS_DECL_SBIALBUMARTFETCHER
  NS_DECL_SBIALBUMARTFETCHERSET
  NS_DECL_NSITIMERCALLBACK
  NS_DECL_SBIALBUMARTLISTENER


  //
  // Public services.
  //

  sbAlbumArtFetcherSet();

  virtual ~sbAlbumArtFetcherSet();

  nsresult Initialize();


  //----------------------------------------------------------------------------
  //
  // Private interface.
  //
  //----------------------------------------------------------------------------

private:

  //
  // mAlbumArtService           Album art service.
  // mThreadManager             Thread manager.
  // mConsoleService            Console service for warning messages.
  // mAlbumArtSourceList        List of album art sources.
  // mType                      sbIAlbumArtFetcherSet.TYPE_[LOCAL|REMOTE|ALL]
  // mShutdown                  Flag to indicate if we should shutdown.
  // mIsFetching                True if currently fetching.
  //

  nsCOMPtr<sbIAlbumArtService>  mAlbumArtService;
  nsCOMPtr<nsIThreadManager>    mThreadManager;
  nsCOMPtr<nsIConsoleService>   mConsoleService;
  nsCOMPtr<nsIArray>            mAlbumArtSourceList;
  PRUint32                      mType;
  PRBool                        mShutdown;
  PRBool                        mIsFetching;

  //
  // mListener                  Listener for the fetching.
  //

  nsCOMPtr<sbIAlbumArtListener> mListener;

  //
  // mFetcherList               List of fetchers to check.
  // mFetcherIndex              Index of current fetcher we are checking.
  // mFetcher                   Current Fetcher we are using.
  // mMediaItems                List of items we are scanning.
  //

  nsCOMPtr<nsIArray>            mFetcherList;
  PRUint32                      mFetcherIndex;
  nsCOMPtr<sbIAlbumArtFetcher>  mFetcher;
  nsCOMPtr<nsIArray>            mMediaItems;

  //
  // mTimeoutTimer              Time out timer for fetch opertaions
  // mTimeoutTimerValue         Max time a fetch operation is allowed.
  //
  nsCOMPtr<nsITimer>            mTimeoutTimer;
  PRInt32                       mTimeoutTimerValue;

  //
  // mFoundAllArtwork           Flag to determine if we have found all artwork
  //                            for the items requested.
  //

  PRBool                        mFoundAllArtwork;

  //
  // Internal services.
  //

  nsresult CheckLocalImage(nsIURI*    aImageLocation);

  nsresult TryNextFetcher();

  nsresult NextFetcher();
};


#endif // __SB_ALBUMARTFETCHERSET_H__