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