sbDeviceXMLCapabilities.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-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 SBDEVICEXMLCAPABILITIES_H_
#define SBDEVICEXMLCAPABILITIES_H_

#include <nsCOMPtr.h>
#include <nsStringAPI.h>
#include <sbIDevice.h>

class sbIDeviceCapabilities;
class sbIDevCapVideoStream;
class sbIDevCapAudioStream;
class sbIDevCapVideoFormatType;
class nsIDOMDocument;
class nsIDOMElement;
class nsIDOMNode;
class nsIMutableArray;

class sbDeviceXMLCapabilities
{
public:
  sbDeviceXMLCapabilities(nsIDOMElement* aRootElement,
                          sbIDevice*     aDevice = nsnull);
  ~sbDeviceXMLCapabilities();
  nsresult Read(sbIDeviceCapabilities * aCapabilities);
  PRBool HasCapabilities() { return mHasCapabilities; }
  static nsresult GetCapabilities(sbIDeviceCapabilities** aCapabilities,
                                  nsIDOMDocument*         aDocument,
                                  sbIDevice*              aDevice = nsnull);
  static nsresult GetCapabilities(sbIDeviceCapabilities** aCapabilities,
                                  nsIDOMNode*             aDeviceCapsRootNode,
                                  sbIDevice*              aDevice = nsnull);
  static nsresult AddCapabilities
                    (sbIDeviceCapabilities* aCapabilities,
                     const char*            aXMLCapabilitiesSpec,
                     PRBool*                aAddedCapabilities = nsnull,
                     sbIDevice*             aDevice = nsnull);
  static nsresult AddCapabilities
                    (sbIDeviceCapabilities* aCapabilities,
                     nsIDOMNode*            aDeviceCapsRootNode,
                     PRBool*                aAddedCapabilities = nsnull,
                     sbIDevice*             aDevice = nsnull);
private:
  sbIDevice* mDevice;                   // Non-owning reference
  sbIDeviceCapabilities * mDeviceCaps;  // Non-owning reference
  nsCOMPtr<nsIDOMElement> mRootElement;
  PRBool mHasCapabilities;

  nsresult AddFunctionType(PRUint32 aFunctionType);

  nsresult AddContentType(PRUint32 aFunctionType,
                          PRUint32 aContentType);

  nsresult AddMimeType(PRUint32 aContentType,
                       nsAString const & aMimeType);

  nsresult ProcessCapabilities(nsIDOMNode* aRootNode);

  nsresult ProcessDeviceCaps(nsIDOMNode * aDevCapNode);

  nsresult ProcessAudio(nsIDOMNode * aAudioNode);

  nsresult ProcessImageSizes(nsIDOMNode * aImageSizeNode,
                             nsIMutableArray * aImageSizes);

  nsresult ProcessImage(nsIDOMNode * aImageNode);

  nsresult ProcessVideo(nsIDOMNode * aVideoNode);

  nsresult
  ProcessVideoStream(nsIDOMNode* aVideoStreamNode,
                     sbIDevCapVideoStream** aVideoStream);

  nsresult
  ProcessAudioStream(nsIDOMNode* aAudioStreamNode,
                     sbIDevCapAudioStream** aAudioStream);

  nsresult
  ProcessVideoFormat(nsIDOMNode* aDOMNode);

  nsresult ProcessPlaylist(nsIDOMNode * aPlaylistNode);

  nsresult DeviceMatchesCapabilitiesNode(nsIDOMNode * aCapabilitiesNode,
                                         PRBool * aDeviceMatches);

  nsresult DeviceMatchesDeviceNode(nsIDOMNode * aDeviceNode,
                                   nsIPropertyBag2 * aDeviceProperties,
                                   PRBool * aDeviceMatches);

  nsresult GetFirstChildByTagName(nsIDOMNode*  aNode,
                                  const char*        aTagName,
                                  nsIDOMNode** aChildNode);
};

#endif /* SBDEVICEXMLCAPABILITIES_H_ */