| OLD | NEW |
| 1 // Copyright (c) 2015 The Chromium Authors. All rights reserved. | 1 // Copyright 2015 The Chromium Authors. All rights reserved. |
| 2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
| 3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
| 4 | 4 |
| 5 #ifndef MEDIA_VIDEO_CAPTURE_VIDEO_CAPTURER_SOURCE_H_ | 5 #ifndef MEDIA_BASE_VIDEO_CAPTURER_SOURCE_H_ |
| 6 #define MEDIA_VIDEO_CAPTURE_VIDEO_CAPTURER_SOURCE_H_ | 6 #define MEDIA_BASE_VIDEO_CAPTURER_SOURCE_H_ |
| 7 | 7 |
| 8 #include <string> | 8 #include "base/callback.h" |
| 9 #include <vector> | |
| 10 | |
| 11 #include "base/basictypes.h" | |
| 12 #include "base/memory/ref_counted.h" | 9 #include "base/memory/ref_counted.h" |
| 13 #include "base/single_thread_task_runner.h" | |
| 14 #include "media/base/media_export.h" | 10 #include "media/base/media_export.h" |
| 15 #include "media/base/video_capture_types.h" | 11 #include "media/base/video_capture_types.h" |
| 16 #include "media/base/video_frame.h" | 12 |
| 13 namespace base { |
| 14 class SingleThreadTaskRunner; |
| 15 } // namespace base |
| 17 | 16 |
| 18 namespace media { | 17 namespace media { |
| 19 | 18 |
| 19 class VideoFrame; |
| 20 |
| 20 // VideoCapturerSource is an interface representing the source for | 21 // VideoCapturerSource is an interface representing the source for |
| 21 // captured video. An implementation will periodically call the frame | 22 // captured video. An implementation will periodically call the frame |
| 22 // callback with new video frames. | 23 // callback with new video frames. |
| 23 class MEDIA_EXPORT VideoCapturerSource { | 24 class MEDIA_EXPORT VideoCapturerSource { |
| 24 public: | 25 public: |
| 25 virtual ~VideoCapturerSource(); | 26 virtual ~VideoCapturerSource() = default; |
| 26 | 27 |
| 27 // This callback is used to deliver video frames. | 28 // This callback is used to deliver video frames. |
| 28 // | 29 // |
| 29 // |estimated_capture_time| - The capture time of the delivered video | 30 // |estimated_capture_time| - The capture time of the delivered video |
| 30 // frame. This field represents the local time at which either: 1) the frame | 31 // frame. This field represents the local time at which either: 1) the frame |
| 31 // was generated, if it was done so locally; or 2) the targeted play-out time | 32 // was generated, if it was done so locally; or 2) the targeted play-out time |
| 32 // of the frame, if it was generated from a remote source. Either way, an | 33 // of the frame, if it was generated from a remote source. Either way, an |
| 33 // implementation should not present the frame before this point-in-time. This | 34 // implementation should not present the frame before this point-in-time. This |
| 34 // value is NOT a high-resolution timestamp, and so it should not be used as a | 35 // value is NOT a high-resolution timestamp, and so it should not be used as a |
| 35 // presentation time; but, instead, it should be used for buffering playback | 36 // presentation time; but, instead, it should be used for buffering playback |
| 36 // and for A/V synchronization purposes. NOTE: It is possible for this value | 37 // and for A/V synchronization purposes. NOTE: It is possible for this value |
| 37 // to be null if the current implementation lacks this timing information. | 38 // to be null if the current implementation lacks this timing information. |
| 38 // | 39 // |
| 39 // |video_frame->timestamp()| gives the presentation timestamp of the video | 40 // |video_frame->timestamp()| gives the presentation timestamp of the video |
| 40 // frame relative to the first frame generated by the corresponding source. | 41 // frame relative to the first frame generated by the corresponding source. |
| 41 // Because a source can start generating frames before a subscriber is added, | 42 // Because a source can start generating frames before a subscriber is added, |
| 42 // the first video frame delivered may not have timestamp equal to 0. | 43 // the first video frame delivered may not have timestamp equal to 0. |
| 43 typedef base::Callback<void( | 44 using VideoCaptureDeliverFrameCB = |
| 44 const scoped_refptr<media::VideoFrame>& video_frame, | 45 base::Callback<void(const scoped_refptr<media::VideoFrame>& video_frame, |
| 45 base::TimeTicks estimated_capture_time)> VideoCaptureDeliverFrameCB; | 46 base::TimeTicks estimated_capture_time)>; |
| 46 | 47 |
| 47 typedef base::Callback<void(const media::VideoCaptureFormats&)> | 48 using VideoCaptureDeviceFormatsCB = |
| 48 VideoCaptureDeviceFormatsCB; | 49 base::Callback<void(const VideoCaptureFormats&)>; |
| 49 | 50 |
| 50 typedef base::Callback<void(bool)> RunningCallback; | 51 using RunningCallback = base::Callback<void(bool)>; |
| 51 | 52 |
| 52 // Collects the formats that can currently be used. | 53 // Collects the formats that can currently be used. |
| 53 // |max_requested_height|, |max_requested_width|, and | 54 // |max_requested_height|, |max_requested_width|, and |
| 54 // |max_requested_frame_rate| is used by Tab and Screen capture to decide what | 55 // |max_requested_frame_rate| is used by Tab and Screen capture to decide what |
| 55 // resolution/framerate to generate. |callback| is triggered when the formats | 56 // resolution/framerate to generate. |callback| is triggered when the formats |
| 56 // have been collected. | 57 // have been collected. |
| 57 virtual void GetCurrentSupportedFormats( | 58 virtual void GetCurrentSupportedFormats( |
| 58 int max_requested_width, | 59 int max_requested_width, |
| 59 int max_requested_height, | 60 int max_requested_height, |
| 60 double max_requested_frame_rate, | 61 double max_requested_frame_rate, |
| 61 const VideoCaptureDeviceFormatsCB& callback) = 0; | 62 const VideoCaptureDeviceFormatsCB& callback) = 0; |
| 62 | 63 |
| 63 // Starts capturing frames using the resolution in |params|. | 64 // Starts capturing frames using the resolution in |params|. |
| 64 // |new_frame_callback| is triggered on |frame_callback_task_runner| | 65 // |new_frame_callback| is triggered on |frame_callback_task_runner| |
| 65 // when a new video frame is available. | 66 // when a new video frame is available. |
| 66 // If capturing is started successfully then |running_callback| will be | 67 // If capturing is started successfully then |running_callback| will be |
| 67 // called with a parameter of true. Note that some implementations may | 68 // called with a parameter of true. Note that some implementations may |
| 68 // simply reject StartCapture (by calling running_callback with a false | 69 // simply reject StartCapture (by calling running_callback with a false |
| 69 // argument) if called with the wrong task runner. | 70 // argument) if called with the wrong task runner. |
| 70 // If capturing fails to start or stopped due to an external event then | 71 // If capturing fails to start or stopped due to an external event then |
| 71 // |running_callback| will be called with a parameter of false. | 72 // |running_callback| will be called with a parameter of false. |
| 72 // |running_callback| will always be called on the same thread as the | 73 // |running_callback| will always be called on the same thread as the |
| 73 // StartCapture. | 74 // StartCapture. |
| 74 virtual void StartCapture( | 75 virtual void StartCapture( |
| 75 const media::VideoCaptureParams& params, | 76 const VideoCaptureParams& params, |
| 76 const VideoCaptureDeliverFrameCB& new_frame_callback, | 77 const VideoCaptureDeliverFrameCB& new_frame_callback, |
| 77 scoped_refptr<base::SingleThreadTaskRunner> frame_callback_task_runner, | 78 scoped_refptr<base::SingleThreadTaskRunner> frame_callback_task_runner, |
| 78 const RunningCallback& running_callback) = 0; | 79 const RunningCallback& running_callback) = 0; |
| 79 | 80 |
| 80 // Stops capturing frames and clears all callbacks including the | 81 // Stops capturing frames and clears all callbacks including the |
| 81 // SupportedFormatsCallback callback. Note that queued frame callbacks | 82 // SupportedFormatsCallback callback. Note that queued frame callbacks |
| 82 // may still occur after this call, so the caller must take care to | 83 // may still occur after this call, so the caller must take care to |
| 83 // use refcounted or weak references in |new_frame_callback|. | 84 // use refcounted or weak references in |new_frame_callback|. |
| 84 virtual void StopCapture() = 0; | 85 virtual void StopCapture() = 0; |
| 85 }; | 86 }; |
| 86 | 87 |
| 87 } // namespace media | 88 } // namespace media |
| 88 | 89 |
| 89 #endif // MEDIA_VIDEO_CAPTURE_VIDEO_CAPTURER_SOURCE_H_ | 90 #endif // MEDIA_BASE_VIDEO_CAPTURER_SOURCE_H_ |
| OLD | NEW |