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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef INCLUDED_BASEBMP_RGBMASKPIXELFORMATS_HXX
#define INCLUDED_BASEBMP_RGBMASKPIXELFORMATS_HXX
#include <basebmp/color.hxx>
#include <basebmp/colortraits.hxx>
#include <basebmp/accessor.hxx>
#include <basebmp/pixeliterator.hxx>
#include <basebmp/pixelformatadapters.hxx>
#include <basebmp/metafunctions.hxx>
#include <basebmp/endian.hxx>
#include <vigra/numerictraits.hxx>
#include <vigra/metaprogramming.hxx>
#include <functional>
namespace basebmp
{
/** Base class operating on RGB truecolor mask pixel
Use this template, if you have an (integer) pixel type, and three
bitmasks denoting where the channel bits are.
@tpl PixelType
Input pixel type to operate on
@tpl ColorType
Underlying color type, to convert the pixel values into
@tpl RedMask
Bitmask, to access the red bits in the data type
@tpl GreenMask
Bitmask, to access the green bits in the data type
@tpl BlueMask
Bitmask, to access the blue bits in the data type
@tpl SwapBytes
When true, the final pixel values will be byte-swapped before
passed on.
*/
template< typename PixelType,
typename ColorType,
unsigned int RedMask,
unsigned int GreenMask,
unsigned int BlueMask,
bool SwapBytes > struct RGBMaskFunctorBase
{
typedef PixelType pixel_type;
typedef ColorType color_type;
typedef typename make_unsigned<pixel_type>::type unsigned_pixel_type;
typedef typename ColorTraits<ColorType>::component_type component_type;
// calc corrective shifts for all three channels in advance
enum {
red_shift = numberOfTrailingZeros<RedMask>::value,
green_shift = numberOfTrailingZeros<GreenMask>::value,
blue_shift = numberOfTrailingZeros<BlueMask>::value,
red_bits = bitcount<RedMask>::value,
green_bits = bitcount<GreenMask>::value,
blue_bits = bitcount<BlueMask>::value
};
};
template< typename PixelType,
typename ColorType,
unsigned int RedMask,
unsigned int GreenMask,
unsigned int BlueMask,
bool SwapBytes > struct RGBMaskGetter :
public RGBMaskFunctorBase<PixelType,
ColorType,
RedMask,
GreenMask,
BlueMask,
SwapBytes>,
public std::unary_function<PixelType, ColorType>
{
typedef RGBMaskFunctorBase<PixelType,
ColorType,
RedMask,
GreenMask,
BlueMask,
SwapBytes> base_type;
ColorType operator()( PixelType v ) const
{
v = SwapBytes ? byteSwap(v) : v;
const typename base_type::unsigned_pixel_type red (v & RedMask);
const typename base_type::unsigned_pixel_type green(v & GreenMask);
const typename base_type::unsigned_pixel_type blue (v & BlueMask);
// shift color nibbles to right-aligned position. ORing it
// channel value shifted twice the number of channel bits, to
// spread the value into the component_type range
ColorType res( (shiftRight(red,
base_type::red_shift-8*
(signed)sizeof(typename base_type::component_type)+
base_type::red_bits)) |
(shiftRight(red,
base_type::red_shift-8*
(signed)sizeof(typename base_type::component_type)+
2*base_type::red_bits)),
(shiftRight(green,
base_type::green_shift-8*
(signed)sizeof(typename base_type::component_type)+
base_type::green_bits)) |
(shiftRight(green,
base_type::green_shift-8*
(signed)sizeof(typename base_type::component_type)+
2*base_type::green_bits)),
(shiftRight(blue,
base_type::blue_shift-8*
(signed)sizeof(typename base_type::component_type)+
base_type::blue_bits)) |
(shiftRight(blue,
base_type::blue_shift-8*
(signed)sizeof(typename base_type::component_type)+
2*base_type::blue_bits)) );
return res;
}
};
template< typename PixelType,
typename ColorType,
unsigned int BaseValue,
unsigned int RedMask,
unsigned int GreenMask,
unsigned int BlueMask,
bool SwapBytes > struct RGBMaskSetter :
public RGBMaskFunctorBase<PixelType,
ColorType,
RedMask,
GreenMask,
BlueMask,
SwapBytes>,
public std::unary_function<ColorType, PixelType>
{
typedef RGBMaskFunctorBase<PixelType,
ColorType,
RedMask,
GreenMask,
BlueMask,
SwapBytes> base_type;
PixelType operator()( ColorType const& c ) const
{
const typename base_type::unsigned_pixel_type red (c.getRed());
const typename base_type::unsigned_pixel_type green(c.getGreen());
const typename base_type::unsigned_pixel_type blue (c.getBlue());
typename base_type::unsigned_pixel_type res(
BaseValue |
(shiftLeft(red,
base_type::red_shift-8*
(signed)sizeof(typename base_type::component_type)+
base_type::red_bits) & RedMask) |
(shiftLeft(green,
base_type::green_shift-8*
(signed)sizeof(typename base_type::component_type)+
base_type::green_bits) & GreenMask) |
(shiftLeft(blue,
base_type::blue_shift-8*
(signed)sizeof(typename base_type::component_type)+
base_type::blue_bits) & BlueMask) );
return SwapBytes ? byteSwap(res) : res;
}
};
template< typename PixelType,
unsigned int BaseValue,
unsigned int RedMask,
unsigned int GreenMask,
unsigned int BlueMask,
bool SwapBytes > struct PixelFormatTraitsTemplate_RGBMask
{
typedef PixelType pixel_type;
typedef RGBMaskGetter<pixel_type,
Color,
RedMask,
GreenMask,
BlueMask,
SwapBytes> getter_type;
typedef RGBMaskSetter<pixel_type,
Color,
BaseValue,
RedMask,
GreenMask,
BlueMask,
SwapBytes> setter_type;
typedef PixelIterator<pixel_type> iterator_type;
typedef StandardAccessor<pixel_type> raw_accessor_type;
typedef AccessorSelector<
getter_type, setter_type> accessor_selector;
};
// Hopefully this is an understandable plaintext explanation that matches
// reality...
// BASEBMP_TRUECOLORMASK_LSB_SWAP means that on a big-endian platform, a pixel
// value when viewed as an integer (16 or 32 bits) has to be byte-swapped for
// the channels to match the masks. Or equivalently (I think), on a big-endian
// platform, the masks need to be byte-swapped to be correct.
// I.e. on a litte-endian platform the masks work as such.
// BASEBMP_TRUECOLORMASK_MSB_SWAP means the opposite. The masks work as such
// on big-endian platforms, on little-endian platforms the pixel needs to be
// byte-swapped for the masks to work.
// So in a sense these two names are "backward". It sounds to me as if
// BASEBMP_TRUECOLORMASK_LSB_SWAP would mean "when on LSB, swap" ;)
#ifdef OSL_LITENDIAN
# define BASEBMP_TRUECOLORMASK_LSB_SWAP false
# define BASEBMP_TRUECOLORMASK_MSB_SWAP true
#else
# ifdef OSL_BIGENDIAN
# define BASEBMP_TRUECOLORMASK_LSB_SWAP true
# define BASEBMP_TRUECOLORMASK_MSB_SWAP false
# else
# error Undetermined endianness!
# endif
#endif
// 16bpp MSB RGB
typedef PixelFormatTraitsTemplate_RGBMask<
sal_uInt16,
0,
0xF800,
0x07E0,
0x001F,
BASEBMP_TRUECOLORMASK_MSB_SWAP > PixelFormatTraits_RGB16_565_MSB;
BASEBMP_SPECIALIZE_ACCESSORTRAITS(PixelFormatTraits_RGB16_565_MSB::getter_type,
PixelFormatTraits_RGB16_565_MSB::setter_type);
// 16bpp LSB RGB
typedef PixelFormatTraitsTemplate_RGBMask<
sal_uInt16,
0,
0xF800,
0x07E0,
0x001F,
BASEBMP_TRUECOLORMASK_LSB_SWAP > PixelFormatTraits_RGB16_565_LSB;
BASEBMP_SPECIALIZE_ACCESSORTRAITS(PixelFormatTraits_RGB16_565_LSB::getter_type,
PixelFormatTraits_RGB16_565_LSB::setter_type);
// 32bpp formats
// The intent is that the order of channel names in the names of the 32bpp
// format typedefs below correspond to the order of the channel bytes in
// memory, if I understand correctly.... I think the point with the below
// formats is that the channel byte order in memory is the same regardless of
// platform byte order.
// This one used to be called PixelFormatTraits_RGB32_888.
typedef PixelFormatTraitsTemplate_RGBMask<
sal_uInt32,
0xFF000000,
0x00FF0000,
0x0000FF00,
0x000000FF,
BASEBMP_TRUECOLORMASK_LSB_SWAP > PixelFormatTraits_BGRA32_8888;
BASEBMP_SPECIALIZE_ACCESSORTRAITS(PixelFormatTraits_BGRA32_8888::getter_type,
PixelFormatTraits_BGRA32_8888::setter_type);
// This one used to be called PixelFormatTraits_BGR32_888.
typedef PixelFormatTraitsTemplate_RGBMask<
sal_uInt32,
0xFF000000,
0x00FF0000,
0x0000FF00,
0x000000FF,
BASEBMP_TRUECOLORMASK_MSB_SWAP > PixelFormatTraits_ARGB32_8888;
BASEBMP_SPECIALIZE_ACCESSORTRAITS(PixelFormatTraits_ARGB32_8888::getter_type,
PixelFormatTraits_ARGB32_8888::setter_type);
// The following two ones were added for Android needs and for completeness
typedef PixelFormatTraitsTemplate_RGBMask<
sal_uInt32,
0x000000FF,
0xFF000000,
0x00FF0000,
0x0000FF00,
BASEBMP_TRUECOLORMASK_LSB_SWAP > PixelFormatTraits_ABGR32_8888;
BASEBMP_SPECIALIZE_ACCESSORTRAITS(PixelFormatTraits_ABGR32_8888::getter_type,
PixelFormatTraits_ABGR32_8888::setter_type);
typedef PixelFormatTraitsTemplate_RGBMask<
sal_uInt32,
0x000000FF,
0xFF000000,
0x00FF0000,
0x0000FF00,
BASEBMP_TRUECOLORMASK_MSB_SWAP > PixelFormatTraits_RGBA32_8888;
BASEBMP_SPECIALIZE_ACCESSORTRAITS(PixelFormatTraits_RGBA32_8888::getter_type,
PixelFormatTraits_RGBA32_8888::setter_type);
// Added for Cairo needs, perhaps Android should get an XRGB and replace
// some uses of ARGB with that instead ?
typedef PixelFormatTraitsTemplate_RGBMask<
sal_uInt32,
0x00000000,
0x00FF0000,
0x0000FF00,
0x000000FF,
BASEBMP_TRUECOLORMASK_LSB_SWAP > PixelFormatTraits_BGRX32_8888;
BASEBMP_SPECIALIZE_ACCESSORTRAITS(PixelFormatTraits_BGRX32_8888::getter_type,
PixelFormatTraits_BGRX32_8888::setter_type);
} // namespace basebmp
#endif /* INCLUDED_BASEBMP_RGBMASKPIXELFORMATS_HXX */
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|