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     // PICTURESUB subtitle packets:
  89     //   Location and size of the subpicture.
  90     int           x;
  91     int           y;
  92     int           width;
  93     int           height;
  94     hb_buffer_t * next_subpicture;
  95
  96     // Video packets (after processing by the hb_sync_video work-object):
  97     //   A (copy of a) PICTURESUB subtitle packet that needs to be burned into this video packet by the hb_render work-object.
  98     //   Subtitles that are simply passed thru are NOT attached to the associated video packets.
  99     hb_buffer_t * sub;
 100
 101     // Packets in a list:
 102     //   the next packet in the list
 103     hb_buffer_t * next;
 104 };
 105
 106 void hb_buffer_pool_init( void );
 107 void hb_buffer_pool_free( void );
 108
 109 hb_buffer_t * hb_buffer_init( int size );
 110 void          hb_buffer_realloc( hb_buffer_t *, int size );
 111 void          hb_buffer_close( hb_buffer_t ** );
 112 void          hb_buffer_copy_settings( hb_buffer_t * dst,
 113                                        const hb_buffer_t * src );
 114
 115 hb_fifo_t   * hb_fifo_init( int capacity, int thresh );
 116 int           hb_fifo_size( hb_fifo_t * );
 117 int           hb_fifo_size_bytes( hb_fifo_t * );
 118 int           hb_fifo_is_full( hb_fifo_t * );
 119 float         hb_fifo_percent_full( hb_fifo_t * f );
 120 hb_buffer_t * hb_fifo_get( hb_fifo_t * );
 121 hb_buffer_t * hb_fifo_get_wait( hb_fifo_t * );
 122 hb_buffer_t * hb_fifo_see( hb_fifo_t * );
 123 hb_buffer_t * hb_fifo_see_wait( hb_fifo_t * );
 124 hb_buffer_t * hb_fifo_see2( hb_fifo_t * );
 125 void          hb_fifo_push( hb_fifo_t *, hb_buffer_t * );
 126 void          hb_fifo_push_wait( hb_fifo_t *, hb_buffer_t * );
 127 int           hb_fifo_full_wait( hb_fifo_t * f );
 128 void          hb_fifo_push_head( hb_fifo_t *, hb_buffer_t * );
 129 void          hb_fifo_push_list_element( hb_fifo_t *fifo, hb_buffer_t *buffer_list );
 130 hb_buffer_t * hb_fifo_get_list_element( hb_fifo_t *fifo );
 131 void          hb_fifo_close( hb_fifo_t ** );
 132 void          hb_fifo_flush( hb_fifo_t * f );
 133
 134 // this routine gets a buffer for an uncompressed YUV420 video frame
 135 // with dimensions width x height.
 136 static inline hb_buffer_t * hb_video_buffer_init( int width, int height )
 137 {
 138     // Y requires w x h bytes. U & V each require (w+1)/2 x
 139     // (h+1)/2 bytes (the "+1" is to round up). We shift rather
 140     // than divide by 2 since the compiler can't know these ints
 141     // are positive so it generates very expensive integer divides
 142     // if we do "/2". The code here matches the calculation for
 143     // PIX_FMT_YUV420P in ffmpeg's avpicture_fill() which is required
 144     // for most of HB's filters to work right.
 145     return hb_buffer_init( width * height + ( ( width+1 ) >> 1 ) *
 146                            ( ( height+1 ) >> 1 ) * 2 );
 147 }
 148
 149 // this routine 'moves' data from src to dst by interchanging 'data',
 150 // 'size' & 'alloc' between them and copying the rest of the fields
 151 // from src to dst.
 152 static inline void hb_buffer_swap_copy( hb_buffer_t *src, hb_buffer_t *dst )
 153 {
 154     uint8_t *data  = dst->data;
 155     int      size  = dst->size;
 156     int      alloc = dst->alloc;
 157
 158     *dst = *src;
 159
 160     src->data  = data;
 161     src->size  = size;
 162     src->alloc = alloc;
 163 }
 164
 165 /***********************************************************************
 166  * Threads: update.c, scan.c, work.c, reader.c, muxcommon.c
 167  **********************************************************************/
 168 hb_thread_t * hb_update_init( int * build, char * version );
 169 hb_thread_t * hb_scan_init( hb_handle_t *, volatile int * die,
 170                             const char * path, int title_index,
 171                             hb_list_t * list_title, int preview_count,
 172                             int store_previews, uint64_t min_duration );
 173 hb_thread_t * hb_work_init( hb_list_t * jobs,
 174                             volatile int * die, int * error, hb_job_t ** job );
 175 hb_thread_t  * hb_reader_init( hb_job_t * );
 176 hb_work_object_t * hb_muxer_init( hb_job_t * );
 177 hb_work_object_t * hb_get_work( int );
 178 hb_work_object_t * hb_codec_decoder( int );
 179 hb_work_object_t * hb_codec_encoder( int );
 180
 181 /***********************************************************************
 182  * sync.c
 183  **********************************************************************/
 184 hb_work_object_t * hb_sync_init( hb_job_t * job );
 185
 186 /***********************************************************************
 187  * mpegdemux.c
 188  **********************************************************************/
 189 typedef struct {
 190     int64_t last_scr;       /* unadjusted SCR from most recent pack */
 191     int64_t last_pts;       /* last pts we saw */
 192     int     scr_changes;    /* number of SCR discontinuities */
 193     int     dts_drops;      /* number of drops because DTS too far from SCR */
 194 } hb_psdemux_t;
 195
 196 typedef int (*hb_muxer_t)(hb_buffer_t *, hb_list_t *, hb_psdemux_t*);
 197
 198 int hb_demux_ps( hb_buffer_t * ps_buf, hb_list_t * es_list, hb_psdemux_t * );
 199 int hb_demux_ss( hb_buffer_t * ps_buf, hb_list_t * es_list, hb_psdemux_t * );
 200 int hb_demux_null( hb_buffer_t * ps_buf, hb_list_t * es_list, hb_psdemux_t * );
 201
 202 extern const hb_muxer_t hb_demux[];
 203
 204 /***********************************************************************
 205  * decmetadata.c
 206  **********************************************************************/
 207 extern void decmetadata( hb_title_t *title );
 208
 209 /***********************************************************************
 210  * batch.c
 211  **********************************************************************/
 212 typedef struct hb_batch_s hb_batch_t;
 213
 214 hb_batch_t  * hb_batch_init( char * path );
 215 void          hb_batch_close( hb_batch_t ** _d );
 216 int           hb_batch_title_count( hb_batch_t * d );
 217 hb_title_t  * hb_batch_title_scan( hb_batch_t * d, int t );
 218
 219 /***********************************************************************
 220  * dvd.c
 221  **********************************************************************/
 222 typedef struct hb_bd_s hb_bd_t;
 223 typedef union  hb_dvd_s hb_dvd_t;
 224 typedef struct hb_stream_s hb_stream_t;
 225
 226 hb_dvd_t *   hb_dvd_init( char * path );
 227 int          hb_dvd_title_count( hb_dvd_t * );
 228 hb_title_t * hb_dvd_title_scan( hb_dvd_t *, int title, uint64_t min_duration );
 229 int          hb_dvd_start( hb_dvd_t *, hb_title_t *title, int chapter );
 230 void         hb_dvd_stop( hb_dvd_t * );
 231 int          hb_dvd_seek( hb_dvd_t *, float );
 232 int          hb_dvd_read( hb_dvd_t *, hb_buffer_t * );
 233 int          hb_dvd_chapter( hb_dvd_t * );
 234 int          hb_dvd_is_break( hb_dvd_t * d );
 235 void         hb_dvd_close( hb_dvd_t ** );
 236 int          hb_dvd_angle_count( hb_dvd_t * d );
 237 void         hb_dvd_set_angle( hb_dvd_t * d, int angle );
 238 int          hb_dvd_main_feature( hb_dvd_t * d, hb_list_t * list_title );
 239
 240 hb_bd_t     * hb_bd_init( char * path );
 241 int           hb_bd_title_count( hb_bd_t * d );
 242 hb_title_t  * hb_bd_title_scan( hb_bd_t * d, int t, uint64_t min_duration );
 243 int           hb_bd_start( hb_bd_t * d, hb_title_t *title );
 244 void          hb_bd_stop( hb_bd_t * d );
 245 int           hb_bd_seek( hb_bd_t * d, float f );
 246 int           hb_bd_seek_pts( hb_bd_t * d, uint64_t pts );
 247 int           hb_bd_seek_chapter( hb_bd_t * d, int chapter );
 248 int           hb_bd_read( hb_bd_t * d, hb_buffer_t * b );
 249 int           hb_bd_chapter( hb_bd_t * d );
 250 void          hb_bd_close( hb_bd_t ** _d );
 251 void          hb_bd_set_angle( hb_bd_t * d, int angle );
 252 int           hb_bd_main_feature( hb_bd_t * d, hb_list_t * list_title );
 253
 254 hb_stream_t * hb_bd_stream_open( hb_title_t *title );
 255 hb_stream_t * hb_stream_open( char * path, hb_title_t *title );
 256 void             hb_stream_close( hb_stream_t ** );
 257 hb_title_t * hb_stream_title_scan( hb_stream_t *);
 258 int          hb_stream_read( hb_stream_t *, hb_buffer_t *);
 259 int          hb_stream_seek( hb_stream_t *, float );
 260 int          hb_stream_seek_ts( hb_stream_t * stream, int64_t ts );
 261 int          hb_stream_seek_chapter( hb_stream_t *, int );
 262 int          hb_stream_chapter( hb_stream_t * );
 263
 264 int          hb_ts_decode_pkt( hb_stream_t *stream, const uint8_t * pkt, hb_buffer_t *obuf );
 265
 266
 267 void       * hb_ffmpeg_context( int codec_param );
 268 void       * hb_ffmpeg_avstream( int codec_param );
 269
 270 #define STR4_TO_UINT32(p) \
 271     ((((const uint8_t*)(p))[0] << 24) | \
 272      (((const uint8_t*)(p))[1] << 16) | \
 273      (((const uint8_t*)(p))[2] <<  8) | \
 274       ((const uint8_t*)(p))[3])
 275
 276 /***********************************************************************
 277  * Work objects
 278  **********************************************************************/
 279 #define HB_CONFIG_MAX_SIZE 8192
 280 union hb_esconfig_u
 281 {
 282
 283     struct
 284     {
 285         uint8_t bytes[HB_CONFIG_MAX_SIZE];
 286         int     length;
 287     } mpeg4;
 288
 289         struct
 290         {
 291             uint8_t  sps[HB_CONFIG_MAX_SIZE];
 292             int       sps_length;
 293             uint8_t  pps[HB_CONFIG_MAX_SIZE];
 294             int       pps_length;
 295         uint32_t init_delay;
 296         } h264;
 297
 298     struct
 299     {
 300         uint8_t headers[3][HB_CONFIG_MAX_SIZE];
 301     } theora;
 302
 303     struct
 304     {
 305         uint8_t bytes[HB_CONFIG_MAX_SIZE];
 306         int     length;
 307     } aac;
 308
 309     struct
 310     {
 311         uint8_t headers[3][HB_CONFIG_MAX_SIZE];
 312         char *language;
 313     } vorbis;
 314
 315     struct
 316     {
 317         /* ac3flags stores the flags from the AC3 source, as found in scan.c */
 318         int     ac3flags;
 319         // next two items are used by the bsinfo routine to accumulate small
 320         // frames until we have enough to validate the crc.
 321         int     len;        // space currently used in 'buf'
 322         uint8_t buf[HB_CONFIG_MAX_SIZE-sizeof(int)];
 323     } a52;
 324
 325     struct
 326     {
 327         /* dcaflags stores the flags from the DCA source, as found in scan.c */
 328         int  dcaflags;
 329     } dca;
 330
 331 };
 332
 333 enum
 334 {
 335     WORK_SYNC_VIDEO = 1,
 336     WORK_SYNC_AUDIO,
 337     WORK_DECMPEG2,
 338     WORK_DECCC608,
 339     WORK_DECVOBSUB,
 340     WORK_DECSRTSUB,
 341     WORK_DECUTF8SUB,
 342     WORK_DECTX3GSUB,
 343     WORK_DECSSASUB,
 344     WORK_ENCVOBSUB,
 345     WORK_RENDER,
 346     WORK_ENCAVCODEC,
 347     WORK_ENCX264,
 348     WORK_ENCTHEORA,
 349     WORK_DECA52,
 350     WORK_DECDCA,
 351     WORK_DECAVCODEC,
 352     WORK_DECAVCODECV,
 353     WORK_DECAVCODECVI,
 354     WORK_DECAVCODECAI,
 355     WORK_DECLPCM,
 356     WORK_ENCFAAC,
 357     WORK_ENCLAME,
 358     WORK_ENCVORBIS,
 359     WORK_ENC_CA_AAC,
 360     WORK_ENCAC3,
 361     WORK_MUX
 362 };
 363
 364 enum
 365 {
 366     FILTER_DEINTERLACE = 1,
 367     FILTER_DEBLOCK,
 368     FILTER_DENOISE,
 369     FILTER_DETELECINE,
 370     FILTER_DECOMB,
 371     FILTER_ROTATE
 372 };
 373
 374 // Picture flags used by filters
 375 #ifndef PIC_FLAG_REPEAT_FIRST_FIELD
 376 #define PIC_FLAG_REPEAT_FIRST_FIELD 256
 377 #endif
 378 #ifndef PIC_FLAG_TOP_FIELD_FIRST
 379 #define PIC_FLAG_TOP_FIELD_FIRST 8
 380 #endif
 381 #ifndef PIC_FLAG_PROGRESSIVE_FRAME
 382 #define PIC_FLAG_PROGRESSIVE_FRAME 16
 383 #endif
 384
 385 extern hb_work_object_t * hb_objects;
 386
 387 #define HB_WORK_IDLE     0
 388 #define HB_WORK_OK       1
 389 #define HB_WORK_ERROR    2
 390 #define HB_WORK_DONE     3
 391
 392 /***********************************************************************
 393  * Muxers
 394  **********************************************************************/
 395 typedef struct hb_mux_object_s hb_mux_object_t;
 396 typedef struct hb_mux_data_s   hb_mux_data_t;
 397
 398 #define HB_MUX_COMMON \
 399     int (*init)      ( hb_mux_object_t * ); \
 400     int (*mux)       ( hb_mux_object_t *, hb_mux_data_t *, \
 401                        hb_buffer_t * ); \
 402     int (*end)       ( hb_mux_object_t * );
 403
 404 #define DECLARE_MUX( a ) \
 405     hb_mux_object_t  * hb_mux_##a##_init( hb_job_t * );
 406
 407 DECLARE_MUX( mp4 );
 408 DECLARE_MUX( avi );
 409 DECLARE_MUX( ogm );
 410 DECLARE_MUX( mkv );
 411