Adding callback support to media filter Initialize() and Seek().

media/base/mock_filters.h

 // Copyright (c) 2009 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.
 //
 // A new breed of mock media filters, this time using gmock!  Feel free to add
 // actions if you need interesting side-effects (i.e., copying data to the
 // buffer passed into MockDataSource::Read()).
 //
 // Don't forget you can use StrictMock<> and NiceMock<> if you want the mock
 // filters to fail the test or do nothing when an unexpected method is called.
@@ skipping 22 matching lines @@
 
  protected:
   virtual ~Destroyable() {
     OnDestroy();
   }
 
  private:
   DISALLOW_COPY_AND_ASSIGN(Destroyable);
 };
 
+// Helper class used to test that callbacks are executed.  It is recommend you
+// combine this class with StrictMock<> to verify that the callback is executed.
+// You can reuse the same instance of a MockFilterCallback many times since
+// gmock will track the number of times the methods are executed.
+class MockFilterCallback {
+ public:
+  MockFilterCallback() {}
+  virtual ~MockFilterCallback() {}
+
+  MOCK_METHOD0(OnCallbackDestroyed, void());
+  MOCK_METHOD0(OnFilterCallback, void());
+
+  // Helper method to create a new callback for this mock.  The callback will
+  // call OnFilterCallback() when executed and OnCallbackDestroyed() when
+  // destroyed.  Clients should use NiceMock<> or StrictMock<> depending on the
+  // test.
+  FilterCallback* NewCallback() {
+    return new CallbackImpl(this);
+  }
+
+ private:
+  // Private implementation of CallbackRunner used to trigger expectations on
+  // MockFilterCallback.
+  class CallbackImpl : public CallbackRunner<Tuple0> {
+   public:
+    CallbackImpl(MockFilterCallback* mock_callback)
+        : mock_callback_(mock_callback) {
+    }
+
+    virtual ~CallbackImpl() {
+      mock_callback_->OnCallbackDestroyed();
+    }
+
+    virtual void RunWithParams(const Tuple0& params) {
+      mock_callback_->OnFilterCallback();
+    }
+
+   private:
+    MockFilterCallback* mock_callback_;
+
+    DISALLOW_COPY_AND_ASSIGN(CallbackImpl);
+  };
+
+  DISALLOW_COPY_AND_ASSIGN(MockFilterCallback);
+};
+
 class MockDataSource : public DataSource {
  public:
   MockDataSource() {}
 
   // MediaFilter implementation.
   MOCK_METHOD0(Stop, void());
   MOCK_METHOD1(SetPlaybackRate, void(float playback_rate));
-  MOCK_METHOD1(Seek, void(base::TimeDelta time));
+  MOCK_METHOD2(Seek, void(base::TimeDelta time, FilterCallback* callback));
 
   // DataSource implementation.
-  MOCK_METHOD1(Initialize, bool(const std::string& url));
+  MOCK_METHOD2(Initialize, void(const std::string& url,
+                                FilterCallback* callback));
   const MediaFormat& media_format() { return media_format_; }
   MOCK_METHOD2(Read, size_t(uint8* data, size_t size));
   MOCK_METHOD1(GetPosition, bool(int64* position_out));
   MOCK_METHOD1(SetPosition, bool(int64 position));
   MOCK_METHOD1(GetSize, bool(int64* size_out));
   MOCK_METHOD0(IsSeekable, bool());
 
  protected:
   virtual ~MockDataSource() {}
 
  private:
   MediaFormat media_format_;
 
   DISALLOW_COPY_AND_ASSIGN(MockDataSource);
 };
 
 class MockDemuxer : public Demuxer {
  public:
   MockDemuxer() {}
 
   // MediaFilter implementation.
   MOCK_METHOD0(Stop, void());
   MOCK_METHOD1(SetPlaybackRate, void(float playback_rate));
-  MOCK_METHOD1(Seek, void(base::TimeDelta time));
+  MOCK_METHOD2(Seek, void(base::TimeDelta time, FilterCallback* callback));
 
   // Demuxer implementation.
-  MOCK_METHOD1(Initialize, bool(DataSource* data_source));
+  MOCK_METHOD2(Initialize, void(DataSource* data_source,
+                                FilterCallback* callback));
   MOCK_METHOD0(GetNumberOfStreams, size_t());
   MOCK_METHOD1(GetStream, scoped_refptr<DemuxerStream>(int stream_id));
 
  protected:
   virtual ~MockDemuxer() {}
 
  private:
   DISALLOW_COPY_AND_ASSIGN(MockDemuxer);
 };
 
