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