4 * Copyright (C) 2010 Adam Williams <broadcast at earthling dot net>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
28 #include "arraylist.h"
30 #include "autoconf.inc"
31 #include "automation.inc"
37 #include "filexml.inc"
38 #include "floatautos.inc"
40 #include "indexable.inc"
41 #include "keyframe.inc"
46 #include "pluginset.inc"
47 #include "sharedlocation.inc"
49 #include "intautos.inc"
50 #include "trackcanvas.inc"
52 #include "transition.inc"
53 #include "zwindow.inc"
55 // UNITS ARE SAMPLES FOR ALL
57 class Track : public ListItem<Track>
60 Track(EDL *edl, Tracks *tracks);
63 void create_objects();
65 virtual int load_defaults(BC_Hash *defaults);
66 int load(FileXML *file, int track_offset, uint32_t load_flags);
67 virtual int save_header(FileXML *file) { return 0; };
68 virtual int save_derived(FileXML *file) { return 0; };
69 virtual int load_header(FileXML *file, uint32_t load_flags) { return 0; };
70 virtual int load_derived(FileXML *file, uint32_t load_flags) { return 0; };
71 void equivalent_output(Track *track, double *result);
74 void get_fauto_xyz(int fauto, float &x, float &y, float &z);
75 void set_fauto_xyz(int fauto, float x, float y, float z);
76 void get_projector(float &x, float &y, float &z);
77 void set_projector(float x, float y, float z);
78 void get_camera(float &x, float &y, float &z);
79 void set_camera(float x, float y, float z);
81 virtual void copy_from(Track *track);
82 Track& operator=(Track& track);
83 virtual PluginSet* new_plugins() { return 0; };
84 // Synchronize playback numbers
85 virtual void synchronize_params(Track *track);
87 // Get number of pixels to display
88 virtual int vertical_span(Theme *theme);
89 int64_t horizontal_span();
90 void resample(double old_rate, double new_rate);
94 // length when speed is applied
95 int64_t speed_length(int64_t start, int64_t end);
96 // Get length of track in seconds
98 // Get dimensions of source for convenience functions
99 void get_source_dimensions(double position, int &w, int &h);
102 void insert_asset(Asset *asset, EDL *nested_edl,
103 double length, double position, int track_number);
104 Plugin* insert_effect(const char *title, SharedLocation *shared_location,
105 KeyFrame *keyframe, PluginSet *plugin_set,
106 double start, double length, int plugin_type);
107 void insert_plugin_set(Track *track, int64_t position,
108 int64_t min_length, int edit_autos);
109 void detach_effect(Plugin *plugin);
110 // Insert a track from another EDL
111 void insert_track(Track *track, double position,
112 int replace_default, int edit_plugins, int edit_autos,
113 // Pad pasted sections to a minimum of this length.
115 void shuffle_edits(double start, double end, int first_track);
116 void reverse_edits(double start, double end, int first_track);
117 void align_edits(double start, double end, Track *master_track);
120 int is_muted(int64_t position, int direction); // Test muting status
122 void move_plugins_up(PluginSet *plugin_set);
123 void move_plugins_down(PluginSet *plugin_set);
124 void remove_pluginset(PluginSet *plugin_set);
125 void remove_asset(Indexable *asset);
127 // Used for determining a selection for editing so leave as int.
128 // converts the selection to SAMPLES OR FRAMES and stores in value
129 virtual int64_t to_units(double position, int round);
131 virtual double to_doubleunits(double position);
132 virtual double from_units(int64_t position);
135 // Positions are identical for handle modifications
136 virtual int identical(int64_t sample1, int64_t sample2) { return 0; };
138 // Get the plugin belonging to the set.
139 Plugin* get_current_plugin(double position,
140 int plugin_set, int direction, int convert_units, int use_nudge);
141 Plugin* get_current_transition(double position,
142 int direction, int convert_units, int use_nudge);
144 // detach shared effects referencing module
145 void detach_shared_effects(int module);
146 // detach all corresponding effects in gang
147 void detach_ganged_effects(Plugin *plugin);
149 // Called by playable tracks to test for playable server.
150 // Descends the plugin tree without creating a virtual console.
151 // Used by PlayableTracks::is_playable.
152 int is_synthesis(int64_t position, int direction, int depth=0);
154 // Used by PlayableTracks::is_playable
155 // Returns 1 if the track is in the output boundaries.
156 virtual int is_playable(int64_t position, int direction);
158 // Test direct copy conditions common to all the rendering routines
159 virtual int direct_copy_possible(int64_t start, int direction, int use_nudge);
161 // Used by PlayableTracks::is_playable
162 int plugin_used(int64_t position, int64_t direction);
163 // align to frame boundary
164 int64_t frame_align(int64_t position, int round);
166 virtual int copy_settings(Track *track);
167 void shift_keyframes(int64_t position, int64_t length);
168 void shift_effects(int64_t position, int64_t length, int edit_autos, Edits *trim_edits);
169 void change_plugins(SharedLocation &old_location, SharedLocation &new_location, int do_swap);
170 void change_modules(int old_location, int new_location, int do_swap);
171 Plugin *plugin_exists(int plugin_id);
172 Track *gang_master();
176 int armed_gang(Track *track);
177 int index_in(Mixer *mixer);
183 // Plugin set uses key frames for automation
184 ArrayList<PluginSet*> plugin_set;
185 Automation *automation;
187 // Vertical offset from top of timeline
189 // Vertical height of the track asset
193 // There is some debate on whether to expand gang from faders to
194 // dragging operations. This would allow every edit in a column to get dragged
197 char title[BCTEXTLEN];
200 // mask enable bit flags
202 // Nudge in track units. Positive shifts track earlier in time. This way
203 // the position variables only need to add the nudge.
205 // TRACK_AUDIO or TRACK_VIDEO
209 int load_automation(FileXML *file);
210 int load_edits(FileXML *file);
212 virtual int change_channels(int oldchannels, int newchannels) { return 0; };
213 virtual int dump(FILE *fp);
215 // ===================================== editing
216 int copy(int copy_flags, double start, double end,
217 FileXML *file, const char *output_path = "");
218 int copy_assets(double start, double end, ArrayList<Asset*> *asset_list);
219 virtual int copy_derived(int64_t start, int64_t end, FileXML *file) { return 0; };
220 virtual int paste_derived(int64_t start, int64_t end,
221 int64_t total_length, FileXML *file, int ¤t_channel) { return 0; };
222 int blade(double position);
223 int clear(double start, double end,
224 int edit_edits, int edit_labels, int clear_plugins,
225 int edit_autos, Edits *trim_edits);
226 int clear(int64_t start, int64_t end,
227 int edit_edits, int edit_labels, int clear_plugins,
228 int edit_autos, Edits *trim_edits);
229 // Returns the point to restart background rendering at.
230 // -1 means nothing changed.
231 void clear_automation(double selectionstart, double selectionend,
232 int shift_autos /* = 1 */,
233 int default_only /* = 0 */);
234 void set_automation_mode(double selectionstart, double selectionend,
236 virtual int clear_automation_derived(AutoConf *auto_conf,
237 double selectionstart, double selectionend,
238 int shift_autos = 1) { return 0; };
239 virtual int clear_derived(double start,
240 double end) { return 0; };
242 int copy_automation(double selectionstart, double selectionend,
243 FileXML *file, int default_only, int active_only);
244 virtual int copy_automation_derived(AutoConf *auto_conf,
245 double selectionstart, double selectionend,
246 FileXML *file) { return 0; };
247 int paste_automation(FileXML *file,
248 double selectionstart, double src_length, double src_rate,
249 int default_only, int active_only);
250 virtual int paste_automation_derived(double selectionstart, double selectionend,
251 double total_length, FileXML *file, int shift_autos, int ¤t_pan) { return 0; };
252 int paste_auto_silence(double start, double end);
253 virtual int paste_auto_silence_derived(int64_t start, int64_t end) { return 0; };
254 int scale_time(float rate_scale, int scale_edits, int scale_autos, int64_t start, int64_t end);
255 virtual int scale_time_derived(float rate_scale, int scale_edits, int scale_autos, int64_t start, int64_t end) { return 0; };
256 int purge_asset(Asset *asset);
257 int asset_used(Asset *asset);
258 int clear_handle(double start, double end,
259 int clear_labels, int clear_plugins, int edit_autos,
261 int paste_silence(double start, double end, int edit_plugins, int edit_autos);
262 int paste_silence(int64_t start, int64_t end, int edit_plugins, int edit_autos);
263 virtual int select_translation(int cursor_x, int cursor_y) { return 0; }; // select video coordinates for frame
264 virtual int update_translation(int cursor_x, int cursor_y, int shift_down) { return 0; }; // move video coordinates
265 int select_auto(AutoConf *auto_conf, int cursor_x, int cursor_y);
266 virtual int select_auto_derived(float zoom_units, float view_start, AutoConf *auto_conf, int cursor_x, int cursor_y) { return 0; };
267 int move_auto(AutoConf *auto_conf, int cursor_x, int cursor_y, int shift_down);
268 virtual int move_auto_derived(float zoom_units, float view_start, AutoConf *auto_conf, int cursor_x, int cursor_y, int shift_down) { return 0; };
270 virtual int release_auto_derived() { return 0; };
271 // Return whether automation would prevent direct frame copies. Not fully implemented.
272 int automation_is_used(int64_t start, int64_t end);
273 virtual int automation_is_used_derived(int64_t start, int64_t end) { return 0; }
275 int popup_transition(int cursor_x, int cursor_y);
277 // Return 1 if the left handle was selected 2 if the right handle was selected 3 if the track isn't recordable
278 int modify_edithandles(double oldposition, double newposition,
279 int currentend, int handle_mode, int edit_labels,
280 int edit_plugins, int edit_autos, int group_id);
281 int modify_pluginhandles(double oldposition,
288 int select_edit(int cursor_x,
292 virtual int end_translation() { return 0; };
293 virtual int reset_translation(int64_t start, int64_t end) { return 0; };
294 int feather_edits(int64_t start, int64_t end, int64_t units);
295 int64_t get_feather(int64_t selectionstart, int64_t selectionend);
299 int show_transitions();
301 // Absolute number of this track
304 // get_dimensions is used for getting drawing regions so use floats for partial frames
305 // get the display dimensions in SAMPLES OR FRAMES
306 // virtual int get_dimensions(double &view_start,
307 // double &view_units,
308 // double &zoom_units) { return 0; };
309 // Longest time from current_position in which nothing changes
310 int64_t edit_change_duration(int64_t input_position,
311 int64_t input_length,
313 int test_transitions,
315 int64_t plugin_change_duration(int64_t input_position,
316 int64_t input_length,
319 // Utility for edit_change_duration.
320 int need_edit(Edit *current, int test_transitions);
321 // If the edit under position is playable.
322 // Used by PlayableTracks::is_playable.
323 int playable_edit(int64_t position, int direction);
324 void create_keyframes(double position, int mask, int mode);
326 // ===================================== for handles, titles, etc
328 int64_t old_view_start;
329 int pixel; // pixel position from top of track view
330 // Dimensions of this track if video
331 int track_w, track_h;
332 // mixer set track id, gang master flag
333 int mixer_id, master;
336 // Identification of the track