/* Copyright (C) 2001, 2007 United States Government as represented by
the Administrator of the National Aeronautics and Space Administration.
All Rights Reserved.
*/
package gov.nasa.worldwind.layers.rpf;
import gov.nasa.worldwind.avlist.*;
import gov.nasa.worldwind.formats.rpf.*;
import gov.nasa.worldwind.formats.wvt.*;
import gov.nasa.worldwind.geom.*;
import gov.nasa.worldwind.util.*;
import java.awt.*;
import java.awt.geom.*;
import java.awt.image.*;
import java.io.*;
import java.net.*;
import java.util.*;
/**
* @author brownrigg
* @version $Id: RPFGenerator.java 5103 2008-04-21 05:41:15Z tgaskins $
*/
class RPFGenerator
{
@SuppressWarnings({"FieldCanBeLocal"})
private final RPFFileIndex fileIndex;
private final FrameFile[] frameFiles;
private final Sector globalBounds;
private final AbsentResourceList absentFrames;
// Wavelet parameters.
private final int smallImageSize;
private final int preloadRes;
// Configuration property keys.
public static final String RPF_FILE_INDEX = "RPFGenerator.RPFFileIndex";
public static final String WAVELET_IMAGE_THRESHOLD = "RPFGenerator.WaveletImageThreshold";
public static final String WAVELET_PRELOAD_SIZE = "RPFGenerator.WaveletPreloadSize";
public RPFGenerator(AVList params)
{
if (params == null)
{
String message = Logging.getMessage("nullValue.AVListIsNull");
Logging.logger().severe(message);
throw new IllegalArgumentException(message);
}
params = initParams(params.copy());
this.fileIndex = (RPFFileIndex) params.getValue(RPF_FILE_INDEX);
this.frameFiles = loadFrameFiles(this.fileIndex);
this.globalBounds = computeGlobalBounds(this.fileIndex);
this.absentFrames = new AbsentResourceList(-1, -1);
this.smallImageSize = (Integer) params.getValue(WAVELET_IMAGE_THRESHOLD);
this.preloadRes = (Integer) params.getValue(WAVELET_PRELOAD_SIZE);
}
private static AVList initParams(AVList params)
{
if (params == null)
{
String message = Logging.getMessage("nullValue.AVListIsNull");
Logging.logger().severe(message);
throw new IllegalArgumentException(message);
}
if (params.getValue(RPF_FILE_INDEX) == null)
{
String message = "RPFFileIndex is null";
Logging.logger().severe(message);
throw new IllegalArgumentException(message);
}
Object o = params.getValue(WAVELET_IMAGE_THRESHOLD);
if (o == null || !(o instanceof Integer))
params.setValue(WAVELET_IMAGE_THRESHOLD, 256);
o = params.getValue(WAVELET_PRELOAD_SIZE);
if (o == null || !(o instanceof Integer) || !WWMath.isPowerOfTwo((Integer) o))
params.setValue(WAVELET_PRELOAD_SIZE, 32);
return params;
}
public Sector getGlobalBounds()
{
return this.globalBounds;
}
public RPFServiceInstance getServiceInstance()
{
return new RPFServiceInstance();
}
private FrameFile[] loadFrameFiles(RPFFileIndex fileIndex)
{
Collection<FrameFile> list = new ArrayList<FrameFile>();
long frameId = -1;
RPFFileIndex.Table fileTable = fileIndex.getRPFFileTable();
if (fileTable != null)
{
for (RPFFileIndex.Record record : fileTable.getRecords())
{
++frameId;
RPFFileIndex.RPFFileRecord rpfRecord = (RPFFileIndex.RPFFileRecord) record;
long rpfKey = record.getKey();
long waveletKey = rpfRecord.getWaveletSecondaryKey();
Sector sector = rpfRecord.getSector();
if (rpfKey != -1 && waveletKey != -1 && sector != null)
{
File rpfFile = fileIndex.getRPFFile(rpfKey);
File waveletFile = fileIndex.getWaveletFile(waveletKey);
list.add(new FrameFile(frameId, rpfFile, waveletFile, sector));
}
else
{
String message = "Ignoring frame file: " + (rpfKey != -1 ? fileIndex.getRPFFile(rpfKey).getPath() : "?");
Logging.logger().fine(message);
}
}
}
FrameFile[] array = new FrameFile[list.size()];
list.toArray(array);
return array;
}
//
// Find the global bounds for this collection of frame files (i.e., the union of their Sectors).
//
private Sector computeGlobalBounds(RPFFileIndex fileIndex)
{
Sector gb = null;
if (fileIndex != null && fileIndex.getIndexProperties() != null)
gb = fileIndex.getIndexProperties().getBoundingSector();
if (gb == null)
gb = Sector.EMPTY_SECTOR;
return gb;
}
// -----------------------------------------------
// class FrameFile
//
// A small private class to bundle info about framefiles.
// Public access to fields is intentional.
//
private static class FrameFile
{
public long id;
public File rpfFile;
public File waveletFile;
public Sector sector;
public WaveletCodec codec;
public FrameFile(long id, File rpfFile, File waveletFile, Sector sector)
{
this.id = id;
this.rpfFile = rpfFile;
this.waveletFile = waveletFile;
this.sector = sector;
}
}
// --------------------------------------------
// class ServiceInstance
//
// Used to manage per-request state.
//
public class RPFServiceInstance
{
public static final String BBOX = "bbox";
public static final String WIDTH = "width";
public static final String HEIGHT = "height";
public RPFServiceInstance()
{}
public BufferedImage serviceRequest(AVList params) throws IOException
{
if (params == null)
{
String message = Logging.getMessage("nullValue.AVListIsNull");
Logging.logger().severe(message);
throw new IllegalArgumentException(message);
}
String message = this.validate(params);
if (message != null)
{
Logging.logger().severe(message);
throw new IllegalArgumentException(message);
}
try
{
Sector reqSector = (Sector) params.getValue(BBOX);
int reqWidth = (Integer) params.getValue(WIDTH);
int reqHeight = (Integer) params.getValue(HEIGHT);
BufferedImage reqImage = new BufferedImage(reqWidth, reqHeight, BufferedImage.TYPE_4BYTE_ABGR);
Graphics2D g2d = (Graphics2D) reqImage.getGraphics();
int numFramesInRequest = 0;
for (FrameFile frame : RPFGenerator.this.frameFiles)
{
try
{
// The call to getSector() can throw an exception if the file is
// named with an inappropriate frameNumber for the dataseries/zone.
// We don't want these to short circuit the entire request, so
// trap any such occurances and ignore 'em.
if (!reqSector.intersects(frame.sector))
continue;
}
catch (Exception e)
{
/* ignore this framefile */
String msg = String.format("Exception while computing frame bounds: %s", frame.rpfFile);
Logging.logger().log(java.util.logging.Level.SEVERE, msg, e);
markFrameFileAbsent(frame);
continue;
}
if (RPFGenerator.this.isFrameFileAbsent(frame))
continue;
Sector frameSector = frame.sector;
// find size of the frame's footprint at the requested image resolution...
int footprintX = (int) (frameSector.getDeltaLonDegrees() * reqImage.getWidth() / reqSector.getDeltaLonDegrees());
int footprintY = (int) (frameSector.getDeltaLatDegrees() * reqImage.getHeight() / reqSector.getDeltaLatDegrees());
// Depending upon footprint, either get image from it RPF framefile, or reconstruct
// it from a wavelet encoding.
BufferedImage sourceImage;
if (footprintX > smallImageSize || footprintY > smallImageSize)
{
sourceImage = getImageFromRPFSource(frame);
}
else
{
int maxRes = footprintX;
maxRes = (footprintY > maxRes) ? footprintY : maxRes;
int power = (int) Math.ceil(Math.log(maxRes) / Math.log(2.));
int res = (int) Math.pow(2., power);
res = Math.max(1, res);
sourceImage = getImageFromWaveletEncoding(frame, res);
}
if (sourceImage == null) // failed to get an image...ignore this FrameFile
continue;
// Frame overlaps request; attempt to draw it...
++numFramesInRequest;
double tx = (frameSector.getMinLongitude().degrees - reqSector.getMinLongitude().degrees) * (reqImage.getWidth() / reqSector.getDeltaLonDegrees());
double ty = (reqSector.getMaxLatitude().degrees - frameSector.getMaxLatitude().degrees) * (reqImage.getHeight() / reqSector.getDeltaLatDegrees());
double sx = (reqImage.getWidth() / reqSector.getDeltaLonDegrees()) * (frameSector.getDeltaLonDegrees() / sourceImage.getWidth());
double sy = (reqImage.getHeight() / reqSector.getDeltaLatDegrees()) * (frameSector.getDeltaLatDegrees() / sourceImage.getHeight());
AffineTransform xform = g2d.getTransform();
g2d.translate(tx, ty);
g2d.scale(sx, sy);
g2d.drawRenderedImage(sourceImage, null);
g2d.setTransform(xform);
}
if (numFramesInRequest <= 0)
return null;
return reqImage;
}
catch (Exception e)
{
String msg = "Exception while processing request";
Logging.logger().log(java.util.logging.Level.SEVERE, msg, e);
throw new IOException(msg);
}
}
public BufferedImage serviceRequest(URL url) throws IOException
{
if (url == null)
{
String message = Logging.getMessage("nullValue.URLIsNull");
Logging.logger().severe(message);
throw new IllegalArgumentException(message);
}
AVList params = new AVListImpl();
// Extract query parameters from the URL, placing them in the AVList.
String query = url.getQuery();
if (query != null)
{
String[] pairs = query.split("&");
for (String s : pairs)
{
String[] keyvalue = s.split("=", 2);
if (keyvalue != null && keyvalue.length == 2)
params.setValue(keyvalue[0], keyvalue[1]);
}
}
// Convert parameter values to the appropriate type.
initParams(params);
return serviceRequest(params);
}
/**
* Determines whether the constructor arguments are valid.
*
* @param params the list of parameters to validate.
* @return null if valid, otherwise a <code>String</code> containing a description of why it's invalid.
*/
private String validate(AVList params)
{
StringBuffer sb = new StringBuffer();
Object o = params.getValue(BBOX);
if (o == null || !(o instanceof Sector))
sb.append("bounding box");
o = params.getValue(WIDTH);
if (o == null || !(o instanceof Integer) || ((Integer) o) < 1)
sb.append("width");
o = params.getValue(HEIGHT);
if (o == null || !(o instanceof Integer) || ((Integer) o) < 1)
sb.append("height");
if (sb.length() == 0)
return null;
return "Inavlid RPFGenerator service request fields: " + sb.toString();
}
private AVList initParams(AVList params)
{
String s = params.getStringValue(BBOX);
if (s != null)
{
String[] values = s.split(",");
if (values != null && values.length == 4)
{
try
{
// Bounding box string is expected in WMS format: "minlon,minlat,maxlon,maxlat"
double minLon = Double.parseDouble(values[0]);
double minLat = Double.parseDouble(values[1]);
double maxLon = Double.parseDouble(values[2]);
double maxLat = Double.parseDouble(values[3]);
params.setValue(BBOX, Sector.fromDegrees(minLat, maxLat, minLon, maxLon));
}
catch (NumberFormatException e)
{
Logging.logger().log(java.util.logging.Level.WARNING, "Parameter conversion error", e);
params.setValue(BBOX, null);
}
}
}
s = params.getStringValue(WIDTH);
if (s != null)
{
try
{
int value = Integer.parseInt(s);
params.setValue(WIDTH, value);
}
catch (NumberFormatException e)
{
Logging.logger().log(java.util.logging.Level.WARNING, "Parameter conversion error", e);
params.setValue(WIDTH, null);
}
}
s = params.getStringValue(HEIGHT);
if (s != null)
{
try
{
int value = Integer.parseInt(s);
params.setValue(HEIGHT, value);
}
catch (NumberFormatException e)
{
Logging.logger().log(java.util.logging.Level.WARNING, "Parameter conversion error", e);
params.setValue(HEIGHT, null);
}
}
return params;
}
//
// Attempts to return the specified FrameFile as a BufferedImage. Returns null on failure.
//
private BufferedImage getImageFromRPFSource(FrameFile frame)
{
try
{
File file = frame.rpfFile;
RPFImageFile sourceFile = RPFImageFile.load(file);
return sourceFile.getBufferedImage();
}
catch (Exception e)
{
String message = "Exception while reading frame file: " + frame.rpfFile;
Logging.logger().log(java.util.logging.Level.SEVERE, message, e);
RPFGenerator.this.markFrameFileAbsent(frame);
return null;
}
}
//
// Attempts to reconstruct the given FrameFile as a BufferedImage from a WaveletEncoding.
// Returns null if encoding does not exist or on any other failure.
//
private BufferedImage getImageFromWaveletEncoding(FrameFile frame, int resolution)
{
if (resolution <= 0)
return null;
try
{
WaveletCodec codec;
if (resolution <= RPFGenerator.this.preloadRes)
{
// Lazily load the wavelet up to "preload resolution".
if (frame.codec == null)
{
java.nio.ByteBuffer buffer = WWIO.readFileToBuffer(frame.waveletFile);
frame.codec = WaveletCodec.loadPartial(buffer, RPFGenerator.this.preloadRes);
}
codec = frame.codec;
}
else
{
// Read wavelet file.
java.nio.ByteBuffer buffer = WWIO.readFileToBuffer(frame.waveletFile);
codec = WaveletCodec.loadPartial(buffer, resolution);
}
BufferedImage sourceImage = null;
if (codec != null)
sourceImage = codec.reconstruct(resolution);
return sourceImage;
}
catch (Exception e)
{
String message = "Exception while reading wavelet file: " + frame.waveletFile;
Logging.logger().log(java.util.logging.Level.SEVERE, message, e);
RPFGenerator.this.markFrameFileAbsent(frame);
return null;
}
}
}
private void markFrameFileAbsent(FrameFile frame)
{
this.absentFrames.markResourceAbsent(frame.id);
}
private boolean isFrameFileAbsent(FrameFile frame)
{
return this.absentFrames.isResourceAbsent(frame.id);
}
@SuppressWarnings({"UnusedDeclaration"})
private void unmarkFrameFileAbsent(FrameFile frame)
{
this.absentFrames.unmarkResourceAbsent(frame.id);
}
}