| OLD | NEW |
| (Empty) |
| 1 // Copyright (c) 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 CONTENT_PUBLIC_BROWSER_RENDER_WIDGET_HOST_VIEW_FRAME_SUBSCRIBER_H_ | |
| 6 #define CONTENT_PUBLIC_BROWSER_RENDER_WIDGET_HOST_VIEW_FRAME_SUBSCRIBER_H_ | |
| 7 | |
| 8 #include "base/callback.h" | |
| 9 #include "base/time/time.h" | |
| 10 | |
| 11 namespace gfx { | |
| 12 class Rect; | |
| 13 } // namespace gfx | |
| 14 | |
| 15 namespace media { | |
| 16 class VideoFrame; | |
| 17 } // namespace media | |
| 18 | |
| 19 namespace content { | |
| 20 | |
| 21 // Defines an interface for listening to events of frame presentation and to | |
| 22 // instruct the platform layer (i.e. RenderWidgetHostView) to copy a frame. | |
| 23 // | |
| 24 // Further processing is possible (e.g. scale and color space conversion) | |
| 25 // through this interface. See ShouldCaptureFrame() for details. | |
| 26 // | |
| 27 // It is platform dependent which thread this object lives on, but it is | |
| 28 // guaranteed to be used on a single thread. | |
| 29 class RenderWidgetHostViewFrameSubscriber { | |
| 30 public: | |
| 31 virtual ~RenderWidgetHostViewFrameSubscriber() {} | |
| 32 | |
| 33 // Called when a captured frame is available or the frame is no longer | |
| 34 // needed by the platform layer. | |
| 35 // | |
| 36 // If |frame_captured| is true then frame provided contains valid content and | |
| 37 // |timestamp| is the time when the frame was painted. | |
| 38 // | |
| 39 // If |frame_captured| is false then the content in frame provided is | |
| 40 // invalid. There was an error during the process of frame capture or the | |
| 41 // platform layer is shutting down. |timestamp| is also invalid in this case. | |
| 42 // | |
| 43 // |region_in_frame| is the location within the Videoframe where the | |
| 44 // captured content resides, with the rest of the VideoFrame blacked out. | |
| 45 typedef base::Callback<void(base::TimeTicks /* timestamp */, | |
| 46 const gfx::Rect& /* region_in_frame */, | |
| 47 bool /* frame_captured */)> DeliverFrameCallback; | |
| 48 | |
| 49 // Called when a new frame is going to be presented at time | |
| 50 // |present_time| with |damage_rect| being the region of the frame that has | |
| 51 // changed since the last frame. The implementation decides whether the | |
| 52 // current frame should be captured or not. | |
| 53 // | |
| 54 // Return true if the current frame should be captured. If so, |storage| | |
| 55 // will be set to hold an appropriately sized and allocated buffer into which | |
| 56 // to copy the frame. The platform presenter will perform scaling and color | |
| 57 // space conversion to fit into the output frame. | |
| 58 // | |
| 59 // Destination format is determined by |storage|, currently only | |
| 60 // media::PIXEL_FORMAT_YV12 is supported. Platform layer will perform color | |
| 61 // space conversion if needed. | |
| 62 // | |
| 63 // When the frame is available |callback| will be called. It is up to the | |
| 64 // platform layer to decide when to deliver a captured frame. | |
| 65 // | |
| 66 // Return false if the current frame should not be captured. | |
| 67 virtual bool ShouldCaptureFrame(const gfx::Rect& damage_rect, | |
| 68 base::TimeTicks present_time, | |
| 69 scoped_refptr<media::VideoFrame>* storage, | |
| 70 DeliverFrameCallback* callback) = 0; | |
| 71 }; | |
| 72 | |
| 73 } // namespace content | |
| 74 | |
| 75 #endif // CONTENT_PUBLIC_BROWSER_RENDER_WIDGET_HOST_VIEW_FRAME_SUBSCRIBER_H_ | |
| OLD | NEW |