forked from OSGeo/gdal
-
Notifications
You must be signed in to change notification settings - Fork 0
/
gdalwarpkernel.cpp
7983 lines (6986 loc) · 300 KB
/
gdalwarpkernel.cpp
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
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/******************************************************************************
*
* Project: High Performance Image Reprojector
* Purpose: Implementation of the GDALWarpKernel class. Implements the actual
* image warping for a "chunk" of input and output imagery already
* loaded into memory.
* Author: Frank Warmerdam, warmerdam@pobox.com
*
******************************************************************************
* Copyright (c) 2003, Frank Warmerdam <warmerdam@pobox.com>
* Copyright (c) 2008-2013, 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.
****************************************************************************/
#include "cpl_port.h"
#include "gdalwarper.h"
#include <cfloat>
#include <cmath>
#include <cstddef>
#include <cstdlib>
#include <cstring>
#include <algorithm>
#include <limits>
#include <mutex>
#include <new>
#include <utility>
#include <vector>
#include "cpl_atomic_ops.h"
#include "cpl_conv.h"
#include "cpl_error.h"
#include "cpl_mask.h"
#include "cpl_multiproc.h"
#include "cpl_progress.h"
#include "cpl_string.h"
#include "cpl_vsi.h"
#include "cpl_worker_thread_pool.h"
#include "cpl_quad_tree.h"
#include "gdal.h"
#include "gdal_alg.h"
#include "gdal_alg_priv.h"
#include "gdal_thread_pool.h"
#include "gdalwarpkernel_opencl.h"
// #define CHECK_SUM_WITH_GEOS
#ifdef CHECK_SUM_WITH_GEOS
#include "ogr_geometry.h"
#include "ogr_geos.h"
#endif
// We restrict to 64bit processors because they are guaranteed to have SSE2.
// Could possibly be used too on 32bit, but we would need to check at runtime.
#if defined(__x86_64) || defined(_M_X64)
#include "gdalsse_priv.h"
#if __SSE4_1__
#include <smmintrin.h>
#endif
#if __SSE3__
#include <pmmintrin.h>
#endif
#endif
CPL_CVSID("$Id$")
constexpr double BAND_DENSITY_THRESHOLD = 0.0000000001;
constexpr float SRC_DENSITY_THRESHOLD = 0.000000001f;
// #define INSTANTIATE_FLOAT64_SSE2_IMPL
static const int anGWKFilterRadius[] = {
0, // Nearest neighbour
1, // Bilinear
2, // Cubic Convolution (Catmull-Rom)
2, // Cubic B-Spline
3, // Lanczos windowed sinc
0, // Average
0, // Mode
0, // Reserved GRA_Gauss=7
0, // Max
0, // Min
0, // Med
0, // Q1
0, // Q3
0, // Sum
0, // RMS
};
static double GWKBilinear(double dfX);
static double GWKCubic(double dfX);
static double GWKBSpline(double dfX);
static double GWKLanczosSinc(double dfX);
static const FilterFuncType apfGWKFilter[] = {
nullptr, // Nearest neighbour
GWKBilinear, // Bilinear
GWKCubic, // Cubic Convolution (Catmull-Rom)
GWKBSpline, // Cubic B-Spline
GWKLanczosSinc, // Lanczos windowed sinc
nullptr, // Average
nullptr, // Mode
nullptr, // Reserved GRA_Gauss=7
nullptr, // Max
nullptr, // Min
nullptr, // Med
nullptr, // Q1
nullptr, // Q3
nullptr, // Sum
nullptr, // RMS
};
// TODO(schwehr): Can we make these functions have a const * const arg?
static double GWKBilinear4Values(double *padfVals);
static double GWKCubic4Values(double *padfVals);
static double GWKBSpline4Values(double *padfVals);
static double GWKLanczosSinc4Values(double *padfVals);
static const FilterFunc4ValuesType apfGWKFilter4Values[] = {
nullptr, // Nearest neighbour
GWKBilinear4Values, // Bilinear
GWKCubic4Values, // Cubic Convolution (Catmull-Rom)
GWKBSpline4Values, // Cubic B-Spline
GWKLanczosSinc4Values, // Lanczos windowed sinc
nullptr, // Average
nullptr, // Mode
nullptr, // Reserved GRA_Gauss=7
nullptr, // Max
nullptr, // Min
nullptr, // Med
nullptr, // Q1
nullptr, // Q3
nullptr, // Sum
nullptr, // RMS
};
int GWKGetFilterRadius(GDALResampleAlg eResampleAlg)
{
static_assert(CPL_ARRAYSIZE(anGWKFilterRadius) == GRA_LAST_VALUE + 1,
"Bad size of anGWKFilterRadius");
return anGWKFilterRadius[eResampleAlg];
}
FilterFuncType GWKGetFilterFunc(GDALResampleAlg eResampleAlg)
{
static_assert(CPL_ARRAYSIZE(apfGWKFilter) == GRA_LAST_VALUE + 1,
"Bad size of apfGWKFilter");
return apfGWKFilter[eResampleAlg];
}
FilterFunc4ValuesType GWKGetFilterFunc4Values(GDALResampleAlg eResampleAlg)
{
static_assert(CPL_ARRAYSIZE(apfGWKFilter4Values) == GRA_LAST_VALUE + 1,
"Bad size of apfGWKFilter4Values");
return apfGWKFilter4Values[eResampleAlg];
}
#ifdef HAVE_OPENCL
static CPLErr GWKOpenCLCase(GDALWarpKernel *);
#endif
static CPLErr GWKGeneralCase(GDALWarpKernel *);
static CPLErr GWKRealCase(GDALWarpKernel *poWK);
static CPLErr GWKNearestNoMasksOrDstDensityOnlyByte(GDALWarpKernel *poWK);
static CPLErr GWKBilinearNoMasksOrDstDensityOnlyByte(GDALWarpKernel *poWK);
static CPLErr GWKCubicNoMasksOrDstDensityOnlyByte(GDALWarpKernel *poWK);
static CPLErr GWKCubicNoMasksOrDstDensityOnlyFloat(GDALWarpKernel *poWK);
#ifdef INSTANTIATE_FLOAT64_SSE2_IMPL
static CPLErr GWKCubicNoMasksOrDstDensityOnlyDouble(GDALWarpKernel *poWK);
#endif
static CPLErr GWKCubicSplineNoMasksOrDstDensityOnlyByte(GDALWarpKernel *poWK);
static CPLErr GWKNearestByte(GDALWarpKernel *poWK);
static CPLErr GWKNearestNoMasksOrDstDensityOnlyShort(GDALWarpKernel *poWK);
static CPLErr GWKBilinearNoMasksOrDstDensityOnlyShort(GDALWarpKernel *poWK);
static CPLErr GWKBilinearNoMasksOrDstDensityOnlyFloat(GDALWarpKernel *poWK);
#ifdef INSTANTIATE_FLOAT64_SSE2_IMPL
static CPLErr GWKBilinearNoMasksOrDstDensityOnlyDouble(GDALWarpKernel *poWK);
#endif
static CPLErr GWKCubicNoMasksOrDstDensityOnlyShort(GDALWarpKernel *poWK);
static CPLErr GWKCubicSplineNoMasksOrDstDensityOnlyShort(GDALWarpKernel *poWK);
static CPLErr GWKNearestShort(GDALWarpKernel *poWK);
static CPLErr GWKNearestNoMasksOrDstDensityOnlyFloat(GDALWarpKernel *poWK);
static CPLErr GWKNearestFloat(GDALWarpKernel *poWK);
static CPLErr GWKAverageOrMode(GDALWarpKernel *);
static CPLErr GWKSumPreserving(GDALWarpKernel *);
static CPLErr GWKCubicNoMasksOrDstDensityOnlyUShort(GDALWarpKernel *);
static CPLErr GWKCubicSplineNoMasksOrDstDensityOnlyUShort(GDALWarpKernel *);
static CPLErr GWKBilinearNoMasksOrDstDensityOnlyUShort(GDALWarpKernel *);
/************************************************************************/
/* GWKJobStruct */
/************************************************************************/
struct GWKJobStruct
{
std::mutex &mutex;
std::condition_variable &cv;
int &counter;
bool &stopFlag;
GDALWarpKernel *poWK;
int iYMin;
int iYMax;
int (*pfnProgress)(GWKJobStruct *psJob);
void *pTransformerArg;
void (*pfnFunc)(
void *); // used by GWKRun() to assign the proper pTransformerArg
GWKJobStruct(std::mutex &mutex_, std::condition_variable &cv_,
int &counter_, bool &stopFlag_)
: mutex(mutex_), cv(cv_), counter(counter_), stopFlag(stopFlag_),
poWK(nullptr), iYMin(0), iYMax(0), pfnProgress(nullptr),
pTransformerArg(nullptr), pfnFunc(nullptr)
{
}
};
struct GWKThreadData
{
std::unique_ptr<CPLJobQueue> poJobQueue{};
std::unique_ptr<std::vector<GWKJobStruct>> threadJobs{};
int nMaxThreads{0};
int counter{0};
bool stopFlag{false};
std::mutex mutex{};
std::condition_variable cv{};
bool bTransformerArgInputAssignedToThread{false};
void *pTransformerArgInput{
nullptr}; // owned by calling layer. Not to be destroyed
std::map<GIntBig, void *> mapThreadToTransformerArg{};
int nTotalThreadCountForThisRun = 0;
int nCurThreadCountForThisRun = 0;
};
/************************************************************************/
/* GWKProgressThread() */
/************************************************************************/
// Return TRUE if the computation must be interrupted.
static int GWKProgressThread(GWKJobStruct *psJob)
{
bool stop = false;
{
std::lock_guard<std::mutex> lock(psJob->mutex);
psJob->counter++;
stop = psJob->stopFlag;
}
psJob->cv.notify_one();
return stop;
}
/************************************************************************/
/* GWKProgressMonoThread() */
/************************************************************************/
// Return TRUE if the computation must be interrupted.
static int GWKProgressMonoThread(GWKJobStruct *psJob)
{
GDALWarpKernel *poWK = psJob->poWK;
if (!poWK->pfnProgress(
poWK->dfProgressBase +
poWK->dfProgressScale *
(++psJob->counter / static_cast<double>(psJob->iYMax)),
"", poWK->pProgress))
{
CPLError(CE_Failure, CPLE_UserInterrupt, "User terminated");
psJob->stopFlag = true;
return TRUE;
}
return FALSE;
}
/************************************************************************/
/* GWKGenericMonoThread() */
/************************************************************************/
static CPLErr GWKGenericMonoThread(GDALWarpKernel *poWK,
void (*pfnFunc)(void *pUserData))
{
GWKThreadData td;
// NOTE: the mutex is not used.
GWKJobStruct job(td.mutex, td.cv, td.counter, td.stopFlag);
job.poWK = poWK;
job.iYMin = 0;
job.iYMax = poWK->nDstYSize;
job.pfnProgress = GWKProgressMonoThread;
job.pTransformerArg = poWK->pTransformerArg;
pfnFunc(&job);
return td.stopFlag ? CE_Failure : CE_None;
}
/************************************************************************/
/* GWKThreadsCreate() */
/************************************************************************/
void *GWKThreadsCreate(char **papszWarpOptions,
GDALTransformerFunc /* pfnTransformer */,
void *pTransformerArg)
{
const char *pszWarpThreads =
CSLFetchNameValue(papszWarpOptions, "NUM_THREADS");
if (pszWarpThreads == nullptr)
pszWarpThreads = CPLGetConfigOption("GDAL_NUM_THREADS", "1");
int nThreads = 0;
if (EQUAL(pszWarpThreads, "ALL_CPUS"))
nThreads = CPLGetNumCPUs();
else
nThreads = atoi(pszWarpThreads);
if (nThreads <= 1)
nThreads = 0;
if (nThreads > 128)
nThreads = 128;
GWKThreadData *psThreadData = new GWKThreadData();
auto poThreadPool =
nThreads > 0 ? GDALGetGlobalThreadPool(nThreads) : nullptr;
if (nThreads && poThreadPool)
{
psThreadData->nMaxThreads = nThreads;
psThreadData->threadJobs.reset(new std::vector<GWKJobStruct>(
nThreads,
GWKJobStruct(psThreadData->mutex, psThreadData->cv,
psThreadData->counter, psThreadData->stopFlag)));
psThreadData->poJobQueue = poThreadPool->CreateJobQueue();
psThreadData->pTransformerArgInput = pTransformerArg;
}
return psThreadData;
}
/************************************************************************/
/* GWKThreadsEnd() */
/************************************************************************/
void GWKThreadsEnd(void *psThreadDataIn)
{
if (psThreadDataIn == nullptr)
return;
GWKThreadData *psThreadData = static_cast<GWKThreadData *>(psThreadDataIn);
if (psThreadData->poJobQueue)
{
for (auto &pair : psThreadData->mapThreadToTransformerArg)
{
CPLAssert(pair.second != psThreadData->pTransformerArgInput);
GDALDestroyTransformer(pair.second);
}
psThreadData->poJobQueue.reset();
}
delete psThreadData;
}
/************************************************************************/
/* ThreadFuncAdapter() */
/************************************************************************/
static void ThreadFuncAdapter(void *pData)
{
GWKJobStruct *psJob = static_cast<GWKJobStruct *>(pData);
GWKThreadData *psThreadData =
static_cast<GWKThreadData *>(psJob->poWK->psThreadData);
// Look if we have already a per-thread transformer
void *pTransformerArg = nullptr;
const GIntBig nThreadId = CPLGetPID();
{
std::lock_guard<std::mutex> lock(psThreadData->mutex);
++psThreadData->nCurThreadCountForThisRun;
auto oIter = psThreadData->mapThreadToTransformerArg.find(nThreadId);
if (oIter != psThreadData->mapThreadToTransformerArg.end())
{
pTransformerArg = oIter->second;
}
else if (!psThreadData->bTransformerArgInputAssignedToThread &&
psThreadData->nCurThreadCountForThisRun ==
psThreadData->nTotalThreadCountForThisRun)
{
// If we are the last thread to be started, temporarily borrow the
// original transformer
psThreadData->bTransformerArgInputAssignedToThread = true;
pTransformerArg = psThreadData->pTransformerArgInput;
psThreadData->mapThreadToTransformerArg[nThreadId] =
pTransformerArg;
}
if (pTransformerArg == nullptr)
{
CPLAssert(psThreadData->pTransformerArgInput != nullptr);
CPLAssert(!psThreadData->bTransformerArgInputAssignedToThread);
}
}
// If no transformer assigned to current thread, instantiate one
if (pTransformerArg == nullptr)
{
// This somehow assumes that GDALCloneTransformer() is thread-safe
// which should normally be the case.
pTransformerArg =
GDALCloneTransformer(psThreadData->pTransformerArgInput);
// Lock for the stop flag and the transformer map.
std::lock_guard<std::mutex> lock(psThreadData->mutex);
if (!pTransformerArg)
{
psJob->stopFlag = true;
return;
}
psThreadData->mapThreadToTransformerArg[nThreadId] = pTransformerArg;
}
psJob->pTransformerArg = pTransformerArg;
psJob->pfnFunc(pData);
// Give back original transformer, if borrowed.
{
std::lock_guard<std::mutex> lock(psThreadData->mutex);
if (psThreadData->bTransformerArgInputAssignedToThread &&
pTransformerArg == psThreadData->pTransformerArgInput)
{
psThreadData->mapThreadToTransformerArg.erase(
psThreadData->mapThreadToTransformerArg.find(nThreadId));
psThreadData->bTransformerArgInputAssignedToThread = false;
}
}
}
/************************************************************************/
/* GWKRun() */
/************************************************************************/
static CPLErr GWKRun(GDALWarpKernel *poWK, const char *pszFuncName,
void (*pfnFunc)(void *pUserData))
{
const int nDstYSize = poWK->nDstYSize;
CPLDebug("GDAL",
"GDALWarpKernel()::%s() "
"Src=%d,%d,%dx%d Dst=%d,%d,%dx%d",
pszFuncName, poWK->nSrcXOff, poWK->nSrcYOff, poWK->nSrcXSize,
poWK->nSrcYSize, poWK->nDstXOff, poWK->nDstYOff, poWK->nDstXSize,
poWK->nDstYSize);
if (!poWK->pfnProgress(poWK->dfProgressBase, "", poWK->pProgress))
{
CPLError(CE_Failure, CPLE_UserInterrupt, "User terminated");
return CE_Failure;
}
GWKThreadData *psThreadData =
static_cast<GWKThreadData *>(poWK->psThreadData);
if (psThreadData == nullptr || psThreadData->poJobQueue == nullptr)
{
return GWKGenericMonoThread(poWK, pfnFunc);
}
int nThreads = std::min(psThreadData->nMaxThreads, nDstYSize / 2);
// Config option mostly useful for tests to be able to test multithreading
// with small rasters
const int nWarpChunkSize =
atoi(CPLGetConfigOption("WARP_THREAD_CHUNK_SIZE", "65536"));
if (nWarpChunkSize > 0)
{
GIntBig nChunks =
static_cast<GIntBig>(nDstYSize) * poWK->nDstXSize / nWarpChunkSize;
if (nThreads > nChunks)
nThreads = static_cast<int>(nChunks);
}
if (nThreads <= 0)
nThreads = 1;
CPLDebug("WARP", "Using %d threads", nThreads);
auto &jobs = *psThreadData->threadJobs;
CPLAssert(static_cast<int>(jobs.size()) >= nThreads);
// Fill-in job structures.
for (int i = 0; i < nThreads; ++i)
{
auto &job = jobs[i];
job.poWK = poWK;
job.iYMin =
static_cast<int>(static_cast<int64_t>(i) * nDstYSize / nThreads);
job.iYMax = static_cast<int>(static_cast<int64_t>(i + 1) * nDstYSize /
nThreads);
if (poWK->pfnProgress != GDALDummyProgress)
job.pfnProgress = GWKProgressThread;
job.pfnFunc = pfnFunc;
}
{
std::unique_lock<std::mutex> lock(psThreadData->mutex);
psThreadData->nTotalThreadCountForThisRun = nThreads;
// coverity[missing_lock]
psThreadData->nCurThreadCountForThisRun = 0;
// Start jobs.
for (int i = 0; i < nThreads; ++i)
{
auto &job = jobs[i];
psThreadData->poJobQueue->SubmitJob(ThreadFuncAdapter,
static_cast<void *>(&job));
}
/* --------------------------------------------------------------------
*/
/* Report progress. */
/* --------------------------------------------------------------------
*/
if (poWK->pfnProgress != GDALDummyProgress)
{
int &counter = psThreadData->counter;
while (counter < nDstYSize)
{
psThreadData->cv.wait(lock);
if (!poWK->pfnProgress(
poWK->dfProgressBase +
poWK->dfProgressScale *
(counter / static_cast<double>(nDstYSize)),
"", poWK->pProgress))
{
CPLError(CE_Failure, CPLE_UserInterrupt, "User terminated");
psThreadData->stopFlag = true;
break;
}
}
}
}
/* -------------------------------------------------------------------- */
/* Wait for all jobs to complete. */
/* -------------------------------------------------------------------- */
psThreadData->poJobQueue->WaitCompletion();
return psThreadData->stopFlag ? CE_Failure : CE_None;
}
/************************************************************************/
/* ==================================================================== */
/* GDALWarpKernel */
/* ==================================================================== */
/************************************************************************/
/**
* \class GDALWarpKernel "gdalwarper.h"
*
* Low level image warping class.
*
* This class is responsible for low level image warping for one
* "chunk" of imagery. The class is essentially a structure with all
* data members public - primarily so that new special-case functions
* can be added without changing the class declaration.
*
* Applications are normally intended to interactive with warping facilities
* through the GDALWarpOperation class, though the GDALWarpKernel can in
* theory be used directly if great care is taken in setting up the
* control data.
*
* <h3>Design Issues</h3>
*
* The intention is that PerformWarp() would analyze the setup in terms
* of the datatype, resampling type, and validity/density mask usage and
* pick one of many specific implementations of the warping algorithm over
* a continuum of optimization vs. generality. At one end there will be a
* reference general purpose implementation of the algorithm that supports
* any data type (working internally in double precision complex), all three
* resampling types, and any or all of the validity/density masks. At the
* other end would be highly optimized algorithms for common cases like
* nearest neighbour resampling on GDT_Byte data with no masks.
*
* The full set of optimized versions have not been decided but we should
* expect to have at least:
* - One for each resampling algorithm for 8bit data with no masks.
* - One for each resampling algorithm for float data with no masks.
* - One for each resampling algorithm for float data with any/all masks
* (essentially the generic case for just float data).
* - One for each resampling algorithm for 8bit data with support for
* input validity masks (per band or per pixel). This handles the common
* case of nodata masking.
* - One for each resampling algorithm for float data with support for
* input validity masks (per band or per pixel). This handles the common
* case of nodata masking.
*
* Some of the specializations would operate on all bands in one pass
* (especially the ones without masking would do this), while others might
* process each band individually to reduce code complexity.
*
* <h3>Masking Semantics</h3>
*
* A detailed explanation of the semantics of the validity and density masks,
* and their effects on resampling kernels is needed here.
*/
/************************************************************************/
/* GDALWarpKernel Data Members */
/************************************************************************/
/**
* \var GDALResampleAlg GDALWarpKernel::eResample;
*
* Resampling algorithm.
*
* The resampling algorithm to use. One of GRA_NearestNeighbour, GRA_Bilinear,
* GRA_Cubic, GRA_CubicSpline, GRA_Lanczos, GRA_Average, GRA_RMS,
* GRA_Mode or GRA_Sum.
*
* This field is required. GDT_NearestNeighbour may be used as a default
* value.
*/
/**
* \var GDALDataType GDALWarpKernel::eWorkingDataType;
*
* Working pixel data type.
*
* The datatype of pixels in the source image (papabySrcimage) and
* destination image (papabyDstImage) buffers. Note that operations on
* some data types (such as GDT_Byte) may be much better optimized than other
* less common cases.
*
* This field is required. It may not be GDT_Unknown.
*/
/**
* \var int GDALWarpKernel::nBands;
*
* Number of bands.
*
* The number of bands (layers) of imagery being warped. Determines the
* number of entries in the papabySrcImage, papanBandSrcValid,
* and papabyDstImage arrays.
*
* This field is required.
*/
/**
* \var int GDALWarpKernel::nSrcXSize;
*
* Source image width in pixels.
*
* This field is required.
*/
/**
* \var int GDALWarpKernel::nSrcYSize;
*
* Source image height in pixels.
*
* This field is required.
*/
/**
* \var double GDALWarpKernel::dfSrcXExtraSize;
*
* Number of pixels included in nSrcXSize that are present on the edges of
* the area of interest to take into account the width of the kernel.
*
* This field is required.
*/
/**
* \var double GDALWarpKernel::dfSrcYExtraSize;
*
* Number of pixels included in nSrcYExtraSize that are present on the edges of
* the area of interest to take into account the height of the kernel.
*
* This field is required.
*/
/**
* \var int GDALWarpKernel::papabySrcImage;
*
* Array of source image band data.
*
* This is an array of pointers (of size GDALWarpKernel::nBands) pointers
* to image data. Each individual band of image data is organized as a single
* block of image data in left to right, then bottom to top order. The actual
* type of the image data is determined by GDALWarpKernel::eWorkingDataType.
*
* To access the pixel value for the (x=3, y=4) pixel (zero based) of
* the second band with eWorkingDataType set to GDT_Float32 use code like
* this:
*
* \code
* float dfPixelValue;
* int nBand = 2-1; // Band indexes are zero based.
* int nPixel = 3; // Zero based.
* int nLine = 4; // Zero based.
*
* assert( nPixel >= 0 && nPixel < poKern->nSrcXSize );
* assert( nLine >= 0 && nLine < poKern->nSrcYSize );
* assert( nBand >= 0 && nBand < poKern->nBands );
* dfPixelValue = ((float *) poKern->papabySrcImage[nBand])
* [nPixel + nLine * poKern->nSrcXSize];
* \endcode
*
* This field is required.
*/
/**
* \var GUInt32 **GDALWarpKernel::papanBandSrcValid;
*
* Per band validity mask for source pixels.
*
* Array of pixel validity mask layers for each source band. Each of
* the mask layers is the same size (in pixels) as the source image with
* one bit per pixel. Note that it is legal (and common) for this to be
* NULL indicating that none of the pixels are invalidated, or for some
* band validity masks to be NULL in which case all pixels of the band are
* valid. The following code can be used to test the validity of a particular
* pixel.
*
* \code
* int bIsValid = TRUE;
* int nBand = 2-1; // Band indexes are zero based.
* int nPixel = 3; // Zero based.
* int nLine = 4; // Zero based.
*
* assert( nPixel >= 0 && nPixel < poKern->nSrcXSize );
* assert( nLine >= 0 && nLine < poKern->nSrcYSize );
* assert( nBand >= 0 && nBand < poKern->nBands );
*
* if( poKern->papanBandSrcValid != NULL
* && poKern->papanBandSrcValid[nBand] != NULL )
* {
* GUInt32 *panBandMask = poKern->papanBandSrcValid[nBand];
* int iPixelOffset = nPixel + nLine * poKern->nSrcXSize;
*
* bIsValid = CPLMaskGet(panBandMask, iPixelOffset)
* }
* \endcode
*/
/**
* \var GUInt32 *GDALWarpKernel::panUnifiedSrcValid;
*
* Per pixel validity mask for source pixels.
*
* A single validity mask layer that applies to the pixels of all source
* bands. It is accessed similarly to papanBandSrcValid, but without the
* extra level of band indirection.
*
* This pointer may be NULL indicating that all pixels are valid.
*
* Note that if both panUnifiedSrcValid, and papanBandSrcValid are available,
* the pixel isn't considered to be valid unless both arrays indicate it is
* valid.
*/
/**
* \var float *GDALWarpKernel::pafUnifiedSrcDensity;
*
* Per pixel density mask for source pixels.
*
* A single density mask layer that applies to the pixels of all source
* bands. It contains values between 0.0 and 1.0 indicating the degree to
* which this pixel should be allowed to contribute to the output result.
*
* This pointer may be NULL indicating that all pixels have a density of 1.0.
*
* The density for a pixel may be accessed like this:
*
* \code
* float fDensity = 1.0;
* int nPixel = 3; // Zero based.
* int nLine = 4; // Zero based.
*
* assert( nPixel >= 0 && nPixel < poKern->nSrcXSize );
* assert( nLine >= 0 && nLine < poKern->nSrcYSize );
* if( poKern->pafUnifiedSrcDensity != NULL )
* fDensity = poKern->pafUnifiedSrcDensity
* [nPixel + nLine * poKern->nSrcXSize];
* \endcode
*/
/**
* \var int GDALWarpKernel::nDstXSize;
*
* Width of destination image in pixels.
*
* This field is required.
*/
/**
* \var int GDALWarpKernel::nDstYSize;
*
* Height of destination image in pixels.
*
* This field is required.
*/
/**
* \var GByte **GDALWarpKernel::papabyDstImage;
*
* Array of destination image band data.
*
* This is an array of pointers (of size GDALWarpKernel::nBands) pointers
* to image data. Each individual band of image data is organized as a single
* block of image data in left to right, then bottom to top order. The actual
* type of the image data is determined by GDALWarpKernel::eWorkingDataType.
*
* To access the pixel value for the (x=3, y=4) pixel (zero based) of
* the second band with eWorkingDataType set to GDT_Float32 use code like
* this:
*
* \code
* float dfPixelValue;
* int nBand = 2-1; // Band indexes are zero based.
* int nPixel = 3; // Zero based.
* int nLine = 4; // Zero based.
*
* assert( nPixel >= 0 && nPixel < poKern->nDstXSize );
* assert( nLine >= 0 && nLine < poKern->nDstYSize );
* assert( nBand >= 0 && nBand < poKern->nBands );
* dfPixelValue = ((float *) poKern->papabyDstImage[nBand])
* [nPixel + nLine * poKern->nSrcYSize];
* \endcode
*
* This field is required.
*/
/**
* \var GUInt32 *GDALWarpKernel::panDstValid;
*
* Per pixel validity mask for destination pixels.
*
* A single validity mask layer that applies to the pixels of all destination
* bands. It is accessed similarly to papanUnitifiedSrcValid, but based
* on the size of the destination image.
*
* This pointer may be NULL indicating that all pixels are valid.
*/
/**
* \var float *GDALWarpKernel::pafDstDensity;
*
* Per pixel density mask for destination pixels.
*
* A single density mask layer that applies to the pixels of all destination
* bands. It contains values between 0.0 and 1.0.
*
* This pointer may be NULL indicating that all pixels have a density of 1.0.
*
* The density for a pixel may be accessed like this:
*
* \code
* float fDensity = 1.0;
* int nPixel = 3; // Zero based.
* int nLine = 4; // Zero based.
*
* assert( nPixel >= 0 && nPixel < poKern->nDstXSize );
* assert( nLine >= 0 && nLine < poKern->nDstYSize );
* if( poKern->pafDstDensity != NULL )
* fDensity = poKern->pafDstDensity[nPixel + nLine * poKern->nDstXSize];
* \endcode
*/
/**
* \var int GDALWarpKernel::nSrcXOff;
*
* X offset to source pixel coordinates for transformation.
*
* See pfnTransformer.
*
* This field is required.
*/
/**
* \var int GDALWarpKernel::nSrcYOff;
*
* Y offset to source pixel coordinates for transformation.
*
* See pfnTransformer.
*
* This field is required.
*/
/**
* \var int GDALWarpKernel::nDstXOff;
*
* X offset to destination pixel coordinates for transformation.
*
* See pfnTransformer.
*
* This field is required.
*/
/**
* \var int GDALWarpKernel::nDstYOff;
*
* Y offset to destination pixel coordinates for transformation.
*
* See pfnTransformer.
*
* This field is required.
*/
/**
* \var GDALTransformerFunc GDALWarpKernel::pfnTransformer;
*
* Source/destination location transformer.
*
* The function to call to transform coordinates between source image
* pixel/line coordinates and destination image pixel/line coordinates.
* See GDALTransformerFunc() for details of the semantics of this function.
*
* The GDALWarpKern algorithm will only ever use this transformer in
* "destination to source" mode (bDstToSrc=TRUE), and will always pass
* partial or complete scanlines of points in the destination image as
* input. This means, among other things, that it is safe to the
* approximating transform GDALApproxTransform() as the transformation
* function.
*
* Source and destination images may be subsets of a larger overall image.
* The transformation algorithms will expect and return pixel/line coordinates
* in terms of this larger image, so coordinates need to be offset by
* the offsets specified in nSrcXOff, nSrcYOff, nDstXOff, and nDstYOff before
* passing to pfnTransformer, and after return from it.
*
* The GDALWarpKernel::pfnTransformerArg value will be passed as the callback
* data to this function when it is called.
*
* This field is required.
*/
/**
* \var void *GDALWarpKernel::pTransformerArg;
*
* Callback data for pfnTransformer.
*
* This field may be NULL if not required for the pfnTransformer being used.
*/
/**
* \var GDALProgressFunc GDALWarpKernel::pfnProgress;
*
* The function to call to report progress of the algorithm, and to check
* for a requested termination of the operation. It operates according to
* GDALProgressFunc() semantics.
*
* Generally speaking the progress function will be invoked for each
* scanline of the destination buffer that has been processed.
*
* This field may be NULL (internally set to GDALDummyProgress()).
*/
/**
* \var void *GDALWarpKernel::pProgress;
*
* Callback data for pfnProgress.
*
* This field may be NULL if not required for the pfnProgress being used.
*/
/************************************************************************/
/* GDALWarpKernel() */
/************************************************************************/
GDALWarpKernel::GDALWarpKernel()
: papszWarpOptions(nullptr), eResample(GRA_NearestNeighbour),
eWorkingDataType(GDT_Unknown), nBands(0), nSrcXSize(0), nSrcYSize(0),
dfSrcXExtraSize(0.0), dfSrcYExtraSize(0.0), papabySrcImage(nullptr),
papanBandSrcValid(nullptr), panUnifiedSrcValid(nullptr),
pafUnifiedSrcDensity(nullptr), nDstXSize(0), nDstYSize(0),
papabyDstImage(nullptr), panDstValid(nullptr), pafDstDensity(nullptr),
dfXScale(1.0), dfYScale(1.0), dfXFilter(0.0), dfYFilter(0.0), nXRadius(0),
nYRadius(0), nFiltInitX(0), nFiltInitY(0), nSrcXOff(0), nSrcYOff(0),
nDstXOff(0), nDstYOff(0), pfnTransformer(nullptr),
pTransformerArg(nullptr), pfnProgress(GDALDummyProgress),
pProgress(nullptr), dfProgressBase(0.0), dfProgressScale(1.0),
padfDstNoDataReal(nullptr), psThreadData(nullptr)
{
}