blob: 779e88b853eae9cae84ce648a85cca613f98e214 [file] [log] [blame]
Constantin Kaplinsky82f7b012008-05-30 10:03:30 +00001/* Copyright (C) 2004-2008 Constantin Kaplinsky. All Rights Reserved.
Constantin Kaplinskyb30ae7f2006-05-25 05:04:46 +00002 *
3 * This is free software; you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation; either version 2 of the License, or
6 * (at your option) any later version.
7 *
8 * This software is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public License
14 * along with this software; if not, write to the Free Software
15 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
16 * USA.
17 */
18
19//
20// PollingManager.h
21//
22
23#ifndef __POLLINGMANAGER_H__
24#define __POLLINGMANAGER_H__
25
26#include <X11/Xlib.h>
27#include <rfb/VNCServer.h>
28
29#include <x0vncserver/Image.h>
30
31#ifdef DEBUG
32#include <x0vncserver/TimeMillis.h>
33#endif
34
35using namespace rfb;
36
37class PollingManager {
38
39public:
40
Constantin Kaplinsky8a85c492008-06-04 05:36:40 +000041 PollingManager(Display *dpy, const Image *image, ImageFactory *factory,
Constantin Kaplinskyb30ae7f2006-05-25 05:04:46 +000042 int offsetLeft = 0, int offsetTop = 0);
43 virtual ~PollingManager();
44
Constantin Kaplinskyd0b15c62007-10-09 08:15:25 +000045 // Currently, these functions do nothing. In past versions, we used
46 // to poll area around the pointer if its position has been changed
47 // recently. But that rather decreased overal polling performance,
48 // so we don't do that any more. However, pointer position may be a
49 // useful hint and might be used in future code, so we do not remove
50 // these functions, just in case.
51 void setPointerPos(const Point &pos) {}
52 void unsetPointerPos() {}
Constantin Kaplinskyb30ae7f2006-05-25 05:04:46 +000053
Constantin Kaplinsky54cfef32008-06-03 07:04:17 +000054 void poll(VNCServer *server);
Constantin Kaplinskyb30ae7f2006-05-25 05:04:46 +000055
Constantin Kaplinskyb30ae7f2006-05-25 05:04:46 +000056protected:
57
Constantin Kaplinsky9ee8dc62007-10-09 07:46:32 +000058 // Screen polling. Returns true if some changes were detected.
Constantin Kaplinsky54cfef32008-06-03 07:04:17 +000059 bool pollScreen(VNCServer *server);
Constantin Kaplinskyb30ae7f2006-05-25 05:04:46 +000060
Constantin Kaplinskyb30ae7f2006-05-25 05:04:46 +000061 Display *m_dpy;
Constantin Kaplinskyb30ae7f2006-05-25 05:04:46 +000062
Constantin Kaplinsky429ea962008-06-02 11:56:57 +000063 const Image *m_image;
Constantin Kaplinskyadebffb2008-01-18 14:33:05 +000064 const int m_bytesPerPixel;
Constantin Kaplinskyec45c482008-01-18 14:13:16 +000065
Constantin Kaplinskyadebffb2008-01-18 14:33:05 +000066 const int m_offsetLeft;
67 const int m_offsetTop;
68 const int m_width;
69 const int m_height;
Constantin Kaplinskyb30ae7f2006-05-25 05:04:46 +000070
Constantin Kaplinskyb30ae7f2006-05-25 05:04:46 +000071private:
72
Constantin Kaplinskybc6b9e22007-10-04 11:43:41 +000073 inline void getRow(int x, int y, int w) {
Constantin Kaplinsky41de2422008-01-19 09:03:47 +000074 if (w == m_width) {
75 // Getting full row may be more efficient.
76 m_rowImage->get(DefaultRootWindow(m_dpy),
77 m_offsetLeft, m_offsetTop + y);
78 } else {
79 m_rowImage->get(DefaultRootWindow(m_dpy),
80 m_offsetLeft + x, m_offsetTop + y, w, 1);
81 }
Constantin Kaplinskybc6b9e22007-10-04 11:43:41 +000082 }
83
84 inline void getColumn(int x, int y, int h) {
Constantin Kaplinskyed3cf5d2007-12-28 17:59:10 +000085 m_columnImage->get(DefaultRootWindow(m_dpy),
86 m_offsetLeft + x, m_offsetTop + y, 1, h);
Constantin Kaplinskybc6b9e22007-10-04 11:43:41 +000087 }
88
Constantin Kaplinsky04aa5202008-01-18 15:37:15 +000089 inline int getTileIndex(int x, int y) {
90 int tile_x = x / 32;
91 int tile_y = y / 32;
92 return tile_y * m_widthTiles + tile_x;
93 }
94
Constantin Kaplinsky9d37e5c2008-01-18 11:17:26 +000095 int checkRow(int x, int y, int w);
Constantin Kaplinsky553340c2007-12-28 18:37:04 +000096 int checkColumn(int x, int y, int h, bool *pChangeFlags);
Constantin Kaplinsky54cfef32008-06-03 07:04:17 +000097 int sendChanges(VNCServer *server);
Constantin Kaplinskybd390352007-12-28 08:44:59 +000098
Constantin Kaplinsky850de2b2008-01-17 19:14:37 +000099 // Check neighboring tiles and update m_changeFlags[].
100 void checkNeighbors();
Constantin Kaplinsky553340c2007-12-28 18:37:04 +0000101
Constantin Kaplinskyf50bd7f2008-01-10 15:27:42 +0000102 // DEBUG: Print the list of changed tiles.
Constantin Kaplinsky850de2b2008-01-17 19:14:37 +0000103 void printChanges(const char *header) const;
Constantin Kaplinskyf50bd7f2008-01-10 15:27:42 +0000104
Constantin Kaplinskyb30ae7f2006-05-25 05:04:46 +0000105 // Additional images used in polling algorithms.
Constantin Kaplinskyed3cf5d2007-12-28 17:59:10 +0000106 Image *m_rowImage; // one row of the framebuffer
107 Image *m_columnImage; // one column of the framebuffer
Constantin Kaplinskyb30ae7f2006-05-25 05:04:46 +0000108
Constantin Kaplinskyadebffb2008-01-18 14:33:05 +0000109 const int m_widthTiles; // shortcut for ((m_width + 31) / 32)
110 const int m_heightTiles; // shortcut for ((m_height + 31) / 32)
111 const int m_numTiles; // shortcut for (m_widthTiles * m_heightTiles)
Constantin Kaplinsky20390a22008-01-17 15:17:36 +0000112
Constantin Kaplinsky85b5eb92008-01-17 17:41:48 +0000113 // m_changeFlags[] array will hold boolean values corresponding to
114 // each 32x32 tile. If a value is true, then we've detected a change
115 // in that tile.
116 bool *m_changeFlags;
117
Constantin Kaplinskyb30ae7f2006-05-25 05:04:46 +0000118 unsigned int m_pollingStep;
119 static const int m_pollingOrder[];
120
Constantin Kaplinskyb30ae7f2006-05-25 05:04:46 +0000121#ifdef DEBUG
122private:
123
124 void debugBeforePoll();
125 void debugAfterPoll();
126
127 TimeMillis m_timeSaved;
128#endif
129
130};
131
132#endif // __POLLINGMANAGER_H__