gem5  v20.1.0.0
bmpwriter.cc
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 
38 #include "base/bmpwriter.hh"
39 
40 #include <cassert>
41 
42 #include "base/logging.hh"
43 
44 const char* BmpWriter::_imgExtension = "bmp";
45 
46 // bitmap class ctor
48  : ImgWriter(_fb)
49 {
50 }
51 
54 {
55  const uint32_t pixel_array_size(sizeof(PixelType) * fb.area());
56  const uint32_t file_size(sizeof(CompleteV1Header) + pixel_array_size);
57 
58  const CompleteV1Header header = {
59  // File header
60  {
61  {'B','M'}, /* Magic */
62  file_size,
63  0, 0, /* Reserved */
64  sizeof(CompleteV1Header) /* Offset to pixel array */
65  },
66  // Info/DIB header
67  {
68  sizeof(InfoHeaderV1),
69  fb.width(),
70  fb.height(),
71  1, /* Color planes */
72  32, /* Bits per pixel */
73  0, /* No compression */
74  pixel_array_size, /* Image size in bytes */
75  2835, /* x pixels per meter (assume 72 DPI) */
76  2835, /* y pixels per meter (assume 72 DPI) */
77  0, /* Colors in color table */
78  0 /* Important color count (0 == all are important) */
79  }
80  };
81 
82  return header;
83 }
84 
85 void
86 BmpWriter::write(std::ostream &bmp) const
87 {
89 
90  // 1. write the header
91  bmp.write(reinterpret_cast<const char *>(&header), sizeof(header));
92 
93  // 2. write the bitmap data
94  // BMP start store data left to right starting with the bottom row
95  // so we need to do some creative flipping
96  std::vector<PixelType> line_buffer(fb.width());
97  for (int y = 0; y < fb.height(); ++y) {
98  for (unsigned x = 0; x < fb.width(); ++x)
99  line_buffer[x] = fb.pixel(x, fb.height() - y - 1);
100 
101  bmp.write(reinterpret_cast<const char *>(line_buffer.data()),
102  line_buffer.size() * sizeof(line_buffer[0]));
103  }
104 
105  bmp.flush();
106 }
107 
108 
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
header
output header
Definition: nop.cc:36
std::vector
STL vector class.
Definition: stl.hh:37
FrameBuffer::pixel
const Pixel & pixel(unsigned x, unsigned y) const
Get a pixel from an (x, y) coordinate.
Definition: framebuffer.hh:157
BmpWriter::getCompleteHeader
const CompleteV1Header getCompleteHeader() const
Definition: bmpwriter.cc:53
FrameBuffer::area
unsigned area() const
Total number of pixels in frame buffer.
Definition: framebuffer.hh:100
ImgWriter
Definition: imgwriter.hh:49
BmpWriter::_imgExtension
static const char * _imgExtension
Definition: bmpwriter.hh:122
RiscvISA::x
Bitfield< 3 > x
Definition: pagetable.hh:69
BmpWriter::BmpPixel32
Definition: bmpwriter.hh:105
bmpwriter.hh
FrameBuffer
Internal gem5 representation of a frame buffer.
Definition: framebuffer.hh:65
logging.hh
ImgWriter::fb
const FrameBuffer & fb
Definition: imgwriter.hh:71
FrameBuffer::width
unsigned width() const
Frame buffer width in pixels.
Definition: framebuffer.hh:96
FrameBuffer::height
unsigned height() const
Frame buffer height in pixels.
Definition: framebuffer.hh:98
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

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