Decouple 'give me more data' and 'rendered end of stream' audio callbacks.

media/filters/audio_renderer_base.h

 // Copyright (c) 2012 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.
 
 // AudioRendererBase takes care of the tricky queuing work and provides simple
 // methods for subclasses to peek and poke at audio data.  In addition to
 // AudioRenderer interface methods this classes doesn't implement, subclasses
 // must also implement the following methods:
 //   OnInitialized
 //   OnStop
 //   OnRenderEndOfStream
 //
 // The general assumption is that subclasses start a callback-based audio thread
 // which needs to be filled with decoded audio data.  AudioDecoderBase provides
 // FillBuffer which handles filling the provided buffer, dequeuing items,
 // scheduling additional reads and updating the clock.  In a sense,
 // AudioRendererBase is the producer and the subclass is the consumer.
 
 #ifndef MEDIA_FILTERS_AUDIO_RENDERER_BASE_H_
 #define MEDIA_FILTERS_AUDIO_RENDERER_BASE_H_
 
 #include <deque>
 
+#include "base/gtest_prod_util.h"
 #include "base/synchronization/lock.h"
 #include "media/base/audio_decoder.h"
 #include "media/base/buffers.h"
 #include "media/base/filters.h"
 #include "media/filters/audio_renderer_algorithm_base.h"
 
 namespace media {
 
 class MEDIA_EXPORT AudioRendererBase : public AudioRenderer {
  public:
@@ skipping 11 matching lines @@
   virtual void Initialize(const scoped_refptr<AudioDecoder>& decoder,
                           const PipelineStatusCB& init_callback,
                           const base::Closure& underflow_callback,
                           const AudioTimeCB& audio_time_cb) OVERRIDE;
   virtual bool HasEnded() OVERRIDE;
   virtual void ResumeAfterUnderflow(bool buffer_more_audio) OVERRIDE;
 
  protected:
   FRIEND_TEST_ALL_PREFIXES(AudioRendererBaseTest, EndOfStream);
   FRIEND_TEST_ALL_PREFIXES(AudioRendererBaseTest, Underflow_EndOfStream);
+  FRIEND_TEST_ALL_PREFIXES(AudioRendererImplTest, OnRenderEndOfStream);
 
   // Subclasses should return true if they were able to initialize, false
   // otherwise.
   virtual bool OnInitialize(int bits_per_channel,
                             ChannelLayout channel_layout,
                             int sample_rate) = 0;
 
   // Called by Stop().  Subclasses should perform any necessary cleanup during
   // this time, such as stopping any running threads.
   virtual void OnStop() = 0;
@@ skipping 27 matching lines @@
   // OnRenderEndOfStream() that calls SignalEndOfStream() when all the hardware
   // buffers become empty (i.e. when all the data written to the device has
   // been played).
   //
   // Safe to call on any thread.
   uint32 FillBuffer(uint8* dest,
                     uint32 len,
                     const base::TimeDelta& playback_delay);
 
   // Called by OnRenderEndOfStream() or some callback scheduled by derived class
-  // to signal end of stream.
-  void SignalEndOfStream();
+  // to signal end of stream. Made virtual so tests can override.
+  virtual void SignalEndOfStream();
 
   // Get/Set the playback rate of |algorithm_|.
   virtual void SetPlaybackRate(float playback_rate) OVERRIDE;
   virtual float GetPlaybackRate();
 
+  // Accessor used by tests. Made protected, not private,
+  // so tests for derived classes can use it.
+  void set_recieved_end_of_stream(bool recieved_end_of_stream) {
+    recieved_end_of_stream_ = recieved_end_of_stream;
+  }
+
  private:
   friend class AudioRendererBaseTest;
 
   // Helper method that schedules an asynchronous read from the decoder and
   // increments |pending_reads_|.
   //
   // Safe to call from any thread.
   void ScheduleRead_Locked();
 
   // Returns true if the data in the buffer is all before
@@ skipping 43 matching lines @@
   base::TimeDelta seek_timestamp_;
 
   AudioDecoder::ReadCB read_cb_;
 
   DISALLOW_COPY_AND_ASSIGN(AudioRendererBase);
 };
 
 }  // namespace media
 
 #endif  // MEDIA_FILTERS_AUDIO_RENDERER_BASE_H_