author Nicholas Nethercote <>
Mon, 08 Aug 2016 12:18:10 +1000
changeset 308871 b09d90288666fb3afb11877fc45527b904ef23db
parent 308466 a6e140998c35958e3d05031afacd9e123356b2d3
child 308883 64863b1fcf6470de45a6f3979dd3b1709e4b10e8
permissions -rw-r--r--
Bug 1293603 (part 2) - Make Run() declarations consistent. r=erahm. This patch makes most Run() declarations in subclasses of nsIRunnable have the same form: |NS_IMETHOD Run() override|. As a result of these changes, I had to add |override| to a couple of other functions to satisfy clang's -Winconsistent-missing-override warning.

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at */

 * An ISurfaceProvider implemented for single-frame decoded surfaces.

#ifndef mozilla_image_DecodedSurfaceProvider_h
#define mozilla_image_DecodedSurfaceProvider_h

#include "IDecodingTask.h"
#include "ISurfaceProvider.h"
#include "SurfaceCache.h"

namespace mozilla {
namespace image {

 * An ISurfaceProvider that manages the decoding of a single-frame image and
 * stores the resulting surface.
class DecodedSurfaceProvider final
  : public ISurfaceProvider
  , public IDecodingTask
  NS_INLINE_DECL_THREADSAFE_REFCOUNTING(DecodedSurfaceProvider, override)

  DecodedSurfaceProvider(NotNull<RasterImage*> aImage,
                         NotNull<Decoder*> aDecoder,
                         const SurfaceKey& aSurfaceKey);

  // ISurfaceProvider implementation.

  DrawableFrameRef DrawableRef() override;
  bool IsFinished() const override;
  size_t LogicalSizeInBytes() const override;

  bool IsLocked() const override { return bool(mLockRef); }
  void SetLocked(bool aLocked) override;

  // IDecodingTask implementation.

  void Run() override;
  bool ShouldPreferSyncRun() const override;

  // Full decodes are low priority compared to metadata decodes because they
  // don't block layout or page load.
  TaskPriority Priority() const override { return TaskPriority::eLow; }

  virtual ~DecodedSurfaceProvider();

  void DropImageReference();
  void CheckForNewSurface();
  void FinishDecoding();

  /// The image associated with our decoder. Dropped after decoding.
  RefPtr<RasterImage> mImage;

  /// The decoder that will generate our surface. Dropped after decoding.
  RefPtr<Decoder> mDecoder;

  /// Our surface. Initially null until it's generated by the decoder.
  RefPtr<imgFrame> mSurface;

  /// A drawable reference to our service; used for locking.
  DrawableFrameRef mLockRef;

  /// The key under which we're stored as a cache entry in the surface cache.
  SurfaceKey mSurfaceKey;

} // namespace image
} // namespace mozilla

#endif // mozilla_image_DecodedSurfaceProvider_h