src/cache.h

   1 /*
   2  * Geeqie
   3  * (C) 2004 John Ellis
   4  * Copyright (C) 2008 The Geeqie Team
   5  *
   6  * Author: John Ellis
   7  *
   8  * This software is released under the GNU General Public License (GNU GPL).
   9  * Please read the included file COPYING for more information.
  10  * This software comes with no warranty of any kind, use at your own risk!
  11  */
  12
  13
  14 #ifndef CACHE_H
  15 #define CACHE_H
  16
  17
  18 #include "similar.h"
  19
  20
  21 #define GQ_CACHE_RC_THUMB       GQ_RC_DIR G_DIR_SEPARATOR_S "thumbnails"
  22 #define GQ_CACHE_RC_METADATA    GQ_RC_DIR G_DIR_SEPARATOR_S "metadata"
  23
  24 #define GQ_CACHE_LOCAL_THUMB    ".thumbnails"
  25 #define GQ_CACHE_LOCAL_METADATA ".metadata"
  26
  27 #define GQ_CACHE_EXT_THUMB      ".png"
  28 #define GQ_CACHE_EXT_SIM        ".sim"
  29 #define GQ_CACHE_EXT_METADATA   ".meta"
  30
  31
  32 typedef enum {
  33         CACHE_TYPE_THUMB,
  34         CACHE_TYPE_SIM,
  35         CACHE_TYPE_METADATA
  36 } CacheType;
  37
  38 typedef struct _CacheData CacheData;
  39 struct _CacheData
  40 {
  41         gchar *path;
  42         gint width;
  43         gint height;
  44         time_t date;
  45         glong checksum;
  46         guchar md5sum[16];
  47         ImageSimilarityData *sim;
  48
  49         gint dimensions;
  50         gint have_date;
  51         gint have_checksum;
  52         gint have_md5sum;
  53         gint similarity;
  54 };
  55
  56 gint cache_time_valid(const gchar *cache, const gchar *path);
  57
  58
  59 CacheData *cache_sim_data_new(void);
  60 void cache_sim_data_free(CacheData *cd);
  61
  62 gint cache_sim_data_save(CacheData *cd);
  63 CacheData *cache_sim_data_load(const gchar *path);
  64
  65 void cache_sim_data_set_dimensions(CacheData *cd, gint w, gint h);
  66 void cache_sim_data_set_date(CacheData *cd, time_t date);
  67 void cache_sim_data_set_checksum(CacheData *cd, glong checksum);
  68 void cache_sim_data_set_md5sum(CacheData *cd, guchar digest[16]);
  69 void cache_sim_data_set_similarity(CacheData *cd, ImageSimilarityData *sd);
  70 gint cache_sim_data_filled(ImageSimilarityData *sd);
  71
  72
  73 gint cache_ensure_dir_exists(gchar *path, mode_t mode);
  74 gchar *cache_get_location(CacheType type, const gchar *source, gint include_name, mode_t *mode);
  75 gchar *cache_find_location(CacheType type, const gchar *source);
  76
  77
  78 #endif