libhb/internal.h

   1 /* $Id: internal.h,v 1.41 2005/11/25 15:05:25 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 /***********************************************************************
   8  * common.c
   9  **********************************************************************/
  10 void hb_log( char * log, ... ) HB_WPRINTF(1,2);
  11 extern int global_verbosity_level; // Global variable for hb_deep_log
  12 typedef enum hb_debug_level_s
  13 {
  14     HB_SUPPORT_LOG      = 1, // helpful in tech support
  15     HB_HOUSEKEEPING_LOG = 2, // stuff we hate scrolling through
  16     HB_GRANULAR_LOG     = 3  // sample-by-sample
  17 } hb_debug_level_t;
  18 void hb_deep_log( hb_debug_level_t level, char * log, ... ) HB_WPRINTF(2,3);
  19 void hb_error( char * fmt, ...) HB_WPRINTF(1,2);
  20
  21 int  hb_list_bytes( hb_list_t * );
  22 void hb_list_seebytes( hb_list_t * l, uint8_t * dst, int size );
  23 void hb_list_getbytes( hb_list_t * l, uint8_t * dst, int size,
  24                        uint64_t * pts, uint64_t * pos );
  25 void hb_list_empty( hb_list_t ** );
  26
  27 hb_title_t * hb_title_init( char * dvd, int index );
  28 void         hb_title_close( hb_title_t ** );
  29
  30 void         hb_filter_close( hb_filter_object_t ** );
  31
  32 /***********************************************************************
  33  * hb.c
  34  **********************************************************************/
  35 int  hb_get_pid( hb_handle_t * );
  36 void hb_set_state( hb_handle_t *, hb_state_t * );
  37
  38 /***********************************************************************
  39  * fifo.c
  40  **********************************************************************/
  41 /*
  42  * Holds a packet of data that is moving through the transcoding process.
  43  *
  44  * May have metadata associated with it via extra fields
  45  * that are conditionally used depending on the type of packet.
  46  */
  47 struct hb_buffer_s
  48 {
  49     int           size;     // size of this packet
  50     int           alloc;    // used internally by the packet allocator (hb_buffer_init)
  51     uint8_t *     data;     // packet data
  52     int           cur;      // used internally by packet lists (hb_list_t)
  53
  54     /*
  55      * Corresponds to the order that this packet was read from the demuxer.
  56      *
  57      * It is important that video decoder work-objects pass this value through
  58      * from their input packets to the output packets they generate. Otherwise
  59      * RENDERSUB subtitles (especially VOB subtitles) will break.
  60      *
  61      * Subtitle decoder work-objects that output a renderable subtitle
  62      * format (ex: PICTURESUB) must also be careful to pass the sequence number
  63      * through for the same reason.
  64      */
  65     int64_t       sequence;
  66
  67     enum { AUDIO_BUF, VIDEO_BUF, SUBTITLE_BUF, OTHER_BUF } type;
  68
  69     int           id;           // ID of the track that the packet comes from
  70     int64_t       start;        // Video and subtitle packets: start time of frame/subtitle
  71     int64_t       stop;         // Video and subtitle packets: stop time of frame/subtitle
  72     int           new_chap;     // Video packets: if non-zero, is the index of the chapter whose boundary was crossed
  73
  74 #define HB_FRAME_IDR    0x01
  75 #define HB_FRAME_I      0x02
  76 #define HB_FRAME_AUDIO  0x04
  77 #define HB_FRAME_P      0x10
  78 #define HB_FRAME_B      0x20
  79 #define HB_FRAME_BREF   0x40
  80 #define HB_FRAME_KEY    0x0F
  81 #define HB_FRAME_REF    0xF0
  82     uint8_t       frametype;
  83     uint16_t       flags;
  84
  85     /* Holds the output PTS from x264, for use by b-frame offsets in muxmp4.c */
  86     int64_t     renderOffset;
  87
  88     // VOB subtitle packets:
  89     //   Location and size of the subpicture.
  90     int           x;
  91     int           y;
  92     int           width;
  93     int           height;
  94
  95     // Video packets (after processing by the hb_sync_video work-object):
  96     //   A (copy of a) VOB subtitle packet that needs to be burned into this video packet by the hb_render work-object.
  97     //   Subtitles that are simply passed thru are NOT attached to the associated video packets.
  98     hb_buffer_t * sub;
  99
 100     // Packets in a list:
 101     //   the next packet in the list
 102     hb_buffer_t * next;
 103 };
 104
 105 void hb_buffer_pool_init( void );
 106 void hb_buffer_pool_free( void );
 107
 108 hb_buffer_t * hb_buffer_init( int size );
 109 void          hb_buffer_realloc( hb_buffer_t *, int size );
 110 void          hb_buffer_close( hb_buffer_t ** );
 111 void          hb_buffer_copy_settings( hb_buffer_t * dst,
 112                                        const hb_buffer_t * src );
 113
 114 hb_fifo_t   * hb_fifo_init( int capacity, int thresh );
 115 int           hb_fifo_size( hb_fifo_t * );
 116 int           hb_fifo_size_bytes( hb_fifo_t * );
 117 int           hb_fifo_is_full( hb_fifo_t * );
 118 float         hb_fifo_percent_full( hb_fifo_t * f );
 119 hb_buffer_t * hb_fifo_get( hb_fifo_t * );
 120 hb_buffer_t * hb_fifo_get_wait( hb_fifo_t * );
 121 hb_buffer_t * hb_fifo_see( hb_fifo_t * );
 122 hb_buffer_t * hb_fifo_see_wait( hb_fifo_t * );
 123 hb_buffer_t * hb_fifo_see2( hb_fifo_t * );
 124 void          hb_fifo_push( hb_fifo_t *, hb_buffer_t * );
 125 void          hb_fifo_push_wait( hb_fifo_t *, hb_buffer_t * );
 126 int           hb_fifo_full_wait( hb_fifo_t * f );
 127 void          hb_fifo_push_head( hb_fifo_t *, hb_buffer_t * );
 128 void          hb_fifo_close( hb_fifo_t ** );
 129 void          hb_fifo_flush( hb_fifo_t * f );
 130
 131 // this routine gets a buffer for an uncompressed YUV420 video frame
 132 // with dimensions width x height.
 133 static inline hb_buffer_t * hb_video_buffer_init( int width, int height )
 134 {
 135     // Y requires w x h bytes. U & V each require (w+1)/2 x
 136     // (h+1)/2 bytes (the "+1" is to round up). We shift rather
 137     // than divide by 2 since the compiler can't know these ints
 138     // are positive so it generates very expensive integer divides
 139     // if we do "/2". The code here matches the calculation for
 140     // PIX_FMT_YUV420P in ffmpeg's avpicture_fill() which is required
 141     // for most of HB's filters to work right.
 142     return hb_buffer_init( width * height + ( ( width+1 ) >> 1 ) *
 143                            ( ( height+1 ) >> 1 ) * 2 );
 144 }
 145
 146 // this routine 'moves' data from src to dst by interchanging 'data',
 147 // 'size' & 'alloc' between them and copying the rest of the fields
 148 // from src to dst.
 149 static inline void hb_buffer_swap_copy( hb_buffer_t *src, hb_buffer_t *dst )
 150 {
 151     uint8_t *data  = dst->data;
 152     int      size  = dst->size;
 153     int      alloc = dst->alloc;
 154
 155     *dst = *src;
 156
 157     src->data  = data;
 158     src->size  = size;
 159     src->alloc = alloc;
 160 }
 161
 162 /***********************************************************************
 163  * Threads: update.c, scan.c, work.c, reader.c, muxcommon.c
 164  **********************************************************************/
 165 hb_thread_t * hb_update_init( int * build, char * version );
 166 hb_thread_t * hb_scan_init( hb_handle_t *, volatile int * die,
 167                             const char * path, int title_index,
 168                             hb_list_t * list_title, int preview_count,
 169                             int store_previews, uint64_t min_duration );
 170 hb_thread_t * hb_work_init( hb_list_t * jobs, int cpu_count,
 171                             volatile int * die, int * error, hb_job_t ** job );
 172 hb_thread_t  * hb_reader_init( hb_job_t * );
 173 hb_work_object_t * hb_muxer_init( hb_job_t * );
 174 hb_work_object_t * hb_get_work( int );
 175 hb_work_object_t * hb_codec_decoder( int );
 176 hb_work_object_t * hb_codec_encoder( int );
 177
 178 /***********************************************************************
 179  * sync.c
 180  **********************************************************************/
 181 hb_work_object_t * hb_sync_init( hb_job_t * job );
 182
 183 /***********************************************************************
 184  * mpegdemux.c
 185  **********************************************************************/
 186 typedef struct {
 187     int64_t last_scr;       /* unadjusted SCR from most recent pack */
 188     int64_t last_pts;       /* last pts we saw */
 189     int     scr_changes;    /* number of SCR discontinuities */
 190     int     dts_drops;      /* number of drops because DTS too far from SCR */
 191 } hb_psdemux_t;
 192
 193 typedef int (*hb_muxer_t)(hb_buffer_t *, hb_list_t *, hb_psdemux_t*);
 194
 195 int hb_demux_ps( hb_buffer_t * ps_buf, hb_list_t * es_list, hb_psdemux_t * );
 196 int hb_demux_ss( hb_buffer_t * ps_buf, hb_list_t * es_list, hb_psdemux_t * );
 197 int hb_demux_null( hb_buffer_t * ps_buf, hb_list_t * es_list, hb_psdemux_t * );
 198
 199 extern const hb_muxer_t hb_demux[];
 200
 201 /***********************************************************************
 202  * decmetadata.c
 203  **********************************************************************/
 204 extern void decmetadata( hb_title_t *title );
 205
 206 /***********************************************************************
 207  * batch.c
 208  **********************************************************************/
 209 typedef struct hb_batch_s hb_batch_t;
 210
 211 hb_batch_t  * hb_batch_init( char * path );
 212 void          hb_batch_close( hb_batch_t ** _d );
 213 int           hb_batch_title_count( hb_batch_t * d );
 214 hb_title_t  * hb_batch_title_scan( hb_batch_t * d, int t );
 215
 216 /***********************************************************************
 217  * dvd.c
 218  **********************************************************************/
 219 typedef struct hb_bd_s hb_bd_t;
 220 typedef union  hb_dvd_s hb_dvd_t;
 221 typedef struct hb_stream_s hb_stream_t;
 222
 223 hb_dvd_t *   hb_dvd_init( char * path );
 224 int          hb_dvd_title_count( hb_dvd_t * );
 225 hb_title_t * hb_dvd_title_scan( hb_dvd_t *, int title, uint64_t min_duration );
 226 int          hb_dvd_start( hb_dvd_t *, hb_title_t *title, int chapter );
 227 void         hb_dvd_stop( hb_dvd_t * );
 228 int          hb_dvd_seek( hb_dvd_t *, float );
 229 int          hb_dvd_read( hb_dvd_t *, hb_buffer_t * );
 230 int          hb_dvd_chapter( hb_dvd_t * );
 231 int          hb_dvd_is_break( hb_dvd_t * d );
 232 void         hb_dvd_close( hb_dvd_t ** );
 233 int          hb_dvd_angle_count( hb_dvd_t * d );
 234 void         hb_dvd_set_angle( hb_dvd_t * d, int angle );
 235 int          hb_dvd_main_feature( hb_dvd_t * d, hb_list_t * list_title );
 236
 237 hb_bd_t     * hb_bd_init( char * path );
 238 int           hb_bd_title_count( hb_bd_t * d );
 239 hb_title_t  * hb_bd_title_scan( hb_bd_t * d, int t, uint64_t min_duration );
 240 int           hb_bd_start( hb_bd_t * d, hb_title_t *title );
 241 void          hb_bd_stop( hb_bd_t * d );
 242 int           hb_bd_seek( hb_bd_t * d, float f );
 243 int           hb_bd_seek_pts( hb_bd_t * d, uint64_t pts );
 244 int           hb_bd_seek_chapter( hb_bd_t * d, int chapter );
 245 int           hb_bd_read( hb_bd_t * d, hb_buffer_t * b );
 246 int           hb_bd_chapter( hb_bd_t * d );
 247 void          hb_bd_close( hb_bd_t ** _d );
 248 void          hb_bd_set_angle( hb_bd_t * d, int angle );
 249 int           hb_bd_main_feature( hb_bd_t * d, hb_list_t * list_title );
 250
 251 hb_stream_t * hb_bd_stream_open( hb_title_t *title );
 252 hb_stream_t * hb_stream_open( char * path, hb_title_t *title );
 253 void             hb_stream_close( hb_stream_t ** );
 254 hb_title_t * hb_stream_title_scan( hb_stream_t *);
 255 int          hb_stream_read( hb_stream_t *, hb_buffer_t *);
 256 int          hb_stream_seek( hb_stream_t *, float );
 257 int          hb_stream_seek_ts( hb_stream_t * stream, int64_t ts );
 258 int          hb_stream_seek_chapter( hb_stream_t *, int );
 259 int          hb_stream_chapter( hb_stream_t * );
 260
 261 int          hb_ts_decode_pkt( hb_stream_t *stream, const uint8_t * pkt, hb_buffer_t *obuf );
 262
 263
 264 void       * hb_ffmpeg_context( int codec_param );
 265 void       * hb_ffmpeg_avstream( int codec_param );
 266
 267 #define STR4_TO_UINT32(p) \
 268     ((((const uint8_t*)(p))[0] << 24) | \
 269      (((const uint8_t*)(p))[1] << 16) | \
 270      (((const uint8_t*)(p))[2] <<  8) | \
 271       ((const uint8_t*)(p))[3])
 272
 273 /***********************************************************************
 274  * Work objects
 275  **********************************************************************/
 276 #define HB_CONFIG_MAX_SIZE 8192
 277 union hb_esconfig_u
 278 {
 279
 280     struct
 281     {
 282         uint8_t bytes[HB_CONFIG_MAX_SIZE];
 283         int     length;
 284     } mpeg4;
 285
 286         struct
 287         {
 288             uint8_t  sps[HB_CONFIG_MAX_SIZE];
 289             int       sps_length;
 290             uint8_t  pps[HB_CONFIG_MAX_SIZE];
 291             int       pps_length;
 292         uint32_t init_delay;
 293         } h264;
 294
 295     struct
 296     {
 297         uint8_t headers[3][HB_CONFIG_MAX_SIZE];
 298     } theora;
 299
 300     struct
 301     {
 302         uint8_t bytes[HB_CONFIG_MAX_SIZE];
 303         int     length;
 304     } aac;
 305
 306     struct
 307     {
 308         uint8_t headers[3][HB_CONFIG_MAX_SIZE];
 309         char *language;
 310     } vorbis;
 311
 312     struct
 313     {
 314         /* ac3flags stores the flags from the AC3 source, as found in scan.c */
 315         int     ac3flags;
 316         // next two items are used by the bsinfo routine to accumulate small
 317         // frames until we have enough to validate the crc.
 318         int     len;        // space currently used in 'buf'
 319         uint8_t buf[HB_CONFIG_MAX_SIZE-sizeof(int)];
 320     } a52;
 321
 322     struct
 323     {
 324         /* dcaflags stores the flags from the DCA source, as found in scan.c */
 325         int  dcaflags;
 326     } dca;
 327
 328 };
 329
 330 enum
 331 {
 332     WORK_SYNC_VIDEO = 1,
 333     WORK_SYNC_AUDIO,
 334     WORK_DECMPEG2,
 335     WORK_DECCC608,
 336     WORK_DECVOBSUB,
 337     WORK_DECSRTSUB,
 338     WORK_DECUTF8SUB,
 339     WORK_DECTX3GSUB,
 340     WORK_DECSSASUB,
 341     WORK_ENCVOBSUB,
 342     WORK_RENDER,
 343     WORK_ENCAVCODEC,
 344     WORK_ENCX264,
 345     WORK_ENCTHEORA,
 346     WORK_DECA52,
 347     WORK_DECDCA,
 348     WORK_DECAVCODEC,
 349     WORK_DECAVCODECV,
 350     WORK_DECAVCODECVI,
 351     WORK_DECAVCODECAI,
 352     WORK_DECLPCM,
 353     WORK_ENCFAAC,
 354     WORK_ENCLAME,
 355     WORK_ENCVORBIS,
 356     WORK_ENC_CA_AAC,
 357     WORK_MUX
 358 };
 359
 360 enum
 361 {
 362     FILTER_DEINTERLACE = 1,
 363     FILTER_DEBLOCK,
 364     FILTER_DENOISE,
 365     FILTER_DETELECINE,
 366     FILTER_DECOMB,
 367     FILTER_ROTATE
 368 };
 369
 370 extern hb_work_object_t * hb_objects;
 371
 372 #define HB_WORK_IDLE     0
 373 #define HB_WORK_OK       1
 374 #define HB_WORK_ERROR    2
 375 #define HB_WORK_DONE     3
 376
 377 /***********************************************************************
 378  * Muxers
 379  **********************************************************************/
 380 typedef struct hb_mux_object_s hb_mux_object_t;
 381 typedef struct hb_mux_data_s   hb_mux_data_t;
 382
 383 #define HB_MUX_COMMON \
 384     int (*init)      ( hb_mux_object_t * ); \
 385     int (*mux)       ( hb_mux_object_t *, hb_mux_data_t *, \
 386                        hb_buffer_t * ); \
 387     int (*end)       ( hb_mux_object_t * );
 388
 389 #define DECLARE_MUX( a ) \
 390     hb_mux_object_t  * hb_mux_##a##_init( hb_job_t * );
 391
 392 DECLARE_MUX( mp4 );
 393 DECLARE_MUX( avi );
 394 DECLARE_MUX( ogm );
 395 DECLARE_MUX( mkv );
 396