sbGStreamerTranscodeDeviceConfigurator.h

Go to the documentation of this file.

/* vim: set sw=2 */
/*
 *=BEGIN SONGBIRD GPL
 *
 * This file is part of the Songbird web player.
 *
 * Copyright(c) 2005-2009 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_GSTREAMER_TRANSCODE_DEVICE_CONFIGURATOR_H_
#define _SB_GSTREAMER_TRANSCODE_DEVICE_CONFIGURATOR_H_

// {8D5D04F8-2060-4e82-A25B-C7D67A6B5292}
#define SB_GSTREAMER_TRANSCODE_DEVICE_CONFIGURATOR_CID \
    { 0x8d5d04f8, 0x2060, 0x4e82, \
    { 0xa2, 0x5b, 0xc7, 0xd6, 0x7a, 0x6b, 0x52, 0x92 } }

#define SB_GSTREAMER_TRANSCODE_DEVICE_CONFIGURATOR_CONTRACTID \
    "@songbirdnest.com/Songbird/Mediacore/Transcode/Configurator/Device/GStreamer;1"
#define SB_GSTREAMER_TRANSCODE_DEVICE_CONFIGURATOR_CLASSNAME  \
    "GStreamerTranscodeDeviceConfigurator"

#include <sbTranscodingConfigurator.h>

#include <sbITranscodingConfigurator.h>
#include <sbPIGstTranscodingConfigurator.h>

#include <nsCOMPtr.h>
#include <nsDataHashtable.h>

#include <sbFraction.h>

class nsIArray;
class nsIWritablePropertyBag;

class sbIDevice;
class sbITranscodeEncoderProfile;
class sbIVideoFormatType;

class sbGStreamerTranscodeDeviceConfigurator :
        public sbTranscodingConfigurator,
        public sbIDeviceTranscodingConfigurator,
        public sbPIGstTranscodingConfigurator
{
public:
  NS_DECL_ISUPPORTS
  NS_DECL_SBIDEVICETRANSCODINGCONFIGURATOR
  NS_DECL_SBPIGSTTRANSCODINGCONFIGURATOR

  // forward most of sbITranscodingConfigurator to the base class
  #define FORWARD_TO_BASE(METHOD, PROTO, ARGS) \
    NS_IMETHOD METHOD PROTO { return sbTranscodingConfigurator::METHOD(ARGS); }

  FORWARD_TO_BASE(GetInputUri, (nsIURI ** aUri), aUri)
  FORWARD_TO_BASE(SetInputUri, (nsIURI * aUri), aUri)
  FORWARD_TO_BASE(GetInputFormat, (sbIMediaFormat * *aInputFormat), aInputFormat)
  FORWARD_TO_BASE(SetInputFormat, (sbIMediaFormat * aInputFormat), aInputFormat)
  FORWARD_TO_BASE(GetLastError, (sbITranscodeError * *aLastError), aLastError)
  FORWARD_TO_BASE(GetMuxer, (nsAString & aMuxer), aMuxer)
  FORWARD_TO_BASE(GetUseMuxer, (PRBool *aUseMuxer), aUseMuxer)
  FORWARD_TO_BASE(GetFileExtension, (nsACString & aFileExtension), aFileExtension)
  FORWARD_TO_BASE(GetVideoEncoder, (nsAString & aVideoEncoder), aVideoEncoder)
  FORWARD_TO_BASE(GetUseVideoEncoder, (PRBool *aUseVideoEncoder), aUseVideoEncoder)
  FORWARD_TO_BASE(GetVideoFormat, (sbIMediaFormatVideo * *aVideoFormat), aVideoFormat)
  FORWARD_TO_BASE(GetAudioEncoder, (nsAString & aAudioEncoder), aAudioEncoder)
  FORWARD_TO_BASE(GetUseAudioEncoder, (PRBool *aUseAudioEncoder), aUseAudioEncoder)
  FORWARD_TO_BASE(GetAudioFormat, (sbIMediaFormatAudio * *aAudioFormat), aAudioFormat)
  FORWARD_TO_BASE(GetVideoEncoderProperties, (nsIPropertyBag * *aVideoEncoderProperties), aVideoEncoderProperties)
  FORWARD_TO_BASE(GetAudioEncoderProperties, (nsIPropertyBag * *aAudioEncoderProperties), aAudioEncoderProperties)
  
  #undef FORWARD_TO_BASE

  /*
   * re-implement determineOutputType() and configurate() to have the
   * configuration logic specific to gstreamer-based configuration for devices
   */
  NS_IMETHOD DetermineOutputType();
  NS_IMETHOD Configurate();
  /* Implement GetAvailableProfiles to return only appropriate profiles. */
  NS_IMETHOD GetAvailableProfiles(nsIArray **aProfiles);

  sbGStreamerTranscodeDeviceConfigurator();

protected:
  virtual ~sbGStreamerTranscodeDeviceConfigurator();

  struct Dimensions {
    PRInt32 width;
    PRInt32 height;
    Dimensions() : width(PR_INT32_MIN), height(PR_INT32_MIN) {}
    Dimensions(PRInt32 w, PRInt32 h) : width(w), height(h) {}
  };
  
  nsresult EnsureProfileAvailable(sbITranscodeEncoderProfile *aProfile);

  nsresult SelectQuality();

  nsresult SelectProfile();

  nsresult SetAudioProperties();

  nsresult DetermineOutputDimensions();

  static Dimensions GetMaximumFit(const Dimensions& aInput,
                                  const Dimensions& aMaximum);

  nsresult DetermineOutputVideoBitrate();

  nsresult SetVideoProperties();

  nsresult CopyPropertiesIntoBag(nsIArray * aSrcProps,
                                 nsIWritablePropertyBag * aDstBag,
                                 PRBool aIsVideo);

protected:
  struct EncoderProfileData {
    nsCString muxer;
    nsCString audioEncoder;
    nsCString videoEncoder;
  };
  nsDataHashtable<nsISupportsHashKey, EncoderProfileData> mElementNames;
  
  double mQuality;
  nsCOMPtr<sbIDevice> mDevice;
  nsCOMPtr<nsIArray> mAvailableProfiles;
  nsCOMPtr<sbITranscodeEncoderProfile> mSelectedProfile;
  nsCOMPtr<sbIVideoFormatType> mSelectedFormat;

  PRInt32 mVideoBitrate;
  
  sbFraction mVideoFrameRate;

  Dimensions mOutputDimensions;
  
  sbFraction mOutputPAR;
};

#endif // _SB_GSTREAMER_TRANSCODE_DEVICE_CONFIGURATOR_H_