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