summaryrefslogtreecommitdiff
path: root/src/base/bitmap.hh
blob: b06aff10f880a85018c364670bdb159b1aa2e1e7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
/*
 * Copyright (c) 2010, 2015 ARM Limited
 * All rights reserved
 *
 * The license below extends only to copyright in the software and shall
 * not be construed as granting a license to any other intellectual
 * property including but not limited to intellectual property relating
 * to a hardware implementation of the functionality of the software
 * licensed hereunder.  You may use the software subject to the license
 * terms below provided that you ensure that this notice is replicated
 * unmodified and in its entirety in all distributions of the software,
 * modified or unmodified, in source code or in binary form.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met: redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer;
 * redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution;
 * neither the name of the copyright holders nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * Authors: William Wang
 *          Ali Saidi
 *          Chris Emmons
 *          Andreas Sandberg
 */
#ifndef __BASE_BITMAP_HH__
#define __BASE_BITMAP_HH__

#include <ostream>

#include "base/compiler.hh"
#include "base/vnc/convert.hh"

/**
 * @file Declaration of a class that writes a frame buffer to a bitmap
 */


// write frame buffer into a bitmap picture
class  Bitmap
{
  public:
    /**
     * Create a bitmap that takes data in a given mode & size and
     * outputs to an ostream.
     *
     * @param mode the type of data that is being provided
     * @param h the hight of the image
     * @param w the width of the image
     * @param d the data for the image in mode
     */
    Bitmap(VideoConvert::Mode mode, uint16_t w, uint16_t h, uint8_t *d);

    ~Bitmap();

    /**
     * Provide the converter with the data that should be output. It
     * will be converted into rgb8888 and written when write() is
     * called.
     *
     * @param d the data
     */
    void rawData(uint8_t* d) { data = d; }

    /**
     * Write the frame buffer data into the provided ostream
     *
     * @param bmp stream to write to
     */
    void write(std::ostream *bmp) const;

    /**
     * Gets a hash over the bitmap for quick comparisons to other bitmaps.
     *
     * @return hash of the bitmap
     */
    uint64_t getHash() const { return vc.getHash(data); }


  private:
    struct FileHeader {
        unsigned char magic_number[2];
        uint32_t size;
        uint16_t reserved1;
        uint16_t reserved2;
        uint32_t offset;
    } M5_ATTR_PACKED;

    struct InfoHeaderV1 { /* Aka DIB header */
        uint32_t Size;
        uint32_t Width;
        uint32_t Height;
        uint16_t Planes;
        uint16_t BitCount;
        uint32_t Compression;
        uint32_t SizeImage;
        uint32_t XPelsPerMeter;
        uint32_t YPelsPerMeter;
        uint32_t ClrUsed;
        uint32_t ClrImportant;
    } M5_ATTR_PACKED;

    struct CompleteV1Header {
        FileHeader file;
        InfoHeaderV1 info;
    } M5_ATTR_PACKED;

    typedef uint32_t PixelType;

    const CompleteV1Header getCompleteHeader() const;

    const uint16_t height;
    const uint16_t width;
    const CompleteV1Header header;
    uint8_t *data;

    VideoConvert vc;
};

#endif // __BASE_BITMAP_HH__