Constantin Kaplinsky | a2adc8d | 2006-05-25 05:01:55 +0000 | [diff] [blame] | 1 | /* Copyright (C) 2002-2005 RealVNC Ltd. All Rights Reserved. |
DRC | ffe09d6 | 2011-08-17 02:27:59 +0000 | [diff] [blame] | 2 | * Copyright (C) 2011 D. R. Commander. All Rights Reserved. |
Pierre Ossman | 6655d96 | 2014-01-20 14:50:19 +0100 | [diff] [blame] | 3 | * Copyright 2009-2014 Pierre Ossman for Cendio AB |
Constantin Kaplinsky | a2adc8d | 2006-05-25 05:01:55 +0000 | [diff] [blame] | 4 | * |
| 5 | * This is free software; you can redistribute it and/or modify |
| 6 | * it under the terms of the GNU General Public License as published by |
| 7 | * the Free Software Foundation; either version 2 of the License, or |
| 8 | * (at your option) any later version. |
| 9 | * |
| 10 | * This software is distributed in the hope that it will be useful, |
| 11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 13 | * GNU General Public License for more details. |
| 14 | * |
| 15 | * You should have received a copy of the GNU General Public License |
| 16 | * along with this software; if not, write to the Free Software |
| 17 | * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, |
| 18 | * USA. |
| 19 | */ |
| 20 | // |
| 21 | // PixelFormat - structure to represent a pixel format. Also has useful |
Pierre Ossman | 823665c | 2014-01-20 16:55:19 +0100 | [diff] [blame] | 22 | // methods for reading & writing to streams, etc. Conversion to and from |
| 23 | // other formats are also handled by this class. We have three different |
| 24 | // representations that we refer to: |
| 25 | // |
| 26 | // a) Pixels - Unsigned native integers in the format specified by this |
| 27 | // PixelFormat object. |
| 28 | // b) Buffer - Same thing as pixels, but in the appropriate byte stream |
| 29 | // format. This involves endian conversion and padding. |
| 30 | // c) RGB - A byte stream of 8 bit red, green and blue elements, in that |
| 31 | // order. |
Constantin Kaplinsky | a2adc8d | 2006-05-25 05:01:55 +0000 | [diff] [blame] | 32 | // |
| 33 | |
| 34 | #ifndef __RFB_PIXELFORMAT_H__ |
| 35 | #define __RFB_PIXELFORMAT_H__ |
| 36 | |
| 37 | #include <rfb/Pixel.h> |
Constantin Kaplinsky | a2adc8d | 2006-05-25 05:01:55 +0000 | [diff] [blame] | 38 | |
| 39 | namespace rdr { class InStream; class OutStream; } |
| 40 | |
| 41 | namespace rfb { |
| 42 | |
| 43 | class PixelFormat { |
| 44 | public: |
| 45 | PixelFormat(int b, int d, bool e, bool t, |
Pierre Ossman | b6b4dc6 | 2014-01-20 15:05:21 +0100 | [diff] [blame] | 46 | int rm, int gm, int bm, int rs, int gs, int bs); |
Constantin Kaplinsky | a2adc8d | 2006-05-25 05:01:55 +0000 | [diff] [blame] | 47 | PixelFormat(); |
Pierre Ossman | 67b2b2f | 2009-03-06 10:12:55 +0000 | [diff] [blame] | 48 | |
Pierre Ossman | b6b4dc6 | 2014-01-20 15:05:21 +0100 | [diff] [blame] | 49 | // Checks if the formats have identical buffer representation. |
| 50 | // They might still have different pixel representation, endianness |
| 51 | // or true colour state. |
Constantin Kaplinsky | a2adc8d | 2006-05-25 05:01:55 +0000 | [diff] [blame] | 52 | bool equal(const PixelFormat& other) const; |
Pierre Ossman | 67b2b2f | 2009-03-06 10:12:55 +0000 | [diff] [blame] | 53 | |
Constantin Kaplinsky | a2adc8d | 2006-05-25 05:01:55 +0000 | [diff] [blame] | 54 | void read(rdr::InStream* is); |
| 55 | void write(rdr::OutStream* os) const; |
Pierre Ossman | 67b2b2f | 2009-03-06 10:12:55 +0000 | [diff] [blame] | 56 | |
| 57 | bool is888(void) const; |
| 58 | bool isBigEndian(void) const; |
| 59 | bool isLittleEndian(void) const; |
| 60 | |
| 61 | inline Pixel pixelFromBuffer(const rdr::U8* buffer) const; |
Pierre Ossman | 19501b8 | 2009-03-31 14:06:53 +0000 | [diff] [blame] | 62 | inline void bufferFromPixel(rdr::U8* buffer, Pixel pixel) const; |
Pierre Ossman | 67b2b2f | 2009-03-06 10:12:55 +0000 | [diff] [blame] | 63 | |
Pierre Ossman | b6b4dc6 | 2014-01-20 15:05:21 +0100 | [diff] [blame] | 64 | inline Pixel pixelFromRGB(rdr::U16 red, rdr::U16 green, rdr::U16 blue) const; |
| 65 | inline Pixel pixelFromRGB(rdr::U8 red, rdr::U8 green, rdr::U8 blue) const; |
Pierre Ossman | 67b2b2f | 2009-03-06 10:12:55 +0000 | [diff] [blame] | 66 | |
Pierre Ossman | b6b4dc6 | 2014-01-20 15:05:21 +0100 | [diff] [blame] | 67 | void bufferFromRGB(rdr::U8 *dst, const rdr::U8* src, int pixels) const; |
| 68 | void bufferFromRGB(rdr::U8 *dst, const rdr::U8* src, |
| 69 | int w, int stride, int h) const; |
Pierre Ossman | 19501b8 | 2009-03-31 14:06:53 +0000 | [diff] [blame] | 70 | |
Pierre Ossman | b6b4dc6 | 2014-01-20 15:05:21 +0100 | [diff] [blame] | 71 | inline void rgbFromPixel(Pixel pix, rdr::U16 *r, rdr::U16 *g, rdr::U16 *b) const; |
| 72 | inline void rgbFromPixel(Pixel pix, rdr::U8 *r, rdr::U8 *g, rdr::U8 *b) const; |
Pierre Ossman | 67b2b2f | 2009-03-06 10:12:55 +0000 | [diff] [blame] | 73 | |
Pierre Ossman | b6b4dc6 | 2014-01-20 15:05:21 +0100 | [diff] [blame] | 74 | void rgbFromBuffer(rdr::U8* dst, const rdr::U8* src, int pixels) const; |
| 75 | void rgbFromBuffer(rdr::U8* dst, const rdr::U8* src, |
| 76 | int w, int stride, int h) const; |
Pierre Ossman | 67b2b2f | 2009-03-06 10:12:55 +0000 | [diff] [blame] | 77 | |
Pierre Ossman | 761fe24 | 2014-01-29 17:00:36 +0100 | [diff] [blame] | 78 | Pixel pixelFromPixel(const PixelFormat &srcPF, Pixel src) const; |
| 79 | |
| 80 | void bufferFromBuffer(rdr::U8* dst, const PixelFormat &srcPF, |
| 81 | const rdr::U8* src, int pixels) const; |
| 82 | void bufferFromBuffer(rdr::U8* dst, const PixelFormat &srcPF, |
| 83 | const rdr::U8* src, int w, int h, |
| 84 | int dstStride, int srcStride) const; |
| 85 | |
Constantin Kaplinsky | a2adc8d | 2006-05-25 05:01:55 +0000 | [diff] [blame] | 86 | void print(char* str, int len) const; |
| 87 | bool parse(const char* str); |
| 88 | |
Pierre Ossman | 67b2b2f | 2009-03-06 10:12:55 +0000 | [diff] [blame] | 89 | protected: |
Pierre Ossman | 19dbca2 | 2009-04-21 17:30:45 +0000 | [diff] [blame] | 90 | void updateState(void); |
Pierre Ossman | 6655d96 | 2014-01-20 14:50:19 +0100 | [diff] [blame] | 91 | bool isSane(void); |
Pierre Ossman | 67b2b2f | 2009-03-06 10:12:55 +0000 | [diff] [blame] | 92 | |
Pierre Ossman | c02c05d | 2014-01-30 10:47:07 +0100 | [diff] [blame] | 93 | private: |
| 94 | // Preprocessor generated, optimised methods |
| 95 | |
| 96 | void directBufferFromBufferFrom888(rdr::U8* dst, const PixelFormat &srcPF, |
| 97 | const rdr::U8* src, int w, int h, |
| 98 | int dstStride, int srcStride) const; |
| 99 | void directBufferFromBufferFrom888(rdr::U16* dst, const PixelFormat &srcPF, |
| 100 | const rdr::U8* src, int w, int h, |
| 101 | int dstStride, int srcStride) const; |
| 102 | void directBufferFromBufferFrom888(rdr::U32* dst, const PixelFormat &srcPF, |
| 103 | const rdr::U8* src, int w, int h, |
| 104 | int dstStride, int srcStride) const; |
| 105 | |
| 106 | void directBufferFromBufferTo888(rdr::U8* dst, const PixelFormat &srcPF, |
| 107 | const rdr::U8* src, int w, int h, |
| 108 | int dstStride, int srcStride) const; |
| 109 | void directBufferFromBufferTo888(rdr::U8* dst, const PixelFormat &srcPF, |
| 110 | const rdr::U16* src, int w, int h, |
| 111 | int dstStride, int srcStride) const; |
| 112 | void directBufferFromBufferTo888(rdr::U8* dst, const PixelFormat &srcPF, |
| 113 | const rdr::U32* src, int w, int h, |
| 114 | int dstStride, int srcStride) const; |
| 115 | |
Pierre Ossman | 67b2b2f | 2009-03-06 10:12:55 +0000 | [diff] [blame] | 116 | public: |
Constantin Kaplinsky | a2adc8d | 2006-05-25 05:01:55 +0000 | [diff] [blame] | 117 | int bpp; |
| 118 | int depth; |
Pierre Ossman | b6b4dc6 | 2014-01-20 15:05:21 +0100 | [diff] [blame] | 119 | |
| 120 | // This only tracks if the client thinks it is in colour map mode. |
| 121 | // In practice we are always in true colour mode. |
Constantin Kaplinsky | a2adc8d | 2006-05-25 05:01:55 +0000 | [diff] [blame] | 122 | bool trueColour; |
Pierre Ossman | 67b2b2f | 2009-03-06 10:12:55 +0000 | [diff] [blame] | 123 | |
Pierre Ossman | a4148f8 | 2014-09-25 10:49:16 +0200 | [diff] [blame] | 124 | protected: |
Pierre Ossman | 67b2b2f | 2009-03-06 10:12:55 +0000 | [diff] [blame] | 125 | bool bigEndian; |
Constantin Kaplinsky | a2adc8d | 2006-05-25 05:01:55 +0000 | [diff] [blame] | 126 | int redMax; |
| 127 | int greenMax; |
| 128 | int blueMax; |
| 129 | int redShift; |
| 130 | int greenShift; |
| 131 | int blueShift; |
Pierre Ossman | 67b2b2f | 2009-03-06 10:12:55 +0000 | [diff] [blame] | 132 | |
| 133 | protected: |
Pierre Ossman | 6e5cd5d | 2014-02-28 11:54:34 +0100 | [diff] [blame] | 134 | /* Pre-computed values to keep algorithms simple */ |
| 135 | int redBits, greenBits, blueBits; |
| 136 | int maxBits, minBits; |
Pierre Ossman | 19dbca2 | 2009-04-21 17:30:45 +0000 | [diff] [blame] | 137 | bool endianMismatch; |
Pierre Ossman | 2fe68da | 2014-07-08 15:06:25 +0200 | [diff] [blame] | 138 | |
| 139 | static rdr::U8 upconvTable[256*8]; |
| 140 | |
| 141 | class Init; |
| 142 | friend class Init; |
| 143 | static Init _init; |
Pierre Ossman | 41deb88 | 2014-09-25 09:58:55 +0200 | [diff] [blame^] | 144 | |
| 145 | /* Only for testing this class */ |
| 146 | friend void makePixel(const rfb::PixelFormat &, rdr::U8 *); |
| 147 | friend bool verifyPixel(const rfb::PixelFormat &, |
| 148 | const rfb::PixelFormat &, |
| 149 | const rdr::U8 *); |
Constantin Kaplinsky | a2adc8d | 2006-05-25 05:01:55 +0000 | [diff] [blame] | 150 | }; |
| 151 | } |
Pierre Ossman | 67b2b2f | 2009-03-06 10:12:55 +0000 | [diff] [blame] | 152 | |
| 153 | #include <rfb/PixelFormat.inl> |
| 154 | |
Constantin Kaplinsky | a2adc8d | 2006-05-25 05:01:55 +0000 | [diff] [blame] | 155 | #endif |