Page MenuHome
Differential D10209 Diff 37213 source/blender/sequencer/intern/utils.c

Changeset View

Standalone View

View Options

source/blender/sequencer/intern/utils.c

Show All 27 Lines
#include <string.h> #include <string.h>
#include "MEM_guardedalloc.h" #include "MEM_guardedalloc.h"
#include "DNA_mask_types.h" #include "DNA_mask_types.h"
#include "DNA_scene_types.h" #include "DNA_scene_types.h"
#include "DNA_sequence_types.h" #include "DNA_sequence_types.h"
#include "BLI_listbase.h" #include "BLI_blenlib.h"
#include "BLI_path_util.h"
#include "BLI_string.h"
#include "BLI_utildefines.h"
#include "BKE_image.h" #include "BKE_image.h"
#include "BKE_main.h" #include "BKE_main.h"
#include "BKE_scene.h" #include "BKE_scene.h"
#include "SEQ_iterator.h" #include "SEQ_iterator.h"
#include "SEQ_relations.h" #include "SEQ_relations.h"
#include "SEQ_select.h" #include "SEQ_select.h"
#include "SEQ_sequencer.h" #include "SEQ_sequencer.h"
#include "SEQ_utils.h" #include "SEQ_utils.h"
#include "IMB_imbuf.h" #include "IMB_imbuf.h"
#include "IMB_imbuf_types.h" #include "IMB_imbuf_types.h"
#include "multiview.h" #include "multiview.h"
#include "proxy.h" #include "proxy.h"
#include "utils.h" #include "utils.h"
void SEQ_sort(Scene *scene) /**
* Sort strips in provided seqbase. Effect strips are trailing the list and they are sorted by
* channel position as well.
* This is important for SEQ_time_update_sequence to work properly
*
* \param seqbase: ListBase with strips
*/
void seq_sort_seqbase(ListBase *seqbase)
{ {
/* all strips together per kind, and in order of y location ("machine") */ /* all strips together per kind, and in order of y location ("machine") */
ListBase seqbase, effbase; ListBase inputbase, effbase;
Editing *ed = SEQ_editing_get(scene, false);
Sequence *seq, *seqt; Sequence *seq, *seqt;
if (ed == NULL) { BLI_listbase_clear(&inputbase);
return;
}
BLI_listbase_clear(&seqbase);
BLI_listbase_clear(&effbase); BLI_listbase_clear(&effbase);
while ((seq = BLI_pophead(ed->seqbasep))) { while ((seq = BLI_pophead(seqbase))) {
if (seq->type & SEQ_TYPE_EFFECT) { if (seq->type & SEQ_TYPE_EFFECT) {
seqt = effbase.first; seqt = effbase.first;
while (seqt) { while (seqt) {
if (seqt->machine >= seq->machine) { if (seqt->machine >= seq->machine) {
BLI_insertlinkbefore(&effbase, seqt, seq); BLI_insertlinkbefore(&effbase, seqt, seq);
break; break;
} }
seqt = seqt->next; seqt = seqt->next;
} }
if (seqt == NULL) { if (seqt == NULL) {
BLI_addtail(&effbase, seq); BLI_addtail(&effbase, seq);
} }
} }
else { else {
seqt = seqbase.first; seqt = inputbase.first;
while (seqt) { while (seqt) {
if (seqt->machine >= seq->machine) { if (seqt->machine >= seq->machine) {
BLI_insertlinkbefore(&seqbase, seqt, seq); BLI_insertlinkbefore(&inputbase, seqt, seq);
break; break;
} }
seqt = seqt->next; seqt = seqt->next;
} }
if (seqt == NULL) { if (seqt == NULL) {
BLI_addtail(&seqbase, seq); BLI_addtail(&inputbase, seq);
} }
} }
} }
BLI_movelisttolist(&seqbase, &effbase); BLI_movelisttolist(seqbase, &inputbase);
*(ed->seqbasep) = seqbase; BLI_movelisttolist(seqbase, &effbase);
}
/**
* Sort strips in active seqbase. Effect strips are trailing the list and they are sorted by
* channel position as well.
* This is important for SEQ_time_update_sequence to work properly
*
* \param scene: Scene to look for active seqbase in
*/
void SEQ_sort(Scene *scene)
{
Editing *ed = SEQ_editing_get(scene, false);
if (ed == NULL) {
return;
}
seq_sort_seqbase(SEQ_active_seqbase_get(ed));
} }
typedef struct SeqUniqueInfo { typedef struct SeqUniqueInfo {
Sequence *seq; Sequence *seq;
char name_src[SEQ_NAME_MAXSTR]; char name_src[SEQ_NAME_MAXSTR];
char name_dest[SEQ_NAME_MAXSTR]; char name_dest[SEQ_NAME_MAXSTR];
int count; int count;
int match; int match;
▲ Show 20 Lines • Show All 495 Lines • ▼ Show 20 Linesint SEQ_recursive_apply(Sequence *seq, int (*apply_fn)(Sequence *, void *), void *arg)
} }
if (ret && seq->seqbase.first) { if (ret && seq->seqbase.first) {
ret = SEQ_seqbase_recursive_apply(&seq->seqbase, apply_fn, arg); ret = SEQ_seqbase_recursive_apply(&seq->seqbase, apply_fn, arg);
} }
return ret; return ret;
} }
/**
sergeyUnsubmitted
Done
Inline Actions

Think there is some documentation needed.

For example, it is unclear to me why in some cases ensuring uniqueness of strips will handle animation data (which happens here) and in some cases it will not (in the case of SEQ_sequence_base_unique_name_recursive).

It also seems that this function is always used as a callback for SEQ_recursive_apply. So would suggest making the entire call of SEQ_recursive_apply(seq, SEQ_apply_unique_name_fn, scene); handled here, under a nice clear name :)

sergey: Think there is some documentation needed. For example, it is unclear to me why in some cases…
ISSAuthorUnsubmitted
Done
Inline Actions

Think there is some documentation needed.

I will add docs.

For example, it is unclear to me why in some cases ensuring uniqueness of strips will handle animation data (which happens here) and in some cases it will not (in the case of SEQ_sequence_base_unique_name_recursive).

It also seems that this function is always used as a callback for SEQ_recursive_apply. So would suggest making the entire call of SEQ_recursive_apply(seq, SEQ_apply_unique_name_fn, scene); handled here, under a nice clear name :)

I think there are few things here that would make this change better for separate patch:
SEQ_sequence_base_unique_name_recursive does same thing as SEQ_apply_unique_name_fn, but with no concern for strip animation. From API perspective I don't think that this function should be public. Looking at other places for usage of SEQ_sequence_base_unique_name_recursive, in strip_add.c it is used incorrectly, and in versioning_280.c I think animation handling is missing.

So I would argue, that usage of SEQ_sequence_base_unique_name_recursive should be replaced by SEQ_apply_unique_name_fn after facelift as you proposed with exception of sequencer.c file.

Perhaps seq_sequence_base_unique_name_recursive should be even static and functionality could be provided by same function that does handle animdata, but handling animdata would be optional. So there would be more cleanup.

Here would be my starting point:

P2120 D10209 followup
1diff --cc source/blender/sequencer/intern/utils.c
2index ea53b7dcf00,f8e313e43f5..00000000000
3--- a/source/blender/sequencer/intern/utils.c
4+++ b/source/blender/sequencer/intern/utils.c
5@@@ -132,50 -132,51 +132,72 @@@ static void seqbase_unique_name(ListBas
6 }
7
8 static int seqbase_unique_name_recursive_fn(Sequence *seq, void *arg_pt)
9 {
10 if (seq->seqbase.first) {
11 seqbase_unique_name(&seq->seqbase, (SeqUniqueInfo *)arg_pt);
12 }
13 return 1;
14 }
15
16- void SEQ_sequence_base_unique_name_recursive(ListBase *seqbasep, Sequence *seq)
17 -static void seq_sequence_base_unique_name_recursive(Scene *scene, Sequence *seq)
18++void seq_sequence_base_unique_name_recursive(Scene *scene, Sequence *seq)
19 {
20 SeqUniqueInfo sui;
21 char *dot;
22 sui.seq = seq;
23 BLI_strncpy(sui.name_src, seq->name + 2, sizeof(sui.name_src));
24 BLI_strncpy(sui.name_dest, seq->name + 2, sizeof(sui.name_dest));
25
26 sui.count = 1;
27 sui.match = 1; /* assume the worst to start the loop */
28
29 /* Strip off the suffix */
30 if ((dot = strrchr(sui.name_src, '.'))) {
31 *dot = '\0';
32 dot++;
33
34 if (*dot) {
35 sui.count = atoi(dot) + 1;
36 }
37 }
38
39+ ListBase *seqbase = &scene->ed->seqbase;
40 while (sui.match) {
41 sui.match = 0;
42- seqbase_unique_name(seqbasep, &sui);
43- SEQ_seqbase_recursive_apply(seqbasep, seqbase_unique_name_recursive_fn, &sui);
44+ seqbase_unique_name(seqbase, &sui);
45+ SEQ_seqbase_recursive_apply(seqbase, seqbase_unique_name_recursive_fn, &sui);
46 }
47
48 BLI_strncpy(seq->name + 2, sui.name_dest, sizeof(seq->name) - 2);
49 }
50
51++/**
52++ * Ensure, that provided Sequence has unique name.
53++ *
54++ * \param seq: Sequence which name will be ensured to be unique
55++ * \param scene: Scene in which name must be unique
56++ */
57++void SEQ_ensure_unique_name(Sequence *seq, Scene *scene)
58++{
59++ char name[SEQ_NAME_MAXSTR];
60++
61++ BLI_strncpy_utf8(name, seq->name + 2, sizeof(name));
62++ seq_sequence_base_unique_name_recursive(scene, seq);
63++ SEQ_dupe_animdata(scene, name, seq->name + 2);
64++
65++ if (seq->type == SEQ_TYPE_META) {
66++ LISTBASE_FOREACH (Sequence *, seq_child, &seq->seqbase) {
67++ SEQ_ensure_unique_name(seq_child, scene);
68++ }
69++ }
70++}
71++
72 static const char *give_seqname_by_type(int type)
73 {
74 switch (type) {
75 case SEQ_TYPE_META:
76 return "Meta";
77 case SEQ_TYPE_IMAGE:
78 return "Image";
79 case SEQ_TYPE_SCENE:
80 return "Scene";
81 case SEQ_TYPE_MOVIE:
82@@@ -608,28 -609,25 +630,10 @@@ int SEQ_recursive_apply(Sequence *seq,
83 if (ret == -1) {
84 return -1; /* bail out */
85 }
86
87 if (ret && seq->seqbase.first) {
88 ret = SEQ_seqbase_recursive_apply(&seq->seqbase, apply_fn, arg);
89 }
90
91 return ret;
92 }
93--
94- /**
95- * Ensure, that provided Sequence has unique name. Use as callback for SEQ_recursive_apply()
96- *
97- * \param seq: Sequence which name will be ensured to be unique
98- * \param arg_pt: Scene in which name must be unique
99- * \return always 1, so SEQ_recursive_apply() wont terminate execution prematurely
100- */
101- int SEQ_apply_unique_name_fn(Sequence *seq, void *arg_pt)
102 -void SEQ_ensure_unique_name(Sequence *seq, Scene *scene)
103--{
104- Scene *scene = (Scene *)arg_pt;
105-- char name[SEQ_NAME_MAXSTR];
106--
107-- BLI_strncpy_utf8(name, seq->name + 2, sizeof(name));
108- SEQ_sequence_base_unique_name_recursive(&scene->ed->seqbase, seq);
109 - seq_sequence_base_unique_name_recursive(&scene->ed->seqbase, seq);
110-- SEQ_dupe_animdata(scene, name, seq->name + 2);
111- return 1;
112 -
113 - if (seq->type == SEQ_TYPE_META) {
114 - LISTBASE_FOREACH (Sequence *, seq_child, &seq->seqbase) {
115 - SEQ_ensure_unique_name(seq_child, scene);
116 - }
117 - }
118--}
119diff --git a/source/blender/sequencer/SEQ_utils.h b/source/blender/sequencer/SEQ_utils.h
120index d129f257962..dacf1df462c 100644
121--- a/source/blender/sequencer/SEQ_utils.h
122+++ b/source/blender/sequencer/SEQ_utils.h
123@@ -52,14 +52,14 @@ void SEQ_set_scale_to_fit(const struct Sequence *seq,
124 const int image_height,
125 const int preview_width,
126 const int preview_height,
127 const eSeqImageFitMethod fit_method);
128 int SEQ_seqbase_recursive_apply(struct ListBase *seqbase,
129 int (*apply_fn)(struct Sequence *seq, void *),
130 void *arg);
131 int SEQ_recursive_apply(struct Sequence *seq,
132 int (*apply_fn)(struct Sequence *, void *),
133 void *arg);
134-void SEQ_ensure_unique_name(struct Sequence *seq, Scene *scene, bool handle_animation);
135+void SEQ_ensure_unique_name(struct Sequence *seq, Scene *scene);
136 #ifdef __cplusplus
137 }
138 #endif

ISS: > Think there is some documentation needed. I will add docs. > For example, it is unclear to…
* Ensure, that provided Sequence has unique name. If animation data exists for this Sequence, it
* will be duplicated and mapped onto new name
*
sergeyUnsubmitted
Done
Inline Actions

It can be SEQ_NAME_MAXSTR.

sergey: It can be `SEQ_NAME_MAXSTR`.
* \param seq: Sequence which name will be ensured to be unique
* \param scene: Scene in which name must be unique
*/
void SEQ_ensure_unique_name(Sequence *seq, Scene *scene)
{
char name[SEQ_NAME_MAXSTR];
BLI_strncpy_utf8(name, seq->name + 2, sizeof(name));
SEQ_sequence_base_unique_name_recursive(&scene->ed->seqbase, seq);
SEQ_dupe_animdata(scene, name, seq->name + 2);
if (seq->type == SEQ_TYPE_META) {
LISTBASE_FOREACH (Sequence *, seq_child, &seq->seqbase) {
SEQ_ensure_unique_name(seq_child, scene);
}
}
}