gem5  v20.1.0.0
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 // write frame buffer into a bitmap picture
51 class BmpWriter : public ImgWriter
52 {
53  public:
58  BmpWriter(const FrameBuffer *fb);
59 
60  ~BmpWriter() {};
61 
62  /*
63  * Return Image format as a string
64  *
65  * @return img extension (e.g. bmp for Bitmap)
66  */
67  const char* getImgExtension() const override
68  { return _imgExtension; }
69 
75  void write(std::ostream &bmp) const override;
76 
77  private:
78  struct FileHeader {
79  unsigned char magic_number[2];
80  uint32_t size;
81  uint16_t reserved1;
82  uint16_t reserved2;
83  uint32_t offset;
85 
86  struct InfoHeaderV1 { /* Aka DIB header */
87  uint32_t Size;
88  uint32_t Width;
89  uint32_t Height;
90  uint16_t Planes;
91  uint16_t BitCount;
92  uint32_t Compression;
93  uint32_t SizeImage;
94  uint32_t XPelsPerMeter;
95  uint32_t YPelsPerMeter;
96  uint32_t ClrUsed;
97  uint32_t ClrImportant;
99 
103  } M5_ATTR_PACKED;
104 
105  struct BmpPixel32 {
106  BmpPixel32 &operator=(const Pixel &rhs) {
107  red = rhs.red;
108  green = rhs.green;
109  blue = rhs.blue;
110  padding = 0;
111 
112  return *this;
113  }
114  uint8_t blue;
115  uint8_t green;
116  uint8_t red;
117  uint8_t padding;
118  } M5_ATTR_PACKED;
119 
121 
122  static const char* _imgExtension;
123 
124  const CompleteV1Header getCompleteHeader() const;
125 };
126 
127 
128 #endif // __BASE_BITMAP_HH__
129 
BmpWriter::InfoHeaderV1::ClrUsed
uint32_t ClrUsed
Definition: bmpwriter.hh:96
BmpWriter::BmpPixel32::operator=
BmpPixel32 & operator=(const Pixel &rhs)
Definition: bmpwriter.hh:106
BmpWriter::InfoHeaderV1::Width
uint32_t Width
Definition: bmpwriter.hh:88
BmpWriter::InfoHeaderV1::Compression
uint32_t Compression
Definition: bmpwriter.hh:92
Pixel::blue
uint8_t blue
Definition: pixel.hh:64
BmpWriter::getImgExtension
const char * getImgExtension() const override
Definition: bmpwriter.hh:67
BmpWriter::FileHeader::reserved1
uint16_t reserved1
Definition: bmpwriter.hh:81
BmpWriter::FileHeader::reserved2
uint16_t reserved2
Definition: bmpwriter.hh:82
BmpWriter::InfoHeaderV1
Definition: bmpwriter.hh:86
BmpWriter::write
void write(std::ostream &bmp) const override
Write the frame buffer data into the provided ostream.
Definition: bmpwriter.cc:86
BmpWriter::BmpPixel32::green
uint8_t green
Definition: bmpwriter.hh:115
Pixel::red
uint8_t red
Definition: pixel.hh:62
BmpWriter::InfoHeaderV1::Height
uint32_t Height
Definition: bmpwriter.hh:89
BmpWriter::PixelType
BmpPixel32 PixelType
Definition: bmpwriter.hh:120
imgwriter.hh
BmpWriter::CompleteV1Header::info
InfoHeaderV1 info
Definition: bmpwriter.hh:102
BmpWriter::BmpPixel32::red
uint8_t red
Definition: bmpwriter.hh:116
BmpWriter::InfoHeaderV1::ClrImportant
uint32_t ClrImportant
Definition: bmpwriter.hh:97
BmpWriter::InfoHeaderV1::XPelsPerMeter
uint32_t XPelsPerMeter
Definition: bmpwriter.hh:94
BmpWriter::getCompleteHeader
const CompleteV1Header getCompleteHeader() const
Definition: bmpwriter.cc:53
BmpWriter::InfoHeaderV1::YPelsPerMeter
uint32_t YPelsPerMeter
Definition: bmpwriter.hh:95
BmpWriter::CompleteV1Header::file
FileHeader file
Definition: bmpwriter.hh:101
BmpWriter::FileHeader::size
uint32_t size
Definition: bmpwriter.hh:80
BmpWriter::BmpPixel32::padding
uint8_t padding
Definition: bmpwriter.hh:117
ImgWriter
Definition: imgwriter.hh:49
BmpWriter::_imgExtension
static const char * _imgExtension
Definition: bmpwriter.hh:122
BmpWriter::InfoHeaderV1::SizeImage
uint32_t SizeImage
Definition: bmpwriter.hh:93
compiler.hh
Pixel
Internal gem5 representation of a Pixel.
Definition: pixel.hh:54
BmpWriter::FileHeader::magic_number
unsigned char magic_number[2]
Definition: bmpwriter.hh:79
BmpWriter::BmpPixel32
Definition: bmpwriter.hh:105
framebuffer.hh
BmpWriter
Definition: bmpwriter.hh:51
BmpWriter::M5_ATTR_PACKED
struct BmpWriter::FileHeader M5_ATTR_PACKED
BmpWriter::InfoHeaderV1::BitCount
uint16_t BitCount
Definition: bmpwriter.hh:91
FrameBuffer
Internal gem5 representation of a frame buffer.
Definition: framebuffer.hh:65
ImgWriter::fb
const FrameBuffer & fb
Definition: imgwriter.hh:71
BmpWriter::~BmpWriter
~BmpWriter()
Definition: bmpwriter.hh:60
BmpWriter::InfoHeaderV1::Size
uint32_t Size
Definition: bmpwriter.hh:87
BmpWriter::FileHeader::offset
uint32_t offset
Definition: bmpwriter.hh:83
BmpWriter::FileHeader
Definition: bmpwriter.hh:78
BmpWriter::CompleteV1Header
Definition: bmpwriter.hh:100
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:47
Pixel::green
uint8_t green
Definition: pixel.hh:63
BmpWriter::BmpPixel32::blue
uint8_t blue
Definition: bmpwriter.hh:114
BmpWriter::InfoHeaderV1::Planes
uint16_t Planes
Definition: bmpwriter.hh:90

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