2 * Copyright (c) 2015 ARM Limited
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.
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.
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.
38 #ifndef __BASE_FRAMEBUFFER_HH__
39 #define __BASE_FRAMEBUFFER_HH__
47 #include "base/compiler.hh"
48 #include "base/cprintf.hh"
49 #include "base/pixel.hh"
50 #include "base/str.hh"
51 #include "base/types.hh"
52 #include "sim/serialize.hh"
55 * Internal gem5 representation of a frame buffer
57 * Display controllers and other devices producing images are expected
58 * to use this class to represent the final image.
60 * Pixels are indexed relative to the upper left corner of the
61 * image. That is, the pixel at position (0, 0) is the upper left
62 * corner. The backing store is a linear vector of Pixels ordered left
63 * to right starting in the upper left corner.
65 class FrameBuffer : public Serializable
69 * Create a frame buffer of a given size.
71 * @param width Width in pixels
72 * @param height Height in pixels
74 FrameBuffer(unsigned width, unsigned height);
75 /** Create an empty (0x0) frame buffer */
78 virtual ~FrameBuffer();
80 void serialize(CheckpointOut &cp) const override;
81 void unserialize(CheckpointIn &cp) override;
84 * Resize the frame buffer.
86 * This method resizes frame buffer including the backing
87 * store. The contents of the backing store are undefined after
90 * @param with Width in pixels.
91 * @param height Height in pixels.
93 void resize(unsigned width, unsigned height);
95 /** Frame buffer width in pixels */
96 unsigned width() const { return _width; }
97 /** Frame buffer height in pixels */
98 unsigned height() const { return _height; }
99 /** Total number of pixels in frame buffer */
100 unsigned area() const { return _width * _height; }
103 * Fill the frame buffer with a single pixel value
105 * @param pixel Pixel value to fill with.
107 void fill(const Pixel &pixel);
109 * Fill the frame buffer with black pixels
114 * Fill the frame buffer with pixel data from an external buffer
115 * of the same width and height as this frame buffer.
117 * @param fb External frame buffer
118 * @param conv Pixel conversion helper
120 void copyIn(const uint8_t *fb, const PixelConverter &conv);
122 * Fill the frame buffer with pixel data from an external buffer
123 * of the same width and height as this frame buffer.
125 * @param fb External frame buffer
126 * @param conv Pixel conversion helper
128 void copyIn(const std::vector<uint8_t> &fb, const PixelConverter &conv) {
129 copyIn(fb.data(), conv);
133 * Store the contents of this frame buffer in an external buffer
134 * of the same width and height as this frame buffer.
136 * @param fb External frame buffer
137 * @param conv Pixel conversion helper
139 void copyOut(uint8_t *fb, const PixelConverter &conv) const;
141 * Store the contents of this frame buffer in an external buffer
142 * of the same width and height as this frame buffer.
144 * @param fb External frame buffer
145 * @param conv Pixel conversion helper
147 void copyOut(std::vector<uint8_t> &fb, const PixelConverter &conv) const {
148 copyOut(fb.data(), conv);
152 * Get a pixel from an (x, y) coordinate
154 * @param x Distance from the left margin.
155 * @param y Distance from the top of the frame.
157 const Pixel &pixel(unsigned x, unsigned y) const {
161 return pixels[y * _width + x];
165 * Get a pixel from an (x, y) coordinate
167 * @param x Distance from the left margin.
168 * @param y Distance from the top of the frame.
170 Pixel &pixel(unsigned x, unsigned y) {
174 return pixels[y * _width + x];
178 * Create a hash of the image that can be used for quick
181 uint64_t getHash() const;
184 * Static "dummy" frame buffer.
186 * This is a dummy frame buffer that can be used as a place holder
187 * for devices that always expect a frame buffer to be present.
189 static const FrameBuffer dummy;
191 /** Frame buffer backing store */
192 std::vector<Pixel> pixels;
195 /** Width in pixels */
197 /** Height in pixels */
201 #endif // __BASE_FRAMEBUFFER_HH__