summaryrefslogtreecommitdiffstats
path: root/remoting/host/encoder.h
blob: 808b34fd7df243023634baa51496f91f2d7f6b58 (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
// 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_HOST_ENCODER_H_
#define REMOTING_HOST_ENCODER_H_

#include "base/basictypes.h"
#include "base/callback.h"
#include "media/base/data_buffer.h"
#include "remoting/base/protocol/chromotocol.pb.h"
#include "remoting/host/capturer.h"

namespace media {

class DataBuffer;

}  // namespace media

namespace remoting {

// A class to perform the task of encoding a continous stream of
// images.
// This class operates asynchronously to enable maximum throughput.
class Encoder {
 public:

  // EncodingState is a bitfield that tracks the state of the encoding.
  // An encoding that consists of a single block could concievably be starting
  // inprogress and ended at the same time.
  enum {
    EncodingStarting = 1 << 0,
    EncodingInProgress = 1 << 1,
    EncodingEnded = 1 << 2
  };
  typedef int EncodingState;

  // DataAvailableCallback is called as blocks of data are made available
  // from the encoder. The callback takes ownership of header and is
  // responsible for deleting it.
  typedef Callback3<const UpdateStreamPacketHeader*,
                    const scoped_refptr<media::DataBuffer>&,
                    EncodingState>::Type DataAvailableCallback;

  virtual ~Encoder() {}

  // Encode an image stored in |input_data|. |dirty_rects| contains
  // regions of update since last encode.
  //
  // If |key_frame| is true, the encoder should not reference
  // previous encode and encode the full frame.
  //
  // When encoded data is available, partial or full |data_available_task|
  // is called, data can be read from |data| and size is |data_size|.
  // After the last data available event and encode has completed,
  // |encode_done| is set to true and |data_available_task| is deleted.
  //
  // Note that |input_data| and |stride| are arrays of 3 elements.
  //
  // Implementation has to ensure that when |data_available_task| is called
  // output parameters are stable.
  virtual void Encode(const DirtyRects& dirty_rects,
                      const uint8* const* input_data,
                      const int* strides,
                      bool key_frame,
                      DataAvailableCallback* data_available_callback) = 0;

  // Set the dimension of the incoming images. Need to call this before
  // calling Encode().
  virtual void SetSize(int width, int height) = 0;

  // Set the pixel format of the incoming images. Need to call this before
  // calling Encode().
  virtual void SetPixelFormat(PixelFormat pixel_format) = 0;
};

}  // namespace remoting

#endif  // REMOTING_HOST_ENCODER_H_