WSL/SLF GitLab Repository

PNGIO.cc 27.3 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
/***********************************************************************************/
/*  Copyright 2009 WSL Institute for Snow and Avalanche Research    SLF-DAVOS      */
/***********************************************************************************/
/* This file is part of MeteoIO.
    MeteoIO is free software: you can redistribute it and/or modify
    it under the terms of the GNU Lesser General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    MeteoIO is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public License
    along with MeteoIO.  If not, see <http://www.gnu.org/licenses/>.
*/
#include "PNGIO.h"
#include <meteoio/ResamplingAlgorithms2D.h>
20
#include <meteoio/Graphics.h>
21
#include <meteoio/meteolaws/Meteoconst.h>
22
23

#include <algorithm>
24
#include <errno.h>
25
#include <zlib.h>
26
27
28
29
30

using namespace std;

namespace mio {
/**
31
 * @page pngio PNGIO
32
 * @section template_format Format
33
34
35
36
 * This plugin write data to the Portable Network Graphics format (see https://secure.wikimedia.org/wikipedia/en/wiki/Portable_Network_Graphics).
 * No data read has been implemented, because reading an existing file would require the exact knowlege of the color gradient that has been used
 * to create it. When writing grids, various color gradients will be used depending on the parameter that the data represents. Nodata values
 * are represented by transparent pixels (transparency is acheived through a transparent color instead of a true alpha channel for size and performance).
37
 * If a grid containing no data (ie: size 0x0) is sent to the plugin, then no file will be written.
38
 * Finally, the naming scheme for meteo grids should be: YYYY-MM-DDTHH.mm_{MeteoGrids::Parameters}.png
39
40
 *
 * @section template_units Units
41
 * All units are MKSA except temperatures that are expressed in celcius.
42
43
44
 *
 * @section template_keywords Keywords
 * This plugin uses the following keywords:
45
46
 * - COORDSYS: input coordinate system (see Coords) specified in the [Output] section
 * - COORDPARAM: extra input coordinates parameters (see Coords) specified in the [Output] section
47
48
49
50
51
52
53
 * - GRID2DPATH: meteo grids directory where to read the grids; [Output] section
 * - PNG_LEGEND: plot legend on the side of the graph? (default: true)
 * - PNG_MIN_SIZE: guarantee that a 2D plot will have at least the given size
 * - PNG_MAX_SIZE: guarantee that a 2D plot will have at most the given size
 * - PNG_SCALING: scaling algorithm, either nearest or bilinear (default=bilinear)
 * - PNG_AUTOSCALE: autoscale for the color gradient? (default=true)
 * - PNG_WORLD_FILE: create world file with each file? (default=false)
54
55
 *
 * Advanced parameters (ie: don't mess up with them if you don't know what you're doing):
56
 * - PNG_INDEXED: create an indexed PNG? (default=true)
57
 * - PNG_NR_LEVELS: number of colors to use (less=smaller files, but it must be at least 5 and less than 255. default=30)
58
 * - PNG_SPEED_OPTIMIZE: optimize file creation for speed? (default=true, otherwise optimize for file size)
59
60
 *
 * The size are specified as width followed by height, with the separator being either a space, 'x' or '*'. If a minimum and a maximum size are given, the average of the smallest and largest permissible sizes will be used.
61
62
63
64
65
66
67
68
69
70
71
 * The world file is used for geolocalization and goes alongside the graphics output. By convention,
 * the file has the same name as the image file, with the third letter of the extension jammed with a w: tif->tfw, jpg->jqw.
 * The format is the following:
 * @code
 *    5.000000000000 (size of pixel in x direction)
 *    0.000000000000 (rotation term for row)
 *    0.000000000000 (rotation term for column)
 *    -5.000000000000 (size of pixel in y direction)
 *    492169.690845528910 (x coordinate of centre of upper left pixel in map units)
 *    5426523.318065105000 (y coordinate of centre of upper left pixel in map units)
 * @endcode
72
 *
73
 * @section example Example use
74
75
76
77
78
79
 * @code
 * GRID2D = PNG
 * png_legend = false
 * png_min_size = 400x400
 * png_max_size = 1366*768
 * @endcode
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 *
 * @section Compilation
 * In order to compile this plugin, you need libpng and zlib. For Linux, please select both the libraries and their development files in your package manager.
 *
 * For Windows, you can find zlib at http://switch.dl.sourceforge.net/project/gnuwin32/zlib/1.2.3/zlib-1.2.3.exe
 * and libpng at http://switch.dl.sourceforge.net/project/gnuwin32/libpng/1.2.37/libpng-1.2.37-setup.exe . Once this has been installed, if you plan on using
 * Visual c++, you also need to edit the file zconf.h in the libpng installation directory and transform the line 287:
 * @code
 * #if 0           // HAVE_UNISTD_H etc etc
 * @endcode
 * should become
 * @code
 * #if 1           // HAVE_UNISTD_H etc etc
 * @endcode
94
95
96
 */

const double PNGIO::plugin_nodata = -999.; //plugin specific nodata value. It can also be read by the plugin (depending on what is appropriate)
97
98
99
const unsigned char PNGIO::channel_depth = 8;
const unsigned char PNGIO::channel_max_color = 255;
const unsigned char PNGIO::transparent_grey = channel_max_color;
100
101
102

PNGIO::PNGIO(void (*delObj)(void*), const Config& i_cfg) : IOInterface(delObj), cfg(i_cfg)
{
103
	setOptions();
104
105
106
107
}

PNGIO::PNGIO(const std::string& configfile) : IOInterface(NULL), cfg(configfile)
{
108
	setOptions();
109
110
111
112
}

PNGIO::PNGIO(const Config& cfgreader) : IOInterface(NULL), cfg(cfgreader)
{
113
114
115
116
117
	setOptions();
}

void PNGIO::setOptions()
{
118
119
	cfg.getValue("COORDSYS", "Output", coordout);
	cfg.getValue("COORDPARAM", "Output", coordoutparam, Config::nothrow);
120
	cfg.getValue("GRID2DPATH", "Output", grid2dpath);
121
122
	//cfg.getValue("TIME_ZONE", "Output", tz_out, Config::nothrow);

123
124
125
	//get size specifications
	std::string min_size, max_size;
	min_w = min_h = max_w = max_h = IOUtils::unodata;
126
	cfg.getValue("PNG_MIN_SIZE", "Output", min_size, Config::nothrow);
127
	if(min_size!="") parse_size(min_size, min_w, min_h);
128
	cfg.getValue("PNG_MAX_SIZE", "Output", max_size, Config::nothrow);
129
	if(max_size!="") parse_size(max_size, max_w, max_h);
130

131
	autoscale = true;
132
	cfg.getValue("PNG_AUTOSCALE", "Output", autoscale, Config::nothrow);
133
	has_legend = true;
134
	cfg.getValue("PNG_LEGEND", "Output", has_legend, Config::nothrow);
135
	scaling = "bilinear";
136
	cfg.getValue("PNG_SCALING", "Output", scaling, Config::nothrow);
137
	has_world_file=false;
138
	cfg.getValue("PNG_WORLD_FILE", "Output", has_world_file, Config::nothrow);
139
140
141
142
143

	if(has_legend) { //we need to save room for the legend
		if(min_w!=IOUtils::unodata) min_w -= legend::getLegendWidth();
		if(max_w!=IOUtils::unodata) max_w -= legend::getLegendWidth();
	}
144
145
146
147
148

	indexed_png = true;
	cfg.getValue("PNG_INDEXED", "Output", indexed_png, Config::nothrow);
	optimize_for_speed = true;
	cfg.getValue("PNG_SPEED_OPTIMIZE", "Output", optimize_for_speed, Config::nothrow);
149
	nr_levels = 30;
150
	unsigned int tmp=IOUtils::unodata;
151
	cfg.getValue("PNG_NR_LEVELS", "Output", tmp, Config::nothrow);
152
	if(tmp!=IOUtils::unodata && (tmp>255 || tmp<5)) {
153
154
		throw InvalidFormatException("PNG_NR_LEVELS must be between 5 and 255!", AT);
	}
155
	if(tmp!=IOUtils::unodata) nr_levels=static_cast<unsigned char>(tmp);
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
}

void PNGIO::parse_size(const std::string& size_spec, unsigned int& width, unsigned int& height)
{
	char rest[32] = "";
	if(sscanf(size_spec.c_str(), "%u %u%31s", &width, &height, rest) < 2)
	if(sscanf(size_spec.c_str(), "%u*%u%31s", &width, &height, rest) < 2)
	if(sscanf(size_spec.c_str(), "%ux%u%31s", &width, &height, rest) < 2) {
		std::stringstream ss;
		ss << "Can not parse PNGIO size specification \"" << size_spec << "\"";
		throw InvalidFormatException(ss.str(), AT);
	}
	std::string tmp(rest);
	IOUtils::trim(tmp);
	if ((tmp.length() > 0) && tmp[0] != '#' && tmp[0] != ';') {//if line holds more than one value it's invalid
		std::stringstream ss;
		ss << "Invalid PNGIO size specification \"" << size_spec << "\"";
		throw InvalidFormatException(ss.str(), AT);
	}
}

double PNGIO::getScaleFactor(const double& grid_w, const double& grid_h)
{
	if(grid_w==0 || grid_h==0) {
		return 1.;
	}

	double min_factor = IOUtils::nodata;
	if(min_w!=IOUtils::unodata) { //min_w & min_w are read together
		const double min_w_factor = (double)min_w / (double)grid_w;
		const double min_h_factor = (double)min_h / (double)grid_h;
		min_factor = std::max(min_w_factor, min_h_factor);
	}
189

190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
	double max_factor = IOUtils::nodata;
	if(max_w!=IOUtils::unodata) { //max_w & max_h are read together
		const double max_w_factor = (double)max_w / (double)grid_w;
		const double max_h_factor = (double)max_h / (double)grid_h;
		max_factor = std::min(max_w_factor, max_h_factor);
	}

	if(min_factor==IOUtils::nodata && max_factor==IOUtils::nodata)
		return 1.; //no user given specification
	if(min_factor!=IOUtils::nodata && max_factor!=IOUtils::nodata)
		return (min_factor+max_factor)/2.; //both min & max -> average

	//only one size specification provided -> return its matching factor
	if(min_factor!=IOUtils::nodata)
		return min_factor;
	else
		return max_factor;
207
208
}

209
PNGIO::~PNGIO() throw() {
210
	//HACK: implement a cleanup (close fp, free png pointers, etc
211
212
}

213
214
215
216
217
218
219
void PNGIO::read2DGrid(Grid2DObject&, const std::string&)
{
	//Nothing so far
	throw IOException("Nothing implemented here", AT);
}

void PNGIO::read2DGrid(Grid2DObject&, const MeteoGrids::Parameters& , const Date&)
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
{
	//Nothing so far
	throw IOException("Nothing implemented here", AT);
}

void PNGIO::readDEM(DEMObject& /*dem_out*/)
{
	//Nothing so far
	throw IOException("Nothing implemented here", AT);
}

void PNGIO::readLanduse(Grid2DObject& /*landuse_out*/)
{
	//Nothing so far
	throw IOException("Nothing implemented here", AT);
}

void PNGIO::readAssimilationData(const Date& /*date_in*/, Grid2DObject& /*da_out*/)
{
	//Nothing so far
	throw IOException("Nothing implemented here", AT);
}

void PNGIO::readStationData(const Date&, std::vector<StationData>& /*vecStation*/)
{
	//Nothing so far
	throw IOException("Nothing implemented here", AT);
}

void PNGIO::readMeteoData(const Date& /*dateStart*/, const Date& /*dateEnd*/,
                             std::vector< std::vector<MeteoData> >& /*vecMeteo*/,
                             const size_t&)
{
	//Nothing so far
	throw IOException("Nothing implemented here", AT);
}

void PNGIO::writeMeteoData(const std::vector< std::vector<MeteoData> >& /*vecMeteo*/,
                              const std::string&)
{
	//Nothing so far
	throw IOException("Nothing implemented here", AT);
}

void PNGIO::readSpecialPoints(std::vector<Coords>&)
{
	//Nothing so far
	throw IOException("Nothing implemented here", AT);
}

270
271
Grid2DObject PNGIO::scaleGrid(const Grid2DObject& grid_in)
{ //scale input image
272
	const double factor = getScaleFactor(grid_in.ncols, grid_in.nrows);
273
	if(scaling=="nearest")
274
		return ResamplingAlgorithms2D::NearestNeighbour(grid_in, factor);
275
	else if(scaling=="bilinear")
276
		return ResamplingAlgorithms2D::BilinearResampling(grid_in, factor);
277
278
279
280
281
	else {
		stringstream ss;
		ss << "Grid scaling algorithm \"" << scaling << "\" unknown";
		throw UnknownValueException(ss.str(), AT);
	}
282
}
283

284
void PNGIO::setFile(const std::string& filename, png_structp& png_ptr, png_infop& info_ptr, const unsigned int &width, const unsigned int &height)
285
{
286
287
288
289
	// Open file for writing (binary mode)
	if (!IOUtils::validFileName(filename)) {
		throw InvalidFileNameException(filename, AT);
	}
290
	errno=0;
291
292
	fp = fopen(filename.c_str(), "wb");
	if (fp == NULL) {
293
294
295
		stringstream ss;
		ss << "Error openning file \"" << filename << "\", possible reason: " << strerror(errno);
		throw FileAccessException(ss.str(), AT);
296
297
298
299
300
301
302
303
304
305
306
307
308
309
	}

	// Initialize write structure
	png_ptr = png_create_write_struct(PNG_LIBPNG_VER_STRING, NULL, NULL, NULL);
	if (png_ptr == NULL) {
		fclose(fp);
		throw IOException("Could not allocate write structure", AT);
	}

	// Initialize info structure
	info_ptr = png_create_info_struct(png_ptr);
	if (info_ptr == NULL) {
		fclose(fp);
		png_destroy_write_struct(&png_ptr, (png_infopp)NULL);
310
		free(png_ptr);
311
312
313
314
		throw IOException("Could not allocate info structure", AT);
	}

	// Setup Exception handling
315
316
317
#ifdef _WIN32
	#pragma warning(disable:4611) //the setjmp of libpng has been set up so that it can safely be called from c++
#endif
318
	if (setjmp(png_jmpbuf(png_ptr))) {
319
		closePNG(png_ptr, info_ptr, NULL);
320
		throw IOException("Error during png creation. Can not set jump pointer (I have no clue what it means too!)", AT);
321
322
323
324
	}

	png_init_io(png_ptr, fp);

325
	if(optimize_for_speed) png_set_compression_level(png_ptr, Z_BEST_SPEED);
326
327
	else png_set_compression_level(png_ptr, Z_BEST_COMPRESSION);

328
329
	png_set_filter(png_ptr, PNG_FILTER_TYPE_BASE, PNG_FILTER_SUB|PNG_FILTER_UP); //any other filter is costly and brings close to nothing...
	if(indexed_png) png_set_compression_strategy(png_ptr, Z_RLE); //Z_DEFAULT_STRATEGY, Z_FILTERED, Z_HUFFMAN_ONLY, Z_RLE
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347

	// Write header (8 bit colour depth). Full alpha channel with PNG_COLOR_TYPE_RGB_ALPHA
	if(indexed_png) {
		png_set_IHDR(png_ptr, info_ptr, width, height,
			channel_depth, PNG_COLOR_TYPE_PALETTE, PNG_INTERLACE_NONE,
			PNG_COMPRESSION_TYPE_BASE, PNG_FILTER_TYPE_BASE);
		//set transparent color (ie: cheap transparency: leads to smaller files and shorter run times)
		png_byte trans = 0; //by convention, the gradient define it as color 0
		png_set_tRNS(png_ptr, info_ptr, &trans, 1, 0);
	} else {
		png_set_IHDR(png_ptr, info_ptr, width, height,
			channel_depth, PNG_COLOR_TYPE_RGB, PNG_INTERLACE_NONE,
			PNG_COMPRESSION_TYPE_BASE, PNG_FILTER_TYPE_BASE);
		//set transparent color (ie: cheap transparency: leads to smaller files and shorter run times)
		png_color_16 trans_rgb_value = {transparent_grey, transparent_grey, transparent_grey, transparent_grey, transparent_grey};
		png_set_tRNS(png_ptr, info_ptr, 0, 0, &trans_rgb_value);
	}

348
349
350
	//set background color to help applications show the picture when no background is present
	png_color_16 background = {channel_max_color, channel_max_color, channel_max_color, channel_max_color, channel_max_color};
	png_set_background(png_ptr, &background, PNG_BACKGROUND_GAMMA_SCREEN, true, 1.0);
351
352
353
354
}

unsigned int PNGIO::setLegend(const unsigned int &ncols, const unsigned int &nrows, const double &min, const double &max, Array2D<double> &legend_array)
{
355
356
357
358
359
	if(has_legend) {
		legend leg(nrows, min, max);
		legend_array = leg.getLegend();
		unsigned int nx, ny;
		legend_array.size(nx,ny);
360
361
362
		return (ncols+nx);
	} else {
		return ncols;
363
	}
364
365
}

366
void PNGIO::writeDataSection(const Grid2DObject &grid, const Array2D<double> &legend_array, const Gradient &gradient, const unsigned int &full_width, const png_structp &png_ptr)
367
{
368
369
	const unsigned int ncols = grid.ncols;
	const unsigned int nrows = grid.nrows;
370

371
	// Allocate memory for one row (3 bytes per pixel - RGB)
372
373
374
375
	unsigned char channels;
	if(indexed_png)
		channels = 1;
	else
376
		channels = 3; //4 for rgba
377

378
379
380
381
	png_bytep row = (png_bytep)calloc(channels*sizeof(png_byte), full_width);
	if(row==NULL) {
		throw IOException("Can not allocate row memory in PNGIO!", AT);
	}
382
383

	// Write image data
384
	if(indexed_png) {
385
		for(int y=(signed)nrows-1 ; y>=0 ; y--) {
386
387
388
			unsigned int x=0;
			for(; x<ncols ; x++) {
				const unsigned int i=x*channels;
389
				unsigned char index;
390
				gradient.getColor(grid(x,y), index);
391
				row[i]=static_cast<png_byte>(index);
392
393
394
			}
			for(; x<full_width; x++) {
				const unsigned int i=x*channels;
395
				unsigned char index;
396
				gradient.getColor(legend_array(x-ncols,y), index);
397
				row[i]=static_cast<png_byte>(index);
398
			}
399
			png_write_row(png_ptr, row);
400
		}
401
	} else {
402
		for(int y=(signed)nrows-1 ; y>=0 ; y--) {
403
404
405
406
407
408
409
			unsigned int x=0;
			for(; x<ncols ; x++) {
				const unsigned int i=x*channels;
				unsigned char r,g,b;
				bool a;
				gradient.getColor(grid(x,y), r,g,b,a);
				if(a==true) {
410
					row[i]=static_cast<png_byte>(transparent_grey); row[i+1]=static_cast<png_byte>(transparent_grey); row[i+2]=static_cast<png_byte>(transparent_grey);
411
				} else {
412
					row[i]=static_cast<png_byte>(r); row[i+1]=static_cast<png_byte>(g); row[i+2]=static_cast<png_byte>(b);
413
414
415
416
417
418
419
420
				}
			}
			for(; x<full_width; x++) {
				const unsigned int i=x*channels;
				unsigned char r,g,b;
				bool a;
				gradient.getColor(legend_array(x-ncols,y), r,g,b,a);
				if(a==true) {
421
					row[i]=static_cast<png_byte>(transparent_grey); row[i+1]=static_cast<png_byte>(transparent_grey); row[i+2]=static_cast<png_byte>(transparent_grey);
422
				} else {
423
					row[i]=static_cast<png_byte>(r); row[i+1]=static_cast<png_byte>(g); row[i+2]=static_cast<png_byte>(b);
424
				}
425
			}
426
			png_write_row(png_ptr, row);
427
428
		}
	}
429

430
431
	png_write_flush(png_ptr);
	png_free(png_ptr, row);
432
433
}

434
void PNGIO::setPalette(const Gradient &gradient, png_structp& png_ptr, png_infop& info_ptr, png_color *palette)
435
{
436
437
438
	std::vector<unsigned char> pal;
	size_t nr_colors;
	gradient.getPalette(pal, nr_colors);
439
	palette = (png_color*)calloc(sizeof (png_color), nr_colors); //ie: three png_bytes, each being an unsigned char
440
	for(size_t ii=0; ii<nr_colors; ii++) {
441
442
443
444
		const size_t interlace = ii*3; //colors from Gradient interlaced
		palette[ii].red = static_cast<png_byte>(pal[interlace]);
		palette[ii].green = static_cast<png_byte>(pal[interlace+1]);
		palette[ii].blue = static_cast<png_byte>(pal[interlace+2]);
445
446
447
448
	}
	png_set_PLTE(png_ptr, info_ptr, palette, nr_colors);
}

449
void PNGIO::closePNG(png_structp& png_ptr, png_infop& info_ptr, png_color *palette)
450
{
451
	png_free_data(png_ptr, info_ptr, PNG_FREE_ALL, -1);
452
	if(indexed_png && palette!=NULL) free(palette);
453
	png_destroy_write_struct(&png_ptr, &info_ptr);
454
	fclose(fp);
455
456
	free(info_ptr);
	free(png_ptr);
457
458
}

459
void PNGIO::write2DGrid(const Grid2DObject& grid_in, const std::string& filename)
460
{
461
	string full_name = grid2dpath+"/"+filename;
462
	fp=NULL;
463
	png_color *palette=NULL;
464
465
466
467
468
	png_structp png_ptr=NULL;
	png_infop info_ptr=NULL;

	//scale input image
	const Grid2DObject grid = scaleGrid(grid_in);
469
	const unsigned int ncols = grid.ncols, nrows = grid.nrows;
470
471
	if(ncols==0 || nrows==0) return;

472
473
474
475
	const double min = grid.grid2D.getMin();
	const double max = grid.grid2D.getMax();

	Gradient gradient(Gradient::heat, min, max, autoscale);
476
	if(indexed_png) gradient.setNrOfLevels(nr_levels);
477
478
479
480

	Array2D<double> legend_array; //it will remain empty if there is no legend
	const unsigned int full_width = setLegend(ncols, nrows, min, max, legend_array);

481
	setFile(full_name, png_ptr, info_ptr, full_width, nrows);
482
	if(indexed_png) setPalette(gradient, png_ptr, info_ptr, palette);
483
	if(has_world_file) writeWorldFile(grid, full_name);
484
485
486
487
488
489
490
491

	createMetadata(grid);
	metadata_key.push_back("Title"); //adding generic title
	metadata_text.push_back("Unknown Gridded data");
	writeMetadata(png_ptr, info_ptr);

	writeDataSection(grid, legend_array, gradient, full_width, png_ptr);
	png_write_end(png_ptr, NULL);
492

493
	closePNG(png_ptr, info_ptr, palette);
494
495
}

496
void PNGIO::write2DGrid(const Grid2DObject& grid_in, const MeteoGrids::Parameters& parameter, const Date& date)
497
{
498
499
	std::string filename;
	if(parameter==MeteoGrids::DEM || parameter==MeteoGrids::SLOPE || parameter==MeteoGrids::AZI)
500
		filename = grid2dpath + "/" + MeteoGrids::getParameterName(parameter) + ".png";
501
502
503
504
505
	else {
		std::string date_str = date.toString(Date::ISO);
		std::replace( date_str.begin(), date_str.end(), ':', '.');
		filename = grid2dpath + "/" + date_str + "_" + MeteoGrids::getParameterName(parameter) + ".png";
	}
506

507
	fp=NULL;
508
	png_color *palette=NULL;
509
510
511
512
513
	png_structp png_ptr=NULL;
	png_infop info_ptr=NULL;

	//scale input image
	Grid2DObject grid = scaleGrid(grid_in);
514
	const unsigned int ncols = grid.ncols, nrows = grid.nrows;
515
516
	if(ncols==0 || nrows==0) return;

517
518
519
520
521
	double min = grid.grid2D.getMin();
	double max = grid.grid2D.getMax();

	Gradient gradient;
	if(parameter==MeteoGrids::DEM) {
522
523
		if(!autoscale) {
			min = 0.; //we want a 3000 snow line with a full scale legend
524
525
			max = 3500.;
			gradient.set(Gradient::terrain, min, max, autoscale); //max used as snow line reference
526
527
		} else
			gradient.set(Gradient::terrain, min, max, autoscale);
528
529
530
	} else if(parameter==MeteoGrids::SLOPE) {
		gradient.set(Gradient::slope, min, max, autoscale);
	} else if(parameter==MeteoGrids::AZI) {
531
532
533
534
		if(!autoscale) {
			min = 0.;
			max = 360.;
		}
535
		gradient.set(Gradient::azi, min, max, autoscale);
536
537
538
539
540
541
	} else if(parameter==MeteoGrids::DW) {
		if(!autoscale) {
			min = 0.;
			max = 360.;
		}
		gradient.set(Gradient::azi, min, max, autoscale);
542
	} else if(parameter==MeteoGrids::HS) {
543
		if(!autoscale) {
544
			min = 0.; max = 2.5;
545
546
		}
		gradient.set(Gradient::blue, min, max, autoscale);
547
548
	} else if(parameter==MeteoGrids::TA) {
		grid.grid2D -= Cst::t_water_freezing_pt; //convert to celsius
549
		if(!autoscale) {
550
			min = -15.; max = 15.;
551
552
553
554
		} else {
			min -= Cst::t_water_freezing_pt;
			max -= Cst::t_water_freezing_pt;
		}
555
		gradient.set(Gradient::heat, min, max, autoscale);
556
557
558
	} else if(parameter==MeteoGrids::TSS) {
		grid.grid2D -= Cst::t_water_freezing_pt; //convert to celsius
		if(!autoscale) {
559
			min = -20.; max = 5.;
560
561
562
563
564
		} else {
			min -= Cst::t_water_freezing_pt;
			max -= Cst::t_water_freezing_pt;
		}
		gradient.set(Gradient::freeze, min, max, autoscale);
565
	} else if(parameter==MeteoGrids::RH) {
566
567
568
		if(!autoscale) {
			min = 0.; max = 1.;
		}
569
		gradient.set(Gradient::bg_isomorphic, min, max, autoscale);
570
571
572
573
574
575
576
577
578
579
580
	} else if(parameter==MeteoGrids::P) {
		if(!autoscale) {
			//lowest and highest pressures ever recorded on Earth: 87000 and 108570
			min = 87000.; max = 115650.; //centered around 1 atm
			gradient.set(Gradient::bluewhitered, min, max, autoscale);
		} else {
			const double delta1 = fabs(Cst::std_press-min);
			const double delta2 = fabs(max - Cst::std_press);
			const double delta = (delta1>delta2)?delta1:delta2;
			gradient.set(Gradient::bluewhitered, Cst::std_press-delta, Cst::std_press+delta, autoscale);
		}
581
582
583
584
	} else if(parameter==MeteoGrids::ALB) {
		if(!autoscale) {
			min = 0.; max = 1.;
		}
585
		gradient.set(Gradient::blktowhite, min, max, autoscale);
586
587
	} else if(parameter==MeteoGrids::ISWR) {
		if(!autoscale) {
588
			min = 0.; max = 800.;
589
590
591
592
593
594
595
		}
		gradient.set(Gradient::heat, min, max, autoscale);
	} else if(parameter==MeteoGrids::ILWR) {
		if(!autoscale) {
			min = 200.; max = 500.;
		}
		gradient.set(Gradient::heat, min, max, autoscale);
596
	} else if(parameter==MeteoGrids::SWE) {
597
		if(!autoscale) {
598
			min = 0.; max = 250.;
599
		}
600
		gradient.set(Gradient::blue_pink, min, max, autoscale);
601
602
603
	} else {
		gradient.set(Gradient::heat, min, max, autoscale);
	}
604
	gradient.setNrOfLevels(nr_levels);
605
606

	Array2D<double> legend_array; //it will remain empty if there is no legend
607
	const unsigned int full_width = setLegend(ncols, nrows, min, max, legend_array);
608

609
	setFile(filename, png_ptr, info_ptr, full_width, nrows);
610
	if(indexed_png) setPalette(gradient, png_ptr, info_ptr, palette);
611
	if(has_world_file) writeWorldFile(grid, filename);
612
613
614
615

	createMetadata(grid);
	metadata_key.push_back("Title"); //adding title
	metadata_text.push_back( MeteoGrids::getParameterName(parameter)+" on "+date.toString(Date::ISO) );
616
617
	metadata_key.push_back("Simulation Date");
	metadata_text.push_back( date.toString(Date::ISO) );
618
619
	metadata_key.push_back("Simulation Parameter");
	metadata_text.push_back( MeteoGrids::getParameterName(parameter) );
620
621
622
623
	writeMetadata(png_ptr, info_ptr);

	writeDataSection(grid, legend_array, gradient, full_width, png_ptr);
	png_write_end(png_ptr, NULL);
624

625
	closePNG(png_ptr, info_ptr, palette);
626
627
628
629
630
631
632
633
}

void PNGIO::writeWorldFile(const Grid2DObject& grid_in, const std::string& filename)
{
	const string world_file = IOUtils::removeExtension(filename)+".pnw";
	const double cellsize = grid_in.cellsize;
	Coords world_ref=grid_in.llcorner;
	world_ref.setProj(coordout, coordoutparam);
634
	world_ref.moveByXY(.5*cellsize, (grid_in.nrows+.5)*cellsize); //moving to center of upper left cell
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654

	std::ofstream fout;
	fout.open(world_file.c_str());
	if (fout.fail()) {
		throw FileAccessException(world_file, AT);
	}

	try {
		fout << std::setprecision(12) << cellsize << "\n";
		fout << "0.000000000000\n";
		fout << "0.000000000000\n";
		fout << std::setprecision(12) << -cellsize << "\n";
		fout << std::setprecision(12) << world_ref.getEasting() << "\n";
		fout << std::setprecision(12) << world_ref.getNorthing() << "\n";
	} catch(...) {
		fout.close();
		throw FileAccessException("Failed when writing to PNG world file \""+world_file+"\"", AT);
	}

	fout.close();
655
656
}

657
void PNGIO::createMetadata(const Grid2DObject& grid)
658
{
659
660
661
662
	const double lat = grid.llcorner.getLat();
	const double lon = grid.llcorner.getLon();
	stringstream ss;

663
664
665
	metadata_key.clear();
	metadata_text.clear();

666
667
668
669
	metadata_key.push_back("Creation Time");
	Date cr_date;
	cr_date.setFromSys();
	metadata_text.push_back( cr_date.toString(Date::ISO) );
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
	metadata_key.push_back("Author");
	metadata_text.push_back(IOUtils::getLogName());
	metadata_key.push_back("Software");
	metadata_text.push_back("MeteoIO "+getLibVersion());
	metadata_key.push_back("Position");
	metadata_text.push_back("llcorner");
	metadata_key.push_back("Cellsize");
	ss.str(""); ss << fixed << setprecision(2) << grid.cellsize;
	metadata_text.push_back(ss.str());
	metadata_key.push_back("Latitude");
	ss.str(""); ss << fixed << setprecision(6) << lat;
	metadata_text.push_back(ss.str());
	metadata_key.push_back("Longitude");
	ss.str(""); ss << fixed << setprecision(6) << lon;
	metadata_text.push_back(ss.str());
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
	if(lat<0.) {
		metadata_key.push_back("LatitudeRef");
		metadata_text.push_back("S");
		metadata_key.push_back("GPSLatitude");
		metadata_text.push_back(decimal_to_dms(-lat));
	} else {
		metadata_key.push_back("LatitudeRef");
		metadata_text.push_back("N");
		metadata_key.push_back("GPSLatitude");
		metadata_text.push_back(decimal_to_dms(lat));
	}
	if(lon<0.) {
		metadata_key.push_back("LongitudeRef");
		metadata_text.push_back("W");
		metadata_key.push_back("GPSLongitude");
		metadata_text.push_back(decimal_to_dms(-lon));
	} else {
		metadata_key.push_back("LongitudeRef");
		metadata_text.push_back("E");
		metadata_key.push_back("GPSLongitude");
		metadata_text.push_back(decimal_to_dms(lon));
	}
}

void PNGIO::writeMetadata(png_structp &png_ptr, png_infop &info_ptr)
{
712
	const size_t max_len = 79; //according to the official specs' recommendation
713
714
715
716
	const size_t nr = metadata_key.size();
	png_text *info_text;
	info_text = (png_text *)calloc(sizeof(png_text), nr);
	char **key, **text;
717
718
	key = (char**)calloc(sizeof(char)*max_len, nr);
	text = (char**)calloc(sizeof(char)*max_len, nr);
719
720

	for(size_t ii=0; ii<nr; ii++) {
721
722
723
724
		key[ii] = (char *)calloc(sizeof(char), max_len);
		text[ii] = (char *)calloc(sizeof(char), max_len);
		strncpy(key[ii], metadata_key[ii].c_str(), max_len);
		strncpy(text[ii], metadata_text[ii].c_str(), max_len);
725
726
727
728
		info_text[ii].key = key[ii];
		info_text[ii].text = text[ii];
		info_text[ii].compression = PNG_TEXT_COMPRESSION_NONE;
	}
729

730
	png_set_text(png_ptr, info_ptr, info_text, nr);
731
732
	png_write_info(png_ptr, info_ptr);

733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
	free(info_text);
	for(size_t ii=0; ii<nr; ii++) {
		free(key[ii]);
		free(text[ii]);
	}
	free(key);
	free(text);
}

std::string PNGIO::decimal_to_dms(const double& decimal) {
	std::stringstream dms;
	const int d = static_cast<int>( floor(decimal) );
	const double m = floor( ((decimal - (double)d)*60.)*100. ) / 100.;
	const double s = 3600.*(decimal - (double)d) - 60.*m;

	dms << d << "/1 " << static_cast<int>(m*100) << "/100 " << fixed << setprecision(6) << s << "/1";
	return dms.str();
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
}

#ifndef _METEOIO_JNI
extern "C"
{
#define COMPILE_PLUGIN
#include "exports.h"

	METEOIO_EXPORT void deleteObject(void* obj) {
		delete reinterpret_cast<PluginObject*>(obj);
	}

	METEOIO_EXPORT void* loadObject(const string& classname, const Config& cfg) {
		if(classname == "PNGIO") {
			//cerr << "Creating dynamic handle for " << classname << endl;
			return new PNGIO(deleteObject, cfg);
		}
		//cerr << "Could not load " << classname << endl;
		return NULL;
	}
}
#endif

} //namespace