gem5  v21.1.0.2
vncinput.hh
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2010, 2015 ARM Limited
3  * All rights reserved
4  *
5  * The license below extends only to copyright in the software and shall
6  * not be construed as granting a license to any other intellectual
7  * property including but not limited to intellectual property relating
8  * to a hardware implementation of the functionality of the software
9  * licensed hereunder. You may use the software subject to the license
10  * terms below provided that you ensure that this notice is replicated
11  * unmodified and in its entirety in all distributions of the software,
12  * modified or unmodified, in source code or in binary form.
13  *
14  * Redistribution and use in source and binary forms, with or without
15  * modification, are permitted provided that the following conditions are
16  * met: redistributions of source code must retain the above copyright
17  * notice, this list of conditions and the following disclaimer;
18  * redistributions in binary form must reproduce the above copyright
19  * notice, this list of conditions and the following disclaimer in the
20  * documentation and/or other materials provided with the distribution;
21  * neither the name of the copyright holders nor the names of its
22  * contributors may be used to endorse or promote products derived from
23  * this software without specific prior written permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
28  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
29  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
30  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
31  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
32  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
33  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
35  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36  */
37 
42 #ifndef __BASE_VNC_VNC_INPUT_HH__
43 #define __BASE_VNC_VNC_INPUT_HH__
44 
45 #include <iostream>
46 #include <memory>
47 
48 #include "base/compiler.hh"
49 #include "base/imgwriter.hh"
50 #include "params/VncInput.hh"
51 #include "sim/sim_object.hh"
52 
53 namespace gem5
54 {
55 
56 class OutputDirectory;
57 
64 {
65  public:
72  virtual void keyPress(uint32_t key, bool down) = 0;
73 };
74 
75 class VncMouse
76 {
77  public:
86  virtual void mouseAt(uint16_t x, uint16_t y, uint8_t buttons) = 0;
87 };
88 
89 class VncInput : public SimObject
90 {
91  public:
92 
95  {
102  };
103 
104  struct GEM5_PACKED PixelFormat
105  {
106  uint8_t bpp;
107  uint8_t depth;
108  uint8_t bigendian;
109  uint8_t truecolor;
110  uint16_t redmax;
111  uint16_t greenmax;
112  uint16_t bluemax;
113  uint8_t redshift;
114  uint8_t greenshift;
115  uint8_t blueshift;
116  uint8_t padding[3];
117  };
118 
119  struct GEM5_PACKED PixelFormatMessage
120  {
121  uint8_t type;
122  uint8_t padding[3];
124  };
125 
126  struct GEM5_PACKED PixelEncodingsMessage
127  {
128  uint8_t type;
129  uint8_t padding;
130  uint16_t num_encodings;
131  };
132 
133  struct GEM5_PACKED FrameBufferUpdateReq
134  {
135  uint8_t type;
136  uint8_t incremental;
137  uint16_t x;
138  uint16_t y;
139  uint16_t width;
140  uint16_t height;
141  };
142 
143  struct GEM5_PACKED KeyEventMessage
144  {
145  uint8_t type;
146  uint8_t down_flag;
147  uint8_t padding[2];
148  uint32_t key;
149  };
150 
151  struct GEM5_PACKED PointerEventMessage
152  {
153  uint8_t type;
154  uint8_t button_mask;
155  uint16_t x;
156  uint16_t y;
157  };
158 
159  struct GEM5_PACKED ClientCutTextMessage
160  {
161  uint8_t type;
162  uint8_t padding[3];
163  uint32_t length;
164  };
165 
166  typedef VncInputParams Params;
167  VncInput(const Params &p);
168 
174  virtual void setFrameBuffer(const FrameBuffer *rfb);
175 
180  void setKeyboard(VncKeyboard *_keyboard) { keyboard = _keyboard; }
181 
186  void setMouse(VncMouse *_mouse) { mouse = _mouse; }
187 
193  uint16_t videoWidth() const { return _videoWidth; }
194 
200  uint16_t videoHeight() const { return _videoHeight; }
201 
206  virtual void setDirty();
207 
208  protected:
209  virtual void frameBufferResized() {};
210 
213 
216 
218  const FrameBuffer *fb;
219 
221  uint16_t _videoWidth;
222 
224  uint16_t _videoHeight;
225 
228 
231 
234 
236  uint64_t captureLastHash;
237 
239  std::unique_ptr<ImgWriter> captureImage;
240 
242  enums::ImageFormat imgFormat;
243 
245  void captureFrameBuffer();
246 };
247 
248 } // namespace gem5
249 
250 #endif
gem5::VncInput::PixelEncodingsMessage::padding
uint8_t padding
Definition: vncinput.hh:129
gem5::VncInput::ClientCutTextMessage::type
uint8_t type
Definition: vncinput.hh:161
gem5::VncInput::PixelEncodingsMessage::num_encodings
uint16_t num_encodings
Definition: vncinput.hh:130
gem5::FrameBuffer
Internal gem5 representation of a frame buffer.
Definition: framebuffer.hh:68
gem5::VncInput::KeyEventMessage::type
uint8_t type
Definition: vncinput.hh:145
gem5::VncInput::FrameBufferUpdateReq::width
uint16_t width
Definition: vncinput.hh:139
gem5::OutputDirectory
Interface for creating files in a gem5 output directory.
Definition: output.hh:137
gem5::VncInput::PointerEventMessage::y
uint16_t y
Definition: vncinput.hh:156
gem5::VncKeyboard::keyPress
virtual void keyPress(uint32_t key, bool down)=0
Called when the vnc server receives a key press event from the client.
gem5::VncInput::PixelFormatMessage::type
uint8_t type
Definition: vncinput.hh:121
gem5::VncInput::PixelFormat::bigendian
uint8_t bigendian
Definition: vncinput.hh:108
gem5::VncInput::fb
const FrameBuffer * fb
pointer to the actual data that is stored in the frame buffer device
Definition: vncinput.hh:218
gem5::VncInput::captureCurrentFrame
int captureCurrentFrame
Current frame number being captured to a file.
Definition: vncinput.hh:230
gem5::VncInput::videoWidth
uint16_t videoWidth() const
What is the width of the screen we're displaying.
Definition: vncinput.hh:193
gem5::VncInput::PixelFormat::bpp
uint8_t bpp
Definition: vncinput.hh:106
gem5::VncInput::captureFrameBuffer
void captureFrameBuffer()
Captures the current frame buffer to a file.
Definition: vncinput.cc:113
gem5::VncInput::PixelFormat::redmax
uint16_t redmax
Definition: vncinput.hh:110
gem5::VncInput::PointerEventMessage::type
uint8_t type
Definition: vncinput.hh:153
gem5::VncInput::PointerEventMessage
Definition: vncinput.hh:151
gem5::VncInput::ClientCutTextMessage::length
uint32_t length
Definition: vncinput.hh:163
gem5::VncInput::PixelFormatMessage
Definition: vncinput.hh:119
gem5::VncInput::FrameBufferUpdateReq::type
uint8_t type
Definition: vncinput.hh:135
imgwriter.hh
gem5::VncInput::FrameBufferUpdateReq::height
uint16_t height
Definition: vncinput.hh:140
gem5::VncInput::PixelEncodingsMessage::type
uint8_t type
Definition: vncinput.hh:128
gem5::VncInput::mouse
VncMouse * mouse
The device to notify when we get mouse events.
Definition: vncinput.hh:215
gem5::VncInput::FrameBufferUpdateReq::x
uint16_t x
Definition: vncinput.hh:137
gem5::VncInput::PixelFormat::truecolor
uint8_t truecolor
Definition: vncinput.hh:109
gem5::VncInput::ClientCutText
@ ClientCutText
Definition: vncinput.hh:101
gem5::VncInput::KeyEventMessage::down_flag
uint8_t down_flag
Definition: vncinput.hh:146
gem5::VncKeyboard
A device that expects to receive input from the vnc server should derrive (through mulitple inheriten...
Definition: vncinput.hh:63
gem5::VncInput::_videoHeight
uint16_t _videoHeight
the height of the frame buffer we are sending to the client
Definition: vncinput.hh:224
gem5::VncInput::ClientKeyEvent
@ ClientKeyEvent
Definition: vncinput.hh:99
gem5::VncMouse::mouseAt
virtual void mouseAt(uint16_t x, uint16_t y, uint8_t buttons)=0
called whenever the mouse moves or it's button state changes buttons is a simple mask with each butto...
sim_object.hh
gem5::VncInput::captureEnabled
bool captureEnabled
Flag indicating whether to capture snapshots of frame buffer or not.
Definition: vncinput.hh:227
gem5::VncInput::PointerEventMessage::button_mask
uint8_t button_mask
Definition: vncinput.hh:154
gem5::VncInput::FrameBufferUpdateReq
Definition: vncinput.hh:133
gem5::MipsISA::p
Bitfield< 0 > p
Definition: pra_constants.hh:326
gem5::VncInput::setDirty
virtual void setDirty()
The frame buffer uses this call to notify the vnc server that the frame buffer has been updated and a...
Definition: vncinput.cc:93
compiler.hh
gem5::VncMouse
Definition: vncinput.hh:75
gem5::SimObject
Abstract superclass for simulation objects.
Definition: sim_object.hh:146
gem5::VncInput::PixelFormat::greenshift
uint8_t greenshift
Definition: vncinput.hh:114
gem5::VncInput::setFrameBuffer
virtual void setFrameBuffer(const FrameBuffer *rfb)
Set the address of the frame buffer we are going to show.
Definition: vncinput.cc:74
gem5::VncInput::_videoWidth
uint16_t _videoWidth
the width of the frame buffer we are sending to the client
Definition: vncinput.hh:221
gem5::VncInput::ClientCutTextMessage
Definition: vncinput.hh:159
gem5::VncInput::setMouse
void setMouse(VncMouse *_mouse)
Setup the device that would like to receive notifications when mouse movements or button presses are ...
Definition: vncinput.hh:186
gem5::VncInput::FrameBufferUpdateReq::incremental
uint8_t incremental
Definition: vncinput.hh:136
gem5::VncInput::ClientPointerEvent
@ ClientPointerEvent
Definition: vncinput.hh:100
gem5::VncInput::VncInput
VncInput(const Params &p)
Definition: vncinput.cc:55
gem5::VncInput::ClientSetEncodings
@ ClientSetEncodings
Definition: vncinput.hh:97
gem5::RiscvISA::x
Bitfield< 3 > x
Definition: pagetable.hh:73
gem5::VncInput::ClientMessages
ClientMessages
Client -> Server message IDs.
Definition: vncinput.hh:94
gem5::VncInput::Params
VncInputParams Params
Definition: vncinput.hh:166
gem5::VncInput::PixelFormat
Definition: vncinput.hh:104
gem5::VncInput::PixelFormatMessage::px
PixelFormat px
Definition: vncinput.hh:123
gem5::VncInput::PixelFormat::bluemax
uint16_t bluemax
Definition: vncinput.hh:112
gem5::VncInput
Definition: vncinput.hh:89
gem5::VncInput::ClientFrameBufferUpdate
@ ClientFrameBufferUpdate
Definition: vncinput.hh:98
gem5::VncInput::frameBufferResized
virtual void frameBufferResized()
Definition: vncinput.hh:209
gem5::VncInput::imgFormat
enums::ImageFormat imgFormat
image format
Definition: vncinput.hh:242
gem5::VncInput::setKeyboard
void setKeyboard(VncKeyboard *_keyboard)
Set up the device that would like to receive notifications when keys are pressed in the vnc client ke...
Definition: vncinput.hh:180
gem5::VncInput::KeyEventMessage
Definition: vncinput.hh:143
gem5::VncInput::keyboard
VncKeyboard * keyboard
The device to notify when we get key events.
Definition: vncinput.hh:209
gem5::VncInput::captureImage
std::unique_ptr< ImgWriter > captureImage
Cached ImgWriter object for writing out frame buffers to file.
Definition: vncinput.hh:239
gem5::VncInput::videoHeight
uint16_t videoHeight() const
What is the height of the screen we're displaying.
Definition: vncinput.hh:200
gem5::VncInput::KeyEventMessage::key
uint32_t key
Definition: vncinput.hh:148
gem5
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
Definition: decoder.cc:40
gem5::VncInput::captureOutputDirectory
OutputDirectory * captureOutputDirectory
Directory to store captured frames to.
Definition: vncinput.hh:233
gem5::ps2::down
bool down
Definition: types.hh:136
gem5::VncInput::PixelFormat::depth
uint8_t depth
Definition: vncinput.hh:107
gem5::VncInput::PointerEventMessage::x
uint16_t x
Definition: vncinput.hh:155
gem5::VncInput::PixelFormat::redshift
uint8_t redshift
Definition: vncinput.hh:113
gem5::VncInput::PixelFormat::blueshift
uint8_t blueshift
Definition: vncinput.hh:115
gem5::VncInput::captureLastHash
uint64_t captureLastHash
Computed hash of the last captured frame.
Definition: vncinput.hh:236
gem5::VncInput::FrameBufferUpdateReq::y
uint16_t y
Definition: vncinput.hh:138
gem5::VncInput::PixelEncodingsMessage
Definition: vncinput.hh:126
gem5::VncInput::PixelFormat::greenmax
uint16_t greenmax
Definition: vncinput.hh:111
gem5::VncInput::ClientSetPixelFormat
@ ClientSetPixelFormat
Definition: vncinput.hh:96

Generated on Tue Sep 21 2021 12:25:00 for gem5 by doxygen 1.8.17