Credit Andrew - improve in-tree documentation
[goodguy/cinelerra.git] / cinelerra / edlsession.h
1
2 /*
3  * CINELERRA
4  * Copyright (C) 2008-2015 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 EDLSESSION_H
23 #define EDLSESSION_H
24
25 #include "asset.inc"
26 #include "autoconf.inc"
27 #include "bcwindowbase.inc"
28 #include "bchash.inc"
29 #include "edl.inc"
30 #include "filexml.inc"
31 #include "maxchannels.h"
32 #include "playbackconfig.inc"
33 #include "recordconfig.inc"
34
35
36 // Session shared between all clips
37
38
39 class EDLSession
40 {
41 public:
42         EDLSession(EDL *edl);
43         ~EDLSession();
44
45         int load_xml(FileXML *xml, int append_mode, uint32_t load_flags);
46         int save_xml(FileXML *xml);
47         int copy(EDLSession *session);
48         int load_audio_config(FileXML *file, int append_mode, uint32_t load_flags);
49         int save_audio_config(FileXML *xml);
50         int load_video_config(FileXML *file, int append_mode, uint32_t load_flags);
51         int save_video_config(FileXML *xml);
52         int load_defaults(BC_Hash *defaults);
53         int save_defaults(BC_Hash *defaults);
54         void boundaries();
55
56 //      PlaybackConfig* get_playback_config(int strategy, int head);
57 //      ArrayList<PlaybackConfig*>* get_playback_config(int strategy);
58 //      int get_playback_heads(int strategy);
59
60 // Called by PreferencesThread to determine if preference changes need to be
61 // rendered.
62         int need_rerender(EDLSession *ptr);
63 // Called by BRender to determine if any background rendered frames are valid.
64         void equivalent_output(EDLSession *session, double *result);
65         void dump();
66
67 // Audio
68         int achannel_positions[MAXCHANNELS];
69 // AWindow format
70         int assetlist_format;
71 // AWindow column widths
72         int asset_columns[ASSET_COLUMNS];
73         AutoConf *auto_conf;
74 // Aspect ratio for video
75         float aspect_w;
76         float aspect_h;
77         int audio_channels;
78         int audio_tracks;
79 // automation follows edits during editing
80         int autos_follow_edits;
81 // Generate keyframes for every tweek
82         int auto_keyframes;
83 // Where to do background rendering
84         double brender_start;
85         double brender_end;
86 // Length of clipboard if pasting
87         double clipboard_length;
88 // Colormodel for intermediate frames
89         int color_model;
90 // Interlace Mode for entire project
91         int interlace_mode;
92 // Coords for cropping operation
93         int crop_x1, crop_x2, crop_y1, crop_y2;
94 // radius of eyedropper
95         int eyedrop_radius;
96         float ruler_x1, ruler_y1;
97         float ruler_x2, ruler_y2;
98 // Ruler points relative to the output frame.
99 // Current folder in resource window
100         int awindow_folder;
101 // align cursor on frame boundaries
102         int cursor_on_frames;
103 // paste keyframes to any track type
104         int typeless_keyframes;
105 // Destination item for CWindow
106         int cwindow_dest;
107 // Current submask being edited in CWindow
108         int cwindow_mask;
109 // Use the cwindow or not
110         int cwindow_meter;
111 // CWindow tool currently selected
112         int cwindow_operation;
113 // Use scrollbars in the CWindow
114         int cwindow_scrollbars;
115 // Scrollbar positions
116         int cwindow_xscroll;
117         int cwindow_yscroll;
118         float cwindow_zoom;
119         int cwindow_click2play;
120 // Transition
121         char default_atransition[BCTEXTLEN];
122         char default_vtransition[BCTEXTLEN];
123 // Length in seconds
124         double default_transition_length;
125 // Edit mode to use for each mouse button
126         int edit_handle_mode[3];
127 // Editing mode
128         int editing_mode;
129         EDL *edl;
130         int enable_duplex;
131 // AWindow format
132         int folderlist_format;
133         double frame_rate;
134         float frames_per_foot;
135 // Number of highlighted track
136         int highlighted_track;
137 // Enumeration for how to scale from edl.inc.
138         int interpolation_type;
139 // Whether to interpolate CR2 images
140         int interpolate_raw;
141 // Whether to white balance CR2 images
142         int white_balance_raw;
143 // labels follow edits during editing
144         int labels_follow_edits;
145         int plugins_follow_edits;
146 // For main menu plugin attaching,
147 // // attach 1 standalone on the first track and share it with other tracks
148         int single_standalone;
149         int meter_format;
150         int min_meter_db;
151         int max_meter_db;
152         int output_w;
153         int output_h;
154         int64_t playback_buffer;
155         int playback_cursor_visible;
156         int64_t playback_preload;
157         int decode_subtitles;
158         int subtitle_number;
159         int label_cells;
160         int program_no;
161         int playback_software_position;
162 // current settings are scaled this much from the original settings
163         int proxy_scale;
164 // original proxy_scale when proxy_enable disables/enables proxy
165         int proxy_disabled_scale;
166 // upscale geom from proxy to session on read in
167         int proxy_use_scaler;
168 // automatically rescale assets when loaded
169         int proxy_auto_scale;
170 // beep when proxy/render done
171         int proxy_beep, render_beep;
172 //      int playback_strategy;
173 // Play audio in realtime priority
174         int real_time_playback;
175         int real_time_record;
176 // Use record positioning selection
177         int record_positioning;
178 // Record undecoded stream data
179         int record_raw_stream;
180 // Sync the drives during recording
181         int record_sync_drives;
182 // Speed of meters when recording
183         int record_speed;
184 // Samples to read from device at a time
185         int record_fragment_size;
186 // Samples to write to disk at a time
187         int64_t record_write_length;
188 // Realtime TOC generation for DVB mpeg recording
189         int record_realtime_toc;
190 // Show title and action safe regions in CWindow
191         int safe_regions;
192         int64_t sample_rate;
193         float scrub_speed;
194 // Load files as a duration
195         int si_useduration;
196         float si_duration;
197 // Show assets in track canvas
198         int show_assets;
199 // Show titles in resources
200         int show_titles;
201 // Test for data before rendering a track
202         int test_playback_edits;
203 // Format to display times in
204         int time_format;
205 // Offset for timecode
206         int timecode_offset[4];
207 // Format to display nudge in, either seconds or track units.
208         int nudge_format;
209 // Show tool window in CWindow
210         int tool_window;
211 // Location of video outs
212         int vchannel_x[MAXCHANNELS];
213         int vchannel_y[MAXCHANNELS];
214 // Recording
215         int video_channels;
216         VideoInConfig *vconfig_in;
217         AudioInConfig *aconfig_in;
218         Asset *recording_format;
219 // play every frame
220         int video_every_frame;
221 // decode video asynchronously
222 //      int video_asynchronous;
223         int video_tracks;
224 // number of frames to write to disk at a time during video recording.
225         int video_write_length;
226         int view_follows_playback;
227 // Use the vwindow meter or not
228         int vwindow_meter;
229         float vwindow_zoom;
230         int vwindow_click2play;
231
232 // Global ID counter
233         static int current_id;
234         PlaybackConfig* playback_config;
235
236 private:
237 // Global playback.  This is loaded from defaults but not from XML probably
238 // because it was discovered to be the most convenient.
239 // It is part of the EDL probably because the playback setting was
240 // going to be bound to the EDL.
241 //      ArrayList<PlaybackConfig*> playback_config[PLAYBACK_STRATEGIES];
242 };
243
244
245 #endif