gem5  v21.1.0.2
bmpwriter.hh
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2010, 2015, 2017 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 #ifndef __BASE_BITMAP_HH__
38 #define __BASE_BITMAP_HH__
39 
40 #include <ostream>
41 
42 #include "base/compiler.hh"
43 #include "base/framebuffer.hh"
44 #include "base/imgwriter.hh"
45 
50 namespace gem5
51 {
52 
53 // write frame buffer into a bitmap picture
54 class BmpWriter : public ImgWriter
55 {
56  public:
61  BmpWriter(const FrameBuffer *fb);
62 
63  ~BmpWriter() {};
64 
65  /*
66  * Return Image format as a string
67  *
68  * @return img extension (e.g. bmp for Bitmap)
69  */
70  const char* getImgExtension() const override
71  { return _imgExtension; }
72 
78  void write(std::ostream &bmp) const override;
79 
80  private:
81  struct GEM5_PACKED FileHeader
82  {
83  unsigned char magic_number[2];
84  uint32_t size;
85  uint16_t reserved1;
86  uint16_t reserved2;
87  uint32_t offset;
88  };
89 
90  struct GEM5_PACKED InfoHeaderV1
91  {
92  /* Aka DIB header */
93  uint32_t Size;
94  uint32_t Width;
95  uint32_t Height;
96  uint16_t Planes;
97  uint16_t BitCount;
98  uint32_t Compression;
99  uint32_t SizeImage;
100  uint32_t XPelsPerMeter;
101  uint32_t YPelsPerMeter;
102  uint32_t ClrUsed;
103  uint32_t ClrImportant;
104  };
105 
106  struct GEM5_PACKED CompleteV1Header
107  {
110  };
111 
112  struct GEM5_PACKED BmpPixel32
113  {
114  BmpPixel32 &operator=(const Pixel &rhs) {
115  red = rhs.red;
116  green = rhs.green;
117  blue = rhs.blue;
118  padding = 0;
119 
120  return *this;
121  }
122  uint8_t blue;
123  uint8_t green;
124  uint8_t red;
125  uint8_t padding;
126  };
127 
129 
130  static const char* _imgExtension;
131 
132  const CompleteV1Header getCompleteHeader() const;
133 };
134 
135 } // namespace gem5
136 
137 #endif // __BASE_BITMAP_HH__
gem5::BmpWriter::write
void write(std::ostream &bmp) const override
Write the frame buffer data into the provided ostream.
Definition: bmpwriter.cc:89
gem5::BmpWriter::InfoHeaderV1::ClrUsed
uint32_t ClrUsed
Definition: bmpwriter.hh:102
gem5::BmpWriter::getCompleteHeader
const CompleteV1Header getCompleteHeader() const
Definition: bmpwriter.cc:56
gem5::BmpWriter::InfoHeaderV1::Width
uint32_t Width
Definition: bmpwriter.hh:94
gem5::BmpWriter::InfoHeaderV1::YPelsPerMeter
uint32_t YPelsPerMeter
Definition: bmpwriter.hh:101
gem5::FrameBuffer
Internal gem5 representation of a frame buffer.
Definition: framebuffer.hh:68
gem5::BmpWriter::BmpPixel32::blue
uint8_t blue
Definition: bmpwriter.hh:122
gem5::BmpWriter::BmpPixel32::padding
uint8_t padding
Definition: bmpwriter.hh:125
gem5::BmpWriter::InfoHeaderV1::Compression
uint32_t Compression
Definition: bmpwriter.hh:98
gem5::BmpWriter::PixelType
BmpPixel32 PixelType
Definition: bmpwriter.hh:128
gem5::BmpWriter::FileHeader
Definition: bmpwriter.hh:81
imgwriter.hh
gem5::BmpWriter::BmpPixel32::red
uint8_t red
Definition: bmpwriter.hh:124
gem5::BmpWriter
Definition: bmpwriter.hh:54
gem5::BmpWriter::_imgExtension
static const char * _imgExtension
Definition: bmpwriter.hh:130
gem5::ImgWriter
Definition: imgwriter.hh:52
gem5::BmpWriter::InfoHeaderV1::XPelsPerMeter
uint32_t XPelsPerMeter
Definition: bmpwriter.hh:100
gem5::BmpWriter::BmpPixel32::operator=
BmpPixel32 & operator=(const Pixel &rhs)
Definition: bmpwriter.hh:114
gem5::BmpWriter::~BmpWriter
~BmpWriter()
Definition: bmpwriter.hh:63
gem5::Pixel::green
uint8_t green
Definition: pixel.hh:67
gem5::BmpWriter::InfoHeaderV1::BitCount
uint16_t BitCount
Definition: bmpwriter.hh:97
gem5::BmpWriter::InfoHeaderV1::Height
uint32_t Height
Definition: bmpwriter.hh:95
gem5::BmpWriter::InfoHeaderV1
Definition: bmpwriter.hh:90
gem5::Pixel::blue
uint8_t blue
Definition: pixel.hh:68
gem5::BmpWriter::FileHeader::reserved2
uint16_t reserved2
Definition: bmpwriter.hh:86
compiler.hh
gem5::BmpWriter::FileHeader::reserved1
uint16_t reserved1
Definition: bmpwriter.hh:85
gem5::BmpWriter::InfoHeaderV1::Size
uint32_t Size
Definition: bmpwriter.hh:93
gem5::SparcISA::red
Bitfield< 5 > red
Definition: misc.hh:122
framebuffer.hh
gem5::Pixel
Internal gem5 representation of a Pixel.
Definition: pixel.hh:58
gem5::BmpWriter::CompleteV1Header::info
InfoHeaderV1 info
Definition: bmpwriter.hh:109
gem5::BmpWriter::FileHeader::offset
uint32_t offset
Definition: bmpwriter.hh:87
gem5::BmpWriter::InfoHeaderV1::Planes
uint16_t Planes
Definition: bmpwriter.hh:96
gem5::BmpWriter::CompleteV1Header
Definition: bmpwriter.hh:106
gem5::BmpWriter::InfoHeaderV1::SizeImage
uint32_t SizeImage
Definition: bmpwriter.hh:99
gem5::Pixel::red
uint8_t red
Definition: pixel.hh:66
gem5::BmpWriter::BmpPixel32::green
uint8_t green
Definition: bmpwriter.hh:123
gem5::BmpWriter::BmpWriter
BmpWriter(const FrameBuffer *fb)
Create a bitmap that takes data in a given mode & size and outputs to an ostream.
Definition: bmpwriter.cc:50
gem5::BmpWriter::getImgExtension
const char * getImgExtension() const override
Definition: bmpwriter.hh:70
gem5
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
Definition: decoder.cc:40
gem5::ImgWriter::fb
const FrameBuffer & fb
Definition: imgwriter.hh:74
gem5::BmpWriter::CompleteV1Header::file
FileHeader file
Definition: bmpwriter.hh:108
gem5::BmpWriter::BmpPixel32
Definition: bmpwriter.hh:112
gem5::BmpWriter::FileHeader::size
uint32_t size
Definition: bmpwriter.hh:84
gem5::BmpWriter::InfoHeaderV1::ClrImportant
uint32_t ClrImportant
Definition: bmpwriter.hh:103

Generated on Tue Sep 21 2021 12:24:53 for gem5 by doxygen 1.8.17