]> git.street.me.uk Git - andy/viking.git/blobdiff - src/vikslippymapsource.c
Improve potential statusbar message of a selected trackpoint.
[andy/viking.git] / src / vikslippymapsource.c
index 1384de3792d32cdc073550bc9391adce900d8a09..54cffc8d36f2f81444fde076e4f12ebc319e2535 100644 (file)
 
 #include "globals.h"
 #include "vikslippymapsource.h"
+#include "maputils.h"
 
 static gboolean _coord_to_mapcoord ( VikMapSource *self, const VikCoord *src, gdouble xzoom, gdouble yzoom, MapCoord *dest );
 static void _mapcoord_to_center_coord ( VikMapSource *self, MapCoord *src, VikCoord *dest );
 
+static gboolean _is_direct_file_access (VikMapSource *self );
+static gboolean _is_mbtiles (VikMapSource *self );
+static gboolean _is_osm_meta_tiles (VikMapSource *self );
 static gboolean _supports_download_only_new (VikMapSource *self );
+static guint8 _get_zoom_min(VikMapSource *self );
+static guint8 _get_zoom_max(VikMapSource *self );
+static gdouble _get_lat_min(VikMapSource *self );
+static gdouble _get_lat_max(VikMapSource *self );
+static gdouble _get_lon_min(VikMapSource *self );
+static gdouble _get_lon_max(VikMapSource *self );
 
 static gchar *_get_uri( VikMapSourceDefault *self, MapCoord *src );
 static gchar *_get_hostname( VikMapSourceDefault *self );
@@ -67,6 +77,18 @@ struct _VikSlippyMapSourcePrivate
   gchar *hostname;
   gchar *url;
   DownloadMapOptions options;
+  // NB Probably best to keep the above fields in same order to be common across Slippy, TMS & WMS map definitions
+  guint zoom_min; // TMS Zoom level: 0 = Whole World // http://wiki.openstreetmap.org/wiki/Slippy_map_tilenames
+  guint zoom_max; // TMS Zoom level: Often 18 for zoomed in.
+  gdouble lat_min; // Degrees
+  gdouble lat_max; // Degrees
+  gdouble lon_min; // Degrees
+  gdouble lon_max; // Degrees
+  gboolean is_direct_file_access;
+  gboolean is_mbtiles;
+  gboolean is_osm_meta_tiles; // http://wiki.openstreetmap.org/wiki/Meta_tiles as used by tirex or renderd
+  // Mainly for ARCGIS Tile Server URL Layout // http://help.arcgis.com/EN/arcgisserver/10.0/apis/rest/tile.html
+  gboolean switch_xy;
 };
 
 #define VIK_SLIPPY_MAP_SOURCE_PRIVATE(o)  (G_TYPE_INSTANCE_GET_PRIVATE ((o), VIK_TYPE_SLIPPY_MAP_SOURCE, VikSlippyMapSourcePrivate))
@@ -78,10 +100,20 @@ enum
 
   PROP_HOSTNAME,
   PROP_URL,
+  PROP_ZOOM_MIN,
+  PROP_ZOOM_MAX,
+  PROP_LAT_MIN,
+  PROP_LAT_MAX,
+  PROP_LON_MIN,
+  PROP_LON_MAX,
   PROP_REFERER,
   PROP_FOLLOW_LOCATION,
   PROP_CHECK_FILE_SERVER_TIME,
   PROP_USE_ETAG,
+  PROP_IS_DIRECT_FILE_ACCESS,
+  PROP_IS_MBTILES,
+  PROP_IS_OSM_META_TILES,
+  PROP_SWITCH_XY,
 };
 
 G_DEFINE_TYPE (VikSlippyMapSource, vik_slippy_map_source, VIK_TYPE_MAP_SOURCE_DEFAULT);
@@ -94,10 +126,21 @@ vik_slippy_map_source_init (VikSlippyMapSource *self)
 
   priv->hostname = NULL;
   priv->url = NULL;
