cinelerra-5.1/cinelerra/edl.h

   1
   2 /*
   3  * CINELERRA
   4  * Copyright (C) 2008 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 EDL_H
  23 #define EDL_H
  24
  25 #include <stdio.h>
  26 #include <stdint.h>
  27
  28 #include "asset.inc"
  29 #include "assets.inc"
  30 #include "autoconf.inc"
  31 #include "bchash.inc"
  32 #include "binfolder.h"
  33 #include "edit.inc"
  34 #include "edits.inc"
  35 #include "edl.inc"
  36 #include "edlsession.inc"
  37 #include "filexml.inc"
  38 #include "indexable.h"
  39 #include "indexstate.inc"
  40 #include "labels.inc"
  41 #include "localsession.inc"
  42 #include "maxchannels.h"
  43 #include "mutex.inc"
  44 #include "clipedls.h"
  45 #include "playabletracks.inc"
  46 #include "playbackconfig.h"
  47 #include "pluginserver.h"
  48 #include "preferences.inc"
  49 #include "recordlabel.inc"
  50 #include "sharedlocation.inc"
  51 #include "theme.inc"
  52 #include "tracks.inc"
  53 #include "vedit.inc"
  54 #include "zwindow.h"
  55
  56 // Loading and saving are built on load and copy except for automation:
  57
  58 // Storage:
  59 // Load: load new -> paste into master
  60 // Save: copy all of master
  61 // Undo: selective load into master
  62 // Copy: copy from master
  63 // Paste: load new -> paste into master
  64 // Copy automation: copy just automation from master
  65 // Paste automation: paste functions in automation
  66
  67
  68 class EDL : public Indexable
  69 {
  70 public:
  71         EDL(EDL *parent_edl = 0);
  72         ~EDL();
  73
  74         void create_objects();
  75         EDL& operator=(EDL &edl);
  76
  77 // Load configuration and track counts
  78         int load_defaults(BC_Hash *defaults);
  79         int save_defaults(BC_Hash *defaults);
  80 // Clip default settings to boundaries.
  81         void boundaries();
  82 // Create tracks using existing configuration
  83         int create_default_tracks();
  84         int load_xml(FileXML *file, uint32_t load_flags);
  85         int read_xml(FileXML *file, uint32_t load_flags);
  86         int save_xml(FileXML *xml, const char *output_path);
  87         int load_audio_config(FileXML *file, int append_mode, uint32_t load_flags);
  88         int load_video_config(FileXML *file, int append_mode, uint32_t load_flags);
  89
  90 // Return 1 if rendering requires a virtual console.
  91         int get_use_vconsole(VEdit* *playable_edit,
  92                 int64_t position,
  93                 int direction,
  94                 PlayableTracks *playable_tracks);
  95
  96 // Convert position to frame boundry times
  97         double frame_align(double position, int round);
  98 // frame align if cursor alignment is enabled
  99         double align_to_frame(double position, int round);
 100 // get position under cursor in pane, and inverse
 101         double get_cursor_position(int cursor_x, int pane_no);
 102         int64_t get_position_cursorx(double position, int pane_no);
 103
 104 // increase track w/h to at least session w/h
 105         void retrack();
 106 // Scale all sample values since everything is locked to audio
 107         void rechannel();
 108         void resample(double old_rate, double new_rate, int data_type);
 109
 110         int copy(double start, double end, int all,
 111                 FileXML *file, const char *output_path, int rewind_it);
 112         int copy(int all, FileXML *file, const char *output_path, int rewind_it);
 113
 114         int copy_clip(double start, double end, int all,
 115                 FileXML *file, const char *output_path, int rewind_it);
 116         int copy_clip(int all, FileXML *file, const char *output_path, int rewind_it);
 117
 118         int copy_nested_edl(double start, double end, int all,
 119                 FileXML *file, const char *output_path, int rewind_it);
 120         int copy_nested_edl(int all, FileXML *file, const char *output_path, int rewind_it);
 121
 122         int copy_vwindow_edl(double start, double end, int all,
 123                 FileXML *file, const char *output_path, int rewind_it);
 124         int copy_vwindow_edl(int all, FileXML *file, const char *output_path, int rewind_it);
 125
 126         void copy_tracks(EDL *edl);
 127 // Copies project path, folders, EDLSession, and LocalSession from edl argument.
 128 // session_only - used by preferences and format specify
 129 // whether to only copy EDLSession
 130         void copy_session(EDL *edl, int session_only = 0);
 131         int copy_all(EDL *edl);
 132         void copy_assets(EDL *edl);
 133         void copy_clips(EDL *edl);
 134         void copy_nested(EDL *edl);
 135         void copy_mixers(EDL *edl);
 136 // Copy pan and fade settings from edl
 137         void synchronize_params(EDL *edl);
 138 // Determine if the positions are equivalent if they're within half a frame
 139 // of each other.
 140         int equivalent(double position1, double position2);
 141 // Determine if the EDL's produce equivalent video output to the old EDL.
 142 // The new EDL is this and the old EDL is the argument.
 143 // Return the number of seconds from the beginning of this which are
 144 // equivalent to the argument.
 145 // If they're completely equivalent, -1 is returned;
 146 // This is used by BRender + BatchRender.
 147         double equivalent_output(EDL *edl);
 148 // Set project path for filename prefixes in the assets
 149         void set_path(const char *path);
 150 // Set points and labels
 151         void set_inpoint(double position);
 152         void set_outpoint(double position);
 153         void unset_inoutpoint();
 154 // Redraw resources during index builds
 155         void set_index_file(Indexable *indexable);
 156 // Add assets from the src to the destination
 157         void update_assets(EDL *src);
 158         void optimize();
 159 // return next/prev edit starting from position
 160         double next_edit(double position);
 161         double prev_edit(double position);
 162 // Debug
 163         int dump(FILE *fp=stdout);
 164         static int next_id();
 165 // folders
 166         BinFolder *get_folder(int no);
 167         int get_folder_number(const char *title);
 168         const char *get_folder_name(int no);
 169         int new_folder(const char *title, int is_clips);
 170         int delete_folder(const char *title);
 171         void delete_edits(ArrayList<Edit*>*, int);
 172         void delete_edit_labels(ArrayList<Edit*> *edits, int collapse);
 173         void move_edit_labels(ArrayList<Edit*> *edits, double dist);
 174
 175         void modify_edithandles(double oldposition,
 176                 double newposition,
 177                 int currentend,
 178                 int handle_mode,
 179                 int edit_labels,
 180                 int edit_plugins,
 181                 int edit_autos);
 182
 183         void modify_pluginhandles(double oldposition,
 184                 double newposition,
 185                 int currentend,
 186                 int handle_mode,
 187                 int edit_labels,
 188                 int edit_autos,
 189                 Edits *trim_edits);
 190
 191         int trim_selection(double start,
 192                 double end,
 193                 int edit_labels,
 194                 int edit_plugins,
 195                 int edit_autos);
 196
 197 // Editing functions
 198         int copy_assets(double start, double end,
 199                 FileXML *file, int all, const char *output_path);
 200         int copy(double start, double end, int all,
 201                 const char *closer, FileXML *file,
 202                 const char *output_path, int rewind_it);
 203         void copy_indexables(EDL *edl);
 204         EDL *new_nested(EDL *edl, const char *path);
 205         EDL *create_nested_clip(EDL *nested);
 206         void create_nested(EDL *nested);
 207         void paste_silence(double start, double end,
 208                 int edit_labels /* = 1 */,
 209                 int edit_plugins,
 210                 int edit_autos);
 211         int in_use(Indexable *indexable);
 212         void remove_from_project(ArrayList<Indexable*> *assets);
 213         void remove_from_project(ArrayList<EDL*> *clips);
 214         int blade(double position);
 215         int clear(double start, double end,
 216                 int clear_labels,
 217                 int clear_plugins,
 218                 int edit_autos);
 219         void deglitch(double position);
 220 // Insert the asset at a point in the EDL
 221         void insert_asset(Asset *asset,
 222                 EDL *nested_edl,
 223                 double position,
 224                 Track *first_track = 0,
 225                 RecordLabels *labels = 0);
 226 // Insert the clip at a point in the EDL
 227         int insert_clips(ArrayList<EDL*> *new_edls, int load_mode, Track *first_track = 0);
 228 // Add a copy of EDL* to the clip array.  Returns the copy.
 229         EDL* add_clip(EDL *edl);
 230 // resequence group ids starting at next_id
 231         int regroup(int next_id);
 232
 233         void get_shared_plugins(Track *source, ArrayList<SharedLocation*> *plugin_locations,
 234                 int omit_recordable, int data_type);
 235         void get_shared_tracks(Track *track, ArrayList<SharedLocation*> *module_locations,
 236                 int omit_recordable, int data_type);
 237
 238     int get_tracks_height(Theme *theme);
 239     int64_t get_tracks_width();
 240 // Return dimensions for canvas if smaller dimensions has zoom of 1
 241         void calculate_conformed_dimensions(int single_channel, float &w, float &h);
 242 // Get the total output size scaled to aspect ratio
 243         void output_dimensions_scaled(int &w, int &h);
 244         float get_aspect_ratio();
 245
 246
 247 // For Indexable
 248         int get_audio_channels();
 249         int get_sample_rate();
 250         int64_t get_audio_samples();
 251         int have_audio();
 252         int have_video();
 253         int get_w();
 254         int get_h();
 255         double get_frame_rate();
 256         int get_video_layers();
 257         int64_t get_video_frames();
 258
 259         EDL* get_vwindow_edl(int number);
 260         int total_vwindow_edls();
 261         void remove_vwindow_edls();
 262         void remove_vwindow_edl(EDL *edl);
 263 // Adds to list of EDLs & increase garbage collection counter
 264 // Does nothing if EDL already exists
 265         void append_vwindow_edl(EDL *edl, int increase_counter);
 266         void rescale_proxy(int orig_scale, int new_scale);
 267         void set_proxy(int new_scale, int use_scaler,
 268                 ArrayList<Indexable*> *orig_assets, ArrayList<Indexable*> *proxy_assets);
 269         void add_proxy(int use_scaler,
 270                 ArrayList<Indexable*> *orig_assets, ArrayList<Indexable*> *proxy_assets);
 271         Asset *get_proxy_asset();
 272         Track *add_new_track(int data_type);
 273
 274 // Titles of all subfolders
 275         BinFolders folders;
 276 // Clips, Nested EDLs
 277         ClipEDLs clips, nested_edls;
 278 // EDLs being shown in VWindows
 279         ArrayList<EDL*> vwindow_edls;
 280 // is the vwindow_edl shared and therefore should not be deleted in destructor
 281 //      int vwindow_edl_shared;
 282         Mixers mixers;
 283
 284 // Media files
 285 // Shared between all EDLs
 286         Assets *assets;
 287
 288         Tracks *tracks;
 289         Labels *labels;
 290 // Shared between all EDLs in a tree, for projects.
 291         EDLSession *session;
 292 // Specific to this EDL, for clips.
 293         LocalSession *local_session;
 294
 295 // Use parent Assets if nonzero
 296         EDL *parent_edl;
 297 };
 298
 299 #endif