Ali Saidi | d33c1d9 | 2011-02-11 18:29:35 -0600 | [diff] [blame] | 1 | /* |
Giacomo Travaglini | 12fb1ca | 2017-09-28 13:01:08 +0100 | [diff] [blame] | 2 | * Copyright (c) 2010, 2015, 2017 ARM Limited |
Ali Saidi | d33c1d9 | 2011-02-11 18:29:35 -0600 | [diff] [blame] | 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 |
Chris Emmons | 9aea847 | 2011-12-01 00:15:26 -0800 | [diff] [blame] | 39 | * Chris Emmons |
Andreas Sandberg | 1985d28 | 2015-05-23 13:37:01 +0100 | [diff] [blame] | 40 | * Andreas Sandberg |
Ali Saidi | d33c1d9 | 2011-02-11 18:29:35 -0600 | [diff] [blame] | 41 | */ |
| 42 | #ifndef __BASE_BITMAP_HH__ |
| 43 | #define __BASE_BITMAP_HH__ |
| 44 | |
Andreas Sandberg | 1985d28 | 2015-05-23 13:37:01 +0100 | [diff] [blame] | 45 | #include <ostream> |
Ali Saidi | d33c1d9 | 2011-02-11 18:29:35 -0600 | [diff] [blame] | 46 | |
Andreas Sandberg | 1985d28 | 2015-05-23 13:37:01 +0100 | [diff] [blame] | 47 | #include "base/compiler.hh" |
Andreas Sandberg | db5c9a5 | 2015-05-23 13:37:03 +0100 | [diff] [blame] | 48 | #include "base/framebuffer.hh" |
Giacomo Travaglini | 12fb1ca | 2017-09-28 13:01:08 +0100 | [diff] [blame] | 49 | #include "base/imgwriter.hh" |
Ali Saidi | d33c1d9 | 2011-02-11 18:29:35 -0600 | [diff] [blame] | 50 | |
| 51 | /** |
| 52 | * @file Declaration of a class that writes a frame buffer to a bitmap |
| 53 | */ |
| 54 | |
Ali Saidi | d33c1d9 | 2011-02-11 18:29:35 -0600 | [diff] [blame] | 55 | // write frame buffer into a bitmap picture |
Giacomo Travaglini | 12fb1ca | 2017-09-28 13:01:08 +0100 | [diff] [blame] | 56 | class BmpWriter : public ImgWriter |
Ali Saidi | d33c1d9 | 2011-02-11 18:29:35 -0600 | [diff] [blame] | 57 | { |
| 58 | public: |
Andreas Sandberg | 1985d28 | 2015-05-23 13:37:01 +0100 | [diff] [blame] | 59 | /** |
| 60 | * Create a bitmap that takes data in a given mode & size and |
| 61 | * outputs to an ostream. |
Ali Saidi | d33c1d9 | 2011-02-11 18:29:35 -0600 | [diff] [blame] | 62 | */ |
Giacomo Travaglini | 12fb1ca | 2017-09-28 13:01:08 +0100 | [diff] [blame] | 63 | BmpWriter(const FrameBuffer *fb); |
Ali Saidi | d33c1d9 | 2011-02-11 18:29:35 -0600 | [diff] [blame] | 64 | |
Giacomo Travaglini | 12fb1ca | 2017-09-28 13:01:08 +0100 | [diff] [blame] | 65 | ~BmpWriter() {}; |
| 66 | |
| 67 | /* |
| 68 | * Return Image format as a string |
| 69 | * |
| 70 | * @return img extension (e.g. bmp for Bitmap) |
| 71 | */ |
| 72 | const char* getImgExtension() const override |
| 73 | { return _imgExtension; } |
Chris Emmons | 9aea847 | 2011-12-01 00:15:26 -0800 | [diff] [blame] | 74 | |
Andreas Sandberg | 1985d28 | 2015-05-23 13:37:01 +0100 | [diff] [blame] | 75 | /** |
Andreas Sandberg | 1985d28 | 2015-05-23 13:37:01 +0100 | [diff] [blame] | 76 | * Write the frame buffer data into the provided ostream |
| 77 | * |
Ali Saidi | d33c1d9 | 2011-02-11 18:29:35 -0600 | [diff] [blame] | 78 | * @param bmp stream to write to |
| 79 | */ |
Giacomo Travaglini | 12fb1ca | 2017-09-28 13:01:08 +0100 | [diff] [blame] | 80 | void write(std::ostream &bmp) const override; |
Ali Saidi | d33c1d9 | 2011-02-11 18:29:35 -0600 | [diff] [blame] | 81 | |
| 82 | private: |
Andreas Sandberg | 1985d28 | 2015-05-23 13:37:01 +0100 | [diff] [blame] | 83 | struct FileHeader { |
Ali Saidi | d33c1d9 | 2011-02-11 18:29:35 -0600 | [diff] [blame] | 84 | unsigned char magic_number[2]; |
Ali Saidi | d33c1d9 | 2011-02-11 18:29:35 -0600 | [diff] [blame] | 85 | uint32_t size; |
| 86 | uint16_t reserved1; |
| 87 | uint16_t reserved2; |
| 88 | uint32_t offset; |
Andreas Sandberg | 1985d28 | 2015-05-23 13:37:01 +0100 | [diff] [blame] | 89 | } M5_ATTR_PACKED; |
Ali Saidi | d33c1d9 | 2011-02-11 18:29:35 -0600 | [diff] [blame] | 90 | |
Andreas Sandberg | 1985d28 | 2015-05-23 13:37:01 +0100 | [diff] [blame] | 91 | struct InfoHeaderV1 { /* Aka DIB header */ |
Ali Saidi | d33c1d9 | 2011-02-11 18:29:35 -0600 | [diff] [blame] | 92 | uint32_t Size; |
| 93 | uint32_t Width; |
| 94 | uint32_t Height; |
| 95 | uint16_t Planes; |
| 96 | uint16_t BitCount; |
| 97 | uint32_t Compression; |
| 98 | uint32_t SizeImage; |
| 99 | uint32_t XPelsPerMeter; |
| 100 | uint32_t YPelsPerMeter; |
| 101 | uint32_t ClrUsed; |
| 102 | uint32_t ClrImportant; |
Andreas Sandberg | 1985d28 | 2015-05-23 13:37:01 +0100 | [diff] [blame] | 103 | } M5_ATTR_PACKED; |
| 104 | |
| 105 | struct CompleteV1Header { |
| 106 | FileHeader file; |
| 107 | InfoHeaderV1 info; |
| 108 | } M5_ATTR_PACKED; |
| 109 | |
Andreas Sandberg | db5c9a5 | 2015-05-23 13:37:03 +0100 | [diff] [blame] | 110 | struct BmpPixel32 { |
| 111 | BmpPixel32 &operator=(const Pixel &rhs) { |
| 112 | red = rhs.red; |
| 113 | green = rhs.green; |
| 114 | blue = rhs.blue; |
| 115 | padding = 0; |
| 116 | |
| 117 | return *this; |
| 118 | } |
| 119 | uint8_t blue; |
| 120 | uint8_t green; |
| 121 | uint8_t red; |
| 122 | uint8_t padding; |
| 123 | } M5_ATTR_PACKED; |
| 124 | |
| 125 | typedef BmpPixel32 PixelType; |
Andreas Sandberg | 1985d28 | 2015-05-23 13:37:01 +0100 | [diff] [blame] | 126 | |
Giacomo Travaglini | 12fb1ca | 2017-09-28 13:01:08 +0100 | [diff] [blame] | 127 | static const char* _imgExtension; |
Andreas Sandberg | 1985d28 | 2015-05-23 13:37:01 +0100 | [diff] [blame] | 128 | |
Giacomo Travaglini | 12fb1ca | 2017-09-28 13:01:08 +0100 | [diff] [blame] | 129 | const CompleteV1Header getCompleteHeader() const; |
Ali Saidi | d33c1d9 | 2011-02-11 18:29:35 -0600 | [diff] [blame] | 130 | }; |
| 131 | |
Giacomo Travaglini | 12fb1ca | 2017-09-28 13:01:08 +0100 | [diff] [blame] | 132 | |
Ali Saidi | d33c1d9 | 2011-02-11 18:29:35 -0600 | [diff] [blame] | 133 | #endif // __BASE_BITMAP_HH__ |
| 134 | |