Credit Andrew - improve in-tree documentation
[goodguy/cinelerra.git] / cinelerra-5.1 / cinelerra / render.h
1
2 /*
3  * CINELERRA
4  * Copyright (C) 2008 Adam Williams <broadcast at earthling dot net>
5  * Copyright (C) 2003-2016 Cinelerra CV contributors
6  *
7  * This program is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software
19  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
20  *
21  */
22
23 #ifndef RENDER_H
24 #define RENDER_H
25
26
27 #include "asset.inc"
28 #include "batchrender.inc"
29 #include "bcdialog.h"
30 #include "bitspopup.h"
31 #include "browsebutton.h"
32 #include "cache.inc"
33 #include "compresspopup.h"
34 #include "condition.inc"
35 #include "bchash.inc"
36 #include "edit.inc"
37 #include "errorbox.inc"
38 #include "file.inc"
39 #include "formatpopup.inc"
40 #include "formattools.h"
41 #include "guicast.h"
42 #include "loadmode.inc"
43 #include "mainprogress.inc"
44 #include "maxchannels.h"
45 #include "mutex.inc"
46 #include "mwindow.inc"
47 #include "packagedispatcher.inc"
48 #include "packagerenderer.h"
49 #include "playabletracks.inc"
50 #include "preferences.inc"
51 #include "bcprogressbox.inc"
52 #include "render.inc"
53 #include "track.inc"
54 #include "transportque.inc"
55 #include "vframe.inc"
56 #include "renderprofiles.inc"
57
58
59 class RenderItem : public BC_MenuItem
60 {
61 public:
62         RenderItem(MWindow *mwindow);
63         int handle_event();
64         MWindow *mwindow;
65 };
66
67 class RenderProgress : public Thread
68 {
69 public:
70         RenderProgress(MWindow *mwindow, Render *render);
71         ~RenderProgress();
72
73         void run();
74
75
76         MWindow *mwindow;
77         Render *render;
78
79         int64_t last_value;
80 };
81
82
83
84 class MainPackageRenderer : public PackageRenderer
85 {
86 public:
87         MainPackageRenderer(Render *render);
88         ~MainPackageRenderer();
89
90
91         int get_master();
92         int get_result();
93         void set_result(int value);
94         void set_progress(int64_t value);
95         int progress_cancelled();
96
97         Render *render;
98 };
99
100 class RenderWindow;
101
102 class RenderAssets : public ArrayList<Indexable *>
103 {
104 public:
105         RenderAssets();
106         ~RenderAssets();
107
108         void clear();
109 };
110
111 class Render : public BC_DialogThread
112 {
113 public:
114         Render(MWindow *mwindow);
115         ~Render();
116
117 // Start dialogue box and render interactively.
118         void start_interactive();
119 // Start batch rendering jobs.
120 // A new thread is created and the rendering is interactive.
121         void start_batches(ArrayList<BatchRenderJob*> *jobs);
122 // The batches are processed in the foreground in non interactive mode.
123         void start_batches(ArrayList<BatchRenderJob*> *jobs,
124                 BC_Hash *boot_defaults, Preferences *batch_prefs);
125 // Called by BatchRender to stop the operation.
126         void stop_operation();
127         BC_Window* new_gui();
128
129         void handle_done_event(int result);
130         void handle_close_event(int result);
131         void start_render();
132
133         int load_defaults(Asset *asset);
134         int save_defaults(Asset *asset);
135         int load_profile(int profile_slot, Asset *asset);
136         double get_render_range();
137 // force asset parameters regardless of window
138 // This should be integrated into the Asset Class.
139         static int check_asset(EDL *edl, Asset &asset);
140 // strategy to conform with using renderfarm.
141         static int get_strategy(int use_renderfarm, int use_labels, int range_type);
142         int get_strategy();
143 // Force filename to have a 0 padded number if rendering to a list.
144         int check_numbering(Asset &asset);
145         static void create_filename(char *path,
146                 char *default_path,
147                 int current_number,
148                 int total_digits,
149                 int number_start);
150         static void get_starting_number(char *path,
151                 int &current_number,
152                 int &number_start,
153                 int &total_digits,
154                 int min_digits = 3);
155         int direct_frame_copy(EDL *edl, int64_t &render_video_position, File *file);
156         int direct_copy_possible(EDL *edl,
157                         int64_t current_position,
158                         Track* playable_track,  // The one track which is playable
159                         Edit* &playable_edit, // The edit which is playing
160                         File *file);   // Output file
161
162         void start_progress();
163         void stop_progress();
164         void show_progress();
165         void update_assets();
166
167 // Procedure the run function should use.
168         int mode;
169         enum
170         {
171                 INTERACTIVE,
172                 BATCH
173         };
174 // When batch rendering is cancelled from the batch dialog
175         int batch_cancelled;
176
177
178         int load_mode;
179         int in_progress;
180 // Background compression must be disabled when direct frame copying and reenabled afterwards
181         int direct_frame_copying;
182 // beep on done
183         float beep;
184
185         Preferences *preferences;
186         VFrame *compressed_output;
187         MainProgressBar *progress;
188         RenderProgress *render_progress;
189         RenderThread *thread;
190         RenderAssets assets;
191         MWindow *mwindow;
192         PlayableTracks *playable_tracks;
193         PackageDispatcher *packages;
194         Mutex *package_lock, *counter_lock;
195         int use_labels;
196         int range_type;
197 // Total selection to render in seconds
198         double total_start, total_end;
199 // External Render farm checks this every frame.
200         int result;
201         Asset *default_asset;
202 // Asset containing the file format
203         Asset *asset;
204 // Jobs pointer passed to start_batches
205         ArrayList<BatchRenderJob*> *jobs;
206 // Used by batch rendering to wait until rendering is finished
207         Condition *completion;
208
209 // Total samples updated by the render farm and the local renderer.
210 // This avoids rounding errors and complies with the use of samples for
211 // timing.
212         int64_t total_rendered;
213 // Time used in last render
214         double elapsed_time;
215
216 // Current open RenderWindow
217         RenderWindow *render_window;
218
219 // For non interactive mode, maintain progress here.
220         int64_t progress_max;
221         Timer *progress_timer;
222         int64_t last_eta;
223 };
224
225
226 class RenderThread : public Thread
227 {
228 public:
229         RenderThread(MWindow *mwindow, Render *render);
230         ~RenderThread();
231
232         void run();
233
234         void render_single(int test_overwrite,
235                 Asset *asset,
236                 EDL *edl,
237                 int strategy,
238                 int range_type);
239
240         MWindow *mwindow;
241         Render *render;
242         int64_t render_frames;
243 };
244
245 class RenderToTracks;
246
247
248 class RenderRangeProject : public BC_Radial
249 {
250 public:
251         RenderRangeProject(RenderWindow *rwindow, int value, int x, int y);
252         int handle_event();
253         RenderWindow *rwindow;
254 };
255
256 class RenderRangeSelection : public BC_Radial
257 {
258 public:
259         RenderRangeSelection(RenderWindow *rwindow, int value, int x, int y);
260         int handle_event();
261         RenderWindow *rwindow;
262 };
263
264
265 class RenderRangeInOut : public BC_Radial
266 {
267 public:
268         RenderRangeInOut(RenderWindow *rwindow, int value, int x, int y);
269         int handle_event();
270         RenderWindow *rwindow;
271 };
272
273
274 class RenderRange1Frame : public BC_Radial
275 {
276 public:
277         RenderRange1Frame(RenderWindow *rwindow, int value, int x, int y);
278         int handle_event();
279         RenderWindow *rwindow;
280 };
281
282
283 class RenderFormat : public FormatTools
284 {
285 public:
286         RenderFormat(MWindow *mwindow, BC_WindowBase *window, Asset *asset);
287         ~RenderFormat();
288         void update_format();
289         int handle_event();
290 };
291
292
293 class RenderBeepOnDone : public BC_FPot
294 {
295 public:
296         RenderBeepOnDone(RenderWindow *rwindow, int x, int y);
297         int handle_event();
298
299         RenderWindow *rwindow;
300 };
301
302
303 class RenderWindow : public BC_Window
304 {
305 public:
306         RenderWindow(MWindow *mwindow,
307                 Render *render,
308                 Asset *asset,
309                 int x,
310                 int y);
311         ~RenderWindow();
312
313         void create_objects();
314         void enable_render_range(int v);
315         void update_range_type(int range_type);
316         void load_profile(int profile_slot);
317
318         RenderRangeProject *rangeproject;
319         RenderRangeSelection *rangeselection;
320         RenderRangeInOut *rangeinout;
321         RenderRange1Frame *range1frame;
322         RenderBeepOnDone *beep_on_done;
323
324         RenderProfile *renderprofile;
325
326         LoadMode *loadmode;
327         BC_Title *file_format;
328         RenderFormat *render_format;
329
330         MWindow *mwindow;
331         Render *render;
332         Asset *asset;
333 };
334
335 #endif