dom/html/HTMLVideoElement.h

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim: set ts=8 sts=2 et sw=2 tw=80: */
   3 /* This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #ifndef mozilla_dom_HTMLVideoElement_h
   8 #define mozilla_dom_HTMLVideoElement_h
   9
  10 #include "mozilla/Attributes.h"
  11 #include "mozilla/dom/HTMLMediaElement.h"
  12 #include "mozilla/StaticPrefs.h"
  13
  14 namespace mozilla {
  15
  16 class FrameStatistics;
  17
  18 namespace dom {
  19
  20 class WakeLock;
  21 class VideoPlaybackQuality;
  22
  23 class HTMLVideoElement final : public HTMLMediaElement
  24 {
  25 public:
  26   typedef mozilla::dom::NodeInfo NodeInfo;
  27
  28   explicit HTMLVideoElement(already_AddRefed<NodeInfo>&& aNodeInfo);
  29
  30   NS_IMPL_FROMNODE_HTML_WITH_TAG(HTMLVideoElement, video)
  31
  32   using HTMLMediaElement::GetPaused;
  33
  34   virtual bool IsVideo() const override {
  35     return true;
  36   }
  37
  38   virtual bool ParseAttribute(int32_t aNamespaceID,
  39                               nsAtom* aAttribute,
  40                               const nsAString& aValue,
  41                               nsIPrincipal* aMaybeScriptedPrincipal,
  42                               nsAttrValue& aResult) override;
  43   NS_IMETHOD_(bool) IsAttributeMapped(const nsAtom* aAttribute) const override;
  44
  45   static void Init();
  46
  47   virtual nsMapRuleToAttributesFunc GetAttributeMappingFunction() const override;
  48
  49   virtual nsresult Clone(NodeInfo*, nsINode** aResult) const override;
  50
  51   // Set size with the current video frame's height and width.
  52   // If there is no video frame, returns NS_ERROR_FAILURE.
  53   nsresult GetVideoSize(nsIntSize* size);
  54
  55   virtual nsresult SetAcceptHeader(nsIHttpChannel* aChannel) override;
  56
  57   // Element
  58   virtual bool IsInteractiveHTMLContent(bool aIgnoreTabindex) const override;
  59
  60   // WebIDL
  61
  62   uint32_t Width() const
  63   {
  64     return GetIntAttr(nsGkAtoms::width, 0);
  65   }
  66
  67   void SetWidth(uint32_t aValue, ErrorResult& aRv)
  68   {
  69     SetUnsignedIntAttr(nsGkAtoms::width, aValue, 0, aRv);
  70   }
  71
  72   uint32_t Height() const
  73   {
  74     return GetIntAttr(nsGkAtoms::height, 0);
  75   }
  76
  77   void SetHeight(uint32_t aValue, ErrorResult& aRv)
  78   {
  79     SetUnsignedIntAttr(nsGkAtoms::height, aValue, 0, aRv);
  80   }
  81
  82   uint32_t VideoWidth() const
  83   {
  84     if (mMediaInfo.HasVideo()) {
  85       if (mMediaInfo.mVideo.mRotation == VideoInfo::Rotation::kDegree_90 ||
  86           mMediaInfo.mVideo.mRotation == VideoInfo::Rotation::kDegree_270) {
  87         return mMediaInfo.mVideo.mDisplay.height;
  88       }
  89       return mMediaInfo.mVideo.mDisplay.width;
  90     }
  91     return 0;
  92   }
  93
  94   uint32_t VideoHeight() const
  95   {
  96     if (mMediaInfo.HasVideo()) {
  97       if (mMediaInfo.mVideo.mRotation == VideoInfo::Rotation::kDegree_90 ||
  98           mMediaInfo.mVideo.mRotation == VideoInfo::Rotation::kDegree_270) {
  99         return mMediaInfo.mVideo.mDisplay.width;
 100       }
 101       return mMediaInfo.mVideo.mDisplay.height;
 102     }
 103     return 0;
 104   }
 105
 106   VideoInfo::Rotation RotationDegrees() const
 107   {
 108     return mMediaInfo.mVideo.mRotation;
 109   }
 110
 111   void GetPoster(nsAString& aValue)
 112   {
 113     GetURIAttr(nsGkAtoms::poster, nullptr, aValue);
 114   }
 115   void SetPoster(const nsAString& aValue, ErrorResult& aRv)
 116   {
 117     SetHTMLAttr(nsGkAtoms::poster, aValue, aRv);
 118   }
 119
 120   uint32_t MozParsedFrames() const;
 121
 122   uint32_t MozDecodedFrames() const;
 123
 124   uint32_t MozPresentedFrames() const;
 125
 126   uint32_t MozPaintedFrames();
 127
 128   double MozFrameDelay();
 129
 130   bool MozHasAudio() const;
 131
 132   // Gives access to the decoder's frame statistics, if present.
 133   FrameStatistics* GetFrameStatistics();
 134
 135   already_AddRefed<VideoPlaybackQuality> GetVideoPlaybackQuality();
 136
 137
 138   bool MozOrientationLockEnabled() const
 139   {
 140     return StaticPrefs::MediaVideocontrolsLockVideoOrientation();
 141   }
 142
 143   bool MozIsOrientationLocked() const
 144   {
 145     return mIsOrientationLocked;
 146   }
 147
 148   void SetMozIsOrientationLocked(bool aLock)
 149   {
 150     mIsOrientationLocked = aLock;
 151   }
 152
 153 protected:
 154   virtual ~HTMLVideoElement();
 155
 156   virtual JSObject* WrapNode(JSContext* aCx, JS::Handle<JSObject*> aGivenProto) override;
 157
 158   /**
 159    * We create video wakelock when the video is playing and release it when
 160    * video pauses. Note, the actual platform wakelock will automatically be
 161    * released when the page is in the background, so we don't need to check the
 162    * video's visibility by ourselves.
 163    */
 164   void WakeLockRelease() override;
 165   void UpdateWakeLock() override;
 166
 167   bool ShouldCreateVideoWakeLock() const;
 168   void CreateVideoWakeLockIfNeeded();
 169   void ReleaseVideoWakeLockIfExists();
 170
 171   RefPtr<WakeLock> mScreenWakeLock;
 172
 173   bool mIsOrientationLocked;
 174
 175 private:
 176   static void MapAttributesIntoRule(const nsMappedAttributes* aAttributes,
 177                                     MappedDeclarations&);
 178
 179   static bool IsVideoStatsEnabled();
 180   double TotalPlayTime() const;
 181 };
 182
 183 } // namespace dom
 184 } // namespace mozilla
 185
 186 #endif // mozilla_dom_HTMLVideoElement_h