#include <cstdlib>
#include "MEM_guardedalloc.h"
#include "BLI_array.hh"
#include "BLI_endian_defines.h"
#include "BLI_endian_switch.h"
#include "BLI_fileops.h"
#include "BLI_ghash.h"
#include "BLI_math_base.h"
#include "BLI_path_utils.hh"
#include "BLI_string.h"
#include "BLI_string_utils.hh"
#include "BLI_threads.h"
#include "BLI_time.h"
#include "BLI_utildefines.h"
#include "BKE_writeffmpeg.hh"
#include "IMB_anim.hh"
#include "IMB_imbuf.hh"
#include "IMB_indexer.hh"
#include "imbuf.hh"

Classes
struct	IndexBuildContext

Macros
#define	INDEX_FILE_VERSION 2

Functions
anim_index_builder *	IMB_index_builder_create (const char *filepath)

void	IMB_index_builder_add_entry (anim_index_builder *fp, int frameno, uint64_t seek_pos, uint64_t seek_pos_pts, uint64_t seek_pos_dts, uint64_t pts)

void	IMB_index_builder_proc_frame (anim_index_builder fp, uchar buffer, int data_size, int frameno, uint64_t seek_pos, uint64_t seek_pos_pts, uint64_t seek_pos_dts, uint64_t pts)

void	IMB_index_builder_finish (anim_index_builder *fp, int rollback)

ImBufAnimIndex *	IMB_indexer_open (const char *filepath)

uint64_t	IMB_indexer_get_seek_pos (ImBufAnimIndex *idx, int frame_index)

uint64_t	IMB_indexer_get_seek_pos_pts (ImBufAnimIndex *idx, int frame_index)

uint64_t	IMB_indexer_get_seek_pos_dts (ImBufAnimIndex *idx, int frame_index)

int	IMB_indexer_get_frame_index (ImBufAnimIndex *idx, int frameno)

uint64_t	IMB_indexer_get_pts (ImBufAnimIndex *idx, int frame_index)

int	IMB_indexer_get_duration (ImBufAnimIndex *idx)

int	IMB_indexer_can_scan (ImBufAnimIndex *idx, int old_frame_index, int new_frame_index)

void	IMB_indexer_close (ImBufAnimIndex *idx)

int	IMB_proxy_size_to_array_index (IMB_Proxy_Size pr_size)

int	IMB_timecode_to_array_index (IMB_Timecode_Type tc)

static void	get_index_dir (ImBufAnim anim, char index_dir, size_t index_dir_maxncpy)

void	IMB_anim_get_filename (ImBufAnim anim, char filename, int filename_maxncpy)

static bool	get_proxy_filepath (ImBufAnim anim, IMB_Proxy_Size preview_size, char filepath, bool temp)

static void	get_tc_filepath (ImBufAnim anim, IMB_Timecode_Type tc, char filepath)

IndexBuildContext *	IMB_anim_index_rebuild_context (ImBufAnim anim, IMB_Timecode_Type tcs_in_use, int proxy_sizes_in_use, int quality, const bool overwrite, GSet file_list, bool build_only_on_bad_performance)

void	IMB_anim_index_rebuild (IndexBuildContext context, bool stop, bool do_update, float progress)

void	IMB_anim_index_rebuild_finish (IndexBuildContext *context, const bool stop)

void	IMB_free_indices (ImBufAnim *anim)

void	IMB_anim_set_index_dir (ImBufAnim anim, const char dir)

ImBufAnim *	IMB_anim_open_proxy (ImBufAnim *anim, IMB_Proxy_Size preview_size)

ImBufAnimIndex *	IMB_anim_open_index (ImBufAnim *anim, IMB_Timecode_Type tc)

int	IMB_anim_index_get_frame_index (ImBufAnim *anim, IMB_Timecode_Type tc, int position)

int	IMB_anim_proxy_get_existing (ImBufAnim *anim)

Variables
static const char	binary_header_str [] = "BlenMIdx"

static const char	temp_ext [] = "_part"

static const IMB_Proxy_Size	proxy_sizes []

static const float	proxy_fac [] = {0.25, 0.50, 0.75, 1.00}

Macro Definition Documentation

◆ INDEX_FILE_VERSION

