4 * Copyright (C) 2008 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
30 #include "cwindowgui.h"
34 #include "edlsession.h"
37 #include "filesystem.h"
38 #include "indexfile.h"
41 #include "mwindowgui.h"
42 #include "packagerenderer.h"
43 #include "playabletracks.h"
44 #include "playbackconfig.h"
45 #include "pluginserver.h"
46 #include "preferences.h"
48 #include "renderengine.h"
49 #include "renderfarmfsserver.h"
51 #include "sighandler.h"
53 #include "transportque.h"
56 #include "videodevice.h"
65 RenderPackage::RenderPackage()
78 RenderPackage::~RenderPackage()
89 // Used by RenderFarm and in the future, Render, to do packages.
90 PackageRenderer::PackageRenderer()
98 frames_per_second = 0;
101 PackageRenderer::~PackageRenderer()
111 // PackageRenderer::initialize happens only once for every node when doing rendering session
112 // This is not called for each package!
114 int PackageRenderer::initialize(MWindow *mwindow,
116 Preferences *preferences,
117 Asset *default_asset)
121 this->mwindow = mwindow;
123 this->preferences = preferences;
124 this->default_asset = default_asset;
127 //printf("PackageRenderer::initialize %d\n", preferences->processors);
128 command = new TransportCommand;
129 command->command = NORMAL_FWD;
130 command->get_edl()->copy_all(edl);
131 command->change_type = CHANGE_ALL;
132 command->set_playback_range(edl);
134 default_asset->frame_rate = command->get_edl()->session->frame_rate;
135 default_asset->sample_rate = command->get_edl()->session->sample_rate;
136 default_asset->aspect_ratio = (double)command->get_edl()->session->aspect_w /
137 command->get_edl()->session->aspect_h;
138 result = Render::check_asset(edl, *default_asset);
140 audio_cache = new CICache(preferences);
141 video_cache = new CICache(preferences);
143 //PlaybackConfig *config = command->get_edl()->session->playback_config;
144 aconfig = new AudioOutConfig();
145 vconfig = new VideoOutConfig;
150 void PackageRenderer::create_output()
153 asset = new Asset(*default_asset);
155 if(!get_master() && preferences->renderfarm_vfs && preferences->use_renderfarm)
156 snprintf(asset->path, sizeof(asset->path),
157 RENDERFARM_FS_PREFIX "%s", package->path);
159 strncpy(asset->path, package->path, sizeof(asset->path));
162 file->set_processors(preferences->processors);
163 result = file->open_file(preferences, asset, 0, 1);
165 if(result && mwindow)
168 char string[BCTEXTLEN];
169 snprintf(string, sizeof(string), _("Couldn't open %s"), asset->path);
170 ErrorBox error(_(PROGRAM_NAME ": Error"),
171 mwindow->gui->get_abs_cursor_x(1),
172 mwindow->gui->get_abs_cursor_y(1));
173 error.create_objects(string);
179 mwindow->sighandler->push_file(file);
180 IndexFile::delete_index(preferences, asset);
182 //printf("PackageRenderer::create_output %d %d\n", __LINE__, result);
185 void PackageRenderer::create_engine()
187 // Fix audio buffers to 1 second
188 audio_read_length = command->get_edl()->session->sample_rate;
189 command->get_edl()->session->playback_config->aconfig->fragment_size = audio_read_length;
191 aconfig->fragment_size = audio_read_length;
194 render_engine = new RenderEngine(0, preferences, 0, 0);
195 render_engine->set_acache(audio_cache);
196 render_engine->set_vcache(video_cache);
197 render_engine->arm_command(command);
199 if(package->use_brender)
201 audio_preroll = Units::to_int64((double)preferences->brender_preroll /
202 default_asset->frame_rate *
203 default_asset->sample_rate);
204 video_preroll = preferences->brender_preroll;
208 audio_preroll = Units::to_int64(preferences->render_preroll *
209 default_asset->sample_rate);
210 video_preroll = Units::to_int64(preferences->render_preroll *
211 default_asset->frame_rate);
213 audio_position = package->audio_start - audio_preroll;
214 if( audio_position < 0 )
216 audio_preroll += audio_position;
219 video_position = package->video_start - video_preroll;
220 if( video_position < 0 )
222 video_preroll += video_position;
229 // Create output buffers
230 if(asset->audio_data)
232 file->start_audio_thread(audio_read_length,
233 preferences->processors > 1 ? 2 : 1);
238 if(asset->video_data)
240 compressed_output = new VFrame;
241 // The write length needs to correlate with the processor count because
242 // it is passed to the file handler which usually processes frames simultaneously.
243 video_write_length = preferences->processors;
244 video_write_position = 0;
245 direct_frame_copying = 0;
248 //printf("PackageRenderer::create_engine %d video_write_length=%d\n", __LINE__, video_write_length);
249 // starting frames are corrupted if video_write_length > 2. Work around it, for now.
250 if(video_write_length > 2)
252 video_write_length = 2;
254 file->start_video_thread(video_write_length,
255 command->get_edl()->session->color_model,
256 preferences->processors > 1 ? 2 : 1,
258 //printf("PackageRenderer::create_engine %d\n", __LINE__);
263 video_device = new VideoDevice;
264 video_device->open_output(vconfig,
265 command->get_edl()->session->frame_rate,
266 command->get_edl()->session->output_w,
267 command->get_edl()->session->output_h,
268 mwindow->cwindow->gui->canvas,
270 // video_device->start_playback();
275 playable_tracks = new PlayableTracks(render_engine->get_edl(),
286 void PackageRenderer::do_audio()
288 //printf("PackageRenderer::do_audio %d\n", __LINE__);
290 if(asset->audio_data)
292 audio_output = file->get_audio_buffer();
293 // Zero unused channels in output vector
294 for(int i = 0; i < MAX_CHANNELS; i++)
296 audio_output_ptr[i] = (i < asset->channels) ?
303 // Call render engine
305 result = render_engine->arender->process_buffer(audio_output_ptr,
311 // Fix buffers for preroll
312 int64_t output_length = audio_read_length;
313 if(audio_preroll > 0)
315 if(audio_preroll >= output_length)
319 output_length -= audio_preroll;
320 for(int i = 0; i < MAX_CHANNELS; i++)
322 if(audio_output_ptr[i])
324 double *data = audio_output_ptr[i]->get_data();
325 for(int j = 0; j < output_length; j++)
327 data[j] = data[j + audio_read_length - output_length];
332 //printf("PackageRenderer::do_audio 4\n");
334 audio_preroll -= audio_read_length;
337 // Must perform writes even if 0 length so get_audio_buffer doesn't block
338 result |= file->write_audio_buffer(output_length);
341 audio_position += audio_read_length;
342 //printf("PackageRenderer::do_audio %d\n", __LINE__);
346 void PackageRenderer::do_video()
350 if(asset->video_data)
352 // get the absolute video position from the audio position
353 int64_t video_end = video_position + video_read_length;
355 if(video_end > package->video_end)
356 video_end = package->video_end;
358 while(video_position < video_end && !result)
360 // Try to copy the compressed frame directly from the input to output files
361 //printf("PackageRenderer::do_video 2 video_position=%ld\n", video_position);
362 if(direct_frame_copy(command->get_edl(),
367 // Direct frame copy failed.
368 // Switch back to background compression
369 if(direct_frame_copying)
372 file->start_video_thread(video_write_length,
373 command->get_edl()->session->color_model,
374 preferences->processors > 1 ? 2 : 1,
376 //printf("PackageRenderer::do_video %d %d\n", __LINE__, preferences->processors);
377 direct_frame_copying = 0;
380 // Try to use the rendering engine to write the frame.
381 // Get a buffer for background writing.
383 if(video_write_position == 0)
384 video_output = file->get_video_buffer();
386 if(debug) printf("PackageRenderer::do_video %d %p\n", __LINE__, video_output);
387 if(debug) printf("PackageRenderer::do_video %d %p\n", __LINE__, video_output[0]);
392 // Construct layered output buffer
393 video_output_ptr = video_output[0][video_write_position];
396 printf("PackageRenderer::do_video %d %p\n", __LINE__, video_output_ptr);
397 printf("PackageRenderer::do_video %d %d\n", __LINE__, result);
398 video_output_ptr->dump();
402 result = render_engine->vrender->process_buffer(
408 if(debug) printf("PackageRenderer::do_video %d %d\n", __LINE__, result);
412 video_device->output_visible())
414 // Vector for video device
415 VFrame *preview_output;
417 video_device->new_output_buffer(&preview_output,
418 command->get_edl()->session->color_model,
421 preview_output->copy_from(video_output_ptr);
422 video_device->write_buffer(preview_output,
426 if(debug) printf("PackageRenderer::do_video %d %d\n", __LINE__, result);
429 // Don't write to file
430 if(video_preroll && !result)
433 // Keep the write position at 0 until ready to write real frames
434 result = file->write_video_buffer(0);
435 video_write_position = 0;
440 // Set background rendering parameters
441 // Allow us to skip sections of the output file by setting the frame number.
442 // Used by background render and render farm.
443 //printf("PackageRenderer::do_video %d %jd\n", __LINE__, video_position);
444 video_output_ptr->set_number(video_position);
445 video_write_position++;
447 if(video_write_position >= video_write_length)
449 result = file->write_video_buffer(video_write_position);
450 //printf("PackageRenderer::do_video %d %jd\n", __LINE__, video_position);
451 // Update the brender map after writing the files.
452 if(package->use_brender)
454 //printf("PackageRenderer::do_video 10\n");
455 for(int i = 0; i < video_write_position && !result; i++)
457 result = set_video_map(video_position + 1 - video_write_position + i,
460 //printf("PackageRenderer::do_video 11 %d\n", result);
462 video_write_position = 0;
465 //printf("PackageRenderer::do_video %d %jd\n", __LINE__, video_position);
471 if(!result && get_result()) result = 1;
472 if(!result && progress_cancelled()) result = 1;
477 video_position += video_read_length;
482 void PackageRenderer::stop_engine()
484 delete render_engine;
485 delete playable_tracks;
489 void PackageRenderer::stop_output()
492 if(asset->audio_data)
495 file->stop_audio_thread();
498 if(asset->video_data)
500 delete compressed_output;
501 if(video_write_position)
502 file->write_video_buffer(video_write_position);
503 if(package->use_brender)
505 for(int i = 0; i < video_write_position && !error; i++)
507 error = set_video_map(video_position - video_write_position + i,
511 video_write_position = 0;
512 if(!error) file->stop_video_thread();
515 // video_device->stop_playback();
516 video_device->close_all();
523 void PackageRenderer::close_output()
526 mwindow->sighandler->pull_file(file);
529 asset->Garbage::remove_user();
532 // Aborts and returns 1 if an error is encountered.
533 int PackageRenderer::render_package(RenderPackage *package)
537 int samples_rendered = 0;
542 this->package = package;
545 // "PackageRenderer::render_package: audio s=%jd l=%jd video s=%jd l=%jd\n",
546 // package->audio_start,
547 // package->audio_end - package->audio_start,
548 // package->video_start,
549 // package->video_end - package->video_start);
551 if(debug) PRINT_TRACE
553 if( package->video_do ) default_asset->video_data = 1;
554 if( package->audio_do ) default_asset->audio_data = 1;
555 Render::check_asset(edl, *default_asset);
557 // FIXME: The design that we only get EDL once does not give us neccessary flexiblity to do things the way they should be donek
558 default_asset->video_data = package->video_do;
559 default_asset->audio_data = package->audio_do;
560 Render::check_asset(edl, *default_asset);
563 if(debug) PRINT_TRACE
565 if(!asset->video_data) video_done = 1;
566 if(!asset->audio_data) audio_done = 1;
568 // Create render engine
571 if(debug) PRINT_TRACE
573 if(debug) PRINT_TRACE
578 total_samples_rendered = 0;
579 while((!audio_done || !video_done) && !result)
581 int need_audio = 0, need_video = 0;
586 // Calculate lengths to process. Audio fragment is constant.
589 if(audio_position + audio_read_length >= package->audio_end)
592 audio_read_length = package->audio_end - audio_position;
595 samples_rendered = audio_read_length;
599 //printf("PackageRenderer::render_package 6 %d\n", samples_rendered);
605 // video_read_length = package->video_end - video_position;
606 // // Packetize video length so progress gets updated
607 // video_read_length = (int)MIN(asset->frame_rate, video_read_length);
608 // video_read_length = MAX(video_read_length, 30);
609 video_read_length = 1;
612 // Guide video with audio
614 video_read_length = Units::to_int64(
615 (double)(audio_position + audio_read_length) /
622 if(video_position + video_read_length >= package->video_end)
625 video_read_length = package->video_end - video_position;
628 // Calculate samples rendered for progress bar.
630 samples_rendered = Units::round((double)video_read_length /
636 if(debug) PRINT_TRACE
638 if(debug) printf("PackageRenderer::render_package 1 %d %jd %jd\n",
639 result, audio_read_length, video_read_length);
640 if(need_video && !result) do_video();
641 if(debug) printf("PackageRenderer::render_package %d %d %d\n",
642 __LINE__, result, samples_rendered);
643 if(need_audio && !result) do_audio();
646 if(debug) PRINT_TRACE
649 // Calculate frames per second for the renderfarm table.
650 total_samples_rendered += samples_rendered;
651 if(!video_done && timer->get_difference() > 30000)
653 frames_per_second = (double)total_samples_rendered *
656 ((double)timer->get_difference() / 1000);
658 set_progress(samples_rendered);
660 if(debug) PRINT_TRACE
666 if(!result && progress_cancelled()) result = 1;
667 if(debug) PRINT_TRACE
669 // printf("PackageRenderer::render_package 10 %d %d %d %d\n",
670 // audio_read_length, video_read_length, samples_rendered, result);
674 result = get_result();
678 frames_per_second = (double)(package->video_end - package->video_start) /
679 ((double)timer->get_difference() / 1000);
714 // Try to copy the compressed frame directly from the input to output files
715 // Return 1 on failure and 0 on success
716 int PackageRenderer::direct_frame_copy(EDL *edl,
717 int64_t &video_position,
721 Track *playable_track = 0;
722 Edit *playable_edit = 0;
724 //printf("Render::direct_frame_copy 1\n");
725 if(direct_copy_possible(edl,
731 // Switch to direct copying
732 if(!direct_frame_copying)
734 if(video_write_position)
736 error |= file->write_video_buffer(video_write_position);
737 video_write_position = 0;
739 file->stop_video_thread();
740 direct_frame_copying = 1;
742 //printf("Render::direct_frame_copy 2\n");
744 if(!package->use_brender)
746 error |= ((VEdit*)playable_edit)->read_frame(compressed_output,
753 //printf("Render::direct_frame_copy %d %d\n", __LINE__, compressed_output->get_compressed_size());
757 if(!error && video_preroll > 0)
764 if(package->use_brender)
766 //printf("PackageRenderer::direct_frame_copy 1\n");
767 error = set_video_map(video_position, BRender::SCANNED);
768 //printf("PackageRenderer::direct_frame_copy 10 %d\n", error);
772 VFrame ***temp_output = new VFrame**[1];
773 temp_output[0] = new VFrame*[1];
774 temp_output[0][0] = compressed_output;
775 error = file->write_frames(temp_output, 1);
776 delete [] temp_output[0];
777 delete [] temp_output;
786 int PackageRenderer::direct_copy_possible(EDL *edl,
787 int64_t current_position,
788 Track* &playable_track, // The one track which is playable
789 Edit* &playable_edit, // The edit which is playing
790 File *file) // Output file
793 int total_playable_tracks = 0;
794 Track* current_track;
796 // Number of playable tracks must equal 1
797 for(current_track = edl->tracks->first;
798 current_track && result;
799 current_track = current_track->next)
801 if(current_track->data_type == TRACK_VIDEO)
803 if(playable_tracks->is_playable(current_track,
808 playable_track = current_track;
809 total_playable_tracks++;
814 //printf("Render::direct_copy_possible 1 %d\n", result);
815 if(total_playable_tracks != 1) result = 0;
816 //printf("Render::direct_copy_possible 2 %d\n", result);
818 // Edit must have a source file
819 // TODO: descend into nested EDL's
822 //printf("Render::direct_copy_possible 3 %d\n", result);
823 playable_edit = playable_track->edits->get_playable_edit(current_position, 1);
824 //printf("Render::direct_copy_possible 4 %d %p\n", result, playable_edit);
829 // Source file must be able to copy to destination file.
830 // Source file must be same size as project output.
833 if(!file->can_copy_from(playable_edit->asset,
834 current_position + playable_track->nudge,
835 edl->session->output_w,
836 edl->session->output_h))
839 //printf("Render::direct_copy_possible 6 %d\n", result);
841 // Test conditions mutual between vrender.C and this.
843 !playable_track->direct_copy_possible(current_position, PLAY_FORWARD, 1))
845 //printf("Render::direct_copy_possible 7 %d\n", result);
858 int PackageRenderer::get_master()
863 // Get result status from server
864 int PackageRenderer::get_result()
869 void PackageRenderer::set_result(int value)
873 void PackageRenderer::set_progress(int64_t value)
877 int PackageRenderer::set_video_map(int64_t position, int value)
882 int PackageRenderer::progress_cancelled()