]> git.street.me.uk Git - andy/viking.git/blobdiff - src/mapcache.c
Save bfilter values used for subsequent reuse in a session.
[andy/viking.git] / src / mapcache.c
index 3e5b077cd6b844c6195deb3c9938a38655c6a4b3..585649b98fa8141a10f4189816190fd886a485ce 100644 (file)
@@ -47,6 +47,11 @@ static guint32 max_cache_size = VIK_CONFIG_MAPCACHE_SIZE * 1024 * 1024;
 
 static GHashTable *cache = NULL;
 
+typedef struct {
+  GdkPixbuf *pixbuf;
+  mapcache_extra_t extra;
+} cache_item_t;
+
 static GMutex *mc_mutex = NULL;
 
 #define HASHKEY_FORMAT_STRING "%d-%d-%d-%d-%d-%d-%d-%.3f-%.3f"
@@ -62,6 +67,12 @@ static VikLayerParam prefs[] = {
   { VIK_LAYER_NUM_TYPES, VIKING_PREFERENCES_NAMESPACE "mapcache_size", VIK_LAYER_PARAM_UINT, VIK_LAYER_GROUP_NONE, N_("Map cache memory size (MB):"), VIK_LAYER_WIDGET_HSCALE, params_scales, NULL, NULL, NULL, NULL, NULL },
 };
 
+static void cache_item_free (cache_item_t *ci)
+{
+  g_object_unref ( ci->pixbuf );
+  g_free ( ci );
+}
+
 void a_mapcache_init ()
 {
   VikLayerParamData tmp;
@@ -69,29 +80,34 @@ void a_mapcache_init ()
   a_preferences_register(prefs, tmp, VIKING_PREFERENCES_GROUP_KEY);
 
   mc_mutex = vik_mutex_new ();
-  cache = g_hash_table_new_full ( g_str_hash, g_str_equal, g_free, g_object_unref );
+  cache = g_hash_table_new_full ( g_str_hash, g_str_equal, g_free, (GDestroyNotify) cache_item_free );
 }
 
