src/base/vnc/vncinput.cc

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