#include <cstddef>
#include <ctime>
#include <memory.h>
#include "MEM_guardedalloc.h"
#include "DNA_scene_types.h"
#include "DNA_sequence_types.h"
#include "IMB_colormanagement.hh"
#include "IMB_imbuf.hh"
#include "IMB_imbuf_types.hh"
#include "BLI_blenlib.h"
#include "BLI_endian_defines.h"
#include "BLI_endian_switch.h"
#include "BLI_fileops.h"
#include "BLI_fileops_types.h"
#include "BLI_listbase.h"
#include "BLI_path_utils.hh"
#include "BLI_threads.h"
#include "BKE_main.hh"
#include "SEQ_render.hh"
#include "SEQ_time.hh"
#include "disk_cache.hh"
#include "image_cache.hh"

Classes
struct	DiskCacheHeaderEntry
struct	DiskCacheHeader
struct	SeqDiskCache
struct	DiskCacheFile

Macros
#define	DCACHE_FNAME_FORMAT "%d-%dx%d-%d%%(%d)-%d.dcf"
#define	DCACHE_IMAGES_PER_FILE 100
#define	DCACHE_CURRENT_VERSION 2
#define	COLORSPACE_NAME_MAX 64 /* XXX: defined in IMB intern. */

Functions
static const char *	seq_disk_cache_base_dir ()
static int	seq_disk_cache_compression_level ()
static size_t	seq_disk_cache_size_limit ()
bool	seq_disk_cache_is_enabled (Main *bmain)
static DiskCacheFile *	seq_disk_cache_add_file_to_list (SeqDiskCache disk_cache, const char filepath)
static void	seq_disk_cache_get_files (SeqDiskCache disk_cache, const char dirpath)
static DiskCacheFile *	seq_disk_cache_get_oldest_file (SeqDiskCache *disk_cache)
static void	seq_disk_cache_delete_file (SeqDiskCache disk_cache, DiskCacheFile file)
bool	seq_disk_cache_enforce_limits (SeqDiskCache *disk_cache)
static DiskCacheFile *	seq_disk_cache_get_file_entry_by_path (SeqDiskCache disk_cache, const char filepath)
static void	seq_disk_cache_update_file (SeqDiskCache disk_cache, const char filepath)
static void	seq_disk_cache_get_project_dir (SeqDiskCache disk_cache, char dirpath, size_t dirpath_maxncpy)
static void	seq_disk_cache_get_dir (SeqDiskCache disk_cache, Scene scene, Sequence seq, char dirpath, size_t dirpath_maxncpy)
static void	seq_disk_cache_get_file_path (SeqDiskCache disk_cache, SeqCacheKey key, char *filepath, size_t filepath_maxncpy)
static void	seq_disk_cache_create_version_file (const char *filepath)
static void	seq_disk_cache_handle_versioning (SeqDiskCache *disk_cache)
static void	seq_disk_cache_delete_invalid_files (SeqDiskCache disk_cache, Scene scene, Sequence *seq, int invalidate_types, int range_start, int range_end)
void	seq_disk_cache_invalidate (SeqDiskCache disk_cache, Scene scene, Sequence seq, Sequence seq_changed, int invalidate_types)
static size_t	deflate_imbuf_to_file (ImBuf ibuf, FILE file, int level, DiskCacheHeaderEntry *header_entry)
static size_t	inflate_file_to_imbuf (ImBuf ibuf, FILE file, DiskCacheHeaderEntry *header_entry)
static bool	seq_disk_cache_read_header (FILE file, DiskCacheHeader header)
static size_t	seq_disk_cache_write_header (FILE file, const DiskCacheHeader header)
static int	seq_disk_cache_add_header_entry (const SeqCacheKey key, ImBuf ibuf, DiskCacheHeader *header)
static int	seq_disk_cache_get_header_entry (const SeqCacheKey key, const DiskCacheHeader header)
bool	seq_disk_cache_write_file (SeqDiskCache disk_cache, SeqCacheKey key, ImBuf *ibuf)
ImBuf *	seq_disk_cache_read_file (SeqDiskCache disk_cache, SeqCacheKey key)
SeqDiskCache *	seq_disk_cache_create (Main bmain, Scene scene)
void	seq_disk_cache_free (SeqDiskCache *disk_cache)

Variables
static ThreadMutex	cache_create_lock = BLI_MUTEX_INITIALIZER

Macro Definition Documentation

◆ COLORSPACE_NAME_MAX

#define COLORSPACE_NAME_MAX 64 /* XXX: defined in IMB intern. */

Definition at line 61 of file disk_cache.cc.

◆ DCACHE_CURRENT_VERSION

#define DCACHE_CURRENT_VERSION 2

Definition at line 60 of file disk_cache.cc.

Referenced by seq_disk_cache_create_version_file(), and seq_disk_cache_handle_versioning().

◆ DCACHE_FNAME_FORMAT

#define DCACHE_FNAME_FORMAT "%d-%dx%d-%d%%(%d)-%d.dcf"

Disk Cache Design Notes

Disk cache uses directory specified in user preferences For each cached non-temp image, image data and supplementary info are written to HDD. Multiple(DCACHE_IMAGES_PER_FILE) images share the same file. Each of these files contains header DiskCacheHeader followed by image data. ZLIB compression with user definable level can be used to compress image data(per image) Images are written in order in which they are rendered. Overwriting of individual entry is not possible. Stored images are deleted by invalidation, or when size of all files exceeds maximum size specified in user preferences. To distinguish 2 blend files with same name, scene->ed->disk_cache_timestamp is used as UID. Blend file can still be copied manually which may cause conflict.

