cinelerra/cache.h

   1 #ifndef CACHE_H
   2 #define CACHE_H
   3
   4 // CICache for quickly reading data that is hard to decompress yet used
   5 // over and over.
   6
   7 // Actual caching is done in the File object
   8 // the CICache keeps files open while rendering.
   9
  10 // Since the CICache outlives EDLs it must copy every parameter given to it.
  11
  12 // Files given as arguments must outlive the cache.
  13
  14 #include "arraylist.h"
  15 #include "asset.inc"
  16 #include "cache.inc"
  17 #include "condition.inc"
  18 #include "edl.inc"
  19 #include "file.inc"
  20 #include "garbage.h"
  21 #include "linklist.h"
  22 #include "mutex.inc"
  23 #include "pluginserver.inc"
  24 #include "preferences.inc"
  25
  26 #include <stdint.h>
  27
  28 class CICacheItem : public ListItem<CICacheItem>, public GarbageObject
  29 {
  30 public:
  31         CICacheItem(CICache *cache, EDL *edl, Asset *asset);
  32         CICacheItem();
  33         ~CICacheItem();
  34
  35         File *file;
  36 // Number of last get or put operation involving this object.
  37         int age;
  38         Asset *asset;     // Copy of asset.  CICache should outlive EDLs.
  39         Condition *item_lock;
  40         int checked_out;
  41 private:
  42         CICache *cache;
  43 };
  44
  45 class CICache : public List<CICacheItem>
  46 {
  47 public:
  48         CICache(Preferences *preferences,
  49                 ArrayList<PluginServer*> *plugindb);
  50         ~CICache();
  51
  52         friend class CICacheItem;
  53
  54 // Enter a new file into the cache which is already open.
  55 // If the file doesn't exist return the arguments.
  56 // If the file exists delete the arguments and return the file which exists.
  57 //      void update(File* &file);
  58 //      void set_edl(EDL *edl);
  59
  60 // open it, lock it and add it to the cache if it isn't here already
  61 // If it's already checked out, the value of block causes it to wait
  62 // until it's checked in.
  63         File* check_out(Asset *asset, EDL *edl, int block = 1);
  64
  65 // unlock a file from the cache
  66         int check_in(Asset *asset);
  67
  68 // delete an entry from the cache
  69 // before deleting an asset, starting a new project or something
  70         int delete_entry(Asset *asset);
  71         int delete_entry(char *path);
  72 // Remove all entries from the cache.
  73         void remove_all();
  74
  75 // Get ID of oldest member.
  76 // Called by MWindow::age_caches.
  77         int get_oldest();
  78         int64_t get_memory_usage(int use_lock);
  79
  80 // Called by age() and MWindow::age_caches
  81 // returns 1 if nothing was available to delete
  82 // 0 if successful
  83         int delete_oldest();
  84
  85 // Called by check_in() and modules.
  86 // deletes oldest assets until under the memory limit
  87         int age();
  88
  89
  90         int dump();
  91
  92         ArrayList<PluginServer*> *plugindb;
  93
  94 private:
  95
  96 // for deleting items
  97         int lock_all();
  98         int unlock_all();
  99
 100 // to prevent one from checking the same asset out before it's checked in
 101 // yet without blocking the asset trying to get checked in
 102 // use a seperate mutex for checkouts and checkins
 103         Mutex *total_lock;
 104         Condition *check_out_lock;
 105 // Copy of EDL
 106         EDL *edl;
 107         Preferences *preferences;
 108 };
 109
 110
 111
 112
 113
 114
 115
 116
 117 #endif