2 * Copyright (c) 2010 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 * Authors: William Wang
41 #ifndef __BASE_BITMAP_HH__
42 #define __BASE_BITMAP_HH__
46 #include "base/vnc/convert.hh"
49 * @file Declaration of a class that writes a frame buffer to a bitmap
53 // write frame buffer into a bitmap picture
57 /** Create a Bitmap creator that takes data in the given mode & size
58 * and outputs to an fstream
59 * @param mode the type of data that is being provided
60 * @param h the hight of the image
61 * @param w the width of the image
62 * @param d the data for the image in mode
64 Bitmap(VideoConvert::Mode mode, uint16_t w, uint16_t h, uint8_t *d);
69 /** Provide the converter with the data that should be output. It will be
70 * converted into rgb8888 and write out when write() is called.
73 void rawData(uint8_t* d) { data = d; }
75 /** Write the provided data into the fstream provided
76 * @param bmp stream to write to
78 void write(std::ostream *bmp) const;
80 /** Gets a hash over the bitmap for quick comparisons to other bitmaps.
81 * @return hash of the bitmap
83 uint64_t getHash() const { return vc.getHash(data); }
87 VideoConvert::Mode mode;
94 mutable char *headerBuffer;
95 static const size_t sizeofHeaderBuffer;
99 unsigned char magic_number[2];
117 uint32_t Compression;
119 uint32_t XPelsPerMeter;
120 uint32_t YPelsPerMeter;
122 uint32_t ClrImportant;
126 #endif // __BASE_BITMAP_HH__