gem5  v21.1.0.2
vncinput.cc
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2010, 2015, 2017 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 #include "base/vnc/vncinput.hh"
43 
44 #include <sys/types.h>
45 
46 #include "base/logging.hh"
47 #include "base/output.hh"
48 
49 #include "base/trace.hh"
50 #include "debug/VNC.hh"
51 
52 namespace gem5
53 {
54 
56  : SimObject(p), keyboard(NULL), mouse(NULL),
57  fb(&FrameBuffer::dummy),
58  _videoWidth(fb->width()), _videoHeight(fb->height()),
59  captureEnabled(p.frame_capture),
60  captureCurrentFrame(0), captureLastHash(0),
61  imgFormat(p.img_format)
62 {
63  if (captureEnabled) {
64  // remove existing frame output directory if it exists, then create a
65  // clean empty directory
66  const std::string FRAME_OUTPUT_SUBDIR = "frames_" + name();
67  simout.remove(FRAME_OUTPUT_SUBDIR, true);
69  FRAME_OUTPUT_SUBDIR);
70  }
71 }
72 
73 void
75 {
76  if (!rfb)
77  panic("Trying to VNC frame buffer to NULL!");
78 
79  fb = rfb;
80 
81  // Create the Image Writer object in charge of dumping
82  // the frame buffer raw data into a file in a specific format.
83  if (captureEnabled) {
85  }
86 
87  // Setting a new frame buffer means that we need to send an update
88  // to the client. Mark the internal buffers as dirty to do so.
89  setDirty();
90 }
91 
92 void
94 {
95  const unsigned width(fb->width());
96  const unsigned height(fb->height());
97 
98  if (_videoWidth != width || _videoHeight != height) {
99  DPRINTF(VNC, "Updating video params: width: %d height: %d\n",
100  width, height);
101 
102  _videoWidth = width;
103  _videoHeight = height;
104 
106  }
107 
108  if (captureEnabled)
110 }
111 
112 void
114 {
115  assert(captureImage);
116 
117  // skip identical frames
118  uint64_t new_hash = fb->getHash();
119  if (captureLastHash == new_hash)
120  return;
121  captureLastHash = new_hash;
122 
123  // get the filename for the current frame
124  char frameFilenameBuffer[64];
125  snprintf(frameFilenameBuffer, 64, "fb.%06d.%lld.%s.gz",
126  captureCurrentFrame, static_cast<long long int>(curTick()),
127  captureImage->getImgExtension());
128  const std::string frameFilename(frameFilenameBuffer);
129 
130  // create the compressed framebuffer file
131  OutputStream *fb_out(captureOutputDirectory->create(frameFilename, true));
132  captureImage->write(*fb_out->stream());
133  captureOutputDirectory->close(fb_out);
134 
136 }
137 
138 } // namespace gem5
gem5::curTick
Tick curTick()
The universal simulation clock.
Definition: cur_tick.hh:46
gem5::FrameBuffer
Internal gem5 representation of a frame buffer.
Definition: framebuffer.hh:68
vncinput.hh
gem5::FrameBuffer::width
unsigned width() const
Frame buffer width in pixels.
Definition: framebuffer.hh:99
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::simout
OutputDirectory simout
Definition: output.cc:62
gem5::VncInput::captureFrameBuffer
void captureFrameBuffer()
Captures the current frame buffer to a file.
Definition: vncinput.cc:113
gem5::OutputDirectory::create
OutputStream * create(const std::string &name, bool binary=false, bool no_gz=false)
Creates a file in this directory (optionally compressed).
Definition: output.cc:210
gem5::OutputDirectory::createSubdirectory
OutputDirectory * createSubdirectory(const std::string &name)
Creates a subdirectory within this directory.
Definition: output.cc:283
output.hh
gem5::FrameBuffer::height
unsigned height() const
Frame buffer height in pixels.
Definition: framebuffer.hh:101
gem5::FrameBuffer::getHash
uint64_t getHash() const
Create a hash of the image that can be used for quick comparisons.
Definition: framebuffer.cc:125
gem5::OutputStream::stream
std::ostream * stream() const
Get the output underlying output stream.
Definition: output.hh:62
gem5::OutputDirectory::close
void close(OutputStream *file)
Closes an output file and free the corresponding OutputFile.
Definition: output.cc:147
gem5::VncInput::_videoHeight
uint16_t _videoHeight
the height of the frame buffer we are sending to the client
Definition: vncinput.hh:224
gem5::Named::name
virtual std::string name() const
Definition: named.hh:47
gem5::ArmISA::width
Bitfield< 4 > width
Definition: misc_types.hh:71
gem5::VncInput::captureEnabled
bool captureEnabled
Flag indicating whether to capture snapshots of frame buffer or not.
Definition: vncinput.hh:227
DPRINTF
#define DPRINTF(x,...)
Definition: trace.hh:186
gem5::MipsISA::p
Bitfield< 0 > p
Definition: pra_constants.hh:326
gem5::ArmISA::fb
Bitfield< 9 > fb
Definition: misc_types.hh:274
gem5::createImgWriter
std::unique_ptr< ImgWriter > createImgWriter(enums::ImageFormat type, const FrameBuffer *fb)
Factory Function which allocates a ImgWriter object and returns a smart pointer to it.
Definition: imgwriter.cc:53
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
gem5::SimObject
Abstract superclass for simulation objects.
Definition: sim_object.hh:146
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::VncInput
VncInput(const Params &p)
Definition: vncinput.cc:55
gem5::VncInput::Params
VncInputParams Params
Definition: vncinput.hh:166
logging.hh
gem5::VncInput::frameBufferResized
virtual void frameBufferResized()
Definition: vncinput.hh:209
gem5::VncInput::imgFormat
enums::ImageFormat imgFormat
image format
Definition: vncinput.hh:242
trace.hh
gem5::VncInput::captureImage
std::unique_ptr< ImgWriter > captureImage
Cached ImgWriter object for writing out frame buffers to file.
Definition: vncinput.hh:239
gem5::OutputDirectory::remove
void remove(const std::string &name, bool recursive=false)
Removes a specified file or subdirectory.
Definition: output.cc:296
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::OutputStream
Definition: output.hh:56
gem5::VncInput::captureLastHash
uint64_t captureLastHash
Computed hash of the last captured frame.
Definition: vncinput.hh:236
panic
#define panic(...)
This implements a cprintf based panic() function.
Definition: logging.hh:177

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