cinelerra-5.1/cinelerra/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 #include "zwindow.inc"
  54
  55 // UNITS ARE SAMPLES FOR ALL
  56
  57 class Track : public ListItem<Track>
  58 {
  59 public:
  60         Track(EDL *edl, Tracks *tracks);
  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         int get_mixer_id();
  73
  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);
  80
  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);
  86
  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);
  91
  92 // Speed curve in use
  93         int has_speed();
  94 // Get length of track in seconds
  95         double get_length();
  96 // Get dimensions of source for convenience functions
  97         void get_source_dimensions(double position, int &w, int &h);
  98
  99 // Editing
 100         void insert_asset(Asset *asset, EDL *nested_edl,
 101                 double length, double position, int track_number);
 102         Plugin* insert_effect(const char *title, SharedLocation *shared_location,
 103                 KeyFrame *keyframe, PluginSet *plugin_set,
 104                 double start, double length, int plugin_type);
 105         void insert_plugin_set(Track *track, int64_t position,
 106                 int64_t min_length, int edit_autos);
 107         void detach_effect(Plugin *plugin);
 108 // Insert a track from another EDL
 109         void insert_track(Track *track, double position,
 110                 int replace_default, int edit_plugins, int edit_autos,
 111 // Pad pasted sections to a minimum of this length.
 112                 double edl_length);
 113         void shuffle_edits(double start, double end, int first_track);
 114         void reverse_edits(double start, double end, int first_track);
 115         void align_edits(double start, double end, Track *master_track);
 116 // Optimize editing
 117         void optimize();
 118         int is_muted(int64_t position, int direction);  // Test muting status
 119
 120         void move_plugins_up(PluginSet *plugin_set);
 121         void move_plugins_down(PluginSet *plugin_set);
 122         void remove_pluginset(PluginSet *plugin_set);
 123         void remove_asset(Indexable *asset);
 124
 125 // Used for determining a selection for editing so leave as int.
 126 // converts the selection to SAMPLES OR FRAMES and stores in value
 127         virtual int64_t to_units(double position, int round);
 128 // For drawing
 129         virtual double to_doubleunits(double position);
 130         virtual double from_units(int64_t position);
 131
 132
 133 // Positions are identical for handle modifications
 134     virtual int identical(int64_t sample1, int64_t sample2) { return 0; };
 135
 136 // Get the plugin belonging to the set.
 137         Plugin* get_current_plugin(double position,
 138                 int plugin_set, int direction, int convert_units, int use_nudge);
 139         Plugin* get_current_transition(double position,
 140                 int direction, int convert_units, int use_nudge);
 141
 142 // detach shared effects referencing module
 143         void detach_shared_effects(int module);
 144 // detach all corresponding effects in gang
 145         void detach_ganged_effects(Plugin *plugin);
 146
 147 // Called by playable tracks to test for playable server.
 148 // Descends the plugin tree without creating a virtual console.
 149 // Used by PlayableTracks::is_playable.
 150         int is_synthesis(int64_t position, int direction, int depth=0);
 151
 152 // Used by PlayableTracks::is_playable
 153 // Returns 1 if the track is in the output boundaries.
 154         virtual int is_playable(int64_t position, int direction);
 155
 156 // Test direct copy conditions common to all the rendering routines
 157         virtual int direct_copy_possible(int64_t start, int direction, int use_nudge);
 158
 159 // Used by PlayableTracks::is_playable
 160         int plugin_used(int64_t position, int64_t direction);
 161 // align to frame boundary
 162         int64_t frame_align(int64_t position, int round);
 163
 164         virtual int copy_settings(Track *track);
 165         void shift_keyframes(int64_t position, int64_t length);
 166         void shift_effects(int64_t position, int64_t length, int edit_autos, Edits *trim_edits);
 167         void change_plugins(SharedLocation &old_location, SharedLocation &new_location, int do_swap);
 168         void change_modules(int old_location, int new_location, int do_swap);
 169         Plugin *plugin_exists(int plugin_id);
 170         Track *gang_master();
 171         int is_hidden();
 172         int is_armed();
 173         int is_ganged();
 174         int armed_gang(Track *track);
 175         int index_in(Mixer *mixer);
 176
 177         EDL *edl;
 178         Tracks *tracks;
 179
 180         Edits *edits;
 181 // Plugin set uses key frames for automation
 182         ArrayList<PluginSet*> plugin_set;
 183         Automation *automation;
 184
 185 // Vertical offset from top of timeline
 186         int y_pixel;
 187 // Vertical height of the track asset
 188         int data_h;
 189         int expand_view;
 190         int draw;
 191 // There is some debate on whether to expand gang from faders to
 192 // dragging operations.  This would allow every edit in a column to get dragged
 193 // simultaneously.
 194         int ganged;
 195         char title[BCTEXTLEN];
 196         int play;
 197         int armed;
 198 // mask enable bit flags
 199         int masks;
 200 // Nudge in track units.  Positive shifts track earlier in time.  This way
 201 // the position variables only need to add the nudge.
 202         int64_t nudge;
 203 // TRACK_AUDIO or TRACK_VIDEO
 204         int data_type;
 205
 206
 207         int load_automation(FileXML *file);
 208         int load_edits(FileXML *file);
 209
 210         virtual int change_channels(int oldchannels, int newchannels) { return 0; };
 211         virtual int dump(FILE *fp);
 212
 213 // ===================================== editing
 214         int copy(int copy_flags, double start, double end,
 215                 FileXML *file, const char *output_path = "");
 216         int copy_assets(double start, double end, ArrayList<Asset*> *asset_list);
 217         virtual int copy_derived(int64_t start, int64_t end, FileXML *file) { return 0; };
 218         virtual int paste_derived(int64_t start, int64_t end,
 219                 int64_t total_length, FileXML *file, int &current_channel) { return 0; };
 220         int blade(double position);
 221         int clear(double start, double end,
 222                 int edit_edits, int edit_labels, int clear_plugins,
 223                 int edit_autos, Edits *trim_edits);
 224         int clear(int64_t start, int64_t end,
 225                 int edit_edits, int edit_labels, int clear_plugins,
 226                 int edit_autos, Edits *trim_edits);
 227 // Returns the point to restart background rendering at.
 228 // -1 means nothing changed.
 229         void clear_automation(double selectionstart, double selectionend,
 230                 int shift_autos   /* = 1 */,
 231                 int default_only  /* = 0 */);
 232         void set_automation_mode(double selectionstart, double selectionend,
 233                 int mode);
 234         virtual int clear_automation_derived(AutoConf *auto_conf,
 235                 double selectionstart, double selectionend,
 236                 int shift_autos = 1) { return 0; };
 237         virtual int clear_derived(double start,
 238                 double end) { return 0; };
 239
 240         int copy_automation(double selectionstart, double selectionend,
 241                 FileXML *file, int default_only, int active_only);
 242         virtual int copy_automation_derived(AutoConf *auto_conf,
 243                 double selectionstart, double selectionend,
 244                 FileXML *file) { return 0; };
 245         int paste_automation(double selectionstart, double total_length,
 246                 double frame_rate, int64_t sample_rate, FileXML *file,
 247                 int default_only, int active_only);
 248         virtual int paste_automation_derived(double selectionstart, double selectionend,
 249                 double total_length, FileXML *file, int shift_autos, int &current_pan) { return 0; };
 250         int paste_auto_silence(double start, double end);
 251         virtual int paste_auto_silence_derived(int64_t start, int64_t end) { return 0; };
 252         int scale_time(float rate_scale, int scale_edits, int scale_autos, int64_t start, int64_t end);
 253         virtual int scale_time_derived(float rate_scale, int scale_edits, int scale_autos, int64_t start, int64_t end) { return 0; };
 254         int purge_asset(Asset *asset);
 255         int asset_used(Asset *asset);
 256         int clear_handle(double start, double end,
 257                 int clear_labels, int clear_plugins, int edit_autos,
 258                 double &distance);
 259         int paste_silence(double start, double end, int edit_plugins, int edit_autos);
 260         int paste_silence(int64_t start, int64_t end, int edit_plugins, int edit_autos);
 261         virtual int select_translation(int cursor_x, int cursor_y) { return 0; };  // select video coordinates for frame
 262         virtual int update_translation(int cursor_x, int cursor_y, int shift_down) { return 0; };  // move video coordinates
 263         int select_auto(AutoConf *auto_conf, int cursor_x, int cursor_y);
 264         virtual int select_auto_derived(float zoom_units, float view_start, AutoConf *auto_conf, int cursor_x, int cursor_y) { return 0; };
 265         int move_auto(AutoConf *auto_conf, int cursor_x, int cursor_y, int shift_down);
 266         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; };
 267         int release_auto();
 268         virtual int release_auto_derived() { return 0; };
 269 // Return whether automation would prevent direct frame copies.  Not fully implemented.
 270         int automation_is_used(int64_t start, int64_t end);
 271         virtual int automation_is_used_derived(int64_t start, int64_t end) { return 0; }
 272
 273         int popup_transition(int cursor_x, int cursor_y);
 274
 275 // Return 1 if the left handle was selected 2 if the right handle was selected 3 if the track isn't recordable
 276         int modify_edithandles(double oldposition, double newposition,
 277                 int currentend, int handle_mode, int edit_labels,
 278                 int edit_plugins, int edit_autos, int group_id);
 279         int modify_pluginhandles(double oldposition,
 280                 double newposition,
 281                 int currentend,
 282                 int handle_mode,
 283                 int edit_labels,
 284                 int edit_autos,
 285                 Edits *trim_edits);
 286         int select_edit(int cursor_x,
 287                 int cursor_y,
 288                 double &new_start,
 289                 double &new_end);
 290         virtual int end_translation() { return 0; };
 291         virtual int reset_translation(int64_t start, int64_t end) { return 0; };
 292         int feather_edits(int64_t start, int64_t end, int64_t units);
 293         int64_t get_feather(int64_t selectionstart, int64_t selectionend);
 294
 295         int show_assets();
 296         int show_titles();
 297         int show_transitions();
 298
 299 // Absolute number of this track
 300         int number_of();
 301
 302 // get_dimensions is used for getting drawing regions so use floats for partial frames
 303 // get the display dimensions in SAMPLES OR FRAMES
 304 //      virtual int get_dimensions(double &view_start,
 305 //              double &view_units,
 306 //              double &zoom_units) { return 0; };
 307 // Longest time from current_position in which nothing changes
 308         int64_t edit_change_duration(int64_t input_position,
 309                 int64_t input_length,
 310                 int reverse,
 311                 int test_transitions,
 312                 int use_nudge);
 313         int64_t plugin_change_duration(int64_t input_position,
 314                 int64_t input_length,
 315                 int reverse,
 316                 int use_nudge);
 317 // Utility for edit_change_duration.
 318         int need_edit(Edit *current, int test_transitions);
 319 // If the edit under position is playable.
 320 // Used by PlayableTracks::is_playable.
 321         int playable_edit(int64_t position, int direction);
 322
 323 // ===================================== for handles, titles, etc
 324
 325         int64_t old_view_start;
 326         int pixel;   // pixel position from top of track view
 327 // Dimensions of this track if video
 328         int track_w, track_h;
 329 // mixer set track id, gang master flag
 330         int mixer_id, master;
 331
 332 private:
 333 // Identification of the track
 334         int id;
 335 };
 336
 337 #endif