#define INDEX_FILE_VERSION 2

Definition at line 51 of file indexer.cc.

Referenced by IMB_index_builder_create(), and IMB_indexer_open().

Function Documentation

◆ get_index_dir()

static void get_index_dir	(	ImBufAnim *	anim,
		char *	index_dir,
		size_t	index_dir_maxncpy )

static

Definition at line 368 of file indexer.cc.

References BLI_path_join, BLI_path_split_dir_file(), BLI_strncpy(), dirname(), FILE_MAXDIR, FILE_MAXFILE, ImBufAnim::filepath, and ImBufAnim::index_dir.

Referenced by get_proxy_filepath(), and get_tc_filepath().

◆ get_proxy_filepath()

static bool get_proxy_filepath	(	ImBufAnim *	anim,
		IMB_Proxy_Size	preview_size,
		char *	filepath,
		bool	temp )

static

Definition at line 386 of file indexer.cc.

References BLI_assert, BLI_path_join, BLI_path_ncmp, FILE_MAXDIR, FILE_MAXFILE, ImBufAnim::filepath, get_index_dir(), IMB_proxy_size_to_array_index(), proxy_fac, SNPRINTF, ImBufAnim::streamindex, and ImBufAnim::suffix.

Referenced by IMB_anim_index_rebuild_context(), IMB_anim_open_proxy(), and IMB_anim_proxy_get_existing().

◆ get_tc_filepath()

static void get_tc_filepath	(	ImBufAnim *	anim,
		IMB_Timecode_Type	tc,
		char *	filepath )

static

Definition at line 418 of file indexer.cc.

References BLI_assert, BLI_path_join, FILE_MAXDIR, FILE_MAXFILE, get_index_dir(), IMB_timecode_to_array_index(), SNPRINTF, ImBufAnim::streamindex, and ImBufAnim::suffix.

Referenced by IMB_anim_open_index().

◆ IMB_anim_get_filename()

void IMB_anim_get_filename	(	ImBufAnim *	anim,
		char *	filename,
		int	filename_maxncpy )

Definition at line 381 of file indexer.cc.

References BLI_path_split_file_part(), and ImBufAnim::filepath.

Referenced by seq_proxy_index_dir_set().

◆ IMB_anim_index_get_frame_index()

int IMB_anim_index_get_frame_index	(	ImBufAnim *	anim,
		IMB_Timecode_Type	tc,
		int	position )

Definition at line 1402 of file indexer.cc.

References IMB_anim_open_index(), and IMB_indexer_get_frame_index().

Referenced by IMB_anim_absolute(), and seq_proxy_fetch().

◆ IMB_anim_index_rebuild()

void IMB_anim_index_rebuild	(	IndexBuildContext *	context,
		bool *	stop,
		bool *	do_update,
		float *	progress )

Will rebuild all used indices and proxies at once.

Definition at line 1283 of file indexer.cc.

References UNUSED_VARS.

Referenced by do_movie_proxy(), and SEQ_proxy_rebuild().

◆ IMB_anim_index_rebuild_context()

IndexBuildContext * IMB_anim_index_rebuild_context	(	ImBufAnim *	anim,
		IMB_Timecode_Type	tcs_in_use,
		int	proxy_sizes_in_use,
		int	quality,
		const bool	overwrite,
		GSet *	file_list,
		bool	build_only_on_bad_performance )

Prepare context for proxies/time-codes builder

Definition at line 1212 of file indexer.cc.

References BLI_gset_ensure_p_ex(), BLI_strdup(), FILE_MAX, get_proxy_filepath(), IMB_anim_proxy_get_existing(), IMB_PROXY_MAX_SLOT, printf, proxy_sizes, ImBufAnim::state, UNUSED_VARS, and ImBufAnim::Valid.

Referenced by clip_rebuild_proxy_exec(), and SEQ_proxy_rebuild_context().

◆ IMB_anim_index_rebuild_finish()

void IMB_anim_index_rebuild_finish	(	IndexBuildContext *	context,
		bool	stop )

Finish rebuilding proxies/time-codes and free temporary contexts used.

Definition at line 1301 of file indexer.cc.

References proxy_sizes, and UNUSED_VARS.

