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 #define HB_VCODEC_THEORA 0x000008
 164
 165     int             vcodec;
 166     float           vquality;
 167     int             vbitrate;
 168     int             vrate;
 169     int             vrate_base;
 170     int             pass;
 171     int             h264_13;
 172     int             h264_level;
 173     int             crf;
 174     char            *x264opts;
 175     int             areBframes;
 176     int             vfr;
 177
 178     /* Audio tracks:
 179          audios:          Indexes in hb_title_t's audios list, starting from 0.
 180                           -1 indicates the end of the list
 181         audio_mixdowns:  The mixdown to be used for each audio track in audios[] */
 182
 183 /* define some masks, used to extract the various information from the HB_AMIXDOWN_XXXX values */
 184 #define HB_AMIXDOWN_DCA_FORMAT_MASK             0x00FFF000
 185 #define HB_AMIXDOWN_A52_FORMAT_MASK             0x00000FF0
 186 #define HB_AMIXDOWN_DISCRETE_CHANNEL_COUNT_MASK 0x0000000F
 187
 188 /* define the HB_AMIXDOWN_XXXX values */
 189
 190 #define HB_AMIXDOWN_MONO                        0x01000001
 191 // DCA_FORMAT of DCA_MONO                  = 0    = 0x000
 192 // A52_FORMAT of A52_MONO                  = 1    = 0x01
 193 // discrete channel count of 1
 194
 195 #define HB_AMIXDOWN_STEREO                      0x02002022
 196 // DCA_FORMAT of DCA_STEREO                = 2    = 0x002
 197 // A52_FORMAT of A52_STEREO                = 2    = 0x02
 198 // discrete channel count of 2
 199
 200 #define HB_AMIXDOWN_DOLBY                       0x042070A2
 201 // DCA_FORMAT of DCA_3F1R | DCA_OUT_DPLI   = 519  = 0x207
 202 // A52_FORMAT of A52_DOLBY                 = 10   = 0x0A
 203 // discrete channel count of 2
 204
 205 #define HB_AMIXDOWN_DOLBYPLII                   0x084094A2
 206 // DCA_FORMAT of DCA_3F2R | DCA_OUT_DPLII  = 1033 = 0x409
 207 // A52_FORMAT of A52_DOLBY | A52_USE_DPLII = 74   = 0x4A
 208 // discrete channel count of 2
 209
 210 #define HB_AMIXDOWN_6CH                         0x10089176
 211 // DCA_FORMAT of DCA_3F2R | DCA_LFE        = 137  = 0x089
 212 // A52_FORMAT of A52_3F2R | A52_LFE        = 23   = 0x17
 213 // discrete channel count of 6
 214
 215 #define HB_AMIXDOWN_AC3                         0x20000000
 216
 217 #define HB_AMIXDOWN_DOLBYPLII_AC3               0x404094A2
 218 // DCA_FORMAT of DCA_3F2R | DCA_OUT_DPLII  = 1033 = 0x409
 219 // A52_FORMAT of A52_DOLBY | A52_USE_DPLII = 74   = 0x4A
 220 // discrete channel count of 2
 221
 222 /* define some macros to extract the various information from the HB_AMIXDOWN_XXXX values */
 223 #define HB_AMIXDOWN_GET_DCA_FORMAT( a ) ( ( a & HB_AMIXDOWN_DCA_FORMAT_MASK ) >> 12 )
 224 #define HB_AMIXDOWN_GET_A52_FORMAT( a ) ( ( a & HB_AMIXDOWN_A52_FORMAT_MASK ) >> 4 )
 225 #define HB_AMIXDOWN_GET_DISCRETE_CHANNEL_COUNT( a ) ( ( a & HB_AMIXDOWN_DISCRETE_CHANNEL_COUNT_MASK ) )
 226
 227     int             audios[8];
 228         int             audio_mixdowns[8];
 229
 230     /* Audio settings:
 231          acodec:   output codec
 232          abitrate: output bitrate (kbps)
 233          arate:    output samplerate (Hz)
 234        HB_ACODEC_AC3 means pass-through, then abitrate and arate are
 235        ignored */
 236 #define HB_ACODEC_MASK   0x00FF00
 237 #define HB_ACODEC_FAAC   0x000100
 238 #define HB_ACODEC_LAME   0x000200
 239 #define HB_ACODEC_VORBIS 0x000400
 240 #define HB_ACODEC_AC3    0x000800
 241 #define HB_ACODEC_MPGA   0x001000
 242 #define HB_ACODEC_LPCM   0x002000
 243 #define HB_ACODEC_DCA    0x004000
 244     int             acodec;
 245     int             abitrate;
 246     int             arate;
 247     float           dynamic_range_compression;
 248
 249     /* Subtitle settings:
 250          subtitle: index in hb_title_t's subtitles list, starting
 251          from 0. -1 means no subtitle */
 252     int             subtitle;
 253     int                         subtitleSmartAdjust;
 254
 255     /* Muxer settings
 256          mux:  output file format
 257          file: file path */
 258 #define HB_MUX_MASK 0xFF0000
 259 #define HB_MUX_MP4  0x010000
 260 #define HB_MUX_PSP  0x020000
 261 #define HB_MUX_AVI  0x040000
 262 #define HB_MUX_OGM  0x080000
 263 #define HB_MUX_IPOD 0x100000
 264 #define HB_MUX_MKV  0x200000
 265
 266     int             mux;
 267     const char          * file;
 268
 269     /* Allow MP4 files > 4 gigs */
 270     int             largeFileSize;
 271     int             mp4_optimize;
 272     int             ipod_atom;
 273
 274     int indepth_scan;
 275     hb_subtitle_t ** select_subtitle;
 276     int subtitle_force;
 277     char * native_language;
 278
 279 #ifdef __LIBHB__
 280     /* Internal data */
 281     hb_handle_t   * h;
 282     hb_lock_t     * pause;
 283     volatile int  * die;
 284     volatile int    done;
 285
 286     hb_fifo_t     * fifo_mpeg2;   /* MPEG-2 video ES */
 287     hb_fifo_t     * fifo_raw;     /* Raw pictures */
 288     hb_fifo_t     * fifo_sync;    /* Raw pictures, framerate corrected */
 289     hb_fifo_t     * fifo_render;  /* Raw pictures, scaled */
 290     hb_fifo_t     * fifo_mpeg4;   /* MPEG-4 video ES */
 291
 292     hb_thread_t   * reader;
 293     hb_thread_t   * muxer;
 294
 295     hb_list_t     * list_work;
 296
 297     hb_esconfig_t config;
 298
 299     hb_mux_data_t * mux_data;
 300 #endif
 301 };
 302
 303 struct hb_audio_s
 304 {
 305     int  id;
 306     char lang[1024];
 307     char lang_simple[1024];
 308     char iso639_2[4];
 309     int  codec;
 310     int  rate;
 311     int  bitrate;
 312
 313     /* ac3flags is only set when the source audio format is HB_ACODEC_AC3 */
 314     int ac3flags;
 315
 316     /* dcaflags is only set when the source audio format is HB_ACODEC_DCA */
 317     int dcaflags;
 318
 319 /* define some masks, used to extract the various information from the HB_AMIXDOWN_XXXX values */
 320 #define HB_INPUT_CH_LAYOUT_DISCRETE_FRONT_MASK  0x00F0000
 321 #define HB_INPUT_CH_LAYOUT_DISCRETE_REAR_MASK   0x000F000
 322 #define HB_INPUT_CH_LAYOUT_DISCRETE_LFE_MASK    0x0000F00
 323 #define HB_INPUT_CH_LAYOUT_DISCRETE_NO_LFE_MASK 0xFFFF0FF
 324 #define HB_INPUT_CH_LAYOUT_ENCODED_FRONT_MASK   0x00000F0
 325 #define HB_INPUT_CH_LAYOUT_ENCODED_REAR_MASK    0x000000F
 326
 327 /* define the input channel layouts used to describe the channel layout of this audio */
 328 #define HB_INPUT_CH_LAYOUT_MONO    0x0110010
 329 #define HB_INPUT_CH_LAYOUT_STEREO  0x0220020
 330 #define HB_INPUT_CH_LAYOUT_DOLBY   0x0320031
 331 #define HB_INPUT_CH_LAYOUT_3F      0x0430030
 332 #define HB_INPUT_CH_LAYOUT_2F1R    0x0521021
 333 #define HB_INPUT_CH_LAYOUT_3F1R    0x0631031
 334 #define HB_INPUT_CH_LAYOUT_2F2R    0x0722022
 335 #define HB_INPUT_CH_LAYOUT_3F2R    0x0832032
 336 #define HB_INPUT_CH_LAYOUT_4F2R    0x0942042
 337 #define HB_INPUT_CH_LAYOUT_HAS_LFE 0x0000100
 338
 339 /* define some macros to extract the various information from the HB_AMIXDOWN_XXXX values */
 340 #define HB_INPUT_CH_LAYOUT_GET_DISCRETE_FRONT_COUNT( a ) ( ( a & HB_INPUT_CH_LAYOUT_DISCRETE_FRONT_MASK ) >> 16 )
 341 #define HB_INPUT_CH_LAYOUT_GET_DISCRETE_REAR_COUNT( a )  ( ( a & HB_INPUT_CH_LAYOUT_DISCRETE_REAR_MASK ) >> 12 )
 342 #define HB_INPUT_CH_LAYOUT_GET_DISCRETE_LFE_COUNT( a )   ( ( a & HB_INPUT_CH_LAYOUT_DISCRETE_LFE_MASK ) >> 8 )
 343 #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 ) )
 344 #define HB_INPUT_CH_LAYOUT_GET_ENCODED_FRONT_COUNT( a )   ( ( a & HB_INPUT_CH_LAYOUT_ENCODED_FRONT_MASK ) >> 4 )
 345 #define HB_INPUT_CH_LAYOUT_GET_ENCODED_REAR_COUNT( a )   ( ( a & HB_INPUT_CH_LAYOUT_ENCODED_REAR_MASK ) )
 346
 347         /* input_channel_layout is the channel layout of this audio */
 348         /* this is used to provide a common way of describing the source audio */
 349         int input_channel_layout;
 350
 351 #ifdef __LIBHB__
 352     /* Internal data */
 353     hb_fifo_t * fifo_in;   /* AC3/MPEG/LPCM ES */
 354     hb_fifo_t * fifo_raw;  /* Raw audio */
 355     hb_fifo_t * fifo_sync; /* Resampled, synced raw audio */
 356     hb_fifo_t * fifo_out;  /* MP3/AAC/Vorbis ES */
 357
 358     hb_esconfig_t config;
 359     hb_mux_data_t * mux_data;
 360
 361         /* amixdown is the mixdown format to be used for this audio track */
 362         int amixdown;
 363 #endif
 364 };
 365
 366 struct hb_chapter_s
 367 {
 368     int      index;
 369     int      cell_start;
 370     int      cell_end;
 371     int      block_start;
 372     int      block_end;
 373     int      block_count;
 374
 375     /* Visual-friendly duration */
 376     int      hours;
 377     int      minutes;
 378     int      seconds;
 379
 380     /* Exact duration (in 1/90000s) */
 381     uint64_t duration;
 382
 383     /* Optional chapter title */
 384     char     title[1024];
 385 };
 386
 387 struct hb_subtitle_s
 388 {
 389     int  id;
 390     char lang[1024];
 391     char iso639_2[4];
 392
 393     int hits;     /* How many hits/occurrences of this subtitle */
 394     int forced_hits; /* How many forced hits in this subtitle */
 395
 396 #ifdef __LIBHB__
 397     /* Internal data */
 398     hb_fifo_t * fifo_in;  /* SPU ES */
 399     hb_fifo_t * fifo_raw; /* Decodec SPU */
 400 #endif
 401 };
 402
 403 struct hb_title_s
 404 {
 405     char        dvd[1024];
 406     char        name[1024];
 407     int         index;
 408     int         vts;
 409     int         ttn;
 410     int         cell_start;
 411     int         cell_end;
 412     int         block_start;
 413     int         block_end;
 414     int         block_count;
 415
 416     /* Visual-friendly duration */
 417     int         hours;
 418     int         minutes;
 419     int         seconds;
 420
 421     /* Exact duration (in 1/90000s) */
 422     uint64_t    duration;
 423
 424     int         width;
 425     int         height;
 426     int         aspect;
 427     int         rate;
 428     int         rate_base;
 429     int         crop[4];
 430
 431     uint32_t    palette[16];
 432
 433     hb_list_t * list_chapter;
 434     hb_list_t * list_audio;
 435     hb_list_t * list_subtitle;
 436
 437     /* Job template for this title */
 438     hb_job_t  * job;
 439 };
 440
 441
 442 struct hb_state_s
 443 {
 444 #define HB_STATE_IDLE     1
 445 #define HB_STATE_SCANNING 2
 446 #define HB_STATE_SCANDONE 4
 447 #define HB_STATE_WORKING  8
 448 #define HB_STATE_PAUSED   16
 449 #define HB_STATE_WORKDONE 32
 450 #define HB_STATE_MUXING   64
 451     int state;
 452
 453     union
 454     {
 455         struct
 456         {
 457             /* HB_STATE_SCANNING */
 458             int title_cur;
 459             int title_count;
 460         } scanning;
 461
 462         struct
 463         {
 464             /* HB_STATE_WORKING */
 465             float progress;
 466             int   job_cur;
 467             int   job_count;
 468             float rate_cur;
 469             float rate_avg;
 470             int   hours;
 471             int   minutes;
 472             int   seconds;
 473             int   sequence_id;
 474         } working;
 475
 476         struct
 477         {
 478             /* HB_STATE_WORKDONE */
 479 #define HB_ERROR_NONE     0
 480 #define HB_ERROR_CANCELED 1
 481 #define HB_ERROR_UNKNOWN  2
 482             int error;
 483         } workdone;
 484
 485         struct
 486         {
 487             /* HB_STATE_MUXING */
 488             float progress;
 489         } muxing;
 490     } param;
 491 };
 492
 493 struct hb_work_object_s
 494 {
 495     int                 id;
 496     char              * name;
 497
 498 #ifdef __LIBHB__
 499     int              (* init)  ( hb_work_object_t *, hb_job_t * );
 500     int              (* work)  ( hb_work_object_t *, hb_buffer_t **,
 501                                  hb_buffer_t ** );
 502     void             (* close) ( hb_work_object_t * );
 503
 504     hb_fifo_t         * fifo_in;
 505     hb_fifo_t         * fifo_out;
 506     hb_esconfig_t     * config;
 507
 508         /* amixdown is the mixdown format to be used if the work object is an audio track */
 509         int               amixdown;
 510     /* source_acodec is the source audio codec if the work object is an audio track */
 511     int               source_acodec;
 512
 513     hb_work_private_t * private_data;
 514
 515     hb_thread_t       * thread;
 516     volatile int      * done;
 517
 518     hb_work_object_t  * next;
 519         int                               thread_sleep_interval;
 520 #endif
 521 };
 522
 523 extern hb_work_object_t hb_sync;
 524 extern hb_work_object_t hb_decmpeg2;
 525 extern hb_work_object_t hb_decsub;
 526 extern hb_work_object_t hb_render;
 527 extern hb_work_object_t hb_encavcodec;
 528 extern hb_work_object_t hb_encxvid;
 529 extern hb_work_object_t hb_encx264;
 530 extern hb_work_object_t hb_enctheora;
 531 extern hb_work_object_t hb_deca52;
 532 extern hb_work_object_t hb_decdca;
 533 extern hb_work_object_t hb_decavcodec;
 534 extern hb_work_object_t hb_declpcm;
 535 extern hb_work_object_t hb_encfaac;
 536 extern hb_work_object_t hb_enclame;
 537 extern hb_work_object_t hb_encvorbis;
 538
 539 #define FILTER_OK      0
 540 #define FILTER_DELAY   1
 541 #define FILTER_FAILED  2
 542 #define FILTER_DROP    3
 543
 544 struct hb_filter_object_s
 545 {
 546     int                     id;
 547     char                  * name;
 548     char                  * settings;
 549
 550 #ifdef __LIBHB__
 551     hb_filter_private_t* (* init)  ( int, int, int, char * );
 552
 553     int                  (* work)  ( const hb_buffer_t *, hb_buffer_t **,
 554                                      int, int, int, hb_filter_private_t * );
 555
 556     void                 (* close) ( hb_filter_private_t * );
 557
 558     hb_filter_private_t   * private_data;
 559     //hb_buffer_t           * buffer;
 560 #endif
 561 };
 562
 563 extern hb_filter_object_t hb_filter_detelecine;
 564 extern hb_filter_object_t hb_filter_deinterlace;
 565 extern hb_filter_object_t hb_filter_deblock;
 566 extern hb_filter_object_t hb_filter_denoise;
 567
 568 typedef void hb_error_handler_t( const char *errmsg );
 569
 570 extern void hb_register_error_handler( hb_error_handler_t * handler );
 571
 572 #endif