vncinput.cc revision 9330:4a3269a11230 
1/*
2 * Copyright (c) 2010 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 <sys/types.h>
46
47#include "base/vnc/vncinput.hh"
48#include "base/output.hh" //simout
49#include "debug/VNC.hh"
50
51using namespace std;
52
53VncInput::VncInput(const Params *p)
54    : SimObject(p), keyboard(NULL), mouse(NULL),
55      vc(NULL), fbPtr(NULL), videoMode(VideoConvert::UnknownMode),
56      _videoWidth(1), _videoHeight(1), captureEnabled(p->frame_capture),
57      captureCurrentFrame(0), captureLastHash(0), captureBitmap(0)
58{
59    if (captureEnabled) {
60        // remove existing frame output directory if it exists, then create a
61        //   clean empty directory
62        const string FRAME_OUTPUT_SUBDIR = "frames_" + name();
63        simout.remove(FRAME_OUTPUT_SUBDIR, true);
64        captureOutputDirectory = simout.createSubdirectory(
65                                FRAME_OUTPUT_SUBDIR);
66    }
67}
68
69void
70VncInput::setFrameBufferParams(VideoConvert::Mode mode, uint16_t width,
71    uint16_t height)
72{
73    DPRINTF(VNC, "Updating video params: mode: %d width: %d height: %d\n", mode,
74            width, height);
75
76    if (mode != videoMode || width != videoWidth() || height != videoHeight()) {
77        videoMode = mode;
78        _videoWidth = width;
79        _videoHeight = height;
80
81        if (vc)
82            delete vc;
83
84        vc = new VideoConvert(mode, VideoConvert::rgb8888, videoWidth(),
85                videoHeight());
86
87        if (captureEnabled) {
88            // create bitmap of the frame with new attributes
89            if (captureBitmap)
90                delete captureBitmap;
91
92            assert(fbPtr);
93            captureBitmap = new Bitmap(videoMode, width, height, fbPtr);
94            assert(captureBitmap);
95        }
96    }
97}
98
99void
100VncInput::captureFrameBuffer()
101{
102    assert(captureBitmap);
103
104    // skip identical frames
105    uint64_t new_hash = captureBitmap->getHash();
106    if (captureLastHash == new_hash)
107        return;
108    captureLastHash = new_hash;
109
110    // get the filename for the current frame
111    char frameFilenameBuffer[64];
112    snprintf(frameFilenameBuffer, 64, "fb.%06d.%lld.bmp.gz",
113            captureCurrentFrame, static_cast<long long int>(curTick()));
114    const string frameFilename(frameFilenameBuffer);
115
116    // create the compressed framebuffer file
117    ostream *fb_out = simout.create(captureOutputDirectory + frameFilename,
118                    true);
119    captureBitmap->write(fb_out);
120    simout.close(fb_out);
121
122    ++captureCurrentFrame;
123}
124
125// create the VNC Replayer object
126VncInput *
127VncInputParams::create()
128{
129    return new VncInput(this);
130}
131