sbPlayQueueService.h

Go to the documentation of this file.

/*
 *=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_PLAYQUEUESERVICE_H__
#define __SB_PLAYQUEUESERVICE_H__

#include <nsAutoPtr.h>
#include <nsCOMPtr.h>
#include <nsTArray.h>
#include <nsIObserver.h>
#include <nsIGenericFactory.h>
#include <nsIWeakReference.h>
#include <nsTHashtable.h>
#include <nsHashKeys.h>

#include <sbILibrary.h>
#include <sbILocalDatabaseLibraryCopyListener.h>
#include <sbIMediacoreEvent.h>
#include <sbIMediacoreEventListener.h>
#include <sbIMediacoreManager.h>
#include <sbIMediaListListener.h>
#include <sbIPlayQueueService.h>
#include <sbLibraryUtils.h>

#include "sbPlayQueueLibraryListener.h"
#include "sbPlayQueueExternalLibraryListener.h"

class nsIStringBundle;
class sbIMediaItem;
class sbIMediaList;
class sbIDataRemote;
class sbPlayQueueAsyncListener;

class sbPlayQueueService : public sbIPlayQueueService,
                           public sbIMediaListListener,
                           public sbIMediacoreEventListener,
                           public sbILocalDatabaseLibraryCopyListener,
                           public nsIObserver
{
  friend class sbPlayQueueAsyncListener;

public:
  NS_DECL_ISUPPORTS
  NS_DECL_SBIPLAYQUEUESERVICE
  NS_DECL_SBIMEDIALISTLISTENER
  NS_DECL_SBIMEDIACOREEVENTLISTENER
  NS_DECL_SBILOCALDATABASELIBRARYCOPYLISTENER
  NS_DECL_NSIOBSERVER

  sbPlayQueueService();
  virtual ~sbPlayQueueService();

  static NS_METHOD RegisterSelf(nsIComponentManager* aCompMgr,
                                nsIFile* aPath,
                                const char* aLoaderStr,
                                const char* aType,
                                const nsModuleComponentInfo* aInfo);

  nsresult Init();

  void SetIgnoreListListener(PRBool aIgnore) {
    mIgnoreListListener = aIgnore;
  }

private:

  void Finalize();

  nsCOMPtr<sbIMediaList> mMediaList;

  nsCOMPtr<sbILibrary> mLibrary;

  PRUint32 mIndex;

  PRBool mInitialized;

  PRBool mExplicitStop;

  PRUint32 mBatchRemovalIndex;

  PRBool mBatchBeginAllHistory;

  PRBool mIgnoreListListener;

  PRBool mSequencerOnQueue;

  PRBool mSequencerPlayingOrPaused;

  PRBool mOperationInProgress;

  sbLibraryBatchHelper mBatchHelper;

  nsTArray<nsString> mRemovedItemGUIDs;

  nsRefPtr<sbPlayQueueLibraryListener> mLibraryListener;

  nsCOMPtr<nsIWeakReference> mWeakMediacoreManager;

  nsresult QueueNextInternal(sbIMediaItem* aMediaItem,
                             PRUint32      aInsertBeforeIndex);

  nsresult QueueNextInternal(sbIMediaList* aMediaList,
                             PRUint32      aInsertBeforeIndex);

  nsresult QueueLastInternal(sbIMediaItem* aMediaItem);

  nsresult QueueLastInternal(sbIMediaList* aMediaList);

  nsresult RefreshIndexFromView();

  nsresult CreateMediaList();

  nsresult InitLibrary();

  nsresult InitMediaList();

  nsresult SetIndexToPlayingTrack();

  nsresult OnViewChange(sbIMediacoreEvent* aEvent);

  nsresult OnTrackChange(sbIMediacoreEvent* aEvent);

  nsresult OnTrackIndexChange(sbIMediacoreEvent* aEvent);

  nsTHashtable<nsISupportsHashKey> mListeners;

  nsresult NotifyQueueOperationStarted();

  nsresult NotifyQueueOperationCompleted();

  static PLDHashOperator PR_CALLBACK
    OnIndexUpdatedCallback(nsISupportsHashKey* aKey,
                           void* aUserData);

  static PLDHashOperator PR_CALLBACK
    OnQueueStartedCallback(nsISupportsHashKey* aKey,
                           void* aUserData);

  static PLDHashOperator PR_CALLBACK
    OnQueueCompletedCallback(nsISupportsHashKey* aKey,
                             void* aUserData);

  nsRefPtr<sbPlayQueueExternalLibraryListener> mExternalListener;

  nsRefPtr<sbPlayQueueAsyncListener> mAsyncListener;
};

class sbPlayQueueAsyncListener : public sbIAddMediaItemsListener,
                                 public sbIMediaListAsyncListener
{
public:
  NS_DECL_ISUPPORTS
  NS_DECL_SBIADDMEDIAITEMSLISTENER

  sbPlayQueueAsyncListener(sbPlayQueueService *aService);
  virtual ~sbPlayQueueAsyncListener();

  nsresult Init();

private:
  void Finalize();

  sbPlayQueueService*       mService;

  nsCOMPtr<nsIStringBundle> mBundle;

  nsCOMPtr<sbIDataRemote>   mDataRemote;

  nsString                  mQueueName;
};

#define SB_PLAYQUEUESERVICE_CONTRACTID                                         \
  "@songbirdnest.com/Songbird/playqueue/service;1"
#define SB_PLAYQUEUESERVICE_CLASSNAME                                          \
  "Songbird Play Queue Service"
#define SB_PLAYQUEUESERVICE_CID                                                \
  { 0xe6407d63, 0x33d2, 0x402e,                                                \
    { 0xa1, 0x66, 0x3d, 0x6b, 0xc7, 0x85, 0xa4, 0x8e } }

#endif /* __SB_PLAYQUEUESERVICE_H__ */