doxygen: add newline after \file
[blender.git] / source / blender / editors / space_sequencer / sequencer_intern.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2008 Blender Foundation.
17  * All rights reserved.
18  */
19
20 /** \file
21  * \ingroup spseq
22  */
23
24 #ifndef __SEQUENCER_INTERN_H__
25 #define __SEQUENCER_INTERN_H__
26
27 #include "RNA_access.h"
28 #include "DNA_sequence_types.h"
29
30 /* internal exports only */
31
32 struct ARegion;
33 struct ARegionType;
34 struct Depsgraph;
35 struct Main;
36 struct Scene;
37 struct ScrArea;
38 struct Sequence;
39 struct SpaceSeq;
40 struct StripElem;
41 struct bContext;
42 struct rctf;
43 struct wmOperator;
44
45 /* space_sequencer.c */
46 struct ARegion *sequencer_has_buttons_region(struct ScrArea *sa);
47
48
49 /* sequencer_draw.c */
50 void draw_timeline_seq(const struct bContext *C, struct ARegion *ar);
51 void draw_image_seq(const struct bContext *C, struct Scene *scene, struct  ARegion *ar, struct SpaceSeq *sseq, int cfra, int offset, bool draw_overlay, bool draw_backdrop);
52 void color3ubv_from_seq(struct Scene *curscene, struct Sequence *seq, unsigned char col[3]);
53
54 void sequencer_special_update_set(Sequence *seq);
55
56 /* UNUSED */
57 // void seq_reset_imageofs(struct SpaceSeq *sseq);
58
59 struct ImBuf *sequencer_ibuf_get(struct Main *bmain, struct Depsgraph *depsgraph, struct Scene *scene, struct SpaceSeq *sseq, int cfra, int frame_ofs, const char *viewname);
60
61 /* sequencer_edit.c */
62 struct View2D;
63 void seq_rectf(struct Sequence *seq, struct rctf *rectf);
64 void boundbox_seq(struct Scene *scene, struct rctf *rect);
65 struct Sequence *find_nearest_seq(struct Scene *scene, struct View2D *v2d, int *hand, const int mval[2]);
66 struct Sequence *find_neighboring_sequence(struct Scene *scene, struct Sequence *test, int lr, int sel);
67 void recurs_sel_seq(struct Sequence *seqm);
68 int seq_effect_find_selected(struct Scene *scene, struct Sequence *activeseq, int type, struct Sequence **selseq1, struct Sequence **selseq2, struct Sequence **selseq3, const char **error_str);
69
70 /* operator helpers */
71 bool sequencer_edit_poll(struct bContext *C);
72 /* UNUSED */
73 //bool sequencer_strip_poll(struct bContext *C);
74 bool sequencer_strip_has_path_poll(struct bContext *C);
75 bool sequencer_view_preview_poll(struct bContext *C);
76 bool sequencer_view_strips_poll(struct bContext *C);
77
78 /* externs */
79 extern EnumPropertyItem sequencer_prop_effect_types[];
80 extern EnumPropertyItem prop_side_types[];
81
82 /* operators */
83 struct wmKeyConfig;
84 struct wmOperatorType;
85
86 void SEQUENCER_OT_cut(struct wmOperatorType *ot);
87 void SEQUENCER_OT_slip(struct wmOperatorType *ot);
88 void SEQUENCER_OT_mute(struct wmOperatorType *ot);
89 void SEQUENCER_OT_unmute(struct wmOperatorType *ot);
90 void SEQUENCER_OT_lock(struct wmOperatorType *ot);
91 void SEQUENCER_OT_unlock(struct wmOperatorType *ot);
92 void SEQUENCER_OT_reload(struct wmOperatorType *ot);
93 void SEQUENCER_OT_refresh_all(struct wmOperatorType *ot);
94 void SEQUENCER_OT_reassign_inputs(struct wmOperatorType *ot);
95 void SEQUENCER_OT_swap_inputs(struct wmOperatorType *ot);
96 void SEQUENCER_OT_duplicate(struct wmOperatorType *ot);
97 void SEQUENCER_OT_delete(struct wmOperatorType *ot);
98 void SEQUENCER_OT_offset_clear(struct wmOperatorType *ot);
99 void SEQUENCER_OT_images_separate(struct wmOperatorType *ot);
100 void SEQUENCER_OT_meta_toggle(struct wmOperatorType *ot);
101 void SEQUENCER_OT_meta_make(struct wmOperatorType *ot);
102 void SEQUENCER_OT_meta_separate(struct wmOperatorType *ot);
103
104 void SEQUENCER_OT_gap_remove(struct wmOperatorType *ot);
105 void SEQUENCER_OT_gap_insert(struct wmOperatorType *ot);
106 void SEQUENCER_OT_snap(struct wmOperatorType *ot);
107
108 void SEQUENCER_OT_strip_jump(struct wmOperatorType *ot);
109 void SEQUENCER_OT_swap(struct wmOperatorType *ot);
110 void SEQUENCER_OT_swap_data(struct wmOperatorType *ot);
111 void SEQUENCER_OT_rendersize(struct wmOperatorType *ot);
112
113 void SEQUENCER_OT_view_toggle(struct wmOperatorType *ot);
114 void SEQUENCER_OT_view_all(struct wmOperatorType *ot);
115 void SEQUENCER_OT_view_selected(struct wmOperatorType *ot);
116 void SEQUENCER_OT_view_frame(struct wmOperatorType *ot);
117 void SEQUENCER_OT_view_zoom_ratio(struct wmOperatorType *ot);
118 void SEQUENCER_OT_view_ghost_border(struct wmOperatorType *ot);
119
120 void SEQUENCER_OT_change_effect_input(struct wmOperatorType *ot);
121 void SEQUENCER_OT_change_effect_type(struct wmOperatorType *ot);
122 void SEQUENCER_OT_change_path(struct wmOperatorType *ot);
123
124 void SEQUENCER_OT_copy(struct wmOperatorType *ot);
125 void SEQUENCER_OT_paste(struct wmOperatorType *ot);
126
127 void SEQUENCER_OT_rebuild_proxy(struct wmOperatorType *ot);
128 void SEQUENCER_OT_enable_proxies(struct wmOperatorType *ot);
129
130 void SEQUENCER_OT_export_subtitles(struct wmOperatorType *ot);
131
132 /* preview specific operators */
133 void SEQUENCER_OT_view_all_preview(struct wmOperatorType *ot);
134
135 /* sequencer_select.c */
136 void SEQUENCER_OT_select_all(struct wmOperatorType *ot);
137 void SEQUENCER_OT_select(struct wmOperatorType *ot);
138 void SEQUENCER_OT_select_more(struct wmOperatorType *ot);
139 void SEQUENCER_OT_select_less(struct wmOperatorType *ot);
140 void SEQUENCER_OT_select_linked(struct wmOperatorType *ot);
141 void SEQUENCER_OT_select_linked_pick(struct wmOperatorType *ot);
142 void SEQUENCER_OT_select_handles(struct wmOperatorType *ot);
143 void SEQUENCER_OT_select_active_side(struct wmOperatorType *ot);
144 void SEQUENCER_OT_select_box(struct wmOperatorType *ot);
145 void SEQUENCER_OT_select_inverse(struct wmOperatorType *ot);
146 void SEQUENCER_OT_select_grouped(struct wmOperatorType *ot);
147
148 /* sequencer_select.c */
149 void SEQUENCER_OT_scene_strip_add(struct wmOperatorType *ot);
150 void SEQUENCER_OT_movie_strip_add(struct wmOperatorType *ot);
151 void SEQUENCER_OT_movieclip_strip_add(struct wmOperatorType *ot);
152 void SEQUENCER_OT_mask_strip_add(struct wmOperatorType *ot);
153 void SEQUENCER_OT_sound_strip_add(struct wmOperatorType *ot);
154 void SEQUENCER_OT_image_strip_add(struct wmOperatorType *ot);
155 void SEQUENCER_OT_effect_strip_add(struct wmOperatorType *ot);
156
157 enum {
158         SEQ_CUT_SOFT,
159         SEQ_CUT_HARD,
160 };
161 enum {
162         SEQ_SELECTED,
163         SEQ_UNSELECTED,
164 };
165
166 enum {
167         SEQ_SELECT_LR_NONE = 0,
168         SEQ_SELECT_LR_MOUSE,
169         SEQ_SELECT_LR_LEFT,
170         SEQ_SELECT_LR_RIGHT,
171 };
172
173 /* defines used internally */
174 #define SCE_MARKERS 0 // XXX - dummy
175
176 /* sequencer_ops.c */
177 void sequencer_operatortypes(void);
178 void sequencer_keymap(struct wmKeyConfig *keyconf);
179
180 /* sequencer_scope.c */
181 struct ImBuf *make_waveform_view_from_ibuf(struct ImBuf *ibuf);
182 struct ImBuf *make_sep_waveform_view_from_ibuf(struct ImBuf *ibuf);
183 struct ImBuf *make_vectorscope_view_from_ibuf(struct ImBuf *ibuf);
184 struct ImBuf *make_zebra_view_from_ibuf(struct ImBuf *ibuf, float perc);
185 struct ImBuf *make_histogram_view_from_ibuf(struct ImBuf *ibuf);
186
187 /* sequencer_buttons.c */
188 void sequencer_buttons_register(struct ARegionType *art);
189 void SEQUENCER_OT_properties(struct wmOperatorType *ot);
190
191 /* sequencer_modifiers.c */
192 void SEQUENCER_OT_strip_modifier_add(struct wmOperatorType *ot);
193 void SEQUENCER_OT_strip_modifier_remove(struct wmOperatorType *ot);
194 void SEQUENCER_OT_strip_modifier_move(struct wmOperatorType *ot);
195 void SEQUENCER_OT_strip_modifier_copy(struct wmOperatorType *ot);
196
197 /* sequencer_view.c */
198 void SEQUENCER_OT_sample(struct wmOperatorType *ot);
199
200 /* sequencer_preview.c */
201 void sequencer_preview_add_sound(const struct bContext *C, struct Sequence *seq);
202
203 /* sequencer_add */
204 int sequencer_image_seq_get_minmax_frame(struct wmOperator *op, int sfra, int *r_minframe, int *r_numdigits);
205 void sequencer_image_seq_reserve_frames(struct wmOperator *op, struct StripElem *se, int len, int minframe, int numdigits);
206
207 #endif /* __SEQUENCER_INTERN_H__ */