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