src/base/bitmap.hh

   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 #ifndef __BASE_BITMAP_HH__
  43 #define __BASE_BITMAP_HH__
  44
  45 #include <ostream>
  46
  47 #include "base/compiler.hh"
  48 #include "base/vnc/convert.hh"
  49
  50 /**
  51  * @file Declaration of a class that writes a frame buffer to a bitmap
  52  */
  53
  54
  55 // write frame buffer into a bitmap picture
  56 class  Bitmap
  57 {
  58   public:
  59     /**
  60      * Create a bitmap that takes data in a given mode & size and
  61      * outputs to an ostream.
  62      *
  63      * @param mode the type of data that is being provided
  64      * @param h the hight of the image
  65      * @param w the width of the image
  66      * @param d the data for the image in mode
  67      */
  68     Bitmap(VideoConvert::Mode mode, uint16_t w, uint16_t h, uint8_t *d);
  69
  70     ~Bitmap();
  71
  72     /**
  73      * Provide the converter with the data that should be output. It
  74      * will be converted into rgb8888 and written when write() is
  75      * called.
  76      *
  77      * @param d the data
  78      */
  79     void rawData(uint8_t* d) { data = d; }
  80
  81     /**
  82      * Write the frame buffer data into the provided ostream
  83      *
  84      * @param bmp stream to write to
  85      */
  86     void write(std::ostream *bmp) const;
  87
  88     /**
  89      * Gets a hash over the bitmap for quick comparisons to other bitmaps.
  90      *
  91      * @return hash of the bitmap
  92      */
  93     uint64_t getHash() const { return vc.getHash(data); }
  94
  95
  96   private:
  97     struct FileHeader {
  98         unsigned char magic_number[2];
  99         uint32_t size;
 100         uint16_t reserved1;
 101         uint16_t reserved2;
 102         uint32_t offset;
 103     } M5_ATTR_PACKED;
 104
 105     struct InfoHeaderV1 { /* Aka DIB header */
 106         uint32_t Size;
 107         uint32_t Width;
 108         uint32_t Height;
 109         uint16_t Planes;
 110         uint16_t BitCount;
 111         uint32_t Compression;
 112         uint32_t SizeImage;
 113         uint32_t XPelsPerMeter;
 114         uint32_t YPelsPerMeter;
 115         uint32_t ClrUsed;
 116         uint32_t ClrImportant;
 117     } M5_ATTR_PACKED;
 118
 119     struct CompleteV1Header {
 120         FileHeader file;
 121         InfoHeaderV1 info;
 122     } M5_ATTR_PACKED;
 123
 124     typedef uint32_t PixelType;
 125
 126     const CompleteV1Header getCompleteHeader() const;
 127
 128     const uint16_t height;
 129     const uint16_t width;
 130     const CompleteV1Header header;
 131     uint8_t *data;
 132
 133     VideoConvert vc;
 134 };
 135
 136 #endif // __BASE_BITMAP_HH__
 137