blob: 9d929ea498e65d5eb816736412ec65891e19c029 [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 Ossman86350622015-11-10 13:02:12 +010022namespace rdr { class InStream; }
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +000023
24namespace rfb {
Pierre Ossman86350622015-11-10 13:02:12 +010025 class ConnParams;
Pierre Ossman0c9bd4b2014-07-09 16:44:11 +020026 class ModifiablePixelBuffer;
Pierre Ossman86350622015-11-10 13:02:12 +010027 class Rect;
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +000028
29 class Decoder {
30 public:
Pierre Ossman86350622015-11-10 13:02:12 +010031 Decoder();
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +000032 virtual ~Decoder();
Pierre Ossman0c9bd4b2014-07-09 16:44:11 +020033
34 // readRect() is the main interface that decodes the given rectangle
Pierre Ossman86350622015-11-10 13:02:12 +010035 // with data from the given InStream, onto the ModifiablePixelBuffer.
36 // The PixelFormat of the PixelBuffer might not match the ConnParams
37 // and it is up to the decoder to do any necessary conversion.
38 virtual void readRect(const Rect& r, rdr::InStream* is,
39 const ConnParams& cp, ModifiablePixelBuffer* pb)=0;
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +000040
Peter Åstrand98fe98c2010-02-10 07:43:02 +000041 static bool supported(int encoding);
Pierre Ossman86350622015-11-10 13:02:12 +010042 static Decoder* createDecoder(int encoding);
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +000043 };
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +000044}
45
46#endif