-static void cache_add(gchar *key, GdkPixbuf *pixbuf)
+static void cache_add(gchar *key, GdkPixbuf *pixbuf, mapcache_extra_t extra)
 {
+  cache_item_t *ci = g_malloc ( sizeof(cache_item_t) );
+  ci->pixbuf = pixbuf;
+  ci->extra = extra;
 #if !GLIB_CHECK_VERSION(2,26,0)
   // Only later versions of GLib actually return a value for this function
   // Annoyingly the documentation doesn't say anything about this interface change :(
-  if ( g_hash_table_insert ( cache, key, pixbuf ) )
+  if ( g_hash_table_insert ( cache, key, ci ) )
 #else
-  g_hash_table_insert ( cache, key, pixbuf );
+  g_hash_table_insert ( cache, key, ci );
 #endif
   {
     cache_size += gdk_pixbuf_get_rowstride(pixbuf) * gdk_pixbuf_get_height(pixbuf);
+    // ATM size of 'extra' data hardly worth trying to count (compared to pixbuf sizes)
+    // Not sure what this 100 represents anyway - probably a guess at an average pixbuf metadata size
     cache_size += 100;
   }
 }
 
 static void cache_remove(const gchar *key)
 {
-  GdkPixbuf *buf = g_hash_table_lookup ( cache, key );
-  if (buf) {
-    cache_size -= gdk_pixbuf_get_rowstride(buf) * gdk_pixbuf_get_height(buf);
+  cache_item_t *ci = g_hash_table_lookup ( cache, key );
+  if (ci && ci->pixbuf) {
+    cache_size -= gdk_pixbuf_get_rowstride(ci->pixbuf) * gdk_pixbuf_get_height(ci->pixbuf);
     cache_size -= 100;
     g_hash_table_remove ( cache, key );
   }
@@ -132,13 +148,23 @@ static void list_add_entry ( gchar *key )
   queue_count++;
 }
 
-void a_mapcache_add ( GdkPixbuf *pixbuf, gint x, gint y, gint z, guint16 type, gint zoom, guint8 alpha, gdouble xshrinkfactor, gdouble yshrinkfactor, const gchar* name )
+/**
+ * Function increments reference counter of pixbuf.
+ * Caller may (and should) decrease it's reference.
+ */
+void a_mapcache_add ( GdkPixbuf *pixbuf, mapcache_extra_t extra, gint x, gint y, gint z, guint16 type, gint zoom, guint8 alpha, gdouble xshrinkfactor, gdouble yshrinkfactor, const gchar* name )
 {
+  if ( ! GDK_IS_PIXBUF(pixbuf) ) {
+    g_debug ( "Not caching corrupt pixbuf for maptype %d at %d %d %d %d", type, x, y, z, zoom );
+    return;
+  }
+
   guint nn = name ? g_str_hash ( name ) : 0;
   gchar *key = g_strdup_printf ( HASHKEY_FORMAT_STRING, type, x, y, z, zoom, nn, alpha, xshrinkfactor, yshrinkfactor );
 
   g_mutex_lock(mc_mutex);
-  cache_add(key, pixbuf);
+  g_object_ref(pixbuf);
+  cache_add(key, pixbuf, extra);
 
   // TODO: that should be done on preference change only...
   max_cache_size = a_preferences_get(VIKING_PREFERENCES_NAMESPACE "mapcache_size")->u * 1024 * 1024;
@@ -165,12 +191,37 @@ void a_mapcache_add ( GdkPixbuf *pixbuf, gint x, gint y, gint z, guint16 type, g
   if ( (++tmp == 100 )) { g_debug("DEBUG: cache count=%d size=%u list count=%d\n", g_hash_table_size(cache), cache_size, queue_count ); tmp=0; }
 }
 
+/**
+ * Function increases reference counter of pixels buffer in behalf of caller.
+ * Caller have to decrease references counter, when buffer is no longer needed.
+ */
 GdkPixbuf *a_mapcache_get ( gint x, gint y, gint z, guint16 type, gint zoom, guint8 alpha, gdouble xshrinkfactor, gdouble yshrinkfactor, const gchar* name )
 {
   static char key[MC_KEY_SIZE];
   guint nn = name ? g_str_hash ( name ) : 0;
   g_snprintf ( key, sizeof(key), HASHKEY_FORMAT_STRING, type, x, y, z, zoom, nn, alpha, xshrinkfactor, yshrinkfactor );
-  return g_hash_table_lookup ( cache, key );
+  g_mutex_lock(mc_mutex); /* prevent returning pixbuf when cache is being cleared */
+  cache_item_t *ci = g_hash_table_lookup ( cache, key );
+  if ( ci ) {
+    g_object_ref(ci->pixbuf);
+    g_mutex_unlock(mc_mutex);
+    return ci->pixbuf;
+  } else {
+    g_mutex_unlock(mc_mutex);
+    return NULL;
+  }
+}
+
+mapcache_extra_t a_mapcache_get_extra ( gint x, gint y, gint z, guint16 type, gint zoom, guint8 alpha, gdouble xshrinkfactor, gdouble yshrinkfactor, const gchar* name )
+{
+  static char key[MC_KEY_SIZE];
+  guint nn = name ? g_str_hash ( name ) : 0;
+  g_snprintf ( key, sizeof(key), HASHKEY_FORMAT_STRING, type, x, y, z, zoom, nn, alpha, xshrinkfactor, yshrinkfactor );
+  cache_item_t *ci = g_hash_table_lookup ( cache, key );
+  if ( ci )
+    return ci->extra;
+  else
+    return (mapcache_extra_t) { 0.0 };
 }
 
 /**
@@ -178,14 +229,19 @@ GdkPixbuf *a_mapcache_get ( gint x, gint y, gint z, guint16 type, gint zoom, gui
  */
 static void flush_matching ( gchar *str )
 {
-  if ( queue_tail == NULL )
+  g_mutex_lock(mc_mutex);
+
+  if ( queue_tail == NULL ) {
+    g_mutex_unlock(mc_mutex);
     return;
+  }
 
+  // The 'loop' variable must be assigned within the mutex lock section,
+  //  otherwise where it points to might not be valid anymore when the actual processing occurs
   List *loop = queue_tail;
   List *tmp;
   gint len = strlen(str);
 
-  g_mutex_lock(mc_mutex);
   do {
     tmp = loop->next;
     if ( tmp ) {
@@ -217,23 +273,23 @@ static void flush_matching ( gchar *str )
 /**
  * Appears this is only used when redownloading tiles (i.e. to invalidate old images)
  */
-void a_mapcache_remove_all_shrinkfactors ( gint x, gint y, gint z, guint16 type, gint zoom )
+void a_mapcache_remove_all_shrinkfactors ( gint x, gint y, gint z, guint16 type, gint zoom, const gchar* name )
 {
   char key[MC_KEY_SIZE];
-  g_snprintf ( key, sizeof(key), HASHKEY_FORMAT_STRING_NOSHRINK_NOR_ALPHA, type, x, y, z, zoom, 0 );
+  guint nn = name ? g_str_hash ( name ) : 0;
+  g_snprintf ( key, sizeof(key), HASHKEY_FORMAT_STRING_NOSHRINK_NOR_ALPHA, type, x, y, z, zoom, nn );
   flush_matching ( key );
 }
 
 void a_mapcache_flush ()
 {
+  // Everything happens within the mutex lock section
+  g_mutex_lock(mc_mutex);
+
   List *loop = queue_tail;
   List *tmp;
 
-  if ( queue_tail == NULL )
-    return;
-
-  g_mutex_lock(mc_mutex);
-  do {
+  while ( loop ) {
     tmp = loop->next;
     cache_remove(tmp->key);
     if ( tmp == queue_tail ) /* we deleted the last thing in the queue */
@@ -242,7 +298,7 @@ void a_mapcache_flush ()
       loop->next = tmp->next;
     g_free ( tmp );
     tmp = NULL;
-  } while ( loop );
+  }
 
   g_mutex_unlock(mc_mutex);
 }