image/ImageMetadata.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
   2  *
   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_image_ImageMetadata_h
   8 #define mozilla_image_ImageMetadata_h
   9
  10 #include <stdint.h>
  11 #include <utility>
  12 #include "FrameTimeout.h"
  13 #include "Orientation.h"
  14 #include "mozilla/Maybe.h"
  15 #include "mozilla/gfx/Point.h"
  16 #include "mozilla/gfx/Rect.h"
  17 #include "mozilla/image/Resolution.h"
  18 #include "nsSize.h"
  19 #include "nsTArray.h"
  20
  21 namespace mozilla::image {
  22
  23 // The metadata about an image that decoders accumulate as they decode.
  24 class ImageMetadata {
  25  public:
  26   ImageMetadata() = default;
  27
  28   void SetHotspot(uint16_t aHotspotX, uint16_t aHotspotY) {
  29     mHotspot = Some(gfx::IntPoint(aHotspotX, aHotspotY));
  30   }
  31   gfx::IntPoint GetHotspot() const { return *mHotspot; }
  32   bool HasHotspot() const { return mHotspot.isSome(); }
  33
  34   void SetLoopCount(int32_t loopcount) { mLoopCount = loopcount; }
  35   int32_t GetLoopCount() const { return mLoopCount; }
  36
  37   void SetLoopLength(FrameTimeout aLength) { mLoopLength = Some(aLength); }
  38   FrameTimeout GetLoopLength() const { return *mLoopLength; }
  39   bool HasLoopLength() const { return mLoopLength.isSome(); }
  40
  41   void SetFrameCount(uint32_t aCount) { mFrameCount = Some(aCount); }
  42   uint32_t GetFrameCount() const { return *mFrameCount; }
  43   bool HasFrameCount() const { return mFrameCount.isSome(); }
  44
  45   void SetFirstFrameTimeout(FrameTimeout aTimeout) {
  46     mFirstFrameTimeout = aTimeout;
  47   }
  48   FrameTimeout GetFirstFrameTimeout() const { return mFirstFrameTimeout; }
  49
  50   void SetFirstFrameRefreshArea(const gfx::IntRect& aRefreshArea) {
  51     mFirstFrameRefreshArea = Some(aRefreshArea);
  52   }
  53   gfx::IntRect GetFirstFrameRefreshArea() const {
  54     return *mFirstFrameRefreshArea;
  55   }
  56   bool HasFirstFrameRefreshArea() const {
  57     return mFirstFrameRefreshArea.isSome();
  58   }
  59
  60   void SetSize(int32_t aWidth, int32_t aHeight, Orientation aOrientation,
  61                Resolution aResolution) {
  62     if (!HasSize()) {
  63       mSize.emplace(
  64           aOrientation.ToOriented(UnorientedIntSize(aWidth, aHeight)));
  65       mOrientation.emplace(aOrientation);
  66       mResolution = aResolution;
  67     }
  68   }
  69   OrientedIntSize GetSize() const { return *mSize; }
  70   bool HasSize() const { return mSize.isSome(); }
  71
  72   void AddNativeSize(const OrientedIntSize& aSize) {
  73     mNativeSizes.AppendElement(aSize);
  74   }
  75
  76   Resolution GetResolution() const { return mResolution; }
  77
  78   const nsTArray<OrientedIntSize>& GetNativeSizes() const {
  79     return mNativeSizes;
  80   }
  81
  82   Orientation GetOrientation() const { return *mOrientation; }
  83   bool HasOrientation() const { return mOrientation.isSome(); }
  84
  85   void SetHasAnimation() { mHasAnimation = true; }
  86   bool HasAnimation() const { return mHasAnimation; }
  87
  88  private:
  89   /// The hotspot found on cursors, if present.
  90   Maybe<gfx::IntPoint> mHotspot;
  91
  92   /// The loop count for animated images, or -1 for infinite loop.
  93   int32_t mLoopCount = -1;
  94
  95   /// The resolution of the image in dppx.
  96   Resolution mResolution;
  97
  98   // The total length of a single loop through an animated image.
  99   Maybe<FrameTimeout> mLoopLength;
 100
 101   // The total number of frames we expect from the animated image.
 102   Maybe<uint32_t> mFrameCount;
 103
 104   /// The timeout of an animated image's first frame.
 105   FrameTimeout mFirstFrameTimeout = FrameTimeout::Forever();
 106
 107   // The area of the image that needs to be invalidated when the animation
 108   // loops.
 109   Maybe<gfx::IntRect> mFirstFrameRefreshArea;
 110
 111   Maybe<OrientedIntSize> mSize;
 112   Maybe<Orientation> mOrientation;
 113
 114   // Sizes the image can natively decode to.
 115   CopyableTArray<OrientedIntSize> mNativeSizes;
 116
 117   bool mHasAnimation = false;
 118 };
 119
 120 }  // namespace mozilla::image
 121
 122 #endif  // mozilla_image_ImageMetadata_h