blob: f631a5512130bd6e2ce9b61ed8088a561779c576 [file] [log] [blame]
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +00001/* Copyright (C) 2002-2005 RealVNC Ltd. All Rights Reserved.
Pierre Ossman316a3242014-01-15 12:40:20 +01002 * Copyright 2014 Pierre Ossman for Cendio AB
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +00003 *
4 * This is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
8 *
9 * This software is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this software; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
17 * USA.
18 */
19#ifndef __RFB_DECODER_H__
20#define __RFB_DECODER_H__
21
Pierre Ossman80b42092015-11-10 17:17:34 +010022namespace rdr {
23 class InStream;
24 class OutStream;
25}
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +000026
27namespace rfb {
Pierre Ossman86350622015-11-10 13:02:12 +010028 class ConnParams;
Pierre Ossman0c9bd4b2014-07-09 16:44:11 +020029 class ModifiablePixelBuffer;
Pierre Ossman86350622015-11-10 13:02:12 +010030 class Rect;
Pierre Ossman570cd5c2015-11-12 13:07:42 +010031 class Region;
32
33 enum DecoderFlags {
34 // A constant for decoders that don't need anything special
35 DecoderPlain = 0,
36 };
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +000037
38 class Decoder {
39 public:
Pierre Ossman570cd5c2015-11-12 13:07:42 +010040 Decoder(enum DecoderFlags flags);
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +000041 virtual ~Decoder();
Pierre Ossman0c9bd4b2014-07-09 16:44:11 +020042
Pierre Ossman80b42092015-11-10 17:17:34 +010043 // These functions are the main interface to an individual decoder
44
45 // readRect() transfers data for the given rectangle from the
46 // InStream to the OutStream, possibly changing it along the way to
Pierre Ossman504afa22015-11-12 12:21:58 +010047 // make it easier to decode. This function will always be called in
48 // a serial manner on the main thread.
Pierre Ossman86350622015-11-10 13:02:12 +010049 virtual void readRect(const Rect& r, rdr::InStream* is,
Pierre Ossman80b42092015-11-10 17:17:34 +010050 const ConnParams& cp, rdr::OutStream* os)=0;
Pierre Ossman504afa22015-11-12 12:21:58 +010051
52 // These functions will be called from any of the worker threads.
53 // A lock will be held whilst these are called so it is safe to
54 // read and update internal state as necessary.
55
Pierre Ossman14127892015-11-12 13:17:42 +010056 // getAffectedRegion() returns the parts of the frame buffer will
57 // be either read from or written do when decoding this rect. The
58 // default implementation simply returns the given rectangle.
59 virtual void getAffectedRegion(const Rect& rect, const void* buffer,
60 size_t buflen, const ConnParams& cp,
61 Region* region);
62
Pierre Ossman80b42092015-11-10 17:17:34 +010063 // decodeRect() decodes the given rectangle with data from the
64 // given buffer, onto the ModifiablePixelBuffer. The PixelFormat of
65 // the PixelBuffer might not match the ConnParams and it is up to
66 // the decoder to do any necessary conversion.
67 virtual void decodeRect(const Rect& r, const void* buffer,
68 size_t buflen, const ConnParams& cp,
69 ModifiablePixelBuffer* pb)=0;
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +000070
Pierre Ossman504afa22015-11-12 12:21:58 +010071 public:
Peter Åstrand98fe98c2010-02-10 07:43:02 +000072 static bool supported(int encoding);
Pierre Ossman86350622015-11-10 13:02:12 +010073 static Decoder* createDecoder(int encoding);
Pierre Ossman570cd5c2015-11-12 13:07:42 +010074
75 public:
76 const enum DecoderFlags flags;
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +000077 };
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +000078}
79
80#endif