Introduce NullVideoSink for test classes.

media/base/null_video_sink.h

+// Copyright 2015 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+#ifndef MEDIA_AUDIO_NULL_VIDEO_SINK_H_
+#define MEDIA_AUDIO_NULL_VIDEO_SINK_H_
+
+#include "base/cancelable_callback.h"
+#include "base/md5.h"
+#include "base/memory/scoped_ptr.h"
+#include "base/time/default_tick_clock.h"
+#include "base/time/tick_clock.h"
+#include "media/base/video_renderer_sink.h"
+
+namespace base {
+class SingleThreadTaskRunner;
+}
+
+namespace media {
+
+class MEDIA_EXPORT NullVideoSink : NON_EXPORTED_BASE(public VideoRendererSink) {
+ public:
+  using NewFrameCB = base::Callback<void(const scoped_refptr<VideoFrame>&)>;
+
+  // Periodically calls |callback| every |interval| on |task_runner| once the
+  // sink has been started.  If |clockless| is true, the RenderCallback will
+  // called back to back by repeated post tasks. Optionally, if specified,

[xhwang, 2015/04/28 23:12:06]

s/called/be called/

[DaleCurtis, 2015/04/29 00:54:07]

Done.

+  // |new_frame_cb| will be called for each new frame received.
+  NullVideoSink(bool clockless,
+                base::TimeDelta interval,
+                const NewFrameCB& new_frame_cb,
+                const scoped_refptr<base::SingleThreadTaskRunner>& task_runner);
+  ~NullVideoSink() override;
+
+  // VideoRendererSink implementation.
+  void Start(RenderCallback* callback) override;
+  void Stop() override;
+  void PaintFrameUsingOldRenderingPath(
+      const scoped_refptr<VideoFrame>& frame) override;
+
+  // Allows tests to simulate suspension of Render() callbacks.
+  void pause_callbacks(base::TimeTicks pause_util) {

[xhwang, 2015/04/28 23:12:06]

s/pause_callbacks/PauseRenderCallbacks/?

[DaleCurtis, 2015/04/29 00:54:07]

Done.

+    pause_end_time_ = pause_util;
+  }
+
+  void set_tick_clock_for_testing(base::TickClock* tick_clock) {

[xhwang, 2015/04/28 23:12:06]

Use SetTickClockForTesting() since this is not strictly a simple setter (due to
the ForTesting part). Also, it's more consistent with other instances of this:

https://code.google.com/p/chromium/codesearch#search/&q=SetTickClockForTestin...

[xhwang, 2015/04/28 23:12:06]

Put comments here since this is the public interface.

[DaleCurtis, 2015/04/29 00:54:07]

That doesn't apply to this case, the reason being that in the VRI tests we need
a single tick clock instance to be used by both NullVideoSink and VRI, both
can't have ownership of the tick clock :)

As such, this is a raw pointer and can be a hacker_style() method with a simple
setter.

+    tick_clock_ = tick_clock;
+  }
+
+  void set_stop_callback(const base::Closure& stop_cb) {

[xhwang, 2015/04/28 23:12:06]

set_stop_cb? Also add comment. It's not clear unless I look at the comment above
|stop_cb_|.

[DaleCurtis, 2015/04/29 00:54:07]

I prefer it spelled out for a method name. Added a comment though.

+    stop_cb_ = stop_cb;
+  }
+
+ private:
+  // Task that periodically calls Render() to consume audio data.

[xhwang, 2015/04/28 23:12:06]

s/audio/video

[DaleCurtis, 2015/04/29 00:54:07]

Done.

+  void CallRender();
+
+  const bool clockless_;
+  const base::TimeDelta interval_;
+  const NewFrameCB new_frame_cb_;
+  scoped_refptr<base::SingleThreadTaskRunner> task_runner_;
+
+  bool started_;
+  RenderCallback* callback_;
+
+  // Manages cancelation of periodic Render() callback task.
+  base::CancelableClosure cancelable_worker_;
+
+  // Used to determine when a new frame is received.
+  scoped_refptr<VideoFrame> last_frame_;
+
+  // Used to determine the interval given to RenderCallback::Render() as well as
+  // to maintain stable periodicity of callbacks.
+  base::TimeTicks current_render_time_;
+
+  // Used to suspend Render() callbacks to |callback_| for some time.
+  base::TimeTicks pause_end_time_;
+
+  // If specified, used instead of base::TimeTicks::Now().

[xhwang, 2015/04/28 23:12:06]

This comment only applies to |tick_clock_|, right?

[DaleCurtis, 2015/04/29 00:54:07]

Done.

+  base::DefaultTickClock default_tick_clock_;
+  base::TickClock* tick_clock_;
+  base::TimeTicks last_now_;
+
+  // If set, called when Stop() is called.
+  base::Closure stop_cb_;
+
+  DISALLOW_COPY_AND_ASSIGN(NullVideoSink);
+};
+
+}  // namespace media
+
+#endif  // MEDIA_AUDIO_NULL_VIDEO_SINK_H_