gem5  v20.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 const FrameBuffer FrameBuffer::dummy(320, 240);
45 
46 FrameBuffer::FrameBuffer(unsigned width, unsigned height)
47  : pixels(width * height),
48  _width(width), _height(height)
49 {
50  clear();
51 }
52 
54  : _width(0), _height(0)
55 {
56 }
57 
59 {
60 }
61 
62 
63 void
65 {
69 }
70 
71 void
73 {
77 }
78 
79 void
80 FrameBuffer::resize(unsigned width, unsigned height)
81 {
82  _width = width;
83  _height = height;
84 
85  pixels.resize(width * height);
86 }
87 
88 void
89 FrameBuffer::fill(const Pixel &pixel)
90 {
91  for (auto &p : pixels)
92  p = pixel;
93 }
94 
95 void
97 {
98  static const Pixel black(0, 0, 0);
99 
100  fill(black);
101 }
102 
103 void
104 FrameBuffer::copyIn(const uint8_t *fb, const PixelConverter &conv)
105 {
106  for (auto &p : pixels) {
107  p = conv.toPixel(fb);
108  fb += conv.length;
109  }
110 }
111 
112 void
113 FrameBuffer::copyOut(uint8_t *fb, const PixelConverter &conv) const
114 {
115  for (auto &p : pixels) {
116  conv.fromPixel(fb, p);
117  fb += conv.length;
118  }
119 }
120 
121 uint64_t
123 {
124  return adler32(0UL,
125  reinterpret_cast<const Bytef *>(pixels.data()),
126  area() * sizeof(Pixel));
127 }
FrameBuffer::dummy
static const FrameBuffer dummy
Static "dummy" frame buffer.
Definition: framebuffer.hh:189
FrameBuffer::clear
void clear()
Fill the frame buffer with black pixels.
Definition: framebuffer.cc:96
FrameBuffer::pixels
std::vector< Pixel > pixels
Frame buffer backing store.
Definition: framebuffer.hh:192
UNSERIALIZE_SCALAR
#define UNSERIALIZE_SCALAR(scalar)
Definition: serialize.hh:797
PixelConverter
Configurable RGB pixel converter.
Definition: pixel.hh:87
FrameBuffer::copyIn
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:104
UNSERIALIZE_CONTAINER
#define UNSERIALIZE_CONTAINER(member)
Definition: serialize.hh:856
FrameBuffer::_width
unsigned _width
Width in pixels.
Definition: framebuffer.hh:196
FrameBuffer::resize
void resize(unsigned width, unsigned height)
Resize the frame buffer.
Definition: framebuffer.cc:80
ArmISA::width
Bitfield< 4 > width
Definition: miscregs_types.hh:68
FrameBuffer::FrameBuffer
FrameBuffer()
Create an empty (0x0) frame buffer.
Definition: framebuffer.cc:53
FrameBuffer::pixel
const Pixel & pixel(unsigned x, unsigned y) const
Get a pixel from an (x, y) coordinate.
Definition: framebuffer.hh:157
PixelConverter::toPixel
Pixel toPixel(uint32_t word) const
Get the Pixel representation of a color word.
Definition: pixel.hh:133
cp
Definition: cprintf.cc:40
FrameBuffer::unserialize
void unserialize(CheckpointIn &cp) override
Unserialize an object.
Definition: framebuffer.cc:72
bitfield.hh
FrameBuffer::area
unsigned area() const
Total number of pixels in frame buffer.
Definition: framebuffer.hh:100
PixelConverter::length
unsigned length
Bytes per pixel when stored in memory (including padding)
Definition: pixel.hh:179
Pixel
Internal gem5 representation of a Pixel.
Definition: pixel.hh:54
SERIALIZE_SCALAR
#define SERIALIZE_SCALAR(scalar)
Definition: serialize.hh:790
framebuffer.hh
FrameBuffer::copyOut
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:113
FrameBuffer::fill
void fill(const Pixel &pixel)
Fill the frame buffer with a single pixel value.
Definition: framebuffer.cc:89
FrameBuffer::_height
unsigned _height
Height in pixels.
Definition: framebuffer.hh:198
FrameBuffer::serialize
void serialize(CheckpointOut &cp) const override
Serialize an object.
Definition: framebuffer.cc:64
FrameBuffer
Internal gem5 representation of a frame buffer.
Definition: framebuffer.hh:65
SERIALIZE_CONTAINER
#define SERIALIZE_CONTAINER(member)
Definition: serialize.hh:848
FrameBuffer::getHash
uint64_t getHash() const
Create a hash of the image that can be used for quick comparisons.
Definition: framebuffer.cc:122
CheckpointOut
std::ostream CheckpointOut
Definition: serialize.hh:63
FrameBuffer::width
unsigned width() const
Frame buffer width in pixels.
Definition: framebuffer.hh:96
MipsISA::p
Bitfield< 0 > p
Definition: pra_constants.hh:323
FrameBuffer::height
unsigned height() const
Frame buffer height in pixels.
Definition: framebuffer.hh:98
ArmISA::fb
Bitfield< 9 > fb
Definition: miscregs_types.hh:271
CheckpointIn
Definition: serialize.hh:67
FrameBuffer::~FrameBuffer
virtual ~FrameBuffer()
Definition: framebuffer.cc:58
PixelConverter::fromPixel
uint32_t fromPixel(const Pixel &pixel) const
Convert a Pixel into a color word.
Definition: pixel.hh:145

Generated on Wed Sep 30 2020 14:02:07 for gem5 by doxygen 1.8.17