== Sequencer ==
[blender.git] / source / blender / editors / space_sequencer / sequencer_add.c
1 /**
2  *
3  * ***** BEGIN GPL LICENSE BLOCK *****
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU General Public License
7  * as published by the Free Software Foundation; either version 2
8  * of the License, or (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software Foundation,
17  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
18  *
19  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
20  * All rights reserved.
21  *
22  * Contributor(s): Blender Foundation, 2003-2009, Campbell Barton
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26
27 #include <stdlib.h>
28 #include <math.h>
29 #include <string.h>
30
31 #ifndef WIN32
32 #include <unistd.h>
33 #else
34 #include <io.h>
35 #endif
36 #include <sys/types.h>
37
38 #include "MEM_guardedalloc.h"
39
40 #include "BLI_blenlib.h"
41 #include "BLI_math.h"
42 #include "BLI_storage_types.h"
43
44 #include "IMB_imbuf_types.h"
45 #include "IMB_imbuf.h"
46
47 #include "DNA_ipo_types.h"
48 #include "DNA_curve_types.h"
49 #include "DNA_scene_types.h"
50 #include "DNA_screen_types.h"
51 #include "DNA_space_types.h"
52 #include "DNA_sequence_types.h"
53 #include "DNA_view2d_types.h"
54 #include "DNA_userdef_types.h"
55 #include "DNA_sound_types.h"
56
57 #include "BKE_context.h"
58 #include "BKE_global.h"
59 #include "BKE_image.h"
60 #include "BKE_library.h"
61 #include "BKE_main.h"
62 #include "BKE_plugin_types.h"
63 #include "BKE_sequence.h"
64 #include "BKE_scene.h"
65 #include "BKE_utildefines.h"
66 #include "BKE_report.h"
67
68 #include "BIF_gl.h"
69 #include "BIF_glutil.h"
70
71 #include "WM_api.h"
72 #include "WM_types.h"
73
74 #include "RNA_access.h"
75 #include "RNA_define.h"
76
77 /* for menu/popup icons etc etc*/
78 #include "UI_interface.h"
79 #include "UI_resources.h"
80
81 #include "ED_anim_api.h"
82 #include "ED_space_api.h"
83 #include "ED_types.h"
84 #include "ED_screen.h"
85 #include "ED_util.h"
86 #include "ED_fileselect.h"
87
88 #include "UI_interface.h"
89 #include "UI_resources.h"
90 #include "UI_view2d.h"
91
92 #include "BKE_sound.h"
93 #include "AUD_C-API.h"
94
95 /* own include */
96 #include "sequencer_intern.h"
97
98 /* Generic functions, reused by add strip operators */
99
100 /* avoid passing multiple args and be more verbose */
101 #define SEQPROP_STARTFRAME      1<<0
102 #define SEQPROP_ENDFRAME        1<<1
103 #define SEQPROP_FILES           1<<2
104
105 static void sequencer_generic_props__internal(wmOperatorType *ot, int flag)
106 {
107         RNA_def_string(ot->srna, "name", "", MAX_ID_NAME-2, "Name", "Name of the new sequence strip");
108
109         if(flag & SEQPROP_STARTFRAME)
110                 RNA_def_int(ot->srna, "start_frame", 0, INT_MIN, INT_MAX, "Start Frame", "Start frame of the sequence strip", INT_MIN, INT_MAX);
111         
112         if(flag & SEQPROP_ENDFRAME)
113                 RNA_def_int(ot->srna, "end_frame", 0, INT_MIN, INT_MAX, "End Frame", "End frame for the color strip", INT_MIN, INT_MAX); /* not useual since most strips have a fixed length */
114         
115         RNA_def_int(ot->srna, "channel", 1, 1, MAXSEQ, "Channel", "Channel to place this strip into", 1, MAXSEQ);
116         
117         RNA_def_boolean(ot->srna, "replace_sel", 1, "Replace Selection", "replace the current selection");
118
119         if(flag & SEQPROP_FILES)
120                 RNA_def_collection_runtime(ot->srna, "files", &RNA_OperatorFileListElement, "Files", "");
121 }
122
123 static void sequencer_generic_invoke_xy__internal(bContext *C, wmOperator *op, wmEvent *event, int flag)
124 {
125         ARegion *ar= CTX_wm_region(C);
126         View2D *v2d= UI_view2d_fromcontext(C);
127         
128         short mval[2];  
129         float mval_v2d[2];
130         
131
132         mval[0]= event->x - ar->winrct.xmin;
133         mval[1]= event->y - ar->winrct.ymin;
134         
135         UI_view2d_region_to_view(v2d, mval[0], mval[1], &mval_v2d[0], &mval_v2d[1]);
136         
137         RNA_int_set(op->ptr, "channel", (int)mval_v2d[1]+0.5f);
138         RNA_int_set(op->ptr, "start_frame", (int)mval_v2d[0]);
139         
140         if ((flag & SEQPROP_ENDFRAME) && RNA_property_is_set(op->ptr, "end_frame")==0)
141                 RNA_int_set(op->ptr, "end_frame", (int)mval_v2d[0] + 25); // XXX arbitary but ok for now.
142         
143 }
144
145 static void seq_load_operator_info(SeqLoadInfo *seq_load, wmOperator *op)
146 {
147         memset(seq_load, 0, sizeof(SeqLoadInfo));
148
149         seq_load->start_frame=  RNA_int_get(op->ptr, "start_frame");
150         seq_load->channel=              RNA_int_get(op->ptr, "channel");
151         seq_load->len=                  1; // images only!
152
153         RNA_string_get(op->ptr, "name", seq_load->name);
154
155         RNA_string_get(op->ptr, "path", seq_load->path); /* full path, file is set by the caller */
156
157         if (RNA_struct_find_property(op->ptr, "replace_sel") && RNA_boolean_get(op->ptr, "replace_sel"))
158                 seq_load->flag |= SEQ_LOAD_REPLACE_SEL;
159
160         if (RNA_struct_find_property(op->ptr, "cache") && RNA_boolean_get(op->ptr, "cache"))
161                 seq_load->flag |= SEQ_LOAD_SOUND_CACHE;
162
163         if (RNA_struct_find_property(op->ptr, "sound") && RNA_boolean_get(op->ptr, "sound"))
164                 seq_load->flag |= SEQ_LOAD_MOVIE_SOUND;
165
166         /* always use this for ops */
167         seq_load->flag |= SEQ_LOAD_FRAME_ADVANCE;
168 }
169
170 /* add scene operator */
171 static int sequencer_add_scene_strip_exec(bContext *C, wmOperator *op)
172 {
173         Scene *scene= CTX_data_scene(C);
174         Editing *ed= seq_give_editing(scene, TRUE);
175         
176         Scene *sce_seq;
177         char sce_name[MAX_ID_NAME-2];
178         
179         Sequence *seq;  /* generic strip vars */
180         Strip *strip;
181         StripElem *se;
182         
183         int start_frame, channel; /* operator props */
184         
185         start_frame= RNA_int_get(op->ptr, "start_frame");
186         channel= RNA_int_get(op->ptr, "channel");
187         
188         RNA_string_get(op->ptr, "scene", sce_name);
189
190         sce_seq= (Scene *)find_id("SC", sce_name);
191         
192         if (sce_seq==NULL) {
193                 BKE_reportf(op->reports, RPT_ERROR, "Scene \"%s\" not found", sce_name);
194                 return OPERATOR_CANCELLED;
195         }
196         
197         seq = alloc_sequence(ed->seqbasep, start_frame, channel);
198         
199         seq->type= SEQ_SCENE;
200         seq->scene= sce_seq;
201         
202         /* basic defaults */
203         seq->strip= strip= MEM_callocN(sizeof(Strip), "strip");
204         strip->len = seq->len = sce_seq->r.efra - sce_seq->r.sfra + 1;
205         strip->us= 1;
206         
207         strip->stripdata= se= MEM_callocN(seq->len*sizeof(StripElem), "stripelem");
208         
209         
210         RNA_string_get(op->ptr, "name", seq->name);
211         
212         calc_sequence_disp(seq);
213         sort_seq(scene);
214         
215         if (RNA_boolean_get(op->ptr, "replace_sel")) {
216                 deselect_all_seq(scene);
217                 active_seq_set(scene, seq);
218                 seq->flag |= SELECT;
219         }
220         
221         ED_area_tag_redraw(CTX_wm_area(C));
222         
223         return OPERATOR_FINISHED;
224 }
225
226
227 static int sequencer_add_scene_strip_invoke(bContext *C, wmOperator *op, wmEvent *event)
228 {
229         sequencer_generic_invoke_xy__internal(C, op, event, 0);
230         
231         /* scene can be left default */
232         RNA_string_set(op->ptr, "scene", "Scene"); // XXX should popup a menu but ton says 2.5 will have some better feature for this
233
234         return sequencer_add_scene_strip_exec(C, op);
235 }
236
237
238 void SEQUENCER_OT_scene_strip_add(struct wmOperatorType *ot)
239 {
240         
241         /* identifiers */
242         ot->name= "Add Scene Strip";
243         ot->idname= "SEQUENCER_OT_scene_strip_add";
244         ot->description= "Add a strip to the sequencer using a blender scene as a source";
245
246         /* api callbacks */
247         ot->invoke= sequencer_add_scene_strip_invoke;
248         ot->exec= sequencer_add_scene_strip_exec;
249
250         ot->poll= ED_operator_sequencer_active;
251         
252         /* flags */
253         ot->flag= OPTYPE_REGISTER|OPTYPE_UNDO;
254         
255         sequencer_generic_props__internal(ot, SEQPROP_STARTFRAME);
256         RNA_def_string(ot->srna, "scene", "", MAX_ID_NAME-2, "Scene Name", "Scene name to add as a strip");
257 }
258
259 static int sequencer_add_generic_strip_exec(bContext *C, wmOperator *op, SeqLoadFunc seq_load_func)
260 {
261         Scene *scene= CTX_data_scene(C); /* only for sound */
262         Editing *ed= seq_give_editing(scene, TRUE);
263         SeqLoadInfo seq_load;
264         Sequence *seq;
265         int tot_files;
266
267         seq_load_operator_info(&seq_load, op);
268
269         if (seq_load.flag & SEQ_LOAD_REPLACE_SEL)
270                 deselect_all_seq(scene);
271
272         tot_files= RNA_property_collection_length(op->ptr, RNA_struct_find_property(op->ptr, "files"));
273
274         if(tot_files) {
275                 /* multiple files */
276                 char dir_only[FILE_MAX];
277                 char file_only[FILE_MAX];
278
279                 BLI_split_dirfile_basic(seq_load.path, dir_only, NULL);
280
281                 RNA_BEGIN(op->ptr, itemptr, "files") {
282                         RNA_string_get(&itemptr, "name", file_only);
283                         BLI_join_dirfile(seq_load.path, dir_only, file_only);
284
285                         seq= seq_load_func(C, ed->seqbasep, &seq_load);
286                 }
287                 RNA_END;
288         }
289         else {
290                 /* single file */
291                 seq= seq_load_func(C, ed->seqbasep, &seq_load);
292         }
293
294         if (seq_load.tot_success==0) {
295                 BKE_reportf(op->reports, RPT_ERROR, "File \"%s\" could not be loaded", seq_load.path);
296                 return OPERATOR_CANCELLED;
297         }
298
299         sort_seq(scene);
300
301         ED_area_tag_redraw(CTX_wm_area(C));
302
303         return OPERATOR_FINISHED;
304 }
305
306 /* add movie operator */
307 static int sequencer_add_movie_strip_exec(bContext *C, wmOperator *op)
308 {
309         return sequencer_add_generic_strip_exec(C, op, sequencer_add_movie_strip);
310 }
311
312
313 static int sequencer_add_movie_strip_invoke(bContext *C, wmOperator *op, wmEvent *event)
314 {       
315         sequencer_generic_invoke_xy__internal(C, op, event, 0);
316         return WM_operator_filesel(C, op, event);
317         //return sequencer_add_movie_strip_exec(C, op);
318 }
319
320
321 void SEQUENCER_OT_movie_strip_add(struct wmOperatorType *ot)
322 {
323         
324         /* identifiers */
325         ot->name= "Add Movie Strip";
326         ot->idname= "SEQUENCER_OT_movie_strip_add";
327         ot->description= "Add a movie strip to the sequencer";
328
329         /* api callbacks */
330         ot->invoke= sequencer_add_movie_strip_invoke;
331         ot->exec= sequencer_add_movie_strip_exec;
332
333         ot->poll= ED_operator_sequencer_active;
334         
335         /* flags */
336         ot->flag= OPTYPE_REGISTER|OPTYPE_UNDO;
337         
338         WM_operator_properties_filesel(ot, FOLDERFILE|MOVIEFILE, FILE_SPECIAL);
339         sequencer_generic_props__internal(ot, SEQPROP_STARTFRAME|SEQPROP_FILES);
340         RNA_def_boolean(ot->srna, "sound", TRUE, "Sound", "Load sound with the movie");
341 }
342
343 /* add sound operator */
344
345 static int sequencer_add_sound_strip_exec(bContext *C, wmOperator *op)
346 {
347         return sequencer_add_generic_strip_exec(C, op, sequencer_add_sound_strip);
348 }
349
350 static int sequencer_add_sound_strip_invoke(bContext *C, wmOperator *op, wmEvent *event)
351 {       
352         sequencer_generic_invoke_xy__internal(C, op, event, 0);
353         return WM_operator_filesel(C, op, event);
354         //return sequencer_add_sound_strip_exec(C, op);
355 }
356
357
358 void SEQUENCER_OT_sound_strip_add(struct wmOperatorType *ot)
359 {
360         
361         /* identifiers */
362         ot->name= "Add Sound Strip";
363         ot->idname= "SEQUENCER_OT_sound_strip_add";
364         ot->description= "Add a sound strip to the sequencer";
365
366         /* api callbacks */
367         ot->invoke= sequencer_add_sound_strip_invoke;
368         ot->exec= sequencer_add_sound_strip_exec;
369
370         ot->poll= ED_operator_sequencer_active;
371         
372         /* flags */
373         ot->flag= OPTYPE_REGISTER|OPTYPE_UNDO;
374         
375         WM_operator_properties_filesel(ot, FOLDERFILE|SOUNDFILE, FILE_SPECIAL);
376         sequencer_generic_props__internal(ot, SEQPROP_STARTFRAME|SEQPROP_FILES);
377         RNA_def_boolean(ot->srna, "cache", FALSE, "Cache", "Cache the sound in memory.");
378 }
379
380 /* add image operator */
381 static int sequencer_add_image_strip_exec(bContext *C, wmOperator *op)
382 {
383         /* cant use the generic function for this */
384
385         Scene *scene= CTX_data_scene(C); /* only for sound */
386         Editing *ed= seq_give_editing(scene, TRUE);
387         SeqLoadInfo seq_load;
388         Sequence *seq;
389
390         Strip *strip;
391         StripElem *se;
392
393         seq_load_operator_info(&seq_load, op);
394
395         /* images are unique in how they handle this - 1 per strip elem */
396         seq_load.len= RNA_property_collection_length(op->ptr, RNA_struct_find_property(op->ptr, "files"));
397
398         if(seq_load.len==0)
399                 seq_load.len= 1;
400
401         if(seq_load.flag & SEQ_LOAD_REPLACE_SEL)
402                 deselect_all_seq(scene);
403
404         
405         /* main adding function */
406         seq= sequencer_add_image_strip(C, ed->seqbasep, &seq_load);
407         strip= seq->strip;
408         se= strip->stripdata;
409
410         if(seq_load.len > 1) {
411                 RNA_BEGIN(op->ptr, itemptr, "files") {
412                         RNA_string_get(&itemptr, "name", se->name);
413                         se++;
414                 }
415                 RNA_END;
416         }
417         else {
418                 BLI_split_dirfile_basic(seq_load.path, NULL, se->name);
419         }
420         
421         calc_sequence_disp(seq);
422
423         sort_seq(scene);
424
425         /* last active name */
426         strncpy(ed->act_imagedir, strip->dir, FILE_MAXDIR-1);
427         
428         ED_area_tag_redraw(CTX_wm_area(C));
429
430         return OPERATOR_FINISHED;
431 }
432
433 static int sequencer_add_image_strip_invoke(bContext *C, wmOperator *op, wmEvent *event)
434 {
435         sequencer_generic_invoke_xy__internal(C, op, event, 0);
436         return WM_operator_filesel(C, op, event);       
437         //return sequencer_add_image_strip_exec(C, op);
438 }
439
440
441 void SEQUENCER_OT_image_strip_add(struct wmOperatorType *ot)
442 {
443         
444         /* identifiers */
445         ot->name= "Add Image Strip";
446         ot->idname= "SEQUENCER_OT_image_strip_add";
447         ot->description= "Add an image or image sequence to the sequencer";
448
449         /* api callbacks */
450         ot->invoke= sequencer_add_image_strip_invoke;
451         ot->exec= sequencer_add_image_strip_exec;
452
453         ot->poll= ED_operator_sequencer_active;
454         
455         /* flags */
456         ot->flag= OPTYPE_REGISTER|OPTYPE_UNDO;
457         
458         WM_operator_properties_filesel(ot, FOLDERFILE|IMAGEFILE, FILE_SPECIAL);
459         sequencer_generic_props__internal(ot, SEQPROP_STARTFRAME|SEQPROP_FILES);
460 }
461
462
463 /* add_effect_strip operator */
464 static int sequencer_add_effect_strip_exec(bContext *C, wmOperator *op)
465 {
466         Scene *scene= CTX_data_scene(C);
467         Editing *ed= seq_give_editing(scene, TRUE);
468
469         Sequence *seq;  /* generic strip vars */
470         Strip *strip;
471         StripElem *se;
472         struct SeqEffectHandle sh;
473
474         int start_frame, end_frame, channel, type; /* operator props */
475         
476         Sequence *seq1, *seq2, *seq3;
477         char *error_msg;
478
479         start_frame= RNA_int_get(op->ptr, "start_frame");
480         end_frame= RNA_int_get(op->ptr, "end_frame");
481         channel= RNA_int_get(op->ptr, "channel");
482
483         type= RNA_enum_get(op->ptr, "type");
484         
485         // XXX We need unique names and move to invoke
486         if(!seq_effect_find_selected(scene, NULL, type, &seq1, &seq2, &seq3, &error_msg)) {
487                 BKE_report(op->reports, RPT_ERROR, error_msg);
488                 return OPERATOR_CANCELLED;
489         }
490
491         /* If seq1 is NULL and no error was rasied it means the seq is standalone
492          * (like color strips) and we need to check its start and end frames are valid */
493         if (seq1==NULL && end_frame <= start_frame) {
494                 BKE_report(op->reports, RPT_ERROR, "Start and end frame are not set");
495                 return OPERATOR_CANCELLED;
496         }
497
498         seq = alloc_sequence(ed->seqbasep, start_frame, channel);
499         seq->type= type;
500
501         seqUniqueName(ed->seqbasep, seq);
502
503         sh = get_sequence_effect(seq);
504
505         seq->seq1= seq1;
506         seq->seq2= seq2;
507         seq->seq3= seq3;
508
509         sh.init(seq);
510
511         if (!seq1) { /* effect has no deps */
512                 seq->len= 1;
513                 seq_tx_set_final_right(seq, end_frame);
514         }
515
516         seq->flag |= SEQ_USE_EFFECT_DEFAULT_FADE;
517
518         calc_sequence(seq);
519         
520         /* basic defaults */
521         seq->strip= strip= MEM_callocN(sizeof(Strip), "strip");
522         strip->len = seq->len;
523         strip->us= 1;
524         if(seq->len>0)
525                 strip->stripdata= se= MEM_callocN(seq->len*sizeof(StripElem), "stripelem");
526
527         if (seq->type==SEQ_PLUGIN) {
528                 char path[FILE_MAX];
529                 RNA_string_get(op->ptr, "path", path);
530
531                 sh.init_plugin(seq, path);
532
533                 if(seq->plugin==NULL) {
534                         BLI_remlink(ed->seqbasep, seq);
535                         seq_free_sequence(scene, seq);
536                         BKE_reportf(op->reports, RPT_ERROR, "Sequencer plugin \"%s\" could not load.", path);
537                         return OPERATOR_CANCELLED;
538                 }
539         }
540         else if (seq->type==SEQ_COLOR) {
541                 SolidColorVars *colvars= (SolidColorVars *)seq->effectdata;
542                 RNA_float_get_array(op->ptr, "color", colvars->col);
543         }
544
545         if(seq_test_overlap(ed->seqbasep, seq)) shuffle_seq(ed->seqbasep, seq);
546
547         update_changed_seq_and_deps(scene, seq, 1, 1); /* runs calc_sequence */
548
549
550         /* not sure if this is needed with update_changed_seq_and_deps.
551          * it was NOT called in blender 2.4x, but wont hurt */
552         sort_seq(scene); 
553
554         if (RNA_boolean_get(op->ptr, "replace_sel")) {
555                 deselect_all_seq(scene);
556                 active_seq_set(scene, seq);
557                 seq->flag |= SELECT;
558         }
559
560         ED_area_tag_redraw(CTX_wm_area(C));
561         return OPERATOR_FINISHED;
562 }
563
564
565 /* add color */
566 static int sequencer_add_effect_strip_invoke(bContext *C, wmOperator *op, wmEvent *event)
567 {
568         sequencer_generic_invoke_xy__internal(C, op, event, SEQPROP_ENDFRAME);
569
570         if (RNA_property_is_set(op->ptr, "type") && RNA_enum_get(op->ptr, "type")==SEQ_PLUGIN) {
571                 /* only plugins need the file selector */
572                 return WM_operator_filesel(C, op, event);
573         }
574         else {
575                 return sequencer_add_effect_strip_exec(C, op);
576         }
577 }
578
579 void SEQUENCER_OT_effect_strip_add(struct wmOperatorType *ot)
580 {
581         /* identifiers */
582         ot->name= "Add Effect Strip";
583         ot->idname= "SEQUENCER_OT_effect_strip_add";
584         ot->description= "Add an effect to the sequencer, most are applied on top of existing strips";
585
586         /* api callbacks */
587         ot->invoke= sequencer_add_effect_strip_invoke;
588         ot->exec= sequencer_add_effect_strip_exec;
589
590         ot->poll= ED_operator_sequencer_active;
591         
592         /* flags */
593         ot->flag= OPTYPE_REGISTER|OPTYPE_UNDO;
594         
595         WM_operator_properties_filesel(ot, 0, FILE_SPECIAL);
596         sequencer_generic_props__internal(ot, SEQPROP_STARTFRAME|SEQPROP_ENDFRAME);
597         RNA_def_enum(ot->srna, "type", sequencer_prop_effect_types, SEQ_CROSS, "Type", "Sequencer effect type");
598         RNA_def_float_vector(ot->srna, "color", 3, NULL, 0.0f, 1.0f, "Color", "Initialize the strip with this color (only used when type='COLOR')", 0.0f, 1.0f);
599 }