2023-08-15 16:20:26 +02:00
|
|
|
/* SPDX-FileCopyrightText: 2004 Blender Authors
|
2023-05-31 16:19:06 +02:00
|
|
|
*
|
|
|
|
* SPDX-License-Identifier: GPL-2.0-or-later */
|
2020-12-19 06:44:57 +01:00
|
|
|
|
|
|
|
#pragma once
|
|
|
|
|
|
|
|
/** \file
|
|
|
|
* \ingroup sequencer
|
|
|
|
*/
|
2023-11-03 09:05:31 +01:00
|
|
|
|
2023-06-14 18:36:17 +02:00
|
|
|
#include "BLI_utildefines.h"
|
2020-12-19 06:44:57 +01:00
|
|
|
|
2023-11-03 09:05:31 +01:00
|
|
|
#include "DNA_scene_enums.h"
|
|
|
|
|
2021-01-04 02:03:34 +01:00
|
|
|
struct ListBase;
|
2023-11-03 09:05:31 +01:00
|
|
|
struct Main;
|
2024-01-04 21:07:48 +01:00
|
|
|
struct Mask;
|
|
|
|
struct MovieClip;
|
2020-12-19 06:44:57 +01:00
|
|
|
struct Scene;
|
|
|
|
struct Sequence;
|
2024-01-04 21:07:48 +01:00
|
|
|
struct Stereo3dFormat;
|
2020-12-19 06:44:57 +01:00
|
|
|
|
2022-04-05 00:00:20 +02:00
|
|
|
/** #SeqLoadData.flags */
|
2023-11-03 09:05:31 +01:00
|
|
|
enum eSeqLoadFlags {
|
2021-03-02 12:08:16 +01:00
|
|
|
SEQ_LOAD_SOUND_CACHE = (1 << 1),
|
|
|
|
SEQ_LOAD_SOUND_MONO = (1 << 2),
|
|
|
|
SEQ_LOAD_MOVIE_SYNC_FPS = (1 << 3),
|
2021-05-05 07:19:30 +02:00
|
|
|
SEQ_LOAD_SET_VIEW_TRANSFORM = (1 << 4),
|
2023-11-03 09:05:31 +01:00
|
|
|
};
|
2023-06-14 18:36:17 +02:00
|
|
|
ENUM_OPERATORS(eSeqLoadFlags, SEQ_LOAD_SET_VIEW_TRANSFORM)
|
2021-03-02 12:08:16 +01:00
|
|
|
|
|
|
|
/* Api for adding new sequence strips. */
|
2023-11-03 09:05:31 +01:00
|
|
|
struct SeqLoadData {
|
2020-12-19 06:44:57 +01:00
|
|
|
int start_frame;
|
|
|
|
int channel;
|
2023-06-05 02:47:37 +02:00
|
|
|
char name[64]; /* Strip name. */
|
|
|
|
/** Typically a `filepath` but may reference any kind of path. */
|
2020-12-19 06:44:57 +01:00
|
|
|
char path[1024]; /* 1024 = FILE_MAX */
|
2021-03-02 12:08:16 +01:00
|
|
|
struct {
|
|
|
|
int len;
|
|
|
|
int end_frame;
|
2024-01-04 21:07:48 +01:00
|
|
|
} image; /* Only for image strips. */
|
|
|
|
Scene *scene; /* Only for scene strips. */
|
|
|
|
MovieClip *clip; /* Only for clip strips. */
|
|
|
|
Mask *mask; /* Only for mask strips. */
|
2021-03-02 12:08:16 +01:00
|
|
|
struct {
|
|
|
|
int type;
|
|
|
|
int end_frame;
|
2024-01-04 21:07:48 +01:00
|
|
|
Sequence *seq1;
|
|
|
|
Sequence *seq2;
|
|
|
|
Sequence *seq3;
|
2021-03-02 12:08:16 +01:00
|
|
|
} effect; /* Only for effect strips. */
|
|
|
|
eSeqLoadFlags flags;
|
2020-12-19 06:44:57 +01:00
|
|
|
eSeqImageFitMethod fit_method;
|
2021-03-02 12:08:16 +01:00
|
|
|
bool use_multiview;
|
2020-12-19 06:44:57 +01:00
|
|
|
char views_format;
|
2024-01-04 21:07:48 +01:00
|
|
|
Stereo3dFormat *stereo3d_format;
|
2022-01-31 22:22:24 +01:00
|
|
|
bool allow_invalid_file; /* Used by RNA API to create placeholder strips. */
|
|
|
|
double r_video_stream_start; /* For AV synchronization. Set by `SEQ_add_movie_strip`. */
|
2022-06-29 12:45:59 +02:00
|
|
|
bool adjust_playback_rate;
|
2023-11-03 09:05:31 +01:00
|
|
|
};
|
2020-12-19 06:44:57 +01:00
|
|
|
|
2021-12-08 11:02:29 +01:00
|
|
|
/**
|
|
|
|
* Initialize common SeqLoadData members
|
|
|
|
*
|
|
|
|
* \param load_data: SeqLoadData to be initialized
|
|
|
|
* \param name: strip name (can be NULL)
|
|
|
|
* \param path: path to file that is used as strip input (can be NULL)
|
|
|
|
* \param start_frame: timeline frame where strip will be created
|
|
|
|
* \param channel: timeline channel where strip will be created
|
|
|
|
*/
|
2023-11-03 09:05:31 +01:00
|
|
|
void SEQ_add_load_data_init(
|
|
|
|
SeqLoadData *load_data, const char *name, const char *path, int start_frame, int channel);
|
2021-12-08 11:02:29 +01:00
|
|
|
/**
|
|
|
|
* Add image strip.
|
|
|
|
* \note Use #SEQ_add_image_set_directory() and #SEQ_add_image_load_file() to load image sequences
|
|
|
|
*
|
2021-12-14 08:35:23 +01:00
|
|
|
* \param bmain: Main reference
|
2021-12-08 11:02:29 +01:00
|
|
|
* \param scene: Scene where strips will be added
|
|
|
|
* \param seqbase: ListBase where strips will be added
|
|
|
|
* \param load_data: SeqLoadData with information necessary to create strip
|
|
|
|
* \return created strip
|
|
|
|
*/
|
2023-11-03 09:05:31 +01:00
|
|
|
Sequence *SEQ_add_image_strip(Main *bmain,
|
|
|
|
Scene *scene,
|
|
|
|
ListBase *seqbase,
|
|
|
|
SeqLoadData *load_data);
|
2021-12-10 11:42:06 +01:00
|
|
|
/**
|
|
|
|
* Add sound strip.
|
|
|
|
* \note Use SEQ_add_image_set_directory() and SEQ_add_image_load_file() to load image sequences
|
|
|
|
*
|
2021-12-14 08:35:23 +01:00
|
|
|
* \param bmain: Main reference
|
2021-12-10 11:42:06 +01:00
|
|
|
* \param scene: Scene where strips will be added
|
|
|
|
* \param seqbase: ListBase where strips will be added
|
|
|
|
* \param load_data: SeqLoadData with information necessary to create strip
|
|
|
|
* \return created strip
|
|
|
|
*/
|
2023-11-03 09:05:31 +01:00
|
|
|
Sequence *SEQ_add_sound_strip(Main *bmain,
|
|
|
|
Scene *scene,
|
|
|
|
ListBase *seqbase,
|
|
|
|
SeqLoadData *load_data);
|
2021-12-10 11:42:06 +01:00
|
|
|
/**
|
|
|
|
* Add meta strip.
|
|
|
|
*
|
|
|
|
* \param scene: Scene where strips will be added
|
|
|
|
* \param seqbase: ListBase where strips will be added
|
|
|
|
* \param load_data: SeqLoadData with information necessary to create strip
|
|
|
|
* \return created strip
|
|
|
|
*/
|
2023-11-03 09:05:31 +01:00
|
|
|
Sequence *SEQ_add_meta_strip(Scene *scene, ListBase *seqbase, SeqLoadData *load_data);
|
2021-12-08 11:02:29 +01:00
|
|
|
/**
|
|
|
|
* Add movie strip.
|
|
|
|
*
|
2021-12-14 08:35:23 +01:00
|
|
|
* \param bmain: Main reference
|
2021-12-08 11:02:29 +01:00
|
|
|
* \param scene: Scene where strips will be added
|
|
|
|
* \param seqbase: ListBase where strips will be added
|
|
|
|
* \param load_data: SeqLoadData with information necessary to create strip
|
|
|
|
* \return created strip
|
|
|
|
*/
|
2023-11-03 09:05:31 +01:00
|
|
|
Sequence *SEQ_add_movie_strip(Main *bmain,
|
|
|
|
Scene *scene,
|
|
|
|
ListBase *seqbase,
|
|
|
|
SeqLoadData *load_data);
|
2021-12-08 11:02:29 +01:00
|
|
|
/**
|
|
|
|
* Add scene strip.
|
|
|
|
*
|
|
|
|
* \param scene: Scene where strips will be added
|
|
|
|
* \param seqbase: ListBase where strips will be added
|
|
|
|
* \param load_data: SeqLoadData with information necessary to create strip
|
|
|
|
* \return created strip
|
|
|
|
*/
|
2023-11-03 09:05:31 +01:00
|
|
|
Sequence *SEQ_add_scene_strip(Scene *scene, ListBase *seqbase, SeqLoadData *load_data);
|
2021-12-08 11:02:29 +01:00
|
|
|
/**
|
|
|
|
* Add movieclip strip.
|
|
|
|
*
|
|
|
|
* \param scene: Scene where strips will be added
|
|
|
|
* \param seqbase: ListBase where strips will be added
|
|
|
|
* \param load_data: SeqLoadData with information necessary to create strip
|
|
|
|
* \return created strip
|
|
|
|
*/
|
2023-11-03 09:05:31 +01:00
|
|
|
Sequence *SEQ_add_movieclip_strip(Scene *scene, ListBase *seqbase, SeqLoadData *load_data);
|
2021-12-08 11:02:29 +01:00
|
|
|
/**
|
|
|
|
* Add mask strip.
|
|
|
|
*
|
|
|
|
* \param scene: Scene where strips will be added
|
|
|
|
* \param seqbase: ListBase where strips will be added
|
|
|
|
* \param load_data: SeqLoadData with information necessary to create strip
|
|
|
|
* \return created strip
|
|
|
|
*/
|
2023-11-03 09:05:31 +01:00
|
|
|
Sequence *SEQ_add_mask_strip(Scene *scene, ListBase *seqbase, SeqLoadData *load_data);
|
2021-12-08 11:02:29 +01:00
|
|
|
/**
|
|
|
|
* Add effect strip.
|
|
|
|
*
|
|
|
|
* \param scene: Scene where strips will be added
|
|
|
|
* \param seqbase: ListBase where strips will be added
|
|
|
|
* \param load_data: SeqLoadData with information necessary to create strip
|
|
|
|
* \return created strip
|
|
|
|
*/
|
2023-11-03 09:05:31 +01:00
|
|
|
Sequence *SEQ_add_effect_strip(Scene *scene, ListBase *seqbase, SeqLoadData *load_data);
|
2021-12-08 11:02:29 +01:00
|
|
|
/**
|
|
|
|
* Set directory used by image strip.
|
|
|
|
*
|
|
|
|
* \param seq: image strip to be changed
|
|
|
|
* \param path: directory path
|
|
|
|
*/
|
2023-11-03 09:05:31 +01:00
|
|
|
void SEQ_add_image_set_directory(Sequence *seq, const char *dirpath);
|
2021-12-08 11:02:29 +01:00
|
|
|
/**
|
|
|
|
* Set directory used by image strip.
|
|
|
|
*
|
|
|
|
* \param seq: image strip to be changed
|
|
|
|
* \param strip_frame: frame index of strip to be changed
|
|
|
|
* \param filename: image filename (only filename, not complete path)
|
|
|
|
*/
|
2023-11-03 09:05:31 +01:00
|
|
|
void SEQ_add_image_load_file(Scene *scene,
|
|
|
|
Sequence *seq,
|
2022-06-29 12:45:59 +02:00
|
|
|
size_t strip_frame,
|
2023-05-13 09:34:29 +02:00
|
|
|
const char *filename);
|
2021-12-08 11:02:29 +01:00
|
|
|
/**
|
|
|
|
* Set image strip alpha mode
|
|
|
|
*
|
|
|
|
* \param seq: image strip to be changed
|
|
|
|
*/
|
2023-11-03 09:05:31 +01:00
|
|
|
void SEQ_add_image_init_alpha_mode(Sequence *seq);
|
|
|
|
void SEQ_add_reload_new_file(Main *bmain, Scene *scene, Sequence *seq, bool lock_range);
|
|
|
|
void SEQ_add_movie_reload_if_needed(
|
|
|
|
Main *bmain, Scene *scene, Sequence *seq, bool *r_was_reloaded, bool *r_can_produce_frames);
|