blob: fc821e7ce225433c0a2a74ef789e0336352f8a44 [file] [log] [blame]
// 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.
#include "base/callback.h"
#include "base/memory/ref_counted.h"
#include "media/base/pipeline_status.h"
#include "media/base/media_export.h"
#include "ui/gfx/size.h"
namespace media {
class DemuxerStream;
class VideoFrame;
class MEDIA_EXPORT VideoDecoder
: public base::RefCountedThreadSafe<VideoDecoder> {
// Status codes for read operations on VideoDecoder.
enum Status {
kOk, // Everything went as planned.
kDecodeError, // Decoding error happened.
kDecryptError // Decrypting error happened.
// Initializes a VideoDecoder with the given DemuxerStream, executing the
// |status_cb| upon completion.
// |statistics_cb| is used to update the global pipeline statistics.
// Note: No VideoDecoder calls should be made before |status_cb| is executed.
virtual void Initialize(const scoped_refptr<DemuxerStream>& stream,
const PipelineStatusCB& status_cb,
const StatisticsCB& statistics_cb) = 0;
// Requests a frame to be decoded. The status of the decoder and decoded frame
// are returned via the provided callback. Only one read may be in flight at
// any given time.
// Implementations guarantee that the callback will not be called from within
// this method.
// If the returned status is not kOk, some error has occurred in the video
// decoder. In this case, the returned frame should always be NULL.
// Otherwise, the video decoder is in good shape. In this case, Non-NULL
// frames contain decoded video data or may indicate the end of the stream.
// NULL video frames indicate an aborted read. This can happen if the
// DemuxerStream gets flushed and doesn't have any more data to return.
typedef base::Callback<void(Status, const scoped_refptr<VideoFrame>&)> ReadCB;
virtual void Read(const ReadCB& read_cb) = 0;
// Resets decoder state, fulfilling all pending ReadCB and dropping extra
// queued decoded data. After this call, the decoder is back to an initialized
// clean state.
// Note: No VideoDecoder calls should be made before |closure| is executed.
virtual void Reset(const base::Closure& closure) = 0;
// Stops decoder, fires any pending callbacks and sets the decoder to an
// uninitialized state. A VideoDecoder cannot be re-initialized after it has
// been stopped.
// Note that if Initialize() has been called, Stop() must be called and
// complete before deleting the decoder.
virtual void Stop(const base::Closure& closure) = 0;
// Returns true if the output format has an alpha channel. Most formats do not
// have alpha so the default is false. Override and return true for decoders
// that return formats with an alpha channel.
virtual bool HasAlpha() const;
#if defined(__LB_SHELL__) || defined(COBALT)
// Notify the decoder that we are going to overflow if the decoder keeps
// working at the current speed. The decoder should try to decode faster or
// even drop frames if possible.
virtual void NearlyUnderflow() {}
// Notify the decoder that we have enough frames cached and no longer need to
// sacrifice quality for speed. Note that it doesn't mean that the decoder no
// longer needs to decode more frames. The decoding of frames is controlled
// by Read() and the decoder should keep decoding when there is pending read.
virtual void HaveEnoughFrames() {}
#endif // defined(__LB_SHELL__) || defined(COBALT)
friend class base::RefCountedThreadSafe<VideoDecoder>;
virtual ~VideoDecoder();
} // namespace media