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 "renderfarm.h"
68 #include "renderprofiles.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();
145 MainPackageRenderer::MainPackageRenderer(Render *render)
148 this->render = render;
153 MainPackageRenderer::~MainPackageRenderer()
158 int MainPackageRenderer::get_master()
163 int MainPackageRenderer::get_result()
165 return render->result;
168 void MainPackageRenderer::set_result(int value)
171 render->result = value;
177 void MainPackageRenderer::set_progress(int64_t value)
179 render->counter_lock->lock("MainPackageRenderer::set_progress");
180 // Increase total rendered for all nodes
181 render->total_rendered += value;
183 // Update frames per second for master node
184 render->preferences->set_rate(frames_per_second, -1);
186 //printf("MainPackageRenderer::set_progress %d %ld %f\n", __LINE__, (long)value, frames_per_second);
188 // If non interactive, print progress out
189 if(!render->progress)
191 int64_t current_eta = render->progress_timer->get_scaled_difference(1000);
192 if(current_eta - render->last_eta > 1000)
197 if(render->total_rendered)
201 render->progress_max /
202 render->total_rendered -
207 char string[BCTEXTLEN];
208 Units::totext(string,
212 printf("\r%d%% %s: %s ",
213 (int)(100 * (float)render->total_rendered / render->progress_max),
216 render->last_eta = current_eta;
220 render->counter_lock->unlock();
222 // This locks the preferences
223 if(mwindow) mwindow->preferences->copy_rates_from(preferences);
226 int MainPackageRenderer::progress_cancelled()
228 return (render->progress && render->progress->is_cancelled()) ||
229 render->batch_cancelled;
233 Render::Render(MWindow *mwindow)
236 this->mwindow = mwindow;
241 package_lock = new Mutex("Render::package_lock");
242 counter_lock = new Mutex("Render::counter_lock");
243 completion = new Condition(0, "Render::completion");
244 progress_timer = new Timer;
245 range_type = RANGE_BACKCOMPAT;
246 thread = new RenderThread(mwindow, this);
258 // May be owned by someone else. This is owned by mwindow, so we don't care
260 // delete preferences;
261 delete progress_timer;
262 if( asset ) asset->Garbage::remove_user();
266 void Render::start_interactive()
268 if( !thread->running() ) {
269 mode = Render::INTERACTIVE;
270 BC_DialogThread::start();
272 else if( in_progress ) {
273 ErrorBox error_box(_(PROGRAM_NAME ": Error"),
274 mwindow->gui->get_abs_cursor_x(1),
275 mwindow->gui->get_abs_cursor_y(1));
276 error_box.create_objects(_("Already rendering"));
277 error_box.raise_window();
278 error_box.run_window();
280 else if( render_window ) {
281 render_window->raise_window();
286 void Render::start_batches(ArrayList<BatchRenderJob*> *jobs)
288 if(!thread->running())
290 mode = Render::BATCH;
296 else if( in_progress ) {
297 ErrorBox error_box(_(PROGRAM_NAME ": Error"),
298 mwindow->gui->get_abs_cursor_x(1),
299 mwindow->gui->get_abs_cursor_y(1));
300 error_box.create_objects("Already rendering");
301 error_box.raise_window();
302 error_box.run_window();
304 // raise the window if rendering hasn't started yet
305 else if( render_window ) {
306 render_window->raise_window();
310 void Render::start_batches(ArrayList<BatchRenderJob*> *jobs,
311 BC_Hash *boot_defaults,
312 Preferences *preferences)
314 mode = Render::BATCH;
317 this->preferences = preferences;
323 this->preferences = 0;
327 BC_Window* Render::new_gui()
334 if(mode == Render::INTERACTIVE) {
335 // Fix the asset for rendering
336 if(!asset) asset = new Asset;
337 load_defaults(asset);
338 check_asset(mwindow->edl, *asset);
339 int px = mwindow->gui->get_pop_cursor_x(1);
340 int py = mwindow->gui->get_pop_cursor_y(1);
341 // Get format from user
342 render_window = new RenderWindow(mwindow, this, asset, px, py);
343 render_window->create_objects();
346 return render_window;
349 void Render::handle_done_event(int result)
352 // add to recentlist only on OK
353 render_window->format_tools->path_recent->
354 add_item(File::formattostr(asset->format), asset->path);
359 void Render::handle_close_event(int result)
361 int format_error = 0;
365 // Check the asset format for errors.
366 FormatCheck format_check(asset);
367 format_error = format_check.check_format();
372 save_defaults(asset);
374 mwindow->save_defaults();
377 if(!format_error && !result)
379 if(debug) printf("Render::handle_close_event %d\n", __LINE__);
380 if(!result) start_render();
381 if(debug) printf("Render::handle_close_event %d\n", __LINE__);
388 void Render::stop_operation()
390 if(thread->Thread::running())
393 // Wait for completion
394 completion->lock("Render::stop_operation");
401 int Render::check_asset(EDL *edl, Asset &asset)
403 if(asset.video_data &&
404 edl->tracks->playable_video_tracks() &&
405 File::supports_video(asset.format))
407 asset.video_data = 1;
409 asset.width = edl->session->output_w;
410 asset.height = edl->session->output_h;
411 asset.interlace_mode = edl->session->interlace_mode;
415 asset.video_data = 0;
419 if(asset.audio_data &&
420 edl->tracks->playable_audio_tracks() &&
421 File::supports_audio(asset.format))
423 asset.audio_data = 1;
424 asset.channels = edl->session->audio_channels;
428 asset.audio_data = 0;
432 if(!asset.audio_data &&
440 int Render::fix_strategy(int strategy, int use_renderfarm)
444 if(strategy == FILE_PER_LABEL)
445 strategy = FILE_PER_LABEL_FARM;
447 if(strategy == SINGLE_PASS)
448 strategy = SINGLE_PASS_FARM;
452 if(strategy == FILE_PER_LABEL_FARM)
453 strategy = FILE_PER_LABEL;
455 if(strategy == SINGLE_PASS_FARM)
456 strategy = SINGLE_PASS;
461 void Render::start_progress()
463 char filename[BCTEXTLEN];
464 char string[BCTEXTLEN];
467 progress_max = packages->get_progress_max();
469 progress_timer->update();
473 // Generate the progress box
474 fs.extract_name(filename, default_asset->path);
475 sprintf(string, _("Rendering %s..."), filename);
477 // Don't bother with the filename since renderfarm defeats the meaning
478 progress = mwindow->mainprogress->start_progress(_("Rendering..."),
480 render_progress = new RenderProgress(mwindow, this);
481 render_progress->start();
485 void Render::stop_progress()
489 char string[BCTEXTLEN], string2[BCTEXTLEN];
490 delete render_progress;
491 progress->get_time(string);
492 elapsed_time = progress->get_time();
493 progress->stop_progress();
496 sprintf(string2, _("Rendering took %s"), string);
497 mwindow->gui->lock_window("");
498 mwindow->gui->show_message(string2);
499 mwindow->gui->update_default_message();
500 mwindow->gui->stop_hourglass();
501 mwindow->gui->unlock_window();
508 void Render::start_render()
518 void Render::create_filename(char *path,
525 int len = strlen(default_path);
526 char printf_string[BCTEXTLEN];
528 for(i = 0, j = 0; i < number_start; i++, j++)
530 printf_string[j] = default_path[i];
534 sprintf(&printf_string[j], "%%0%dd", total_digits);
535 j = strlen(printf_string);
538 // Copy remainder of string
539 for( ; i < len; i++, j++)
541 printf_string[j] = default_path[i];
543 printf_string[j] = 0;
544 // Print the printf argument to the path
545 sprintf(path, printf_string, current_number);
548 void Render::get_starting_number(char *path,
554 int len = strlen(path);
555 char number_text[BCTEXTLEN];
563 ptr2 = strrchr(path, '/');
565 // Search for first 0 after last /.
567 ptr = strchr(ptr2, '0');
569 if(ptr && isdigit(*ptr))
571 number_start = ptr - path;
573 // Store the first number
574 char *ptr2 = number_text;
578 current_number = atol(number_text);
579 total_digits = strlen(number_text);
583 // No number found or number not long enough
584 if(total_digits < min_digits)
588 total_digits = min_digits;
593 int Render::load_defaults(Asset *asset)
595 strategy = mwindow->defaults->get("RENDER_STRATEGY", SINGLE_PASS);
596 load_mode = mwindow->defaults->get("RENDER_LOADMODE", LOADMODE_NEW_TRACKS);
597 range_type = mwindow->defaults->get("RENDER_RANGE_TYPE", RANGE_PROJECT);
599 // some defaults which work
600 asset->video_data = 1;
601 asset->audio_data = 1;
602 asset->format = FILE_FFMPEG;
603 strcpy(asset->acodec, "mp4.qt");
604 strcpy(asset->vcodec, "mp4.qt");
606 asset->load_defaults(mwindow->defaults,
607 "RENDER_", 1, 1, 1, 1, 1);
611 int Render::load_profile(int profile_slot, Asset *asset)
613 char string_name[100];
614 sprintf(string_name, "RENDER_%i_STRATEGY", profile_slot);
615 strategy = mwindow->defaults->get(string_name, SINGLE_PASS);
616 // Load mode is not part of the profile
617 // printf(string_name, "RENDER_%i_LOADMODE", profile_slot);
618 // load_mode = mwindow->defaults->get(string_name, LOADMODE_NEW_TRACKS);
619 sprintf(string_name, "RENDER_%i_RANGE_TYPE", profile_slot);
620 range_type = mwindow->defaults->get(string_name, RANGE_PROJECT);
622 sprintf(string_name, "RENDER_%i_", profile_slot);
623 asset->load_defaults(mwindow->defaults,
624 string_name, 1, 1, 1, 1, 1);
629 int Render::save_defaults(Asset *asset)
631 mwindow->defaults->update("RENDER_STRATEGY", strategy);
632 mwindow->defaults->update("RENDER_LOADMODE", load_mode);
633 mwindow->defaults->update("RENDER_RANGE_TYPE", range_type);
635 asset->save_defaults(mwindow->defaults,
636 "RENDER_", 1, 1, 1, 1, 1);
641 static void run_script(const char *script, const char *arg)
643 char *const argv[] = { (char*)script, (char*)arg, 0 };
644 execvp(script ,&argv[0]);
645 perror("execvp script failed");
649 RenderThread::RenderThread(MWindow *mwindow, Render *render)
652 this->mwindow = mwindow;
653 this->render = render;
656 RenderThread::~RenderThread()
661 void RenderThread::render_single(int test_overwrite,
667 // Total length in seconds
669 RenderFarmServer *farm_server = 0;
674 render->in_progress = 1;
677 render->default_asset = asset;
678 render->progress = 0;
683 if(!render->preferences)
684 render->preferences = new Preferences;
686 render->preferences->copy_from(mwindow->preferences);
690 // Create rendering command
691 TransportCommand *command = new TransportCommand;
692 command->command = NORMAL_FWD;
693 command->get_edl()->copy_all(edl);
694 command->change_type = CHANGE_ALL;
696 if (range_type == RANGE_BACKCOMPAT) {
697 // Get highlighted playback range
698 command->set_playback_range();
699 // Adjust playback range with in/out points
700 command->playback_range_adjust_inout();
702 else if (range_type == RANGE_PROJECT) {
703 command->playback_range_project();
705 else if (range_type == RANGE_SELECTION) {
706 command->set_playback_range();
708 else if (range_type == RANGE_INOUT) {
709 command->playback_range_inout();
712 render->packages = new PackageDispatcher;
715 CICache *audio_cache = new CICache(render->preferences);
716 CICache *video_cache = new CICache(render->preferences);
718 render->default_asset->frame_rate = command->get_edl()->session->frame_rate;
719 render->default_asset->sample_rate = command->get_edl()->session->sample_rate;
721 // Conform asset to EDL. Find out if any tracks are playable.
722 render->result = render->check_asset(command->get_edl(),
723 *render->default_asset);
727 // Get total range to render
728 render->total_start = command->start_position;
729 render->total_end = command->end_position;
730 total_length = render->total_end - render->total_start;
733 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,
759 render->total_rendered = 0;
763 // Start dispatching external jobs
766 mwindow->gui->lock_window("Render::render 1");
767 mwindow->gui->show_message(_("Starting render farm"));
768 mwindow->gui->start_hourglass();
769 mwindow->gui->unlock_window();
773 printf("Render::render: starting render farm\n");
776 if(strategy == SINGLE_PASS_FARM || strategy == FILE_PER_LABEL_FARM)
778 farm_server = new RenderFarmServer(mwindow,
783 &render->total_rendered,
784 render->counter_lock,
785 render->default_asset,
788 render->result = farm_server->start_clients();
794 mwindow->gui->lock_window("Render::render 2");
795 mwindow->gui->show_message(_("Failed to start render farm"),
796 mwindow->theme->message_error);
797 mwindow->gui->stop_hourglass();
798 mwindow->gui->unlock_window();
802 printf("Render::render: Failed to start render farm\n");
808 // Perform local rendering
813 render->start_progress();
818 MainPackageRenderer package_renderer(render);
819 render->result = package_renderer.initialize(mwindow,
820 command->get_edl(), // Copy of master EDL
822 render->default_asset);
830 while(!render->result)
832 // Get unfinished job
833 RenderPackage *package;
835 if(strategy == SINGLE_PASS_FARM)
837 package = render->packages->get_package(
838 package_renderer.frames_per_second,
844 package = render->packages->get_package(0, -1, 1);
859 if(package_renderer.render_package(package))
867 printf("Render::render_single: Session finished.\n");
873 if(strategy == SINGLE_PASS_FARM || strategy == FILE_PER_LABEL_FARM)
875 farm_server->wait_clients();
876 render->result |= render->packages->packages_are_done();
879 if(debug) printf("Render::render %d\n", __LINE__);
883 (!render->progress || !render->progress->is_cancelled()) &&
884 !render->batch_cancelled)
886 if(debug) printf("Render::render %d\n", __LINE__);
889 if(debug) printf("Render::render %d\n", __LINE__);
890 ErrorBox error_box(_(PROGRAM_NAME ": Error"),
891 mwindow->gui->get_abs_cursor_x(1),
892 mwindow->gui->get_abs_cursor_y(1));
893 error_box.create_objects(_("Error rendering data."));
894 error_box.raise_window();
895 error_box.run_window();
896 if(debug) printf("Render::render %d\n", __LINE__);
900 printf("Render::render: Error rendering data\n");
903 if(debug) printf("Render::render %d\n", __LINE__);
905 // Delete the progress box
906 render->stop_progress();
908 if(debug) printf("Render::render %d\n", __LINE__);
912 // Paste all packages into timeline if desired
914 if(!render->result &&
915 render->load_mode != LOADMODE_NOTHING &&
917 render->mode != Render::BATCH)
919 if(debug) printf("Render::render %d\n", __LINE__);
920 mwindow->gui->lock_window("Render::render 3");
921 if(debug) printf("Render::render %d\n", __LINE__);
923 mwindow->undo->update_undo_before();
925 if(debug) printf("Render::render %d\n", __LINE__);
928 ArrayList<Indexable*> *assets = render->packages->get_asset_list();
929 if(debug) printf("Render::render %d\n", __LINE__);
930 if(render->load_mode == LOADMODE_PASTE)
932 if(debug) printf("Render::render %d\n", __LINE__);
933 mwindow->load_assets(assets, -1, render->load_mode, 0, 0,
934 mwindow->edl->session->labels_follow_edits,
935 mwindow->edl->session->plugins_follow_edits,
936 mwindow->edl->session->autos_follow_edits,
938 if(debug) printf("Render::render %d\n", __LINE__);
939 for(int i = 0; i < assets->size(); i++)
940 assets->get(i)->Garbage::remove_user();
942 if(debug) printf("Render::render %d\n", __LINE__);
945 mwindow->save_backup();
946 if(debug) printf("Render::render %d\n", __LINE__);
947 mwindow->undo->update_undo_after(_("render"), LOAD_ALL);
948 if(debug) printf("Render::render %d\n", __LINE__);
949 mwindow->update_plugin_guis();
950 if(debug) printf("Render::render %d\n", __LINE__);
951 mwindow->gui->update(1,
958 if(debug) printf("Render::render %d\n", __LINE__);
959 mwindow->sync_parameters(CHANGE_ALL);
960 if(debug) printf("Render::render %d\n", __LINE__);
961 mwindow->gui->unlock_window();
964 mwindow->awindow->gui->async_update_assets();
966 if(debug) printf("Render::render %d\n", __LINE__);
969 if(debug) printf("Render::render %d\n", __LINE__);
974 mwindow->gui->lock_window("Render::render 3");
975 mwindow->gui->stop_hourglass();
976 mwindow->gui->unlock_window();
979 //printf("Render::render 110\n");
980 // Need to restart because brender always stops before render.
982 mwindow->restart_brender();
983 if(farm_server) delete farm_server;
987 // Must delete packages after server
988 delete render->packages;
990 render->packages = 0;
991 render->in_progress = 0;
992 if(debug) printf("Render::render %d\n", __LINE__);
995 void RenderThread::run()
997 if(render->mode == Render::INTERACTIVE)
999 render_single(1, render->asset, mwindow->edl, render->strategy, render->range_type);
1002 if(render->mode == Render::BATCH)
1005 // printf("RenderThread::run %d %d %d\n",
1007 // render->jobs->total,
1009 for(int i = 0; i < render->jobs->total && !render->result; i++)
1012 BatchRenderJob *job = render->jobs->values[i];
1016 if( *job->edl_path == '@' )
1018 run_script(job->edl_path+1, job->asset->path);
1023 mwindow->batch_render->update_active(i);
1027 printf("Render::run: %s\n", job->edl_path);
1032 FileXML *file = new FileXML;
1034 edl->create_objects();
1035 file->read_from_file(job->edl_path);
1036 edl->load_xml(file, LOAD_ALL);
1039 render_single(0, job->asset, edl, job->strategy, RANGE_BACKCOMPAT);
1042 edl->Garbage::remove_user();
1047 mwindow->batch_render->update_done(i, 1, render->elapsed_time);
1050 char string[BCTEXTLEN];
1051 render->elapsed_time =
1052 (double)render->progress_timer->get_scaled_difference(1);
1053 Units::totext(string,
1054 render->elapsed_time,
1056 printf("Render::run: done in %s\n", string);
1062 mwindow->batch_render->update_active(-1);
1064 printf("Render::run: failed\n");
1072 mwindow->batch_render->update_active(-1);
1073 mwindow->batch_render->update_done(-1, 0, 0);
1076 render->completion->unlock();
1084 RenderWindow::RenderWindow(MWindow *mwindow,
1089 : BC_Window(_(PROGRAM_NAME ": Render"), x, y,
1090 WIDTH, HEIGHT, WIDTH, HEIGHT, 0, 0, 1)
1092 this->mwindow = mwindow;
1093 this->render = render;
1094 this->asset = asset;
1097 RenderWindow::~RenderWindow()
1100 lock_window("RenderWindow::~RenderWindow");
1102 delete format_tools;
1111 void RenderWindow::load_profile(int profile_slot)
1113 render->load_profile(profile_slot, asset);
1114 update_range_type(render->range_type);
1115 format_tools->update(asset, &render->strategy);
1119 void RenderWindow::create_objects()
1122 lock_window("RenderWindow::create_objects");
1123 add_subwindow(new BC_Title(x,
1125 (char*)((render->strategy == FILE_PER_LABEL ||
1126 render->strategy == FILE_PER_LABEL_FARM) ?
1127 _("Select the first file to render to:") :
1128 _("Select a file to render to:"))));
1131 format_tools = new FormatTools(mwindow, this, asset);
1132 format_tools->create_objects(x, y,
1133 1, 1, 1, 1, 0, 1, 0, 0, &render->strategy, 0);
1135 add_subwindow(new BC_Title(x, y, _("Render range:")));
1138 add_subwindow(rangeproject = new RenderRangeProject(this,
1139 render->range_type == RANGE_PROJECT, x, y));
1141 add_subwindow(rangeselection = new RenderRangeSelection(this,
1142 render->range_type == RANGE_SELECTION, x, y));
1144 add_subwindow(rangeinout = new RenderRangeInOut(this,
1145 render->range_type == RANGE_INOUT, x, y));
1149 renderprofile = new RenderProfile(mwindow, this, x, y, 1);
1150 renderprofile->create_objects();
1153 loadmode = new LoadMode(mwindow, this, x, y, &render->load_mode, 1);
1154 loadmode->create_objects();
1156 add_subwindow(new BC_OKButton(this));
1157 add_subwindow(new BC_CancelButton(this));
1162 void RenderWindow::update_range_type(int range_type)
1164 render->range_type = range_type;
1165 rangeproject->update(range_type == RANGE_PROJECT);
1166 rangeselection->update(range_type == RANGE_SELECTION);
1167 rangeinout->update(range_type == RANGE_INOUT);
1171 RenderRangeProject::RenderRangeProject(RenderWindow *rwindow, int value, int x, int y)
1172 : BC_Radial(x, y, value, _("Project"))
1174 this->rwindow = rwindow;
1176 int RenderRangeProject::handle_event()
1178 rwindow->update_range_type(RANGE_PROJECT);
1182 RenderRangeSelection::RenderRangeSelection(RenderWindow *rwindow, int value, int x, int y)
1183 : BC_Radial(x, y, value, _("Selection"))
1185 this->rwindow = rwindow;
1187 int RenderRangeSelection::handle_event()
1189 rwindow->update_range_type(RANGE_SELECTION);
1194 RenderRangeInOut::RenderRangeInOut(RenderWindow *rwindow, int value, int x, int y)
1195 : BC_Radial(x, y, value, _("In/Out Points"))
1197 this->rwindow = rwindow;
1199 int RenderRangeInOut::handle_event()
1201 rwindow->update_range_type(RANGE_INOUT);