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