Definition at line 58 of file disk_cache.cc.

Referenced by seq_disk_cache_add_file_to_list(), and seq_disk_cache_get_file_path().

◆ DCACHE_IMAGES_PER_FILE

#define DCACHE_IMAGES_PER_FILE 100

Definition at line 59 of file disk_cache.cc.

Referenced by seq_disk_cache_add_file_to_list(), seq_disk_cache_add_header_entry(), seq_disk_cache_get_file_path(), seq_disk_cache_get_header_entry(), seq_disk_cache_invalidate(), and seq_disk_cache_read_header().

Function Documentation

◆ deflate_imbuf_to_file()

size_t deflate_imbuf_to_file	(	ImBuf *	ibuf,
		FILE *	file,
		int	level,
		DiskCacheHeaderEntry *	header_entry )

static

Definition at line 416 of file disk_cache.cc.

References BLI_file_zstd_from_mem_at_pos(), ImBuf::byte_buffer, data, ImBufByteBuffer::data, ImBufFloatBuffer::data, ImBuf::float_buffer, DiskCacheHeaderEntry::offset, and DiskCacheHeaderEntry::size_raw.

Referenced by seq_disk_cache_write_file().

◆ inflate_file_to_imbuf()

size_t inflate_file_to_imbuf	(	ImBuf *	ibuf,
		FILE *	file,
		DiskCacheHeaderEntry *	header_entry )

static

Definition at line 434 of file disk_cache.cc.

References BLI_file_magic_is_zstd(), BLI_file_unzstd_to_mem_at_pos(), ImBuf::byte_buffer, data, ImBufByteBuffer::data, ImBufFloatBuffer::data, ImBuf::float_buffer, DiskCacheHeaderEntry::offset, and DiskCacheHeaderEntry::size_raw.

Referenced by seq_disk_cache_read_file().

◆ seq_disk_cache_add_file_to_list()

DiskCacheFile * seq_disk_cache_add_file_to_list	(	SeqDiskCache *	disk_cache,
		const char *	filepath )

static

Definition at line 131 of file disk_cache.cc.

References BLI_addtail(), BLI_path_split_dir_file(), DiskCacheFile::cache_type, DCACHE_FNAME_FORMAT, DCACHE_IMAGES_PER_FILE, DiskCacheFile::dir, DiskCacheFile::file, FILE_MAX, FILE_MAXDIR, DiskCacheFile::filepath, SeqDiskCache::files, MEM_callocN, DiskCacheFile::rectx, DiskCacheFile::recty, DiskCacheFile::render_size, DiskCacheFile::start_frame, STRNCPY, and DiskCacheFile::view_id.

Referenced by seq_disk_cache_get_files(), and seq_disk_cache_write_file().

◆ seq_disk_cache_add_header_entry()

int seq_disk_cache_add_header_entry	(	const SeqCacheKey *	key,
		ImBuf *	ibuf,
		DiskCacheHeader *	header )

static

◆ seq_disk_cache_base_dir()

const char * seq_disk_cache_base_dir ( )

static

Definition at line 100 of file disk_cache.cc.

References U.

Referenced by seq_disk_cache_create(), seq_disk_cache_enforce_limits(), and seq_disk_cache_get_project_dir().

◆ seq_disk_cache_compression_level()

int seq_disk_cache_compression_level ( )

static

Definition at line 105 of file disk_cache.cc.

References U, USER_SEQ_DISK_CACHE_COMPRESSION_HIGH, USER_SEQ_DISK_CACHE_COMPRESSION_LOW, and USER_SEQ_DISK_CACHE_COMPRESSION_NONE.

Referenced by seq_disk_cache_write_file().

◆ seq_disk_cache_create()

SeqDiskCache * seq_disk_cache_create	(	Main *	bmain,
		Scene *	scene )

Definition at line 667 of file disk_cache.cc.

References BLI_mutex_init(), BLI_mutex_unlock(), SeqDiskCache::bmain, cache_create_lock, Editing::disk_cache_timestamp, Scene::ed, MEM_callocN, SeqDiskCache::read_write_mutex, seq_disk_cache_base_dir(), seq_disk_cache_get_files(), seq_disk_cache_handle_versioning(), and SeqDiskCache::timestamp.

Referenced by seq_cache_get(), and seq_cache_put().

◆ seq_disk_cache_create_version_file()

void seq_disk_cache_create_version_file ( const char * filepath )

static

Definition at line 329 of file disk_cache.cc.

References BLI_file_ensure_parent_dir_exists(), BLI_fopen(), and DCACHE_CURRENT_VERSION.

Referenced by seq_disk_cache_handle_versioning().

◆ seq_disk_cache_delete_file()

void seq_disk_cache_delete_file	(	SeqDiskCache *	disk_cache,
		DiskCacheFile *	file )

static

Definition at line 211 of file disk_cache.cc.

References BLI_delete(), BLI_remlink(), DiskCacheFile::filepath, SeqDiskCache::files, DiskCacheFile::fstat, MEM_freeN(), and SeqDiskCache::size_total.

Referenced by seq_disk_cache_delete_invalid_files(), seq_disk_cache_enforce_limits(), and seq_disk_cache_write_file().

◆ seq_disk_cache_delete_invalid_files()

void seq_disk_cache_delete_invalid_files	(	SeqDiskCache *	disk_cache,
		Scene *	scene,
		Sequence *	seq,
		int	invalidate_types,
		int	range_start,
		int	range_end )