3 * Copyright (C) 1997-2014 Adam Williams <broadcast at earthling dot net>
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
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.
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
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
27 #include "apatchgui.h"
28 #include "arraylist.h"
31 #include "audiodevice.inc"
33 #include "awindow.inc"
34 #include "batchrender.inc"
35 #include "bcwindowbase.inc"
36 #include "bdcreate.inc"
37 #include "brender.inc"
39 #include "channel.inc"
40 #include "channeldb.inc"
41 #include "commercials.inc"
42 #include "cwindow.inc"
44 #include "devicedvbinput.inc"
45 #include "devicempeginput.inc"
46 #include "dvdcreate.inc"
49 #include "edlsession.inc"
50 #include "exportedl.inc"
51 #include "filesystem.inc"
52 #include "filexml.inc"
53 #include "framecache.inc"
54 #include "gwindow.inc"
55 #include "indexable.inc"
56 #include "keyframegui.inc"
57 #include "levelwindow.inc"
58 #include "loadmode.inc"
59 #include "mainerror.inc"
60 #include "mainindexes.inc"
61 #include "mainprogress.inc"
62 #include "mainsession.inc"
63 #include "mainundo.inc"
64 #include "maxchannels.h"
66 #include "mwindow.inc"
67 #include "mwindowgui.inc"
69 #include "patchbay.inc"
70 #include "playback3d.inc"
71 #include "playbackengine.inc"
73 #include "pluginfclient.inc"
74 #include "pluginserver.inc"
75 #include "pluginset.inc"
76 #include "preferences.inc"
77 #include "preferencesthread.inc"
79 #include "recordlabel.inc"
81 #include "sharedlocation.inc"
82 #include "sighandler.inc"
83 #include "splashgui.inc"
86 #include "threadloader.inc"
87 #include "timebar.inc"
89 #include "tipwindow.inc"
91 #include "tracking.inc"
93 #include "transition.inc"
94 #include "transportque.inc"
95 #include "videowindow.inc"
96 #include "vpatchgui.h"
97 #include "vwindow.inc"
98 #include "zwindow.inc"
99 #include "wwindow.inc"
100 #include "wavecache.inc"
102 #define FONT_SEARCHPATH "fonts"
104 // All entry points for commands except for window locking should be here.
105 // This allows scriptability.
107 class MWindow : public Thread
113 // ======================================== initialization commands
114 void create_objects(int want_gui,
122 int run_script(FileXML *script);
124 int delete_project(int flash = 1);
126 int restart() { return restart_status; }
130 int set_filename(const char *filename);
131 // Total vertical pixels in timeline
132 int get_tracks_height();
133 // Total horizontal pixels in timeline
134 int get_tracks_width();
142 int tile_windows(int window_config);
143 char *get_cwindow_display();
144 // void set_titles(int value);
145 void set_screens(int value);
146 int asset_to_edl(EDL *new_edl,
148 RecordLabels *labels = 0);
149 // Convert nested_edl to a nested EDL in new_edl
150 // suitable for pasting in paste_edls
151 int edl_to_nested(EDL *new_edl,
154 // Entry point to insert assets and insert edls. Called by TrackCanvas
155 // and AssetPopup when assets are dragged in from AWindow.
156 // Takes the drag vectors from MainSession and
157 // pastes either assets or clips depending on which is full.
158 // Returns 1 if the vectors were full
159 int paste_assets(double position, Track *dest_track, int overwrite);
161 // Insert the assets at a point in the EDL. Called by menueffects,
162 // render, and CWindow drop but recording calls paste_edls directly for
164 void load_assets(ArrayList<Indexable*> *new_assets,
167 Track *first_track /* = 0 */,
168 RecordLabels *labels /* = 0 */,
173 int paste_edls(ArrayList<EDL*> *new_edls,
175 Track *first_track /* = 0 */,
176 double current_position /* = -1 */,
181 // Reset everything for a load
182 void update_project(int load_mode);
183 // Fit selected time to horizontal display range
184 void fit_selection();
185 // Fit selected autos to the vertical display range
186 void fit_autos(int doall);
187 void change_currentautorange(int autogrouptype, int increment, int changemax);
188 void expand_autos(int changeall, int domin, int domax);
189 void shrink_autos(int changeall, int domin, int domax);
190 // move the window to include the cursor
192 // Search plugindb and put results in argument
193 static void search_plugindb(int do_audio,
198 ArrayList<PluginServer*> &results);
199 // Find the plugin whose title matches title and return it
200 static PluginServer* scan_plugindb(char *title,
202 static void fix_plugin_title(char *title);
203 static int plugin_exists(const char *plugin_path, ArrayList<PluginServer*> &plugins);
204 static int plugin_exists(char *plugin_path);
205 void dump_plugindb(FILE *fp);
206 void stop_playback(int wait);
207 void stop_transport();
209 void queue_mixers(EDL *edl, int command, int wait_tracking,
210 int use_inout, int update_refresh, int toggle_audio, int loop_play);
211 void create_mixers();
212 void refresh_mixers();
216 ZWindow *get_mixer(Mixer *&mixer);
217 void del_mixer(ZWindow *zwindow);
218 int mixer_track_active(Track *track);
219 void update_mixer_tracks();
221 int select_zwindow(ZWindow *zwindow);
224 int load_filenames(ArrayList<char*> *filenames,
225 int load_mode = LOADMODE_REPLACE,
226 // Cause the project filename on the top of the window to be updated.
227 // Not wanted for loading backups.
228 int update_filename = 1);
231 // Print out plugins which are referenced in the EDL but not loaded.
232 void test_plugins(EDL *new_edl, char *path);
234 int interrupt_indexes(); // Stop index building
236 int redraw_time_dependancies(); // after reconfiguring the time format, sample rate, frame rate
238 // =========================================== movement
240 void next_time_format();
241 void prev_time_format();
242 void time_format_common();
243 int reposition_timebar(int new_pixel, int new_height);
245 int zoom_in_sample();
246 int zoom_sample(int64_t zoom_sample);
247 void zoom_autos(float min, float max);
248 void zoom_amp(int64_t zoom_amp);
249 void zoom_track(int64_t zoom_track);
251 int move_left(int64_t distance = 0);
252 int move_right(int64_t distance = 0);
253 void move_up(int64_t distance = 0);
254 void move_down(int64_t distance = 0);
255 int find_selection(double position, int scroll_display = 0);
258 // shift_down must be passed by the caller because different windows call
260 int next_label(int shift_down);
261 int prev_label(int shift_down);
262 // seek to edit handles
263 int next_edit_handle(int shift_down);
264 int prev_edit_handle(int shift_down);
266 int nearest_plugin_keyframe(int shift_down, int dir);
267 // offset is pixels to add to track_start
268 void trackmovement(int offset, int pane_number);
269 // view_start is pixels
270 int samplemovement(int64_t view_start, int pane_number);
274 int goto_position(double position);
282 void update_plugins();
283 // Call after every edit operation
286 void show_plugin(Plugin *plugin);
287 void hide_plugin(Plugin *plugin, int lock);
289 void delete_plugin(PluginServer *plugin);
290 // Update plugins with configuration changes.
291 // Called by TrackCanvas::cursor_motion_event.
292 void update_plugin_guis(int do_keyframe_guis = 1);
293 void update_plugin_states();
294 void update_plugin_titles();
295 // Called by Attachmentpoint during playback.
296 // Searches for matching plugin and renders data in it.
297 void render_plugin_gui(void *data, Plugin *plugin);
298 void render_plugin_gui(void *data, int size, Plugin *plugin);
300 // Called from PluginVClient::process_buffer
301 // Returns 1 if a GUI for the plugin is open so OpenGL routines can determine if
303 int plugin_gui_open(Plugin *plugin);
305 void show_keyframe_gui(Plugin *plugin);
306 void hide_keyframe_guis();
307 void hide_keyframe_gui(Plugin *plugin);
308 void update_keyframe_guis();
311 // ============================= editing commands ========================
313 // Map each recordable audio track to the desired pattern
314 void map_audio(int pattern);
315 void remap_audio(int pattern);
321 void add_audio_track_entry(int above, Track *dst);
322 int add_audio_track(int above, Track *dst);
323 void add_clip_to_edl(EDL *edl);
324 void add_video_track_entry(Track *dst = 0);
325 int add_video_track(int above, Track *dst);
326 void add_subttl_track_entry(Track *dst = 0);
327 int add_subttl_track(int above, Track *dst);
330 void asset_to_size();
331 void asset_to_rate();
332 // Entry point for clear operations.
334 // Clears active region in EDL.
335 // If clear_handle, edit boundaries are cleared if the range is 0.
336 // Called by paste, record, menueffects, render, and CWindow drop.
337 void clear(int clear_handle);
339 int clear_labels(double start, double end);
340 void concatenate_tracks();
342 int copy(double start, double end);
344 void blade(double position);
345 void cut(double start, double end, double new_position=-1);
346 // snap off edit from current position to handle/label
347 void snap_left_edit();
348 void snap_right_edit();
349 void snap_left_label();
350 void snap_right_label();
352 // Calculate aspect ratio from pixel counts
353 static int create_aspect_ratio(float &w, float &h, int width, int height);
354 // Calculate defaults path
355 static void create_defaults_path(char *string, const char *config_file);
357 void delete_folder(char *folder);
360 void delete_track(Track *track);
361 void delete_tracks();
362 int feather_edits(int64_t feather_samples, int audio, int video);
363 int64_t get_feather(int audio, int video);
364 float get_aspect_ratio();
365 void insert(double position,
370 EDL *parent_edl /* = 0 */);
372 // TrackCanvas calls this to insert multiple effects from the drag_pluginservers
373 // into pluginset_highlighted.
374 void insert_effects_canvas(double start,
377 // CWindow calls this to insert multiple effects from
378 // the drag_pluginservers array.
379 void insert_effects_cwindow(Track *dest_track);
381 // Attach new effect to all recordable tracks
382 // single_standalone - attach 1 standalone on the first track and share it with
384 void insert_effect(char *title,
385 SharedLocation *shared_location,
388 int single_standalone);
390 // This is called multiple times by the above functions.
391 // It can't sync parameters.
392 void insert_effect(char *title,
393 SharedLocation *shared_location,
395 PluginSet *plugin_set,
400 void match_output_size(Track *track);
401 // Move edit to new position
402 void move_edits(ArrayList<Edit*> *edits,
405 int behaviour); // behaviour: 0 - old style (cut and insert elswhere), 1- new style - (clear and overwrite elsewere)
406 // Move effect to position
407 void move_effect(Plugin *plugin,
410 void move_effect(Plugin *plugin,
411 PluginSet *plugin_set,
413 void move_plugins_up(PluginSet *plugin_set);
414 void move_plugins_down(PluginSet *plugin_set);
415 void move_track_down(Track *track);
416 void move_tracks_down();
417 void move_track_up(Track *track);
418 void move_tracks_up();
419 void mute_selection();
420 void new_folder(const char *new_folder);
421 void overwrite(EDL *source);
422 // For clipboard commands
424 // For splice and overwrite
425 int paste(double start,
431 int paste_output(int64_t startproject,
433 int64_t startsource_sample,
434 int64_t endsource_sample,
435 int64_t startsource_frame,
436 int64_t endsource_frame,
438 RecordLabels *new_labels);
439 void paste_silence();
441 // Detach single transition
442 void detach_transition(Transition *transition);
443 // Detach all transitions in selection
444 void detach_transitions();
445 // Attach dragged transition
446 void paste_transition();
447 // Attach transition to all edits in selection
448 void paste_transitions(int track_type, char *title);
449 // Attach transition dragged onto CWindow
450 void paste_transition_cwindow(Track *dest_track);
451 // Attach default transition to single edit
452 void paste_audio_transition();
453 void paste_video_transition();
454 void shuffle_edits();
455 void reverse_edits();
457 void set_edit_length(double length);
458 // Set length of single transition
459 void set_transition_length(Transition *transition, double length);
460 // Set length in seconds of all transitions in active range
461 void set_transition_length(double length);
463 void remove_indexfile(Indexable *indexable);
464 void rebuild_indices();
465 // Asset removal from caches
467 void remove_asset_from_caches(Asset *asset);
468 void remove_assets_from_project(int push_undo /* = 0 */,
470 ArrayList<Indexable*> *drag_assets /* mwindow->session->drag_assets */,
471 ArrayList<EDL*> *drag_clips /* mwindow->session->drag_clips */);
472 void remove_assets_from_disk();
473 void resize_track(Track *track, int w, int h);
475 void set_automation_mode(int mode);
476 void set_keyframe_type(int mode);
477 void set_auto_keyframes(int value, int lock_mwindow, int lock_cwindow);
478 void set_auto_visibility(Autos *autos, int value);
479 void set_labels_follow_edits(int value);
481 // Update the editing mode
482 int set_editing_mode(int new_editing_mode, int lock_mwindow, int lock_cwindow);
483 void toggle_editing_mode();
484 void set_inpoint(int is_mwindow);
485 void set_outpoint(int is_mwindow);
486 void unset_inoutpoint(int is_mwindow);
487 void splice(EDL *source);
488 void toggle_loop_playback();
489 void trim_selection();
490 // Synchronize EDL settings with all playback engines depending on current
491 // operation. Doesn't redraw anything.
492 void sync_parameters(int change_type = CHANGE_PARAMS);
493 void save_clip(EDL *new_edl, const char *txt);
494 void to_clip(EDL *edl, const char *txt);
495 int toggle_label(int is_mwindow);
496 void undo_entry(BC_WindowBase *calling_window_gui);
497 void redo_entry(BC_WindowBase *calling_window_gui);
500 int cut_automation();
501 int copy_automation();
502 int paste_automation();
503 void clear_automation();
504 int cut_default_keyframe();
505 int copy_default_keyframe();
506 // Use paste_automation to paste the default keyframe in other position.
507 // Use paste_default_keyframe to replace the default keyframe with whatever is
509 int paste_default_keyframe();
510 int clear_default_keyframe();
512 FloatAuto* get_float_auto(PatchGUI *patch,int idx);
513 IntAuto* get_int_auto(PatchGUI *patch,int idx);
514 PanAuto* get_pan_auto(PatchGUI *patch);
515 PatchGUI *get_patchgui(Track *track);
517 int modify_edithandles();
518 int modify_pluginhandles();
519 void finish_modify_handles();
520 void set_proxy(int use_scaler, int new_scale, int auto_scale,
521 ArrayList<Indexable*> *orig_assets,
522 ArrayList<Indexable*> *proxy_assets);
523 void add_proxy(int use_scaler,
524 ArrayList<Indexable*> *orig_assets,
525 ArrayList<Indexable*> *proxy_assets);
526 void render_proxy(ArrayList<Indexable *> &new_idxbls);
528 void dump_plugins(FILE *fp=stdout);
529 void dump_edl(FILE *fp=stdout);
530 void dump_undo(FILE *fp=stdout);
531 void dump_exe(FILE *fp=stdout);
532 static void trap_hook(FILE *fp, void *vp);
534 void reset_android_remote();
536 // Send new EDL to caches
538 int optimize_assets(); // delete unused assets from the cache and assets
540 void select_point(double position);
541 int set_loop_boundaries(); // toggle loop playback and set boundaries for loop playback
544 Playback3D *playback_3d;
545 SplashGUI *splash_window;
551 // CICaches for drawing timeline only
552 CICache *audio_cache, *video_cache;
553 // Frame cache for drawing timeline only.
554 // Cache drawing doesn't wait for file decoding.
555 FrameCache *frame_cache;
556 WaveCache *wave_cache;
557 Preferences *preferences;
558 PreferencesThread *preferences_thread;
559 MainSession *session;
561 MainIndexes *mainindexes;
562 MainProgress *mainprogress;
566 const char *default_standard;
567 static Commercials *commercials;
568 int commercial_active;
569 int has_commercials();
572 ArrayList<ColormodelItem*> colormodels;
573 ArrayList<InterlacemodeItem*> interlace_project_modes;
574 ArrayList<InterlacemodeItem*> interlace_asset_modes;
575 ArrayList<InterlacefixmethodItem*> interlace_asset_fixmethods;
580 int select_asset(Asset *asset, int vstream, int astream, int delete_tracks);
581 int select_asset(int vtrack, int delete_tracks);
583 // Channel DB for playback only. Record channel DB's are in record.C
584 ChannelDB *channeldb_buz;
585 ChannelDB *channeldb_v4l2jpeg;
587 // ====================================== plugins ==============================
589 // Contains file descriptors for all the dlopens
590 static ArrayList<PluginServer*> *plugindb;
591 // Currently visible plugins
592 int64_t plugin_visibility;
593 ArrayList<PluginServer*> *plugin_guis;
594 // GUI Plugins to delete
595 ArrayList<PluginServer*> *dead_plugins;
597 ArrayList<KeyFrameThread*> *keyframe_threads;
599 // Adjust sample position to line up with frames.
600 int fix_timing(int64_t &samples_out,
605 CreateBD_Thread *create_bd;
606 CreateDVD_Thread *create_dvd;
607 BatchRenderThread *batch_render;
610 ExportEDL *exportedl;
620 Mutex *vwindows_lock;
621 ArrayList<VWindow*> vwindows;
623 Mutex *zwindows_lock;
624 ArrayList<ZWindow*> zwindows;
633 void show_warning(int *do_warning, const char *text);
636 LevelWindow *lwindow;
638 // Lock during creation and destruction of GUI
639 Mutex *plugin_gui_lock;
640 Mutex *dead_plugin_lock;
641 Mutex *keyframe_gui_lock;
642 // Lock during creation and destruction of brender so playback doesn't use it.
645 // Initialize shared memory
648 // Initialize channel DB's for playback
649 void init_channeldb();
651 void init_exportedl();
652 // These three happen synchronously with each other
653 // Make sure this is called after synchronizing EDL's.
655 // Restart brender after testing its existence
656 void restart_brender();
657 // Stops brender after testing its existence
659 // This one happens asynchronously of the others. Used by playback to
660 // see what frame is background rendered.
661 int brender_available(int position);
662 void set_brender_active(int v, int update=1);
663 int put_commercial();
664 void activate_commercial() { commercial_active = 1; }
665 void commit_commercial();
666 void undo_commercial();
667 void cut_commercials();
668 int paste_subtitle_text(char *text, double start, double end);
672 static void init_defaults(BC_Hash* &defaults, char *config_path);
673 void check_language();
674 const char *default_std();
675 void fill_preset_defaults(const char *preset, EDLSession *session);
676 const char *get_preset_name(int index);
680 void init_tipwindow();
681 // Used by MWindow and RenderFarmClient
682 static void get_plugin_path(char *path, const char *plug_dir, const char *fs_path);
683 static int init_plugins(MWindow *mwindow, Preferences *preferences);
684 static int init_ladspa_plugins(MWindow *mwindow, Preferences *preferences);
685 static void init_plugin_tips(ArrayList<PluginServer*> &plugins, const char *lang);
686 static int check_plugin_index(ArrayList<PluginServer*> &plugins,
687 const char *plug_dir, const char *plug_path);
688 static void init_plugin_index(MWindow *mwindow, Preferences *preferences,
689 FILE *fp, const char *plugin_dir);
690 static int init_ladspa_index(MWindow *mwindow, Preferences *preferences,
691 const char *index_path, const char *plugin_dir);
692 static void scan_plugin_index(MWindow *mwindow, Preferences *preferences,
693 FILE *fp, const char *plug_dir, const char *plug_path, int &idx);
694 static void init_ffmpeg();
695 static void init_ffmpeg_index(MWindow *mwindow, Preferences *preferences, FILE *fp);
696 static int load_plugin_index(MWindow *mwindow, const char *index_path,
697 const char *plugin_dir);
698 static PluginServer* new_ffmpeg_server(MWindow *mwindow, const char *name);
699 void init_preferences();
702 void init_compositor();
703 void init_levelwindow();
704 // Called when creating a new viewer to view footage
705 VWindow* get_viewer(int start_it, int idx=-1);
711 void init_playbackcursor();
712 void init_commercials();
713 static void add_plugins(ArrayList<PluginServer*> &plugins);
714 static void delete_plugins();
716 void clean_indexes();
717 // TimeBomb timebomb;
718 SigHandler *sighandler;