sbFileMetadataService.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 SBFILEMETADATASERVICE_H__
#define SBFILEMETADATASERVICE_H__

// INCLUDES ===================================================================
#include <nscore.h>
#include <prlock.h>
#include <nsStringGlue.h>
#include <nsITimer.h>
#include <nsCOMPtr.h>
#include <nsIObserver.h>
#include <nsIStringBundle.h>
#include <nsTArray.h>
#include <nsAutoPtr.h>

#include <sbIDataRemote.h>
#include <sbIMediacoreManager.h>

#include "sbIFileMetadataService.h"
#include "sbPIFileMetadataService.h"
#include "sbMetadataJob.h"


// DEFINES ====================================================================
#define SONGBIRD_FILEMETADATASERVICE_CONTRACTID \
"@songbirdnest.com/Songbird/FileMetadataService;1"

#define SONGBIRD_FILEMETADATASERVICE_CLASSNAME \
"Songbird File Metadata Service"

#define SONGBIRD_FILEMETADATASERVICE_DESCRIPTION \
"Songbird File Metadata Service - Reads and writes media file metadata"

// {183C63A5-8195-4294-8D41-A21FE16A0D7C}
#define SONGBIRD_FILEMETADATASERVICE_CID \
{0x183C63A5, 0x8195, 0x4294, {0x8D, 0x41, 0xA2, 0x1F, 0xE1, 0x6A, 0x0D, 0x7C}}


// CLASSES ====================================================================
class sbMetadataJob;
class sbMetadataJobItem;
class sbMainThreadMetadataProcessor;
class sbBackgroundThreadMetadataProcessor;
class sbMetadataCrashTracker;

class sbFileMetadataService : public sbIFileMetadataService,
                              public sbPIFileMetadataService,
                              public nsIObserver
{
public:
  
  NS_DECL_ISUPPORTS
  NS_DECL_SBIFILEMETADATASERVICE
  NS_DECL_SBPIFILEMETADATASERVICE
  NS_DECL_NSIOBSERVER

  sbFileMetadataService();
  virtual ~sbFileMetadataService();
  
  nsresult Init();
  
  
  nsresult GetQueuedJobItem(PRBool aMainThreadOnly, sbMetadataJobItem** aJobItem);
  
  nsresult PutProcessedJobItem(sbMetadataJobItem* aJobItem);

  nsresult GetJobItemIsBlocked(sbMetadataJobItem* aJobItem,
                               PRBool*            aJobItemIsBlocked);


protected:
  
  nsresult ProxiedRestartProcessors(PRUint16 aProcessorsToRestart);
  nsresult ProxiedStartJob(nsIArray* aMediaItemsArray,
                           nsIStringEnumerator* aRequiredProperties,
                           sbMetadataJob::JobType aJobType,
                           sbIJobProgress** _retval);
  
  nsresult StartJob(nsIArray* aMediaItemsArray,
                    nsIStringEnumerator* aRequiredProperties,
                    sbMetadataJob::JobType aJobType,
                    sbIJobProgress** _retval);
  
  nsresult Shutdown();
    
  nsresult EnsureWritePermitted();
  
  nsresult UpdateDataRemotes(PRInt64 aJobCount);
  
  // Legacy dataremote used to indicate metadata status
  nsCOMPtr<sbIDataRemote>                  mDataCurrentMetadataJobs;
  
  // Job processors
  nsRefPtr<sbMainThreadMetadataProcessor>  mMainThreadProcessor;
  nsRefPtr<sbBackgroundThreadMetadataProcessor>  
                                           mBackgroundThreadProcessor;

  PRBool                                   mInitialized;
  PRBool                                   mRunning;
  
  // Timer used to call Job.OnJobProgress()
  nsCOMPtr<nsITimer>                       mNotificationTimer;
  
  // Lock to protect mJobArray and mNextJobIndex
  PRLock*                                  mJobLock;
  
  // List of all active jobs
  nsTArray<nsRefPtr<sbMetadataJob> >       mJobArray;
  
  // Index into mJobArray to use with the next call to GetQueuedJobItem.
  // Used to spread processing between all active jobs
  PRUint32                                 mNextJobIndex;
  
  // Used to keep track of what we're processing, and 
  // blacklist files that seem to destroy the app
  nsRefPtr<sbMetadataCrashTracker>         mCrashTracker;

  // Mediacore manager;
  nsCOMPtr<sbIMediacoreManager>            mMediacoreManager;
};

#endif // SBFILEMETADATASERVICE_H__