2 * Copyright (c) 2010, 2015, 2017 ARM Limited
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.
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.
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.
37 #ifndef __BASE_BITMAP_HH__
38 #define __BASE_BITMAP_HH__
42 #include "base/compiler.hh"
43 #include "base/framebuffer.hh"
44 #include "base/imgwriter.hh"
47 * @file Declaration of a class that writes a frame buffer to a bitmap
50 // write frame buffer into a bitmap picture
51 class BmpWriter : public ImgWriter
55 * Create a bitmap that takes data in a given mode & size and
56 * outputs to an ostream.
58 BmpWriter(const FrameBuffer *fb);
63 * Return Image format as a string
65 * @return img extension (e.g. bmp for Bitmap)
67 const char* getImgExtension() const override
68 { return _imgExtension; }
71 * Write the frame buffer data into the provided ostream
73 * @param bmp stream to write to
75 void write(std::ostream &bmp) const override;
78 struct M5_ATTR_PACKED FileHeader {
79 unsigned char magic_number[2];
86 struct M5_ATTR_PACKED InfoHeaderV1 { /* Aka DIB header */
94 uint32_t XPelsPerMeter;
95 uint32_t YPelsPerMeter;
97 uint32_t ClrImportant;
100 struct M5_ATTR_PACKED CompleteV1Header {
105 struct M5_ATTR_PACKED BmpPixel32 {
106 BmpPixel32 &operator=(const Pixel &rhs) {
120 typedef BmpPixel32 PixelType;
122 static const char* _imgExtension;
124 const CompleteV1Header getCompleteHeader() const;
128 #endif // __BASE_BITMAP_HH__