libhb/work.c

   1 /* $Id: work.c,v 1.43 2005/03/17 16:38:49 titer Exp $
   2
   3    This file is part of the HandBrake source code.
   4    Homepage: <http://handbrake.fr/>.
   5    It may be used under the terms of the GNU General Public License. */
   6
   7 #include "hb.h"
   8 #include "a52dec/a52.h"
   9 #include "dca.h"
  10 #include "libavformat/avformat.h"
  11
  12 typedef struct
  13 {
  14     hb_list_t * jobs;
  15     hb_job_t  ** current_job;
  16     int         cpu_count;
  17     int       * error;
  18     volatile int * die;
  19
  20 } hb_work_t;
  21
  22 static void work_func();
  23 static void do_job( hb_job_t *, int cpu_count );
  24 static void work_loop( void * );
  25
  26 #define FIFO_LARGE 32
  27 #define FIFO_LARGE_WAKE 16
  28 #define FIFO_SMALL 16
  29 #define FIFO_SMALL_WAKE 15
  30
  31 /**
  32  * Allocates work object and launches work thread with work_func.
  33  * @param jobs Handle to hb_list_t.
  34  * @param cpu_count Humber of CPUs found in system.
  35  * @param die Handle to user inititated exit indicator.
  36  * @param error Handle to error indicator.
  37  */
  38 hb_thread_t * hb_work_init( hb_list_t * jobs, int cpu_count,
  39                             volatile int * die, int * error, hb_job_t ** job )
  40 {
  41     hb_work_t * work = calloc( sizeof( hb_work_t ), 1 );
  42
  43     work->jobs      = jobs;
  44     work->current_job = job;
  45     work->cpu_count = cpu_count;
  46     work->die       = die;
  47     work->error     = error;
  48
  49     return hb_thread_init( "work", work_func, work, HB_LOW_PRIORITY );
  50 }
  51
  52 static void InitWorkState( hb_handle_t * h )
  53 {
  54     hb_state_t state;
  55
  56     state.state = HB_STATE_WORKING;
  57 #define p state.param.working
  58     p.progress  = 0.0;
  59     p.rate_cur  = 0.0;
  60     p.rate_avg  = 0.0;
  61     p.hours     = -1;
  62     p.minutes   = -1;
  63     p.seconds   = -1;
  64 #undef p
  65
  66     hb_set_state( h, &state );
  67
  68 }
  69
  70 /**
  71  * Iterates through job list and calls do_job for each job.
  72  * @param _work Handle work object.
  73  */
  74 static void work_func( void * _work )
  75 {
  76     hb_work_t  * work = _work;
  77     hb_job_t   * job;
  78
  79     hb_log( "%d job(s) to process", hb_list_count( work->jobs ) );
  80
  81     while( !*work->die && ( job = hb_list_item( work->jobs, 0 ) ) )
  82     {
  83         hb_list_rem( work->jobs, job );
  84         job->die = work->die;
  85         *(work->current_job) = job;
  86         InitWorkState( job->h );
  87         do_job( job, work->cpu_count );
  88         *(work->current_job) = NULL;
  89     }
  90
  91     *(work->error) = HB_ERROR_NONE;
  92
  93     free( work );
  94 }
  95
  96 hb_work_object_t * hb_get_work( int id )
  97 {
  98     hb_work_object_t * w;
  99     for( w = hb_objects; w; w = w->next )
 100     {
 101         if( w->id == id )
 102         {
 103             hb_work_object_t *wc = malloc( sizeof(*w) );
 104             *wc = *w;
 105             return wc;
 106         }
 107     }
 108     return NULL;
 109 }
 110
 111 hb_work_object_t * hb_codec_decoder( int codec )
 112 {
 113     switch( codec )
 114     {
 115         case HB_ACODEC_AC3:  return hb_get_work( WORK_DECA52 );
 116         case HB_ACODEC_DCA:  return hb_get_work( WORK_DECDCA );
 117         case HB_ACODEC_MPGA: return hb_get_work( WORK_DECAVCODEC );
 118         case HB_ACODEC_LPCM: return hb_get_work( WORK_DECLPCM );
 119         case HB_ACODEC_FFMPEG: return hb_get_work( WORK_DECAVCODECAI );
 120     }
 121     return NULL;
 122 }
 123
 124 hb_work_object_t * hb_codec_encoder( int codec )
 125 {
 126     switch( codec )
 127     {
 128         case HB_ACODEC_FAAC:   return hb_get_work( WORK_ENCFAAC );
 129         case HB_ACODEC_LAME:   return hb_get_work( WORK_ENCLAME );
 130         case HB_ACODEC_VORBIS: return hb_get_work( WORK_ENCVORBIS );
 131         case HB_ACODEC_CA_AAC:  return hb_get_work( WORK_ENC_CA_AAC );
 132     }
 133     return NULL;
 134 }
 135
 136 /**
 137  * Displays job parameters in the debug log.
 138  * @param job Handle work hb_job_t.
 139  */
 140 void hb_display_job_info( hb_job_t * job )
 141 {
 142     hb_title_t * title = job->title;
 143     hb_audio_t   * audio;
 144     hb_subtitle_t * subtitle;
 145     int             i, j;
 146
 147     hb_log("job configuration:");
 148     hb_log( " * source");
 149
 150     hb_log( "   + %s", title->path );
 151
 152     hb_log( "   + title %d, chapter(s) %d to %d", title->index,
 153             job->chapter_start, job->chapter_end );
 154
 155     if( title->container_name != NULL )
 156         hb_log( "   + container: %s", title->container_name);
 157
 158     if( title->data_rate )
 159     {
 160         hb_log( "   + data rate: %d kbps", title->data_rate / 1000 );
 161     }
 162
 163     hb_log( " * destination");
 164
 165     hb_log( "   + %s", job->file );
 166
 167     switch( job->mux )
 168     {
 169         case HB_MUX_MP4:
 170             hb_log("   + container: MPEG-4 (.mp4 and .m4v)");
 171
 172             if( job->ipod_atom )
 173                 hb_log( "     + compatibility atom for iPod 5G");
 174
 175             if( job->largeFileSize )
 176                 hb_log( "     + 64-bit formatting");
 177
 178             if( job->mp4_optimize )
 179                 hb_log( "     + optimized for progressive web downloads");
 180
 181             if( job->color_matrix )
 182                 hb_log( "     + custom color matrix: %s", job->color_matrix == 1 ? "ITU Bt.601 (SD)" : "ITU Bt.709 (HD)");
 183             break;
 184
 185         case HB_MUX_AVI:
 186             hb_log("   + container: AVI");
 187             break;
 188
 189         case HB_MUX_MKV:
 190             hb_log("   + container: Matroska (.mkv)");
 191             break;
 192
 193         case HB_MUX_OGM:
 194             hb_log("   + conttainer: Ogg Media (.ogm)");
 195             break;
 196     }
 197
 198     if( job->chapter_markers )
 199     {
 200         hb_log( "     + chapter markers" );
 201     }
 202
 203     hb_log(" * video track");
 204
 205     hb_log("   + decoder: %s", title->video_codec_name );
 206
 207     if( title->video_bitrate )
 208     {
 209         hb_log( "     + bitrate %d kbps", title->video_bitrate / 1000 );
 210     }
 211
 212     if( !job->cfr )
 213     {
 214         hb_log( "   + frame rate: same as source (around %.3f fps)",
 215             (float) title->rate / (float) title->rate_base );
 216     }
 217     else
 218     {
 219         static const char *frtypes[] = {
 220             "", "constant", "peak rate limited to"
 221         };
 222         hb_log( "   + frame rate: %.3f fps -> %s %.3f fps",
 223             (float) title->rate / (float) title->rate_base, frtypes[job->cfr],
 224             (float) job->vrate / (float) job->vrate_base );
 225     }
 226
 227     if( job->anamorphic.mode )
 228     {
 229         hb_log( "   + %s anamorphic", job->anamorphic.mode == 1 ? "strict" : job->anamorphic.mode == 2? "loose" : "custom" );
 230         if( job->anamorphic.mode == 3 && job->anamorphic.keep_display_aspect )
 231         {
 232             hb_log( "     + keeping source display aspect ratio");
 233         }
 234         hb_log( "     + storage dimensions: %d * %d -> %d * %d, crop %d/%d/%d/%d, mod %i",
 235                     title->width, title->height, job->width, job->height,
 236                     job->crop[0], job->crop[1], job->crop[2], job->crop[3], job->modulus );
 237         if( job->anamorphic.itu_par )
 238         {
 239             hb_log( "     + using ITU pixel aspect ratio values");
 240         }
 241         hb_log( "     + pixel aspect ratio: %i / %i", job->anamorphic.par_width, job->anamorphic.par_height );
 242         hb_log( "     + display dimensions: %.0f * %i",
 243             (float)( job->width * job->anamorphic.par_width / job->anamorphic.par_height ), job->height );
 244     }
 245     else
 246     {
 247         hb_log( "   + dimensions: %d * %d -> %d * %d, crop %d/%d/%d/%d",
 248                 title->width, title->height, job->width, job->height,
 249                 job->crop[0], job->crop[1], job->crop[2], job->crop[3] );
 250     }
 251
 252     if ( job->grayscale )
 253         hb_log( "   + grayscale mode" );
 254
 255     if( hb_list_count( job->filters ) )
 256     {
 257         hb_log("   + %s", hb_list_count( job->filters) > 1 ? "filters" : "filter" );
 258         for( i = 0; i < hb_list_count( job->filters ); i++ )
 259         {
 260             hb_filter_object_t * filter = hb_list_item( job->filters, i );
 261             if (filter->settings)
 262                 hb_log("     + %s (%s)", filter->name, filter->settings);
 263             else
 264                 hb_log("     + %s (default settings)", filter->name);
 265         }
 266     }
 267
 268     if( !job->indepth_scan )
 269     {
 270         /* Video encoder */
 271         switch( job->vcodec )
 272         {
 273             case HB_VCODEC_FFMPEG:
 274                 hb_log( "   + encoder: FFmpeg" );
 275                 break;
 276
 277             case HB_VCODEC_X264:
 278                 hb_log( "   + encoder: x264" );
 279                 if( job->x264opts != NULL && *job->x264opts != '\0' )
 280                     hb_log( "     + options: %s", job->x264opts);
 281                 break;
 282
 283             case HB_VCODEC_THEORA:
 284                 hb_log( "   + encoder: Theora" );
 285                 break;
 286         }
 287
 288         if( job->vquality >= 0.0 && job->vquality <= 1.0 )
 289         {
 290             hb_log( "     + quality: %.2f", job->vquality );
 291         }
 292         else if( job->vquality > 1 )
 293         {
 294             hb_log( "     + quality: %.2f %s", job->vquality, job->vcodec == HB_VCODEC_X264 ? "(RF)" : "(QP)" );
 295         }
 296         else
 297         {
 298             hb_log( "     + bitrate: %d kbps, pass: %d", job->vbitrate, job->pass );
 299         }
 300     }
 301
 302     for( i=0; i < hb_list_count( title->list_subtitle ); i++ )
 303     {
 304         subtitle =  hb_list_item( title->list_subtitle, i );
 305
 306         if( subtitle )
 307         {
 308             if( subtitle->source == SRTSUB )
 309             {
 310                 /* For SRT, print offset and charset too */
 311                 hb_log( " * subtitle track %i, %s (id %x) %s [%s] -> %s%s, offset: %"PRId64", charset: %s",
 312                         subtitle->track, subtitle->lang, subtitle->id, "Text", "SRT", "Pass-Through",
 313                         subtitle->config.default_track ? ", Default" : "",
 314                         subtitle->config.offset, subtitle->config.src_codeset );
 315             }
 316             else
 317             {
 318                 hb_log( " * subtitle track %i, %s (id %x) %s [%s] -> %s%s%s", subtitle->track, subtitle->lang, subtitle->id,
 319                         subtitle->format == PICTURESUB ? "Picture" : "Text",
 320                         hb_subsource_name( subtitle->source ),
 321                         job->indepth_scan ? "Foreign Audio Search" :
 322                         subtitle->config.dest == RENDERSUB ? "Render/Burn in" : "Pass-Through",
 323                         subtitle->config.force ? ", Forced Only" : "",
 324                         subtitle->config.default_track ? ", Default" : "" );
 325             }
 326         }
 327     }
 328
 329     if( !job->indepth_scan )
 330     {
 331         for( i = 0; i < hb_list_count( title->list_audio ); i++ )
 332         {
 333             audio = hb_list_item( title->list_audio, i );
 334
 335             hb_log( " * audio track %d", audio->config.out.track );
 336
 337             if( audio->config.out.name )
 338                 hb_log( "   + name: %s", audio->config.out.name );
 339
 340             hb_log( "   + decoder: %s (track %d, id %x)", audio->config.lang.description, audio->config.in.track + 1, audio->id );
 341
 342             if( ( audio->config.in.codec == HB_ACODEC_AC3 ) || ( audio->config.in.codec == HB_ACODEC_DCA) )
 343             {
 344                 hb_log( "     + bitrate: %d kbps, samplerate: %d Hz", audio->config.in.bitrate / 1000, audio->config.in.samplerate );
 345             }
 346
 347             if( (audio->config.out.codec != HB_ACODEC_AC3) && (audio->config.out.codec != HB_ACODEC_DCA) )
 348             {
 349                 for (j = 0; j < hb_audio_mixdowns_count; j++)
 350                 {
 351                     if (hb_audio_mixdowns[j].amixdown == audio->config.out.mixdown) {
 352                         hb_log( "   + mixdown: %s", hb_audio_mixdowns[j].human_readable_name );
 353                         break;
 354                     }
 355                 }
 356             }
 357
 358             if ( audio->config.out.dynamic_range_compression && (audio->config.out.codec != HB_ACODEC_AC3) && (audio->config.out.codec != HB_ACODEC_DCA))
 359             {
 360                 hb_log("   + dynamic range compression: %f", audio->config.out.dynamic_range_compression);
 361             }
 362
 363             if( (audio->config.out.codec == HB_ACODEC_AC3) || (audio->config.out.codec == HB_ACODEC_DCA) )
 364             {
 365                 hb_log( "   + %s passthrough", (audio->config.out.codec == HB_ACODEC_AC3) ?
 366                     "AC3" : "DCA" );
 367             }
 368             else
 369             {
 370                 hb_log( "   + encoder: %s", ( audio->config.out.codec == HB_ACODEC_FAAC ) ?
 371                     "faac" : ( ( audio->config.out.codec == HB_ACODEC_LAME ) ?
 372                     "lame" : ( ( audio->config.out.codec == HB_ACODEC_CA_AAC ) ?
 373                               "ca_aac" : "vorbis"  ) ) );
 374                 hb_log( "     + bitrate: %d kbps, samplerate: %d Hz", audio->config.out.bitrate, audio->config.out.samplerate );
 375             }
 376         }
 377     }
 378 }
 379
 380 /* Corrects framerates when actual duration and frame count numbers are known. */
 381 void correct_framerate( hb_job_t * job )
 382 {
 383     int real_frames;
 384
 385     hb_interjob_t * interjob = hb_interjob_get( job->h );
 386
 387     if( ( job->sequence_id & 0xFFFFFF ) != ( interjob->last_job & 0xFFFFFF) )
 388         return; // Interjob information is for a different encode.
 389
 390     /* Cache the original framerate before altering it. */
 391     interjob->vrate = job->vrate;
 392     interjob->vrate_base = job->vrate_base;
 393
 394     real_frames = interjob->frame_count - interjob->render_dropped;
 395
 396     job->vrate = job->vrate_base * ( (double)real_frames * 90000 / interjob->total_time );
 397 }
 398
 399 /**
 400  * Job initialization rountine.
 401  * Initializes fifos.
 402  * Creates work objects for synchronizer, video decoder, video renderer, video decoder, audio decoder, audio encoder, reader, muxer.
 403  * Launches thread for each work object with work_loop.
 404  * Loops while monitoring status of work threads and fifos.
 405  * Exits loop when conversion is done and fifos are empty.
 406  * Closes threads and frees fifos.
 407  * @param job Handle work hb_job_t.
 408  * @param cpu_count number of CPUs found in system.
 409  */
 410 static void do_job( hb_job_t * job, int cpu_count )
 411 {
 412     hb_title_t    * title;
 413     int             i, j;
 414     hb_work_object_t * w;
 415     hb_work_object_t * sync;
 416     hb_work_object_t * muxer;
 417     hb_interjob_t * interjob;
 418
 419     hb_audio_t   * audio;
 420     hb_subtitle_t * subtitle;
 421     hb_attachment_t * attachment;
 422     unsigned int subtitle_highest = 0;
 423     unsigned int subtitle_highest_id = 0;
 424     unsigned int subtitle_lowest = -1;
 425     unsigned int subtitle_lowest_id = 0;
 426     unsigned int subtitle_forced_id = 0;
 427     unsigned int subtitle_hit = 0;
 428
 429     title = job->title;
 430     interjob = hb_interjob_get( job->h );
 431
 432     if( job->pass == 2 && !job->cfr )
 433     {
 434         correct_framerate( job );
 435     }
 436
 437     job->list_work = hb_list_init();
 438
 439     hb_log( "starting job" );
 440
 441     if( job->anamorphic.mode )
 442     {
 443         hb_set_anamorphic_size(job, &job->width, &job->height, &job->anamorphic.par_width, &job->anamorphic.par_height);
 444
 445         if( job->vcodec == HB_VCODEC_FFMPEG )
 446         {
 447             /* Just to make working with ffmpeg even more fun,
 448                lavc's MPEG-4 encoder can't handle PAR values >= 255,
 449                even though AVRational does. Adjusting downwards
 450                distorts the display aspect slightly, but such is life. */
 451             while ((job->anamorphic.par_width & ~0xFF) ||
 452                    (job->anamorphic.par_height & ~0xFF))
 453             {
 454                 job->anamorphic.par_width >>= 1;
 455                 job->anamorphic.par_height >>= 1;
 456             }
 457         }
 458     }
 459
 460     /* Keep width and height within these boundaries,
 461        but ignore for anamorphic. For "loose" anamorphic encodes,
 462        this stuff is covered in the pixel_ratio section above.    */
 463     if ( job->maxHeight && ( job->height > job->maxHeight ) && ( !job->anamorphic.mode ) )
 464     {
 465         job->height = job->maxHeight;
 466         hb_fix_aspect( job, HB_KEEP_HEIGHT );
 467         hb_log( "Height out of bounds, scaling down to %i", job->maxHeight );
 468         hb_log( "New dimensions %i * %i", job->width, job->height );
 469     }
 470     if ( job->maxWidth && ( job->width > job->maxWidth ) && ( !job->anamorphic.mode ) )
 471     {
 472         job->width = job->maxWidth;
 473         hb_fix_aspect( job, HB_KEEP_WIDTH );
 474         hb_log( "Width out of bounds, scaling down to %i", job->maxWidth );
 475         hb_log( "New dimensions %i * %i", job->width, job->height );
 476     }
 477
 478     if( job->mux & HB_MUX_AVI )
 479     {
 480         // The concept of variable frame rate video was a bit too advanced
 481         // for Microsoft so AVI doesn't support it. Since almost all dvd
 482         // video is VFR we have to convert it to constant frame rate to
 483         // put it in an AVI container. So duplicate, drop and
 484         // otherwise trash video frames to appease the gods of Redmond.
 485         job->cfr = 1;
 486     }
 487
 488     if ( job->cfr == 0 )
 489     {
 490         /* Ensure we're using "Same as source" FPS */
 491         job->vrate_base = title->rate_base;
 492     }
 493
 494     job->fifo_mpeg2  = hb_fifo_init( FIFO_LARGE, FIFO_LARGE_WAKE );
 495     job->fifo_raw    = hb_fifo_init( FIFO_SMALL, FIFO_SMALL_WAKE );
 496     job->fifo_sync   = hb_fifo_init( FIFO_SMALL, FIFO_SMALL_WAKE );
 497     job->fifo_render = hb_fifo_init( FIFO_SMALL, FIFO_SMALL_WAKE );
 498     job->fifo_mpeg4  = hb_fifo_init( FIFO_LARGE, FIFO_LARGE_WAKE );
 499
 500     /*
 501      * Audio fifos must be initialized before sync
 502      */
 503     if( !job->indepth_scan )
 504     {
 505     // if we are doing passthru, and the input codec is not the same as the output
 506     // codec, then remove this audio from the job. If we're not doing passthru and
 507     // the input codec is the 'internal' ffmpeg codec, make sure that only one
 508     // audio references that audio stream since the codec context is specific to
 509     // the audio id & multiple copies of the same stream will garble the audio
 510     // or cause aborts.
 511     uint8_t aud_id_uses[MAX_STREAMS];
 512     memset( aud_id_uses, 0, sizeof(aud_id_uses) );
 513     for( i = 0; i < hb_list_count( title->list_audio ); )
 514     {
 515         audio = hb_list_item( title->list_audio, i );
 516         if( ( ( audio->config.out.codec == HB_ACODEC_AC3 ) && ( audio->config.in.codec != HB_ACODEC_AC3 ) ) ||
 517             ( ( audio->config.out.codec == HB_ACODEC_DCA ) && ( audio->config.in.codec != HB_ACODEC_DCA ) ) )
 518         {
 519             hb_log( "Passthru requested and input codec is not the same as output codec for track %d",
 520                     audio->config.out.track );
 521             hb_list_rem( title->list_audio, audio );
 522             free( audio );
 523             continue;
 524         }
 525         if( audio->config.out.codec != HB_ACODEC_AC3 &&
 526             audio->config.out.codec != HB_ACODEC_DCA &&
 527             audio->config.out.samplerate > 48000 )
 528         {
 529             hb_log( "Sample rate %d not supported.  Down-sampling to 48kHz.",
 530                     audio->config.out.samplerate );
 531             audio->config.out.samplerate = 48000;
 532         }
 533         if ( audio->config.in.codec == HB_ACODEC_FFMPEG )
 534         {
 535             if ( aud_id_uses[audio->id] )
 536             {
 537                 hb_log( "Multiple decodes of audio id %d, removing track %d",
 538                         audio->id, audio->config.out.track );
 539                 hb_list_rem( title->list_audio, audio );
 540                 free( audio );
 541                 continue;
 542             }
 543             ++aud_id_uses[audio->id];
 544         }
 545         /* Adjust output track number, in case we removed one.
 546          * Output tracks sadly still need to be in sequential order.
 547          */
 548         audio->config.out.track = i++;
 549     }
 550
 551     int requested_mixdown = 0;
 552     int requested_mixdown_index = 0;
 553
 554     for( i = 0; i < hb_list_count( title->list_audio ); i++ )
 555     {
 556         audio = hb_list_item( title->list_audio, i );
 557
 558         if( audio->config.out.codec != audio->config.in.codec )
 559         {
 560             /* sense-check the current mixdown options */
 561
 562             /* log the requested mixdown */
 563             for (j = 0; j < hb_audio_mixdowns_count; j++) {
 564                 if (hb_audio_mixdowns[j].amixdown == audio->config.out.mixdown) {
 565                     requested_mixdown = audio->config.out.mixdown;
 566                     requested_mixdown_index = j;
 567                 }
 568             }
 569
 570             /* sense-check the requested mixdown */
 571
 572             if( audio->config.out.mixdown == 0 &&
 573                 audio->config.out.codec != HB_ACODEC_AC3 &&
 574                 audio->config.out.codec != HB_ACODEC_DCA )
 575             {
 576                 /*
 577                  * Mixdown wasn't specified and this is not pass-through,
 578                  * set a default mixdown of stereo.
 579                  */
 580                 audio->config.out.mixdown = HB_AMIXDOWN_STEREO;
 581             }
 582
 583             // Here we try to sanitize the audio input to output mapping.
 584             // Constraints are:
 585             //   1. only the AC3 & DCA decoder libraries currently support mixdown
 586             //   2. the lame encoder library only supports stereo.
 587             // So if the encoder is lame we need the output to be stereo (or multichannel
 588             // matrixed into stereo like dpl). If the decoder is not AC3 or DCA the
 589             // encoder has to handle the input format since we can't do a mixdown.
 590             switch (audio->config.in.channel_layout & HB_INPUT_CH_LAYOUT_DISCRETE_NO_LFE_MASK)
 591             {
 592                 // stereo input or something not handled below
 593                 default:
 594                 case HB_INPUT_CH_LAYOUT_STEREO:
 595                     // mono gets mixed up to stereo & more than stereo gets mixed down
 596                     if ( audio->config.out.mixdown > HB_AMIXDOWN_STEREO )
 597                     {
 598                         audio->config.out.mixdown = HB_AMIXDOWN_STEREO;
 599                     }
 600                     break;
 601
 602                 // mono input
 603                 case HB_INPUT_CH_LAYOUT_MONO:
 604                     // everything else passes through
 605                     audio->config.out.mixdown = HB_AMIXDOWN_MONO;
 606                     break;
 607
 608                 // dolby (DPL1 aka Dolby Surround = 4.0 matrix-encoded) input
 609                 // the A52 flags don't allow for a way to distinguish between DPL1 and
 610                 // DPL2 on a DVD so we always assume a DPL1 source for A52_DOLBY.
 611                 case HB_INPUT_CH_LAYOUT_DOLBY:
 612                     if ( audio->config.out.mixdown > HB_AMIXDOWN_DOLBY )
 613                     {
 614                         audio->config.out.mixdown = HB_AMIXDOWN_DOLBY;
 615                     }
 616                     break;
 617
 618                 // 4 channel discrete
 619                 case HB_INPUT_CH_LAYOUT_2F2R:
 620                 case HB_INPUT_CH_LAYOUT_3F1R:
 621                     if ( audio->config.out.mixdown > HB_AMIXDOWN_DOLBY )
 622                     {
 623                         audio->config.out.mixdown = HB_AMIXDOWN_DOLBY;
 624                     }
 625                     break;
 626
 627                 // 5 or 6 channel discrete
 628                 case HB_INPUT_CH_LAYOUT_3F2R:
 629                     if ( ! ( audio->config.in.channel_layout &
 630                                     HB_INPUT_CH_LAYOUT_HAS_LFE ) )
 631                     {
 632                         // we don't do 5 channel discrete so mixdown to DPLII
 633                         audio->config.out.mixdown = HB_AMIXDOWN_DOLBYPLII;
 634                     }
 635                     break;
 636             }
 637
 638             /* log the output mixdown */
 639             for (j = 0; j < hb_audio_mixdowns_count; j++) {
 640                 if (hb_audio_mixdowns[j].amixdown == audio->config.out.mixdown) {
 641                     if ( audio->config.out.mixdown != requested_mixdown )
 642                     {
 643                         hb_log("work: sanitizing track %i mixdown %s to %s", i, hb_audio_mixdowns[requested_mixdown_index].human_readable_name, hb_audio_mixdowns[j].human_readable_name);
 644                     }
 645                     break;
 646                 }
 647             }
 648         }
 649
 650         if (audio->config.out.codec == HB_ACODEC_VORBIS)
 651             audio->priv.config.vorbis.language = audio->config.lang.simple;
 652
 653         /* set up the audio work structures */
 654         audio->priv.fifo_in   = hb_fifo_init( FIFO_LARGE, FIFO_LARGE_WAKE );
 655         audio->priv.fifo_raw  = hb_fifo_init( FIFO_SMALL, FIFO_SMALL_WAKE );
 656         audio->priv.fifo_sync = hb_fifo_init( FIFO_SMALL, FIFO_SMALL_WAKE );
 657         audio->priv.fifo_out  = hb_fifo_init( FIFO_LARGE, FIFO_LARGE_WAKE );
 658     }
 659
 660     }
 661     /* Synchronization */
 662     sync = hb_sync_init( job );
 663
 664     /* Video decoder */
 665     int vcodec = title->video_codec? title->video_codec : WORK_DECMPEG2;
 666     hb_list_add( job->list_work, ( w = hb_get_work( vcodec ) ) );
 667     w->codec_param = title->video_codec_param;
 668     w->fifo_in  = job->fifo_mpeg2;
 669     w->fifo_out = job->fifo_raw;
 670
 671     /* Video renderer */
 672     hb_list_add( job->list_work, ( w = hb_get_work( WORK_RENDER ) ) );
 673     w->fifo_in  = job->fifo_sync;
 674     if( !job->indepth_scan )
 675         w->fifo_out = job->fifo_render;
 676     else
 677         w->fifo_out = NULL;
 678
 679     if( !job->indepth_scan )
 680     {
 681
 682         /* Video encoder */
 683         switch( job->vcodec )
 684         {
 685         case HB_VCODEC_FFMPEG:
 686             w = hb_get_work( WORK_ENCAVCODEC );
 687             break;
 688         case HB_VCODEC_X264:
 689             w = hb_get_work( WORK_ENCX264 );
 690             break;
 691         case HB_VCODEC_THEORA:
 692             w = hb_get_work( WORK_ENCTHEORA );
 693             break;
 694         }
 695         w->fifo_in  = job->fifo_render;
 696         w->fifo_out = job->fifo_mpeg4;
 697         w->config   = &job->config;
 698
 699         hb_list_add( job->list_work, w );
 700     }
 701
 702     /*
 703      * Look for the scanned subtitle in the existing subtitle list
 704      * select_subtitle implies that we did a scan.
 705      */
 706     if ( !job->indepth_scan && interjob->select_subtitle &&
 707          ( job->pass == 0 || job->pass == 2 ) )
 708     {
 709         /*
 710          * Disable forced subtitles if we didn't find any in the scan
 711          * so that we display normal subtitles instead.
 712          */
 713         if( interjob->select_subtitle->config.force &&
 714             interjob->select_subtitle->forced_hits == 0 )
 715         {
 716             interjob->select_subtitle->config.force = 0;
 717         }
 718         for( i=0; i < hb_list_count(title->list_subtitle); i++ )
 719         {
 720             subtitle =  hb_list_item( title->list_subtitle, i );
 721
 722             if( subtitle )
 723             {
 724                 /*
 725                 * Remove the scanned subtitle from the subtitle list if
 726                 * it would result in an identical duplicate subtitle track
 727                 * or an emty track (forced and no forced hits).
 728                 */
 729                 if( ( interjob->select_subtitle->id == subtitle->id ) &&
 730                     ( ( interjob->select_subtitle->forced_hits == 0 &&
 731                         subtitle->config.force ) ||
 732                     ( subtitle->config.force == interjob->select_subtitle->config.force ) ) )
 733                 {
 734                     *subtitle = *(interjob->select_subtitle);
 735                     free( interjob->select_subtitle );
 736                     interjob->select_subtitle = NULL;
 737                     break;
 738                 }
 739             }
 740         }
 741
 742         if( interjob->select_subtitle )
 743         {
 744             /*
 745              * Its not in the existing list
 746              *
 747              * Must be second pass of a two pass with subtitle scan enabled, so
 748              * add the subtitle that we found on the first pass for use in this
 749              * pass.
 750              */
 751             hb_list_add( title->list_subtitle, interjob->select_subtitle );
 752             interjob->select_subtitle = NULL;
 753         }
 754     }
 755
 756
 757     for( i=0; i < hb_list_count(title->list_subtitle); i++ )
 758     {
 759         subtitle =  hb_list_item( title->list_subtitle, i );
 760
 761         if( subtitle )
 762         {
 763             subtitle->fifo_in   = hb_fifo_init( FIFO_SMALL, FIFO_SMALL_WAKE );
 764             subtitle->fifo_raw  = hb_fifo_init( FIFO_SMALL, FIFO_SMALL_WAKE );
 765             subtitle->fifo_sync = hb_fifo_init( FIFO_SMALL, FIFO_SMALL_WAKE );
 766             subtitle->fifo_out  = hb_fifo_init( FIFO_SMALL, FIFO_SMALL_WAKE );
 767
 768             if( (!job->indepth_scan || job->select_subtitle_config.force) &&
 769                 subtitle->source == VOBSUB ) {
 770                 /*
 771                  * Don't add threads for subtitles when we are scanning, unless
 772                  * looking for forced subtitles.
 773                  */
 774                 w = hb_get_work( WORK_DECVOBSUB );
 775                 w->fifo_in  = subtitle->fifo_in;
 776                 w->fifo_out = subtitle->fifo_raw;
 777                 w->subtitle = subtitle;
 778                 hb_list_add( job->list_work, w );
 779             }
 780
 781             if( !job->indepth_scan && subtitle->source == CC608SUB )
 782             {
 783                 w = hb_get_work( WORK_DECCC608 );
 784                 w->fifo_in  = subtitle->fifo_in;
 785                 w->fifo_out = subtitle->fifo_raw;
 786                 hb_list_add( job->list_work, w );
 787             }
 788
 789             if( !job->indepth_scan && subtitle->source == SRTSUB )
 790             {
 791                 w = hb_get_work( WORK_DECSRTSUB );
 792                 w->fifo_in  = subtitle->fifo_in;
 793                 w->fifo_out = subtitle->fifo_raw;
 794                 w->subtitle = subtitle;
 795                 hb_list_add( job->list_work, w );
 796             }
 797
 798             if( !job->indepth_scan && subtitle->source == UTF8SUB )
 799             {
 800                 w = hb_get_work( WORK_DECUTF8SUB );
 801                 w->fifo_in  = subtitle->fifo_in;
 802                 w->fifo_out = subtitle->fifo_raw;
 803                 hb_list_add( job->list_work, w );
 804             }
 805
 806             if( !job->indepth_scan && subtitle->source == TX3GSUB )
 807             {
 808                 w = hb_get_work( WORK_DECTX3GSUB );
 809                 w->fifo_in  = subtitle->fifo_in;
 810                 w->fifo_out = subtitle->fifo_raw;
 811                 hb_list_add( job->list_work, w );
 812             }
 813
 814             if( !job->indepth_scan && subtitle->source == SSASUB )
 815             {
 816                 w = hb_get_work( WORK_DECSSASUB );
 817                 w->fifo_in  = subtitle->fifo_in;
 818                 w->fifo_out = subtitle->fifo_raw;
 819                 w->subtitle = subtitle;
 820                 hb_list_add( job->list_work, w );
 821             }
 822
 823             if( !job->indepth_scan &&
 824                 subtitle->format == PICTURESUB
 825                 && subtitle->config.dest == PASSTHRUSUB )
 826             {
 827                 /*
 828                  * Passing through a subtitle picture, this will have to
 829                  * be rle encoded before muxing.
 830                  */
 831                 w = hb_get_work( WORK_ENCVOBSUB );
 832                 w->fifo_in  = subtitle->fifo_sync;
 833                 w->fifo_out = subtitle->fifo_out;
 834                 w->subtitle = subtitle;
 835                 hb_list_add( job->list_work, w );
 836             }
 837         }
 838     }
 839
 840     if( !job->indepth_scan )
 841     {
 842         for( i = 0; i < hb_list_count( title->list_audio ); i++ )
 843         {
 844             audio = hb_list_item( title->list_audio, i );
 845
 846             /*
 847             * Audio Decoder Thread
 848             */
 849             if ( ( w = hb_codec_decoder( audio->config.in.codec ) ) == NULL )
 850             {
 851                 hb_error("Invalid input codec: %d", audio->config.in.codec);
 852                 *job->die = 1;
 853                 goto cleanup;
 854             }
 855             w->fifo_in  = audio->priv.fifo_in;
 856             w->fifo_out = audio->priv.fifo_raw;
 857             w->config   = &audio->priv.config;
 858             w->audio    = audio;
 859             w->codec_param = audio->config.in.codec_param;
 860
 861             hb_list_add( job->list_work, w );
 862
 863             /*
 864             * Audio Encoder Thread
 865             */
 866             if( audio->config.out.codec != HB_ACODEC_AC3 &&
 867                 audio->config.out.codec != HB_ACODEC_DCA )
 868             {
 869                 /*
 870                 * Add the encoder thread if not doing AC-3 pass through
 871                 */
 872                 if ( ( w = hb_codec_encoder( audio->config.out.codec ) ) == NULL )
 873                 {
 874                     hb_error("Invalid audio codec: %#x", audio->config.out.codec);
 875                     w = NULL;
 876                     *job->die = 1;
 877                     goto cleanup;
 878                 }
 879                 w->fifo_in  = audio->priv.fifo_sync;
 880                 w->fifo_out = audio->priv.fifo_out;
 881                 w->config   = &audio->priv.config;
 882                 w->audio    = audio;
 883
 884                 hb_list_add( job->list_work, w );
 885             }
 886         }
 887     }
 888
 889     if( job->chapter_markers && job->chapter_start == job->chapter_end )
 890     {
 891         job->chapter_markers = 0;
 892         hb_log("work: only 1 chapter, disabling chapter markers");
 893     }
 894
 895     /* Display settings */
 896     hb_display_job_info( job );
 897
 898     /* Init read & write threads */
 899     job->reader = hb_reader_init( job );
 900
 901
 902     job->done = 0;
 903
 904     /* Launch processing threads */
 905     for( i = 0; i < hb_list_count( job->list_work ); i++ )
 906     {
 907         w = hb_list_item( job->list_work, i );
 908         w->done = &job->done;
 909         w->thread_sleep_interval = 10;
 910         if( w->init( w, job ) )
 911         {
 912             hb_error( "Failure to initialise thread '%s'", w->name );
 913             *job->die = 1;
 914             goto cleanup;
 915         }
 916         w->thread = hb_thread_init( w->name, work_loop, w,
 917                                     HB_LOW_PRIORITY );
 918     }
 919
 920     if ( job->indepth_scan )
 921     {
 922         muxer = NULL;
 923         w = sync;
 924         sync->done = &job->done;
 925     }
 926     else
 927     {
 928         sync->done = &job->done;
 929         sync->thread_sleep_interval = 10;
 930         if( sync->init( w, job ) )
 931         {
 932             hb_error( "Failure to initialise thread '%s'", w->name );
 933             *job->die = 1;
 934             goto cleanup;
 935         }
 936         sync->thread = hb_thread_init( sync->name, work_loop, sync,
 937                                     HB_LOW_PRIORITY );
 938
 939         // The muxer requires track information that's set up by the encoder
 940         // init routines so we have to init the muxer last.
 941         muxer = hb_muxer_init( job );
 942         w = muxer;
 943     }
 944
 945     while ( !*job->die && !*w->done && w->status != HB_WORK_DONE )
 946     {
 947         hb_buffer_t      * buf_in, * buf_out;
 948
 949         buf_in = hb_fifo_get_wait( w->fifo_in );
 950         if ( buf_in == NULL )
 951             continue;
 952         if ( *job->die )
 953         {
 954             if( buf_in )
 955             {
 956                 hb_buffer_close( &buf_in );
 957             }
 958             break;
 959         }
 960
 961         buf_out = NULL;
 962         w->status = w->work( w, &buf_in, &buf_out );
 963
 964         if( buf_in )
 965         {
 966             hb_buffer_close( &buf_in );
 967         }
 968         if ( buf_out && w->fifo_out == NULL )
 969         {
 970             hb_buffer_close( &buf_out );
 971         }
 972         if( buf_out )
 973         {
 974             while ( !*job->die )
 975             {
 976                 if ( hb_fifo_full_wait( w->fifo_out ) )
 977                 {
 978                     hb_fifo_push( w->fifo_out, buf_out );
 979                     break;
 980                 }
 981             }
 982         }
 983     }
 984
 985     hb_handle_t * h = job->h;
 986     hb_state_t state;
 987     hb_get_state( h, &state );
 988
 989     hb_log("work: average encoding speed for job is %f fps", state.param.working.rate_avg);
 990
 991     job->done = 1;
 992     if( muxer != NULL )
 993     {
 994         muxer->close( muxer );
 995         free( muxer );
 996
 997         if( sync->thread != NULL )
 998         {
 999             hb_thread_close( &sync->thread );
1000             sync->close( sync );
1001         }
1002         free( sync );
1003     }
1004
1005 cleanup:
1006     /* Stop the write thread (thread_close will block until the muxer finishes) */
1007     job->done = 1;
1008
1009     /* Close work objects */
1010     while( ( w = hb_list_item( job->list_work, 0 ) ) )
1011     {
1012         hb_list_rem( job->list_work, w );
1013         if( w->thread != NULL )
1014         {
1015             hb_thread_close( &w->thread );
1016             w->close( w );
1017         }
1018         free( w );
1019     }
1020
1021     hb_list_close( &job->list_work );
1022
1023     /* Stop the read thread */
1024     if( job->reader != NULL )
1025         hb_thread_close( &job->reader );
1026
1027     /* Close fifos */
1028     hb_fifo_close( &job->fifo_mpeg2 );
1029     hb_fifo_close( &job->fifo_raw );
1030     hb_fifo_close( &job->fifo_sync );
1031     hb_fifo_close( &job->fifo_render );
1032     hb_fifo_close( &job->fifo_mpeg4 );
1033
1034     for (i=0; i < hb_list_count(title->list_subtitle); i++) {
1035         subtitle =  hb_list_item( title->list_subtitle, i);
1036         if( subtitle )
1037         {
1038             hb_fifo_close( &subtitle->fifo_in );
1039             hb_fifo_close( &subtitle->fifo_raw );
1040             hb_fifo_close( &subtitle->fifo_sync );
1041             hb_fifo_close( &subtitle->fifo_out );
1042         }
1043     }
1044     for( i = 0; i < hb_list_count( title->list_audio ); i++ )
1045     {
1046         audio = hb_list_item( title->list_audio, i );
1047         if( audio->priv.fifo_in != NULL )
1048             hb_fifo_close( &audio->priv.fifo_in );
1049         if( audio->priv.fifo_raw != NULL )
1050             hb_fifo_close( &audio->priv.fifo_raw );
1051         if( audio->priv.fifo_sync != NULL )
1052             hb_fifo_close( &audio->priv.fifo_sync );
1053         if( audio->priv.fifo_out != NULL )
1054             hb_fifo_close( &audio->priv.fifo_out );
1055     }
1056
1057     if( job->indepth_scan )
1058     {
1059         /*
1060          * Before closing the title print out our subtitle stats if we need to
1061          * Find the highest and lowest.
1062          */
1063         for( i=0; i < hb_list_count( title->list_subtitle ); i++ )
1064         {
1065             subtitle =  hb_list_item( title->list_subtitle, i );
1066
1067             hb_log( "Subtitle stream 0x%x '%s': %d hits (%d forced)",
1068                     subtitle->id, subtitle->lang, subtitle->hits,
1069                     subtitle->forced_hits );
1070
1071             if( subtitle->hits == 0 )
1072                 continue;
1073
1074             if( subtitle->hits > subtitle_highest )
1075             {
1076                 subtitle_highest = subtitle->hits;
1077                 subtitle_highest_id = subtitle->id;
1078             }
1079
1080             if( subtitle->hits < subtitle_lowest )
1081             {
1082                 subtitle_lowest = subtitle->hits;
1083                 subtitle_lowest_id = subtitle->id;
1084             }
1085
1086             if( subtitle->forced_hits > 0 )
1087             {
1088                 if( subtitle_forced_id == 0 )
1089                 {
1090                     subtitle_forced_id = subtitle->id;
1091                 }
1092             }
1093         }
1094
1095
1096         if( subtitle_forced_id )
1097         {
1098             /*
1099              * If there are any subtitle streams with forced subtitles
1100              * then select it in preference to the lowest.
1101              */
1102             subtitle_hit = subtitle_forced_id;
1103             hb_log("Found a subtitle candidate id 0x%x (contains forced subs)",
1104                    subtitle_hit);
1105         } else if( subtitle_lowest < subtitle_highest )
1106         {
1107             /*
1108              * OK we have more than one, and the lowest is lower,
1109              * but how much lower to qualify for turning it on by
1110              * default?
1111              *
1112              * Let's say 10% as a default.
1113              */
1114             if( subtitle_lowest < ( subtitle_highest * 0.1 ) )
1115             {
1116                 subtitle_hit = subtitle_lowest_id;
1117                 hb_log( "Found a subtitle candidate id 0x%x",
1118                         subtitle_hit );
1119             } else {
1120                 hb_log( "No candidate subtitle detected during subtitle-scan");
1121             }
1122         }
1123     }
1124
1125     if( job->indepth_scan )
1126     {
1127         for( i=0; i < hb_list_count( title->list_subtitle ); i++ )
1128         {
1129             subtitle =  hb_list_item( title->list_subtitle, i );
1130             if( subtitle->id == subtitle_hit )
1131             {
1132                 subtitle->config = job->select_subtitle_config;
1133                 hb_list_rem( title->list_subtitle, subtitle );
1134                 interjob->select_subtitle = subtitle;
1135                 break;
1136             }
1137         }
1138     }
1139
1140     if( job->filters )
1141     {
1142         for( i = 0; i < hb_list_count( job->filters ); i++ )
1143         {
1144             hb_filter_object_t * filter = hb_list_item( job->filters, i );
1145             hb_filter_close( &filter );
1146         }
1147         hb_list_close( &job->filters );
1148     }
1149
1150     hb_buffer_pool_free();
1151
1152     hb_title_close( &job->title );
1153     free( job );
1154 }
1155
1156 /**
1157  * Performs the work object's specific work function.
1158  * Loops calling work function for associated work object. Sleeps when fifo is full.
1159  * Monitors work done indicator.
1160  * Exits loop when work indiactor is set.
1161  * @param _w Handle to work object.
1162  */
1163 static void work_loop( void * _w )
1164 {
1165     hb_work_object_t * w = _w;
1166     hb_buffer_t      * buf_in, * buf_out;
1167
1168     while( !*w->done && w->status != HB_WORK_DONE )
1169     {
1170         buf_in = hb_fifo_get_wait( w->fifo_in );
1171         if ( buf_in == NULL )
1172             continue;
1173         if ( *w->done )
1174         {
1175             if( buf_in )
1176             {
1177                 hb_buffer_close( &buf_in );
1178             }
1179             break;
1180         }
1181
1182         // Invalidate buf_out so that if there is no output
1183         // we don't try to pass along junk.
1184         buf_out = NULL;
1185         w->status = w->work( w, &buf_in, &buf_out );
1186
1187         // Propagate any chapter breaks for the worker if and only if the
1188         // output frame has the same time stamp as the input frame (any
1189         // worker that delays frames has to propagate the chapter marks itself
1190         // and workers that move chapter marks to a different time should set
1191         // 'buf_in' to NULL so that this code won't generate spurious duplicates.)
1192         if( buf_in && buf_out && buf_in->new_chap && buf_in->start == buf_out->start)
1193         {
1194             // restore log below to debug chapter mark propagation problems
1195             //hb_log("work %s: Copying Chapter Break @ %"PRId64, w->name, buf_in->start);
1196             buf_out->new_chap = buf_in->new_chap;
1197         }
1198
1199         if( buf_in )
1200         {
1201             hb_buffer_close( &buf_in );
1202         }
1203         if ( buf_out && w->fifo_out == NULL )
1204         {
1205             hb_buffer_close( &buf_out );
1206         }
1207         if( buf_out )
1208         {
1209             while ( !*w->done )
1210             {
1211                 if ( hb_fifo_full_wait( w->fifo_out ) )
1212                 {
1213                     hb_fifo_push( w->fifo_out, buf_out );
1214                     break;
1215                 }
1216             }
1217         }
1218     }
1219     // Consume data in incoming fifo till job complete so that
1220     // residual data does not stall the pipeline
1221     while( !*w->done )
1222     {
1223         buf_in = hb_fifo_get_wait( w->fifo_in );
1224         if ( buf_in != NULL )
1225             hb_buffer_close( &buf_in );
1226     }
1227 }