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