blob: 93010f3e0ba1a5a0ba154a26fe0ce9a9c245bc4c [file] [log] [blame]
// Copyright 2016 The Cobalt Authors. All Rights Reserved.
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// See the License for the specific language governing permissions and
// limitations under the License.
#include <functional>
#include <vector>
#include "starboard/atomic.h"
#include "starboard/common/log.h"
#include "starboard/common/mutex.h"
#include "starboard/common/optional.h"
#include "starboard/common/scoped_ptr.h"
#include "starboard/media.h"
#include "starboard/shared/internal_only.h"
#include "starboard/shared/starboard/player/decoded_audio_internal.h"
#include "starboard/shared/starboard/player/filter/audio_decoder_internal.h"
#include "starboard/shared/starboard/player/filter/audio_frame_tracker.h"
#include "starboard/shared/starboard/player/filter/audio_renderer_internal.h"
#include "starboard/shared/starboard/player/filter/audio_renderer_sink.h"
#include "starboard/shared/starboard/player/filter/audio_resampler.h"
#include "starboard/shared/starboard/player/filter/audio_time_stretcher.h"
#include "starboard/shared/starboard/player/filter/media_time_provider.h"
#include "starboard/shared/starboard/player/input_buffer_internal.h"
#include "starboard/shared/starboard/player/job_queue.h"
#include "starboard/time.h"
#include "starboard/types.h"
// Uncomment the following statement to log the media time stats with deviation
// when GetCurrentMediaTime() is called.
namespace starboard {
namespace shared {
namespace starboard {
namespace player {
namespace filter {
const int kFramesInBufferBeginUnderflow = 1024;
// A class that sits in between the audio decoder, the audio sink and the
// pipeline to coordinate data transfer between these parties. It also serves
// as the authority of playback time.
class AudioRendererImpl : public AudioRenderer,
public MediaTimeProvider,
private AudioRendererSink::RenderCallback,
private JobQueue::JobOwner {
// |max_cached_frames| is a soft limit for the max audio frames this class can
// cache so it can:
// 1. Avoid using too much memory.
// 2. Have the audio cache full to simulate the state that the renderer can no
// longer accept more data.
// |min_frames_per_append| is the min number of frames that the audio renderer
// tries to append to the sink buffer at once.
AudioRendererImpl(scoped_ptr<AudioDecoder> decoder,
scoped_ptr<AudioRendererSink> audio_renderer_sink,
const SbMediaAudioSampleInfo& audio_sample_info,
int max_cached_frames,
int min_frames_per_append);
~AudioRendererImpl() override;
void Initialize(const ErrorCB& error_cb,
const PrerolledCB& prerolled_cb,
const EndedCB& ended_cb) override;
void WriteSample(const scoped_refptr<InputBuffer>& input_buffer) override;
void WriteEndOfStream() override;
void SetVolume(double volume) override;
// TODO: Remove the eos state querying functions and their tests.
bool IsEndOfStreamWritten() const override;
bool IsEndOfStreamPlayed() const override;
bool CanAcceptMoreData() const override;
// MediaTimeProvider methods
void Play() override;
void Pause() override;
void SetPlaybackRate(double playback_rate) override;
void Seek(SbTime seek_to_time) override;
SbTime GetCurrentMediaTime(bool* is_playing,
bool* is_eos_played,
bool* is_underflow) override;
enum EOSState {
const int max_cached_frames_;
const int min_frames_per_append_;
// |buffered_frames_to_start_| would be initialized in OnFirstOutput().
// Before it's initialized, set it to a large number.
int buffered_frames_to_start_ = 48 * 1024;
ErrorCB error_cb_;
PrerolledCB prerolled_cb_;
EndedCB ended_cb_;
Mutex mutex_;
bool paused_ = true;
bool consume_frames_called_ = false;
bool seeking_ = false;
SbTime seeking_to_time_ = 0;
SbTime last_media_time_ = 0;
AudioFrameTracker audio_frame_tracker_;
bool ended_cb_called_ = false;
int64_t total_frames_sent_to_sink_ = 0;
int64_t total_frames_consumed_by_sink_ = 0;
int32_t frames_consumed_by_sink_since_last_get_current_time_;
scoped_ptr<AudioDecoder> decoder_;
int64_t frames_consumed_set_at_;
double playback_rate_ = 1.0;
// AudioRendererSink methods
void GetSourceStatus(int* frames_in_buffer,
int* offset_in_frames,
bool* is_playing,
bool* is_eos_reached) override;
void ConsumeFrames(int frames_consumed, SbTime frames_consumed_at) override;
void OnError(bool capability_changed) override;
void UpdateVariablesOnSinkThread_Locked(SbTime system_time_on_consume_frames);
void OnFirstOutput(const SbMediaAudioSampleType decoded_sample_type,
const SbMediaAudioFrameStorageType decoded_storage_type,
const int decoded_sample_rate);
bool IsEndOfStreamPlayed_Locked() const;
void OnDecoderConsumed();
void OnDecoderOutput();
void ProcessAudioData();
void FillResamplerAndTimeStretcher();
bool AppendAudioToFrameBuffer(bool* is_frame_buffer_full);
EOSState eos_state_ = kEOSNotReceived;
const int channels_;
const SbMediaAudioSampleType sink_sample_type_;
const int bytes_per_frame_;
scoped_ptr<AudioResampler> resampler_;
optional<int> decoder_sample_rate_;
AudioTimeStretcher time_stretcher_;
std::vector<uint8_t> frame_buffer_;
uint8_t* frame_buffers_[1];
int32_t pending_decoder_outputs_ = 0;
bool can_accept_more_data_ = true;
JobQueue::JobToken process_audio_data_job_token_;
std::function<void()> process_audio_data_job_;
// Our owner will attempt to seek to time 0 when playback begins. In
// general, seeking could require a full reset of the underlying decoder on
// some platforms, so we make an effort to improve playback startup
// performance by keeping track of whether we already have a fresh decoder,
// and can thus avoid doing a full reset.
bool first_input_written_ = false;
scoped_ptr<AudioRendererSink> audio_renderer_sink_;
bool is_eos_reached_on_sink_thread_ = false;
bool is_playing_on_sink_thread_ = false;
int64_t frames_in_buffer_on_sink_thread_ = 0;
int64_t offset_in_frames_on_sink_thread_ = 0;
int64_t frames_consumed_on_sink_thread_ = 0;
SbTime frames_consumed_set_at_on_sink_thread_ = 0;
int64_t silence_frames_written_after_eos_on_sink_thread_ = 0;
int64_t silence_frames_consumed_on_sink_thread_ = 0;
SbTime system_and_media_time_offset_ = -1;
SbTime min_drift_ = kSbTimeMax;
SbTime max_drift_ = 0;
int64_t total_frames_consumed_ = 0;
// Set to true when there are fewer than |kFramesInBufferBeginUnderflow|
// frames in buffer. Set to false when the queue is full or EOS.
bool underflow_ = false;
static const int32_t kMaxSinkCallbacksBetweenCheck = 1024;
static const SbTime kCheckAudioSinkStatusInterval = kSbTimeSecond;
void CheckAudioSinkStatus();
atomic_int32_t sink_callbacks_since_last_check_;
} // namespace filter
} // namespace player
} // namespace starboard
} // namespace shared
} // namespace starboard