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