blob: 4d083bdfc9a8342402899cf557cf3ee49f2ac7b2 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
|
// 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.
#ifndef REMOTING_CLIENT_DECODER_H_
#define REMOTING_CLIENT_DECODER_H_
#include <vector>
#include "base/task.h"
#include "base/scoped_ptr.h"
#include "gfx/rect.h"
#include "media/base/video_frame.h"
#include "remoting/base/protocol/chromotocol.pb.h"
namespace remoting {
// TODO(hclam): Merge this with the one in remoting/host/encoder.h.
typedef std::vector<gfx::Rect> UpdatedRects;
// Defines the behavior of a decoder for decoding images received from the
// host.
//
// Sequence of actions with a decoder is as follows:
//
// 1. BeginDecode(PartialDecodeDone, DecodeDone, VideoFrame)
// 2. PartialDecode(HostMessage)
// ...
// 3. EndDecode()
//
// The decoder will reply with:
// 1. PartialDecodeDone(VideoFrame, UpdatedRects)
// ...
// 2. DecodeDone(VideoFrame)
//
// The format of VideoFrame is a contract between the object that creates the
// decoder (most likely the renderer) and the decoder.
class Decoder {
public:
virtual ~Decoder() {
}
// Tell the decoder to use |frame| as a target to write the decoded image
// for the coming update stream.
// If decode is partially done and |frame| can be read, |partial_decode_done|
// is called and |update_rects| contains the updated regions.
// If decode is completed |decode_done| is called.
// Return true if the decoder can writes output to |frame| and accept
// the codec format.
// TODO(hclam): Provide more information when calling this function.
virtual bool BeginDecode(scoped_refptr<media::VideoFrame> frame,
UpdatedRects* updated_rects,
Task* partial_decode_done,
Task* decode_done) = 0;
// Give a HostMessage that contains the update stream packet that contains
// the encoded data to the decoder.
// The decoder will own |message| and is responsible for deleting it.
//
// If the decoder has written something into |frame|,
// |partial_decode_done_| is called with |frame| and updated regions.
// Return true if the decoder can accept |message| and decode it.
//
// HostMessage returned by this method will contain a
// UpdateStreamPacketMessage.
// This message will contain either:
// 1. UpdateStreamBeginRect
// 2. UpdateStreamRectData
// 3. UpdateStreamEndRect
//
// See remoting/base/protocol/chromotocol.proto for more information about
// these messages.
virtual bool PartialDecode(HostMessage* message) = 0;
// Notify the decoder that we have received the last update stream packet.
// If the decoding of the update stream has completed |decode_done_| is
// called with |frame|.
// If the update stream is not received fully and this method is called the
// decoder should also call |decode_done_| as soon as possible.
virtual void EndDecode() = 0;
protected:
// Every decoder will have two internal states because there are three
// kinds of messages send to PartialDecode().
//
// Here's a state diagram:
//
// UpdateStreamBeginRect UpdateStreamRectData
// .............. ............
// . . . .
// . v . .
// kWaitingForBeginRect kWaitingForRectData .
// ^ . ^ .
// . . . .
// .............. ............
// UpdateStreaEndRect
enum State {
// In this state the decoder is waiting for UpdateStreamBeginRect.
// After receiving UpdateStreaBeginRect, the encoder will transit to
// to kWaitingForRectData state.
kWaitingForBeginRect,
// In this state the decoder is waiting for UpdateStreamRectData.
// The decode remains in this state if UpdateStreamRectData is received.
// The decoder will transit to kWaitingForBeginRect if UpdateStreamEndRect
// is received.
kWaitingForRectData,
};
};
} // namespace remoting
#endif // REMOTING_CLIENT_DECODER_H_
|
