cc/resources/picture_layer_tiling.h

   1 // Copyright 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef CC_RESOURCES_PICTURE_LAYER_TILING_H_
   6 #define CC_RESOURCES_PICTURE_LAYER_TILING_H_
   7
   8 #include <set>
   9 #include <utility>
  10 #include <vector>
  11
  12 #include "base/basictypes.h"
  13 #include "base/containers/hash_tables.h"
  14 #include "base/memory/scoped_ptr.h"
  15 #include "cc/base/cc_export.h"
  16 #include "cc/base/region.h"
  17 #include "cc/base/tiling_data.h"
  18 #include "cc/resources/tile.h"
  19 #include "cc/resources/tile_priority.h"
  20 #include "cc/trees/occlusion.h"
  21 #include "ui/gfx/geometry/rect.h"
  22
  23 namespace base {
  24 namespace trace_event {
  25 class TracedValue;
  26 }
  27 }
  28
  29 namespace cc {
  30
  31 class PictureLayerTiling;
  32 class RasterSource;
  33
  34 class CC_EXPORT PictureLayerTilingClient {
  35  public:
  36   // Create a tile at the given content_rect (in the contents scale of the
  37   // tiling) This might return null if the client cannot create such a tile.
  38   virtual scoped_refptr<Tile> CreateTile(float contents_scale,
  39                                          const gfx::Rect& content_rect) = 0;
  40   virtual gfx::Size CalculateTileSize(
  41     const gfx::Size& content_bounds) const = 0;
  42   // This invalidation region defines the area (if any, it can by null) that
  43   // tiles can not be shared between pending and active trees.
  44   virtual const Region* GetPendingInvalidation() = 0;
  45   virtual const PictureLayerTiling* GetPendingOrActiveTwinTiling(
  46       const PictureLayerTiling* tiling) const = 0;
  47   virtual PictureLayerTiling* GetRecycledTwinTiling(
  48       const PictureLayerTiling* tiling) = 0;
  49   virtual TilePriority::PriorityBin GetMaxTilePriorityBin() const = 0;
  50   virtual WhichTree GetTree() const = 0;
  51   virtual bool RequiresHighResToDraw() const = 0;
  52
  53  protected:
  54   virtual ~PictureLayerTilingClient() {}
  55 };
  56
  57 class CC_EXPORT PictureLayerTiling {
  58  public:
  59   static const int kBorderTexels = 1;
  60
  61   ~PictureLayerTiling();
  62
  63   static float CalculateSoonBorderDistance(
  64       const gfx::Rect& visible_rect_in_content_space,
  65       float content_to_screen_scale);
  66
  67   // Create a tiling with no tiles. CreateTile() must be called to add some.
  68   static scoped_ptr<PictureLayerTiling> Create(
  69       float contents_scale,
  70       scoped_refptr<RasterSource> raster_source,
  71       PictureLayerTilingClient* client,
  72       size_t max_tiles_for_interest_area,
  73       float skewport_target_time_in_seconds,
  74       int skewport_extrapolation_limit_in_content_pixels);
  75
  76   void SetRasterSourceAndResize(scoped_refptr<RasterSource> raster_source);
  77   void Invalidate(const Region& layer_invalidation);
  78   void SetRasterSourceOnTiles();
  79   void CreateMissingTilesInLiveTilesRect();
  80
  81   void CloneTilesAndPropertiesFrom(const PictureLayerTiling& twin_tiling);
  82
  83   void set_resolution(TileResolution resolution) { resolution_ = resolution; }
  84   TileResolution resolution() const { return resolution_; }
  85   void set_can_require_tiles_for_activation(bool can_require_tiles) {
  86     can_require_tiles_for_activation_ = can_require_tiles;
  87   }
  88
  89   RasterSource* raster_source() const { return raster_source_.get(); }
  90   gfx::Size tiling_size() const { return tiling_data_.tiling_size(); }
  91   gfx::Rect live_tiles_rect() const { return live_tiles_rect_; }
  92   gfx::Size tile_size() const { return tiling_data_.max_texture_size(); }
  93   float contents_scale() const { return contents_scale_; }
  94
  95   Tile* TileAt(int i, int j) const {
  96     TileMap::const_iterator iter = tiles_.find(TileMapKey(i, j));
  97     return (iter == tiles_.end()) ? NULL : iter->second.get();
  98   }
  99
 100   void CreateAllTilesForTesting() {
 101     SetLiveTilesRect(gfx::Rect(tiling_data_.tiling_size()));
 102   }
 103
 104   const TilingData& TilingDataForTesting() const { return tiling_data_; }
 105
 106   std::vector<Tile*> AllTilesForTesting() const {
 107     std::vector<Tile*> all_tiles;
 108     for (TileMap::const_iterator it = tiles_.begin(); it != tiles_.end(); ++it)
 109       all_tiles.push_back(it->second.get());
 110     return all_tiles;
 111   }
 112
 113   void UpdateAllTilePrioritiesForTesting() {
 114     for (TileMap::const_iterator it = tiles_.begin(); it != tiles_.end(); ++it)
 115       UpdateTileAndTwinPriority(it->second.get());
 116   }
 117
 118   std::vector<scoped_refptr<Tile>> AllRefTilesForTesting() const {
 119     std::vector<scoped_refptr<Tile>> all_tiles;
 120     for (TileMap::const_iterator it = tiles_.begin(); it != tiles_.end(); ++it)
 121       all_tiles.push_back(it->second);
 122     return all_tiles;
 123   }
 124
 125   void SetAllTilesOccludedForTesting() {
 126     gfx::Rect viewport_in_layer_space =
 127         ScaleToEnclosingRect(current_visible_rect_, 1.0f / contents_scale_);
 128     current_occlusion_in_layer_space_ =
 129         Occlusion(gfx::Transform(),
 130                   SimpleEnclosedRegion(viewport_in_layer_space),
 131                   SimpleEnclosedRegion(viewport_in_layer_space));
 132   }
 133
 134   const gfx::Rect& GetCurrentVisibleRectForTesting() const {
 135     return current_visible_rect_;
 136   }
 137
 138   bool IsTileOccluded(const Tile* tile) const;
 139   bool IsTileRequiredForActivationIfVisible(const Tile* tile) const;
 140   bool IsTileRequiredForDrawIfVisible(const Tile* tile) const;
 141
 142   void UpdateTileAndTwinPriority(Tile* tile) const;
 143   bool has_visible_rect_tiles() const { return has_visible_rect_tiles_; }
 144   bool has_skewport_rect_tiles() const { return has_skewport_rect_tiles_; }
 145   bool has_soon_border_rect_tiles() const {
 146     return has_soon_border_rect_tiles_;
 147   }
 148   bool has_eventually_rect_tiles() const { return has_eventually_rect_tiles_; }
 149
 150   const gfx::Rect& current_visible_rect() const {
 151     return current_visible_rect_;
 152   }
 153   const gfx::Rect& current_skewport_rect() const {
 154     return current_skewport_rect_;
 155   }
 156   const gfx::Rect& current_soon_border_rect() const {
 157     return current_soon_border_rect_;
 158   }
 159   const gfx::Rect& current_eventually_rect() const {
 160     return current_eventually_rect_;
 161   }
 162
 163   // Iterate over all tiles to fill content_rect.  Even if tiles are invalid
 164   // (i.e. no valid resource) this tiling should still iterate over them.
 165   // The union of all geometry_rect calls for each element iterated over should
 166   // exactly equal content_rect and no two geometry_rects should intersect.
 167   class CC_EXPORT CoverageIterator {
 168    public:
 169     CoverageIterator();
 170     CoverageIterator(const PictureLayerTiling* tiling,
 171         float dest_scale,
 172         const gfx::Rect& rect);
 173     ~CoverageIterator();
 174
 175     // Visible rect (no borders), always in the space of content_rect,
 176     // regardless of the contents scale of the tiling.
 177     gfx::Rect geometry_rect() const;
 178     // Texture rect (in texels) for geometry_rect
 179     gfx::RectF texture_rect() const;
 180
 181     Tile* operator->() const { return current_tile_; }
 182     Tile* operator*() const { return current_tile_; }
 183
 184     CoverageIterator& operator++();
 185     operator bool() const { return tile_j_ <= bottom_; }
 186
 187     int i() const { return tile_i_; }
 188     int j() const { return tile_j_; }
 189
 190    private:
 191     const PictureLayerTiling* tiling_;
 192     gfx::Rect dest_rect_;
 193     float dest_to_content_scale_;
 194
 195     Tile* current_tile_;
 196     gfx::Rect current_geometry_rect_;
 197     int tile_i_;
 198     int tile_j_;
 199     int left_;
 200     int top_;
 201     int right_;
 202     int bottom_;
 203
 204     friend class PictureLayerTiling;
 205   };
 206
 207   void Reset();
 208
 209   bool ComputeTilePriorityRects(const gfx::Rect& viewport_in_layer_space,
 210                                 float ideal_contents_scale,
 211                                 double current_frame_time_in_seconds,
 212                                 const Occlusion& occlusion_in_layer_space);
 213
 214   void GetAllTilesForTracing(std::set<const Tile*>* tiles) const;
 215   void AsValueInto(base::trace_event::TracedValue* array) const;
 216   size_t GPUMemoryUsageInBytes() const;
 217
 218   struct RectExpansionCache {
 219     RectExpansionCache();
 220
 221     gfx::Rect previous_start;
 222     gfx::Rect previous_bounds;
 223     gfx::Rect previous_result;
 224     int64 previous_target;
 225   };
 226
 227   static
 228   gfx::Rect ExpandRectEquallyToAreaBoundedBy(
 229       const gfx::Rect& starting_rect,
 230       int64 target_area,
 231       const gfx::Rect& bounding_rect,
 232       RectExpansionCache* cache);
 233
 234   bool has_ever_been_updated() const {
 235     return last_impl_frame_time_in_seconds_ != 0.0;
 236   }
 237
 238  protected:
 239   friend class CoverageIterator;
 240   friend class TilingSetRasterQueueAll;
 241   friend class TilingSetRasterQueueRequired;
 242   friend class TilingSetEvictionQueue;
 243
 244   typedef std::pair<int, int> TileMapKey;
 245   typedef base::hash_map<TileMapKey, scoped_refptr<Tile>> TileMap;
 246
 247   PictureLayerTiling(float contents_scale,
 248                      scoped_refptr<RasterSource> raster_source,
 249                      PictureLayerTilingClient* client,
 250                      size_t max_tiles_for_interest_area,
 251                      float skewport_target_time_in_seconds,
 252                      int skewport_extrapolation_limit_in_content_pixels);
 253   void SetLiveTilesRect(const gfx::Rect& live_tiles_rect);
 254   void VerifyLiveTilesRect(bool is_on_recycle_tree) const;
 255   Tile* CreateTile(int i,
 256                    int j,
 257                    const PictureLayerTiling* twin_tiling,
 258                    PictureLayerTiling* recycled_twin);
 259   // Returns true if the Tile existed and was removed from the tiling.
 260   bool RemoveTileAt(int i, int j, PictureLayerTiling* recycled_twin);
 261
 262   // Computes a skewport. The calculation extrapolates the last visible
 263   // rect and the current visible rect to expand the skewport to where it
 264   // would be in |skewport_target_time| seconds. Note that the skewport
 265   // is guaranteed to contain the current visible rect.
 266   gfx::Rect ComputeSkewport(double current_frame_time_in_seconds,
 267                             const gfx::Rect& visible_rect_in_content_space)
 268       const;
 269
 270   // Save the required data for computing tile priorities later.
 271   void UpdateTilePriorityRects(float content_to_screen_scale_,
 272                                const gfx::Rect& visible_rect_in_content_space,
 273                                const gfx::Rect& skewport,
 274                                const gfx::Rect& soon_border_rect,
 275                                const gfx::Rect& eventually_rect,
 276                                const Occlusion& occlusion_in_layer_space);
 277
 278   void UpdateTilePriorityForTree(Tile* tile, WhichTree tree) const;
 279   bool NeedsUpdateForFrameAtTimeAndViewport(
 280       double frame_time_in_seconds,
 281       const gfx::Rect& viewport_in_layer_space) {
 282     return frame_time_in_seconds != last_impl_frame_time_in_seconds_ ||
 283            viewport_in_layer_space != last_viewport_in_layer_space_;
 284   }
 285
 286   const size_t max_tiles_for_interest_area_;
 287   const float skewport_target_time_in_seconds_;
 288   const int skewport_extrapolation_limit_in_content_pixels_;
 289
 290   // Given properties.
 291   const float contents_scale_;
 292   PictureLayerTilingClient* const client_;
 293   scoped_refptr<RasterSource> raster_source_;
 294   TileResolution resolution_;
 295
 296   // Internal data.
 297   TilingData tiling_data_;
 298   TileMap tiles_;  // It is not legal to have a NULL tile in the tiles_ map.
 299   gfx::Rect live_tiles_rect_;
 300
 301   // State saved for computing velocities based upon finite differences.
 302   double last_impl_frame_time_in_seconds_;
 303   gfx::Rect last_viewport_in_layer_space_;
 304   gfx::Rect last_visible_rect_in_content_space_;
 305
 306   bool can_require_tiles_for_activation_;
 307
 308   // Iteration rects in content space.
 309   gfx::Rect current_visible_rect_;
 310   gfx::Rect current_skewport_rect_;
 311   gfx::Rect current_soon_border_rect_;
 312   gfx::Rect current_eventually_rect_;
 313   // Other properties used for tile iteration and prioritization.
 314   float current_content_to_screen_scale_;
 315   Occlusion current_occlusion_in_layer_space_;
 316
 317   bool has_visible_rect_tiles_;
 318   bool has_skewport_rect_tiles_;
 319   bool has_soon_border_rect_tiles_;
 320   bool has_eventually_rect_tiles_;
 321
 322  private:
 323   DISALLOW_ASSIGN(PictureLayerTiling);
 324
 325   RectExpansionCache expansion_cache_;
 326 };
 327
 328 }  // namespace cc
 329
 330 #endif  // CC_RESOURCES_PICTURE_LAYER_TILING_H_