sbGStreamerTranscodeAudioConfigurator.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_AUDIO_CONFIGURATOR_H_
#define _SB_GSTREAMER_TRANSCODE_AUDIO_CONFIGURATOR_H_

// {b61e78ec-9aa1-4505-b16c-e33819bca705}
#define SB_GSTREAMER_TRANSCODE_AUDIO_CONFIGURATOR_CID \
    { 0xb61e78ec, 0x9aa1, 0x4505, \
    { 0xb1, 0x6c, 0xe3, 0x38, 0x19, 0xbc, 0xa7, 0x05 } }

#define SB_GSTREAMER_TRANSCODE_AUDIO_CONFIGURATOR_CONTRACTID \
    "@songbirdnest.com/Songbird/Mediacore/Transcode/Configurator/Audio/GStreamer;1"
#define SB_GSTREAMER_TRANSCODE_AUDIO_CONFIGURATOR_CLASSNAME  \
    "GStreamerTranscodeAudioConfigurator"

#include <sbTranscodingConfigurator.h>

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

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

class nsIArray;
class nsIWritablePropertyBag;

class sbIDevice;
class sbITranscodeEncoderProfile;
class sbIAudioFormatType;

class sbGStreamerTranscodeAudioConfigurator :
        public sbTranscodingConfigurator,
        public sbIDeviceTranscodingConfigurator
{
public:
  NS_DECL_ISUPPORTS
  NS_DECL_SBIDEVICETRANSCODINGCONFIGURATOR

  // 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();

  NS_IMETHOD GetAvailableProfiles(nsIArray **aProfiles);

  sbGStreamerTranscodeAudioConfigurator();

protected:
  virtual ~sbGStreamerTranscodeAudioConfigurator();

  nsresult EnsureProfileAvailable(sbITranscodeProfile *aProfile);

  nsresult CheckProfileSupportedByDevice(sbITranscodeProfile *aProfile,
                                         sbIAudioFormatType **aFormat);

  nsresult SelectProfile();

  /* Select the audio format (sample rate, channels, etc) to encode to */
  nsresult SelectOutputAudioFormat();

  nsresult SetAudioProperties();

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

  /* For each property in the property array, get a value from the device
   * preferences and apply it to the property.
   */
  nsresult ApplyPreferencesToPropertyArray(sbIDevice *aDevice,
                                           nsIArray  *aPropertyArray,
                                           nsString aPrefNameBase);

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

  PRBool mProfileFromPrefs;

  PRBool mProfileFromGlobalPrefs;
};

#endif // _SB_GSTREAMER_TRANSCODE_AUDIO_CONFIGURATOR_H_