gem5  v22.1.0.0
framebuffer.cc
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2015 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 #include "base/framebuffer.hh"
39 
40 #include <zlib.h>
41 
42 #include "base/bitfield.hh"
43 
44 namespace gem5
45 {
46 
47 const FrameBuffer FrameBuffer::dummy(320, 240);
48 
49 FrameBuffer::FrameBuffer(unsigned width, unsigned height)
50  : pixels(width * height),
51  _width(width), _height(height)
52 {
53  clear();
54 }
55 
57  : _width(0), _height(0)
58 {
59 }
60 
62 {
63 }
64 
65 
66 void
68 {
72 }
73 
74 void
76 {
80 }
81 
82 void
83 FrameBuffer::resize(unsigned width, unsigned height)
84 {
85  _width = width;
86  _height = height;
87 
88  pixels.resize(width * height);
89 }
90 
91 void
92 FrameBuffer::fill(const Pixel &pixel)
93 {
94  for (auto &p : pixels)
95  p = pixel;
96 }
97 
98 void
100 {
101  static const Pixel black(0, 0, 0);
102 
103  fill(black);
104 }
105 
106 void
107 FrameBuffer::copyIn(const uint8_t *fb, const PixelConverter &conv)
108 {
109  for (auto &p : pixels) {
110  p = conv.toPixel(fb);
111  fb += conv.length;
112  }
113 }
114 
115 void
116 FrameBuffer::copyOut(uint8_t *fb, const PixelConverter &conv) const
117 {
118  for (auto &p : pixels) {
119  conv.fromPixel(fb, p);
120  fb += conv.length;
121  }
122 }
123 
124 uint64_t
126 {
127  return adler32(0UL,
128  reinterpret_cast<const Bytef *>(pixels.data()),
129  area() * sizeof(Pixel));
130 }
131 
132 } // namespace gem5
std::vector< Pixel > pixels
Frame buffer backing store.
Definition: framebuffer.hh:195
FrameBuffer()
Create an empty (0x0) frame buffer.
Definition: framebuffer.cc:56
uint64_t getHash() const
Create a hash of the image that can be used for quick comparisons.
Definition: framebuffer.cc:125
void unserialize(CheckpointIn &cp) override
Unserialize an object.
Definition: framebuffer.cc:75
unsigned _height
Height in pixels.
Definition: framebuffer.hh:201
unsigned height() const
Frame buffer height in pixels.
Definition: framebuffer.hh:101
void copyOut(uint8_t *fb, const PixelConverter &conv) const
Store the contents of this frame buffer in an external buffer of the same width and height as this fr...
Definition: framebuffer.cc:116
void clear()
Fill the frame buffer with black pixels.
Definition: framebuffer.cc:99
void fill(const Pixel &pixel)
Fill the frame buffer with a single pixel value.
Definition: framebuffer.cc:92
const Pixel & pixel(unsigned x, unsigned y) const
Get a pixel from an (x, y) coordinate.
Definition: framebuffer.hh:160
void copyIn(const uint8_t *fb, const PixelConverter &conv)
Fill the frame buffer with pixel data from an external buffer of the same width and height as this fr...
Definition: framebuffer.cc:107
virtual ~FrameBuffer()
Definition: framebuffer.cc:61
unsigned _width
Width in pixels.
Definition: framebuffer.hh:199
void resize(unsigned width, unsigned height)
Resize the frame buffer.
Definition: framebuffer.cc:83
static const FrameBuffer dummy
Static "dummy" frame buffer.
Definition: framebuffer.hh:192
void serialize(CheckpointOut &cp) const override
Serialize an object.
Definition: framebuffer.cc:67
unsigned width() const
Frame buffer width in pixels.
Definition: framebuffer.hh:99
unsigned area() const
Total number of pixels in frame buffer.
Definition: framebuffer.hh:103
Configurable RGB pixel converter.
Definition: pixel.hh:92
Pixel toPixel(uint32_t word) const
Get the Pixel representation of a color word.
Definition: pixel.hh:138
unsigned length
Bytes per pixel when stored in memory (including padding)
Definition: pixel.hh:184
uint32_t fromPixel(const Pixel &pixel) const
Convert a Pixel into a color word.
Definition: pixel.hh:150
#define UNSERIALIZE_CONTAINER(member)
Definition: serialize.hh:634
#define SERIALIZE_CONTAINER(member)
Definition: serialize.hh:626
Bitfield< 4 > width
Definition: misc_types.hh:72
Bitfield< 9 > fb
Definition: misc_types.hh:281
Bitfield< 54 > p
Definition: pagetable.hh:70
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
std::ostream CheckpointOut
Definition: serialize.hh:66
#define UNSERIALIZE_SCALAR(scalar)
Definition: serialize.hh:575
#define SERIALIZE_SCALAR(scalar)
Definition: serialize.hh:568
Internal gem5 representation of a Pixel.
Definition: pixel.hh:59

Generated on Wed Dec 21 2022 10:22:29 for gem5 by doxygen 1.9.1