annotate src/main/java/com/glavsoft/rfb/encoding/EncodingType.java @ 0:daa24f8a557b

TightVNC original
author YU
date Thu, 11 Sep 2014 07:30:03 +0900
parents
children 61d95bdc2bdb
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
daa24f8a557b TightVNC original
YU
parents:
diff changeset
1 // Copyright (C) 2010, 2011, 2012, 2013 GlavSoft LLC.
daa24f8a557b TightVNC original
YU
parents:
diff changeset
2 // All rights reserved.
daa24f8a557b TightVNC original
YU
parents:
diff changeset
3 //
daa24f8a557b TightVNC original
YU
parents:
diff changeset
4 //-------------------------------------------------------------------------
daa24f8a557b TightVNC original
YU
parents:
diff changeset
5 // This file is part of the TightVNC software. Please visit our Web site:
daa24f8a557b TightVNC original
YU
parents:
diff changeset
6 //
daa24f8a557b TightVNC original
YU
parents:
diff changeset
7 // http://www.tightvnc.com/
daa24f8a557b TightVNC original
YU
parents:
diff changeset
8 //
daa24f8a557b TightVNC original
YU
parents:
diff changeset
9 // This program is free software; you can redistribute it and/or modify
daa24f8a557b TightVNC original
YU
parents:
diff changeset
10 // it under the terms of the GNU General Public License as published by
daa24f8a557b TightVNC original
YU
parents:
diff changeset
11 // the Free Software Foundation; either version 2 of the License, or
daa24f8a557b TightVNC original
YU
parents:
diff changeset
12 // (at your option) any later version.
daa24f8a557b TightVNC original
YU
parents:
diff changeset
13 //
daa24f8a557b TightVNC original
YU
parents:
diff changeset
14 // This program is distributed in the hope that it will be useful,
daa24f8a557b TightVNC original
YU
parents:
diff changeset
15 // but WITHOUT ANY WARRANTY; without even the implied warranty of
daa24f8a557b TightVNC original
YU
parents:
diff changeset
16 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
daa24f8a557b TightVNC original
YU
parents:
diff changeset
17 // GNU General Public License for more details.
daa24f8a557b TightVNC original
YU
parents:
diff changeset
18 //
daa24f8a557b TightVNC original
YU
parents:
diff changeset
19 // You should have received a copy of the GNU General Public License along
daa24f8a557b TightVNC original
YU
parents:
diff changeset
20 // with this program; if not, write to the Free Software Foundation, Inc.,
daa24f8a557b TightVNC original
YU
parents:
diff changeset
21 // 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
daa24f8a557b TightVNC original
YU
parents:
diff changeset
22 //-------------------------------------------------------------------------
daa24f8a557b TightVNC original
YU
parents:
diff changeset
23 //
daa24f8a557b TightVNC original
YU
parents:
diff changeset
24
daa24f8a557b TightVNC original
YU
parents:
diff changeset
25 package com.glavsoft.rfb.encoding;
daa24f8a557b TightVNC original
YU
parents:
diff changeset
26
daa24f8a557b TightVNC original
YU
parents:
diff changeset
27 import java.util.LinkedHashSet;
daa24f8a557b TightVNC original
YU
parents:
diff changeset
28
daa24f8a557b TightVNC original
YU
parents:
diff changeset
29 /**
daa24f8a557b TightVNC original
YU
parents:
diff changeset
30 * Encoding types
daa24f8a557b TightVNC original
YU
parents:
diff changeset
31 */
daa24f8a557b TightVNC original
YU
parents:
diff changeset
32 public enum EncodingType {
daa24f8a557b TightVNC original
YU
parents:
diff changeset
33 /**
daa24f8a557b TightVNC original
YU
parents:
diff changeset
34 * Desktop data representes as raw bytes stream
daa24f8a557b TightVNC original
YU
parents:
diff changeset
35 */
daa24f8a557b TightVNC original
YU
parents:
diff changeset
36 RAW_ENCODING(0, "Raw"),
daa24f8a557b TightVNC original
YU
parents:
diff changeset
37 /**
daa24f8a557b TightVNC original
YU
parents:
diff changeset
38 * Specfies encodings which allow to copy part of image in client's
daa24f8a557b TightVNC original
YU
parents:
diff changeset
39 * framebuffer from one place to another.
daa24f8a557b TightVNC original
YU
parents:
diff changeset
40 */
daa24f8a557b TightVNC original
YU
parents:
diff changeset
41 COPY_RECT(1, "CopyRect"),
daa24f8a557b TightVNC original
YU
parents:
diff changeset
42 RRE(2, "RRE"),
daa24f8a557b TightVNC original
YU
parents:
diff changeset
43 /**
daa24f8a557b TightVNC original
YU
parents:
diff changeset
44 * Hextile encoding, uses palettes, filling and raw subencoding
daa24f8a557b TightVNC original
YU
parents:
diff changeset
45 */
daa24f8a557b TightVNC original
YU
parents:
diff changeset
46 HEXTILE(5, "Hextile"),
daa24f8a557b TightVNC original
YU
parents:
diff changeset
47 /**
daa24f8a557b TightVNC original
YU
parents:
diff changeset
48 * This encoding is like raw but previously all data compressed with zlib.
daa24f8a557b TightVNC original
YU
parents:
diff changeset
49 */
daa24f8a557b TightVNC original
YU
parents:
diff changeset
50 ZLIB(6, "ZLib"),
daa24f8a557b TightVNC original
YU
parents:
diff changeset
51 /**
daa24f8a557b TightVNC original
YU
parents:
diff changeset
52 * Tight Encoding for slow connection. It is uses raw data, palettes, filling
daa24f8a557b TightVNC original
YU
parents:
diff changeset
53 * and jpeg subencodings
daa24f8a557b TightVNC original
YU
parents:
diff changeset
54 */
daa24f8a557b TightVNC original
YU
parents:
diff changeset
55 TIGHT(7, "Tight"),
daa24f8a557b TightVNC original
YU
parents:
diff changeset
56 //ZlibHex(8),
daa24f8a557b TightVNC original
YU
parents:
diff changeset
57 /**
daa24f8a557b TightVNC original
YU
parents:
diff changeset
58 * ZRLE Encoding is like Hextile but previously all data compressed with zlib.
daa24f8a557b TightVNC original
YU
parents:
diff changeset
59 */
daa24f8a557b TightVNC original
YU
parents:
diff changeset
60 ZRLE(16, "ZRLE"),
daa24f8a557b TightVNC original
YU
parents:
diff changeset
61
daa24f8a557b TightVNC original
YU
parents:
diff changeset
62 /**
daa24f8a557b TightVNC original
YU
parents:
diff changeset
63 * Rich Cursor pseudo encoding which allows to transfer cursor shape
daa24f8a557b TightVNC original
YU
parents:
diff changeset
64 * with transparency
daa24f8a557b TightVNC original
YU
parents:
diff changeset
65 */
daa24f8a557b TightVNC original
YU
parents:
diff changeset
66 RICH_CURSOR(0xFFFFFF11, "RichCursor"),
daa24f8a557b TightVNC original
YU
parents:
diff changeset
67 /**
daa24f8a557b TightVNC original
YU
parents:
diff changeset
68 * Desktop Size Pseudo encoding allows to notificate client about
daa24f8a557b TightVNC original
YU
parents:
diff changeset
69 * remote screen resolution changed.
daa24f8a557b TightVNC original
YU
parents:
diff changeset
70 */
daa24f8a557b TightVNC original
YU
parents:
diff changeset
71 DESKTOP_SIZE(0xFFFFFF21, "DesctopSize"),
daa24f8a557b TightVNC original
YU
parents:
diff changeset
72 /**
daa24f8a557b TightVNC original
YU
parents:
diff changeset
73 * Cusros position encoding allows to transfer remote cursor position to
daa24f8a557b TightVNC original
YU
parents:
diff changeset
74 * client side.
daa24f8a557b TightVNC original
YU
parents:
diff changeset
75 */
daa24f8a557b TightVNC original
YU
parents:
diff changeset
76 CURSOR_POS(0xFFFFFF18, "CursorPos"),
daa24f8a557b TightVNC original
YU
parents:
diff changeset
77
daa24f8a557b TightVNC original
YU
parents:
diff changeset
78 COMPRESS_LEVEL_0(0xFFFFFF00 + 0, "CompressionLevel0"),
daa24f8a557b TightVNC original
YU
parents:
diff changeset
79 COMPRESS_LEVEL_1(0xFFFFFF00 + 1, "CompressionLevel1"),
daa24f8a557b TightVNC original
YU
parents:
diff changeset
80 COMPRESS_LEVEL_2(0xFFFFFF00 + 2, "CompressionLevel2"),
daa24f8a557b TightVNC original
YU
parents:
diff changeset
81 COMPRESS_LEVEL_3(0xFFFFFF00 + 3, "CompressionLevel3"),
daa24f8a557b TightVNC original
YU
parents:
diff changeset
82 COMPRESS_LEVEL_4(0xFFFFFF00 + 4, "CompressionLevel4"),
daa24f8a557b TightVNC original
YU
parents:
diff changeset
83 COMPRESS_LEVEL_5(0xFFFFFF00 + 5, "CompressionLevel5"),
daa24f8a557b TightVNC original
YU
parents:
diff changeset
84 COMPRESS_LEVEL_6(0xFFFFFF00 + 6, "CompressionLevel6"),
daa24f8a557b TightVNC original
YU
parents:
diff changeset
85 COMPRESS_LEVEL_7(0xFFFFFF00 + 7, "CompressionLevel7"),
daa24f8a557b TightVNC original
YU
parents:
diff changeset
86 COMPRESS_LEVEL_8(0xFFFFFF00 + 8, "CompressionLevel8"),
daa24f8a557b TightVNC original
YU
parents:
diff changeset
87 COMPRESS_LEVEL_9(0xFFFFFF00 + 9, "CompressionLevel9"),
daa24f8a557b TightVNC original
YU
parents:
diff changeset
88
daa24f8a557b TightVNC original
YU
parents:
diff changeset
89 JPEG_QUALITY_LEVEL_0(0xFFFFFFE0 + 0, "JpegQualityLevel0"),
daa24f8a557b TightVNC original
YU
parents:
diff changeset
90 JPEG_QUALITY_LEVEL_1(0xFFFFFFE0 + 1, "JpegQualityLevel1"),
daa24f8a557b TightVNC original
YU
parents:
diff changeset
91 JPEG_QUALITY_LEVEL_2(0xFFFFFFE0 + 2, "JpegQualityLevel2"),
daa24f8a557b TightVNC original
YU
parents:
diff changeset
92 JPEG_QUALITY_LEVEL_3(0xFFFFFFE0 + 3, "JpegQualityLevel3"),
daa24f8a557b TightVNC original
YU
parents:
diff changeset
93 JPEG_QUALITY_LEVEL_4(0xFFFFFFE0 + 4, "JpegQualityLevel4"),
daa24f8a557b TightVNC original
YU
parents:
diff changeset
94 JPEG_QUALITY_LEVEL_5(0xFFFFFFE0 + 5, "JpegQualityLevel5"),
daa24f8a557b TightVNC original
YU
parents:
diff changeset
95 JPEG_QUALITY_LEVEL_6(0xFFFFFFE0 + 6, "JpegQualityLevel6"),
daa24f8a557b TightVNC original
YU
parents:
diff changeset
96 JPEG_QUALITY_LEVEL_7(0xFFFFFFE0 + 7, "JpegQualityLevel7"),
daa24f8a557b TightVNC original
YU
parents:
diff changeset
97 JPEG_QUALITY_LEVEL_8(0xFFFFFFE0 + 8, "JpegQualityLevel8"),
daa24f8a557b TightVNC original
YU
parents:
diff changeset
98 JPEG_QUALITY_LEVEL_9(0xFFFFFFE0 + 9, "JpegQualityLevel9");
daa24f8a557b TightVNC original
YU
parents:
diff changeset
99
daa24f8a557b TightVNC original
YU
parents:
diff changeset
100 private int id;
daa24f8a557b TightVNC original
YU
parents:
diff changeset
101 private final String name;
daa24f8a557b TightVNC original
YU
parents:
diff changeset
102 private EncodingType(int id, String name) {
daa24f8a557b TightVNC original
YU
parents:
diff changeset
103 this.id = id;
daa24f8a557b TightVNC original
YU
parents:
diff changeset
104 this.name = name;
daa24f8a557b TightVNC original
YU
parents:
diff changeset
105 }
daa24f8a557b TightVNC original
YU
parents:
diff changeset
106
daa24f8a557b TightVNC original
YU
parents:
diff changeset
107 public int getId() {
daa24f8a557b TightVNC original
YU
parents:
diff changeset
108 return id;
daa24f8a557b TightVNC original
YU
parents:
diff changeset
109 }
daa24f8a557b TightVNC original
YU
parents:
diff changeset
110 public String getName() {
daa24f8a557b TightVNC original
YU
parents:
diff changeset
111 return name;
daa24f8a557b TightVNC original
YU
parents:
diff changeset
112 }
daa24f8a557b TightVNC original
YU
parents:
diff changeset
113
daa24f8a557b TightVNC original
YU
parents:
diff changeset
114 public static LinkedHashSet<EncodingType> ordinaryEncodings = new LinkedHashSet<EncodingType>();
daa24f8a557b TightVNC original
YU
parents:
diff changeset
115 static {
daa24f8a557b TightVNC original
YU
parents:
diff changeset
116 ordinaryEncodings.add(TIGHT);
daa24f8a557b TightVNC original
YU
parents:
diff changeset
117 ordinaryEncodings.add(HEXTILE);
daa24f8a557b TightVNC original
YU
parents:
diff changeset
118 ordinaryEncodings.add(ZRLE);
daa24f8a557b TightVNC original
YU
parents:
diff changeset
119 ordinaryEncodings.add(ZLIB);
daa24f8a557b TightVNC original
YU
parents:
diff changeset
120 ordinaryEncodings.add(RRE);
daa24f8a557b TightVNC original
YU
parents:
diff changeset
121 ordinaryEncodings.add(COPY_RECT);
daa24f8a557b TightVNC original
YU
parents:
diff changeset
122 // ordinaryEncodings.add(RAW_ENCODING);
daa24f8a557b TightVNC original
YU
parents:
diff changeset
123 }
daa24f8a557b TightVNC original
YU
parents:
diff changeset
124
daa24f8a557b TightVNC original
YU
parents:
diff changeset
125 public static LinkedHashSet<EncodingType> pseudoEncodings = new LinkedHashSet<EncodingType>();
daa24f8a557b TightVNC original
YU
parents:
diff changeset
126 static {
daa24f8a557b TightVNC original
YU
parents:
diff changeset
127 pseudoEncodings.add(RICH_CURSOR);
daa24f8a557b TightVNC original
YU
parents:
diff changeset
128 pseudoEncodings.add(CURSOR_POS);
daa24f8a557b TightVNC original
YU
parents:
diff changeset
129 pseudoEncodings.add(DESKTOP_SIZE);
daa24f8a557b TightVNC original
YU
parents:
diff changeset
130 }
daa24f8a557b TightVNC original
YU
parents:
diff changeset
131
daa24f8a557b TightVNC original
YU
parents:
diff changeset
132 public static LinkedHashSet<EncodingType> compressionEncodings = new LinkedHashSet<EncodingType>();
daa24f8a557b TightVNC original
YU
parents:
diff changeset
133 static {
daa24f8a557b TightVNC original
YU
parents:
diff changeset
134 compressionEncodings.add(COMPRESS_LEVEL_0);
daa24f8a557b TightVNC original
YU
parents:
diff changeset
135 compressionEncodings.add(JPEG_QUALITY_LEVEL_0);
daa24f8a557b TightVNC original
YU
parents:
diff changeset
136 }
daa24f8a557b TightVNC original
YU
parents:
diff changeset
137
daa24f8a557b TightVNC original
YU
parents:
diff changeset
138 public static EncodingType byId(int id) {
daa24f8a557b TightVNC original
YU
parents:
diff changeset
139 // TODO needs to speedup with hash usage?
daa24f8a557b TightVNC original
YU
parents:
diff changeset
140 for (EncodingType type : values()) {
daa24f8a557b TightVNC original
YU
parents:
diff changeset
141 if (type.getId() == id)
daa24f8a557b TightVNC original
YU
parents:
diff changeset
142 return type;
daa24f8a557b TightVNC original
YU
parents:
diff changeset
143 }
daa24f8a557b TightVNC original
YU
parents:
diff changeset
144 throw new IllegalArgumentException("Unsupported encoding id: " + id);
daa24f8a557b TightVNC original
YU
parents:
diff changeset
145 }
daa24f8a557b TightVNC original
YU
parents:
diff changeset
146
daa24f8a557b TightVNC original
YU
parents:
diff changeset
147 }