libhb/common.h

   1 /* $Id: common.h,v 1.51 2005/11/04 13:09:40 titer Exp $
   2
   3    This file is part of the HandBrake source code.
   4    Homepage: <http://handbrake.m0k.org/>.
   5    It may be used under the terms of the GNU General Public License. */
   6
   7 #ifndef HB_COMMON_H
   8 #define HB_COMMON_H
   9
  10 #include <math.h>
  11 #include <stdio.h>
  12 #include <stdlib.h>
  13 #include <stdarg.h>
  14 #include <string.h>
  15 #include <unistd.h>
  16 #include <inttypes.h>
  17 #include <sys/types.h>
  18 #include <sys/stat.h>
  19 #include <dirent.h>
  20
  21 #ifndef MIN
  22 #define MIN( a, b ) ( (a) > (b) ? (b) : (a) )
  23 #endif
  24 #ifndef MAX
  25 #define MAX( a, b ) ( (a) > (b) ? (a) : (b) )
  26 #endif
  27
  28 #define EVEN( a )        ( (a) + ( (a) & 1 ) )
  29 #define MULTIPLE_16( a ) ( 16 * ( ( (a) + 8 ) / 16 ) )
  30
  31 typedef struct hb_handle_s hb_handle_t;
  32 typedef struct hb_list_s hb_list_t;
  33 typedef struct hb_rate_s hb_rate_t;
  34 typedef struct hb_mixdown_s hb_mixdown_t;
  35 typedef struct hb_job_s  hb_job_t;
  36 typedef struct hb_title_s hb_title_t;
  37 typedef struct hb_chapter_s hb_chapter_t;
  38 typedef struct hb_audio_s hb_audio_t;
  39 typedef struct hb_subtitle_s hb_subtitle_t;
  40 typedef struct hb_state_s hb_state_t;
  41 typedef union  hb_esconfig_u     hb_esconfig_t;
  42 typedef struct hb_work_private_s hb_work_private_t;
  43 typedef struct hb_work_object_s  hb_work_object_t;
  44 typedef struct hb_buffer_s hb_buffer_t;
  45 typedef struct hb_fifo_s hb_fifo_t;
  46 typedef struct hb_lock_s hb_lock_t;
  47
  48 #include "ports.h"
  49 #ifdef __LIBHB__
  50 #include "internal.h"
  51 #endif
  52
  53 hb_list_t * hb_list_init();
  54 int         hb_list_count( hb_list_t * );
  55 void        hb_list_add( hb_list_t *, void * );
  56 void        hb_list_rem( hb_list_t *, void * );
  57 void      * hb_list_item( hb_list_t *, int );
  58 void        hb_list_close( hb_list_t ** );
  59
  60 void hb_reduce( int *x, int *y, int num, int den );
  61
  62 #define HB_KEEP_WIDTH  0
  63 #define HB_KEEP_HEIGHT 1
  64 void hb_fix_aspect( hb_job_t * job, int keep );
  65
  66 int hb_calc_bitrate( hb_job_t *, int size );
  67
  68 struct hb_rate_s
  69 {
  70     char * string;
  71     int    rate;
  72 };
  73
  74 struct hb_mixdown_s
  75 {
  76     char * human_readable_name;
  77     char * internal_name;
  78     char * short_name;
  79     int    amixdown;
  80 };
  81
  82 #define HB_ASPECT_BASE 9
  83 #define HB_VIDEO_RATE_BASE   27000000
  84
  85 extern hb_rate_t    hb_video_rates[];
  86 extern int          hb_video_rates_count;
  87 extern hb_rate_t    hb_audio_rates[];
  88 extern int          hb_audio_rates_count;
  89 extern int          hb_audio_rates_default;
  90 extern hb_rate_t    hb_audio_bitrates[];
  91 extern int          hb_audio_bitrates_count;
  92 extern int          hb_audio_bitrates_default;
  93 extern hb_mixdown_t hb_audio_mixdowns[];
  94 extern int          hb_audio_mixdowns_count;
  95 int hb_mixdown_get_mixdown_from_short_name( const char * short_name );
  96 const char * hb_mixdown_get_short_name_from_mixdown( int amixdown );
  97
  98 /******************************************************************************
  99  * hb_job_t: settings to be filled by the UI
 100  *****************************************************************************/
 101 struct hb_job_s
 102 {
 103     /* Pointer to the title to be ripped */
 104     hb_title_t    * title;
 105
 106     /* Chapter selection */
 107     int             chapter_start;
 108     int             chapter_end;
 109
 110         /* Include chapter marker track in mp4? */
 111     int             chapter_markers;
 112
 113     /* Picture settings:
 114          crop:                must be multiples of 2 (top/bottom/left/right)
 115          deinterlace:         0 or 1
 116          width:               must be a multiple of 16
 117          height:              must be a multiple of 16
 118          keep_ratio:          used by UIs
 119          pixel_ratio:         store pixel aspect ratio in the video
 120          pixel_aspect_width:  numerator for pixel aspect ratio
 121          pixel_aspect_height: denominator for pixel aspect ratio
 122                  maxWidth:                        keep width below this
 123                  maxHeight:                       keep height below this */
 124
 125     int             crop[4];
 126     int             deinterlace;
 127     int             width;
 128     int             height;
 129     int             keep_ratio;
 130     int             grayscale;
 131     int             pixel_ratio;
 132     int             pixel_aspect_width;
 133     int             pixel_aspect_height;
 134         int                             maxWidth;
 135         int                             maxHeight;
 136
 137
 138     /* Video settings:
 139          vcodec:            output codec
 140          vquality:          output quality (0.0..1.0)
 141                             if < 0.0 or > 1.0, bitrate is used instead
 142          vbitrate:          output bitrate (kbps)
 143          pass:              0, 1 or 2
 144          vrate, vrate_base: output framerate is vrate / vrate_base
 145          h264_level:        boolean for whether or not we're encoding for iPod
 146          crf:               boolean for whether to use constant rate factor with x264
 147          x264opts:          string of extra x264 options
 148          areBframes:        boolean to note if b-frames are included in x264opts */
 149 #define HB_VCODEC_MASK   0x0000FF
 150 #define HB_VCODEC_FFMPEG 0x000001
 151 #define HB_VCODEC_XVID   0x000002
 152 #define HB_VCODEC_X264   0x000004
 153
 154     int             vcodec;
 155     float           vquality;
 156     int             vbitrate;
 157     int             vrate;
 158     int             vrate_base;
 159     int             pass;
 160     int             h264_13;
 161     int             h264_level;
 162     int             crf;
 163     char            *x264opts;
 164     int             areBframes;
 165
 166     /* Audio tracks:
 167          audios:          Indexes in hb_title_t's audios list, starting from 0.
 168                           -1 indicates the end of the list
 169         audio_mixdowns:  The mixdown to be used for each audio track in audios[] */
 170
 171 /* define some masks, used to extract the various information from the HB_AMIXDOWN_XXXX values */
 172 #define HB_AMIXDOWN_DCA_FORMAT_MASK             0x00FFF000
 173 #define HB_AMIXDOWN_A52_FORMAT_MASK             0x00000FF0
 174 #define HB_AMIXDOWN_DISCRETE_CHANNEL_COUNT_MASK 0x0000000F
 175
 176 /* define the HB_AMIXDOWN_XXXX values */
 177
 178 #define HB_AMIXDOWN_MONO                        0x01000001
 179 // DCA_FORMAT of DCA_MONO                  = 0    = 0x000
 180 // A52_FORMAT of A52_MONO                  = 1    = 0x01
 181 // discrete channel count of 1
 182
 183 #define HB_AMIXDOWN_STEREO                      0x02002022
 184 // DCA_FORMAT of DCA_STEREO                = 2    = 0x002
 185 // A52_FORMAT of A52_STEREO                = 2    = 0x02
 186 // discrete channel count of 2
 187
 188 #define HB_AMIXDOWN_DOLBY                       0x042070A2
 189 // DCA_FORMAT of DCA_3F1R | DCA_OUT_DPLI   = 519  = 0x207
 190 // A52_FORMAT of A52_DOLBY                 = 10   = 0x0A
 191 // discrete channel count of 2
 192
 193 #define HB_AMIXDOWN_DOLBYPLII                   0x084094A2
 194 // DCA_FORMAT of DCA_3F2R | DCA_OUT_DPLII  = 1033 = 0x409
 195 // A52_FORMAT of A52_DOLBY | A52_USE_DPLII = 74   = 0x4A
 196 // discrete channel count of 2
 197
 198 #define HB_AMIXDOWN_6CH                         0x10089176
 199 // DCA_FORMAT of DCA_3F2R | DCA_LFE        = 137  = 0x089
 200 // A52_FORMAT of A52_3F2R | A52_LFE        = 23   = 0x17
 201 // discrete channel count of 6
 202
 203 /* define some macros to extract the various information from the HB_AMIXDOWN_XXXX values */
 204 #define HB_AMIXDOWN_GET_DCA_FORMAT( a ) ( ( a & HB_AMIXDOWN_DCA_FORMAT_MASK ) >> 12 )
 205 #define HB_AMIXDOWN_GET_A52_FORMAT( a ) ( ( a & HB_AMIXDOWN_A52_FORMAT_MASK ) >> 4 )
 206 #define HB_AMIXDOWN_GET_DISCRETE_CHANNEL_COUNT( a ) ( ( a & HB_AMIXDOWN_DISCRETE_CHANNEL_COUNT_MASK ) )
 207
 208     int             audios[8];
 209         int             audio_mixdowns[8];
 210
 211     /* Audio settings:
 212          acodec:   output codec
 213          abitrate: output bitrate (kbps)
 214          arate:    output samplerate (Hz)
 215        HB_ACODEC_AC3 means pass-through, then abitrate and arate are
 216        ignored */
 217 #define HB_ACODEC_MASK   0x00FF00
 218 #define HB_ACODEC_FAAC   0x000100
 219 #define HB_ACODEC_LAME   0x000200
 220 #define HB_ACODEC_VORBIS 0x000400
 221 #define HB_ACODEC_AC3    0x000800
 222 #define HB_ACODEC_MPGA   0x001000
 223 #define HB_ACODEC_LPCM   0x002000
 224 #define HB_ACODEC_DCA    0x004000
 225     int             acodec;
 226     int             abitrate;
 227     int             arate;
 228
 229     /* Subtitle settings:
 230          subtitle: index in hb_title_t's subtitles list, starting
 231          from 0. -1 means no subtitle */
 232     int             subtitle;
 233     int                         subtitleSmartAdjust;
 234
 235     /* Muxer settings
 236          mux:  output file format
 237          file: file path */
 238 #define HB_MUX_MASK 0xFF0000
 239 #define HB_MUX_MP4  0x010000
 240 #define HB_MUX_PSP  0x020000
 241 #define HB_MUX_AVI  0x040000
 242 #define HB_MUX_OGM  0x080000
 243 #define HB_MUX_IPOD 0x100000
 244
 245     int             mux;
 246     const char          * file;
 247
 248     /* Allow MP4 files > 4 gigs */
 249     int             largeFileSize;
 250
 251
 252     int subtitle_scan;
 253     hb_subtitle_t ** select_subtitle;
 254     char * native_language;
 255
 256 #ifdef __LIBHB__
 257     /* Internal data */
 258     hb_handle_t   * h;
 259     hb_lock_t     * pause;
 260     volatile int  * die;
 261     volatile int    done;
 262
 263     hb_fifo_t     * fifo_mpeg2;   /* MPEG-2 video ES */
 264     hb_fifo_t     * fifo_raw;     /* Raw pictures */
 265     hb_fifo_t     * fifo_sync;    /* Raw pictures, framerate corrected */
 266     hb_fifo_t     * fifo_render;  /* Raw pictures, scaled */
 267     hb_fifo_t     * fifo_mpeg4;   /* MPEG-4 video ES */
 268
 269     hb_thread_t   * reader;
 270     hb_thread_t   * muxer;
 271
 272     hb_list_t     * list_work;
 273
 274     hb_esconfig_t config;
 275
 276     hb_mux_data_t * mux_data;
 277 #endif
 278 };
 279
 280 struct hb_audio_s
 281 {
 282     int  id;
 283     char lang[1024];
 284     char lang_simple[1024];
 285     char iso639_2[4];
 286     int  codec;
 287     int  rate;
 288     int  bitrate;
 289
 290     /* ac3flags is only set when the source audio format is HB_ACODEC_AC3 */
 291     int ac3flags;
 292
 293     /* dcaflags is only set when the source audio format is HB_ACODEC_DCA */
 294     int dcaflags;
 295
 296 /* define some masks, used to extract the various information from the HB_AMIXDOWN_XXXX values */
 297 #define HB_INPUT_CH_LAYOUT_DISCRETE_FRONT_MASK  0x00F0000
 298 #define HB_INPUT_CH_LAYOUT_DISCRETE_REAR_MASK   0x000F000
 299 #define HB_INPUT_CH_LAYOUT_DISCRETE_LFE_MASK    0x0000F00
 300 #define HB_INPUT_CH_LAYOUT_DISCRETE_NO_LFE_MASK 0xFFFF0FF
 301 #define HB_INPUT_CH_LAYOUT_ENCODED_FRONT_MASK   0x00000F0
 302 #define HB_INPUT_CH_LAYOUT_ENCODED_REAR_MASK    0x000000F
 303
 304 /* define the input channel layouts used to describe the channel layout of this audio */
 305 #define HB_INPUT_CH_LAYOUT_MONO    0x0110010
 306 #define HB_INPUT_CH_LAYOUT_STEREO  0x0220020
 307 #define HB_INPUT_CH_LAYOUT_DOLBY   0x0320031
 308 #define HB_INPUT_CH_LAYOUT_3F      0x0430030
 309 #define HB_INPUT_CH_LAYOUT_2F1R    0x0521021
 310 #define HB_INPUT_CH_LAYOUT_3F1R    0x0631031
 311 #define HB_INPUT_CH_LAYOUT_2F2R    0x0722022
 312 #define HB_INPUT_CH_LAYOUT_3F2R    0x0832032
 313 #define HB_INPUT_CH_LAYOUT_4F2R    0x0942042
 314 #define HB_INPUT_CH_LAYOUT_HAS_LFE 0x0000100
 315
 316 /* define some macros to extract the various information from the HB_AMIXDOWN_XXXX values */
 317 #define HB_INPUT_CH_LAYOUT_GET_DISCRETE_FRONT_COUNT( a ) ( ( a & HB_INPUT_CH_LAYOUT_DISCRETE_FRONT_MASK ) >> 16 )
 318 #define HB_INPUT_CH_LAYOUT_GET_DISCRETE_REAR_COUNT( a )  ( ( a & HB_INPUT_CH_LAYOUT_DISCRETE_REAR_MASK ) >> 12 )
 319 #define HB_INPUT_CH_LAYOUT_GET_DISCRETE_LFE_COUNT( a )   ( ( a & HB_INPUT_CH_LAYOUT_DISCRETE_LFE_MASK ) >> 8 )
 320 #define HB_INPUT_CH_LAYOUT_GET_DISCRETE_COUNT( a ) ( ( ( a & HB_INPUT_CH_LAYOUT_DISCRETE_FRONT_MASK ) >> 16 ) + ( ( a & HB_INPUT_CH_LAYOUT_DISCRETE_REAR_MASK ) >> 12 ) + ( ( a & HB_INPUT_CH_LAYOUT_DISCRETE_LFE_MASK ) >> 8 ) )
 321 #define HB_INPUT_CH_LAYOUT_GET_ENCODED_FRONT_COUNT( a )   ( ( a & HB_INPUT_CH_LAYOUT_ENCODED_FRONT_MASK ) >> 4 )
 322 #define HB_INPUT_CH_LAYOUT_GET_ENCODED_REAR_COUNT( a )   ( ( a & HB_INPUT_CH_LAYOUT_ENCODED_REAR_MASK ) )
 323
 324         /* input_channel_layout is the channel layout of this audio */
 325         /* this is used to provide a common way of describing the source audio */
 326         int input_channel_layout;
 327
 328 #ifdef __LIBHB__
 329     /* Internal data */
 330     hb_fifo_t * fifo_in;   /* AC3/MPEG/LPCM ES */
 331     hb_fifo_t * fifo_raw;  /* Raw audio */
 332     hb_fifo_t * fifo_sync; /* Resampled, synced raw audio */
 333     hb_fifo_t * fifo_out;  /* MP3/AAC/Vorbis ES */
 334
 335     hb_esconfig_t config;
 336     hb_mux_data_t * mux_data;
 337
 338         /* amixdown is the mixdown format to be used for this audio track */
 339         int amixdown;
 340
 341 #endif
 342 };
 343
 344 struct hb_chapter_s
 345 {
 346     int      index;
 347     int      cell_start;
 348     int      cell_end;
 349     int      block_start;
 350     int      block_end;
 351     int      block_count;
 352
 353     /* Visual-friendly duration */
 354     int      hours;
 355     int      minutes;
 356     int      seconds;
 357
 358     /* Exact duration (in 1/90000s) */
 359     uint64_t duration;
 360
 361     /* Optional chapter title */
 362     char     title[1024];
 363 };
 364
 365 struct hb_subtitle_s
 366 {
 367     int  id;
 368     char lang[1024];
 369     char iso639_2[4];
 370
 371     int hits;     /* How many hits/occurrences of this subtitle */
 372
 373 #ifdef __LIBHB__
 374     /* Internal data */
 375     hb_fifo_t * fifo_in;  /* SPU ES */
 376     hb_fifo_t * fifo_raw; /* Decodec SPU */
 377 #endif
 378 };
 379
 380 struct hb_title_s
 381 {
 382     char        dvd[1024];
 383     char        name[1024];
 384     int         index;
 385     int         vts;
 386     int         ttn;
 387     int         cell_start;
 388     int         cell_end;
 389     int         block_start;
 390     int         block_end;
 391     int         block_count;
 392
 393     /* Visual-friendly duration */
 394     int         hours;
 395     int         minutes;
 396     int         seconds;
 397
 398     /* Exact duration (in 1/90000s) */
 399     uint64_t    duration;
 400
 401     int         width;
 402     int         height;
 403     int         aspect;
 404     int         rate;
 405     int         rate_base;
 406     int         crop[4];
 407
 408     uint32_t    palette[16];
 409
 410     hb_list_t * list_chapter;
 411     hb_list_t * list_audio;
 412     hb_list_t * list_subtitle;
 413
 414     /* Job template for this title */
 415     hb_job_t  * job;
 416 };
 417
 418
 419 struct hb_state_s
 420 {
 421 #define HB_STATE_IDLE     1
 422 #define HB_STATE_SCANNING 2
 423 #define HB_STATE_SCANDONE 4
 424 #define HB_STATE_WORKING  8
 425 #define HB_STATE_PAUSED   16
 426 #define HB_STATE_WORKDONE 32
 427 #define HB_STATE_MUXING   64
 428     int state;
 429
 430     union
 431     {
 432         struct
 433         {
 434             /* HB_STATE_SCANNING */
 435             int title_cur;
 436             int title_count;
 437         } scanning;
 438
 439         struct
 440         {
 441             /* HB_STATE_WORKING */
 442             float progress;
 443             int   job_cur;
 444             int   job_count;
 445             float rate_cur;
 446             float rate_avg;
 447             int   hours;
 448             int   minutes;
 449             int   seconds;
 450         } working;
 451
 452         struct
 453         {
 454             /* HB_STATE_WORKDONE */
 455 #define HB_ERROR_NONE     0
 456 #define HB_ERROR_CANCELED 1
 457 #define HB_ERROR_UNKNOWN  2
 458             int error;
 459         } workdone;
 460
 461         struct
 462         {
 463             /* HB_STATE_MUXING */
 464             float progress;
 465         } muxing;
 466     } param;
 467 };
 468
 469 struct hb_work_object_s
 470 {
 471     int                 id;
 472     char              * name;
 473
 474 #ifdef __LIBHB__
 475     int              (* init)  ( hb_work_object_t *, hb_job_t * );
 476     int              (* work)  ( hb_work_object_t *, hb_buffer_t **,
 477                                  hb_buffer_t ** );
 478     void             (* close) ( hb_work_object_t * );
 479
 480     hb_fifo_t         * fifo_in;
 481     hb_fifo_t         * fifo_out;
 482     hb_esconfig_t     * config;
 483
 484         /* amixdown is the mixdown format to be used if the work object is an audio track */
 485         int               amixdown;
 486     /* source_acodec is the source audio codec if the work object is an audio track */
 487     int               source_acodec;
 488
 489     hb_work_private_t * private_data;
 490
 491     hb_thread_t       * thread;
 492     volatile int      * done;
 493
 494     hb_work_object_t  * next;
 495         int                               thread_sleep_interval;
 496 #endif
 497 };
 498
 499 extern hb_work_object_t hb_sync;
 500 extern hb_work_object_t hb_decmpeg2;
 501 extern hb_work_object_t hb_decsub;
 502 extern hb_work_object_t hb_render;
 503 extern hb_work_object_t hb_encavcodec;
 504 extern hb_work_object_t hb_encxvid;
 505 extern hb_work_object_t hb_encx264;
 506 extern hb_work_object_t hb_deca52;
 507 extern hb_work_object_t hb_decdca;
 508 extern hb_work_object_t hb_decavcodec;
 509 extern hb_work_object_t hb_declpcm;
 510 extern hb_work_object_t hb_encfaac;
 511 extern hb_work_object_t hb_enclame;
 512 extern hb_work_object_t hb_encvorbis;
 513
 514 #endif