// 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.
#ifndef MEDIA_FILTERS_CHUNK_DEMUXER_H_
#define MEDIA_FILTERS_CHUNK_DEMUXER_H_
#include <deque>
#include <map>
#include <string>
#include <utility>
#include <vector>
#include "base/synchronization/lock.h"
#include "media/base/byte_queue.h"
#include "media/base/demuxer.h"
#include "media/base/ranges.h"
#include "media/base/stream_parser.h"
#include "media/filters/source_buffer_stream.h"
namespace media {
class FFmpegURLProtocol;
class SourceState;
class ChunkDemuxerStream : public DemuxerStream {
public:
typedef std::deque<scoped_refptr<StreamParserBuffer> > BufferQueue;
explicit ChunkDemuxerStream(Type type, bool splice_frames_enabled);
virtual ~ChunkDemuxerStream();
// ChunkDemuxerStream control methods.
void StartReturningData();
void AbortReads();
void CompletePendingReadIfPossible();
void Shutdown();
// SourceBufferStream manipulation methods.
void Seek(base::TimeDelta time);
bool IsSeekWaitingForData() const;
// Add buffers to this stream. Buffers are stored in SourceBufferStreams,
// which handle ordering and overlap resolution.
// Returns true if buffers were successfully added.
bool Append(const StreamParser::BufferQueue& buffers);
// Removes buffers between |start| and |end| according to the steps
// in the "Coded Frame Removal Algorithm" in the Media Source
// Extensions Spec.
// https://dvcs.w3.org/hg/html-media/raw-file/default/media-source/media-source.html#sourcebuffer-coded-frame-removal
//
// |duration| is the current duration of the presentation. It is
// required by the computation outlined in the spec.
void Remove(base::TimeDelta start, base::TimeDelta end,
base::TimeDelta duration);
// Signal to the stream that duration has changed to |duration|.
void OnSetDuration(base::TimeDelta duration);
// Returns the range of buffered data in this stream, capped at |duration|.
Ranges<base::TimeDelta> GetBufferedRanges(base::TimeDelta duration) const;
// Returns the duration of the buffered data.
// Returns base::TimeDelta() if the stream has no buffered data.
base::TimeDelta GetBufferedDuration() const;
// Signal to the stream that buffers handed in through subsequent calls to
// Append() belong to a media segment that starts at |start_timestamp|.
void OnNewMediaSegment(base::TimeDelta start_timestamp);
// Called when midstream config updates occur.
// Returns true if the new config is accepted.
// Returns false if the new config should trigger an error.
bool UpdateAudioConfig(const AudioDecoderConfig& config, const LogCB& log_cb);
bool UpdateVideoConfig(const VideoDecoderConfig& config, const LogCB& log_cb);
void UpdateTextConfig(const TextTrackConfig& config, const LogCB& log_cb);
void MarkEndOfStream();
void UnmarkEndOfStream();
// DemuxerStream methods.
virtual void Read(const ReadCB& read_cb) OVERRIDE;
virtual Type type() OVERRIDE;
virtual void EnableBitstreamConverter() OVERRIDE;
virtual AudioDecoderConfig audio_decoder_config() OVERRIDE;
virtual VideoDecoderConfig video_decoder_config() OVERRIDE;
virtual bool SupportsConfigChanges() OVERRIDE;
// Returns the text track configuration. It is an error to call this method
// if type() != TEXT.
TextTrackConfig text_track_config();
// Sets the memory limit, in bytes, on the SourceBufferStream.
void set_memory_limit_for_testing(int memory_limit) {
stream_->set_memory_limit_for_testing(memory_limit);
}
private:
enum State {
UNINITIALIZED,
RETURNING_DATA_FOR_READS,
RETURNING_ABORT_FOR_READS,
SHUTDOWN,
};
// Assigns |state_| to |state|
void ChangeState_Locked(State state);
void CompletePendingReadIfPossible_Locked();
// Specifies the type of the stream.
Type type_;
scoped_ptr<SourceBufferStream> stream_;
mutable base::Lock lock_;
State state_;
ReadCB read_cb_;
const bool splice_frames_enabled_;
DISALLOW_IMPLICIT_CONSTRUCTORS(ChunkDemuxerStream);
};
// Demuxer implementation that allows chunks of media data to be passed
// from JavaScript to the media stack.
class MEDIA_EXPORT ChunkDemuxer : public Demuxer {
public:
enum Status {
kOk, // ID added w/o error.
kNotSupported, // Type specified is not supported.
kReachedIdLimit, // Reached ID limit. We can't handle any more IDs.
};
// |open_cb| Run when Initialize() is called to signal that the demuxer
// is ready to receive media data via AppenData().
// |need_key_cb| Run when the demuxer determines that an encryption key is
// needed to decrypt the content.
// |enable_text| Process inband text tracks in the normal way when true,
// otherwise ignore them.
// |log_cb| Run when parsing error messages need to be logged to the error
// console.
// |splice_frames_enabled| Indicates that it's okay to generate splice frames
// per the MSE specification. Renderers must understand DecoderBuffer's
// splice_timestamp() field.
ChunkDemuxer(const base::Closure& open_cb,
const NeedKeyCB& need_key_cb,
const LogCB& log_cb,
bool splice_frames_enabled);
virtual ~ChunkDemuxer();
// Demuxer implementation.
virtual void Initialize(DemuxerHost* host,
const PipelineStatusCB& cb,
bool enable_text_tracks) OVERRIDE;
virtual void Stop(const base::Closure& callback) OVERRIDE;
virtual void Seek(base::TimeDelta time, const PipelineStatusCB& cb) OVERRIDE;
virtual void OnAudioRendererDisabled() OVERRIDE;
virtual DemuxerStream* GetStream(DemuxerStream::Type type) OVERRIDE;
virtual base::TimeDelta GetStartTime() const OVERRIDE;
// Methods used by an external object to control this demuxer.
//
// Indicates that a new Seek() call is on its way. Any pending Reads on the
// DemuxerStream objects should be aborted immediately inside this call and
// future Read calls should return kAborted until the Seek() call occurs.
// This method MUST ALWAYS be called before Seek() is called to signal that
// the next Seek() call represents the seek point we actually want to return
// data for.
// |seek_time| - The presentation timestamp for the seek that triggered this
// call. It represents the most recent position the caller is trying to seek
// to.
void StartWaitingForSeek(base::TimeDelta seek_time);
// Indicates that a Seek() call is on its way, but another seek has been
// requested that will override the impending Seek() call. Any pending Reads
// on the DemuxerStream objects should be aborted immediately inside this call
// and future Read calls should return kAborted until the next
// StartWaitingForSeek() call. This method also arranges for the next Seek()
// call received before a StartWaitingForSeek() call to immediately call its
// callback without waiting for any data.
// |seek_time| - The presentation timestamp for the seek request that
// triggered this call. It represents the most recent position the caller is
// trying to seek to.
void CancelPendingSeek(base::TimeDelta seek_time);
// Registers a new |id| to use for AppendData() calls. |type| indicates
// the MIME type for the data that we intend to append for this ID.
// |use_legacy_frame_processor| determines which of LegacyFrameProcessor or
// a (not yet implemented) more compliant frame processor to use to process
// parsed frames from AppendData() calls.
// TODO(wolenetz): Enable usage of new frame processor based on this flag.
// See http://crbug.com/249422.
// kOk is returned if the demuxer has enough resources to support another ID
// and supports the format indicated by |type|.
// kNotSupported is returned if |type| is not a supported format.
// kReachedIdLimit is returned if the demuxer cannot handle another ID right
// now.
Status AddId(const std::string& id, const std::string& type,
std::vector<std::string>& codecs,
const bool use_legacy_frame_processor);
// Removed an ID & associated resources that were previously added with
// AddId().
void RemoveId(const std::string& id);
// Gets the currently buffered ranges for the specified ID.
Ranges<base::TimeDelta> GetBufferedRanges(const std::string& id) const;
// Appends media data to the source buffer associated with |id|, applying
// and possibly updating |*timestamp_offset| during coded frame processing.
// |append_window_start| and |append_window_end| correspond to the MSE spec's
// similarly named source buffer attributes that are used in coded frame
// processing.
void AppendData(const std::string& id, const uint8* data, size_t length,
base::TimeDelta append_window_start,
base::TimeDelta append_window_end,
base::TimeDelta* timestamp_offset);
// Aborts parsing the current segment and reset the parser to a state where
// it can accept a new segment.
void Abort(const std::string& id);
// Remove buffers between |start| and |end| for the source buffer
// associated with |id|.
void Remove(const std::string& id, base::TimeDelta start,
base::TimeDelta end);
// Returns the current presentation duration.
double GetDuration();
double GetDuration_Locked();
// Notifies the demuxer that the duration of the media has changed to
// |duration|.
void SetDuration(double duration);
// Returns true if the source buffer associated with |id| is currently parsing
// a media segment, or false otherwise.
bool IsParsingMediaSegment(const std::string& id);
// Set the append mode to be applied to subsequent buffers appended to the
// source buffer associated with |id|. If |sequence_mode| is true, caller
// is requesting "sequence" mode. Otherwise, caller is requesting "segments"
// mode.
void SetSequenceMode(const std::string& id, bool sequence_mode);
// Called to signal changes in the "end of stream"
// state. UnmarkEndOfStream() must not be called if a matching
// MarkEndOfStream() has not come before it.
void MarkEndOfStream(PipelineStatus status);
void UnmarkEndOfStream();
void Shutdown();
// Sets the memory limit on each stream. |memory_limit| is the
// maximum number of bytes each stream is allowed to hold in its buffer.
void SetMemoryLimitsForTesting(int memory_limit);
// Returns the ranges representing the buffered data in the demuxer.
// TODO(wolenetz): Remove this method once MediaSourceDelegate no longer
// requires it for doing hack browser seeks to I-frame on Android. See
// http://crbug.com/304234.
Ranges<base::TimeDelta> GetBufferedRanges() const;
private:
enum State {
WAITING_FOR_INIT,
INITIALIZING,
INITIALIZED,
ENDED,
PARSE_ERROR,
SHUTDOWN,
};
void ChangeState_Locked(State new_state);
// Reports an error and puts the demuxer in a state where it won't accept more
// data.
void ReportError_Locked(PipelineStatus error);
// Returns true if any stream has seeked to a time without buffered data.
bool IsSeekWaitingForData_Locked() const;
// Returns true if all streams can successfully call EndOfStream,
// false if any can not.
bool CanEndOfStream_Locked() const;
// SourceState callbacks.
void OnSourceInitDone(bool success, base::TimeDelta duration);
// Creates a DemuxerStream for the specified |type|.
// Returns a new ChunkDemuxerStream instance if a stream of this type
// has not been created before. Returns NULL otherwise.
ChunkDemuxerStream* CreateDemuxerStream(DemuxerStream::Type type);
void OnNewTextTrack(ChunkDemuxerStream* text_stream,
const TextTrackConfig& config);
// Returns true if |source_id| is valid, false otherwise.
bool IsValidId(const std::string& source_id) const;
// Increases |duration_| to |new_duration|, if |new_duration| is higher.
void IncreaseDurationIfNecessary(base::TimeDelta new_duration);
// Decreases |duration_| if the buffered region is less than |duration_| when
// EndOfStream() is called.
void DecreaseDurationIfNecessary();
// Sets |duration_| to |new_duration|, sets |user_specified_duration_| to -1
// and notifies |host_|.
void UpdateDuration(base::TimeDelta new_duration);
// Returns the ranges representing the buffered data in the demuxer.
Ranges<base::TimeDelta> GetBufferedRanges_Locked() const;
// Start returning data on all DemuxerStreams.
void StartReturningData();
// Aborts pending reads on all DemuxerStreams.
void AbortPendingReads();
// Completes any pending reads if it is possible to do so.
void CompletePendingReadsIfPossible();
// Seeks all SourceBufferStreams to |seek_time|.
void SeekAllSources(base::TimeDelta seek_time);
// Shuts down all DemuxerStreams by calling Shutdown() on
// all objects in |source_state_map_|.
void ShutdownAllStreams();
mutable base::Lock lock_;
State state_;
bool cancel_next_seek_;
DemuxerHost* host_;
base::Closure open_cb_;
NeedKeyCB need_key_cb_;
bool enable_text_;
// Callback used to report error strings that can help the web developer
// figure out what is wrong with the content.
LogCB log_cb_;
PipelineStatusCB init_cb_;
// Callback to execute upon seek completion.
// TODO(wolenetz/acolwell): Protect against possible double-locking by first
// releasing |lock_| before executing this callback. See
// http://crbug.com/308226
PipelineStatusCB seek_cb_;
scoped_ptr<ChunkDemuxerStream> audio_;
scoped_ptr<ChunkDemuxerStream> video_;
// Keeps |audio_| alive when audio has been disabled.
scoped_ptr<ChunkDemuxerStream> disabled_audio_;
base::TimeDelta duration_;
// The duration passed to the last SetDuration(). If
// SetDuration() is never called or an AppendData() call or
// a EndOfStream() call changes |duration_|, then this
// variable is set to < 0 to indicate that the |duration_| represents
// the actual duration instead of a user specified value.
double user_specified_duration_;
typedef std::map<std::string, SourceState*> SourceStateMap;
SourceStateMap source_state_map_;
// Used to ensure that (1) config data matches the type and codec provided in
// AddId(), (2) only 1 audio and 1 video sources are added, and (3) ids may be
// removed with RemoveID() but can not be re-added (yet).
std::string source_id_audio_;
std::string source_id_video_;
// Indicates that splice frame generation is enabled.
const bool splice_frames_enabled_;
DISALLOW_COPY_AND_ASSIGN(ChunkDemuxer);
};
} // namespace media
#endif // MEDIA_FILTERS_CHUNK_DEMUXER_H_