blob: 36a90f0822b74b5e7aa68a12794ef57a50e53efe [file] [log] [blame]
// Copyright (c) 2010 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
// 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.
#include <deque>
#include "base/lock.h"
#include "media/base/buffers.h"
#include "media/base/factory.h"
#include "media/base/filters.h"
#include "media/filters/audio_renderer_algorithm_base.h"
namespace media {
class AudioRendererBase : public AudioRenderer {
// MediaFilter implementation.
virtual void Play(FilterCallback* callback);
virtual void Pause(FilterCallback* callback);
virtual void Stop(FilterCallback* callback);
virtual void Seek(base::TimeDelta time, FilterCallback* callback);
// AudioRenderer implementation.
virtual void Initialize(AudioDecoder* decoder, FilterCallback* callback);
virtual bool HasEnded();
// Only allow a factory to create this class.
virtual ~AudioRendererBase();
// Called by Initialize(). |media_format| is the format of the AudioDecoder.
// Subclasses should return true if they were able to initialize, false
// otherwise.
virtual bool OnInitialize(const MediaFormat& media_format) = 0;
// Called by Stop(). Subclasses should perform any necessary cleanup during
// this time, such as stopping any running threads.
virtual void OnStop() = 0;
// Called when a AudioDecoder completes decoding and decrements
// |pending_reads_|.
virtual void ConsumeAudioSamples(scoped_refptr<Buffer> buffer_in);
// Fills the given buffer with audio data by delegating to its |algorithm_|.
// FillBuffer() also takes care of updating the clock. Returns the number of
// bytes copied into |dest|, which may be less than or equal to |len|.
// If this method is returns less bytes than |len| (including zero), it could
// be a sign that the pipeline is stalled or unable to stream the data fast
// enough. In such scenarios, the callee should zero out unused portions
// of their buffer to playback silence.
// FillBuffer() updates the pipeline's playback timestamp. If FillBuffer() is
// not called at the same rate as audio samples are played, then the reported
// timestamp in the pipeline will be ahead of the actual audio playback. In
// this case |playback_delay| should be used to indicate when in the future
// should the filled buffer be played. If FillBuffer() is called as the audio
// hardware plays the buffer, then |playback_delay| should be zero.
// Safe to call on any thread.
uint32 FillBuffer(uint8* dest,
uint32 len,
const base::TimeDelta& playback_delay,
bool buffers_empty);
// Helper to parse a media format and return whether we were successful
// retrieving all the information we care about.
static bool ParseMediaFormat(const MediaFormat& media_format,
int* channels_out, int* sample_rate_out,
int* sample_bits_out);
// Get/Set the playback rate of |algorithm_|.
virtual void SetPlaybackRate(float playback_rate);
virtual float GetPlaybackRate();
// Helper method that schedules an asynchronous read from the decoder and
// increments |pending_reads_|.
// Safe to call from any thread.
void ScheduleRead_Locked();
// Audio decoder.
scoped_refptr<AudioDecoder> decoder_;
// Algorithm for scaling audio.
scoped_ptr<AudioRendererAlgorithmBase> algorithm_;
Lock lock_;
// Simple state tracking variable.
enum State {
State state_;
// Keeps track of whether we received and rendered the end of stream buffer.
bool recieved_end_of_stream_;
bool rendered_end_of_stream_;
// Keeps track of our pending reads. We *must* have no pending reads before
// executing the pause callback, otherwise we breach the contract that all
// filters are idling.
// We use size_t since we compare against std::deque::size().
size_t pending_reads_;
// Audio time at end of last call to FillBuffer().
// TODO(ralphl): Update this value after seeking.
base::TimeDelta last_fill_buffer_time_;
// Filter callbacks.
scoped_ptr<FilterCallback> pause_callback_;
scoped_ptr<FilterCallback> seek_callback_;
base::TimeDelta seek_timestamp_;
} // namespace media