4 * Copyright (C) 1997-2011 Adam Williams <broadcast at earthling dot net>
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.
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.
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
26 #include "awindowgui.h"
27 #include "batchrender.h"
28 #include "bcprogressbox.h"
29 #include "bcsignals.h"
32 #include "compresspopup.h"
33 #include "condition.h"
34 #include "confirmsave.h"
35 #include "cwindowgui.h"
40 #include "edlsession.h"
43 #include "filesystem.h"
45 #include "formatcheck.h"
46 #include "formatpopup.h"
47 #include "formattools.h"
48 #include "indexable.h"
52 #include "localsession.h"
53 #include "mainprogress.h"
54 #include "mainsession.h"
58 #include "mwindowgui.h"
60 #include "packagedispatcher.h"
61 #include "packagerenderer.h"
63 #include "playabletracks.h"
64 #include "preferences.h"
65 #include "preferencesthread.h"
66 #include "quicktime.h"
67 #include "renderfarm.h"
69 #include "statusbar.h"
73 #include "transportque.h"
76 #include "videoconfig.h"
84 RenderItem::RenderItem(MWindow *mwindow)
85 : BC_MenuItem(_("Render..."), _("Shift+R"), 'R')
87 this->mwindow = mwindow;
91 int RenderItem::handle_event()
93 mwindow->gui->unlock_window();
94 mwindow->render->start_interactive();
95 mwindow->gui->lock_window("RenderItem::handle_event");
108 RenderProgress::RenderProgress(MWindow *mwindow, Render *render)
111 this->mwindow = mwindow;
112 this->render = render;
114 Thread::set_synchronous(1);
117 RenderProgress::~RenderProgress()
124 void RenderProgress::run()
126 Thread::disable_cancel();
129 if(render->total_rendered != last_value)
131 render->progress->update(render->total_rendered);
132 last_value = render->total_rendered;
134 if(mwindow) mwindow->preferences_thread->update_rates();
137 Thread::enable_cancel();
139 Thread::disable_cancel();
152 MainPackageRenderer::MainPackageRenderer(Render *render)
155 this->render = render;
160 MainPackageRenderer::~MainPackageRenderer()
165 int MainPackageRenderer::get_master()
170 int MainPackageRenderer::get_result()
172 return render->result;
175 void MainPackageRenderer::set_result(int value)
178 render->result = value;
184 void MainPackageRenderer::set_progress(int64_t value)
186 render->counter_lock->lock("MainPackageRenderer::set_progress");
187 // Increase total rendered for all nodes
188 render->total_rendered += value;
190 // Update frames per second for master node
191 render->preferences->set_rate(frames_per_second, -1);
193 //printf("MainPackageRenderer::set_progress %d %ld %f\n", __LINE__, (long)value, frames_per_second);
195 // If non interactive, print progress out
196 if(!render->progress)
198 int64_t current_eta = render->progress_timer->get_scaled_difference(1000);
199 if(current_eta - render->last_eta > 1000)
204 if(render->total_rendered)
208 render->progress_max /
209 render->total_rendered -
214 char string[BCTEXTLEN];
215 Units::totext(string,
219 printf(_("\r%d%% ETA: %s "), (int)(100 *
220 (float)render->total_rendered /
221 render->progress_max),
224 render->last_eta = current_eta;
228 render->counter_lock->unlock();
230 // This locks the preferences
231 if(mwindow) mwindow->preferences->copy_rates_from(preferences);
234 int MainPackageRenderer::progress_cancelled()
236 return (render->progress && render->progress->is_cancelled()) ||
237 render->batch_cancelled;
251 Render::Render(MWindow *mwindow)
254 this->mwindow = mwindow;
259 package_lock = new Mutex("Render::package_lock");
260 counter_lock = new Mutex("Render::counter_lock");
261 completion = new Condition(0, "Render::completion");
262 progress_timer = new Timer;
263 thread = new RenderThread(mwindow, this);
273 // May be owned by someone else. This is owned by mwindow, so we don't care
275 // delete preferences;
276 delete progress_timer;
277 if( asset ) asset->Garbage::remove_user();
281 void Render::start_interactive()
283 if(!thread->running())
285 mode = Render::INTERACTIVE;
286 BC_DialogThread::start();
290 ErrorBox error_box(_(PROGRAM_NAME ": Error"),
291 mwindow->gui->get_abs_cursor_x(1),
292 mwindow->gui->get_abs_cursor_y(1));
293 error_box.create_objects(_("Already rendering"));
294 error_box.raise_window();
295 error_box.run_window();
300 void Render::start_batches(ArrayList<BatchRenderJob*> *jobs)
302 if(!thread->running())
304 mode = Render::BATCH;
312 void Render::start_batches(ArrayList<BatchRenderJob*> *jobs,
313 BC_Hash *boot_defaults,
314 Preferences *preferences)
316 mode = Render::BATCH;
319 this->preferences = preferences;
325 this->preferences = 0;
329 BC_Window* Render::new_gui()
336 RenderWindow *window = 0;
338 if(mode == Render::INTERACTIVE)
340 // Fix the asset for rendering
341 if(!asset) asset = new Asset;
342 load_defaults(asset);
343 check_asset(mwindow->edl, *asset);
345 // Get format from user
346 window = new RenderWindow(mwindow,
349 mwindow->gui->get_abs_cursor_x(1),
350 mwindow->gui->get_abs_cursor_y(1));
351 window->create_objects();
362 void Render::handle_close_event(int result)
364 int format_error = 0;
369 if(debug) printf("Render::handle_close_event %d\n", __LINE__);
370 // Check the asset format for errors.
371 FormatCheck format_check(asset);
372 if(debug) printf("Render::handle_close_event %d\n", __LINE__);
373 format_error = format_check.check_format();
374 if(debug) printf("Render::handle_close_event %d\n", __LINE__);
379 save_defaults(asset);
381 mwindow->save_defaults();
384 if(!format_error && !result)
386 if(debug) printf("Render::handle_close_event %d\n", __LINE__);
387 if(!result) start_render();
388 if(debug) printf("Render::handle_close_event %d\n", __LINE__);
395 void Render::stop_operation()
397 if(thread->Thread::running())
400 // Wait for completion
401 completion->lock("Render::stop_operation");
409 int Render::check_asset(EDL *edl, Asset &asset)
411 if(asset.video_data &&
412 edl->tracks->playable_video_tracks() &&
413 File::supports_video(asset.format))
415 asset.video_data = 1;
417 asset.width = edl->session->output_w;
418 asset.height = edl->session->output_h;
422 asset.video_data = 0;
426 if(asset.audio_data &&
427 edl->tracks->playable_audio_tracks() &&
428 File::supports_audio(asset.format))
430 asset.audio_data = 1;
431 asset.channels = edl->session->audio_channels;
432 if(asset.format == FILE_MOV) asset.byte_order = 0;
436 asset.audio_data = 0;
440 if(!asset.audio_data &&
448 int Render::fix_strategy(int strategy, int use_renderfarm)
452 if(strategy == FILE_PER_LABEL)
453 strategy = FILE_PER_LABEL_FARM;
455 if(strategy == SINGLE_PASS)
456 strategy = SINGLE_PASS_FARM;
460 if(strategy == FILE_PER_LABEL_FARM)
461 strategy = FILE_PER_LABEL;
463 if(strategy == SINGLE_PASS_FARM)
464 strategy = SINGLE_PASS;
469 void Render::start_progress()
471 char filename[BCTEXTLEN];
472 char string[BCTEXTLEN];
475 progress_max = Units::to_int64(default_asset->sample_rate *
476 (total_end - total_start)) +
477 Units::to_int64(preferences->render_preroll *
478 packages->total_allocated *
479 default_asset->sample_rate);
480 progress_timer->update();
484 // Generate the progress box
485 fs.extract_name(filename, default_asset->path);
486 sprintf(string, _("Rendering %s..."), filename);
488 // Don't bother with the filename since renderfarm defeats the meaning
489 progress = mwindow->mainprogress->start_progress(_("Rendering..."),
491 render_progress = new RenderProgress(mwindow, this);
492 render_progress->start();
496 void Render::stop_progress()
500 char string[BCTEXTLEN], string2[BCTEXTLEN];
501 delete render_progress;
502 progress->get_time(string);
503 elapsed_time = progress->get_time();
504 progress->stop_progress();
507 sprintf(string2, _("Rendering took %s"), string);
508 mwindow->gui->lock_window("");
509 mwindow->gui->show_message(string2);
510 mwindow->gui->stop_hourglass();
511 mwindow->gui->unlock_window();
518 void Render::start_render()
527 void Render::create_filename(char *path,
534 int len = strlen(default_path);
535 char printf_string[BCTEXTLEN];
537 for(i = 0, j = 0; i < number_start; i++, j++)
539 printf_string[j] = default_path[i];
543 sprintf(&printf_string[j], "%%0%dd", total_digits);
544 j = strlen(printf_string);
547 // Copy remainder of string
548 for( ; i < len; i++, j++)
550 printf_string[j] = default_path[i];
552 printf_string[j] = 0;
553 // Print the printf argument to the path
554 sprintf(path, printf_string, current_number);
557 void Render::get_starting_number(char *path,
563 int len = strlen(path);
564 char number_text[BCTEXTLEN];
572 ptr2 = strrchr(path, '/');
574 // Search for first 0 after last /.
576 ptr = strchr(ptr2, '0');
578 if(ptr && isdigit(*ptr))
580 number_start = ptr - path;
582 // Store the first number
583 char *ptr2 = number_text;
587 current_number = atol(number_text);
588 total_digits = strlen(number_text);
592 // No number found or number not long enough
593 if(total_digits < min_digits)
597 total_digits = min_digits;
607 int Render::load_defaults(Asset *asset)
609 strategy = mwindow->defaults->get("RENDER_STRATEGY", SINGLE_PASS);
610 load_mode = mwindow->defaults->get("RENDER_LOADMODE", LOADMODE_NEW_TRACKS);
613 asset->load_defaults(mwindow->defaults,
625 int Render::save_defaults(Asset *asset)
627 mwindow->defaults->update("RENDER_STRATEGY", strategy);
628 mwindow->defaults->update("RENDER_LOADMODE", load_mode);
633 asset->save_defaults(mwindow->defaults,
649 static void run_script(const char *script, const char *arg)
651 char *const argv[] = { (char*)script, (char*)arg, 0 };
652 execvp(script ,&argv[0]);
653 perror("execvp script failed");
657 RenderThread::RenderThread(MWindow *mwindow, Render *render)
660 this->mwindow = mwindow;
661 this->render = render;
664 RenderThread::~RenderThread()
669 void RenderThread::render_single(int test_overwrite,
674 // Total length in seconds
676 RenderFarmServer *farm_server = 0;
681 render->in_progress = 1;
684 render->default_asset = asset;
685 render->progress = 0;
690 if(!render->preferences)
691 render->preferences = new Preferences;
693 render->preferences->copy_from(mwindow->preferences);
697 // Create rendering command
698 TransportCommand *command = new TransportCommand;
699 command->command = NORMAL_FWD;
700 command->get_edl()->copy_all(edl);
701 command->change_type = CHANGE_ALL;
702 // Get highlighted playback range
703 command->set_playback_range();
704 // Adjust playback range with in/out points
705 command->adjust_playback_range();
706 render->packages = new PackageDispatcher;
709 CICache *audio_cache = new CICache(render->preferences);
710 CICache *video_cache = new CICache(render->preferences);
712 render->default_asset->frame_rate = command->get_edl()->session->frame_rate;
713 render->default_asset->sample_rate = command->get_edl()->session->sample_rate;
715 // Conform asset to EDL. Find out if any tracks are playable.
716 render->result = render->check_asset(command->get_edl(),
717 *render->default_asset);
721 // Get total range to render
722 render->total_start = command->start_position;
723 render->total_end = command->end_position;
724 total_length = render->total_end - render->total_start;
727 if(EQUIV(total_length, 0))
742 // Stop background rendering
743 if(mwindow) mwindow->stop_brender();
745 fs.complete_path(render->default_asset->path);
746 strategy = Render::fix_strategy(strategy, render->preferences->use_renderfarm);
748 render->result = render->packages->create_packages(mwindow,
752 render->default_asset,
768 render->total_rendered = 0;
772 // Start dispatching external jobs
775 mwindow->gui->lock_window("Render::render 1");
776 mwindow->gui->show_message(_("Starting render farm"));
777 mwindow->gui->start_hourglass();
778 mwindow->gui->unlock_window();
782 printf("Render::render: starting render farm\n");
785 if(strategy == SINGLE_PASS_FARM || strategy == FILE_PER_LABEL_FARM)
787 farm_server = new RenderFarmServer(mwindow,
792 &render->total_rendered,
793 render->counter_lock,
794 render->default_asset,
797 render->result = farm_server->start_clients();
803 mwindow->gui->lock_window("Render::render 2");
804 mwindow->gui->show_message(_("Failed to start render farm"),
805 mwindow->theme->message_error);
806 mwindow->gui->stop_hourglass();
807 mwindow->gui->unlock_window();
811 printf("Render::render: Failed to start render farm\n");
820 // Perform local rendering
825 render->start_progress();
830 MainPackageRenderer package_renderer(render);
831 render->result = package_renderer.initialize(mwindow,
832 command->get_edl(), // Copy of master EDL
834 render->default_asset);
842 while(!render->result)
844 // Get unfinished job
845 RenderPackage *package;
847 if(strategy == SINGLE_PASS_FARM)
849 package = render->packages->get_package(
850 package_renderer.frames_per_second,
856 package = render->packages->get_package(0, -1, 1);
871 if(package_renderer.render_package(package))
879 printf("Render::render_single: Session finished.\n");
885 if(strategy == SINGLE_PASS_FARM || strategy == FILE_PER_LABEL_FARM)
887 farm_server->wait_clients();
890 if(debug) printf("Render::render %d\n", __LINE__);
894 (!render->progress || !render->progress->is_cancelled()) &&
895 !render->batch_cancelled)
897 if(debug) printf("Render::render %d\n", __LINE__);
900 if(debug) printf("Render::render %d\n", __LINE__);
901 ErrorBox error_box(_(PROGRAM_NAME ": Error"),
902 mwindow->gui->get_abs_cursor_x(1),
903 mwindow->gui->get_abs_cursor_y(1));
904 error_box.create_objects(_("Error rendering data."));
905 error_box.raise_window();
906 error_box.run_window();
907 if(debug) printf("Render::render %d\n", __LINE__);
911 printf("Render::render: Error rendering data\n");
914 if(debug) printf("Render::render %d\n", __LINE__);
916 // Delete the progress box
917 render->stop_progress();
919 if(debug) printf("Render::render %d\n", __LINE__);
927 // Paste all packages into timeline if desired
929 if(!render->result &&
930 render->load_mode != LOADMODE_NOTHING &&
932 render->mode != Render::BATCH)
934 if(debug) printf("Render::render %d\n", __LINE__);
935 mwindow->gui->lock_window("Render::render 3");
936 if(debug) printf("Render::render %d\n", __LINE__);
938 mwindow->undo->update_undo_before();
940 if(debug) printf("Render::render %d\n", __LINE__);
943 ArrayList<Indexable*> *assets = render->packages->get_asset_list();
944 if(debug) printf("Render::render %d\n", __LINE__);
945 if(render->load_mode == LOADMODE_PASTE)
947 if(debug) printf("Render::render %d\n", __LINE__);
948 mwindow->load_assets(assets,
953 mwindow->edl->session->labels_follow_edits,
954 mwindow->edl->session->plugins_follow_edits,
955 mwindow->edl->session->autos_follow_edits);
956 if(debug) printf("Render::render %d\n", __LINE__);
957 for(int i = 0; i < assets->size(); i++)
958 assets->get(i)->Garbage::remove_user();
960 if(debug) printf("Render::render %d\n", __LINE__);
963 mwindow->save_backup();
964 if(debug) printf("Render::render %d\n", __LINE__);
965 mwindow->undo->update_undo_after(_("render"), LOAD_ALL);
966 if(debug) printf("Render::render %d\n", __LINE__);
967 mwindow->update_plugin_guis();
968 if(debug) printf("Render::render %d\n", __LINE__);
969 mwindow->gui->update(1,
976 if(debug) printf("Render::render %d\n", __LINE__);
977 mwindow->sync_parameters(CHANGE_ALL);
978 if(debug) printf("Render::render %d\n", __LINE__);
979 mwindow->gui->unlock_window();
982 mwindow->awindow->gui->lock_window("Render::render");
983 mwindow->awindow->gui->update_assets();
984 mwindow->awindow->gui->flush();
985 mwindow->awindow->gui->unlock_window();
987 if(debug) printf("Render::render %d\n", __LINE__);
990 if(debug) printf("Render::render %d\n", __LINE__);
995 mwindow->gui->lock_window("Render::render 3");
996 mwindow->gui->stop_hourglass();
997 mwindow->gui->unlock_window();
1000 //printf("Render::render 110\n");
1001 // Need to restart because brender always stops before render.
1003 mwindow->restart_brender();
1004 if(farm_server) delete farm_server;
1008 // Must delete packages after server
1009 delete render->packages;
1011 render->packages = 0;
1012 render->in_progress = 0;
1013 render->completion->unlock();
1014 if(debug) printf("Render::render %d\n", __LINE__);
1017 void RenderThread::run()
1019 if(render->mode == Render::INTERACTIVE)
1021 render_single(1, render->asset, mwindow->edl, render->strategy);
1024 if(render->mode == Render::BATCH)
1027 // printf("RenderThread::run %d %d %d\n",
1029 // render->jobs->total,
1031 for(int i = 0; i < render->jobs->total && !render->result; i++)
1034 BatchRenderJob *job = render->jobs->values[i];
1038 if( *job->edl_path == '@' )
1040 run_script(job->edl_path+1, job->asset->path);
1045 mwindow->batch_render->update_active(i);
1049 printf("Render::run: %s\n", job->edl_path);
1054 FileXML *file = new FileXML;
1056 edl->create_objects();
1057 file->read_from_file(job->edl_path);
1058 edl->load_xml(file, LOAD_ALL);
1061 render_single(0, job->asset, edl, job->strategy);
1064 edl->Garbage::remove_user();
1069 mwindow->batch_render->update_done(i, 1, render->elapsed_time);
1072 char string[BCTEXTLEN];
1073 render->elapsed_time =
1074 (double)render->progress_timer->get_scaled_difference(1);
1075 Units::totext(string,
1076 render->elapsed_time,
1078 printf("Render::run: done in %s\n", string);
1084 mwindow->batch_render->update_active(-1);
1086 printf("Render::run: failed\n");
1094 mwindow->batch_render->update_active(-1);
1095 mwindow->batch_render->update_done(-1, 0, 0);
1112 RenderWindow::RenderWindow(MWindow *mwindow,
1117 : BC_Window(_(PROGRAM_NAME ": Render"),
1128 this->mwindow = mwindow;
1129 this->render = render;
1130 this->asset = asset;
1133 RenderWindow::~RenderWindow()
1136 lock_window("RenderWindow::~RenderWindow");
1138 delete format_tools;
1148 void RenderWindow::create_objects()
1151 lock_window("RenderWindow::create_objects");
1152 add_subwindow(new BC_Title(x,
1154 (char*)((render->strategy == FILE_PER_LABEL ||
1155 render->strategy == FILE_PER_LABEL_FARM) ?
1156 _("Select the first file to render to:") :
1157 _("Select a file to render to:"))));
1160 format_tools = new FormatTools(mwindow,
1163 format_tools->create_objects(x,
1176 loadmode = new LoadMode(mwindow,
1183 loadmode->create_objects();
1185 add_subwindow(new BC_OKButton(this));
1186 add_subwindow(new BC_CancelButton(this));