blob: dded4843f484dea50dda1d2113774a24044decb1 [file] [log] [blame]
// Copyright (c) 2011 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 <vector>
#include "base/memory/scoped_ptr.h"
#include "base/task.h"
#include "media/base/video_frame.h"
#include "remoting/proto/video.pb.h"
#include "third_party/skia/include/core/SkRect.h"
namespace remoting {
typedef std::vector<SkIRect> RectVector;
// Interface for a decoder that takes a stream of bytes from the network and
// outputs frames of data.
// TODO(ajwong): Beef up this documentation once the API stablizes.
class Decoder {
// DecodeResult is returned from DecodePacket() and indicates current state
// of the decoder. DECODE_DONE means that last packet for the frame was
// processed, and the frame can be displayed now. DECODE_IN_PROGRESS
// indicates that the decoder must receive more data before the frame can be
// displayed. DECODE_ERROR is returned if there was an error in the stream.
enum DecodeResult {
Decoder() {}
virtual ~Decoder() {}
// Initializes the decoder to draw into the given |frame|.
virtual void Initialize(scoped_refptr<media::VideoFrame> frame) = 0;
// Feeds more data into the decoder.
virtual DecodeResult DecodePacket(const VideoPacket* packet) = 0;
// Returns rects that were updated in the last frame. Can be called only
// after DecodePacket returned DECODE_DONE. Caller keeps ownership of
// |rects|. |rects| is kept empty if whole screen needs to be updated.
virtual void GetUpdatedRects(RectVector* rects) = 0;
// Reset the decoder to an uninitialized state. Release all references to
// the initialized |frame|. Initialize() must be called before the decoder
// is used again.
virtual void Reset() = 0;
// Returns true if decoder is ready to accept data via DecodePacket.
virtual bool IsReadyForData() = 0;
virtual VideoPacketFormat::Encoding Encoding() = 0;
// Set the scale factors of the decoded output. If the decoder doesn't support
// scaling then this all is ignored.
// If both |horizontal_ratio| and |vertical_ratio| equal 1.0 then scaling is
// turned off.
virtual void SetScaleRatios(double horizontal_ratio, double vertical_ratio) {}
// Set the clipping rectangle to the decoder. Decoder should respect this and
// only output changes in this rectangle. The new clipping rectangle will be
// effective on the next decoded video frame.
// When scaling is enabled clipping rectangles are ignored.
virtual void SetClipRect(const SkIRect& clip_rect) {}
// Force decoder to output a video frame with content in |rects| using the
// last decoded video frame.
// Coordinates of rectangles supplied here are before scaling.
virtual void RefreshRects(const RectVector& rects) {}
} // namespace remoting