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
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
/******************************************************************************
* $Id: gdal_proxy.h 48750f0a05e88eec700319b3e1a3146da6054e09 2019-09-20 20:55:41 +0300 drons $
*
* Project: GDAL Core
* Purpose: GDAL Core C++/Private declarations
* Author: Even Rouault <even dot rouault at spatialys.com>
*
******************************************************************************
* Copyright (c) 2008-2014, Even Rouault <even dot rouault at spatialys.com>
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included
* in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
****************************************************************************/
#ifndef GDAL_PROXY_H_INCLUDED
#define GDAL_PROXY_H_INCLUDED
#ifndef DOXYGEN_SKIP
#include "gdal.h"
#ifdef __cplusplus
#include "gdal_priv.h"
#include "cpl_hash_set.h"
/* ******************************************************************** */
/* GDALProxyDataset */
/* ******************************************************************** */
class CPL_DLL GDALProxyDataset : public GDALDataset
{
protected:
GDALProxyDataset() {}
virtual GDALDataset *RefUnderlyingDataset() const = 0;
virtual void UnrefUnderlyingDataset(GDALDataset* poUnderlyingDataset) const;
CPLErr IBuildOverviews( const char *, int, int *,
int, int *, GDALProgressFunc, void * ) override;
CPLErr IRasterIO( GDALRWFlag, int, int, int, int,
void *, int, int, GDALDataType,
int, int *, GSpacing, GSpacing, GSpacing,
GDALRasterIOExtraArg* psExtraArg ) override;
public:
char **GetMetadataDomainList() override;
char **GetMetadata( const char * pszDomain ) override;
CPLErr SetMetadata( char ** papszMetadata,
const char * pszDomain ) override;
const char *GetMetadataItem( const char * pszName,
const char * pszDomain ) override;
CPLErr SetMetadataItem( const char * pszName,
const char * pszValue,
const char * pszDomain ) override;
void FlushCache() override;
const OGRSpatialReference* GetSpatialRef() const override;
CPLErr SetSpatialRef(const OGRSpatialReference* poSRS) override;
CPLErr GetGeoTransform( double * ) override;
CPLErr SetGeoTransform( double * ) override;
void *GetInternalHandle( const char * ) override;
GDALDriver *GetDriver() override;
char **GetFileList() override;
int GetGCPCount() override;
const OGRSpatialReference* GetGCPSpatialRef() const override;
const GDAL_GCP *GetGCPs() override;
CPLErr SetGCPs( int nGCPCount, const GDAL_GCP *pasGCPList,
const OGRSpatialReference * poGCP_SRS ) override;
CPLErr AdviseRead( int nXOff, int nYOff, int nXSize, int nYSize,
int nBufXSize, int nBufYSize,
GDALDataType eDT,
int nBandCount, int *panBandList,
char **papszOptions ) override;
CPLErr CreateMaskBand( int nFlags ) override;
protected:
const char *_GetProjectionRef(void) override;
CPLErr _SetProjection( const char * ) override;
const char *_GetGCPProjection() override;
CPLErr _SetGCPs( int nGCPCount, const GDAL_GCP *pasGCPList,
const char *pszGCPProjection ) override;
private:
CPL_DISALLOW_COPY_ASSIGN(GDALProxyDataset)
};
/* ******************************************************************** */
/* GDALProxyRasterBand */
/* ******************************************************************** */
class CPL_DLL GDALProxyRasterBand : public GDALRasterBand
{
protected:
GDALProxyRasterBand() {}
virtual GDALRasterBand* RefUnderlyingRasterBand() = 0;
virtual void UnrefUnderlyingRasterBand(GDALRasterBand* poUnderlyingRasterBand);
CPLErr IReadBlock( int, int, void * ) override;
CPLErr IWriteBlock( int, int, void * ) override;
CPLErr IRasterIO( GDALRWFlag, int, int, int, int,
void *, int, int, GDALDataType,
GSpacing, GSpacing, GDALRasterIOExtraArg* psExtraArg ) override;
public:
char **GetMetadataDomainList() override;
char **GetMetadata( const char * pszDomain ) override;
CPLErr SetMetadata( char ** papszMetadata,
const char * pszDomain ) override;
const char *GetMetadataItem( const char * pszName,
const char * pszDomain ) override;
CPLErr SetMetadataItem( const char * pszName,
const char * pszValue,
const char * pszDomain ) override;
CPLErr FlushCache() override;
char **GetCategoryNames() override;
double GetNoDataValue( int *pbSuccess = nullptr ) override;
double GetMinimum( int *pbSuccess = nullptr ) override;
double GetMaximum(int *pbSuccess = nullptr ) override;
double GetOffset( int *pbSuccess = nullptr ) override;
double GetScale( int *pbSuccess = nullptr ) override;
const char *GetUnitType() override;
GDALColorInterp GetColorInterpretation() override;
GDALColorTable *GetColorTable() override;
CPLErr Fill(double dfRealValue, double dfImaginaryValue = 0) override;
CPLErr SetCategoryNames( char ** ) override;
CPLErr SetNoDataValue( double ) override;
CPLErr DeleteNoDataValue() override;
CPLErr SetColorTable( GDALColorTable * ) override;
CPLErr SetColorInterpretation( GDALColorInterp ) override;
CPLErr SetOffset( double ) override;
CPLErr SetScale( double ) override;
CPLErr SetUnitType( const char * ) override;
CPLErr GetStatistics( int bApproxOK, int bForce,
double *pdfMin, double *pdfMax,
double *pdfMean, double *padfStdDev ) override;
CPLErr ComputeStatistics( int bApproxOK,
double *pdfMin, double *pdfMax,
double *pdfMean, double *pdfStdDev,
GDALProgressFunc, void *pProgressData ) override;
CPLErr SetStatistics( double dfMin, double dfMax,
double dfMean, double dfStdDev ) override;
CPLErr ComputeRasterMinMax( int, double* ) override;
int HasArbitraryOverviews() override;
int GetOverviewCount() override;
GDALRasterBand *GetOverview( int ) override;
GDALRasterBand *GetRasterSampleOverview( GUIntBig ) override;
CPLErr BuildOverviews( const char *, int, int *,
GDALProgressFunc, void * ) override;
CPLErr AdviseRead( int nXOff, int nYOff, int nXSize, int nYSize,
int nBufXSize, int nBufYSize,
GDALDataType eDT, char **papszOptions ) override;
CPLErr GetHistogram( double dfMin, double dfMax,
int nBuckets, GUIntBig * panHistogram,
int bIncludeOutOfRange, int bApproxOK,
GDALProgressFunc, void *pProgressData ) override;
CPLErr GetDefaultHistogram( double *pdfMin, double *pdfMax,
int *pnBuckets, GUIntBig ** ppanHistogram,
int bForce,
GDALProgressFunc, void *pProgressData) override;
CPLErr SetDefaultHistogram( double dfMin, double dfMax,
int nBuckets, GUIntBig *panHistogram ) override;
GDALRasterAttributeTable *GetDefaultRAT() override;
CPLErr SetDefaultRAT( const GDALRasterAttributeTable * ) override;
GDALRasterBand *GetMaskBand() override;
int GetMaskFlags() override;
CPLErr CreateMaskBand( int nFlags ) override;
CPLVirtualMem *GetVirtualMemAuto( GDALRWFlag eRWFlag,
int *pnPixelSpace,
GIntBig *pnLineSpace,
char **papszOptions ) override;
private:
CPL_DISALLOW_COPY_ASSIGN(GDALProxyRasterBand)
};
/* ******************************************************************** */
/* GDALProxyPoolDataset */
/* ******************************************************************** */
typedef struct _GDALProxyPoolCacheEntry GDALProxyPoolCacheEntry;
class GDALProxyPoolRasterBand;
class CPL_DLL GDALProxyPoolDataset : public GDALProxyDataset
{
private:
GIntBig responsiblePID = -1;
mutable char *pszProjectionRef = nullptr;
mutable OGRSpatialReference* m_poSRS = nullptr;
mutable OGRSpatialReference* m_poGCPSRS = nullptr;
double adfGeoTransform[6]{0,1,0,0,0,1};
bool bHasSrcProjection = false;
bool m_bHasSrcSRS = false;
bool bHasSrcGeoTransform = false;
char *pszGCPProjection = nullptr;
int nGCPCount = 0;
GDAL_GCP *pasGCPList = nullptr;
CPLHashSet *metadataSet = nullptr;
CPLHashSet *metadataItemSet = nullptr;
mutable GDALProxyPoolCacheEntry* cacheEntry = nullptr;
char *m_pszOwner = nullptr;
GDALDataset *RefUnderlyingDataset(bool bForceOpen) const;
protected:
GDALDataset *RefUnderlyingDataset() const override;
void UnrefUnderlyingDataset(GDALDataset* poUnderlyingDataset) const override;
friend class GDALProxyPoolRasterBand;
public:
GDALProxyPoolDataset( const char* pszSourceDatasetDescription,
int nRasterXSize, int nRasterYSize,
GDALAccess eAccess = GA_ReadOnly,
int bShared = FALSE,
const char * pszProjectionRef = nullptr,
double * padfGeoTransform = nullptr,
const char* pszOwner = nullptr );
~GDALProxyPoolDataset() override;
void SetOpenOptions( char** papszOpenOptions );
// If size (nBlockXSize&nBlockYSize) parameters is zero
// they will be loaded when RefUnderlyingRasterBand function is called.
// But in this case we cannot use them in other non-virtual methods before
// RefUnderlyingRasterBand fist call.
void AddSrcBandDescription( GDALDataType eDataType, int nBlockXSize,
int nBlockYSize );
// Used by VRT SimpleSource to add a single GDALProxyPoolRasterBand while
// keeping all other bands initialized to a nullptr. This is under the assumption,
// VRT SimpleSource will not have to access any other bands than the one added.
void AddSrcBand(int nBand, GDALDataType eDataType, int nBlockXSize,
int nBlockYSize );
void FlushCache() override;
const OGRSpatialReference* GetSpatialRef() const override;
CPLErr SetSpatialRef(const OGRSpatialReference* poSRS) override;
const char *_GetProjectionRef() override;
CPLErr _SetProjection( const char * ) override;
CPLErr GetGeoTransform( double * ) override;
CPLErr SetGeoTransform( double * ) override;
// Special behaviour for the following methods : they return a pointer
// data type, that must be cached by the proxy, so it doesn't become invalid
// when the underlying object get closed.
char **GetMetadata( const char * pszDomain ) override;
const char *GetMetadataItem( const char * pszName,
const char * pszDomain ) override;
void *GetInternalHandle( const char * pszRequest ) override;
const char *_GetGCPProjection() override;
const OGRSpatialReference* GetGCPSpatialRef() const override;
const GDAL_GCP *GetGCPs() override;
private:
CPL_DISALLOW_COPY_ASSIGN(GDALProxyPoolDataset)
};
/* ******************************************************************** */
/* GDALProxyPoolRasterBand */
/* ******************************************************************** */
class GDALProxyPoolOverviewRasterBand;
class GDALProxyPoolMaskBand;
class CPL_DLL GDALProxyPoolRasterBand : public GDALProxyRasterBand
{
private:
CPLHashSet *metadataSet = nullptr;
CPLHashSet *metadataItemSet = nullptr;
char *pszUnitType = nullptr;
char **papszCategoryNames = nullptr;
GDALColorTable *poColorTable = nullptr;
int nSizeProxyOverviewRasterBand = 0;
GDALProxyPoolOverviewRasterBand **papoProxyOverviewRasterBand = nullptr;
GDALProxyPoolMaskBand *poProxyMaskBand = nullptr;
GDALRasterBand* RefUnderlyingRasterBand( bool bForceOpen );
protected:
GDALRasterBand* RefUnderlyingRasterBand() override;
void UnrefUnderlyingRasterBand( GDALRasterBand* poUnderlyingRasterBand )
override;
friend class GDALProxyPoolOverviewRasterBand;
friend class GDALProxyPoolMaskBand;
public:
GDALProxyPoolRasterBand( GDALProxyPoolDataset* poDS, int nBand,
GDALDataType eDataType,
int nBlockXSize, int nBlockYSize );
GDALProxyPoolRasterBand( GDALProxyPoolDataset* poDS,
GDALRasterBand* poUnderlyingRasterBand );
~GDALProxyPoolRasterBand() override;
void AddSrcMaskBandDescription( GDALDataType eDataType, int nBlockXSize,
int nBlockYSize );
// Special behaviour for the following methods : they return a pointer
// data type, that must be cached by the proxy, so it doesn't become invalid
// when the underlying object get closed.
char **GetMetadata( const char * pszDomain ) override;
const char *GetMetadataItem( const char * pszName,
const char * pszDomain ) override;
char **GetCategoryNames() override;
const char *GetUnitType() override;
GDALColorTable *GetColorTable() override;
GDALRasterBand *GetOverview( int ) override;
GDALRasterBand *GetRasterSampleOverview( GUIntBig nDesiredSamples ) override; // TODO
GDALRasterBand *GetMaskBand() override;
CPLErr FlushCache() override;
private:
CPL_DISALLOW_COPY_ASSIGN(GDALProxyPoolRasterBand)
};
/* ******************************************************************** */
/* GDALProxyPoolOverviewRasterBand */
/* ******************************************************************** */
class GDALProxyPoolOverviewRasterBand : public GDALProxyPoolRasterBand
{
private:
GDALProxyPoolRasterBand *poMainBand = nullptr;
int nOverviewBand = 0;
GDALRasterBand *poUnderlyingMainRasterBand = nullptr;
int nRefCountUnderlyingMainRasterBand = 0;
CPL_DISALLOW_COPY_ASSIGN(GDALProxyPoolOverviewRasterBand)
protected:
GDALRasterBand* RefUnderlyingRasterBand() override;
void UnrefUnderlyingRasterBand( GDALRasterBand* poUnderlyingRasterBand )
override;
public:
GDALProxyPoolOverviewRasterBand( GDALProxyPoolDataset* poDS,
GDALRasterBand* poUnderlyingOverviewBand,
GDALProxyPoolRasterBand* poMainBand,
int nOverviewBand );
~GDALProxyPoolOverviewRasterBand() override;
};
/* ******************************************************************** */
/* GDALProxyPoolMaskBand */
/* ******************************************************************** */
class GDALProxyPoolMaskBand : public GDALProxyPoolRasterBand
{
private:
GDALProxyPoolRasterBand *poMainBand = nullptr;
GDALRasterBand *poUnderlyingMainRasterBand = nullptr;
int nRefCountUnderlyingMainRasterBand = 0;
CPL_DISALLOW_COPY_ASSIGN(GDALProxyPoolMaskBand)
protected:
GDALRasterBand* RefUnderlyingRasterBand() override;
void UnrefUnderlyingRasterBand( GDALRasterBand* poUnderlyingRasterBand )
override;
public:
GDALProxyPoolMaskBand( GDALProxyPoolDataset* poDS,
GDALRasterBand* poUnderlyingMaskBand,
GDALProxyPoolRasterBand* poMainBand );
GDALProxyPoolMaskBand( GDALProxyPoolDataset* poDS,
GDALProxyPoolRasterBand* poMainBand,
GDALDataType eDataType,
int nBlockXSize, int nBlockYSize );
~GDALProxyPoolMaskBand() override;
};
#endif
/* ******************************************************************** */
/* C types and methods declarations */
/* ******************************************************************** */
CPL_C_START
typedef struct GDALProxyPoolDatasetHS *GDALProxyPoolDatasetH;
GDALProxyPoolDatasetH CPL_DLL GDALProxyPoolDatasetCreate(const char* pszSourceDatasetDescription,
int nRasterXSize, int nRasterYSize,
GDALAccess eAccess, int bShared,
const char * pszProjectionRef,
double * padfGeoTransform);
void CPL_DLL GDALProxyPoolDatasetDelete(GDALProxyPoolDatasetH hProxyPoolDataset);
void CPL_DLL GDALProxyPoolDatasetAddSrcBandDescription( GDALProxyPoolDatasetH hProxyPoolDataset,
GDALDataType eDataType,
int nBlockXSize, int nBlockYSize);
CPL_C_END
#endif /* #ifndef DOXYGEN_SKIP */
#endif /* GDAL_PROXY_H_INCLUDED */