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