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 * Authors: Ali Saidi
38 * William Wang
39 */
40
41/** @file
42 * Implementiation of a VNC input
43 */
44
45#include "base/vnc/vncinput.hh"
46
47#include <sys/types.h>
48
49#include "base/misc.hh"
50#include "base/output.hh"
51#include "base/trace.hh"
52#include "debug/VNC.hh"
53
54using namespace std;
55
56VncInput::VncInput(const Params *p)
57 : SimObject(p), keyboard(NULL), mouse(NULL),
58 fb(&FrameBuffer::dummy),
59 _videoWidth(fb->width()), _videoHeight(fb->height()),
60 captureEnabled(p->frame_capture),
61 captureCurrentFrame(0), captureLastHash(0)
62{
63 if (captureEnabled) {
64 // remove existing frame output directory if it exists, then create a
65 // clean empty directory
66 const string FRAME_OUTPUT_SUBDIR = "frames_" + name();
67 simout.remove(FRAME_OUTPUT_SUBDIR, true);
68 captureOutputDirectory = simout.createSubdirectory(
69 FRAME_OUTPUT_SUBDIR);
70 }
71}
72
73void
74VncInput::setFrameBuffer(const FrameBuffer *rfb)
75{
76 if (!rfb)
77 panic("Trying to VNC frame buffer to NULL!");
78
79 fb = rfb;
80
81 // create bitmap of the frame with new attributes
82 if (captureEnabled)
83 captureBitmap.reset(new Bitmap(rfb));
84
85 // Setting a new frame buffer means that we need to send an update
86 // to the client. Mark the internal buffers as dirty to do so.
87 setDirty();
88}
89
90void
91VncInput::setDirty()
92{
93 const unsigned width(fb->width());
94 const unsigned height(fb->height());
95
96 if (_videoWidth != width || _videoHeight != height) {
97 DPRINTF(VNC, "Updating video params: width: %d height: %d\n",
98 width, height);
99
100 _videoWidth = width;
101 _videoHeight = height;
102
103 frameBufferResized();
104 }
105
106 if (captureEnabled)
107 captureFrameBuffer();
108}
109
110void
111VncInput::captureFrameBuffer()
112{
113 assert(captureBitmap);
114
115 // skip identical frames
116 uint64_t new_hash = fb->getHash();
117 if (captureLastHash == new_hash)
118 return;
119 captureLastHash = new_hash;
120
121 // get the filename for the current frame
122 char frameFilenameBuffer[64];
123 snprintf(frameFilenameBuffer, 64, "fb.%06d.%lld.bmp.gz",
124 captureCurrentFrame, static_cast<long long int>(curTick()));
125 const string frameFilename(frameFilenameBuffer);
126
127 // create the compressed framebuffer file
128 OutputStream *fb_out(captureOutputDirectory->create(frameFilename, true));
129 captureBitmap->write(*fb_out->stream());
130 captureOutputDirectory->close(fb_out);
131
132 ++captureCurrentFrame;
133}
134
135// create the VNC Replayer object
136VncInput *
137VncInputParams::create()
138{
139 return new VncInput(this);
140}