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