changeset 10cac0f0f419 in /z/repo/gem5
details: http://repo.gem5.org/gem5?cmd=changeset;node=10cac0f0f419
description:
        base: Redesign internal frame buffer handling

        Currently, frame buffer handling in gem5 is quite ad hoc. In practice,
        we pass around naked pointers to raw pixel data and expect consumers
        to convert frame buffers using the (broken) VideoConverter.

        This changeset completely redesigns the way we handle frame buffers
        internally. In summary, it fixes several color conversion bugs, adds
        support for more color formats (e.g., big endian), and makes the code
        base easier to follow.

        In the new world, gem5 always represents pixel data using the Pixel
        struct when pixels need to be passed between different classes (e.g.,
        a display controller and the VNC server). Producers of entire frames
        (e.g., display controllers) should use the FrameBuffer class to
        represent a frame.

        Frame producers are expected to create one instance of the FrameBuffer
        class in their constructors and register it with its consumers
        once. Consumers are expected to check the dimensions of the frame
        buffer when they consume it.

        Conversion between the external representation and the internal
        representation is supported for all common "true color" RGB formats of
        up to 32-bit color depth. The external pixel representation is
        expected to be between 1 and 4 bytes in either big endian or little
        endian. Color channels are assumed to be contiguous ranges of bits
        within each pixel word. The external pixel value is scaled to an 8-bit
        internal representation using a floating multiplication to map it to
        the entire 8-bit range.

diffstat:

 src/base/SConscript       |    1 +
 src/base/bitmap.cc        |   38 ++--
 src/base/bitmap.hh        |   51 ++----
 src/base/framebuffer.cc   |  173 ++++++++++++++++++++++
 src/base/framebuffer.hh   |  355 ++++++++++++++++++++++++++++++++++++++++++++++
 src/base/types.hh         |    5 +
 src/base/vnc/SConscript   |    2 -
 src/base/vnc/convert.cc   |  183 -----------------------
 src/base/vnc/convert.hh   |  158 --------------------
 src/base/vnc/vncinput.cc  |   64 ++++---
 src/base/vnc/vncinput.hh  |   33 +---
 src/base/vnc/vncserver.cc |   82 ++++++----
 src/base/vnc/vncserver.hh |   24 +--
 src/dev/arm/hdlcd.cc      |  126 +++++----------
 src/dev/arm/hdlcd.hh      |   18 +-
 src/dev/arm/pl111.cc      |  103 ++++++++-----
 src/dev/arm/pl111.hh      |   13 +-
 src/sim/byteswap.hh       |    2 -
 src/unittest/SConscript   |    1 +
 src/unittest/fbtest.cc    |  126 ++++++++++++++++
 20 files changed, 925 insertions(+), 633 deletions(-)

diffs (truncated from 2168 to 300 lines):

diff -r 364e7cc28406 -r 10cac0f0f419 src/base/SConscript
--- a/src/base/SConscript       Sat May 23 13:37:01 2015 +0100
+++ b/src/base/SConscript       Sat May 23 13:37:03 2015 +0100
@@ -42,6 +42,7 @@
 Source('debug.cc')
 if env['USE_FENV']:
     Source('fenv.c')
+Source('framebuffer.cc')
 Source('hostinfo.cc')
 Source('inet.cc')
 Source('inifile.cc')
diff -r 364e7cc28406 -r 10cac0f0f419 src/base/bitmap.cc
--- a/src/base/bitmap.cc        Sat May 23 13:37:01 2015 +0100
+++ b/src/base/bitmap.cc        Sat May 23 13:37:03 2015 +0100
@@ -47,11 +47,8 @@
 #include "base/misc.hh"
 
 // bitmap class ctor
-Bitmap::Bitmap(VideoConvert::Mode mode, uint16_t w, uint16_t h, uint8_t *d)
-    : height(h), width(w),
-      header(getCompleteHeader()),
-      data(d),
-      vc(mode, VideoConvert::rgb8888, width, height)
+Bitmap::Bitmap(const FrameBuffer *_fb)
+    : fb(*_fb)
 {
 }
 
