base: Redesign internal frame buffer handling
[gem5.git] / src / base / bitmap.cc
1 /*
2 * Copyright (c) 2010, 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 * Authors: William Wang
38 * Ali Saidi
39 * Chris Emmons
40 * Andreas Sandberg
41 */
42
43 #include "base/bitmap.hh"
44
45 #include <cassert>
46
47 #include "base/misc.hh"
48
49 // bitmap class ctor
50 Bitmap::Bitmap(const FrameBuffer *_fb)
51 : fb(*_fb)
52 {
53 }
54
55 Bitmap::~Bitmap()
56 {
57 }
58
59 const Bitmap::CompleteV1Header
60 Bitmap::getCompleteHeader() const
61 {
62 const uint32_t pixel_array_size(sizeof(PixelType) * fb.area());
63 const uint32_t file_size(sizeof(CompleteV1Header) + pixel_array_size);
64
65 const CompleteV1Header header = {
66 // File header
67 {
68 {'B','M'}, /* Magic */
69 file_size,
70 0, 0, /* Reserved */
71 sizeof(CompleteV1Header) /* Offset to pixel array */
72 },
73 // Info/DIB header
74 {
75 sizeof(InfoHeaderV1),
76 fb.width(),
77 fb.height(),
78 1, /* Color planes */
79 32, /* Bits per pixel */
80 0, /* No compression */
81 pixel_array_size, /* Image size in bytes */
82 2835, /* x pixels per meter (assume 72 DPI) */
83 2835, /* y pixels per meter (assume 72 DPI) */
84 0, /* Colors in color table */
85 0 /* Important color count (0 == all are important) */
86 }
87 };
88
89 return header;
90 }
91
92 void
93 Bitmap::write(std::ostream &bmp) const
94 {
95 const CompleteV1Header header(getCompleteHeader());
96
97 // 1. write the header
98 bmp.write(reinterpret_cast<const char *>(&header), sizeof(header));
99
100 // 2. write the bitmap data
101 // BMP start store data left to right starting with the bottom row
102 // so we need to do some creative flipping
103 std::vector<PixelType> line_buffer(fb.width());
104 for (int y = 0; y < fb.height(); ++y) {
105 for (unsigned x = 0; x < fb.width(); ++x)
106 line_buffer[x] = fb.pixel(x, fb.height() - y - 1);
107
108 bmp.write(reinterpret_cast<const char *>(line_buffer.data()),
109 line_buffer.size() * sizeof(line_buffer[0]));
110 }
111
112 bmp.flush();
113 }
114