Tarball tree for barry-0.17.0.tar.bz2
[barry.git] / doc / www / doxygen / html / bmp_8cc-source.html
blob99948232da6d2304acbfcde10318152d24f27ff3
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3 <title>Barry: bmp.cc Source File</title>
4 <link href="doxygen.css" rel="stylesheet" type="text/css">
5 <link href="tabs.css" rel="stylesheet" type="text/css">
6 </head><body>
7 <!-- Generated by Doxygen 1.5.6 -->
8 <div class="navigation" id="top">
9 <div class="tabs">
10 <ul>
11 <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
12 <li><a href="modules.html"><span>Modules</span></a></li>
13 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
14 <li><a href="classes.html"><span>Classes</span></a></li>
15 <li class="current"><a href="files.html"><span>Files</span></a></li>
16 <li><a href="dirs.html"><span>Directories</span></a></li>
17 </ul>
18 </div>
19 <div class="navpath"><a class="el" href="dir_edc0f428e3eefcfdce9c25befd901c57.html">src</a>
20 </div>
21 </div>
22 <div class="contents">
23 <h1>bmp.cc</h1><a href="bmp_8cc.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">///</span>
24 <a name="l00002"></a>00002 <span class="comment"></span><span class="comment">/// \file bmp.cc</span>
25 <a name="l00003"></a>00003 <span class="comment"></span><span class="comment">/// BMP conversion routines</span>
26 <a name="l00004"></a>00004 <span class="comment"></span><span class="comment">///</span>
27 <a name="l00005"></a>00005 <span class="comment"></span>
28 <a name="l00006"></a>00006 <span class="comment">/*</span>
29 <a name="l00007"></a>00007 <span class="comment"> Copyright (C) 2009-2011, Net Direct Inc. (http://www.netdirect.ca/)</span>
30 <a name="l00008"></a>00008 <span class="comment"> Copyright (C) 2008-2009, Nicolas VIVIEN</span>
31 <a name="l00009"></a>00009 <span class="comment"></span>
32 <a name="l00010"></a>00010 <span class="comment"> This program is free software; you can redistribute it and/or modify</span>
33 <a name="l00011"></a>00011 <span class="comment"> it under the terms of the GNU General Public License as published by</span>
34 <a name="l00012"></a>00012 <span class="comment"> the Free Software Foundation; either version 2 of the License, or</span>
35 <a name="l00013"></a>00013 <span class="comment"> (at your option) any later version.</span>
36 <a name="l00014"></a>00014 <span class="comment"></span>
37 <a name="l00015"></a>00015 <span class="comment"> This program is distributed in the hope that it will be useful,</span>
38 <a name="l00016"></a>00016 <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
39 <a name="l00017"></a>00017 <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.</span>
40 <a name="l00018"></a>00018 <span class="comment"></span>
41 <a name="l00019"></a>00019 <span class="comment"> See the GNU General Public License in the COPYING file at the</span>
42 <a name="l00020"></a>00020 <span class="comment"> root directory of this project for more details.</span>
43 <a name="l00021"></a>00021 <span class="comment">*/</span>
44 <a name="l00022"></a>00022
45 <a name="l00023"></a>00023 <span class="preprocessor">#include "<a class="code" href="bmp_8h.html" title="BMP conversion routines.">bmp.h</a>"</span>
46 <a name="l00024"></a>00024 <span class="preprocessor">#include "<a class="code" href="bmp-internal_8h.html" title="BMP structures.">bmp-internal.h</a>"</span>
47 <a name="l00025"></a>00025 <span class="preprocessor">#include "<a class="code" href="error_8h.html" title="Common exception classes for the Barry library.">error.h</a>"</span>
48 <a name="l00026"></a>00026 <span class="preprocessor">#include "<a class="code" href="endian_8h.html" title="Endian conversion macros.">endian.h</a>"</span>
49 <a name="l00027"></a>00027
50 <a name="l00028"></a>00028 <span class="keyword">namespace </span>Barry {
51 <a name="l00029"></a>00029
52 <a name="l00030"></a>00030 <span class="comment">//</span>
53 <a name="l00031"></a>00031 <span class="comment">// GetTotalBitmapSize</span>
54 <a name="l00032"></a>00032 <span class="comment">//</span><span class="comment"></span>
55 <a name="l00033"></a>00033 <span class="comment">/// Returns the total number of bytes needed to convert a</span>
56 <a name="l00034"></a>00034 <span class="comment">/// screenshot of the given dimensions into a bitmap,</span>
57 <a name="l00035"></a>00035 <span class="comment">/// using the ScreenshotToBitmap() function.</span>
58 <a name="l00036"></a>00036 <span class="comment">///</span>
59 <a name="l00037"></a><a class="code" href="namespaceBarry.html#e9d92a617771de40f7bb5a15b8da1807">00037</a> <span class="comment"></span>BXEXPORT <span class="keywordtype">size_t</span> <a class="code" href="namespaceBarry.html#e9d92a617771de40f7bb5a15b8da1807" title="Returns the total number of bytes needed to convert a screenshot of the given dimensions...">GetTotalBitmapSize</a>(<span class="keyword">const</span> JLScreenInfo &amp;info)
60 <a name="l00038"></a>00038 {
61 <a name="l00039"></a>00039 <span class="keywordflow">return</span> <span class="keyword">sizeof</span>(bmp_file_header_t) +
62 <a name="l00040"></a>00040 <span class="keyword">sizeof</span>(bmp_info_header_t) +
63 <a name="l00041"></a>00041 (info.width * info.height * 4); <span class="comment">// 4 byte RGB per pixel</span>
64 <a name="l00042"></a>00042
65 <a name="l00043"></a>00043 }
66 <a name="l00044"></a>00044
67 <a name="l00045"></a>00045 <span class="comment">//</span>
68 <a name="l00046"></a>00046 <span class="comment">// ScreenshotToBitmap</span>
69 <a name="l00047"></a>00047 <span class="comment">//</span><span class="comment"></span>
70 <a name="l00048"></a>00048 <span class="comment">/// Converts screenshot data obtained via JavaLoader::GetScreenshot()</span>
71 <a name="l00049"></a>00049 <span class="comment">/// into uncompressed bitmap format, suitable for writing BMP files.</span>
72 <a name="l00050"></a>00050 <span class="comment">/// Arguments info and screenshot come from GetScreenshot() and the</span>
73 <a name="l00051"></a>00051 <span class="comment">/// converted data is stored in bitmap.</span>
74 <a name="l00052"></a>00052 <span class="comment">///</span>
75 <a name="l00053"></a>00053 <span class="comment"></span><span class="comment">//</span>
76 <a name="l00054"></a>00054 <span class="comment">// This function assumes that the btoh() converter functions match</span>
77 <a name="l00055"></a>00055 <span class="comment">// the needs of the bitmap file format. Namely: little endian.</span>
78 <a name="l00056"></a>00056 <span class="comment">//</span>
79 <a name="l00057"></a><a class="code" href="namespaceBarry.html#9da780aab46e04d16fddd855c85933ba">00057</a> BXEXPORT <span class="keywordtype">void</span> <a class="code" href="namespaceBarry.html#9da780aab46e04d16fddd855c85933ba" title="Converts screenshot data obtained via JavaLoader::GetScreenshot() into uncompressed...">ScreenshotToBitmap</a>(<span class="keyword">const</span> JLScreenInfo &amp;info,
80 <a name="l00058"></a>00058 <span class="keyword">const</span> Data &amp;screenshot,
81 <a name="l00059"></a>00059 Data &amp;bitmap)
82 <a name="l00060"></a>00060 {
83 <a name="l00061"></a>00061 <span class="comment">// Read screen info</span>
84 <a name="l00062"></a>00062 <span class="keywordtype">size_t</span> width = info.width;
85 <a name="l00063"></a>00063 <span class="keywordtype">size_t</span> height = info.height;
86 <a name="l00064"></a>00064 <span class="keywordtype">size_t</span> total_bitmap_size = <a class="code" href="namespaceBarry.html#e9d92a617771de40f7bb5a15b8da1807" title="Returns the total number of bytes needed to convert a screenshot of the given dimensions...">GetTotalBitmapSize</a>(info);
87 <a name="l00065"></a>00065
88 <a name="l00066"></a>00066 <span class="comment">// make sure there is enough screeshot pixel data for the</span>
89 <a name="l00067"></a>00067 <span class="comment">// given width and height</span>
90 <a name="l00068"></a>00068 <span class="keywordflow">if</span>( screenshot.GetSize() &lt; (width * height * 2) ) <span class="comment">// 2 byte screenshot pixel data</span>
91 <a name="l00069"></a>00069 <span class="keywordflow">throw</span> <a class="code" href="classBarry_1_1Error.html" title="The base class for any future derived exceptions.">Error</a>(<span class="stringliteral">"Screenshot data size is too small for given width+height"</span>);
92 <a name="l00070"></a>00070
93 <a name="l00071"></a>00071
94 <a name="l00072"></a>00072 <span class="comment">// setup write pointer</span>
95 <a name="l00073"></a>00073 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *write = bitmap.GetBuffer(total_bitmap_size);
96 <a name="l00074"></a>00074
97 <a name="l00075"></a>00075 <span class="comment">//</span>
98 <a name="l00076"></a>00076 <span class="comment">// Build header BMP file</span>
99 <a name="l00077"></a>00077 <span class="comment">//</span>
100 <a name="l00078"></a>00078 bmp_file_header_t *fileheader = (bmp_file_header_t*) write;
101 <a name="l00079"></a>00079 write += <span class="keyword">sizeof</span>(bmp_file_header_t);
102 <a name="l00080"></a>00080
103 <a name="l00081"></a>00081 <span class="comment">// BMP</span>
104 <a name="l00082"></a>00082 fileheader-&gt;bfType[0] = <span class="charliteral">'B'</span>;
105 <a name="l00083"></a>00083 fileheader-&gt;bfType[1] = <span class="charliteral">'M'</span>;
106 <a name="l00084"></a>00084
107 <a name="l00085"></a>00085 <span class="comment">// Size of file</span>
108 <a name="l00086"></a>00086 fileheader-&gt;bfSize = btohl(total_bitmap_size);
109 <a name="l00087"></a>00087
110 <a name="l00088"></a>00088 <span class="comment">// Always 0x00</span>
111 <a name="l00089"></a>00089 fileheader-&gt;bfReserved1 = 0;
112 <a name="l00090"></a>00090 fileheader-&gt;bfReserved2 = 0;
113 <a name="l00091"></a>00091
114 <a name="l00092"></a>00092 <span class="comment">// Offset to find the data</span>
115 <a name="l00093"></a>00093 fileheader-&gt;bfOffBits = btohl(<span class="keyword">sizeof</span>(bmp_file_header_t) + <span class="keyword">sizeof</span>(bmp_info_header_t));
116 <a name="l00094"></a>00094
117 <a name="l00095"></a>00095
118 <a name="l00096"></a>00096 <span class="comment">//</span>
119 <a name="l00097"></a>00097 <span class="comment">// Build info BMP file</span>
120 <a name="l00098"></a>00098 <span class="comment">//</span>
121 <a name="l00099"></a>00099 bmp_info_header_t *infoheader = (bmp_info_header_t*) write;
122 <a name="l00100"></a>00100 write += <span class="keyword">sizeof</span>(bmp_info_header_t);
123 <a name="l00101"></a>00101
124 <a name="l00102"></a>00102 <span class="comment">// Size of info section</span>
125 <a name="l00103"></a>00103 infoheader-&gt;biSize = btohl(<span class="keyword">sizeof</span>(bmp_info_header_t));
126 <a name="l00104"></a>00104
127 <a name="l00105"></a>00105 <span class="comment">// Width x Height</span>
128 <a name="l00106"></a>00106 infoheader-&gt;biWidth = btohl(width);
129 <a name="l00107"></a>00107 infoheader-&gt;biHeight = btohl(height);
130 <a name="l00108"></a>00108
131 <a name="l00109"></a>00109 <span class="comment">// Planes number</span>
132 <a name="l00110"></a>00110 infoheader-&gt;biPlanes = btohs(0x01);
133 <a name="l00111"></a>00111
134 <a name="l00112"></a>00112 <span class="comment">// Bit count</span>
135 <a name="l00113"></a>00113 infoheader-&gt;biBitCount = btohs(0x20);
136 <a name="l00114"></a>00114
137 <a name="l00115"></a>00115 <span class="comment">// Compression : No</span>
138 <a name="l00116"></a>00116 infoheader-&gt;biCompression = 0;
139 <a name="l00117"></a>00117
140 <a name="l00118"></a>00118 <span class="comment">// Size of image</span>
141 <a name="l00119"></a>00119 infoheader-&gt;biSizeImage = btohl(4 * width * height);
142 <a name="l00120"></a>00120
143 <a name="l00121"></a>00121 <span class="comment">// Pels Per Meter</span>
144 <a name="l00122"></a>00122 infoheader-&gt;biXPelsPerMeter = 0;
145 <a name="l00123"></a>00123 infoheader-&gt;biYPelsPerMeter = 0;
146 <a name="l00124"></a>00124
147 <a name="l00125"></a>00125 <span class="comment">// Color palette used : None</span>
148 <a name="l00126"></a>00126 infoheader-&gt;biClrUsed = 0;
149 <a name="l00127"></a>00127
150 <a name="l00128"></a>00128 <span class="comment">// Color palette important : None</span>
151 <a name="l00129"></a>00129 infoheader-&gt;biClrImportant = 0;
152 <a name="l00130"></a>00130
153 <a name="l00131"></a>00131
154 <a name="l00132"></a>00132 <span class="comment">// I work with 2 bytes (see the pixel format)</span>
155 <a name="l00133"></a>00133 <span class="keyword">const</span> uint16_t *data = (<span class="keyword">const</span> uint16_t*) screenshot.GetData();
156 <a name="l00134"></a>00134 <span class="keywordtype">size_t</span> pixel_count = width * height;
157 <a name="l00135"></a>00135
158 <a name="l00136"></a>00136 <span class="comment">// For each pixel... (note BMP format is up and backwards, hence</span>
159 <a name="l00137"></a>00137 <span class="comment">// offset calculation for each pixel in for loop)</span>
160 <a name="l00138"></a>00138 <span class="keywordflow">for</span> (<span class="keywordtype">size_t</span> j=0; j&lt;height; j++) {
161 <a name="l00139"></a>00139 <span class="keywordflow">for</span> (<span class="keywordtype">size_t</span> i=0; i&lt;width; i++) {
162 <a name="l00140"></a>00140 <span class="comment">// Read one pixel in the picture</span>
163 <a name="l00141"></a>00141 <span class="keywordtype">short</span> value = data[(pixel_count - 1) - ((width-1 - i) + (width * j))];
164 <a name="l00142"></a>00142
165 <a name="l00143"></a>00143 <span class="comment">// Pixel format used by the handheld is : 16 bits</span>
166 <a name="l00144"></a>00144 <span class="comment">// MSB &lt; .... .... .... .... &gt; LSB</span>
167 <a name="l00145"></a>00145 <span class="comment">// ^^^^^^ : Blue (between 0x00 and 0x1F)</span>
168 <a name="l00146"></a>00146 <span class="comment">// ^^^^^^^ : Green (between 0x00 and 0x3F)</span>
169 <a name="l00147"></a>00147 <span class="comment">// ^^^^^^ : Red (between 0x00 and 0x1F)</span>
170 <a name="l00148"></a>00148
171 <a name="l00149"></a>00149 write[3] = 0x00; <span class="comment">// alpha</span>
172 <a name="l00150"></a>00150 write[2] = (((value &gt;&gt; 11) &amp; 0x1F) * 0xFF) / 0x1F; <span class="comment">// red</span>
173 <a name="l00151"></a>00151 write[1] = (((value &gt;&gt; 5) &amp; 0x3F) * 0xFF) / 0x3F; <span class="comment">// green</span>
174 <a name="l00152"></a>00152 write[0] = ((value &amp; 0x1F) * 0xFF) / 0x1F; <span class="comment">// blue</span>
175 <a name="l00153"></a>00153
176 <a name="l00154"></a>00154 write += 4;
177 <a name="l00155"></a>00155 }
178 <a name="l00156"></a>00156 }
179 <a name="l00157"></a>00157
180 <a name="l00158"></a>00158 bitmap.ReleaseBuffer(total_bitmap_size);
181 <a name="l00159"></a>00159 }
182 <a name="l00160"></a>00160
183 <a name="l00161"></a>00161 } <span class="comment">// namespace Barry</span>
184 <a name="l00162"></a>00162
185 </pre></div></div>
186 <hr size="1"><address style="text-align: right;"><small>Generated on Thu Feb 10 16:13:57 2011 for Barry by&nbsp;
187 <a href="http://www.doxygen.org/index.html">
188 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
189 </body>
190 </html>