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->set_default_message(string2);
499 mwindow->gui->stop_hourglass();
500 mwindow->gui->unlock_window();
507 void Render::start_render()
517 void Render::create_filename(char *path,
524 int len = strlen(default_path);
525 char printf_string[BCTEXTLEN];
527 for(i = 0, j = 0; i < number_start; i++, j++)
529 printf_string[j] = default_path[i];
533 sprintf(&printf_string[j], "%%0%dd", total_digits);
534 j = strlen(printf_string);
537 // Copy remainder of string
538 for( ; i < len; i++, j++)
540 printf_string[j] = default_path[i];
542 printf_string[j] = 0;
543 // Print the printf argument to the path
544 sprintf(path, printf_string, current_number);
547 void Render::get_starting_number(char *path,
553 int len = strlen(path);
554 char number_text[BCTEXTLEN];
562 ptr2 = strrchr(path, '/');
564 // Search for first 0 after last /.
566 ptr = strchr(ptr2, '0');
568 if(ptr && isdigit(*ptr))
570 number_start = ptr - path;
572 // Store the first number
573 char *ptr2 = number_text;
577 current_number = atol(number_text);
578 total_digits = strlen(number_text);
582 // No number found or number not long enough
583 if(total_digits < min_digits)
587 total_digits = min_digits;
592 int Render::load_defaults(Asset *asset)
594 strategy = mwindow->defaults->get("RENDER_STRATEGY", SINGLE_PASS);
595 load_mode = mwindow->defaults->get("RENDER_LOADMODE", LOADMODE_NEW_TRACKS);
596 range_type = mwindow->defaults->get("RENDER_RANGE_TYPE", RANGE_PROJECT);
598 // some defaults which work
599 asset->video_data = 1;
600 asset->audio_data = 1;
601 asset->format = FILE_FFMPEG;
602 strcpy(asset->acodec, "mp4.qt");
603 strcpy(asset->vcodec, "mp4.qt");
605 asset->load_defaults(mwindow->defaults,
606 "RENDER_", 1, 1, 1, 1, 1);
610 int Render::load_profile(int profile_slot, Asset *asset)
612 char string_name[100];
613 sprintf(string_name, "RENDER_%i_STRATEGY", profile_slot);
614 strategy = mwindow->defaults->get(string_name, SINGLE_PASS);
615 // Load mode is not part of the profile
616 // printf(string_name, "RENDER_%i_LOADMODE", profile_slot);
617 // load_mode = mwindow->defaults->get(string_name, LOADMODE_NEW_TRACKS);
618 sprintf(string_name, "RENDER_%i_RANGE_TYPE", profile_slot);
619 range_type = mwindow->defaults->get(string_name, RANGE_PROJECT);
621 sprintf(string_name, "RENDER_%i_", profile_slot);
622 asset->load_defaults(mwindow->defaults,
623 string_name, 1, 1, 1, 1, 1);
628 int Render::save_defaults(Asset *asset)
630 mwindow->defaults->update("RENDER_STRATEGY", strategy);
631 mwindow->defaults->update("RENDER_LOADMODE", load_mode);
632 mwindow->defaults->update("RENDER_RANGE_TYPE", range_type);
634 asset->save_defaults(mwindow->defaults,
635 "RENDER_", 1, 1, 1, 1, 1);
640 static void run_script(const char *script, const char *arg)
642 char *const argv[] = { (char*)script, (char*)arg, 0 };
643 execvp(script ,&argv[0]);
644 perror("execvp script failed");
648 RenderThread::RenderThread(MWindow *mwindow, Render *render)
651 this->mwindow = mwindow;
652 this->render = render;
655 RenderThread::~RenderThread()
660 void RenderThread::render_single(int test_overwrite,
666 // Total length in seconds
668 RenderFarmServer *farm_server = 0;
673 render->in_progress = 1;
676 render->default_asset = asset;
677 render->progress = 0;
682 if(!render->preferences)
683 render->preferences = new Preferences;
685 render->preferences->copy_from(mwindow->preferences);
689 // Create rendering command
690 TransportCommand *command = new TransportCommand;
691 command->command = NORMAL_FWD;
692 command->get_edl()->copy_all(edl);
693 command->change_type = CHANGE_ALL;
695 if (range_type == RANGE_BACKCOMPAT) {
696 // Get highlighted playback range
697 command->set_playback_range();
698 // Adjust playback range with in/out points
699 command->playback_range_adjust_inout();
701 else if (range_type == RANGE_PROJECT) {
702 command->playback_range_project();
704 else if (range_type == RANGE_SELECTION) {
705 command->set_playback_range();
707 else if (range_type == RANGE_INOUT) {
708 command->playback_range_inout();
711 render->packages = new PackageDispatcher;
714 CICache *audio_cache = new CICache(render->preferences);
715 CICache *video_cache = new CICache(render->preferences);
717 render->default_asset->frame_rate = command->get_edl()->session->frame_rate;
718 render->default_asset->sample_rate = command->get_edl()->session->sample_rate;
720 // Conform asset to EDL. Find out if any tracks are playable.
721 render->result = render->check_asset(command->get_edl(),
722 *render->default_asset);
726 // Get total range to render
727 render->total_start = command->start_position;
728 render->total_end = command->end_position;
729 total_length = render->total_end - render->total_start;
732 if(EQUIV(total_length, 0))
741 // Stop background rendering
742 if(mwindow) mwindow->stop_brender();
744 fs.complete_path(render->default_asset->path);
745 strategy = Render::fix_strategy(strategy, render->preferences->use_renderfarm);
747 render->result = render->packages->create_packages(mwindow,
751 render->default_asset,
758 render->total_rendered = 0;
762 // Start dispatching external jobs
765 mwindow->gui->lock_window("Render::render 1");
766 mwindow->gui->show_message(_("Starting render farm"));
767 mwindow->gui->start_hourglass();
768 mwindow->gui->unlock_window();
772 printf("Render::render: starting render farm\n");
775 if(strategy == SINGLE_PASS_FARM || strategy == FILE_PER_LABEL_FARM)
777 farm_server = new RenderFarmServer(mwindow,
782 &render->total_rendered,
783 render->counter_lock,
784 render->default_asset,
787 render->result = farm_server->start_clients();
793 mwindow->gui->lock_window("Render::render 2");
794 mwindow->gui->show_message(_("Failed to start render farm"),
795 mwindow->theme->message_error);
796 mwindow->gui->stop_hourglass();
797 mwindow->gui->unlock_window();
801 printf("Render::render: Failed to start render farm\n");
807 // Perform local rendering
812 render->start_progress();
817 MainPackageRenderer package_renderer(render);
818 render->result = package_renderer.initialize(mwindow,
819 command->get_edl(), // Copy of master EDL
821 render->default_asset);
829 while(!render->result)
831 // Get unfinished job
832 RenderPackage *package;
834 if(strategy == SINGLE_PASS_FARM)
836 package = render->packages->get_package(
837 package_renderer.frames_per_second,
843 package = render->packages->get_package(0, -1, 1);
858 if(package_renderer.render_package(package))
866 printf("Render::render_single: Session finished.\n");
872 if(strategy == SINGLE_PASS_FARM || strategy == FILE_PER_LABEL_FARM)
874 farm_server->wait_clients();
875 render->result |= render->packages->packages_are_done();
878 if(debug) printf("Render::render %d\n", __LINE__);
882 (!render->progress || !render->progress->is_cancelled()) &&
883 !render->batch_cancelled)
885 if(debug) printf("Render::render %d\n", __LINE__);
888 if(debug) printf("Render::render %d\n", __LINE__);
889 ErrorBox error_box(_(PROGRAM_NAME ": Error"),
890 mwindow->gui->get_abs_cursor_x(1),
891 mwindow->gui->get_abs_cursor_y(1));
892 error_box.create_objects(_("Error rendering data."));
893 error_box.raise_window();
894 error_box.run_window();
895 if(debug) printf("Render::render %d\n", __LINE__);
899 printf("Render::render: Error rendering data\n");
902 if(debug) printf("Render::render %d\n", __LINE__);
904 // Delete the progress box
905 render->stop_progress();
907 if(debug) printf("Render::render %d\n", __LINE__);
911 // Paste all packages into timeline if desired
913 if(!render->result &&
914 render->load_mode != LOADMODE_NOTHING &&
916 render->mode != Render::BATCH)
918 if(debug) printf("Render::render %d\n", __LINE__);
919 mwindow->gui->lock_window("Render::render 3");
920 if(debug) printf("Render::render %d\n", __LINE__);
922 mwindow->undo->update_undo_before();
924 if(debug) printf("Render::render %d\n", __LINE__);
927 ArrayList<Indexable*> *assets = render->packages->get_asset_list();
928 if(debug) printf("Render::render %d\n", __LINE__);
929 if(render->load_mode == LOADMODE_PASTE)
931 if(debug) printf("Render::render %d\n", __LINE__);
932 mwindow->load_assets(assets, -1, render->load_mode, 0, 0,
933 mwindow->edl->session->labels_follow_edits,
934 mwindow->edl->session->plugins_follow_edits,
935 mwindow->edl->session->autos_follow_edits,
937 if(debug) printf("Render::render %d\n", __LINE__);
938 for(int i = 0; i < assets->size(); i++)
939 assets->get(i)->Garbage::remove_user();
941 if(debug) printf("Render::render %d\n", __LINE__);
944 mwindow->save_backup();
945 if(debug) printf("Render::render %d\n", __LINE__);
946 mwindow->undo->update_undo_after(_("render"), LOAD_ALL);
947 if(debug) printf("Render::render %d\n", __LINE__);
948 mwindow->update_plugin_guis();
949 if(debug) printf("Render::render %d\n", __LINE__);
950 mwindow->gui->update(1,
957 if(debug) printf("Render::render %d\n", __LINE__);
958 mwindow->sync_parameters(CHANGE_ALL);
959 if(debug) printf("Render::render %d\n", __LINE__);
960 mwindow->gui->unlock_window();
963 mwindow->awindow->gui->async_update_assets();
965 if(debug) printf("Render::render %d\n", __LINE__);
968 if(debug) printf("Render::render %d\n", __LINE__);
973 mwindow->gui->lock_window("Render::render 3");
974 mwindow->gui->stop_hourglass();
975 mwindow->gui->unlock_window();
978 //printf("Render::render 110\n");
979 // Need to restart because brender always stops before render.
981 mwindow->restart_brender();
982 if(farm_server) delete farm_server;
986 // Must delete packages after server
987 delete render->packages;
989 render->packages = 0;
990 render->in_progress = 0;
991 if(debug) printf("Render::render %d\n", __LINE__);
994 void RenderThread::run()
996 if(render->mode == Render::INTERACTIVE)
998 render_single(1, render->asset, mwindow->edl, render->strategy, render->range_type);
1001 if(render->mode == Render::BATCH)
1004 // printf("RenderThread::run %d %d %d\n",
1006 // render->jobs->total,
1008 for(int i = 0; i < render->jobs->total && !render->result; i++)
1011 BatchRenderJob *job = render->jobs->values[i];
1015 if( *job->edl_path == '@' )
1017 run_script(job->edl_path+1, job->asset->path);
1022 mwindow->batch_render->update_active(i);
1026 printf("Render::run: %s\n", job->edl_path);
1031 FileXML *file = new FileXML;
1033 edl->create_objects();
1034 file->read_from_file(job->edl_path);
1035 edl->load_xml(file, LOAD_ALL);
1038 render_single(0, job->asset, edl, job->strategy, RANGE_BACKCOMPAT);
1041 edl->Garbage::remove_user();
1046 mwindow->batch_render->update_done(i, 1, render->elapsed_time);
1049 char string[BCTEXTLEN];
1050 render->elapsed_time =
1051 (double)render->progress_timer->get_scaled_difference(1);
1052 Units::totext(string,
1053 render->elapsed_time,
1055 printf("Render::run: done in %s\n", string);
1061 mwindow->batch_render->update_active(-1);
1063 printf("Render::run: failed\n");
1071 mwindow->batch_render->update_active(-1);
1072 mwindow->batch_render->update_done(-1, 0, 0);
1075 render->completion->unlock();
1083 RenderWindow::RenderWindow(MWindow *mwindow,
1088 : BC_Window(_(PROGRAM_NAME ": Render"), x, y,
1089 WIDTH, HEIGHT, WIDTH, HEIGHT, 0, 0, 1)
1091 this->mwindow = mwindow;
1092 this->render = render;
1093 this->asset = asset;
1096 RenderWindow::~RenderWindow()
1099 lock_window("RenderWindow::~RenderWindow");
1101 delete format_tools;
1110 void RenderWindow::load_profile(int profile_slot)
1112 render->load_profile(profile_slot, asset);
1113 update_range_type(render->range_type);
1114 format_tools->update(asset, &render->strategy);
1118 void RenderWindow::create_objects()
1121 lock_window("RenderWindow::create_objects");
1122 add_subwindow(new BC_Title(x,
1124 (char*)((render->strategy == FILE_PER_LABEL ||
1125 render->strategy == FILE_PER_LABEL_FARM) ?
1126 _("Select the first file to render to:") :
1127 _("Select a file to render to:"))));
1130 format_tools = new FormatTools(mwindow, this, asset);
1131 format_tools->create_objects(x, y,
1132 1, 1, 1, 1, 0, 1, 0, 0, &render->strategy, 0);
1134 add_subwindow(new BC_Title(x, y, _("Render range:")));
1137 add_subwindow(rangeproject = new RenderRangeProject(this,
1138 render->range_type == RANGE_PROJECT, x, y));
1140 add_subwindow(rangeselection = new RenderRangeSelection(this,
1141 render->range_type == RANGE_SELECTION, x, y));
1143 add_subwindow(rangeinout = new RenderRangeInOut(this,
1144 render->range_type == RANGE_INOUT, x, y));
1148 renderprofile = new RenderProfile(mwindow, this, x, y, 1);
1149 renderprofile->create_objects();
1152 loadmode = new LoadMode(mwindow, this, x, y, &render->load_mode, 1);
1153 loadmode->create_objects();
1155 add_subwindow(new BC_OKButton(this));
1156 add_subwindow(new BC_CancelButton(this));
1161 void RenderWindow::update_range_type(int range_type)
1163 render->range_type = range_type;
1164 rangeproject->update(range_type == RANGE_PROJECT);
1165 rangeselection->update(range_type == RANGE_SELECTION);
1166 rangeinout->update(range_type == RANGE_INOUT);
1170 RenderRangeProject::RenderRangeProject(RenderWindow *rwindow, int value, int x, int y)
1171 : BC_Radial(x, y, value, _("Project"))
1173 this->rwindow = rwindow;
1175 int RenderRangeProject::handle_event()
1177 rwindow->update_range_type(RANGE_PROJECT);
1181 RenderRangeSelection::RenderRangeSelection(RenderWindow *rwindow, int value, int x, int y)
1182 : BC_Radial(x, y, value, _("Selection"))
1184 this->rwindow = rwindow;
1186 int RenderRangeSelection::handle_event()
1188 rwindow->update_range_type(RANGE_SELECTION);
1193 RenderRangeInOut::RenderRangeInOut(RenderWindow *rwindow, int value, int x, int y)
1194 : BC_Radial(x, y, value, _("In/Out Points"))
1196 this->rwindow = rwindow;
1198 int RenderRangeInOut::handle_event()
1200 rwindow->update_range_type(RANGE_INOUT);