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