track.h

   1
   2 /*
   3  * CINELERRA
   4  * Copyright (C) 2010 Adam Williams <broadcast at earthling dot net>
   5  *
   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.
  10  *
  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.
  15  *
  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
  19  *
  20  */
  21
  22 #ifndef TRACK_H
  23 #define TRACK_H
  24
  25 #include <stdio.h>
  26 #include <stdint.h>
  27
  28 #include "arraylist.h"
  29 #include "asset.inc"
  30 #include "autoconf.inc"
  31 #include "automation.inc"
  32 #include "datatype.h"
  33 #include "bchash.inc"
  34 #include "edit.inc"
  35 #include "edits.inc"
  36 #include "edl.inc"
  37 #include "filexml.inc"
  38 #include "floatautos.inc"
  39 #include "guicast.h"
  40 #include "indexable.inc"
  41 #include "keyframe.inc"
  42 #include "linklist.h"
  43 #include "module.inc"
  44 #include "patch.inc"
  45 #include "plugin.inc"
  46 #include "pluginset.inc"
  47 #include "sharedlocation.inc"
  48 #include "theme.inc"
  49 #include "intautos.inc"
  50 #include "trackcanvas.inc"
  51 #include "tracks.inc"
  52 #include "transition.inc"
  53
  54 // UNITS ARE SAMPLES FOR ALL
  55
  56 class Track : public ListItem<Track>
  57 {
  58 public:
  59         Track(EDL *edl, Tracks *tracks);
  60         Track();
  61         virtual ~Track();
  62
  63         void create_objects();
  64         int get_id();
  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);
  72
  73         virtual void copy_from(Track *track);
  74         Track& operator=(Track& track);
  75         virtual PluginSet* new_plugins() { return 0; };
  76 // Synchronize playback numbers
  77         virtual void synchronize_params(Track *track);
  78
  79 // Get number of pixels to display
  80         virtual int vertical_span(Theme *theme);
  81         int64_t horizontal_span();
  82         void resample(double old_rate, double new_rate);
  83
  84 // Speed curve in use
  85         int has_speed();
  86 // Get length of track in seconds
  87         double get_length();
  88 // Get dimensions of source for convenience functions
  89         void get_source_dimensions(double position, int &w, int &h);
  90
  91 // Editing
  92         void insert_asset(Asset *asset,
  93                 EDL *nested_edl,
  94                 double length,
  95                 double position,
  96                 int track_number);
  97         Plugin* insert_effect(const char *title,
  98                 SharedLocation *shared_location,
  99                 KeyFrame *keyframe,
 100                 PluginSet *plugin_set,
 101                 double start,
 102                 double length,
 103                 int plugin_type);
 104         void insert_plugin_set(Track *track,
 105                 int64_t position,
 106                 int64_t min_length,
 107                 int edit_autos);
 108         void detach_effect(Plugin *plugin);
 109 // Insert a track from another EDL
 110         void insert_track(Track *track,
 111                 double position,
 112                 int replace_default,
 113                 int edit_plugins,
 114                 int edit_autos,
 115 // Pad pasted sections to a minimum of this length.
 116                 double edl_length);
 117         void shuffle_edits(double start, double end, int first_track);
 118         void reverse_edits(double start, double end, int first_track);
 119         void align_edits(double start,
 120                 double end,
 121                 ArrayList<double> *times);
 122 // Optimize editing
 123         void optimize();
 124         int is_muted(int64_t position, int direction);  // Test muting status
 125
 126         void move_plugins_up(PluginSet *plugin_set);
 127         void move_plugins_down(PluginSet *plugin_set);
 128         void remove_pluginset(PluginSet *plugin_set);
 129         void remove_asset(Indexable *asset);
 130
 131 // Used for determining a selection for editing so leave as int.
 132 // converts the selection to SAMPLES OR FRAMES and stores in value
 133         virtual int64_t to_units(double position, int round);
 134 // For drawing
 135         virtual double to_doubleunits(double position);
 136         virtual double from_units(int64_t position);
 137
 138
 139
 140 // Positions are identical for handle modifications
 141     virtual int identical(int64_t sample1, int64_t sample2) { return 0; };
 142
 143 // Get the plugin belonging to the set.
 144         Plugin* get_current_plugin(double position,
 145                 int plugin_set,
 146                 int direction,
 147                 int convert_units,
 148                 int use_nudge);
 149         Plugin* get_current_transition(double position,
 150                 int direction,
 151                 int convert_units,
 152                 int use_nudge);
 153
 154 // detach shared effects referencing module
 155         void detach_shared_effects(int module);
 156
 157
 158 // Called by playable tracks to test for playable server.
 159 // Descends the plugin tree without creating a virtual console.
 160 // Used by PlayableTracks::is_playable.
 161         int is_synthesis(int64_t position,
 162                 int direction);
 163
 164 // Used by PlayableTracks::is_playable
 165 // Returns 1 if the track is in the output boundaries.
 166         virtual int is_playable(int64_t position,
 167                 int direction);
 168
 169 // Test direct copy conditions common to all the rendering routines
 170         virtual int direct_copy_possible(int64_t start, int direction, int use_nudge);
 171
 172 // Used by PlayableTracks::is_playable
 173         int plugin_used(int64_t position, int64_t direction);
 174
 175
 176
 177
 178
 179         virtual int copy_settings(Track *track);
 180         void shift_keyframes(int64_t position, int64_t length);
 181         void shift_effects(int64_t position, int64_t length, int edit_autos);
 182         void change_plugins(SharedLocation &old_location,
 183                 SharedLocation &new_location,
 184                 int do_swap);
 185         void change_modules(int old_location,
 186                 int new_location,
 187                 int do_swap);
 188         int plugin_exists(Plugin *plugin);
 189
 190         EDL *edl;
 191         Tracks *tracks;
 192
 193         Edits *edits;
 194 // Plugin set uses key frames for automation
 195         ArrayList<PluginSet*> plugin_set;
 196         Automation *automation;
 197
 198 // Vertical offset from top of timeline
 199         int y_pixel;
 200         int expand_view;
 201         int draw;
 202 // There is some debate on whether to expand gang from faders to
 203 // dragging operations.  This would allow every edit in a column to get dragged
 204 // simultaneously.
 205         int gang;
 206         char title[BCTEXTLEN];
 207         int play;
 208         int record;
 209 // Nudge in track units.  Positive shifts track earlier in time.  This way
 210 // the position variables only need to add the nudge.
 211         int64_t nudge;
 212 // TRACK_AUDIO or TRACK_VIDEO
 213         int data_type;
 214
 215
 216
 217
 218
 219
 220
 221
 222
 223
 224
 225
 226
 227
 228
 229
 230
 231
 232
 233         int load_automation(FileXML *file);
 234         int load_edits(FileXML *file);
 235
 236         virtual int change_channels(int oldchannels, int newchannels) { return 0; };
 237         virtual int dump(FILE *fp);
 238
 239
 240
 241 // ===================================== editing
 242         int copy(double start, double end,
 243                 FileXML *file, const char *output_path = "");
 244         int copy_assets(double start,
 245                 double end,
 246                 ArrayList<Asset*> *asset_list);
 247         virtual int copy_derived(int64_t start, int64_t end, FileXML *file) { return 0; };
 248         virtual int paste_derived(int64_t start, int64_t end, int64_t total_length, FileXML *file, int &current_channel) { return 0; };
 249         int clear(double start,
 250                 double end,
 251                 int edit_edits,
 252                 int edit_labels,
 253                 int clear_plugins,
 254                 int edit_autos,
 255                 int convert_units,
 256                 Edits *trim_edits);
 257 // Returns the point to restart background rendering at.
 258 // -1 means nothing changed.
 259         void clear_automation(double selectionstart,
 260                 double selectionend,
 261                 int shift_autos   /* = 1 */,
 262                 int default_only  /* = 0 */);
 263         void set_automation_mode(double selectionstart,
 264                 double selectionend,
 265                 int mode);
 266         virtual int clear_automation_derived(AutoConf *auto_conf,
 267                 double selectionstart,
 268                 double selectionend,
 269                 int shift_autos = 1) { return 0; };
 270         virtual int clear_derived(double start,
 271                 double end) { return 0; };
 272
 273         int copy_automation(double selectionstart,
 274                 double selectionend,
 275                 FileXML *file,
 276                 int default_only,
 277                 int active_only);
 278         virtual int copy_automation_derived(AutoConf *auto_conf,
 279                 double selectionstart,
 280                 double selectionend,
 281                 FileXML *file) { return 0; };
 282         int paste_automation(double selectionstart,
 283                 double total_length,
 284                 double frame_rate,
 285                 int64_t sample_rate,
 286                 FileXML *file,
 287                 int default_only,
 288                 int active_only);
 289         virtual int paste_automation_derived(double selectionstart,
 290                 double selectionend,
 291                 double total_length,
 292                 FileXML *file,
 293                 int shift_autos,
 294                 int &current_pan) { return 0; };
 295         int paste_auto_silence(double start, double end);
 296         virtual int paste_auto_silence_derived(int64_t start, int64_t end) { return 0; };
 297         int scale_time(float rate_scale, int scale_edits, int scale_autos, int64_t start, int64_t end);
 298         virtual int scale_time_derived(float rate_scale, int scale_edits, int scale_autos, int64_t start, int64_t end) { return 0; };
 299         int purge_asset(Asset *asset);
 300         int asset_used(Asset *asset);
 301         int clear_handle(double start,
 302                 double end,
 303                 int clear_labels,
 304                 int clear_plugins,
 305                 int edit_autos,
 306                 double &distance);
 307         int paste_silence(double start, double end, int edit_plugins, int edit_autos);
 308         virtual int select_translation(int cursor_x, int cursor_y) { return 0; };  // select video coordinates for frame
 309         virtual int update_translation(int cursor_x, int cursor_y, int shift_down) { return 0; };  // move video coordinates
 310         int select_auto(AutoConf *auto_conf, int cursor_x, int cursor_y);
 311         virtual int select_auto_derived(float zoom_units, float view_start, AutoConf *auto_conf, int cursor_x, int cursor_y) { return 0; };
 312         int move_auto(AutoConf *auto_conf, int cursor_x, int cursor_y, int shift_down);
 313         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; };
 314         int release_auto();
 315         virtual int release_auto_derived() { return 0; };
 316 // Return whether automation would prevent direct frame copies.  Not fully implemented.
 317         int automation_is_used(int64_t start, int64_t end);
 318         virtual int automation_is_used_derived(int64_t start, int64_t end) { return 0; }
 319
 320         int popup_transition(int cursor_x, int cursor_y);
 321
 322 // Return 1 if the left handle was selected 2 if the right handle was selected 3 if the track isn't recordable
 323         int modify_edithandles(double oldposition,
 324                 double newposition,
 325                 int currentend,
 326                 int handle_mode,
 327                 int edit_labels,
 328                 int edit_plugins,
 329                 int edit_autos);
 330         int modify_pluginhandles(double oldposition,
 331                 double newposition,
 332                 int currentend,
 333                 int handle_mode,
 334                 int edit_labels,
 335                 int edit_autos,
 336                 Edits *trim_edits);
 337         int select_edit(int cursor_x,
 338                 int cursor_y,
 339                 double &new_start,
 340                 double &new_end);
 341         virtual int end_translation() { return 0; };
 342         virtual int reset_translation(int64_t start, int64_t end) { return 0; };
 343         int feather_edits(int64_t start, int64_t end, int64_t units);
 344         int64_t get_feather(int64_t selectionstart, int64_t selectionend);
 345
 346
 347 // Absolute number of this track
 348         int number_of();
 349
 350 // get_dimensions is used for getting drawing regions so use floats for partial frames
 351 // get the display dimensions in SAMPLES OR FRAMES
 352 //      virtual int get_dimensions(double &view_start,
 353 //              double &view_units,
 354 //              double &zoom_units) { return 0; };
 355 // Longest time from current_position in which nothing changes
 356         int64_t edit_change_duration(int64_t input_position,
 357                 int64_t input_length,
 358                 int reverse,
 359                 int test_transitions,
 360                 int use_nudge);
 361         int64_t plugin_change_duration(int64_t input_position,
 362                 int64_t input_length,
 363                 int reverse,
 364                 int use_nudge);
 365 // Utility for edit_change_duration.
 366         int need_edit(Edit *current, int test_transitions);
 367 // If the edit under position is playable.
 368 // Used by PlayableTracks::is_playable.
 369         int playable_edit(int64_t position, int direction);
 370
 371 // ===================================== for handles, titles, etc
 372
 373         int64_t old_view_start;
 374         int pixel;   // pixel position from top of track view
 375 // Dimensions of this track if video
 376         int track_w, track_h;
 377
 378
 379
 380
 381 private:
 382 // Identification of the track
 383         int id;
 384 };
 385
 386 #endif