aboutsummaryrefslogtreecommitdiffstats
path: root/common/rfb/PixelFormat.h
blob: ce9b3927b64647ef3ef4e5c2937b572d736bc3b9 (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
138
139
140
141
142
143
144
145
/* Copyright (C) 2002-2005 RealVNC Ltd.  All Rights Reserved.
 * Copyright (C) 2011 D. R. Commander.  All Rights Reserved.
 * Copyright 2009-2022 Pierre Ossman for Cendio AB
 * 
 * This is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 * 
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this software; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307,
 * USA.
 */
//
// PixelFormat - structure to represent a pixel format.  Also has useful
// methods for reading & writing to streams, etc. Conversion to and from
// other formats are also handled by this class. We have three different
// representations that we refer to:
//
// a) Pixels - Unsigned native integers in the format specified by this
//             PixelFormat object.
// b) Buffer - Same thing as pixels, but in the appropriate byte stream
//             format. This involves endian conversion and padding.
// c) RGB - A byte stream of 8 bit red, green and blue elements, in that
//          order.
//

#ifndef __RFB_PIXELFORMAT_H__
#define __RFB_PIXELFORMAT_H__

#include <rfb/Pixel.h>

namespace rdr { class InStream; class OutStream; }

namespace rfb {

  class PixelFormat {
  public:
    PixelFormat(int b, int d, bool e, bool t,
                int rm, int gm, int bm, int rs, int gs, int bs);
    PixelFormat();

    // Checks if the formats have identical buffer representation.
    // They might still have different pixel representation, endianness
    // or true colour state.
    bool operator==(const PixelFormat& other) const;
    bool operator!=(const PixelFormat& other) const;

    void read(rdr::InStream* is);
    void write(rdr::OutStream* os) const;

    bool is888(void) const;
    bool isBigEndian(void) const;
    bool isLittleEndian(void) const;

    inline Pixel pixelFromBuffer(const uint8_t* buffer) const;
    inline void bufferFromPixel(uint8_t* buffer, Pixel pixel) const;

    inline Pixel pixelFromRGB(uint16_t red, uint16_t green, uint16_t blue) const;
    inline Pixel pixelFromRGB(uint8_t red, uint8_t green, uint8_t blue) const;

    void bufferFromRGB(uint8_t *dst, const uint8_t* src, int pixels) const;
    void bufferFromRGB(uint8_t *dst, const uint8_t* src,
                       int w, int stride, int h) const;

    inline void rgbFromPixel(Pixel pix, uint16_t *r, uint16_t *g, uint16_t *b) const;
    inline void rgbFromPixel(Pixel pix, uint8_t *r, uint8_t *g, uint8_t *b) const;

    void rgbFromBuffer(uint8_t* dst, const uint8_t* src, int pixels) const;
    void rgbFromBuffer(uint8_t* dst, const uint8_t* src,
                       int w, int stride, int h) const;

    Pixel pixelFromPixel(const PixelFormat &srcPF, Pixel src) const;

    void bufferFromBuffer(uint8_t* dst, const PixelFormat &srcPF,
                          const uint8_t* src, int pixels) const;
    void bufferFromBuffer(uint8_t* dst, const PixelFormat &srcPF,
                          const uint8_t* src, int w, int h,
                          int dstStride, int srcStride) const;

    void print(char* str, int len) const;
    bool parse(const char* str);

  protected:
    void updateState(void);
    bool isSane(void);

  private:
    // Templated, optimised methods
    template<class T>
    void directBufferFromBufferFrom888(T* dst, const PixelFormat &srcPF,
                                       const uint8_t* src, int w, int h,
                                       int dstStride, int srcStride) const;
    template<class T>
    void directBufferFromBufferTo888(uint8_t* dst, const PixelFormat &srcPF,
                                     const T* src, int w, int h,
                                     int dstStride, int srcStride) const;

  public:
    int bpp;
    int depth;

    // This only tracks if the client thinks it is in colour map mode.
    // In practice we are always in true colour mode.
    bool trueColour;

  protected:
    bool bigEndian;
    int redMax;
    int greenMax;
    int blueMax;
    int redShift;
    int greenShift;
    int blueShift;

  protected:
    /* Pre-computed values to keep algorithms simple */
    int redBits, greenBits, blueBits;
    int maxBits, minBits;
    bool endianMismatch;

    static uint8_t upconvTable[256*8];
    static uint8_t downconvTable[256*8];

    class Init;
    friend class Init;
    static Init _init;

    /* Only for testing this class */
    friend void makePixel(const rfb::PixelFormat &, uint8_t *);
    friend bool verifyPixel(const rfb::PixelFormat &,
                            const rfb::PixelFormat &,
                            const uint8_t *);
  };
}

#include <rfb/PixelFormat.inl>

#endif