Referenced by proxy_endjob(), and SEQ_proxy_rebuild_finish().

◆ IMB_anim_open_index()

ImBufAnimIndex * IMB_anim_open_index	(	ImBufAnim *	anim,
		IMB_Timecode_Type	tc )

Definition at line 1373 of file indexer.cc.

References FILE_MAX, get_tc_filepath(), IMB_indexer_open(), IMB_TC_RECORD_RUN, IMB_TC_RECORD_RUN_NO_GAPS, ImBufAnim::indices_tried, ImBufAnim::no_gaps, and ImBufAnim::record_run.

Referenced by IMB_anim_get_duration(), and IMB_anim_index_get_frame_index().

◆ IMB_anim_open_proxy()

ImBufAnim * IMB_anim_open_proxy	(	ImBufAnim *	anim,
		IMB_Proxy_Size	preview_size )

Definition at line 1346 of file indexer.cc.

References ImBufAnim::colorspace, FILE_MAX, get_proxy_filepath(), IMB_open_anim(), IMB_proxy_size_to_array_index(), ImBufAnim::proxies_tried, and ImBufAnim::proxy_anim.

Referenced by IMB_anim_absolute().

◆ IMB_anim_proxy_get_existing()

int IMB_anim_proxy_get_existing ( ImBufAnim * anim )

Definition at line 1413 of file indexer.cc.

References BLI_exists(), FILE_MAX, get_proxy_filepath(), IMB_PROXY_MAX_SLOT, IMB_PROXY_NONE, int, and proxy_sizes.

Referenced by IMB_anim_index_rebuild_context(), and seq_proxy_need_rebuild().

◆ IMB_anim_set_index_dir()

void IMB_anim_set_index_dir	(	ImBufAnim *	anim,
		const char *	dir )

Defaults to BL_proxy within the directory of the animation.

Definition at line 1336 of file indexer.cc.

References IMB_free_indices(), ImBufAnim::index_dir, STREQ, and STRNCPY.

Referenced by movieclip_open_anim_file(), and seq_proxy_index_dir_set().

◆ IMB_free_indices()

void IMB_free_indices ( ImBufAnim * anim )

Definition at line 1312 of file indexer.cc.

References IMB_close_anim(), IMB_indexer_close(), IMB_PROXY_MAX_SLOT, ImBufAnim::indices_tried, ImBufAnim::no_gaps, ImBufAnim::proxies_tried, ImBufAnim::proxy_anim, and ImBufAnim::record_run.

Referenced by IMB_anim_set_index_dir(), IMB_close_anim_proxies(), and IMB_free_anim().

◆ IMB_index_builder_add_entry()

void IMB_index_builder_add_entry	(	anim_index_builder *	fp,
		int	frameno,
		uint64_t	seek_pos,
		uint64_t	seek_pos_pts,
		uint64_t	seek_pos_dts,
		uint64_t	pts )

Definition at line 91 of file indexer.cc.

References anim_index_builder::fp.

Referenced by IMB_index_builder_proc_frame().

◆ IMB_index_builder_create()

anim_index_builder * IMB_index_builder_create ( const char * filepath )

Definition at line 57 of file indexer.cc.

References B_ENDIAN, binary_header_str, BLI_file_ensure_parent_dir_exists(), BLI_fopen(), BLI_string_join, ENDIAN_ORDER, anim_index_builder::filepath, anim_index_builder::filepath_temp, anim_index_builder::fp, INDEX_FILE_VERSION, MEM_freeN(), STRNCPY, and temp_ext.

◆ IMB_index_builder_finish()

void IMB_index_builder_finish	(	anim_index_builder *	fp,
		int	rollback )

Definition at line 129 of file indexer.cc.

References BLI_rename(), anim_index_builder::delete_priv_data, anim_index_builder::filepath, anim_index_builder::filepath_temp, anim_index_builder::fp, and MEM_freeN().

◆ IMB_index_builder_proc_frame()

void IMB_index_builder_proc_frame	(	anim_index_builder *	fp,
		uchar *	buffer,
		int	data_size,
		int	frameno,
		uint64_t	seek_pos,
		uint64_t	seek_pos_pts,
		uint64_t	seek_pos_dts,
		uint64_t	pts )