aboutsummaryrefslogtreecommitdiff
path: root/nxcomp/src/PutImage.h
blob: 93dde9dfbacfb67292d6df0151d604648e65b206 (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
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
/**************************************************************************/
/*                                                                        */
/* Copyright (c) 2001, 2011 NoMachine (http://www.nomachine.com)          */
/* Copyright (c) 2008-2014 Oleksandr Shneyder <o.shneyder@phoca-gmbh.de>  */
/* Copyright (c) 2014-2016 Ulrich Sibiller <uli42@gmx.de>                 */
/* Copyright (c) 2014-2016 Mihai Moldovan <ionic@ionic.de>                */
/* Copyright (c) 2011-2016 Mike Gabriel <mike.gabriel@das-netzwerkteam.de>*/
/* Copyright (c) 2015-2016 Qindel Group (http://www.qindel.com)           */
/*                                                                        */
/* NXCOMP, NX protocol compression and NX extensions to this software     */
/* are copyright of the aforementioned persons and companies.             */
/*                                                                        */
/* Redistribution and use of the present software is allowed according    */
/* to terms specified in the file LICENSE.nxcomp which comes in the       */
/* source distribution.                                                   */
/*                                                                        */
/* All rights reserved.                                                   */
/*                                                                        */
/* NOTE: This software has received contributions from various other      */
/* contributors, only the core maintainers and supporters are listed as   */
/* copyright holders. Please contact us, if you feel you should be listed */
/* as copyright holder, as well.                                          */
/*                                                                        */
/**************************************************************************/

#ifndef PutImage_H
#define PutImage_H

#include "Message.h"

//
// Set the verbosity level.
//

#define PANIC
#define WARNING
#undef  TEST
#undef  DEBUG
#undef  DUMP

//
// Set default values.
//

#define PUTIMAGE_ENABLE_CACHE                            1
#define PUTIMAGE_ENABLE_DATA                             1

#define PUTIMAGE_DATA_LIMIT                              262144 - 24
#define PUTIMAGE_DATA_OFFSET                             24

#define PUTIMAGE_CACHE_SLOTS                             6000
#define PUTIMAGE_CACHE_THRESHOLD                         70
#define PUTIMAGE_CACHE_LOWER_THRESHOLD                   50

#define PUTIMAGE_ENABLE_COMPRESS_IF_PROTO_STEP_7         0

#define PUTIMAGE_CACHE_THRESHOLD_IF_PACKED               10
#define PUTIMAGE_CACHE_LOWER_THRESHOLD_IF_PACKED         5

#define PUTIMAGE_CACHE_THRESHOLD_IF_SHADOW               97
#define PUTIMAGE_CACHE_LOWER_THRESHOLD_IF_SHADOW         90

#define PUTIMAGE_ENABLE_SPLIT_IF_PROTO_STEP_8            0

//
// The message class.
//

class PutImageMessage : public Message
{
  friend class PutImageStore;

  public:

  PutImageMessage()
  {
  }

  ~PutImageMessage()
  {
  }

  //
  // Put here the fields which constitute 
  // the 'identity' part of the message.
  //

  private:

  unsigned char  format;
  unsigned char  depth;
  unsigned char  left_pad;
  unsigned short width;
  unsigned short height;
  unsigned int   drawable;
  unsigned int   gcontext;
  unsigned short pos_x;
  unsigned short pos_y;
};

class PutImageStore : public MessageStore
{
  public:

  PutImageStore(StaticCompressor *compressor);

  virtual ~PutImageStore();

  virtual const char *name() const
  {
    return "PutImage";
  }

  virtual unsigned char opcode() const
  {
    return X_PutImage;
  }

  virtual unsigned int storage() const
  {
    return sizeof(PutImageMessage);
  }

  //
  // Message handling methods.
  //

  protected:

  virtual Message *create() const
  {
    return new PutImageMessage();
  }

  virtual Message *create(const Message &message) const
  {
    return new PutImageMessage((const PutImageMessage &) message);
  }

  virtual void destroy(Message *message) const
  {
    delete (PutImageMessage *) message;
  }

  virtual int encodeIdentity(EncodeBuffer &encodeBuffer, const unsigned char *buffer,
                                 const unsigned int size, int bigEndian,
                                     ChannelCache *channelCache) const;

  virtual int decodeIdentity(DecodeBuffer &decodeBuffer, unsigned char *&buffer,
                                 unsigned int &size, int bigEndian, WriteBuffer *writeBuffer,
                                     ChannelCache *channelCache) const;

  virtual int parseIdentity(Message *message, const unsigned char *buffer, 
                                unsigned int size, int bigEndian) const;

  virtual int unparseIdentity(const Message *message, unsigned char *buffer, 
                                  unsigned int size, int bigEndian) const;

  virtual void updateIdentity(EncodeBuffer &encodeBuffer, const Message *message,
                                  const Message *cachedMessage,
                                      ChannelCache *channelCache) const;

  virtual void updateIdentity(DecodeBuffer &decodeBuffer, const Message *message,
                                  ChannelCache *channelCache) const;

  virtual void identityChecksum(const Message *message, const unsigned char *buffer, 
                                    unsigned int size, int bigEndian) const;

  virtual void dumpIdentity(const Message *message) const;
};

#endif /* PutImage_H */