src/base/bitmap.hh

   1 /*
   2  * Copyright (c) 2010 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  */
  40 #ifndef __BASE_BITMAP_HH__
  41 #define __BASE_BITMAP_HH__
  42
  43 #include <fstream>
  44
  45 #include "base/vnc/convert.hh"
  46
  47 /**
  48  * @file Declaration of a class that writes a frame buffer to a bitmap
  49  */
  50
  51
  52 // write frame buffer into a bitmap picture
  53 class  Bitmap
  54 {
  55   public:
  56     /** Create a Bitmap creator that takes data in the given mode & size
  57      * and outputs to an fstream
  58      * @param mode the type of data that is being provided
  59      * @param h the hight of the image
  60      * @param w the width of the image
  61      * @param d the data for the image in mode
  62      */
  63     Bitmap(VideoConvert::Mode mode, uint16_t w, uint16_t h, uint8_t *d);
  64
  65     /** Provide the converter with the data that should be output. It will be
  66      * converted into rgb8888 and write out when write() is called.
  67      * @param d the data
  68      */
  69     void rawData(uint8_t* d) { data = d; }
  70
  71     /** Write the provided data into the fstream provided
  72      * @param bmp stream to write to
  73      */
  74     void write(std::ostream *bmp);
  75
  76   private:
  77     VideoConvert::Mode mode;
  78     uint16_t height;
  79     uint16_t width;
  80     uint8_t *data;
  81
  82     VideoConvert vc;
  83
  84     struct Magic
  85     {
  86         unsigned char magic_number[2];
  87     };
  88
  89     struct Header
  90     {
  91         uint32_t size;
  92         uint16_t reserved1;
  93         uint16_t reserved2;
  94         uint32_t offset;
  95     };
  96
  97     struct Info
  98     {
  99         uint32_t Size;
 100         uint32_t Width;
 101         uint32_t Height;
 102         uint16_t Planes;
 103         uint16_t BitCount;
 104         uint32_t Compression;
 105         uint32_t SizeImage;
 106         uint32_t XPelsPerMeter;
 107         uint32_t YPelsPerMeter;
 108         uint32_t ClrUsed;
 109         uint32_t ClrImportant;
 110     };
 111 };
 112
 113 #endif // __BASE_BITMAP_HH__
 114