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.fr/>.
   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 #if defined( __GNUC__ ) && !(defined( _WIN32 ) || defined( __MINGW32__ ))
  22 #   define HB_WPRINTF(s,v) __attribute__((format(printf,s,v)))
  23 #else
  24 #   define HB_WPRINTF(s,v)
  25 #endif
  26
  27 #if defined( SYS_MINGW )
  28 #   define fseek fseeko64
  29 #   define ftell ftello64
  30 #   undef  fseeko
  31 #   define fseeko fseeko64
  32 #   undef  ftello
  33 #   define ftello ftello64
  34 #   define flockfile(...)
  35 #   define funlockfile(...)
  36 #   define getc_unlocked getc
  37 #   undef  off_t
  38 #   define off_t off64_t
  39 #endif
  40
  41 #ifndef MIN
  42 #define MIN( a, b ) ( (a) > (b) ? (b) : (a) )
  43 #endif
  44 #ifndef MAX
  45 #define MAX( a, b ) ( (a) > (b) ? (a) : (b) )
  46 #endif
  47
  48 #define EVEN( a )        ( (a) + ( (a) & 1 ) )
  49 #define MULTIPLE_16( a ) ( 16 * ( ( (a) + 8 ) / 16 ) )
  50 #define MULTIPLE_MOD( a, b ) ((b==1)?a:( b * ( ( (a) + (b / 2) - 1) / b ) ))
  51 #define MULTIPLE_MOD_DOWN( a, b ) ((b==1)?a:( b * ( (a) / b ) ))
  52
  53 #define HB_DVD_READ_BUFFER_SIZE 2048
  54
  55 typedef struct hb_handle_s hb_handle_t;
  56 typedef struct hb_list_s hb_list_t;
  57 typedef struct hb_rate_s hb_rate_t;
  58 typedef struct hb_mixdown_s hb_mixdown_t;
  59 typedef struct hb_job_s  hb_job_t;
  60 typedef struct hb_title_s hb_title_t;
  61 typedef struct hb_chapter_s hb_chapter_t;
  62 typedef struct hb_audio_s hb_audio_t;
  63 typedef struct hb_audio_config_s hb_audio_config_t;
  64 typedef struct hb_subtitle_s hb_subtitle_t;
  65 typedef struct hb_subtitle_config_s hb_subtitle_config_t;
  66 typedef struct hb_attachment_s hb_attachment_t;
  67 typedef struct hb_metadata_s hb_metadata_t;
  68 typedef struct hb_state_s hb_state_t;
  69 typedef union  hb_esconfig_u     hb_esconfig_t;
  70 typedef struct hb_work_private_s hb_work_private_t;
  71 typedef struct hb_work_object_s  hb_work_object_t;
  72 typedef struct hb_filter_private_s hb_filter_private_t;
  73 typedef struct hb_filter_object_s  hb_filter_object_t;
  74 typedef struct hb_buffer_s hb_buffer_t;
  75 typedef struct hb_fifo_s hb_fifo_t;
  76 typedef struct hb_lock_s hb_lock_t;
  77
  78 #include "ports.h"
  79 #ifdef __LIBHB__
  80 #include "internal.h"
  81 #define PRIVATE
  82 #else
  83 #define PRIVATE const
  84 #endif
  85
  86 hb_list_t * hb_list_init();
  87 int         hb_list_count( hb_list_t * );
  88 void        hb_list_add( hb_list_t *, void * );
  89 void        hb_list_rem( hb_list_t *, void * );
  90 void      * hb_list_item( hb_list_t *, int );
  91 void        hb_list_close( hb_list_t ** );
  92
  93 void hb_reduce( int *x, int *y, int num, int den );
  94
  95 #define HB_KEEP_WIDTH  0
  96 #define HB_KEEP_HEIGHT 1
  97 void hb_fix_aspect( hb_job_t * job, int keep );
  98
  99 int hb_calc_bitrate( hb_job_t *, int size );
 100
 101 hb_audio_t *hb_audio_copy(const hb_audio_t *src);
 102 void hb_audio_config_init(hb_audio_config_t * audiocfg);
 103 int hb_audio_add(const hb_job_t * job, const hb_audio_config_t * audiocfg);
 104 hb_audio_config_t * hb_list_audio_config_item(hb_list_t * list, int i);
 105
 106 hb_subtitle_t *hb_subtitle_copy(const hb_subtitle_t *src);
 107 int hb_subtitle_add(const hb_job_t * job, const hb_subtitle_config_t * subtitlecfg, int track);
 108 int hb_srt_add(const hb_job_t * job, const hb_subtitle_config_t * subtitlecfg,
 109                const char *lang);
 110
 111 hb_attachment_t *hb_attachment_copy(const hb_attachment_t *src);
 112
 113 struct hb_rate_s
 114 {
 115     char * string;
 116     int    rate;
 117 };
 118
 119 struct hb_mixdown_s
 120 {
 121     char * human_readable_name;
 122     char * internal_name;
 123     char * short_name;
 124     int    amixdown;
 125 };
 126
 127 struct hb_subtitle_config_s
 128 {
 129     enum subdest { RENDERSUB, PASSTHRUSUB } dest;
 130     int  force;
 131     int  default_track;
 132
 133     /* SRT subtitle tracks only */
 134     char src_filename[128];
 135     char src_codeset[40];
 136     int64_t offset;
 137 };
 138
 139 #define HB_VIDEO_RATE_BASE   27000000
 140
 141 extern hb_rate_t    hb_video_rates[];
 142 extern int          hb_video_rates_count;
 143 extern hb_rate_t    hb_audio_rates[];
 144 extern int          hb_audio_rates_count;
 145 extern int          hb_audio_rates_default;
 146 extern hb_rate_t    hb_audio_bitrates[];
 147 extern int          hb_audio_bitrates_count;
 148 extern hb_mixdown_t hb_audio_mixdowns[];
 149 extern int          hb_audio_mixdowns_count;
 150 int hb_mixdown_get_mixdown_from_short_name( const char * short_name );
 151 const char * hb_mixdown_get_short_name_from_mixdown( int amixdown );
 152 int hb_get_best_mixdown( uint32_t codec, int layout, int mixdown );
 153 int hb_get_default_mixdown( uint32_t codec, int layout );
 154 int hb_find_closest_audio_bitrate(int bitrate);
 155 void hb_get_audio_bitrate_limits(uint32_t codec, int samplerate, int mixdown, int *low, int *high);
 156 int hb_get_best_audio_bitrate( uint32_t codec, int bitrate, int samplerate, int mixdown);
 157 int hb_get_default_audio_bitrate( uint32_t codec, int samplerate, int mixdown );
 158
 159 /******************************************************************************
 160  * hb_job_t: settings to be filled by the UI
 161  *****************************************************************************/
 162 struct hb_job_s
 163 {
 164     /* ID assigned by UI so it can groups job passes together */
 165     int             sequence_id;
 166
 167     /* Pointer to the title to be ripped */
 168     hb_title_t    * title;
 169     int             feature; // Detected DVD feature title
 170
 171     /* Chapter selection */
 172     int             chapter_start;
 173     int             chapter_end;
 174
 175         /* Include chapter marker track in mp4? */
 176     int             chapter_markers;
 177
 178     /* Picture settings:
 179          crop:                must be multiples of 2 (top/bottom/left/right)
 180          deinterlace:         0 or 1
 181          width:               must be a multiple of 2
 182          height:              must be a multiple of 2
 183          keep_ratio:          used by UIs
 184          grayscale:           black and white encoding
 185          pixel_ratio:         store pixel aspect ratio in the video
 186          pixel_aspect_width:  numerator for pixel aspect ratio
 187          pixel_aspect_height: denominator for pixel aspect ratio
 188          modulus:             set a number for dimensions to be multiples of
 189          maxWidth:            keep width below this
 190          maxHeight:           keep height below this */
 191     int             crop[4];
 192     int             deinterlace;
 193     hb_list_t     * filters;
 194     int             width;
 195     int             height;
 196     int             keep_ratio;
 197     int             grayscale;
 198
 199     struct
 200     {
 201         int             mode;
 202         int             itu_par;
 203         int             par_width;
 204         int             par_height;
 205         int             dar_width;  // 0 if normal
 206         int             dar_height; // 0 if normal
 207         int             keep_display_aspect;
 208     } anamorphic;
 209
 210     int             modulus;
 211     int             maxWidth;
 212     int             maxHeight;
 213
 214     /* Video settings:
 215          vcodec:            output codec
 216          vquality:          output quality (0.0..1.0)
 217                             if < 0.0 or > 1.0, bitrate is used instead,
 218                             except with x264, to use its real QP/RF scale
 219          vbitrate:          output bitrate (kbps)
 220          vrate, vrate_base: output framerate is vrate / vrate_base
 221          cfr:               0 (vfr), 1 (cfr), 2 (pfr) [see render.c]
 222          pass:              0, 1 or 2 (or -1 for scan)
 223          h264_level:        vestigial boolean to decide if we're encoding for iPod
 224          x264opts:          string of extra x264 options
 225          areBframes:        boolean to note if b-frames are included in x264opts */
 226 #define HB_VCODEC_MASK   0x0000FF
 227 #define HB_VCODEC_FFMPEG 0x000001
 228 #define HB_VCODEC_X264   0x000002
 229 #define HB_VCODEC_THEORA 0x000004
 230
 231     int             vcodec;
 232     float           vquality;
 233     int             vbitrate;
 234     int             vrate;
 235     int             vrate_base;
 236     int             vfr;
 237     int             cfr;
 238     int             pass;
 239     int             h264_13;
 240     int             h264_level;
 241     char            *x264opts;
 242     int             areBframes;
 243     int             color_matrix;
 244
 245     /* List of audio settings. */
 246     hb_list_t     * list_audio;
 247
 248     /* Subtitles */
 249     hb_list_t     * list_subtitle;
 250
 251     /* Muxer settings
 252          mux:  output file format
 253          file: file path */
 254 #define HB_MUX_MASK 0xFF0000
 255 #define HB_MUX_MP4  0x010000
 256 #define HB_MUX_PSP  0x020000
 257 #define HB_MUX_AVI  0x040000
 258 #define HB_MUX_OGM  0x080000
 259 #define HB_MUX_IPOD 0x100000
 260 #define HB_MUX_MKV  0x200000
 261
 262     int             mux;
 263     const char          * file;
 264
 265     /* Allow MP4 files > 4 gigs */
 266     int             largeFileSize;
 267     int             mp4_optimize;
 268     int             ipod_atom;
 269
 270     int                     indepth_scan;
 271     hb_subtitle_config_t    select_subtitle_config;
 272
 273     int             angle;              // dvd angle to encode
 274     int             frame_to_start;     // declare eof when we hit this frame
 275     int64_t         pts_to_start;       // drop frames until  we pass this pts
 276                                         //  in the time-linearized input stream
 277     int             frame_to_stop;      // declare eof when we hit this frame
 278     int64_t         pts_to_stop;        // declare eof when we pass this pts in
 279                                         //  the time-linearized input stream
 280     int             start_at_preview;   // if non-zero, encoding will start
 281                                         //  at the position of preview n
 282     int             seek_points;        //  out of N previews
 283     uint32_t        frames_to_skip;     // decode but discard this many frames
 284                                         //  initially (for frame accurate positioning
 285                                         //  to non-I frames).
 286
 287 #ifdef __LIBHB__
 288     /* Internal data */
 289     hb_handle_t   * h;
 290     hb_lock_t     * pause;
 291     volatile int  * die;
 292     volatile int    done;
 293
 294     uint64_t        st_pause_date;
 295     uint64_t        st_paused;
 296
 297     hb_fifo_t     * fifo_mpeg2;   /* MPEG-2 video ES */
 298     hb_fifo_t     * fifo_raw;     /* Raw pictures */
 299     hb_fifo_t     * fifo_sync;    /* Raw pictures, framerate corrected */
 300     hb_fifo_t     * fifo_render;  /* Raw pictures, scaled */
 301     hb_fifo_t     * fifo_mpeg4;   /* MPEG-4 video ES */
 302
 303     hb_thread_t   * reader;
 304
 305     hb_list_t     * list_work;
 306
 307     hb_esconfig_t config;
 308
 309     hb_mux_data_t * mux_data;
 310 #endif
 311 };
 312
 313 /* Audio starts here */
 314 /* Audio Codecs */
 315 #define HB_ACODEC_MASK      0x000FFF00
 316 #define HB_ACODEC_FAAC      0x00000100
 317 #define HB_ACODEC_LAME      0x00000200
 318 #define HB_ACODEC_VORBIS    0x00000400
 319 #define HB_ACODEC_AC3       0x00000800
 320 #define HB_ACODEC_MPGA      0x00001000
 321 #define HB_ACODEC_LPCM      0x00002000
 322 #define HB_ACODEC_DCA       0x00004000
 323 #define HB_ACODEC_FFMPEG    0x00008000
 324 #define HB_ACODEC_CA_AAC    0x00010000
 325 #define HB_ACODEC_PASS_FLAG 0x40000000
 326 #define HB_ACODEC_PASS_MASK (HB_ACODEC_AC3 | HB_ACODEC_DCA)
 327 #define HB_ACODEC_AC3_PASS  (HB_ACODEC_AC3 | HB_ACODEC_PASS_FLAG)
 328 #define HB_ACODEC_DCA_PASS  (HB_ACODEC_DCA | HB_ACODEC_PASS_FLAG)
 329 #define HB_ACODEC_ANY       (HB_ACODEC_MASK | HB_ACODEC_PASS_FLAG)
 330
 331 /* Audio Mixdown */
 332 /* define some masks, used to extract the various information from the HB_AMIXDOWN_XXXX values */
 333 #define HB_AMIXDOWN_DCA_FORMAT_MASK             0x00FFF000
 334 #define HB_AMIXDOWN_A52_FORMAT_MASK             0x00000FF0
 335 #define HB_AMIXDOWN_DISCRETE_CHANNEL_COUNT_MASK 0x0000000F
 336 /* define the HB_AMIXDOWN_XXXX values */
 337 #define HB_AMIXDOWN_MONO                        0x01000001
 338 // DCA_FORMAT of DCA_MONO                  = 0    = 0x000
 339 // A52_FORMAT of A52_MONO                  = 1    = 0x01
 340 // discrete channel count of 1
 341 #define HB_AMIXDOWN_STEREO                      0x02002022
 342 // DCA_FORMAT of DCA_STEREO                = 2    = 0x002
 343 // A52_FORMAT of A52_STEREO                = 2    = 0x02
 344 // discrete channel count of 2
 345 #define HB_AMIXDOWN_DOLBY                       0x042070A2
 346 // DCA_FORMAT of DCA_3F1R | DCA_OUT_DPLI   = 519  = 0x207
 347 // A52_FORMAT of A52_DOLBY                 = 10   = 0x0A
 348 // discrete channel count of 2
 349 #define HB_AMIXDOWN_DOLBYPLII                   0x084094A2
 350 // DCA_FORMAT of DCA_3F2R | DCA_OUT_DPLII  = 1033 = 0x409
 351 // A52_FORMAT of A52_DOLBY | A52_USE_DPLII = 74   = 0x4A
 352 // discrete channel count of 2
 353 #define HB_AMIXDOWN_6CH                         0x10089176
 354 // DCA_FORMAT of DCA_3F2R | DCA_LFE        = 137  = 0x089
 355 // A52_FORMAT of A52_3F2R | A52_LFE        = 23   = 0x17
 356 // discrete channel count of 6
 357 /* define some macros to extract the various information from the HB_AMIXDOWN_XXXX values */
 358 #define HB_AMIXDOWN_GET_DCA_FORMAT( a ) ( ( a & HB_AMIXDOWN_DCA_FORMAT_MASK ) >> 12 )
 359 #define HB_AMIXDOWN_GET_A52_FORMAT( a ) ( ( a & HB_AMIXDOWN_A52_FORMAT_MASK ) >> 4 )
 360 #define HB_AMIXDOWN_GET_DISCRETE_CHANNEL_COUNT( a ) ( ( a & HB_AMIXDOWN_DISCRETE_CHANNEL_COUNT_MASK ) )
 361
 362 /* Input Channel Layout */
 363 /* define some masks, used to extract the various information from the HB_AMIXDOWN_XXXX values */
 364 #define HB_INPUT_CH_LAYOUT_DISCRETE_FRONT_MASK  0x00F0000
 365 #define HB_INPUT_CH_LAYOUT_DISCRETE_REAR_MASK   0x000F000
 366 #define HB_INPUT_CH_LAYOUT_DISCRETE_LFE_MASK    0x0000F00
 367 #define HB_INPUT_CH_LAYOUT_DISCRETE_NO_LFE_MASK 0xFFFF0FF
 368 #define HB_INPUT_CH_LAYOUT_ENCODED_FRONT_MASK   0x00000F0
 369 #define HB_INPUT_CH_LAYOUT_ENCODED_REAR_MASK    0x000000F
 370 /* define the input channel layouts used to describe the channel layout of this audio */
 371 #define HB_INPUT_CH_LAYOUT_MONO    0x0110010
 372 #define HB_INPUT_CH_LAYOUT_STEREO  0x0220020
 373 #define HB_INPUT_CH_LAYOUT_DOLBY   0x0320031
 374 #define HB_INPUT_CH_LAYOUT_3F      0x0430030
 375 #define HB_INPUT_CH_LAYOUT_2F1R    0x0521021
 376 #define HB_INPUT_CH_LAYOUT_3F1R    0x0631031
 377 #define HB_INPUT_CH_LAYOUT_2F2R    0x0722022
 378 #define HB_INPUT_CH_LAYOUT_3F2R    0x0832032
 379 #define HB_INPUT_CH_LAYOUT_4F2R    0x0942042
 380 #define HB_INPUT_CH_LAYOUT_3F4R    0x0a34034
 381 #define HB_INPUT_CH_LAYOUT_HAS_LFE 0x0000100
 382 /* define some macros to extract the various information from the HB_AMIXDOWN_XXXX values */
 383 #define HB_INPUT_CH_LAYOUT_GET_DISCRETE_FRONT_COUNT( a ) ( ( a & HB_INPUT_CH_LAYOUT_DISCRETE_FRONT_MASK ) >> 16 )
 384 #define HB_INPUT_CH_LAYOUT_GET_DISCRETE_REAR_COUNT( a )  ( ( a & HB_INPUT_CH_LAYOUT_DISCRETE_REAR_MASK ) >> 12 )
 385 #define HB_INPUT_CH_LAYOUT_GET_DISCRETE_LFE_COUNT( a )   ( ( a & HB_INPUT_CH_LAYOUT_DISCRETE_LFE_MASK ) >> 8 )
 386 #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 ) )
 387 #define HB_INPUT_CH_LAYOUT_GET_ENCODED_FRONT_COUNT( a )   ( ( a & HB_INPUT_CH_LAYOUT_ENCODED_FRONT_MASK ) >> 4 )
 388 #define HB_INPUT_CH_LAYOUT_GET_ENCODED_REAR_COUNT( a )   ( ( a & HB_INPUT_CH_LAYOUT_ENCODED_REAR_MASK ) )
 389
 390 struct hb_audio_config_s
 391 {
 392     /* Output */
 393     struct
 394     {
 395             int track;      /* Output track number */
 396             uint32_t codec;  /* Output audio codec.
 397                                  * HB_ACODEC_AC3 means pass-through, then bitrate and samplerate
 398                                  * are ignored.
 399                                  */
 400             int samplerate; /* Output sample rate (Hz) */
 401             int bitrate;    /* Output bitrate (kbps) */
 402             int mixdown;    /* The mixdown format to be used for this audio track (see HB_AMIXDOWN_*) */
 403             double dynamic_range_compression; /* Amount of DRC that gets applied to this track */
 404             char * name;    /* Output track name */
 405     } out;
 406
 407     /* Input */
 408     struct
 409     {
 410         int track;                /* Input track number */
 411         PRIVATE uint32_t codec;   /* Input audio codec */
 412         PRIVATE uint32_t stream_type; /* stream type from source stream */
 413         PRIVATE uint32_t codec_param; /* per-codec config info */
 414         PRIVATE uint32_t version; /* Bitsream version */
 415         PRIVATE uint32_t mode;    /* Bitstream mode, codec dependent encoding */
 416         PRIVATE int samplerate; /* Input sample rate (Hz) */
 417         PRIVATE int bitrate;    /* Input bitrate (kbps) */
 418         PRIVATE int channel_layout;
 419         /* channel_layout is the channel layout of this audio this is used to
 420         * provide a common way of describing the source audio
 421         */
 422     } in;
 423
 424     /* Misc. */
 425     union
 426     {
 427         PRIVATE int ac3;    /* flags.ac3 is only set when the source audio format is HB_ACODEC_AC3 */
 428         PRIVATE int dca;    /* flags.dca is only set when the source audio format is HB_ACODEC_DCA */
 429     } flags;
 430 #define AUDIO_F_DOLBY (1 << 31)  /* set if source uses Dolby Surround */
 431
 432     struct
 433     {
 434         PRIVATE char description[1024];
 435         PRIVATE char simple[1024];
 436         PRIVATE char iso639_2[4];
 437         PRIVATE uint8_t type; /* normal, visually impared, directors */
 438     } lang;
 439 };
 440
 441 #ifdef __LIBHB__
 442 struct hb_audio_s
 443 {
 444     int id;
 445
 446     hb_audio_config_t config;
 447
 448     struct {
 449         hb_fifo_t * fifo_in;   /* AC3/MPEG/LPCM ES */
 450         hb_fifo_t * fifo_raw;  /* Raw audio */
 451         hb_fifo_t * fifo_sync; /* Resampled, synced raw audio */
 452         hb_fifo_t * fifo_out;  /* MP3/AAC/Vorbis ES */
 453
 454         hb_esconfig_t config;
 455         hb_mux_data_t * mux_data;
 456         hb_fifo_t     * scan_cache;
 457     } priv;
 458 };
 459 #endif
 460
 461 struct hb_chapter_s
 462 {
 463     int      index;
 464     int      pgcn;
 465     int      pgn;
 466     int      cell_start;
 467     int      cell_end;
 468     uint64_t block_start;
 469     uint64_t block_end;
 470     uint64_t block_count;
 471
 472     /* Visual-friendly duration */
 473     int      hours;
 474     int      minutes;
 475     int      seconds;
 476
 477     /* Exact duration (in 1/90000s) */
 478     uint64_t duration;
 479
 480     /* Optional chapter title */
 481     char     title[1024];
 482 };
 483
 484 /*
 485  * A subtitle track.
 486  *
 487  * Required fields when a demuxer creates a subtitle track are:
 488  * > id
 489  *     - ID of this track
 490  *     - must be unique for all tracks within a single job,
 491  *       since it is used to look up the appropriate in-FIFO with GetFifoForId()
 492  * > format
 493  *     - format of the packets the subtitle decoder work-object sends to sub->fifo_raw
 494  *     - for passthru subtitles, is also the format of the final packets sent to sub->fifo_out
 495  *     - PICTURESUB for banded 8-bit YAUV pixels; see decvobsub.c documentation for more info
 496  *     - TEXTSUB for UTF-8 text marked up with <b>, <i>, or <u>
 497  *     - read by the muxers, and by the subtitle burn-in logic in the hb_sync_video work-object
 498  * > source
 499  *     - used to create the appropriate subtitle decoder work-object in do_job()
 500  * > config.dest
 501  *     - whether to render the subtitle on the video track (RENDERSUB) or
 502  *       to pass it through its own subtitle track in the output container (PASSTHRUSUB)
 503  *     - all newly created non-VOBSUB tracks should default to PASSTHRUSUB
 504  *     - all newly created VOBSUB tracks should default to RENDERSUB, for legacy compatibility
 505  * > lang
 506  *     - user-readable description of the subtitle track
 507  *     - may correspond to the language of the track (see the 'iso639_2' field)
 508  *     - may correspond to the type of track (see the 'type' field; ex: "Closed Captions")
 509  * > iso639_2
 510  *     - language code for the subtitle, or "und" if unknown
 511  */
 512 struct hb_subtitle_s
 513 {
 514     int  id;
 515     int  track;
 516
 517     hb_subtitle_config_t config;
 518
 519     enum subtype { PICTURESUB, TEXTSUB } format;
 520     enum subsource { VOBSUB, SRTSUB, CC608SUB, /*unused*/CC708SUB, UTF8SUB, TX3GSUB, SSASUB } source;
 521     char lang[1024];
 522     char iso639_2[4];
 523     uint8_t type; /* Closed Caption, Childrens, Directors etc */
 524
 525     // Color lookup table for VOB subtitle tracks. Each entry is in YCbCr format.
 526     // Must be filled out by the demuxer for VOB subtitle tracks.
 527     uint32_t    palette[16];
 528     int         width;
 529     int         height;
 530
 531     // Codec private data for subtitles originating from FFMPEG sources
 532     uint8_t *   extradata;
 533     int         extradata_size;
 534
 535     int hits;     /* How many hits/occurrences of this subtitle */
 536     int forced_hits; /* How many forced hits in this subtitle */
 537
 538 #ifdef __LIBHB__
 539     /* Internal data */
 540     hb_fifo_t * fifo_in;  /* SPU ES */
 541     hb_fifo_t * fifo_raw; /* Decoded SPU */
 542     hb_fifo_t * fifo_sync;/* Synced */
 543     hb_fifo_t * fifo_out; /* Correct Timestamps, ready to be muxed */
 544     hb_mux_data_t * mux_data;
 545 #endif
 546 };
 547
 548 /*
 549  * An attachment.
 550  *
 551  * These are usually used for attaching embedded fonts to movies containing SSA subtitles.
 552  */
 553 struct hb_attachment_s
 554 {
 555     enum attachtype { FONT_TTF_ATTACH } type;
 556     char *  name;
 557     char *  data;
 558     int     size;
 559 };
 560
 561 struct hb_metadata_s
 562 {
 563     char  name[255];
 564     char  artist[255];
 565     char  composer[255];
 566     char  release_date[255];
 567     char  comment[1024];
 568     char  album[255];
 569     char  genre[255];
 570     uint32_t coverart_size;
 571     uint8_t *coverart;
 572 };
 573
 574 struct hb_title_s
 575 {
 576     enum { HB_DVD_TYPE, HB_BD_TYPE, HB_STREAM_TYPE } type;
 577     uint32_t    reg_desc;
 578     char        path[1024];
 579     char        name[1024];
 580     int         index;
 581     int         vts;
 582     int         ttn;
 583     int         cell_start;
 584     int         cell_end;
 585     uint64_t    block_start;
 586     uint64_t    block_end;
 587     uint64_t    block_count;
 588     int         angle_count;
 589
 590     /* Visual-friendly duration */
 591     int         hours;
 592     int         minutes;
 593     int         seconds;
 594
 595     /* Exact duration (in 1/90000s) */
 596     uint64_t    duration;
 597
 598     double      aspect;             // aspect ratio for the title's video
 599     double      container_aspect;   // aspect ratio from container (0 if none)
 600     int         width;
 601     int         height;
 602     int         pixel_aspect_width;
 603     int         pixel_aspect_height;
 604     int         rate;
 605     int         rate_base;
 606     int         crop[4];
 607     enum { HB_MPEG2_PS_DEMUXER = 0, HB_MPEG2_TS_DEMUXER, HB_NULL_DEMUXER } demuxer;
 608     int         detected_interlacing;
 609     int         pcr_pid;                /* PCR PID for TS streams */
 610     int         video_id;               /* demuxer stream id for video */
 611     int         video_codec;            /* worker object id of video codec */
 612     uint32_t    video_stream_type;      /* stream type from source stream */
 613     int         video_codec_param;      /* codec specific config */
 614     const char  *video_codec_name;
 615     int         video_bitrate;
 616     const char  *container_name;
 617     int         data_rate;
 618
 619     hb_metadata_t *metadata;
 620
 621     hb_list_t * list_chapter;
 622     hb_list_t * list_audio;
 623     hb_list_t * list_subtitle;
 624     hb_list_t * list_attachment;
 625
 626     /* Job template for this title */
 627     hb_job_t  * job;
 628
 629     uint32_t    flags;
 630                 // set if video stream doesn't have IDR frames
 631 #define         HBTF_NO_IDR (1 << 0)
 632 };
 633
 634
 635 struct hb_state_s
 636 {
 637 #define HB_STATE_IDLE     1
 638 #define HB_STATE_SCANNING 2
 639 #define HB_STATE_SCANDONE 4
 640 #define HB_STATE_WORKING  8
 641 #define HB_STATE_PAUSED   16
 642 #define HB_STATE_WORKDONE 32
 643 #define HB_STATE_MUXING   64
 644 #define HB_STATE_SEARCHING 128
 645     int state;
 646
 647     union
 648     {
 649         struct
 650         {
 651             /* HB_STATE_SCANNING */
 652             int title_cur;
 653             int title_count;
 654         } scanning;
 655
 656         struct
 657         {
 658             /* HB_STATE_WORKING */
 659             float progress;
 660             int   job_cur;
 661             int   job_count;
 662             float rate_cur;
 663             float rate_avg;
 664             int   hours;
 665             int   minutes;
 666             int   seconds;
 667             int   sequence_id;
 668         } working;
 669
 670         struct
 671         {
 672             /* HB_STATE_WORKDONE */
 673 #define HB_ERROR_NONE     0
 674 #define HB_ERROR_CANCELED 1
 675 #define HB_ERROR_UNKNOWN  2
 676             int error;
 677         } workdone;
 678
 679         struct
 680         {
 681             /* HB_STATE_MUXING */
 682             float progress;
 683         } muxing;
 684     } param;
 685 };
 686
 687 typedef struct hb_work_info_s
 688 {
 689     const char *name;
 690     int     profile;
 691     int     level;
 692     int     bitrate;
 693     int     rate;
 694     int     rate_base;
 695     int     flags;
 696     int     version;
 697     int     mode;
 698     union {
 699         struct {    // info only valid for video decoders
 700             int     width;
 701             int     height;
 702             int     pixel_aspect_width;
 703             int     pixel_aspect_height;
 704             double  aspect;
 705         };
 706         struct {    // info only valid for audio decoders
 707             int     channel_layout;
 708         };
 709     };
 710 } hb_work_info_t;
 711
 712 struct hb_work_object_s
 713 {
 714     int                 id;
 715     char              * name;
 716
 717 #ifdef __LIBHB__
 718     int              (* init)  ( hb_work_object_t *, hb_job_t * );
 719     int              (* work)  ( hb_work_object_t *, hb_buffer_t **,
 720                                  hb_buffer_t ** );
 721     void             (* close) ( hb_work_object_t * );
 722     /* the info entry point is used by scan to get bitstream information
 723      * during a decode (i.e., it should only be called after at least one
 724      * call to the 'work' entry point). currently it's only called for
 725      * video streams & can be null for other work objects. */
 726     int              (* info)  ( hb_work_object_t *, hb_work_info_t * );
 727     /* the bitstream info entry point is used by scan to get bitstream
 728      * information from a buffer. it doesn't have to be called during a
 729      * decode (it can be called even if init & work haven't been).
 730      * currently it's only called for audio streams & can be null for
 731      * other work objects. */
 732     int              (* bsinfo)  ( hb_work_object_t *, const hb_buffer_t *,
 733                                    hb_work_info_t * );
 734
 735     hb_fifo_t         * fifo_in;
 736     hb_fifo_t         * fifo_out;
 737     hb_esconfig_t     * config;
 738
 739     /* Pointer hb_audio_t so we have access to the info in the audio worker threads. */
 740     hb_audio_t        * audio;
 741
 742     /* Pointer hb_subtitle_t so we have access to the info in the subtitle worker threads. */
 743     hb_subtitle_t     * subtitle;
 744
 745     hb_work_private_t * private_data;
 746
 747     hb_thread_t       * thread;
 748     volatile int      * done;
 749     int                 status;
 750     int                 codec_param;
 751     hb_title_t        * title;
 752
 753     hb_work_object_t  * next;
 754     int                 thread_sleep_interval;
 755 #endif
 756 };
 757
 758 extern hb_work_object_t hb_sync_video;
 759 extern hb_work_object_t hb_sync_audio;
 760 extern hb_work_object_t hb_decmpeg2;
 761 extern hb_work_object_t hb_decvobsub;
 762 extern hb_work_object_t hb_encvobsub;
 763 extern hb_work_object_t hb_deccc608;
 764 extern hb_work_object_t hb_decsrtsub;
 765 extern hb_work_object_t hb_decutf8sub;
 766 extern hb_work_object_t hb_dectx3gsub;
 767 extern hb_work_object_t hb_decssasub;
 768 extern hb_work_object_t hb_render;
 769 extern hb_work_object_t hb_encavcodec;
 770 extern hb_work_object_t hb_encx264;
 771 extern hb_work_object_t hb_enctheora;
 772 extern hb_work_object_t hb_deca52;
 773 extern hb_work_object_t hb_decdca;
 774 extern hb_work_object_t hb_decavcodec;
 775 extern hb_work_object_t hb_decavcodecv;
 776 extern hb_work_object_t hb_decavcodecvi;
 777 extern hb_work_object_t hb_decavcodecai;
 778 extern hb_work_object_t hb_declpcm;
 779 extern hb_work_object_t hb_encfaac;
 780 extern hb_work_object_t hb_enclame;
 781 extern hb_work_object_t hb_encvorbis;
 782 extern hb_work_object_t hb_muxer;
 783 extern hb_work_object_t hb_encca_aac;
 784 extern hb_work_object_t hb_encac3;
 785
 786 #define FILTER_OK      0
 787 #define FILTER_DELAY   1
 788 #define FILTER_FAILED  2
 789 #define FILTER_DROP    3
 790
 791 struct hb_filter_object_s
 792 {
 793     int                     id;
 794     char                  * name;
 795     char                  * settings;
 796
 797 #ifdef __LIBHB__
 798     hb_filter_private_t* (* init)  ( int, int, int, char * );
 799
 800     int                  (* work)  ( const hb_buffer_t *, hb_buffer_t **,
 801                                      int, int, int, hb_filter_private_t * );
 802
 803     void                 (* close) ( hb_filter_private_t * );
 804
 805     hb_filter_private_t   * private_data;
 806     //hb_buffer_t           * buffer;
 807 #endif
 808 };
 809
 810 #define HB_FILTER_DETELECINE    1
 811 #define HB_FILTER_DEINTERLACE   2
 812 #define HB_FILTER_DEBLOCK       3
 813 #define HB_FILTER_DENOISE       4
 814 #define HB_FILTER_DECOMB        5
 815 #define HB_FILTER_ROTATE        6
 816
 817 extern hb_filter_object_t hb_filter_detelecine;
 818 extern hb_filter_object_t hb_filter_deinterlace;
 819 extern hb_filter_object_t hb_filter_deblock;
 820 extern hb_filter_object_t hb_filter_denoise;
 821 extern hb_filter_object_t hb_filter_decomb;
 822 extern hb_filter_object_t hb_filter_rotate;
 823
 824 typedef void hb_error_handler_t( const char *errmsg );
 825
 826 extern void hb_register_error_handler( hb_error_handler_t * handler );
 827
 828 char * hb_strdup_printf( char * fmt, ... );
 829
 830 int hb_yuv2rgb(int yuv);
 831 int hb_rgb2yuv(int rgb);
 832
 833 const char * hb_subsource_name( int source );
 834
 835 #endif