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();
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 ) {
167 char string[BCTEXTLEN];
168 snprintf(string, sizeof(string), _("Couldn't open %s"), asset->path);
169 ErrorBox error(_(PROGRAM_NAME ": Error"),
170 mwindow->gui->get_abs_cursor_x(1),
171 mwindow->gui->get_abs_cursor_y(1));
172 error.create_objects(string);
177 mwindow->sighandler->push_file(file);
178 IndexFile::delete_index(preferences, asset);
180 //printf("PackageRenderer::create_output %d %d\n", __LINE__, result);
183 void PackageRenderer::create_engine()
185 // Fix audio buffers to 1 second
186 audio_read_length = command->get_edl()->session->sample_rate;
187 command->get_edl()->session->playback_config->aconfig->fragment_size = audio_read_length;
189 aconfig->fragment_size = audio_read_length;
192 render_engine = new RenderEngine(0, preferences, 0, 0);
193 render_engine->set_acache(audio_cache);
194 render_engine->set_vcache(video_cache);
195 render_engine->arm_command(command);
197 if( package->use_brender ) {
198 audio_preroll = Units::to_int64((double)preferences->brender_preroll /
199 default_asset->frame_rate *
200 default_asset->sample_rate);
201 video_preroll = preferences->brender_preroll;
204 audio_preroll = Units::to_int64(preferences->render_preroll *
205 default_asset->sample_rate);
206 video_preroll = Units::to_int64(preferences->render_preroll *
207 default_asset->frame_rate);
209 audio_position = package->audio_start - audio_preroll;
210 if( audio_position < 0 ) {
211 audio_preroll += audio_position;
214 video_position = package->video_start - video_preroll;
215 if( video_position < 0 ) {
216 video_preroll += video_position;
223 // Create output buffers
224 if( asset->audio_data ) {
225 file->start_audio_thread(audio_read_length,
226 preferences->processors > 1 ? 2 : 1);
231 if( asset->video_data ) {
232 compressed_output = new VFrame;
233 // The write length needs to correlate with the processor count because
234 // it is passed to the file handler which usually processes frames simultaneously.
235 video_write_length = preferences->processors;
236 video_write_position = 0;
237 direct_frame_copying = 0;
240 //printf("PackageRenderer::create_engine %d video_write_length=%d\n", __LINE__, video_write_length);
241 // starting frames are corrupted if video_write_length > 2. Work around it, for now.
242 if( video_write_length > 2 ) {
243 video_write_length = 2;
245 file->start_video_thread(video_write_length,
246 command->get_edl()->session->color_model,
247 preferences->processors > 1 ? 2 : 1,
249 //printf("PackageRenderer::create_engine %d\n", __LINE__);
253 video_device = new VideoDevice;
254 video_device->open_output(vconfig,
255 command->get_edl()->session->frame_rate,
256 command->get_edl()->session->output_w,
257 command->get_edl()->session->output_h,
258 mwindow->cwindow->gui->canvas,
260 // video_device->start_playback();
265 playable_tracks = new PlayableTracks(render_engine->get_edl(),
276 void PackageRenderer::do_audio()
278 //printf("PackageRenderer::do_audio %d\n", __LINE__);
280 if( asset->audio_data ) {
281 audio_output = file->get_audio_buffer();
282 // Zero unused channels in output vector
283 for( int i = 0; i < MAX_CHANNELS; i++ ) {
284 audio_output_ptr[i] = (i < asset->channels) ?
291 // Call render engine
293 result = render_engine->arender->process_buffer(audio_output_ptr,
299 // Fix buffers for preroll
300 int64_t output_length = audio_read_length;
301 if( audio_preroll > 0 ) {
302 if( audio_preroll >= output_length )
305 output_length -= audio_preroll;
306 for( int i = 0; i < MAX_CHANNELS; i++ ) {
307 if( audio_output_ptr[i] ) {
308 double *data = audio_output_ptr[i]->get_data();
309 for( int j = 0; j < output_length; j++ ) {
310 data[j] = data[j + audio_read_length - output_length];
315 //printf("PackageRenderer::do_audio 4\n");
317 audio_preroll -= audio_read_length;
320 // Must perform writes even if 0 length so get_audio_buffer doesn't block
321 result |= file->write_audio_buffer(output_length);
324 audio_position += audio_read_length;
325 //printf("PackageRenderer::do_audio %d\n", __LINE__);
329 void PackageRenderer::do_video()
332 if( asset->video_data ) {
333 // get the absolute video position from the audio position
334 int64_t video_end = video_position + video_read_length;
336 if( video_end > package->video_end )
337 video_end = package->video_end;
339 while( !result && video_position < video_end ) {
340 // Try to copy the compressed frame directly from the input to output files
341 if( direct_frame_copy(command->get_edl(),
342 video_position, file, result) ) {
343 // Direct frame copy failed.
344 // Switch back to background compression
345 if( direct_frame_copying ) {
347 file->start_video_thread(video_write_length,
348 command->get_edl()->session->color_model,
349 preferences->processors > 1 ? 2 : 1,
351 //printf("PackageRenderer::do_video %d %d\n", __LINE__, preferences->processors);
352 direct_frame_copying = 0;
355 // Try to use the rendering engine to write the frame.
356 // Get a buffer for background writing.
358 if( video_write_position == 0 )
359 video_output = file->get_video_buffer();
360 // Construct layered output buffer
361 video_output_ptr = video_output[0][video_write_position];
364 result = render_engine->vrender->process_buffer(
365 video_output_ptr, video_position, 0);
368 video_device->output_visible() ) {
369 // Vector for video device
370 VFrame *preview_output;
372 video_device->new_output_buffer(&preview_output,
373 command->get_edl()->session->color_model,
376 preview_output->copy_from(video_output_ptr);
377 video_device->write_buffer(preview_output,
380 // Don't write to file
381 if( video_preroll && !result ) {
383 // Keep the write position at 0 until ready to write real frames
384 result = file->write_video_buffer(0);
385 video_write_position = 0;
389 // Set background rendering parameters
390 // Allow us to skip sections of the output file by setting the frame number.
391 // Used by background render and render farm.
392 video_output_ptr->set_number(video_position);
393 video_write_position++;
395 if( video_write_position >= video_write_length ) {
396 result = file->write_video_buffer(video_write_position);
397 // Update the brender map after writing the files.
398 if( package->use_brender ) {
399 for( int i = 0; i < video_write_position && !result; i++ ) {
400 result = set_video_map(video_position + 1 - video_write_position + i,
404 video_write_position = 0;
410 if( !result && get_result() ) result = 1;
411 if( !result && progress_cancelled() ) result = 1;
415 video_position += video_read_length;
420 void PackageRenderer::stop_engine()
422 delete render_engine;
423 delete playable_tracks;
427 void PackageRenderer::stop_output()
430 if( asset->audio_data ) {
432 file->stop_audio_thread();
435 if( asset->video_data ) {
436 delete compressed_output;
437 if( video_write_position )
438 file->write_video_buffer(video_write_position);
439 if( package->use_brender ) {
440 for( int i = 0; i < video_write_position && !error; i++ ) {
441 error = set_video_map(video_position - video_write_position + i,
445 video_write_position = 0;
446 if( !error ) file->stop_video_thread();
448 // video_device->stop_playback();
449 video_device->close_all();
456 void PackageRenderer::close_output()
459 mwindow->sighandler->pull_file(file);
462 asset->Garbage::remove_user();
465 // Aborts and returns 1 if an error is encountered.
466 int PackageRenderer::render_package(RenderPackage *package)
470 int samples_rendered = 0;
475 this->package = package;
478 // "PackageRenderer::render_package: audio s=%jd l=%jd video s=%jd l=%jd\n",
479 // package->audio_start,
480 // package->audio_end - package->audio_start,
481 // package->video_start,
482 // package->video_end - package->video_start);
484 if( debug ) PRINT_TRACE
486 if( package->video_do ) default_asset->video_data = 1;
487 if( package->audio_do ) default_asset->audio_data = 1;
488 Render::check_asset(edl, *default_asset);
490 // FIXME: The design that we only get EDL once does not give us neccessary flexiblity to do things the way they should be donek
491 default_asset->video_data = package->video_do;
492 default_asset->audio_data = package->audio_do;
493 Render::check_asset(edl, *default_asset);
497 if( !asset->video_data ) video_done = 1;
498 if( !asset->audio_data ) audio_done = 1;
500 // Create render engine
505 total_samples_rendered = 0;
506 while( !result && (!audio_done || !video_done) ) {
507 int need_audio = 0, need_video = 0;
508 // Calculate lengths to process. Audio fragment is constant.
510 if( audio_position + audio_read_length >= package->audio_end ) {
512 audio_read_length = package->audio_end - audio_position;
515 samples_rendered = audio_read_length;
519 //printf("PackageRenderer::render_package 6 %d\n", samples_rendered);
523 // video_read_length = package->video_end - video_position;
524 // // Packetize video length so progress gets updated
525 // video_read_length = (int)MIN(asset->frame_rate, video_read_length);
526 // video_read_length = MAX(video_read_length, 30);
527 video_read_length = 1;
530 // Guide video with audio
531 video_read_length = Units::to_int64(
532 (double)(audio_position + audio_read_length) /
539 if( video_position + video_read_length >= package->video_end ) {
541 video_read_length = package->video_end - video_position;
544 // Calculate samples rendered for progress bar.
546 samples_rendered = Units::round((double)video_read_length /
552 if( need_video && !result ) do_video();
553 if( need_audio && !result ) do_audio();
555 if( debug ) PRINT_TRACE
557 // Calculate frames per second for the renderfarm table.
558 total_samples_rendered += samples_rendered;
559 if( !video_done && timer->get_difference() > 30000 ) {
560 frames_per_second = (double)total_samples_rendered *
563 ((double)timer->get_difference() / 1000);
565 set_progress(samples_rendered);
568 if( !result && progress_cancelled() ) result = 1;
570 // audio_read_length, video_read_length, samples_rendered, result);
574 result = get_result();
578 frames_per_second = (double)(package->video_end - package->video_start) /
579 ((double)timer->get_difference() / 1000);
614 // Try to copy the compressed frame directly from the input to output files
615 // Return 1 on failure and 0 on success
616 int PackageRenderer::direct_frame_copy(EDL *edl,
617 int64_t &video_position,
621 Track *playable_track = 0;
622 Edit *playable_edit = 0;
624 //printf("Render::direct_frame_copy 1\n");
625 if( direct_copy_possible(edl,
630 // Switch to direct copying
631 if( !direct_frame_copying ) {
632 if( video_write_position ) {
633 error |= file->write_video_buffer(video_write_position);
634 video_write_position = 0;
636 file->stop_video_thread();
637 direct_frame_copying = 1;
639 //printf("Render::direct_frame_copy 2\n");
641 if( !package->use_brender ) {
642 error |= ((VEdit*)playable_edit)->read_frame(compressed_output,
649 //printf("Render::direct_frame_copy %d %d\n", __LINE__, compressed_output->get_compressed_size());
653 if( !error && video_preroll > 0 ) {
658 if( package->use_brender ) {
659 //printf("PackageRenderer::direct_frame_copy 1\n");
660 error = set_video_map(video_position, BRender::SCANNED);
661 //printf("PackageRenderer::direct_frame_copy 10 %d\n", error);
664 VFrame ***temp_output = new VFrame**[1];
665 temp_output[0] = new VFrame*[1];
666 temp_output[0][0] = compressed_output;
667 error = file->write_frames(temp_output, 1);
668 delete [] temp_output[0];
669 delete [] temp_output;
678 int PackageRenderer::direct_copy_possible(EDL *edl,
679 int64_t current_position,
680 Track* &playable_track, // The one track which is playable
681 Edit* &playable_edit, // The edit which is playing
682 File *file) // Output file
685 int total_playable_tracks = 0;
686 Track* current_track;
688 // Number of playable tracks must equal 1
689 for( current_track = edl->tracks->first;
690 current_track && result;
691 current_track = current_track->next ) {
692 if( current_track->data_type == TRACK_VIDEO ) {
693 if( playable_tracks->is_playable(current_track,
697 playable_track = current_track;
698 total_playable_tracks++;
703 //printf("Render::direct_copy_possible 1 %d\n", result);
704 if( total_playable_tracks != 1 ) result = 0;
705 //printf("Render::direct_copy_possible 2 %d\n", result);
707 // Edit must have a source file
708 // TODO: descend into nested EDL's
710 //printf("Render::direct_copy_possible 3 %d\n", result);
711 playable_edit = playable_track->edits->get_playable_edit(current_position, 1);
712 //printf("Render::direct_copy_possible 4 %d %p\n", result, playable_edit);
717 // Source file must be able to copy to destination file.
718 // Source file must be same size as project output.
720 if( !file->can_copy_from(playable_edit->asset,
721 current_position + playable_track->nudge,
722 edl->session->output_w,
723 edl->session->output_h) )
726 //printf("Render::direct_copy_possible 6 %d\n", result);
728 // Test conditions mutual between vrender.C and this.
730 !playable_track->direct_copy_possible(current_position, PLAY_FORWARD, 1) )
732 //printf("Render::direct_copy_possible 7 %d\n", result);
745 int PackageRenderer::get_master()
750 // Get result status from server
751 int PackageRenderer::get_result()
756 void PackageRenderer::set_result(int value)
760 void PackageRenderer::set_progress(int64_t value)
764 int PackageRenderer::set_video_map(int64_t position, int value)
769 int PackageRenderer::progress_cancelled()