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