MOV_read.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2024 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */

 
#pragma once
 
#include "IMB_imbuf_enums.h"
 
#include "MOV_enums.hh"
 
#include "BLI_set.hh"
 
#include <string>
 
struct IDProperty;
struct ImBuf;
struct MovieReader;
struct MovieProxyBuilder;

MovieReader *MOV_open_file(const char *filepath,
                           int ib_flags,
                           int streamindex,
                           bool keep_original_colorspace,
                           char colorspace[IM_MAX_SPACE]);

void MOV_close(MovieReader *anim);

ImBuf *MOV_decode_frame(MovieReader *anim,
                        int position,
                        IMB_Timecode_Type tc /* = 1 = IMB_TC_RECORD_RUN */,
                        IMB_Proxy_Size preview_size /* = 0 = IMB_PROXY_NONE */);

ImBuf *MOV_decode_preview_frame(MovieReader *anim);

int MOV_get_duration_frames(MovieReader *anim, IMB_Timecode_Type tc);

double MOV_get_start_offset_seconds(const MovieReader *anim);

float MOV_get_fps(const MovieReader *anim);

bool MOV_get_fps_num_denom(const MovieReader *anim, short &r_fps_num, float &r_fps_denom);

int MOV_get_image_width(const MovieReader *anim);

int MOV_get_image_height(const MovieReader *anim);

bool MOV_is_initialized_and_valid(const MovieReader *anim);

void MOV_get_filename(const MovieReader *anim, char *filename, int filename_maxncpy);

IDProperty *MOV_load_metadata(MovieReader *anim);
 
/*-------------------------------------------------------------------- */
/*
 * Movie proxy / timecode index related functionality.
 */

void MOV_set_multiview_suffix(MovieReader *anim, const char *suffix);

void MOV_close_proxies(MovieReader *anim);

void MOV_set_custom_proxy_dir(MovieReader *anim, const char *dir);

int MOV_calc_frame_index_with_timecode(MovieReader *anim, IMB_Timecode_Type tc, int position);

int MOV_get_existing_proxies(const MovieReader *anim);

MovieProxyBuilder *MOV_proxy_builder_start(MovieReader *anim,
                                           IMB_Timecode_Type tcs_in_use,
                                           int proxy_sizes_in_use,
                                           int quality,
                                           const bool overwrite,
                                           blender::Set<std::string> *processed_paths,
                                           bool build_only_on_bad_performance);

void MOV_proxy_builder_process(MovieProxyBuilder *context,
                               bool *stop,
                               bool *do_update,
                               float *progress);

void MOV_proxy_builder_finish(MovieProxyBuilder *context, bool stop);