@@ skipping 18 matching lines @@
  private:
   MediaFormat media_format_;
 
   DISALLOW_COPY_AND_ASSIGN(MockDemuxerStream);
 };
 
 class MockVideoDecoder : public VideoDecoder {
  public:
   MockVideoDecoder() {}
 
+  // Sets the essential media format keys for this decoder.
+  MockVideoDecoder(const std::string& mime_type, int width, int height) {
+    media_format_.SetAsString(MediaFormat::kMimeType, mime_type);
+    media_format_.SetAsInteger(MediaFormat::kWidth, width);
+    media_format_.SetAsInteger(MediaFormat::kHeight, height);
+  }
+
   // MediaFilter implementation.
   MOCK_METHOD0(Stop, void());
   MOCK_METHOD1(SetPlaybackRate, void(float playback_rate));
-  MOCK_METHOD1(Seek, void(base::TimeDelta time));
+  MOCK_METHOD2(Seek, void(base::TimeDelta time, FilterCallback* callback));
 
   // VideoDecoder implementation.
-  MOCK_METHOD1(Initialize, bool(DemuxerStream* demuxer_stream));
+  MOCK_METHOD2(Initialize, void(DemuxerStream* stream,
+                                FilterCallback* callback));
   const MediaFormat& media_format() { return media_format_; }
   MOCK_METHOD1(Read, void(Callback1<VideoFrame*>::Type* read_callback));
 
  protected:
   virtual ~MockVideoDecoder() {}
 
  private:
   MediaFormat media_format_;
 
   DISALLOW_COPY_AND_ASSIGN(MockVideoDecoder);
 };
 
 class MockAudioDecoder : public AudioDecoder {
  public:
   MockAudioDecoder() {}
 
   // MediaFilter implementation.
   MOCK_METHOD0(Stop, void());
   MOCK_METHOD1(SetPlaybackRate, void(float playback_rate));
-  MOCK_METHOD1(Seek, void(base::TimeDelta time));
+  MOCK_METHOD2(Seek, void(base::TimeDelta time, FilterCallback* callback));
 
   // AudioDecoder implementation.
-  MOCK_METHOD1(Initialize, bool(DemuxerStream* demuxer_stream));
+  MOCK_METHOD2(Initialize, void(DemuxerStream* stream,
+                                FilterCallback* callback));
   const MediaFormat& media_format() { return media_format_; }
   MOCK_METHOD1(Read, void(Callback1<Buffer*>::Type* read_callback));
 
  protected:
   virtual ~MockAudioDecoder() {}
 
  private:
   MediaFormat media_format_;
 
   DISALLOW_COPY_AND_ASSIGN(MockAudioDecoder);
 };
 
 class MockVideoRenderer : public VideoRenderer {
  public:
   MockVideoRenderer() {}
 
   // MediaFilter implementation.
   MOCK_METHOD0(Stop, void());
   MOCK_METHOD1(SetPlaybackRate, void(float playback_rate));
-  MOCK_METHOD1(Seek, void(base::TimeDelta time));
+  MOCK_METHOD2(Seek, void(base::TimeDelta time, FilterCallback* callback));
 
   // VideoRenderer implementation.
-  MOCK_METHOD1(Initialize, bool(VideoDecoder* decoder));
+  MOCK_METHOD2(Initialize, void(VideoDecoder* decoder,
+                                FilterCallback* callback));
 
  protected:
   virtual ~MockVideoRenderer() {}
 
  private:
   DISALLOW_COPY_AND_ASSIGN(MockVideoRenderer);
 };
 
 class MockAudioRenderer : public AudioRenderer {
  public:
   MockAudioRenderer() {}
 
   // MediaFilter implementation.
   MOCK_METHOD0(Stop, void());
   MOCK_METHOD1(SetPlaybackRate, void(float playback_rate));
-  MOCK_METHOD1(Seek, void(base::TimeDelta time));
+  MOCK_METHOD2(Seek, void(base::TimeDelta time, FilterCallback* callback));
 
   // AudioRenderer implementation.
-  MOCK_METHOD1(Initialize, bool(AudioDecoder* decoder));
+  MOCK_METHOD2(Initialize, void(AudioDecoder* decoder,
+                                FilterCallback* callback));
   MOCK_METHOD1(SetVolume, void(float volume));
 
  protected:
   virtual ~MockAudioRenderer() {}
 
  private:
   DISALLOW_COPY_AND_ASSIGN(MockAudioRenderer);
 };
 
 // FilterFactory that returns canned instances of mock filters.  You can set
@@ skipping 55 matching lines @@
   scoped_refptr<MockDataSource> data_source_;
   scoped_refptr<MockDemuxer> demuxer_;
   scoped_refptr<MockVideoDecoder> video_decoder_;
   scoped_refptr<MockAudioDecoder> audio_decoder_;
   scoped_refptr<MockVideoRenderer> video_renderer_;
   scoped_refptr<MockAudioRenderer> audio_renderer_;
 
   DISALLOW_COPY_AND_ASSIGN(MockFilterFactory);
 };
 
-// Helper gmock action that calls InitializationComplete() on behalf of the
-// provided filter.
-ACTION_P(InitializationComplete, filter) {
-  filter->host()->InitializationComplete();
-}
+// Helper gmock function that immediately executes and destroys the
+// FilterCallback on behalf of the provided filter.  Can be used when mocking
+// the Initialize() and Seek() methods.
+void RunFilterCallback(::testing::Unused, FilterCallback* callback);
+
+// Helper gmock function that immediately destroys the FilterCallback on behalf
+// of the provided filter.  Can be used when mocking the Initialize() and Seek()
+// methods.
+void DestroyFilterCallback(::testing::Unused, FilterCallback* callback);
 
 // Helper gmock action that calls Error() on behalf of the provided filter.
 ACTION_P2(Error, filter, error) {
   filter->host()->Error(error);
 }
 
 }  // namespace media
 
 #endif  // MEDIA_BASE_MOCK_FILTERS_H_