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);
274 // May be owned by someone else. This is owned by mwindow, so we don't care
276 // delete preferences;
277 delete progress_timer;
278 if( asset ) asset->Garbage::remove_user();
282 void Render::start_interactive()
284 if(!thread->running())
286 mode = Render::INTERACTIVE;
287 BC_DialogThread::start();
291 ErrorBox error_box(_(PROGRAM_NAME ": Error"),
292 mwindow->gui->get_abs_cursor_x(1),
293 mwindow->gui->get_abs_cursor_y(1));
294 error_box.create_objects(_("Already rendering"));
295 error_box.raise_window();
296 error_box.run_window();
301 void Render::start_batches(ArrayList<BatchRenderJob*> *jobs)
303 if(!thread->running())
305 mode = Render::BATCH;
313 void Render::start_batches(ArrayList<BatchRenderJob*> *jobs,
314 BC_Hash *boot_defaults,
315 Preferences *preferences)
317 mode = Render::BATCH;
320 this->preferences = preferences;
326 this->preferences = 0;
330 BC_Window* Render::new_gui()
337 RenderWindow *window = 0;
339 if(mode == Render::INTERACTIVE)
341 // Fix the asset for rendering
342 if(!asset) asset = new Asset;
343 load_defaults(asset);
344 check_asset(mwindow->edl, *asset);
346 // Get format from user
347 window = new RenderWindow(mwindow,
350 mwindow->gui->get_abs_cursor_x(1),
351 mwindow->gui->get_abs_cursor_y(1));
352 window->create_objects();
363 void Render::handle_close_event(int result)
365 int format_error = 0;
370 if(debug) printf("Render::handle_close_event %d\n", __LINE__);
371 // Check the asset format for errors.
372 FormatCheck format_check(asset);
373 if(debug) printf("Render::handle_close_event %d\n", __LINE__);
374 format_error = format_check.check_format();
375 if(debug) printf("Render::handle_close_event %d\n", __LINE__);
380 save_defaults(asset);
382 mwindow->save_defaults();
385 if(!format_error && !result)
387 if(debug) printf("Render::handle_close_event %d\n", __LINE__);
388 if(!result) start_render();
389 if(debug) printf("Render::handle_close_event %d\n", __LINE__);
396 void Render::stop_operation()
398 if(thread->Thread::running())
401 // Wait for completion
402 completion->lock("Render::stop_operation");
410 int Render::check_asset(EDL *edl, Asset &asset)
412 if(asset.video_data &&
413 edl->tracks->playable_video_tracks() &&
414 File::supports_video(asset.format))
416 asset.video_data = 1;
418 asset.width = edl->session->output_w;
419 asset.height = edl->session->output_h;
423 asset.video_data = 0;
427 if(asset.audio_data &&
428 edl->tracks->playable_audio_tracks() &&
429 File::supports_audio(asset.format))
431 asset.audio_data = 1;
432 asset.channels = edl->session->audio_channels;
433 if(asset.format == FILE_MOV) asset.byte_order = 0;
437 asset.audio_data = 0;
441 if(!asset.audio_data &&
449 int Render::fix_strategy(int strategy, int use_renderfarm)
453 if(strategy == FILE_PER_LABEL)
454 strategy = FILE_PER_LABEL_FARM;
456 if(strategy == SINGLE_PASS)
457 strategy = SINGLE_PASS_FARM;
461 if(strategy == FILE_PER_LABEL_FARM)
462 strategy = FILE_PER_LABEL;
464 if(strategy == SINGLE_PASS_FARM)
465 strategy = SINGLE_PASS;
470 void Render::start_progress()
472 char filename[BCTEXTLEN];
473 char string[BCTEXTLEN];
476 progress_max = Units::to_int64(default_asset->sample_rate *
477 (total_end - total_start)) +
478 Units::to_int64(preferences->render_preroll *
479 packages->total_allocated *
480 default_asset->sample_rate);
481 progress_timer->update();
485 // Generate the progress box
486 fs.extract_name(filename, default_asset->path);
487 sprintf(string, _("Rendering %s..."), filename);
489 // Don't bother with the filename since renderfarm defeats the meaning
490 progress = mwindow->mainprogress->start_progress(_("Rendering..."),
492 render_progress = new RenderProgress(mwindow, this);
493 render_progress->start();
497 void Render::stop_progress()
501 char string[BCTEXTLEN], string2[BCTEXTLEN];
502 delete render_progress;
503 progress->get_time(string);
504 elapsed_time = progress->get_time();
505 progress->stop_progress();
508 sprintf(string2, _("Rendering took %s"), string);
509 mwindow->gui->lock_window("");
510 mwindow->gui->show_message(string2);
511 mwindow->gui->stop_hourglass();
512 mwindow->gui->unlock_window();
519 void Render::start_render()
528 void Render::create_filename(char *path,
535 int len = strlen(default_path);
536 char printf_string[BCTEXTLEN];
538 for(i = 0, j = 0; i < number_start; i++, j++)
540 printf_string[j] = default_path[i];
544 sprintf(&printf_string[j], "%%0%dd", total_digits);
545 j = strlen(printf_string);
548 // Copy remainder of string
549 for( ; i < len; i++, j++)
551 printf_string[j] = default_path[i];
553 printf_string[j] = 0;
554 // Print the printf argument to the path
555 sprintf(path, printf_string, current_number);
558 void Render::get_starting_number(char *path,
564 int len = strlen(path);
565 char number_text[BCTEXTLEN];
573 ptr2 = strrchr(path, '/');
575 // Search for first 0 after last /.
577 ptr = strchr(ptr2, '0');
579 if(ptr && isdigit(*ptr))
581 number_start = ptr - path;
583 // Store the first number
584 char *ptr2 = number_text;
588 current_number = atol(number_text);
589 total_digits = strlen(number_text);
593 // No number found or number not long enough
594 if(total_digits < min_digits)
598 total_digits = min_digits;
608 int Render::load_defaults(Asset *asset)
610 strategy = mwindow->defaults->get("RENDER_STRATEGY", SINGLE_PASS);
611 load_mode = mwindow->defaults->get("RENDER_LOADMODE", LOADMODE_NEW_TRACKS);
614 asset->load_defaults(mwindow->defaults,
626 int Render::save_defaults(Asset *asset)
628 mwindow->defaults->update("RENDER_STRATEGY", strategy);
629 mwindow->defaults->update("RENDER_LOADMODE", load_mode);
634 asset->save_defaults(mwindow->defaults,
650 static void run_script(const char *script, const char *arg)
652 char *const argv[] = { (char*)script, (char*)arg, 0 };
653 execvp(script ,&argv[0]);
654 perror("execvp script failed");
658 RenderThread::RenderThread(MWindow *mwindow, Render *render)
661 this->mwindow = mwindow;
662 this->render = render;
665 RenderThread::~RenderThread()
670 void RenderThread::render_single(int test_overwrite,
675 // Total length in seconds
677 RenderFarmServer *farm_server = 0;
682 render->in_progress = 1;
685 render->default_asset = asset;
686 render->progress = 0;
691 if(!render->preferences)
692 render->preferences = new Preferences;
694 render->preferences->copy_from(mwindow->preferences);
698 // Create rendering command
699 TransportCommand *command = new TransportCommand;
700 command->command = NORMAL_FWD;
701 command->get_edl()->copy_all(edl);
702 command->change_type = CHANGE_ALL;
703 // Get highlighted playback range
704 command->set_playback_range();
705 // Adjust playback range with in/out points
706 command->adjust_playback_range();
707 render->packages = new PackageDispatcher;
710 CICache *audio_cache = new CICache(render->preferences);
711 CICache *video_cache = new CICache(render->preferences);
713 render->default_asset->frame_rate = command->get_edl()->session->frame_rate;
714 render->default_asset->sample_rate = command->get_edl()->session->sample_rate;
716 // Conform asset to EDL. Find out if any tracks are playable.
717 render->result = render->check_asset(command->get_edl(),
718 *render->default_asset);
722 // Get total range to render
723 render->total_start = command->start_position;
724 render->total_end = command->end_position;
725 total_length = render->total_end - render->total_start;
728 if(EQUIV(total_length, 0))
743 // Stop background rendering
744 if(mwindow) mwindow->stop_brender();
746 fs.complete_path(render->default_asset->path);
747 strategy = Render::fix_strategy(strategy, render->preferences->use_renderfarm);
749 render->result = render->packages->create_packages(mwindow,
753 render->default_asset,
769 render->total_rendered = 0;
773 // Start dispatching external jobs
776 mwindow->gui->lock_window("Render::render 1");
777 mwindow->gui->show_message(_("Starting render farm"));
778 mwindow->gui->start_hourglass();
779 mwindow->gui->unlock_window();
783 printf("Render::render: starting render farm\n");
786 if(strategy == SINGLE_PASS_FARM || strategy == FILE_PER_LABEL_FARM)
788 farm_server = new RenderFarmServer(mwindow,
793 &render->total_rendered,
794 render->counter_lock,
795 render->default_asset,
798 render->result = farm_server->start_clients();
804 mwindow->gui->lock_window("Render::render 2");
805 mwindow->gui->show_message(_("Failed to start render farm"),
806 mwindow->theme->message_error);
807 mwindow->gui->stop_hourglass();
808 mwindow->gui->unlock_window();
812 printf("Render::render: Failed to start render farm\n");
821 // Perform local rendering
826 render->start_progress();
831 MainPackageRenderer package_renderer(render);
832 render->result = package_renderer.initialize(mwindow,
833 command->get_edl(), // Copy of master EDL
835 render->default_asset);
843 while(!render->result)
845 // Get unfinished job
846 RenderPackage *package;
848 if(strategy == SINGLE_PASS_FARM)
850 package = render->packages->get_package(
851 package_renderer.frames_per_second,
857 package = render->packages->get_package(0, -1, 1);
872 if(package_renderer.render_package(package))
880 printf("Render::render_single: Session finished.\n");
886 if(strategy == SINGLE_PASS_FARM || strategy == FILE_PER_LABEL_FARM)
888 farm_server->wait_clients();
891 if(debug) printf("Render::render %d\n", __LINE__);
895 (!render->progress || !render->progress->is_cancelled()) &&
896 !render->batch_cancelled)
898 if(debug) printf("Render::render %d\n", __LINE__);
901 if(debug) printf("Render::render %d\n", __LINE__);
902 ErrorBox error_box(_(PROGRAM_NAME ": Error"),
903 mwindow->gui->get_abs_cursor_x(1),
904 mwindow->gui->get_abs_cursor_y(1));
905 error_box.create_objects(_("Error rendering data."));
906 error_box.raise_window();
907 error_box.run_window();
908 if(debug) printf("Render::render %d\n", __LINE__);
912 printf("Render::render: Error rendering data\n");
915 if(debug) printf("Render::render %d\n", __LINE__);
917 // Delete the progress box
918 render->stop_progress();
920 if(debug) printf("Render::render %d\n", __LINE__);
928 // Paste all packages into timeline if desired
930 if(!render->result &&
931 render->load_mode != LOADMODE_NOTHING &&
933 render->mode != Render::BATCH)
935 if(debug) printf("Render::render %d\n", __LINE__);
936 mwindow->gui->lock_window("Render::render 3");
937 if(debug) printf("Render::render %d\n", __LINE__);
939 mwindow->undo->update_undo_before();
941 if(debug) printf("Render::render %d\n", __LINE__);
944 ArrayList<Indexable*> *assets = render->packages->get_asset_list();
945 if(debug) printf("Render::render %d\n", __LINE__);
946 if(render->load_mode == LOADMODE_PASTE)
948 if(debug) printf("Render::render %d\n", __LINE__);
949 mwindow->load_assets(assets,
954 mwindow->edl->session->labels_follow_edits,
955 mwindow->edl->session->plugins_follow_edits,
956 mwindow->edl->session->autos_follow_edits);
957 if(debug) printf("Render::render %d\n", __LINE__);
958 for(int i = 0; i < assets->size(); i++)
959 assets->get(i)->Garbage::remove_user();
961 if(debug) printf("Render::render %d\n", __LINE__);
964 mwindow->save_backup();
965 if(debug) printf("Render::render %d\n", __LINE__);
966 mwindow->undo->update_undo_after(_("render"), LOAD_ALL);
967 if(debug) printf("Render::render %d\n", __LINE__);
968 mwindow->update_plugin_guis();
969 if(debug) printf("Render::render %d\n", __LINE__);
970 mwindow->gui->update(1,
977 if(debug) printf("Render::render %d\n", __LINE__);
978 mwindow->sync_parameters(CHANGE_ALL);
979 if(debug) printf("Render::render %d\n", __LINE__);
980 mwindow->gui->unlock_window();
983 mwindow->awindow->gui->lock_window("Render::render");
984 mwindow->awindow->gui->update_assets();
985 mwindow->awindow->gui->flush();
986 mwindow->awindow->gui->unlock_window();
988 if(debug) printf("Render::render %d\n", __LINE__);
991 if(debug) printf("Render::render %d\n", __LINE__);
996 mwindow->gui->lock_window("Render::render 3");
997 mwindow->gui->stop_hourglass();
998 mwindow->gui->unlock_window();
1001 //printf("Render::render 110\n");
1002 // Need to restart because brender always stops before render.
1004 mwindow->restart_brender();
1005 if(farm_server) delete farm_server;
1009 // Must delete packages after server
1010 delete render->packages;
1012 render->packages = 0;
1013 render->in_progress = 0;
1014 render->completion->unlock();
1015 if(debug) printf("Render::render %d\n", __LINE__);
1018 void RenderThread::run()
1020 if(render->mode == Render::INTERACTIVE)
1022 render_single(1, render->asset, mwindow->edl, render->strategy);
1025 if(render->mode == Render::BATCH)
1028 // printf("RenderThread::run %d %d %d\n",
1030 // render->jobs->total,
1032 for(int i = 0; i < render->jobs->total && !render->result; i++)
1035 BatchRenderJob *job = render->jobs->values[i];
1039 if( *job->edl_path == '@' )
1041 run_script(job->edl_path+1, job->asset->path);
1046 mwindow->batch_render->update_active(i);
1050 printf("Render::run: %s\n", job->edl_path);
1055 FileXML *file = new FileXML;
1057 edl->create_objects();
1058 file->read_from_file(job->edl_path);
1059 edl->load_xml(file, LOAD_ALL);
1062 render_single(0, job->asset, edl, job->strategy);
1065 edl->Garbage::remove_user();
1070 mwindow->batch_render->update_done(i, 1, render->elapsed_time);
1073 char string[BCTEXTLEN];
1074 render->elapsed_time =
1075 (double)render->progress_timer->get_scaled_difference(1);
1076 Units::totext(string,
1077 render->elapsed_time,
1079 printf("Render::run: done in %s\n", string);
1085 mwindow->batch_render->update_active(-1);
1087 printf("Render::run: failed\n");
1095 mwindow->batch_render->update_active(-1);
1096 mwindow->batch_render->update_done(-1, 0, 0);
1113 RenderWindow::RenderWindow(MWindow *mwindow,
1118 : BC_Window(_(PROGRAM_NAME ": Render"),
1129 this->mwindow = mwindow;
1130 this->render = render;
1131 this->asset = asset;
1134 RenderWindow::~RenderWindow()
1137 lock_window("RenderWindow::~RenderWindow");
1139 delete format_tools;
1149 void RenderWindow::create_objects()
1152 lock_window("RenderWindow::create_objects");
1153 add_subwindow(new BC_Title(x,
1155 (char*)((render->strategy == FILE_PER_LABEL ||
1156 render->strategy == FILE_PER_LABEL_FARM) ?
1157 _("Select the first file to render to:") :
1158 _("Select a file to render to:"))));
1161 format_tools = new FormatTools(mwindow,
1164 format_tools->create_objects(x,
1177 loadmode = new LoadMode(mwindow,
1184 loadmode->create_objects();
1186 add_subwindow(new BC_OKButton(this));
1187 add_subwindow(new BC_CancelButton(this));