@@ -62,7 +59,7 @@
 const Bitmap::CompleteV1Header
 Bitmap::getCompleteHeader() const
 {
-    const uint32_t pixel_array_size(sizeof(PixelType) * width * height);
+    const uint32_t pixel_array_size(sizeof(PixelType) * fb.area());
     const uint32_t file_size(sizeof(CompleteV1Header) + pixel_array_size);
 
     const CompleteV1Header header = {
@@ -76,8 +73,8 @@
         // Info/DIB header
         {
             sizeof(InfoHeaderV1),
-            width,
-            height,
+            fb.width(),
+            fb.height(),
             1, /* Color planes */
             32, /* Bits per pixel */
             0, /* No compression */
@@ -93,28 +90,25 @@
 }
 
 void
-Bitmap::write(std::ostream *bmp) const
+Bitmap::write(std::ostream &bmp) const
 {
-    assert(data);
+    const CompleteV1Header header(getCompleteHeader());
 
     // 1.  write the header
-    bmp->write(reinterpret_cast<const char *>(&header), sizeof(header));
+    bmp.write(reinterpret_cast<const char *>(&header), sizeof(header));
 
     // 2.  write the bitmap data
-    const uint8_t *pixels(vc.convert(data));
-
     // BMP start store data left to right starting with the bottom row
     // so we need to do some creative flipping
-    for (int y = height - 1; y >= 0; y--) {
-        for (int x = 0; x < width; x++) {
-            bmp->write(
-                (const char *)&pixels[sizeof(PixelType) * (y * width + x)],
-                sizeof(PixelType));
-        }
+    std::vector<PixelType> line_buffer(fb.width());
+    for (int y = 0; y < fb.height(); ++y) {
+        for (unsigned x = 0; x < fb.width(); ++x)
+            line_buffer[x] = fb.pixel(x, fb.height() - y - 1);
+
+        bmp.write(reinterpret_cast<const char *>(line_buffer.data()),
+                  line_buffer.size() * sizeof(line_buffer[0]));
     }
 
-    bmp->flush();
-
-    delete[] pixels;
+    bmp.flush();
 }
 
diff -r 364e7cc28406 -r 10cac0f0f419 src/base/bitmap.hh
--- a/src/base/bitmap.hh        Sat May 23 13:37:01 2015 +0100
+++ b/src/base/bitmap.hh        Sat May 23 13:37:03 2015 +0100
@@ -45,7 +45,7 @@
 #include <ostream>
 
 #include "base/compiler.hh"
-#include "base/vnc/convert.hh"
+#include "base/framebuffer.hh"
 
 /**
  * @file Declaration of a class that writes a frame buffer to a bitmap
@@ -59,38 +59,17 @@
     /**
      * Create a bitmap that takes data in a given mode & size and
      * outputs to an ostream.
-     *
-     * @param mode the type of data that is being provided
-     * @param h the hight of the image
-     * @param w the width of the image
-     * @param d the data for the image in mode
      */
-    Bitmap(VideoConvert::Mode mode, uint16_t w, uint16_t h, uint8_t *d);
+    Bitmap(const FrameBuffer *fb);
 
     ~Bitmap();
 
     /**
-     * Provide the converter with the data that should be output. It
-     * will be converted into rgb8888 and written when write() is
-     * called.
-     *
-     * @param d the data
-     */
-    void rawData(uint8_t* d) { data = d; }
-
-    /**
      * Write the frame buffer data into the provided ostream
      *
      * @param bmp stream to write to
      */
-    void write(std::ostream *bmp) const;
-
-    /**
-     * Gets a hash over the bitmap for quick comparisons to other bitmaps.
-     *
-     * @return hash of the bitmap
-     */
-    uint64_t getHash() const { return vc.getHash(data); }
+    void write(std::ostream &bmp) const;
 
 
   private:
@@ -121,16 +100,26 @@
         InfoHeaderV1 info;
     } M5_ATTR_PACKED;
 
-    typedef uint32_t PixelType;
+    struct BmpPixel32 {
+        BmpPixel32 &operator=(const Pixel &rhs) {
+            red = rhs.red;
+            green = rhs.green;
+            blue = rhs.blue;
+            padding = 0;
+
+            return *this;
+        }
+        uint8_t blue;
+        uint8_t green;
+        uint8_t red;
+        uint8_t padding;
+    } M5_ATTR_PACKED;
+
+    typedef BmpPixel32 PixelType;
 
     const CompleteV1Header getCompleteHeader() const;
 
-    const uint16_t height;
-    const uint16_t width;
-    const CompleteV1Header header;
-    uint8_t *data;
-
-    VideoConvert vc;
+    const FrameBuffer &fb;
 };
 
 #endif // __BASE_BITMAP_HH__
diff -r 364e7cc28406 -r 10cac0f0f419 src/base/framebuffer.cc
--- /dev/null   Thu Jan 01 00:00:00 1970 +0000
+++ b/src/base/framebuffer.cc   Sat May 23 13:37:03 2015 +0100
@@ -0,0 +1,173 @@
+/*
+ * Copyright (c) 2015 ARM Limited
+ * All rights reserved
+ *
+ * The license below extends only to copyright in the software and shall
+ * not be construed as granting a license to any other intellectual
+ * property including but not limited to intellectual property relating
+ * to a hardware implementation of the functionality of the software
+ * licensed hereunder.  You may use the software subject to the license
+ * terms below provided that you ensure that this notice is replicated
+ * unmodified and in its entirety in all distributions of the software,
+ * modified or unmodified, in source code or in binary form.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met: redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer;
+ * redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution;
+ * neither the name of the copyright holders nor the names of its
+ * contributors may be used to endorse or promote products derived from
+ * this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * Authors: Andreas Sandberg
+ */
+
+#include "base/framebuffer.hh"
+
+#include <zlib.h>
+
+#include <cassert>
+
+#include "base/bitfield.hh"
+
+const PixelConverter PixelConverter::rgba8888_le(4, 0, 8, 16, 8, 8, 8);
+const PixelConverter PixelConverter::rgba8888_be(4, 0, 8, 16, 8, 8, 8,
+                                                 BigEndianByteOrder);
+const PixelConverter PixelConverter::rgb565_le(2,  0, 5, 11, 5, 6, 5);
+const PixelConverter PixelConverter::rgb565_be(2,  0, 5, 11, 5, 6, 5,
+                                               BigEndianByteOrder);
+
+const FrameBuffer FrameBuffer::dummy(320, 240);
+
+PixelConverter::PixelConverter(unsigned _length,
+                               unsigned ro, unsigned go, unsigned bo,
+                               unsigned rw, unsigned gw, unsigned bw,
+                               ByteOrder _byte_order)
+    : length(_length),
+      depth(rw + gw + bw),
+      byte_order(_byte_order),
+      ch_r(ro, rw),
+      ch_g(go, gw),
+      ch_b(bo, bw)
+{
+    assert(length > 1);
+}
+
+PixelConverter::Channel::Channel(unsigned _offset, unsigned width)
+    : offset(_offset),
+      mask(::mask(width)),
+      factor(255.0 / mask)
+{
+}
+
+uint32_t
+PixelConverter::readWord(const uint8_t *p) const
+{
+    uint32_t word(0);
+
+    if (byte_order == LittleEndianByteOrder) {
+        for (int i = 0; i < length; ++i)
+            word |= p[i] << (8 * i);
+    } else {
+        for (int i = 0; i < length; ++i)
+            word |= p[i] << (8 * (length - i - 1));
+    }
+
+    return word;
+}
+
+void
+PixelConverter::writeWord(uint8_t *p, uint32_t word) const
+{
+    if (byte_order == LittleEndianByteOrder) {
+        for (int i = 0; i < length; ++i)
+            p[i] = (word >> (8 * i)) & 0xFF;
+    } else {
+        for (int i = 0; i < length; ++i)
+            p[i] = (word >> (8 * (length - i - 1))) & 0xFF;
+    }
+}
+
+
+
+
+FrameBuffer::FrameBuffer(unsigned width, unsigned height)
+    : pixels(width * height),
+      _width(width), _height(height)
+{
+    clear();
+}
+
+FrameBuffer::FrameBuffer()
+    : _width(0), _height(0)
+{
+}
+
+FrameBuffer::~FrameBuffer()
_______________________________________________
gem5-dev mailing list
[email protected]
http://m5sim.org/mailman/listinfo/gem5-dev

Reply via email to