altosui: Add map preloading GUI
[fw/altos] / altosui / AltosSiteMap.java
1 /*
2  * Copyright © 2010 Anthony Towns <aj@erisian.com.au>
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation; version 2 of the License.
7  *
8  * This program is distributed in the hope that it will be useful, but
9  * WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
11  * General Public License for more details.
12  *
13  * You should have received a copy of the GNU General Public License along
14  * with this program; if not, write to the Free Software Foundation, Inc.,
15  * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
16  */
17
18 package altosui;
19
20 import java.awt.*;
21 import java.awt.image.*;
22 import java.awt.event.*;
23 import javax.swing.*;
24 import javax.swing.event.MouseInputAdapter;
25 import javax.imageio.ImageIO;
26 import javax.swing.table.*;
27 import java.io.*;
28 import java.util.*;
29 import java.text.*;
30 import java.util.prefs.*;
31 import java.lang.Math;
32 import java.awt.geom.Point2D;
33 import java.awt.geom.Line2D;
34
35 public class AltosSiteMap extends JScrollPane implements AltosFlightDisplay {
36         // preferred vertical step in a tile in naut. miles
37         // will actually choose a step size between x and 2x, where this
38         // is 1.5x
39         static final double tile_size_nmi = 0.75;
40
41         static final int px_size = 512;
42
43         static final int MAX_TILE_DELTA = 100;
44
45         private static Point2D.Double translatePoint(Point2D.Double p,
46                         Point2D.Double d)
47         {
48                 return new Point2D.Double(p.x + d.x, p.y + d.y);
49         }
50
51         static class LatLng {
52                 public double lat, lng;
53                 public LatLng(double lat, double lng) {
54                         this.lat = lat;
55                         this.lng = lng;
56                 }
57         }
58
59         // based on google js
60         //  http://maps.gstatic.com/intl/en_us/mapfiles/api-3/2/10/main.js
61         // search for fromLatLngToPoint and fromPointToLatLng
62         private static Point2D.Double pt(LatLng latlng, int zoom) {
63                 double scale_x = 256/360.0 * Math.pow(2, zoom);
64                 double scale_y = 256/(2.0*Math.PI) * Math.pow(2, zoom);
65                 return pt(latlng, scale_x, scale_y);
66         }
67
68         private static Point2D.Double pt(LatLng latlng,
69                                          double scale_x, double scale_y)
70         {
71                 Point2D.Double res = new Point2D.Double();
72                 double e;
73
74                 res.x = latlng.lng * scale_x;
75
76                 e = Math.sin(Math.toRadians(latlng.lat));
77                 e = Math.max(e,-(1-1.0E-15));
78                 e = Math.min(e,  1-1.0E-15 );
79
80                 res.y = 0.5*Math.log((1+e)/(1-e))*-scale_y;
81                 return res;
82         }
83
84         static private LatLng latlng(Point2D.Double pt,
85                                      double scale_x, double scale_y)
86         {
87                 double lat, lng;
88                 double rads;
89
90                 lng = pt.x/scale_x;
91                 rads = 2 * Math.atan(Math.exp(-pt.y/scale_y));
92                 lat = Math.toDegrees(rads - Math.PI/2);
93
94                 return new LatLng(lat,lng);
95         }
96
97         int zoom;
98         double scale_x, scale_y;
99
100         private Point2D.Double pt(double lat, double lng) {
101                 return pt(new LatLng(lat, lng), scale_x, scale_y);
102         }
103
104         private LatLng latlng(double x, double y) {
105                 return latlng(new Point2D.Double(x,y), scale_x, scale_y);
106         }
107         private LatLng latlng(Point2D.Double pt) {
108                 return latlng(pt, scale_x, scale_y);
109         }
110
111         HashMap<Point,AltosSiteMapTile> mapTiles = new HashMap<Point,AltosSiteMapTile>();
112         Point2D.Double centre;
113
114         private Point2D.Double tileCoordOffset(Point p) {
115                 return new Point2D.Double(centre.x - p.x*px_size,
116                                           centre.y - p.y * px_size);
117         }
118
119         private Point tileOffset(Point2D.Double p) {
120                 return new Point((int)Math.floor((centre.x+p.x)/px_size),
121                                  (int)Math.floor((centre.y+p.y)/px_size));
122         }
123
124         private Point2D.Double getBaseLocation(double lat, double lng) {
125                 Point2D.Double locn, north_step;
126
127                 zoom = 2;
128                 // stupid loop structure to please Java's control flow analysis
129                 do {
130                         zoom++;
131                         scale_x = 256/360.0 * Math.pow(2, zoom);
132                         scale_y = 256/(2.0*Math.PI) * Math.pow(2, zoom);
133                         locn = pt(lat, lng);
134                         north_step = pt(lat+tile_size_nmi*4/3/60.0, lng);
135                         if (locn.y - north_step.y > px_size)
136                                 break;
137                 } while (zoom < 22);
138                 locn.x = -px_size * Math.floor(locn.x/px_size);
139                 locn.y = -px_size * Math.floor(locn.y/px_size);
140                 return locn;
141         }
142
143         public void reset() {
144                 // nothing
145         }
146
147         private void bgLoadMap(final AltosSiteMapTile tile,
148                                final File pngfile, final String pngurl)
149         {
150                 //System.out.printf("Loading/fetching map %s\n", pngfile);
151                 Thread thread = new Thread() {
152                         public void run() {
153                                 final ImageIcon res = AltosSiteMapCache.fetchAndLoadMap(pngfile, pngurl);
154                                 if (res != null) {
155                                         SwingUtilities.invokeLater(new Runnable() {
156                                                         public void run() {
157                                                                 tile.loadMap(res);
158                                                         }
159                                                 });
160                                 } else {
161                                         System.out.printf("# Failed to fetch file %s\n", pngfile);
162                                         System.out.printf(" wget -O '%s' ''\n", pngfile, pngurl);
163                                 }
164                         }
165                 };
166                 thread.start();
167         }
168
169         File    pngfile;
170         String  pngurl;
171
172         public int prefetchMap(int x, int y) {
173                 LatLng map_latlng = latlng(
174                         -centre.x + x*px_size + px_size/2,
175                         -centre.y + y*px_size + px_size/2);
176                 pngfile = MapFile(map_latlng.lat, map_latlng.lng);
177                 pngurl = MapURL(map_latlng.lat, map_latlng.lng);
178                 if (pngfile.exists()) {
179                         return 1;
180                 } else if (AltosSiteMapCache.fetchMap(pngfile, pngurl)) {
181                         return 0;
182                 } else {
183                         return -1;
184                 }
185         }
186
187         public static void prefetchMaps(double lat, double lng, int w, int h) {
188                 AltosSiteMap asm = new AltosSiteMap(true);
189                 asm.centre = asm.getBaseLocation(lat, lng);
190
191                 Point2D.Double p = new Point2D.Double();
192                 Point2D.Double p2;
193                 int dx = -w/2, dy = -h/2;
194                 for (int y = dy; y < h+dy; y++) {
195                         for (int x = dx; x < w+dx; x++) {
196                                 int r = asm.prefetchMap(x, y);
197                                 switch (r) {
198                                 case 1:
199                                         System.out.printf("Already have %s\n", asm.pngfile);
200                                         break;
201                                 case 0:
202                                         System.out.printf("Fetched map %s\n", asm.pngfile);
203                                         break;
204                                 case -1:
205                                         System.out.printf("# Failed to fetch file %s\n", asm.pngfile);
206                                         System.out.printf(" wget -O '%s' ''\n", asm.pngfile, asm.pngurl);
207                                         break;
208                                 }
209                         }
210                 }
211         }
212
213         private void initMap(AltosSiteMapTile tile, Point offset) {
214                 Point2D.Double coord = tileCoordOffset(offset);
215
216                 LatLng map_latlng = latlng(px_size/2-coord.x, px_size/2-coord.y);
217
218                 File pngfile = MapFile(map_latlng.lat, map_latlng.lng);
219                 String pngurl = MapURL(map_latlng.lat, map_latlng.lng);
220                 bgLoadMap(tile, pngfile, pngurl);
221         }
222
223         private void initMaps(double lat, double lng) {
224                 centre = getBaseLocation(lat, lng);
225
226                 for (Point k : mapTiles.keySet()) {
227                         initMap(mapTiles.get(k), k);
228                 }
229         }
230
231         private File MapFile(double lat, double lng) {
232                 char chlat = lat < 0 ? 'S' : 'N';
233                 char chlng = lng < 0 ? 'W' : 'E';
234                 if (lat < 0) lat = -lat;
235                 if (lng < 0) lng = -lng;
236                 return new File(AltosPreferences.mapdir(),
237                                 String.format("map-%c%.6f,%c%.6f-%d.png",
238                                               chlat, lat, chlng, lng, zoom));
239         }
240
241         private String MapURL(double lat, double lng) {
242                 return String.format("http://maps.google.com/maps/api/staticmap?center=%.6f,%.6f&zoom=%d&size=%dx%d&sensor=false&maptype=hybrid&format=png32", lat, lng, zoom, px_size, px_size);
243         }
244
245         boolean initialised = false;
246         Point2D.Double last_pt = null;
247         int last_state = -1;
248
249         public void show(double lat, double lon) {
250                 initMaps(lat, lon);
251                 initialised = true;
252                 scrollRocketToVisible(pt(lat, lon));
253         }
254         public void show(final AltosState state, final int crc_errors) {
255                 // if insufficient gps data, nothing to update
256                 if (!state.gps.locked && state.gps.nsat < 4)
257                         return;
258
259                 if (!initialised) {
260                         if (state.pad_lat != 0 || state.pad_lon != 0) {
261                                 initMaps(state.pad_lat, state.pad_lon);
262                                 initialised = true;
263                         } else if (state.gps.lat != 0 || state.gps.lon != 0) {
264                                 initMaps(state.gps.lat, state.gps.lon);
265                                 initialised = true;
266                         } else {
267                                 return;
268                         }
269                 }
270
271                 final Point2D.Double pt = pt(state.gps.lat, state.gps.lon);
272                 if (last_pt == pt && last_state == state.state)
273                         return;
274
275                 if (last_pt == null) {
276                         last_pt = pt;
277                 }
278                 boolean in_any = false;
279                 for (Point offset : mapTiles.keySet()) {
280                         AltosSiteMapTile tile = mapTiles.get(offset);
281                         Point2D.Double ref, lref;
282                         ref = translatePoint(pt, tileCoordOffset(offset));
283                         lref = translatePoint(last_pt, tileCoordOffset(offset));
284                         tile.show(state, crc_errors, lref, ref);
285                         if (0 <= ref.x && ref.x < px_size)
286                                 if (0 <= ref.y && ref.y < px_size)
287                                         in_any = true;
288                 }
289
290                 Point offset = tileOffset(pt);
291                 if (!in_any) {
292                         Point2D.Double ref, lref;
293                         ref = translatePoint(pt, tileCoordOffset(offset));
294                         lref = translatePoint(last_pt, tileCoordOffset(offset));
295
296                         AltosSiteMapTile tile = createTile(offset);
297                         tile.show(state, crc_errors, lref, ref);
298                         initMap(tile, offset);
299                         finishTileLater(tile, offset);
300                 }
301
302                 scrollRocketToVisible(pt);
303
304                 if (offset != tileOffset(last_pt)) {
305                         ensureTilesAround(offset);
306                 }
307
308                 last_pt = pt;
309                 last_state = state.state;
310         }
311
312         private AltosSiteMapTile createTile(Point offset) {
313                 AltosSiteMapTile tile = new AltosSiteMapTile(px_size);
314                 mapTiles.put(offset, tile);
315                 return tile;
316         }
317         private void finishTileLater(final AltosSiteMapTile tile,
318                                      final Point offset)
319         {
320                 SwingUtilities.invokeLater( new Runnable() {
321                         public void run() {
322                                 addTileAt(tile, offset);
323                         }
324                 } );
325         }
326
327         private void ensureTilesAround(Point base_offset) {
328                 for (int x = -1; x <= 1; x++) {
329                         for (int y = -1; y <= 1; y++) {
330                                 Point offset = new Point(base_offset.x + x, base_offset.y + y);
331                                 if (mapTiles.containsKey(offset))
332                                         continue;
333                                 AltosSiteMapTile tile = createTile(offset);
334                                 initMap(tile, offset);
335                                 finishTileLater(tile, offset);
336                         }
337                 }
338         }
339
340         private Point topleft = new Point(0,0);
341         private void scrollRocketToVisible(Point2D.Double pt) {
342                 Rectangle r = comp.getVisibleRect();
343                 Point2D.Double copt = translatePoint(pt, tileCoordOffset(topleft));
344                 int dx = (int)copt.x - r.width/2 - r.x;
345                 int dy = (int)copt.y - r.height/2 - r.y;
346                 if (Math.abs(dx) > r.width/4 || Math.abs(dy) > r.height/4) {
347                         r.x += dx;
348                         r.y += dy;
349                         comp.scrollRectToVisible(r);
350                 }
351         }
352
353         private void addTileAt(AltosSiteMapTile tile, Point offset) {
354                 if (Math.abs(offset.x) >= MAX_TILE_DELTA ||
355                                 Math.abs(offset.y) >= MAX_TILE_DELTA)
356                 {
357                         System.out.printf("Rocket too far away from pad (tile %d,%d)\n",
358                                           offset.x, offset.y);
359                         return;
360                 }
361
362                 boolean review = false;
363                 Rectangle r = comp.getVisibleRect();
364                 if (offset.x < topleft.x) {
365                         r.x += (topleft.x - offset.x) * px_size;
366                         topleft.x = offset.x;
367                         review = true;
368                 }
369                 if (offset.y < topleft.y) {
370                         r.y += (topleft.y - offset.y) * px_size;
371                         topleft.y = offset.y;
372                         review = true;
373                 }
374                 GridBagConstraints c = new GridBagConstraints();
375                 c.anchor = GridBagConstraints.CENTER;
376                 c.fill = GridBagConstraints.BOTH;
377                 // put some space between the map tiles, debugging only
378                 // c.insets = new Insets(5, 5, 5, 5);
379
380                 c.gridx = offset.x + MAX_TILE_DELTA;
381                 c.gridy = offset.y + MAX_TILE_DELTA;
382                 layout.setConstraints(tile, c);
383
384                 comp.add(tile);
385                 if (review) {
386                         comp.scrollRectToVisible(r);
387                 }
388         }
389
390         private AltosSiteMap(boolean knowWhatYouAreDoing) {
391                 if (!knowWhatYouAreDoing) {
392                         throw new RuntimeException("Arggh.");
393                 }
394         }
395
396         JComponent comp = new JComponent() { };
397         private GridBagLayout layout = new GridBagLayout();
398
399         public AltosSiteMap() {
400                 GrabNDrag scroller = new GrabNDrag(comp);
401
402                 comp.setLayout(layout);
403
404                 for (int x = -1; x <= 1; x++) {
405                         for (int y = -1; y <= 1; y++) {
406                                 Point offset = new Point(x, y);
407                                 AltosSiteMapTile t = createTile(offset);
408                                 addTileAt(t, offset);
409                         }
410                 }
411                 setViewportView(comp);
412                 setPreferredSize(new Dimension(500,500));
413         }
414 }