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