db5c9a5f90
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.
127 lines
3.9 KiB
C++
127 lines
3.9 KiB
C++
/*
|
|
* Copyright (c) 2010, 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: William Wang
|
|
* Ali Saidi
|
|
* Chris Emmons
|
|
* Andreas Sandberg
|
|
*/
|
|
#ifndef __BASE_BITMAP_HH__
|
|
#define __BASE_BITMAP_HH__
|
|
|
|
#include <ostream>
|
|
|
|
#include "base/compiler.hh"
|
|
#include "base/framebuffer.hh"
|
|
|
|
/**
|
|
* @file Declaration of a class that writes a frame buffer to a bitmap
|
|
*/
|
|
|
|
|
|
// write frame buffer into a bitmap picture
|
|
class Bitmap
|
|
{
|
|
public:
|
|
/**
|
|
* Create a bitmap that takes data in a given mode & size and
|
|
* outputs to an ostream.
|
|
*/
|
|
Bitmap(const FrameBuffer *fb);
|
|
|
|
~Bitmap();
|
|
|
|
/**
|
|
* Write the frame buffer data into the provided ostream
|
|
*
|
|
* @param bmp stream to write to
|
|
*/
|
|
void write(std::ostream &bmp) const;
|
|
|
|
|
|
private:
|
|
struct FileHeader {
|
|
unsigned char magic_number[2];
|
|
uint32_t size;
|
|
uint16_t reserved1;
|
|
uint16_t reserved2;
|
|
uint32_t offset;
|
|
} M5_ATTR_PACKED;
|
|
|
|
struct InfoHeaderV1 { /* Aka DIB header */
|
|
uint32_t Size;
|
|
uint32_t Width;
|
|
uint32_t Height;
|
|
uint16_t Planes;
|
|
uint16_t BitCount;
|
|
uint32_t Compression;
|
|
uint32_t SizeImage;
|
|
uint32_t XPelsPerMeter;
|
|
uint32_t YPelsPerMeter;
|
|
uint32_t ClrUsed;
|
|
uint32_t ClrImportant;
|
|
} M5_ATTR_PACKED;
|
|
|
|
struct CompleteV1Header {
|
|
FileHeader file;
|
|
InfoHeaderV1 info;
|
|
} M5_ATTR_PACKED;
|
|
|
|
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 FrameBuffer &fb;
|
|
};
|
|
|
|
#endif // __BASE_BITMAP_HH__
|
|
|