+  priv->zoom_min = 0;
+  priv->zoom_max = 18;
+  priv->lat_min = -90.0;
+  priv->lat_max = 90.0;
+  priv->lon_min = -180.0;
+  priv->lon_max = 180.0;
   priv->options.referer = NULL;
   priv->options.follow_location = 0;
   priv->options.check_file = a_check_map_file;
   priv->options.check_file_server_time = FALSE;
+  priv->options.use_etag = FALSE;
+  priv->is_direct_file_access = FALSE;
+  priv->is_mbtiles = FALSE;
+  priv->is_osm_meta_tiles = FALSE;
+  priv->switch_xy = FALSE;
 
   g_object_set (G_OBJECT (self),
                 "tilesize-x", 256,
@@ -143,6 +186,30 @@ vik_slippy_map_source_set_property (GObject      *object,
       priv->url = g_value_dup_string (value);
       break;
 
+    case PROP_ZOOM_MIN:
+      priv->zoom_min = g_value_get_uint (value);
+      break;
+
+    case PROP_ZOOM_MAX:
+      priv->zoom_max = g_value_get_uint (value);
+      break;
+
+    case PROP_LAT_MIN:
+      priv->lat_min = g_value_get_double (value);
+      break;
+
+    case PROP_LAT_MAX:
+      priv->lat_max = g_value_get_double (value);
+      break;
+
+    case PROP_LON_MIN:
+      priv->lon_min = g_value_get_double (value);
+      break;
+
+    case PROP_LON_MAX:
+      priv->lon_max = g_value_get_double (value);
+      break;
+
     case PROP_REFERER:
       g_free (priv->options.referer);
       priv->options.referer = g_value_dup_string (value);
@@ -160,6 +227,22 @@ vik_slippy_map_source_set_property (GObject      *object,
       priv->options.use_etag = g_value_get_boolean (value);
       break;
 
+    case PROP_IS_DIRECT_FILE_ACCESS:
+      priv->is_direct_file_access = g_value_get_boolean (value);
+      break;
+
+    case PROP_IS_MBTILES:
+      priv->is_mbtiles = g_value_get_boolean (value);
+      break;
+
+    case PROP_IS_OSM_META_TILES:
+      priv->is_osm_meta_tiles = g_value_get_boolean (value);
+      break;
+
+    case PROP_SWITCH_XY:
+      priv->switch_xy = g_value_get_boolean (value);
+      break;
+
     default:
       /* We don't have any other property... */
       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
@@ -186,6 +269,30 @@ vik_slippy_map_source_get_property (GObject    *object,
       g_value_set_string (value, priv->url);
       break;
 
+    case PROP_ZOOM_MIN:
+      g_value_set_uint (value, priv->zoom_min);
+      break;
+
+    case PROP_ZOOM_MAX:
+      g_value_set_uint (value, priv->zoom_max);
+      break;
+
+    case PROP_LON_MIN:
+      g_value_set_double (value, priv->lon_min);
+      break;
+
+    case PROP_LON_MAX:
+      g_value_set_double (value, priv->lon_max);
+      break;
+
+    case PROP_LAT_MIN:
+      g_value_set_double (value, priv->lat_min);
+      break;
+
+    case PROP_LAT_MAX:
+      g_value_set_double (value, priv->lat_max);
+      break;
+
     case PROP_REFERER:
       g_value_set_string (value, priv->options.referer);
       break;
@@ -202,6 +309,22 @@ vik_slippy_map_source_get_property (GObject    *object,
       g_value_set_boolean (value, priv->options.use_etag);
       break;
 
+    case PROP_IS_DIRECT_FILE_ACCESS:
+      g_value_set_boolean (value, priv->is_direct_file_access);
+      break;
+
+    case PROP_IS_MBTILES:
+      g_value_set_boolean (value, priv->is_mbtiles);
+      break;
+
+    case PROP_IS_OSM_META_TILES:
+      g_value_set_boolean (value, priv->is_osm_meta_tiles);
+      break;
+
+    case PROP_SWITCH_XY:
+      g_value_set_boolean (value, priv->switch_xy);
+      break;
+
     default:
       /* We don't have any other property... */
       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
@@ -213,7 +336,7 @@ static void
 vik_slippy_map_source_class_init (VikSlippyMapSourceClass *klass)
 {
        GObjectClass* object_class = G_OBJECT_CLASS (klass);
-       VikMapSourceClass* granparent_class = VIK_MAP_SOURCE_CLASS (klass);
+       VikMapSourceClass* grandparent_class = VIK_MAP_SOURCE_CLASS (klass);
        VikMapSourceDefaultClass* parent_class = VIK_MAP_SOURCE_DEFAULT_CLASS (klass);
        GParamSpec *pspec = NULL;
                
@@ -221,9 +344,18 @@ vik_slippy_map_source_class_init (VikSlippyMapSourceClass *klass)
     object_class->get_property = vik_slippy_map_source_get_property;
 
        /* Overiding methods */
-       granparent_class->coord_to_mapcoord =        _coord_to_mapcoord;
-       granparent_class->mapcoord_to_center_coord = _mapcoord_to_center_coord;
-       granparent_class->supports_download_only_new = _supports_download_only_new;
+       grandparent_class->coord_to_mapcoord =        _coord_to_mapcoord;
+       grandparent_class->mapcoord_to_center_coord = _mapcoord_to_center_coord;
+       grandparent_class->is_direct_file_access = _is_direct_file_access;
+       grandparent_class->is_mbtiles = _is_mbtiles;
+       grandparent_class->is_osm_meta_tiles = _is_osm_meta_tiles;
+       grandparent_class->supports_download_only_new = _supports_download_only_new;
+       grandparent_class->get_zoom_min = _get_zoom_min;
+       grandparent_class->get_zoom_max = _get_zoom_max;
+       grandparent_class->get_lat_min = _get_lat_min;
+       grandparent_class->get_lat_max = _get_lat_max;
+       grandparent_class->get_lon_min = _get_lon_min;
+       grandparent_class->get_lon_max = _get_lon_max;
 
        parent_class->get_uri = _get_uri;
        parent_class->get_hostname = _get_hostname;
@@ -233,16 +365,70 @@ vik_slippy_map_source_class_init (VikSlippyMapSourceClass *klass)
                                     "Hostname",
                                     "The hostname of the map server",
                                     "<no-set>" /* default value */,
-                                    G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE);
+                                    G_PARAM_READWRITE);
        g_object_class_install_property (object_class, PROP_HOSTNAME, pspec);
 
        pspec = g_param_spec_string ("url",
                                     "URL",
                                     "The template of the tiles' URL",
                                     "<no-set>" /* default value */,
-                                    G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE);
+                                    G_PARAM_READWRITE);
        g_object_class_install_property (object_class, PROP_URL, pspec);
 
+       pspec = g_param_spec_uint ("zoom-min",
+                                  "Minimum zoom",
+                                  "Minimum Zoom level supported by the map provider",
+                                  0,  // minimum value,
+                                  22, // maximum value
+                                  0, // default value
+                                  G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE);
+       g_object_class_install_property (object_class, PROP_ZOOM_MIN, pspec);
+
+       pspec = g_param_spec_uint ("zoom-max",
+                                  "Maximum zoom",
+                                  "Maximum Zoom level supported by the map provider",
+                                  0,  // minimum value,
+                                  22, // maximum value
+                                  18, // default value
+                                  G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE);
+       g_object_class_install_property (object_class, PROP_ZOOM_MAX, pspec);
+
+       pspec = g_param_spec_double ("lat-min",
+                                    "Minimum latitude",
+                                    "Minimum latitude in degrees supported by the map provider",
+                                    -90.0,  // minimum value
+                                    90.0, // maximum value
+                                    -90.0, // default value
+                                    G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE);
+       g_object_class_install_property (object_class, PROP_LAT_MIN, pspec);
+
+       pspec = g_param_spec_double ("lat-max",
+                                    "Maximum latitude",
+                                    "Maximum latitude in degrees supported by the map provider",
+                                    -90.0,  // minimum value
+                                    90.0, // maximum value
+                                    90.0, // default value
+                                    G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE);
+       g_object_class_install_property (object_class, PROP_LAT_MAX, pspec);
+
+       pspec = g_param_spec_double ("lon-min",
+                                    "Minimum longitude",
+                                    "Minimum longitude in degrees supported by the map provider",
+                                    -180.0,  // minimum value
+                                    180.0, // maximum value
+                                    -180.0, // default value
+                                    G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE);
+       g_object_class_install_property (object_class, PROP_LON_MIN, pspec);
+
+       pspec = g_param_spec_double ("lon-max",
+                                    "Maximum longitude",
+                                    "Maximum longitude in degrees supported by the map provider",
+                                    -180.0,  // minimum value
+                                    180.0, // maximum value
+                                    180.0, // default value
+                                    G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE);
+       g_object_class_install_property (object_class, PROP_LON_MAX, pspec);
+
        pspec = g_param_spec_string ("referer",
                                     "Referer",
                                     "The REFERER string to use in HTTP request",
@@ -273,40 +459,71 @@ vik_slippy_map_source_class_init (VikSlippyMapSourceClass *klass)
                                   G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE);
        g_object_class_install_property (object_class, PROP_USE_ETAG, pspec);
 
+       pspec = g_param_spec_boolean ("use-direct-file-access",
+                                     "Use direct file access",
+                                     "Use direct file access to OSM like tile images - no need for a webservice",
+                                  FALSE  /* default value */,
+                                  G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE);
+       g_object_class_install_property (object_class, PROP_IS_DIRECT_FILE_ACCESS, pspec);
+
+       pspec = g_param_spec_boolean ("is-mbtiles",
+                                     "Is an SQL MBTiles File",
+                                     "Use an SQL MBTiles File for the tileset - no need for a webservice",
+                                     FALSE  /* default value */,
+                                     G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE);
+       g_object_class_install_property (object_class, PROP_IS_MBTILES, pspec);
+
+       pspec = g_param_spec_boolean ("is-osm-meta-tiles",
+                                     "Is in OSM Meta Tile format",
+                                     "Read from OSM Meta Tiles - Should be 'use-direct-file-access' as well",
+                                     FALSE  /* default value */,
+                                     G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE);
+       g_object_class_install_property (object_class, PROP_IS_OSM_META_TILES, pspec);
+
+       pspec = g_param_spec_boolean ("switch-xy",
+                                     "Switch the order of x,y components in the URL",
+                                     "Switch the order of x,y components in the URL (such as used by ARCGIS Tile Server",
+                                     FALSE  /* default value */,
+                                     G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE);
+       g_object_class_install_property (object_class, PROP_SWITCH_XY, pspec);
+
        g_type_class_add_private (klass, sizeof (VikSlippyMapSourcePrivate));
        
        object_class->finalize = vik_slippy_map_source_finalize;
 }
 
-/* 1 << (x) is like a 2**(x) */
-#define GZ(x) ((1<<(x)))
+static gboolean
+_is_direct_file_access (VikMapSource *self)
+{
+  g_return_val_if_fail (VIK_IS_SLIPPY_MAP_SOURCE(self), FALSE);
 
-static const gdouble scale_mpps[] = { GZ(0), GZ(1), GZ(2), GZ(3), GZ(4), GZ(5), GZ(6), GZ(7), GZ(8), GZ(9),
-                                           GZ(10), GZ(11), GZ(12), GZ(13), GZ(14), GZ(15), GZ(16), GZ(17) };
+  VikSlippyMapSourcePrivate *priv = VIK_SLIPPY_MAP_SOURCE_PRIVATE(self);
 
-static const gint num_scales = (sizeof(scale_mpps) / sizeof(scale_mpps[0]));
+  return priv->is_direct_file_access;
+}
 
-static const gdouble scale_neg_mpps[] = { 1.0/GZ(0), 1.0/GZ(1), 1.0/GZ(2), 1.0/GZ(3) };
-static const gint num_scales_neg = (sizeof(scale_neg_mpps) / sizeof(scale_neg_mpps[0]));
+static gboolean
+_is_mbtiles (VikMapSource *self)
+{
+  g_return_val_if_fail (VIK_IS_SLIPPY_MAP_SOURCE(self), FALSE);
 
-#define ERROR_MARGIN 0.01
-static gint slippy_zoom ( gdouble mpp ) {
-  gint i;
-  for ( i = 0; i < num_scales; i++ ) {
-    if ( ABS(scale_mpps[i] - mpp) < ERROR_MARGIN ) {
-      return i;
-    }
-  }
-  for ( i = 0; i < num_scales_neg; i++ ) {
-    if ( ABS(scale_neg_mpps[i] - mpp) < 0.000001 ) {
-      return -i;
-    }
-  }
+  VikSlippyMapSourcePrivate *priv = VIK_SLIPPY_MAP_SOURCE_PRIVATE(self);
+
+  return priv->is_mbtiles;
+}
 
-  return 255;
+/**
+ *
+ */
+static gboolean
+_is_osm_meta_tiles (VikMapSource *self)
+{
+  g_return_val_if_fail (VIK_IS_SLIPPY_MAP_SOURCE(self), FALSE);
+  VikSlippyMapSourcePrivate *priv = VIK_SLIPPY_MAP_SOURCE_PRIVATE(self);
+  return priv->is_osm_meta_tiles;
 }
 
-gboolean
+static gboolean
 _supports_download_only_new (VikMapSource *self)
 {
   g_return_val_if_fail (VIK_IS_SLIPPY_MAP_SOURCE(self), FALSE);
@@ -316,6 +533,72 @@ _supports_download_only_new (VikMapSource *self)
   return priv->options.check_file_server_time || priv->options.use_etag;
 }
 
+/**
+ *
+ */
+static guint8
+_get_zoom_min (VikMapSource *self)
+{
+  g_return_val_if_fail (VIK_IS_SLIPPY_MAP_SOURCE(self), FALSE);
+  VikSlippyMapSourcePrivate *priv = VIK_SLIPPY_MAP_SOURCE_PRIVATE(self);
+  return priv->zoom_min;
+}
+
+/**
+ *
+ */
+static guint8
+_get_zoom_max (VikMapSource *self)
+{
+  g_return_val_if_fail (VIK_IS_SLIPPY_MAP_SOURCE(self), FALSE);
+  VikSlippyMapSourcePrivate *priv = VIK_SLIPPY_MAP_SOURCE_PRIVATE(self);
+  return priv->zoom_max;
+}
+
+/**
+ *
+ */
+static gdouble
+_get_lat_min (VikMapSource *self)
+{
+  g_return_val_if_fail (VIK_IS_SLIPPY_MAP_SOURCE(self), FALSE);
+  VikSlippyMapSourcePrivate *priv = VIK_SLIPPY_MAP_SOURCE_PRIVATE(self);
+  return priv->lat_min;
+}
+
+/**
+ *
+ */
+static gdouble
+_get_lat_max (VikMapSource *self)
+{
+  g_return_val_if_fail (VIK_IS_SLIPPY_MAP_SOURCE(self), FALSE);
+  VikSlippyMapSourcePrivate *priv = VIK_SLIPPY_MAP_SOURCE_PRIVATE(self);
+  return priv->lat_max;
+}
+
+/**
+ *
+ */
+static gdouble
+_get_lon_min (VikMapSource *self)
+{
+  g_return_val_if_fail (VIK_IS_SLIPPY_MAP_SOURCE(self), FALSE);
+  VikSlippyMapSourcePrivate *priv = VIK_SLIPPY_MAP_SOURCE_PRIVATE(self);
+  return priv->lon_min;
+}
+
+/**
+ *
+ */
+static gdouble
+_get_lon_max (VikMapSource *self)
+{
+  g_return_val_if_fail (VIK_IS_SLIPPY_MAP_SOURCE(self), FALSE);
+  VikSlippyMapSourcePrivate *priv = VIK_SLIPPY_MAP_SOURCE_PRIVATE(self);
+  return priv->lon_max;
+}
+
 static gboolean
 _coord_to_mapcoord ( VikMapSource *self, const VikCoord *src, gdouble xzoom, gdouble yzoom, MapCoord *dest )
 {
@@ -324,12 +607,12 @@ _coord_to_mapcoord ( VikMapSource *self, const VikCoord *src, gdouble xzoom, gdo
   if ( xzoom != yzoom )
     return FALSE;
 
-  dest->scale = slippy_zoom ( xzoom );
+  dest->scale = map_utils_mpp_to_scale ( xzoom );
   if ( dest->scale == 255 )
     return FALSE;
 
-  dest->x = (src->east_west + 180) / 360 * GZ(17) / xzoom;
-  dest->y = (180 - MERCLAT(src->north_south)) / 360 * GZ(17) / xzoom;
+  dest->x = (src->east_west + 180) / 360 * VIK_GZ(17) / xzoom;
+  dest->y = (180 - MERCLAT(src->north_south)) / 360 * VIK_GZ(17) / xzoom;
   dest->z = 0;
 
   return TRUE;
@@ -340,12 +623,12 @@ _mapcoord_to_center_coord ( VikMapSource *self, MapCoord *src, VikCoord *dest )
 {
   gdouble socalled_mpp;
   if (src->scale >= 0)
-    socalled_mpp = GZ(src->scale);
+    socalled_mpp = VIK_GZ(src->scale);
   else
-    socalled_mpp = 1.0/GZ(-src->scale);
+    socalled_mpp = 1.0/VIK_GZ(-src->scale);
   dest->mode = VIK_COORD_LATLON;
-  dest->east_west = ((src->x+0.5) / GZ(17) * socalled_mpp * 360) - 180;
-  dest->north_south = DEMERCLAT(180 - ((src->y+0.5) / GZ(17) * socalled_mpp * 360));
+  dest->east_west = ((src->x+0.5) / VIK_GZ(17) * socalled_mpp * 360) - 180;
+  dest->north_south = DEMERCLAT(180 - ((src->y+0.5) / VIK_GZ(17) * socalled_mpp * 360));
 }
 
 static gchar *
@@ -353,8 +636,16 @@ _get_uri( VikMapSourceDefault *self, MapCoord *src )
 {
        g_return_val_if_fail (VIK_IS_SLIPPY_MAP_SOURCE(self), NULL);
        
-    VikSlippyMapSourcePrivate *priv = VIK_SLIPPY_MAP_SOURCE_PRIVATE(self);
-       gchar *uri = g_strdup_printf (priv->url, 17 - src->scale, src->x, src->y);
+       VikSlippyMapSourcePrivate *priv = VIK_SLIPPY_MAP_SOURCE_PRIVATE(self);
+
+       gchar *uri = NULL;
+       if ( priv->switch_xy )
+               // 'ARC GIS' Tile Server layout ordering
+               uri = g_strdup_printf (priv->url, 17 - src->scale, src->y, src->x);
+       else
+               // (Default) Standard OSM Tile Server layout ordering
+               uri = g_strdup_printf (priv->url, 17 - src->scale, src->x, src->y);
+
        return uri;
 } 
 
@@ -377,7 +668,7 @@ _get_download_options( VikMapSourceDefault *self )
 }
 
 VikSlippyMapSource *
-vik_slippy_map_source_new_with_id (guint8 id, const gchar *label, const gchar *hostname, const gchar *url)
+vik_slippy_map_source_new_with_id (guint16 id, const gchar *label, const gchar *hostname, const gchar *url)
 {
        return g_object_new(VIK_TYPE_SLIPPY_MAP_SOURCE,
                            "id", id, "label", label, "hostname", hostname, "url", url, NULL);