/
cog.go
248 lines (210 loc) · 8.4 KB
/
cog.go
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
package image
import (
"context"
"fmt"
"io"
"os"
"path/filepath"
"strconv"
"github.com/airbusgeo/geocube/internal/utils"
"github.com/airbusgeo/cogger"
"github.com/airbusgeo/geocube/internal/geocube"
"github.com/airbusgeo/godal"
"github.com/google/tiff"
)
type CogGenerator interface {
Create(dataset *godal.Dataset, oContainer geocube.ConsolidationContainer, recordId, workDir string) (string, error)
Open(ctx context.Context, filePath string) (*godal.Dataset, error)
}
func NewCogGenerator() CogGenerator {
return &cogGenerator{}
}
type cogGenerator struct{}
func (c *cogGenerator) Create(dataset *godal.Dataset, oContainer geocube.ConsolidationContainer, recordId, workDir string) (string, error) {
options := []string{
"-co", "TILED=YES",
"-co", fmt.Sprintf("BLOCKXSIZE=%d", oContainer.BlockXSize),
"-co", fmt.Sprintf("BLOCKYSIZE=%d", oContainer.BlockYSize),
"-co", fmt.Sprintf("NUM_THREADS=%v", "ALL_CPUS"),
"-co", "SPARSE_OK=TRUE",
}
if oContainer.Compression != geocube.CompressionNO {
options = c.addCompressionOption(oContainer, options)
}
isBig := (oContainer.Width * oContainer.Height) >= (10000 * 10000)
if isBig {
options = append(options, "-co", "BIGTIFF=YES")
}
tiffDatasetPath := filepath.Join("/vsimem", fmt.Sprintf("tiff_%s.tif", recordId))
tiffDataset, err := dataset.Translate(tiffDatasetPath, options)
if err != nil {
return "", fmt.Errorf("Create.Translate: %w", err)
}
defer func() {
tiffDataset.Close()
godal.VSIUnlink(tiffDatasetPath) // Delete the VSI or traditionnal file
}()
for i := 0; i < tiffDataset.Structure().NBands; i++ {
band := tiffDataset.Bands()[i]
err = band.SetNoData(oContainer.DatasetFormat.NoData)
if err != nil {
return "", fmt.Errorf("Create.SetNoData: %w", err)
}
}
if oContainer.OverviewsMinSize != geocube.NO_OVERVIEW {
if err := c.buildOverviews(tiffDataset, oContainer.OvrResamplingAlg, oContainer.OverviewsMinSize); err != nil {
return "", fmt.Errorf("Create.%w", err)
}
}
if err = tiffDataset.Close(); err != nil {
return "", fmt.Errorf("Create.Close: %w", err)
}
cogDatasetPath := filepath.Join(workDir, fmt.Sprintf("cog_%s.tif", recordId))
if err = c.rewriteTiff(tiffDatasetPath, cogDatasetPath); err != nil {
return "", fmt.Errorf("Create.%w", err)
}
return cogDatasetPath, nil
}
/*
Open a cog or return an error if file is not a valid COG (see: https://github.com/rouault/cog_validator/blob/master/validate_cloud_optimized_geotiff.py)
The caller is responsible for closing the dataset
*/
func (c *cogGenerator) Open(ctx context.Context, filepath string) (*godal.Dataset, error) {
ds, err := godal.Open(filepath, godal.Drivers("GTiff"))
if err != nil {
return nil, err
}
band := ds.Bands()[0]
ovrCount := len(band.Overviews())
sizeX := band.Structure().SizeX
sizeY := band.Structure().SizeY
blockSizeX := band.Structure().BlockSizeX
blockSizeY := band.Structure().BlockSizeY
if sizeX > 512 || sizeY > 512 {
if (blockSizeX == sizeX && blockSizeX > 1024) || (blockSizeY == sizeY && blockSizeY > 1024) {
err = utils.MergeErrors(true, err, fmt.Errorf("file is greater than 1024xHeight or Widthx1024, but is not tiled"))
}
}
var ifdOffsets []int
ifdOffset, e := strconv.Atoi(band.Metadata("IFD_OFFSET", godal.Domain("TIFF")))
if e != nil {
err = utils.MergeErrors(true, err, e)
}
ifdOffsets = append(ifdOffsets, ifdOffset)
for i := 0; i < ovrCount; i++ {
ovrBand := band.Overviews()[i]
if i == 0 {
if ovrBand.Structure().SizeX > sizeX || ovrBand.Structure().SizeY > sizeY {
err = utils.MergeErrors(true, err, fmt.Errorf("first overview has larger dimension than main band"))
}
} else {
previousOvrBand := band.Overviews()[i-1]
if ovrBand.Structure().SizeX > previousOvrBand.Structure().SizeX || ovrBand.Structure().SizeY > previousOvrBand.Structure().SizeY {
err = utils.MergeErrors(true, err, fmt.Errorf("overview of index %d has larger dimension than overview of index %d", i, i-1))
}
}
blockSizeXBandOvr := ovrBand.Structure().BlockSizeX
blockSizeYBandOvr := ovrBand.Structure().BlockSizeY
if (blockSizeXBandOvr == sizeX && blockSizeXBandOvr > 1024) || (blockSizeYBandOvr == sizeY && blockSizeYBandOvr > 1024) {
err = utils.MergeErrors(true, err, fmt.Errorf("overview of index %d is not tiled", i))
}
if ifdOffset, e = strconv.Atoi(ovrBand.Metadata("IFD_OFFSET", godal.Domain("TIFF"))); e != nil {
err = utils.MergeErrors(true, err, e)
}
ifdOffsets = append(ifdOffsets, ifdOffset)
if ifdOffsets[len(ifdOffsets)-1] < ifdOffsets[len(ifdOffsets)-2] {
if i == 0 {
err = utils.MergeErrors(true, err, fmt.Errorf("the offset of the IFD for overview of index %d is %d, whereas it should be greater than the one of the main image, which is at byte %d", i, ifdOffsets[len(ifdOffsets)-1], ifdOffsets[len(ifdOffsets)-2]))
} else {
err = utils.MergeErrors(true, err, fmt.Errorf("the offset of the IFD for overview of index %d is %d, whereas it should be greater than the one of index %d, which is at byte %d", i, ifdOffsets[len(ifdOffsets)-1], i-1, ifdOffsets[len(ifdOffsets)-2]))
}
}
}
blockOffset := c.getBlockOffset(band)
dataOffsets := []int{blockOffset}
for i := 0; i < ovrCount; i++ {
ovrBand := band.Overviews()[i]
blockOffset = c.getBlockOffset(ovrBand)
dataOffsets = append(dataOffsets, blockOffset)
}
if dataOffsets[len(dataOffsets)-1] != 0 && dataOffsets[len(dataOffsets)-1] < ifdOffsets[len(ifdOffsets)-1] {
if ovrCount > 0 {
err = utils.MergeErrors(true, err, fmt.Errorf("the offset of the first block of the smallest overview should be after its IFD"))
} else {
err = utils.MergeErrors(true, err, fmt.Errorf("the offset of the first block of the image should be after its IFD"))
}
}
/*if len(dataOffsets) >= 2 && dataOffsets[0] != 0 && dataOffsets[0] < dataOffsets[1] {
err = utils.MergeErrors(true, err, fmt.Errorf("the offset of the first block of the main resolution image should be after the one of the overview of index %d", ovrCount-1))
}*/
if err != nil {
ds.Close()
return nil, err
}
return ds, nil
}
func (c *cogGenerator) getBlockOffset(band godal.Band) int {
blockSizeX, blockSizeY := band.Structure().BlockSizeX, band.Structure().BlockSizeY
for y := 0; y < (band.Structure().SizeY+blockSizeY-1)/blockSizeY; y++ {
for x := 0; x < (band.Structure().SizeX+blockSizeX-1)/blockSizeX; x++ {
blockOffset := band.Metadata(fmt.Sprintf("BLOCK_OFFSET_%d_%d", x, y), godal.Domain("TIFF"))
if blockOffset != "" {
i, err := strconv.Atoi(blockOffset)
if err != nil {
return -1
}
return i
}
}
}
return -1
}
func (c *cogGenerator) addCompressionOption(container geocube.ConsolidationContainer, options []string) []string {
switch container.DatasetFormat.DType {
case geocube.DTypeINT8, geocube.DTypeUINT8, geocube.DTypeINT16, geocube.DTypeUINT16, geocube.DTypeINT32, geocube.DTypeUINT32:
switch container.Compression {
case geocube.CompressionLOSSY:
options = append(options, "-co", "COMPRESS=LERC", "-co", "MAX_Z_ERROR=0.01")
case geocube.CompressionLOSSLESS:
options = append(options, "-co", "COMPRESS=ZSTD", "-co", "PREDICTOR=2")
}
case geocube.DTypeFLOAT32, geocube.DTypeFLOAT64:
switch container.Compression {
case geocube.CompressionLOSSY:
options = append(options, "-co", "COMPRESS=LERC_ZSTD", "-co", "MAX_Z_ERROR=0.01")
case geocube.CompressionLOSSLESS:
options = append(options, "-co", "COMPRESS=LERC_ZSTD", "-co", "MAX_Z_ERROR=0")
}
case geocube.DTypeCOMPLEX64:
options = append(options, "")
default:
options = append(options, "")
}
return options
}
func (c *cogGenerator) buildOverviews(d *godal.Dataset, resampling geocube.Resampling, overviewsMinSize int) error {
if err := d.BuildOverviews(godal.Resampling(resampling.ToGDAL()), godal.MinSize(overviewsMinSize)); err != nil {
return fmt.Errorf("buildOverviews: %w", err)
}
return nil
}
func (c *cogGenerator) rewriteTiff(src, dest string) error {
file, fdesc, err := c.openDatasetTiffs(src)
if err != nil {
return fmt.Errorf("rewriteTiff: %w", err)
}
defer fdesc.Close()
finalCogFile, err := os.Create(dest)
if err != nil {
return fmt.Errorf("rewriteTiff: %w", err)
}
defer finalCogFile.Close()
return cogger.Rewrite(finalCogFile, file)
}
func (c *cogGenerator) openDatasetTiffs(datasetFileName string) (tiff.ReadAtReadSeeker, io.Closer, error) {
fd, err := godal.VSIOpen(datasetFileName)
if err != nil {
return nil, nil, fmt.Errorf("failed to open file [%s]: %w", datasetFileName, err)
}
return tiff.NewReadAtReadSeeker(fd), fd, nil
}