content/browser/compositor/delegated_frame_host.cc

   1 // Copyright 2014 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 #include "content/browser/compositor/delegated_frame_host.h"
   6
   7 #include "base/callback_helpers.h"
   8 #include "base/command_line.h"
   9 #include "base/time/default_tick_clock.h"
  10 #include "cc/output/compositor_frame.h"
  11 #include "cc/output/compositor_frame_ack.h"
  12 #include "cc/output/copy_output_request.h"
  13 #include "cc/resources/single_release_callback.h"
  14 #include "cc/resources/texture_mailbox.h"
  15 #include "cc/surfaces/surface.h"
  16 #include "cc/surfaces/surface_factory.h"
  17 #include "cc/surfaces/surface_hittest.h"
  18 #include "cc/surfaces/surface_manager.h"
  19 #include "content/browser/compositor/resize_lock.h"
  20 #include "content/browser/compositor/surface_utils.h"
  21 #include "content/browser/gpu/compositor_util.h"
  22 #include "content/common/gpu/client/gl_helper.h"
  23 #include "content/public/browser/render_widget_host_view_frame_subscriber.h"
  24 #include "content/public/common/content_switches.h"
  25 #include "media/base/video_frame.h"
  26 #include "media/base/video_util.h"
  27 #include "skia/ext/image_operations.h"
  28 #include "third_party/skia/include/core/SkCanvas.h"
  29 #include "third_party/skia/include/core/SkPaint.h"
  30 #include "third_party/skia/include/effects/SkLumaColorFilter.h"
  31 #include "ui/gfx/geometry/dip_util.h"
  32
  33 namespace content {
  34
  35 namespace {
  36
  37 void SatisfyCallback(cc::SurfaceManager* manager,
  38                      cc::SurfaceSequence sequence) {
  39   std::vector<uint32_t> sequences;
  40   sequences.push_back(sequence.sequence);
  41   manager->DidSatisfySequences(sequence.id_namespace, &sequences);
  42 }
  43
  44 void RequireCallback(cc::SurfaceManager* manager,
  45                      cc::SurfaceId id,
  46                      cc::SurfaceSequence sequence) {
  47   cc::Surface* surface = manager->GetSurfaceForId(id);
  48   if (!surface) {
  49     LOG(ERROR) << "Attempting to require callback on nonexistent surface";
  50     return;
  51   }
  52   surface->AddDestructionDependency(sequence);
  53 }
  54
  55 }  // namespace
  56
  57 ////////////////////////////////////////////////////////////////////////////////
  58 // DelegatedFrameHost
  59
  60 DelegatedFrameHost::DelegatedFrameHost(DelegatedFrameHostClient* client)
  61     : client_(client),
  62       compositor_(nullptr),
  63       use_surfaces_(UseSurfacesEnabled()),
  64       tick_clock_(new base::DefaultTickClock()),
  65       last_output_surface_id_(0),
  66       pending_delegated_ack_count_(0),
  67       skipped_frames_(false),
  68       current_scale_factor_(1.f),
  69       can_lock_compositor_(YES_CAN_LOCK),
  70       delegated_frame_evictor_(new DelegatedFrameEvictor(this)) {
  71   ImageTransportFactory* factory = ImageTransportFactory::GetInstance();
  72   factory->AddObserver(this);
  73   id_allocator_ = factory->GetContextFactory()->CreateSurfaceIdAllocator();
  74 }
  75
  76 void DelegatedFrameHost::WasShown(const ui::LatencyInfo& latency_info) {
  77   delegated_frame_evictor_->SetVisible(true);
  78
  79   if (surface_id_.is_null() && !frame_provider_.get() &&
  80       !released_front_lock_.get()) {
  81     if (compositor_)
  82       released_front_lock_ = compositor_->GetCompositorLock();
  83   }
  84
  85   if (compositor_) {
  86     compositor_->SetLatencyInfo(latency_info);
  87   }
  88 }
  89
  90 bool DelegatedFrameHost::HasSavedFrame() {
  91   return delegated_frame_evictor_->HasFrame();
  92 }
  93
  94 void DelegatedFrameHost::WasHidden() {
  95   delegated_frame_evictor_->SetVisible(false);
  96   released_front_lock_ = NULL;
  97 }
  98
  99 void DelegatedFrameHost::MaybeCreateResizeLock() {
 100   if (!ShouldCreateResizeLock())
 101     return;
 102   DCHECK(compositor_);
 103
 104   bool defer_compositor_lock =
 105       can_lock_compositor_ == NO_PENDING_RENDERER_FRAME ||
 106       can_lock_compositor_ == NO_PENDING_COMMIT;
 107
 108   if (can_lock_compositor_ == YES_CAN_LOCK)
 109     can_lock_compositor_ = YES_DID_LOCK;
 110
 111   resize_lock_ =
 112       client_->DelegatedFrameHostCreateResizeLock(defer_compositor_lock);
 113 }
 114
 115 bool DelegatedFrameHost::ShouldCreateResizeLock() {
 116   if (!client_->DelegatedFrameCanCreateResizeLock())
 117     return false;
 118
 119   if (resize_lock_)
 120     return false;
 121
 122   gfx::Size desired_size = client_->DelegatedFrameHostDesiredSizeInDIP();
 123   if (desired_size == current_frame_size_in_dip_ || desired_size.IsEmpty())
 124     return false;
 125
 126   if (!compositor_)
 127     return false;
 128
 129   return true;
 130 }
 131
 132 void DelegatedFrameHost::CopyFromCompositingSurface(
 133     const gfx::Rect& src_subrect,
 134     const gfx::Size& output_size,
 135     ReadbackRequestCallback& callback,
 136     const SkColorType preferred_color_type) {
 137   // Only ARGB888 and RGB565 supported as of now.
 138   bool format_support = ((preferred_color_type == kAlpha_8_SkColorType) ||
 139                          (preferred_color_type == kRGB_565_SkColorType) ||
 140                          (preferred_color_type == kN32_SkColorType));
 141   DCHECK(format_support);
 142   if (!CanCopyToBitmap()) {
 143     callback.Run(SkBitmap(), content::READBACK_SURFACE_UNAVAILABLE);
 144     return;
 145   }
 146
 147   scoped_ptr<cc::CopyOutputRequest> request =
 148       cc::CopyOutputRequest::CreateRequest(
 149           base::Bind(&DelegatedFrameHost::CopyFromCompositingSurfaceHasResult,
 150                      output_size, preferred_color_type, callback));
 151   if (!src_subrect.IsEmpty())
 152     request->set_area(src_subrect);
 153   RequestCopyOfOutput(request.Pass());
 154 }
 155
 156 void DelegatedFrameHost::CopyFromCompositingSurfaceToVideoFrame(
 157       const gfx::Rect& src_subrect,
 158       const scoped_refptr<media::VideoFrame>& target,
 159       const base::Callback<void(bool)>& callback) {
 160   if (!CanCopyToVideoFrame()) {
 161     callback.Run(false);
 162     return;
 163   }
 164
 165   scoped_ptr<cc::CopyOutputRequest> request =
 166       cc::CopyOutputRequest::CreateRequest(base::Bind(
 167           &DelegatedFrameHost::
 168                CopyFromCompositingSurfaceHasResultForVideo,
 169           AsWeakPtr(),  // For caching the ReadbackYUVInterface on this class.
 170           nullptr,
 171           target,
 172           callback));
 173   request->set_area(src_subrect);
 174   RequestCopyOfOutput(request.Pass());
 175 }
 176
 177 bool DelegatedFrameHost::CanCopyToBitmap() const {
 178   return compositor_ &&
 179          client_->DelegatedFrameHostGetLayer()->has_external_content();
 180 }
 181
 182 bool DelegatedFrameHost::CanCopyToVideoFrame() const {
 183   return compositor_ &&
 184          client_->DelegatedFrameHostGetLayer()->has_external_content();
 185 }
 186
 187 void DelegatedFrameHost::BeginFrameSubscription(
 188     scoped_ptr<RenderWidgetHostViewFrameSubscriber> subscriber) {
 189   frame_subscriber_ = subscriber.Pass();
 190 }
 191
 192 void DelegatedFrameHost::EndFrameSubscription() {
 193   idle_frame_subscriber_textures_.clear();
 194   frame_subscriber_.reset();
 195 }
 196
 197 uint32_t DelegatedFrameHost::GetSurfaceIdNamespace() {
 198   if (!use_surfaces_)
 199     return 0;
 200
 201   return id_allocator_->id_namespace();
 202 }
 203
 204 cc::SurfaceId DelegatedFrameHost::SurfaceIdAtPoint(
 205     const gfx::Point& point,
 206     gfx::Point* transformed_point) {
 207   if (surface_id_.is_null())
 208     return surface_id_;
 209   cc::SurfaceHittest hittest(GetSurfaceManager());
 210   return hittest.GetTargetSurfaceAtPoint(surface_id_, point, transformed_point);
 211 }
 212
 213 bool DelegatedFrameHost::ShouldSkipFrame(gfx::Size size_in_dip) const {
 214   // Should skip a frame only when another frame from the renderer is guaranteed
 215   // to replace it. Otherwise may cause hangs when the renderer is waiting for
 216   // the completion of latency infos (such as when taking a Snapshot.)
 217   if (can_lock_compositor_ == NO_PENDING_RENDERER_FRAME ||
 218       can_lock_compositor_ == NO_PENDING_COMMIT ||
 219       !resize_lock_.get())
 220     return false;
 221
 222   return size_in_dip != resize_lock_->expected_size();
 223 }
 224
 225 void DelegatedFrameHost::WasResized() {
 226   if (client_->DelegatedFrameHostDesiredSizeInDIP() !=
 227           current_frame_size_in_dip_ &&
 228       !client_->DelegatedFrameHostIsVisible())
 229     EvictDelegatedFrame();
 230   MaybeCreateResizeLock();
 231 }
 232
 233 gfx::Size DelegatedFrameHost::GetRequestedRendererSize() const {
 234   if (resize_lock_)
 235     return resize_lock_->expected_size();
 236   else
 237     return client_->DelegatedFrameHostDesiredSizeInDIP();
 238 }
 239
 240 void DelegatedFrameHost::CheckResizeLock() {
 241   if (!resize_lock_ ||
 242       resize_lock_->expected_size() != current_frame_size_in_dip_)
 243     return;
 244
 245   // Since we got the size we were looking for, unlock the compositor. But delay
 246   // the release of the lock until we've kicked a frame with the new texture, to
 247   // avoid resizing the UI before we have a chance to draw a "good" frame.
 248   resize_lock_->UnlockCompositor();
 249 }
 250
 251 void DelegatedFrameHost::DidReceiveFrameFromRenderer(
 252     const gfx::Rect& damage_rect) {
 253   if (!frame_subscriber() || !CanCopyToVideoFrame())
 254     return;
 255
 256   const base::TimeTicks now = tick_clock_->NowTicks();
 257   base::TimeTicks present_time;
 258   if (vsync_interval_ <= base::TimeDelta()) {
 259     present_time = now;
 260   } else {
 261     const int64 intervals_elapsed = (now - vsync_timebase_) / vsync_interval_;
 262     present_time = vsync_timebase_ + (intervals_elapsed + 1) * vsync_interval_;
 263   }
 264
 265   scoped_refptr<media::VideoFrame> frame;
 266   RenderWidgetHostViewFrameSubscriber::DeliverFrameCallback callback;
 267   if (!frame_subscriber()->ShouldCaptureFrame(damage_rect, present_time,
 268                                               &frame, &callback))
 269     return;
 270
 271   // Get a texture to re-use; else, create a new one.
 272   scoped_refptr<OwnedMailbox> subscriber_texture;
 273   if (!idle_frame_subscriber_textures_.empty()) {
 274     subscriber_texture = idle_frame_subscriber_textures_.back();
 275     idle_frame_subscriber_textures_.pop_back();
 276   } else if (GLHelper* helper =
 277                  ImageTransportFactory::GetInstance()->GetGLHelper()) {
 278     subscriber_texture = new OwnedMailbox(helper);
 279   }
 280
 281   scoped_ptr<cc::CopyOutputRequest> request =
 282       cc::CopyOutputRequest::CreateRequest(base::Bind(
 283           &DelegatedFrameHost::CopyFromCompositingSurfaceHasResultForVideo,
 284           AsWeakPtr(),
 285           subscriber_texture,
 286           frame,
 287           base::Bind(callback, present_time)));
 288   // Setting the source in this copy request asks that the layer abort any prior
 289   // uncommitted copy requests made on behalf of the same frame subscriber.
 290   // This will not affect any of the copy requests spawned elsewhere from
 291   // DelegatedFrameHost (e.g., a call to CopyFromCompositingSurface() for
 292   // screenshots) since those copy requests do not specify |frame_subscriber()|
 293   // as a source.
 294   request->set_source(frame_subscriber());
 295   request->set_area(gfx::Rect(current_frame_size_in_dip_));
 296   if (subscriber_texture.get()) {
 297     request->SetTextureMailbox(
 298         cc::TextureMailbox(subscriber_texture->mailbox(),
 299                            subscriber_texture->target(),
 300                            subscriber_texture->sync_point()));
 301   }
 302   RequestCopyOfOutput(request.Pass());
 303 }
 304
 305 void DelegatedFrameHost::SwapDelegatedFrame(
 306     uint32 output_surface_id,
 307     scoped_ptr<cc::DelegatedFrameData> frame_data,
 308     float frame_device_scale_factor,
 309     const std::vector<ui::LatencyInfo>& latency_info,
 310     std::vector<uint32_t>* satisfies_sequences) {
 311   DCHECK(!frame_data->render_pass_list.empty());
 312
 313   cc::RenderPass* root_pass = frame_data->render_pass_list.back();
 314
 315   gfx::Size frame_size = root_pass->output_rect.size();
 316   gfx::Size frame_size_in_dip =
 317       gfx::ConvertSizeToDIP(frame_device_scale_factor, frame_size);
 318
 319   gfx::Rect damage_rect = root_pass->damage_rect;
 320   damage_rect.Intersect(gfx::Rect(frame_size));
 321   gfx::Rect damage_rect_in_dip =
 322       gfx::ConvertRectToDIP(frame_device_scale_factor, damage_rect);
 323
 324   if (ShouldSkipFrame(frame_size_in_dip)) {
 325     cc::CompositorFrameAck ack;
 326     cc::TransferableResource::ReturnResources(frame_data->resource_list,
 327                                               &ack.resources);
 328
 329     skipped_latency_info_list_.insert(skipped_latency_info_list_.end(),
 330         latency_info.begin(), latency_info.end());
 331
 332     client_->DelegatedFrameHostSendCompositorSwapAck(output_surface_id, ack);
 333     skipped_frames_ = true;
 334     return;
 335   }
 336
 337   if (skipped_frames_) {
 338     skipped_frames_ = false;
 339     damage_rect = gfx::Rect(frame_size);
 340     damage_rect_in_dip = gfx::Rect(frame_size_in_dip);
 341
 342     // Give the same damage rect to the compositor.
 343     cc::RenderPass* root_pass = frame_data->render_pass_list.back();
 344     root_pass->damage_rect = damage_rect;
 345   }
 346
 347   if (output_surface_id != last_output_surface_id_) {
 348     // Resource ids are scoped by the output surface.
 349     // If the originating output surface doesn't match the last one, it
 350     // indicates the renderer's output surface may have been recreated, in which
 351     // case we should recreate the DelegatedRendererLayer, to avoid matching
 352     // resources from the old one with resources from the new one which would
 353     // have the same id. Changing the layer to showing painted content destroys
 354     // the DelegatedRendererLayer.
 355     EvictDelegatedFrame();
 356
 357     surface_factory_.reset();
 358     if (!surface_returned_resources_.empty())
 359       SendReturnedDelegatedResources(last_output_surface_id_);
 360
 361     // Drop the cc::DelegatedFrameResourceCollection so that we will not return
 362     // any resources from the old output surface with the new output surface id.
 363     if (resource_collection_.get()) {
 364       resource_collection_->SetClient(NULL);
 365
 366       if (resource_collection_->LoseAllResources())
 367         SendReturnedDelegatedResources(last_output_surface_id_);
 368
 369       resource_collection_ = NULL;
 370     }
 371     last_output_surface_id_ = output_surface_id;
 372   }
 373   bool immediate_ack = !compositor_;
 374   pending_delegated_ack_count_++;
 375
 376   if (frame_size.IsEmpty()) {
 377     DCHECK(frame_data->resource_list.empty());
 378     EvictDelegatedFrame();
 379   } else {
 380     if (use_surfaces_) {
 381       ImageTransportFactory* factory = ImageTransportFactory::GetInstance();
 382       cc::SurfaceManager* manager = factory->GetSurfaceManager();
 383       if (!surface_factory_) {
 384         surface_factory_ =
 385             make_scoped_ptr(new cc::SurfaceFactory(manager, this));
 386       }
 387       if (surface_id_.is_null() || frame_size != current_surface_size_ ||
 388           frame_size_in_dip != current_frame_size_in_dip_) {
 389         if (!surface_id_.is_null())
 390           surface_factory_->Destroy(surface_id_);
 391         surface_id_ = id_allocator_->GenerateId();
 392         surface_factory_->Create(surface_id_);
 393         // manager must outlive compositors using it.
 394         client_->DelegatedFrameHostGetLayer()->SetShowSurface(
 395             surface_id_,
 396             base::Bind(&SatisfyCallback, base::Unretained(manager)),
 397             base::Bind(&RequireCallback, base::Unretained(manager)), frame_size,
 398             frame_device_scale_factor, frame_size_in_dip);
 399         current_surface_size_ = frame_size;
 400         current_scale_factor_ = frame_device_scale_factor;
 401       }
 402       scoped_ptr<cc::CompositorFrame> compositor_frame =
 403           make_scoped_ptr(new cc::CompositorFrame());
 404       compositor_frame->delegated_frame_data = frame_data.Pass();
 405
 406       compositor_frame->metadata.latency_info.swap(skipped_latency_info_list_);
 407       compositor_frame->metadata.latency_info.insert(
 408           compositor_frame->metadata.latency_info.end(),
 409           latency_info.begin(),
 410           latency_info.end());
 411       compositor_frame->metadata.satisfies_sequences.swap(*satisfies_sequences);
 412
 413       gfx::Size desired_size = client_->DelegatedFrameHostDesiredSizeInDIP();
 414       if (desired_size != frame_size_in_dip && !desired_size.IsEmpty())
 415         immediate_ack = true;
 416
 417       cc::SurfaceFactory::DrawCallback ack_callback;
 418       if (compositor_ && !immediate_ack) {
 419         ack_callback = base::Bind(&DelegatedFrameHost::SurfaceDrawn,
 420                                   AsWeakPtr(), output_surface_id);
 421       }
 422       surface_factory_->SubmitCompositorFrame(
 423           surface_id_, compositor_frame.Pass(), ack_callback);
 424     } else {
 425       if (!resource_collection_.get()) {
 426         resource_collection_ = new cc::DelegatedFrameResourceCollection;
 427         resource_collection_->SetClient(this);
 428       }
 429       // If the physical frame size changes, we need a new |frame_provider_|. If
 430       // the physical frame size is the same, but the size in DIP changed, we
 431       // need to adjust the scale at which the frames will be drawn, and we do
 432       // this by making a new |frame_provider_| also to ensure the scale change
 433       // is presented in sync with the new frame content.
 434       if (!frame_provider_.get() ||
 435           frame_size != frame_provider_->frame_size() ||
 436           frame_size_in_dip != current_frame_size_in_dip_) {
 437         frame_provider_ = new cc::DelegatedFrameProvider(
 438             resource_collection_.get(), frame_data.Pass());
 439         client_->DelegatedFrameHostGetLayer()->SetShowDelegatedContent(
 440             frame_provider_.get(), frame_size_in_dip);
 441       } else {
 442         frame_provider_->SetFrameData(frame_data.Pass());
 443       }
 444     }
 445   }
 446   released_front_lock_ = NULL;
 447   current_frame_size_in_dip_ = frame_size_in_dip;
 448   CheckResizeLock();
 449
 450   if (!damage_rect_in_dip.IsEmpty())
 451     client_->DelegatedFrameHostGetLayer()->OnDelegatedFrameDamage(
 452         damage_rect_in_dip);
 453
 454   if (immediate_ack) {
 455     SendDelegatedFrameAck(output_surface_id);
 456   } else if (!use_surfaces_) {
 457     std::vector<ui::LatencyInfo>::const_iterator it;
 458     for (it = latency_info.begin(); it != latency_info.end(); ++it)
 459       compositor_->SetLatencyInfo(*it);
 460     // If we've previously skipped any latency infos add them.
 461     for (it = skipped_latency_info_list_.begin();
 462         it != skipped_latency_info_list_.end();
 463         ++it)
 464       compositor_->SetLatencyInfo(*it);
 465     skipped_latency_info_list_.clear();
 466     AddOnCommitCallbackAndDisableLocks(
 467         base::Bind(&DelegatedFrameHost::SendDelegatedFrameAck,
 468                    AsWeakPtr(), output_surface_id));
 469   } else {
 470     AddOnCommitCallbackAndDisableLocks(base::Closure());
 471   }
 472   DidReceiveFrameFromRenderer(damage_rect);
 473   if (frame_provider_.get() || !surface_id_.is_null())
 474     delegated_frame_evictor_->SwappedFrame(
 475         client_->DelegatedFrameHostIsVisible());
 476   // Note: the frame may have been evicted immediately.
 477 }
 478
 479 void DelegatedFrameHost::ClearDelegatedFrame() {
 480   if (frame_provider_.get() || !surface_id_.is_null())
 481     EvictDelegatedFrame();
 482 }
 483
 484 void DelegatedFrameHost::SendDelegatedFrameAck(uint32 output_surface_id) {
 485   cc::CompositorFrameAck ack;
 486   if (!surface_returned_resources_.empty())
 487     ack.resources.swap(surface_returned_resources_);
 488   if (resource_collection_.get())
 489     resource_collection_->TakeUnusedResourcesForChildCompositor(&ack.resources);
 490   client_->DelegatedFrameHostSendCompositorSwapAck(output_surface_id, ack);
 491   DCHECK_GT(pending_delegated_ack_count_, 0);
 492   pending_delegated_ack_count_--;
 493 }
 494
 495 void DelegatedFrameHost::SurfaceDrawn(uint32 output_surface_id,
 496                                       cc::SurfaceDrawStatus drawn) {
 497   SendDelegatedFrameAck(output_surface_id);
 498 }
 499
 500 void DelegatedFrameHost::UnusedResourcesAreAvailable() {
 501   if (pending_delegated_ack_count_)
 502     return;
 503
 504   SendReturnedDelegatedResources(last_output_surface_id_);
 505 }
 506
 507 void DelegatedFrameHost::SendReturnedDelegatedResources(
 508     uint32 output_surface_id) {
 509   cc::CompositorFrameAck ack;
 510   if (!surface_returned_resources_.empty()) {
 511     ack.resources.swap(surface_returned_resources_);
 512   } else {
 513     DCHECK(resource_collection_.get());
 514     resource_collection_->TakeUnusedResourcesForChildCompositor(&ack.resources);
 515   }
 516   DCHECK(!ack.resources.empty());
 517
 518   client_->DelegatedFrameHostSendReclaimCompositorResources(output_surface_id,
 519                                                             ack);
 520 }
 521
 522 void DelegatedFrameHost::ReturnResources(
 523     const cc::ReturnedResourceArray& resources) {
 524   if (resources.empty())
 525     return;
 526   std::copy(resources.begin(),
 527             resources.end(),
 528             std::back_inserter(surface_returned_resources_));
 529   if (!pending_delegated_ack_count_)
 530     SendReturnedDelegatedResources(last_output_surface_id_);
 531 }
 532
 533 void DelegatedFrameHost::EvictDelegatedFrame() {
 534   client_->DelegatedFrameHostGetLayer()->SetShowSolidColorContent();
 535   frame_provider_ = NULL;
 536   if (!surface_id_.is_null()) {
 537     surface_factory_->Destroy(surface_id_);
 538     surface_id_ = cc::SurfaceId();
 539   }
 540   delegated_frame_evictor_->DiscardedFrame();
 541 }
 542
 543 // static
 544 void DelegatedFrameHost::CopyFromCompositingSurfaceHasResult(
 545     const gfx::Size& dst_size_in_pixel,
 546     const SkColorType color_type,
 547     ReadbackRequestCallback& callback,
 548     scoped_ptr<cc::CopyOutputResult> result) {
 549   if (result->IsEmpty() || result->size().IsEmpty()) {
 550     callback.Run(SkBitmap(), content::READBACK_FAILED);
 551     return;
 552   }
 553
 554   gfx::Size output_size_in_pixel;
 555   if (dst_size_in_pixel.IsEmpty())
 556     output_size_in_pixel = result->size();
 557   else
 558     output_size_in_pixel = dst_size_in_pixel;
 559
 560   if (result->HasTexture()) {
 561     // GPU-accelerated path
 562     PrepareTextureCopyOutputResult(output_size_in_pixel, color_type,
 563                                    callback,
 564                                    result.Pass());
 565     return;
 566   }
 567
 568   DCHECK(result->HasBitmap());
 569   // Software path
 570   PrepareBitmapCopyOutputResult(output_size_in_pixel, color_type, callback,
 571                                 result.Pass());
 572 }
 573
 574 static void CopyFromCompositingSurfaceFinished(
 575     ReadbackRequestCallback& callback,
 576     scoped_ptr<cc::SingleReleaseCallback> release_callback,
 577     scoped_ptr<SkBitmap> bitmap,
 578     scoped_ptr<SkAutoLockPixels> bitmap_pixels_lock,
 579     bool result) {
 580   bitmap_pixels_lock.reset();
 581
 582   uint32 sync_point = 0;
 583   if (result) {
 584     GLHelper* gl_helper = ImageTransportFactory::GetInstance()->GetGLHelper();
 585     if (gl_helper)
 586       sync_point = gl_helper->InsertSyncPoint();
 587   }
 588   bool lost_resource = sync_point == 0;
 589   release_callback->Run(sync_point, lost_resource);
 590
 591   callback.Run(*bitmap,
 592                result ? content::READBACK_SUCCESS : content::READBACK_FAILED);
 593 }
 594
 595 // static
 596 void DelegatedFrameHost::PrepareTextureCopyOutputResult(
 597     const gfx::Size& dst_size_in_pixel,
 598     const SkColorType color_type,
 599     ReadbackRequestCallback& callback,
 600     scoped_ptr<cc::CopyOutputResult> result) {
 601   DCHECK(result->HasTexture());
 602   base::ScopedClosureRunner scoped_callback_runner(
 603       base::Bind(callback, SkBitmap(), content::READBACK_FAILED));
 604
 605   // TODO(siva.gunturi): We should be able to validate the format here using
 606   // GLHelper::IsReadbackConfigSupported before we processs the result.
 607   // See crbug.com/415682 and crbug.com/415131.
 608   scoped_ptr<SkBitmap> bitmap(new SkBitmap);
 609   if (!bitmap->tryAllocPixels(SkImageInfo::Make(
 610           dst_size_in_pixel.width(), dst_size_in_pixel.height(), color_type,
 611           kOpaque_SkAlphaType))) {
 612     scoped_callback_runner.Reset(base::Bind(
 613         callback, SkBitmap(), content::READBACK_BITMAP_ALLOCATION_FAILURE));
 614     return;
 615   }
 616
 617   ImageTransportFactory* factory = ImageTransportFactory::GetInstance();
 618   GLHelper* gl_helper = factory->GetGLHelper();
 619   if (!gl_helper)
 620     return;
 621
 622   scoped_ptr<SkAutoLockPixels> bitmap_pixels_lock(
 623       new SkAutoLockPixels(*bitmap));
 624   uint8* pixels = static_cast<uint8*>(bitmap->getPixels());
 625
 626   cc::TextureMailbox texture_mailbox;
 627   scoped_ptr<cc::SingleReleaseCallback> release_callback;
 628   result->TakeTexture(&texture_mailbox, &release_callback);
 629   DCHECK(texture_mailbox.IsTexture());
 630
 631   ignore_result(scoped_callback_runner.Release());
 632
 633   gl_helper->CropScaleReadbackAndCleanMailbox(
 634       texture_mailbox.mailbox(),
 635       texture_mailbox.sync_point(),
 636       result->size(),
 637       gfx::Rect(result->size()),
 638       dst_size_in_pixel,
 639       pixels,
 640       color_type,
 641       base::Bind(&CopyFromCompositingSurfaceFinished,
 642                  callback,
 643                  base::Passed(&release_callback),
 644                  base::Passed(&bitmap),
 645                  base::Passed(&bitmap_pixels_lock)),
 646       GLHelper::SCALER_QUALITY_GOOD);
 647 }
 648
 649 // static
 650 void DelegatedFrameHost::PrepareBitmapCopyOutputResult(
 651     const gfx::Size& dst_size_in_pixel,
 652     const SkColorType preferred_color_type,
 653     ReadbackRequestCallback& callback,
 654     scoped_ptr<cc::CopyOutputResult> result) {
 655   SkColorType color_type = preferred_color_type;
 656   if (color_type != kN32_SkColorType && color_type != kAlpha_8_SkColorType) {
 657     // Switch back to default colortype if format not supported.
 658     color_type = kN32_SkColorType;
 659   }
 660   DCHECK(result->HasBitmap());
 661   scoped_ptr<SkBitmap> source = result->TakeBitmap();
 662   DCHECK(source);
 663   SkBitmap scaled_bitmap;
 664   if (source->width() != dst_size_in_pixel.width() ||
 665       source->height() != dst_size_in_pixel.height()) {
 666     scaled_bitmap =
 667         skia::ImageOperations::Resize(*source,
 668                                       skia::ImageOperations::RESIZE_BEST,
 669                                       dst_size_in_pixel.width(),
 670                                       dst_size_in_pixel.height());
 671   } else {
 672     scaled_bitmap = *source;
 673   }
 674   if (color_type == kN32_SkColorType) {
 675     DCHECK_EQ(scaled_bitmap.colorType(), kN32_SkColorType);
 676     callback.Run(scaled_bitmap, READBACK_SUCCESS);
 677     return;
 678   }
 679   DCHECK_EQ(color_type, kAlpha_8_SkColorType);
 680   // The software path currently always returns N32 bitmap regardless of the
 681   // |color_type| we ask for.
 682   DCHECK_EQ(scaled_bitmap.colorType(), kN32_SkColorType);
 683   // Paint |scaledBitmap| to alpha-only |grayscale_bitmap|.
 684   SkBitmap grayscale_bitmap;
 685   bool success = grayscale_bitmap.tryAllocPixels(
 686       SkImageInfo::MakeA8(scaled_bitmap.width(), scaled_bitmap.height()));
 687   if (!success) {
 688     callback.Run(SkBitmap(), content::READBACK_BITMAP_ALLOCATION_FAILURE);
 689     return;
 690   }
 691   SkCanvas canvas(grayscale_bitmap);
 692   SkPaint paint;
 693   skia::RefPtr<SkColorFilter> filter =
 694       skia::AdoptRef(SkLumaColorFilter::Create());
 695   paint.setColorFilter(filter.get());
 696   canvas.drawBitmap(scaled_bitmap, SkIntToScalar(0), SkIntToScalar(0), &paint);
 697   callback.Run(grayscale_bitmap, READBACK_SUCCESS);
 698 }
 699
 700 // static
 701 void DelegatedFrameHost::ReturnSubscriberTexture(
 702     base::WeakPtr<DelegatedFrameHost> dfh,
 703     scoped_refptr<OwnedMailbox> subscriber_texture,
 704     uint32 sync_point) {
 705   if (!subscriber_texture.get())
 706     return;
 707   if (!dfh)
 708     return;
 709
 710   subscriber_texture->UpdateSyncPoint(sync_point);
 711
 712   if (dfh->frame_subscriber_ && subscriber_texture->texture_id())
 713     dfh->idle_frame_subscriber_textures_.push_back(subscriber_texture);
 714 }
 715
 716 // static
 717 void DelegatedFrameHost::CopyFromCompositingSurfaceFinishedForVideo(
 718     base::WeakPtr<DelegatedFrameHost> dfh,
 719     const base::Callback<void(bool)>& callback,
 720     scoped_refptr<OwnedMailbox> subscriber_texture,
 721     scoped_ptr<cc::SingleReleaseCallback> release_callback,
 722     bool result) {
 723   callback.Run(result);
 724
 725   uint32 sync_point = 0;
 726   if (result) {
 727     GLHelper* gl_helper = ImageTransportFactory::GetInstance()->GetGLHelper();
 728     sync_point = gl_helper->InsertSyncPoint();
 729   }
 730   if (release_callback) {
 731     // A release callback means the texture came from the compositor, so there
 732     // should be no |subscriber_texture|.
 733     DCHECK(!subscriber_texture.get());
 734     bool lost_resource = sync_point == 0;
 735     release_callback->Run(sync_point, lost_resource);
 736   }
 737   ReturnSubscriberTexture(dfh, subscriber_texture, sync_point);
 738 }
 739
 740 // static
 741 void DelegatedFrameHost::CopyFromCompositingSurfaceHasResultForVideo(
 742     base::WeakPtr<DelegatedFrameHost> dfh,
 743     scoped_refptr<OwnedMailbox> subscriber_texture,
 744     scoped_refptr<media::VideoFrame> video_frame,
 745     const base::Callback<void(bool)>& callback,
 746     scoped_ptr<cc::CopyOutputResult> result) {
 747   base::ScopedClosureRunner scoped_callback_runner(base::Bind(callback, false));
 748   base::ScopedClosureRunner scoped_return_subscriber_texture(
 749       base::Bind(&ReturnSubscriberTexture, dfh, subscriber_texture, 0));
 750
 751   if (!dfh)
 752     return;
 753   if (result->IsEmpty())
 754     return;
 755   if (result->size().IsEmpty())
 756     return;
 757
 758   // Compute the dest size we want after the letterboxing resize. Make the
 759   // coordinates and sizes even because we letterbox in YUV space
 760   // (see CopyRGBToVideoFrame). They need to be even for the UV samples to
 761   // line up correctly.
 762   // The video frame's visible_rect() and the result's size() are both physical
 763   // pixels.
 764   gfx::Rect region_in_frame = media::ComputeLetterboxRegion(
 765       video_frame->visible_rect(), result->size());
 766   region_in_frame = gfx::Rect(region_in_frame.x() & ~1,
 767                               region_in_frame.y() & ~1,
 768                               region_in_frame.width() & ~1,
 769                               region_in_frame.height() & ~1);
 770   if (region_in_frame.IsEmpty())
 771     return;
 772
 773   if (!result->HasTexture()) {
 774     DCHECK(result->HasBitmap());
 775     scoped_ptr<SkBitmap> bitmap = result->TakeBitmap();
 776     // Scale the bitmap to the required size, if necessary.
 777     SkBitmap scaled_bitmap;
 778     if (result->size() != region_in_frame.size()) {
 779       skia::ImageOperations::ResizeMethod method =
 780           skia::ImageOperations::RESIZE_GOOD;
 781       scaled_bitmap = skia::ImageOperations::Resize(*bitmap.get(), method,
 782                                                     region_in_frame.width(),
 783                                                     region_in_frame.height());
 784     } else {
 785       scaled_bitmap = *bitmap.get();
 786     }
 787
 788     {
 789       SkAutoLockPixels scaled_bitmap_locker(scaled_bitmap);
 790
 791       media::CopyRGBToVideoFrame(
 792           reinterpret_cast<uint8*>(scaled_bitmap.getPixels()),
 793           scaled_bitmap.rowBytes(),
 794           region_in_frame,
 795           video_frame.get());
 796     }
 797     ignore_result(scoped_callback_runner.Release());
 798     callback.Run(true);
 799     return;
 800   }
 801
 802   ImageTransportFactory* factory = ImageTransportFactory::GetInstance();
 803   GLHelper* gl_helper = factory->GetGLHelper();
 804   if (!gl_helper)
 805     return;
 806   if (subscriber_texture.get() && !subscriber_texture->texture_id())
 807     return;
 808
 809   cc::TextureMailbox texture_mailbox;
 810   scoped_ptr<cc::SingleReleaseCallback> release_callback;
 811   result->TakeTexture(&texture_mailbox, &release_callback);
 812   DCHECK(texture_mailbox.IsTexture());
 813
 814   gfx::Rect result_rect(result->size());
 815
 816   content::ReadbackYUVInterface* yuv_readback_pipeline =
 817       dfh->yuv_readback_pipeline_.get();
 818   if (yuv_readback_pipeline == NULL ||
 819       yuv_readback_pipeline->scaler()->SrcSize() != result_rect.size() ||
 820       yuv_readback_pipeline->scaler()->SrcSubrect() != result_rect ||
 821       yuv_readback_pipeline->scaler()->DstSize() != region_in_frame.size()) {
 822     GLHelper::ScalerQuality quality = GLHelper::SCALER_QUALITY_FAST;
 823     std::string quality_switch = switches::kTabCaptureDownscaleQuality;
 824     // If we're scaling up, we can use the "best" quality.
 825     if (result_rect.size().width() < region_in_frame.size().width() &&
 826         result_rect.size().height() < region_in_frame.size().height())
 827       quality_switch = switches::kTabCaptureUpscaleQuality;
 828
 829     std::string switch_value =
 830         base::CommandLine::ForCurrentProcess()->GetSwitchValueASCII(
 831             quality_switch);
 832     if (switch_value == "fast")
 833       quality = GLHelper::SCALER_QUALITY_FAST;
 834     else if (switch_value == "good")
 835       quality = GLHelper::SCALER_QUALITY_GOOD;
 836     else if (switch_value == "best")
 837       quality = GLHelper::SCALER_QUALITY_BEST;
 838
 839     dfh->yuv_readback_pipeline_.reset(
 840         gl_helper->CreateReadbackPipelineYUV(quality,
 841                                              result_rect.size(),
 842                                              result_rect,
 843                                              region_in_frame.size(),
 844                                              true,
 845                                              true));
 846     yuv_readback_pipeline = dfh->yuv_readback_pipeline_.get();
 847   }
 848
 849   ignore_result(scoped_callback_runner.Release());
 850   ignore_result(scoped_return_subscriber_texture.Release());
 851   base::Callback<void(bool result)> finished_callback = base::Bind(
 852       &DelegatedFrameHost::CopyFromCompositingSurfaceFinishedForVideo,
 853       dfh->AsWeakPtr(),
 854       callback,
 855       subscriber_texture,
 856       base::Passed(&release_callback));
 857   yuv_readback_pipeline->ReadbackYUV(texture_mailbox.mailbox(),
 858                                      texture_mailbox.sync_point(),
 859                                      video_frame.get(),
 860                                      region_in_frame.origin(),
 861                                      finished_callback);
 862 }
 863
 864 ////////////////////////////////////////////////////////////////////////////////
 865 // DelegatedFrameHost, ui::CompositorObserver implementation:
 866
 867 void DelegatedFrameHost::OnCompositingDidCommit(
 868     ui::Compositor* compositor) {
 869   if (can_lock_compositor_ == NO_PENDING_COMMIT) {
 870     can_lock_compositor_ = YES_CAN_LOCK;
 871     if (resize_lock_.get() && resize_lock_->GrabDeferredLock())
 872       can_lock_compositor_ = YES_DID_LOCK;
 873   }
 874   RunOnCommitCallbacks();
 875   if (resize_lock_ &&
 876       resize_lock_->expected_size() == current_frame_size_in_dip_) {
 877     resize_lock_.reset();
 878     client_->DelegatedFrameHostResizeLockWasReleased();
 879     // We may have had a resize while we had the lock (e.g. if the lock expired,
 880     // or if the UI still gave us some resizes), so make sure we grab a new lock
 881     // if necessary.
 882     MaybeCreateResizeLock();
 883   }
 884 }
 885
 886 void DelegatedFrameHost::OnCompositingStarted(
 887     ui::Compositor* compositor, base::TimeTicks start_time) {
 888   last_draw_ended_ = start_time;
 889 }
 890
 891 void DelegatedFrameHost::OnCompositingEnded(
 892     ui::Compositor* compositor) {
 893 }
 894
 895 void DelegatedFrameHost::OnCompositingAborted(ui::Compositor* compositor) {
 896 }
 897
 898 void DelegatedFrameHost::OnCompositingLockStateChanged(
 899     ui::Compositor* compositor) {
 900   // A compositor lock that is part of a resize lock timed out. We
 901   // should display a renderer frame.
 902   if (!compositor->IsLocked() && can_lock_compositor_ == YES_DID_LOCK) {
 903     can_lock_compositor_ = NO_PENDING_RENDERER_FRAME;
 904   }
 905 }
 906
 907 void DelegatedFrameHost::OnCompositingShuttingDown(ui::Compositor* compositor) {
 908   DCHECK_EQ(compositor, compositor_);
 909   ResetCompositor();
 910   DCHECK(!compositor_);
 911 }
 912
 913 void DelegatedFrameHost::OnUpdateVSyncParameters(
 914     base::TimeTicks timebase,
 915     base::TimeDelta interval) {
 916   SetVSyncParameters(timebase, interval);
 917   if (client_->DelegatedFrameHostIsVisible())
 918     client_->DelegatedFrameHostUpdateVSyncParameters(timebase, interval);
 919 }
 920
 921 ////////////////////////////////////////////////////////////////////////////////
 922 // DelegatedFrameHost, ImageTransportFactoryObserver implementation:
 923
 924 void DelegatedFrameHost::OnLostResources() {
 925   if (frame_provider_.get() || !surface_id_.is_null())
 926     EvictDelegatedFrame();
 927   idle_frame_subscriber_textures_.clear();
 928   yuv_readback_pipeline_.reset();
 929
 930   client_->DelegatedFrameHostOnLostCompositorResources();
 931 }
 932
 933 ////////////////////////////////////////////////////////////////////////////////
 934 // DelegatedFrameHost, private:
 935
 936 DelegatedFrameHost::~DelegatedFrameHost() {
 937   DCHECK(!compositor_);
 938   ImageTransportFactory::GetInstance()->RemoveObserver(this);
 939
 940   if (!surface_id_.is_null())
 941     surface_factory_->Destroy(surface_id_);
 942   if (resource_collection_.get())
 943     resource_collection_->SetClient(NULL);
 944
 945   DCHECK(!vsync_manager_.get());
 946 }
 947
 948 void DelegatedFrameHost::RunOnCommitCallbacks() {
 949   for (std::vector<base::Closure>::const_iterator
 950       it = on_compositing_did_commit_callbacks_.begin();
 951       it != on_compositing_did_commit_callbacks_.end(); ++it) {
 952     it->Run();
 953   }
 954   on_compositing_did_commit_callbacks_.clear();
 955 }
 956
 957 void DelegatedFrameHost::AddOnCommitCallbackAndDisableLocks(
 958     const base::Closure& callback) {
 959   DCHECK(compositor_);
 960
 961   can_lock_compositor_ = NO_PENDING_COMMIT;
 962   if (!callback.is_null())
 963     on_compositing_did_commit_callbacks_.push_back(callback);
 964 }
 965
 966 void DelegatedFrameHost::SetCompositor(ui::Compositor* compositor) {
 967   DCHECK(!compositor_);
 968   if (!compositor)
 969     return;
 970   compositor_ = compositor;
 971   compositor_->AddObserver(this);
 972   DCHECK(!vsync_manager_.get());
 973   vsync_manager_ = compositor_->vsync_manager();
 974   vsync_manager_->AddObserver(this);
 975 }
 976
 977 void DelegatedFrameHost::ResetCompositor() {
 978   if (!compositor_)
 979     return;
 980   RunOnCommitCallbacks();
 981   if (resize_lock_) {
 982     resize_lock_.reset();
 983     client_->DelegatedFrameHostResizeLockWasReleased();
 984   }
 985   if (compositor_->HasObserver(this))
 986     compositor_->RemoveObserver(this);
 987   if (vsync_manager_.get()) {
 988     vsync_manager_->RemoveObserver(this);
 989     vsync_manager_ = NULL;
 990   }
 991   compositor_ = nullptr;
 992 }
 993
 994 void DelegatedFrameHost::SetVSyncParameters(const base::TimeTicks& timebase,
 995                                             const base::TimeDelta& interval) {
 996   vsync_timebase_ = timebase;
 997   vsync_interval_ = interval;
 998 }
 999
1000 void DelegatedFrameHost::LockResources() {
1001   DCHECK(frame_provider_.get() || !surface_id_.is_null());
1002   delegated_frame_evictor_->LockFrame();
1003 }
1004
1005 void DelegatedFrameHost::RequestCopyOfOutput(
1006     scoped_ptr<cc::CopyOutputRequest> request) {
1007   if (!request_copy_of_output_callback_for_testing_.is_null())
1008     request_copy_of_output_callback_for_testing_.Run(request.Pass());
1009   else
1010     client_->DelegatedFrameHostGetLayer()->RequestCopyOfOutput(request.Pass());
1011 }
1012
1013 void DelegatedFrameHost::UnlockResources() {
1014   DCHECK(frame_provider_.get() || !surface_id_.is_null());
1015   delegated_frame_evictor_->UnlockFrame();
1016 }
1017
1018 ////////////////////////////////////////////////////////////////////////////////
1019 // DelegatedFrameHost, ui::LayerOwnerDelegate implementation:
1020
1021 void DelegatedFrameHost::OnLayerRecreated(ui::Layer* old_layer,
1022                                                 ui::Layer* new_layer) {
1023   // The new_layer is the one that will be used by our Window, so that's the one
1024   // that should keep our frame. old_layer will be returned to the
1025   // RecreateLayer caller, and should have a copy.
1026   if (frame_provider_.get()) {
1027     new_layer->SetShowDelegatedContent(frame_provider_.get(),
1028                                        current_frame_size_in_dip_);
1029   }
1030   if (!surface_id_.is_null()) {
1031     ImageTransportFactory* factory = ImageTransportFactory::GetInstance();
1032     cc::SurfaceManager* manager = factory->GetSurfaceManager();
1033     new_layer->SetShowSurface(
1034         surface_id_, base::Bind(&SatisfyCallback, base::Unretained(manager)),
1035         base::Bind(&RequireCallback, base::Unretained(manager)),
1036         current_surface_size_, current_scale_factor_,
1037         current_frame_size_in_dip_);
1038   }
1039 }
1040
1041 }  // namespace content