1 /* $Id: common.h,v 1.51 2005/11/04 13:09:40 titer Exp $
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. */
17 #include <sys/types.h>
21 #if defined( SYS_MINGW )
22 # define fseek fseeko64
23 # define ftell ftello64
25 # define fseeko fseeko64
27 # define ftello ftello64
28 # define flockfile(...)
29 # define funlockfile(...)
30 # define getc_unlocked getc
32 # define off_t off64_t
36 #define MIN( a, b ) ( (a) > (b) ? (b) : (a) )
39 #define MAX( a, b ) ( (a) > (b) ? (a) : (b) )
42 #define EVEN( a ) ( (a) + ( (a) & 1 ) )
43 #define MULTIPLE_16( a ) ( 16 * ( ( (a) + 8 ) / 16 ) )
44 #define MULTIPLE_MOD( a, b ) ((b==1)?a:( b * ( ( (a) + (b / 2) - 1) / b ) ))
46 #define HB_DVD_READ_BUFFER_SIZE 2048
48 typedef struct hb_handle_s hb_handle_t;
49 typedef struct hb_list_s hb_list_t;
50 typedef struct hb_rate_s hb_rate_t;
51 typedef struct hb_mixdown_s hb_mixdown_t;
52 typedef struct hb_job_s hb_job_t;
53 typedef struct hb_title_s hb_title_t;
54 typedef struct hb_chapter_s hb_chapter_t;
55 typedef struct hb_audio_s hb_audio_t;
56 typedef struct hb_audio_config_s hb_audio_config_t;
57 typedef struct hb_subtitle_s hb_subtitle_t;
58 typedef struct hb_subtitle_config_s hb_subtitle_config_t;
59 typedef struct hb_metadata_s hb_metadata_t;
60 typedef struct hb_state_s hb_state_t;
61 typedef union hb_esconfig_u hb_esconfig_t;
62 typedef struct hb_work_private_s hb_work_private_t;
63 typedef struct hb_work_object_s hb_work_object_t;
64 typedef struct hb_filter_private_s hb_filter_private_t;
65 typedef struct hb_filter_object_s hb_filter_object_t;
66 typedef struct hb_buffer_s hb_buffer_t;
67 typedef struct hb_fifo_s hb_fifo_t;
68 typedef struct hb_lock_s hb_lock_t;
78 hb_list_t * hb_list_init();
79 int hb_list_count( hb_list_t * );
80 void hb_list_add( hb_list_t *, void * );
81 void hb_list_rem( hb_list_t *, void * );
82 void * hb_list_item( hb_list_t *, int );
83 void hb_list_close( hb_list_t ** );
85 void hb_reduce( int *x, int *y, int num, int den );
87 #define HB_KEEP_WIDTH 0
88 #define HB_KEEP_HEIGHT 1
89 void hb_fix_aspect( hb_job_t * job, int keep );
91 int hb_calc_bitrate( hb_job_t *, int size );
93 hb_audio_t *hb_audio_copy(const hb_audio_t *src);
94 void hb_audio_config_init(hb_audio_config_t * audiocfg);
95 int hb_audio_add(const hb_job_t * job, const hb_audio_config_t * audiocfg);
96 hb_audio_config_t * hb_list_audio_config_item(hb_list_t * list, int i);
106 char * human_readable_name;
107 char * internal_name;
112 struct hb_subtitle_config_s
114 enum subdest { RENDERSUB, PASSTHRUSUB } dest;
119 #define HB_VIDEO_RATE_BASE 27000000
121 extern hb_rate_t hb_video_rates[];
122 extern int hb_video_rates_count;
123 extern hb_rate_t hb_audio_rates[];
124 extern int hb_audio_rates_count;
125 extern int hb_audio_rates_default;
126 extern hb_rate_t hb_audio_bitrates[];
127 extern int hb_audio_bitrates_count;
128 extern int hb_audio_bitrates_default;
129 extern hb_mixdown_t hb_audio_mixdowns[];
130 extern int hb_audio_mixdowns_count;
131 int hb_mixdown_get_mixdown_from_short_name( const char * short_name );
132 const char * hb_mixdown_get_short_name_from_mixdown( int amixdown );
134 /******************************************************************************
135 * hb_job_t: settings to be filled by the UI
136 *****************************************************************************/
139 /* ID assigned by UI so it can groups job passes together */
142 /* Pointer to the title to be ripped */
145 /* Chapter selection */
149 /* Include chapter marker track in mp4? */
153 crop: must be multiples of 2 (top/bottom/left/right)
155 width: must be a multiple of 16
156 height: must be a multiple of 16
157 keep_ratio: used by UIs
158 grayscale: black and white encoding
159 pixel_ratio: store pixel aspect ratio in the video
160 pixel_aspect_width: numerator for pixel aspect ratio
161 pixel_aspect_height: denominator for pixel aspect ratio
162 modulus: set a number besides 16 for dimensions to be multiples of
163 maxWidth: keep width below this
164 maxHeight: keep height below this */
189 vquality: output quality (0.0..1.0)
190 if < 0.0 or > 1.0, bitrate is used instead,
191 except with x264, to use its real QP/RF scale
192 vbitrate: output bitrate (kbps)
193 vrate, vrate_base: output framerate is vrate / vrate_base
194 cfr: 0 (vfr), 1 (cfr), 2 (pfr) [see render.c]
195 pass: 0, 1 or 2 (or -1 for scan)
196 h264_level: vestigial boolean to decide if we're encoding for iPod
197 crf: boolean for whether to use constant rate factor with x264
198 x264opts: string of extra x264 options
199 areBframes: boolean to note if b-frames are included in x264opts */
200 #define HB_VCODEC_MASK 0x0000FF
201 #define HB_VCODEC_FFMPEG 0x000001
202 #define HB_VCODEC_X264 0x000002
203 #define HB_VCODEC_THEORA 0x000004
220 /* List of audio settings. */
221 hb_list_t * list_audio;
225 hb_list_t * list_subtitle;
228 mux: output file format
230 #define HB_MUX_MASK 0xFF0000
231 #define HB_MUX_MP4 0x010000
232 #define HB_MUX_PSP 0x020000
233 #define HB_MUX_AVI 0x040000
234 #define HB_MUX_OGM 0x080000
235 #define HB_MUX_IPOD 0x100000
236 #define HB_MUX_MKV 0x200000
241 /* Allow MP4 files > 4 gigs */
247 hb_subtitle_config_t select_subtitle_config;
248 hb_subtitle_t ** select_subtitle;
249 char * native_language;
251 int angle; // dvd angle to encode
252 int frame_to_stop; // declare eof when we hit this frame
253 int64_t pts_to_stop; // declare eof when we pass this pts in
254 // the time-linearized input stream
255 int start_at_preview; // if non-zero, encoding will start
256 // at the position of preview n
257 int seek_points; // out of N previews
258 uint32_t frames_to_skip; // decode but discard this many frames
259 // initially (for frame accurate positioning
269 hb_fifo_t * fifo_mpeg2; /* MPEG-2 video ES */
270 hb_fifo_t * fifo_raw; /* Raw pictures */
271 hb_fifo_t * fifo_sync; /* Raw pictures, framerate corrected */
272 hb_fifo_t * fifo_render; /* Raw pictures, scaled */
273 hb_fifo_t * fifo_mpeg4; /* MPEG-4 video ES */
275 hb_thread_t * reader;
278 hb_list_t * list_work;
280 hb_esconfig_t config;
282 hb_mux_data_t * mux_data;
286 /* Audio starts here */
288 #define HB_ACODEC_MASK 0x00FF00
289 #define HB_ACODEC_FAAC 0x000100
290 #define HB_ACODEC_LAME 0x000200
291 #define HB_ACODEC_VORBIS 0x000400
292 #define HB_ACODEC_AC3 0x000800
293 #define HB_ACODEC_MPGA 0x001000
294 #define HB_ACODEC_LPCM 0x002000
295 #define HB_ACODEC_DCA 0x004000
296 #define HB_ACODEC_FFMPEG 0x008000
297 #define HB_ACODEC_CA_AAC 0x010000
300 /* define some masks, used to extract the various information from the HB_AMIXDOWN_XXXX values */
301 #define HB_AMIXDOWN_DCA_FORMAT_MASK 0x00FFF000
302 #define HB_AMIXDOWN_A52_FORMAT_MASK 0x00000FF0
303 #define HB_AMIXDOWN_DISCRETE_CHANNEL_COUNT_MASK 0x0000000F
304 /* define the HB_AMIXDOWN_XXXX values */
305 #define HB_AMIXDOWN_MONO 0x01000001
306 // DCA_FORMAT of DCA_MONO = 0 = 0x000
307 // A52_FORMAT of A52_MONO = 1 = 0x01
308 // discrete channel count of 1
309 #define HB_AMIXDOWN_STEREO 0x02002022
310 // DCA_FORMAT of DCA_STEREO = 2 = 0x002
311 // A52_FORMAT of A52_STEREO = 2 = 0x02
312 // discrete channel count of 2
313 #define HB_AMIXDOWN_DOLBY 0x042070A2
314 // DCA_FORMAT of DCA_3F1R | DCA_OUT_DPLI = 519 = 0x207
315 // A52_FORMAT of A52_DOLBY = 10 = 0x0A
316 // discrete channel count of 2
317 #define HB_AMIXDOWN_DOLBYPLII 0x084094A2
318 // DCA_FORMAT of DCA_3F2R | DCA_OUT_DPLII = 1033 = 0x409
319 // A52_FORMAT of A52_DOLBY | A52_USE_DPLII = 74 = 0x4A
320 // discrete channel count of 2
321 #define HB_AMIXDOWN_6CH 0x10089176
322 // DCA_FORMAT of DCA_3F2R | DCA_LFE = 137 = 0x089
323 // A52_FORMAT of A52_3F2R | A52_LFE = 23 = 0x17
324 // discrete channel count of 6
325 /* define some macros to extract the various information from the HB_AMIXDOWN_XXXX values */
326 #define HB_AMIXDOWN_GET_DCA_FORMAT( a ) ( ( a & HB_AMIXDOWN_DCA_FORMAT_MASK ) >> 12 )
327 #define HB_AMIXDOWN_GET_A52_FORMAT( a ) ( ( a & HB_AMIXDOWN_A52_FORMAT_MASK ) >> 4 )
328 #define HB_AMIXDOWN_GET_DISCRETE_CHANNEL_COUNT( a ) ( ( a & HB_AMIXDOWN_DISCRETE_CHANNEL_COUNT_MASK ) )
330 /* Input Channel Layout */
331 /* define some masks, used to extract the various information from the HB_AMIXDOWN_XXXX values */
332 #define HB_INPUT_CH_LAYOUT_DISCRETE_FRONT_MASK 0x00F0000
333 #define HB_INPUT_CH_LAYOUT_DISCRETE_REAR_MASK 0x000F000
334 #define HB_INPUT_CH_LAYOUT_DISCRETE_LFE_MASK 0x0000F00
335 #define HB_INPUT_CH_LAYOUT_DISCRETE_NO_LFE_MASK 0xFFFF0FF
336 #define HB_INPUT_CH_LAYOUT_ENCODED_FRONT_MASK 0x00000F0
337 #define HB_INPUT_CH_LAYOUT_ENCODED_REAR_MASK 0x000000F
338 /* define the input channel layouts used to describe the channel layout of this audio */
339 #define HB_INPUT_CH_LAYOUT_MONO 0x0110010
340 #define HB_INPUT_CH_LAYOUT_STEREO 0x0220020
341 #define HB_INPUT_CH_LAYOUT_DOLBY 0x0320031
342 #define HB_INPUT_CH_LAYOUT_3F 0x0430030
343 #define HB_INPUT_CH_LAYOUT_2F1R 0x0521021
344 #define HB_INPUT_CH_LAYOUT_3F1R 0x0631031
345 #define HB_INPUT_CH_LAYOUT_2F2R 0x0722022
346 #define HB_INPUT_CH_LAYOUT_3F2R 0x0832032
347 #define HB_INPUT_CH_LAYOUT_4F2R 0x0942042
348 #define HB_INPUT_CH_LAYOUT_HAS_LFE 0x0000100
349 /* define some macros to extract the various information from the HB_AMIXDOWN_XXXX values */
350 #define HB_INPUT_CH_LAYOUT_GET_DISCRETE_FRONT_COUNT( a ) ( ( a & HB_INPUT_CH_LAYOUT_DISCRETE_FRONT_MASK ) >> 16 )
351 #define HB_INPUT_CH_LAYOUT_GET_DISCRETE_REAR_COUNT( a ) ( ( a & HB_INPUT_CH_LAYOUT_DISCRETE_REAR_MASK ) >> 12 )
352 #define HB_INPUT_CH_LAYOUT_GET_DISCRETE_LFE_COUNT( a ) ( ( a & HB_INPUT_CH_LAYOUT_DISCRETE_LFE_MASK ) >> 8 )
353 #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 ) )
354 #define HB_INPUT_CH_LAYOUT_GET_ENCODED_FRONT_COUNT( a ) ( ( a & HB_INPUT_CH_LAYOUT_ENCODED_FRONT_MASK ) >> 4 )
355 #define HB_INPUT_CH_LAYOUT_GET_ENCODED_REAR_COUNT( a ) ( ( a & HB_INPUT_CH_LAYOUT_ENCODED_REAR_MASK ) )
357 struct hb_audio_config_s
362 int track; /* Output track number */
363 uint32_t codec; /* Output audio codec.
364 * HB_ACODEC_AC3 means pass-through, then bitrate and samplerate
367 int samplerate; /* Output sample rate (Hz) */
368 int bitrate; /* Output bitrate (kbps) */
369 int mixdown; /* The mixdown format to be used for this audio track (see HB_AMIXDOWN_*) */
370 double dynamic_range_compression; /* Amount of DRC that gets applied to this track */
371 char * name; /* Output track name */
377 int track; /* Input track number */
378 PRIVATE uint32_t codec; /* Input audio codec */
379 PRIVATE uint32_t codec_param; /* per-codec config info */
380 PRIVATE uint32_t version; /* Bitsream version */
381 PRIVATE uint32_t mode; /* Bitstream mode, codec dependent encoding */
382 PRIVATE int samplerate; /* Input sample rate (Hz) */
383 PRIVATE int bitrate; /* Input bitrate (kbps) */
384 PRIVATE int channel_layout;
385 /* channel_layout is the channel layout of this audio this is used to
386 * provide a common way of describing the source audio
393 PRIVATE int ac3; /* flags.ac3 is only set when the source audio format is HB_ACODEC_AC3 */
394 PRIVATE int dca; /* flags.dca is only set when the source audio format is HB_ACODEC_DCA */
396 #define AUDIO_F_DOLBY (1 << 31) /* set if source uses Dolby Surround */
400 PRIVATE char description[1024];
401 PRIVATE char simple[1024];
402 PRIVATE char iso639_2[4];
403 PRIVATE uint8_t type; /* normal, visually impared, directors */
412 hb_audio_config_t config;
415 hb_fifo_t * fifo_in; /* AC3/MPEG/LPCM ES */
416 hb_fifo_t * fifo_raw; /* Raw audio */
417 hb_fifo_t * fifo_sync; /* Resampled, synced raw audio */
418 hb_fifo_t * fifo_out; /* MP3/AAC/Vorbis ES */
420 hb_esconfig_t config;
421 hb_mux_data_t * mux_data;
437 /* Visual-friendly duration */
442 /* Exact duration (in 1/90000s) */
445 /* Optional chapter title */
454 hb_subtitle_config_t config;
456 enum subtype { PICTURESUB, TEXTSUB } format;
457 enum subsource { VOBSUB, SRTSUB, CC608SUB, CC708SUB } source;
460 uint8_t type; /* Closed Caption, Childrens, Directors etc */
462 int hits; /* How many hits/occurrences of this subtitle */
463 int forced_hits; /* How many forced hits in this subtitle */
467 hb_fifo_t * fifo_in; /* SPU ES */
468 hb_fifo_t * fifo_raw; /* Decoded SPU */
469 hb_fifo_t * fifo_sync;/* Synced */
470 hb_fifo_t * fifo_out; /* Correct Timestamps, ready to be muxed */
471 hb_mux_data_t * mux_data;
480 char release_date[255];
484 uint32_t coverart_size;
502 /* Visual-friendly duration */
507 /* Exact duration (in 1/90000s) */
510 double aspect; // aspect ratio for the title's video
511 double container_aspect; // aspect ratio from container (0 if none)
514 int pixel_aspect_width;
515 int pixel_aspect_height;
519 enum { HB_MPEG2_PS_DEMUXER = 0, HB_MPEG2_TS_DEMUXER, HB_NULL_DEMUXER } demuxer;
520 int detected_interlacing;
521 int video_id; /* demuxer stream id for video */
522 int video_codec; /* worker object id of video codec */
523 int video_codec_param; /* codec specific config */
524 const char *video_codec_name;
526 const char *container_name;
529 uint32_t palette[16];
531 hb_metadata_t *metadata;
533 hb_list_t * list_chapter;
534 hb_list_t * list_audio;
535 hb_list_t * list_subtitle;
537 /* Job template for this title */
541 // set if video stream doesn't have IDR frames
542 #define HBTF_NO_IDR (1 << 0)
548 #define HB_STATE_IDLE 1
549 #define HB_STATE_SCANNING 2
550 #define HB_STATE_SCANDONE 4
551 #define HB_STATE_WORKING 8
552 #define HB_STATE_PAUSED 16
553 #define HB_STATE_WORKDONE 32
554 #define HB_STATE_MUXING 64
561 /* HB_STATE_SCANNING */
568 /* HB_STATE_WORKING */
582 /* HB_STATE_WORKDONE */
583 #define HB_ERROR_NONE 0
584 #define HB_ERROR_CANCELED 1
585 #define HB_ERROR_UNKNOWN 2
591 /* HB_STATE_MUXING */
597 typedef struct hb_work_info_s
609 struct { // info only valid for video decoders
612 int pixel_aspect_width;
613 int pixel_aspect_height;
616 struct { // info only valid for audio decoders
622 struct hb_work_object_s
628 int (* init) ( hb_work_object_t *, hb_job_t * );
629 int (* work) ( hb_work_object_t *, hb_buffer_t **,
631 void (* close) ( hb_work_object_t * );
632 /* the info entry point is used by scan to get bitstream information
633 * during a decode (i.e., it should only be called after at least one
634 * call to the 'work' entry point). currently it's only called for
635 * video streams & can be null for other work objects. */
636 int (* info) ( hb_work_object_t *, hb_work_info_t * );
637 /* the bitstream info entry point is used by scan to get bitstream
638 * information from a buffer. it doesn't have to be called during a
639 * decode (it can be called even if init & work haven't been).
640 * currently it's only called for audio streams & can be null for
641 * other work objects. */
642 int (* bsinfo) ( hb_work_object_t *, const hb_buffer_t *,
646 hb_fifo_t * fifo_out;
647 hb_esconfig_t * config;
649 /* Pointer hb_audio_t so we have access to the info in the audio worker threads. */
652 /* Pointer hb_subtitle_t so we have access to the info in the subtitle worker threads. */
653 hb_subtitle_t * subtitle;
655 hb_work_private_t * private_data;
657 hb_thread_t * thread;
663 hb_work_object_t * next;
664 int thread_sleep_interval;
668 extern hb_work_object_t hb_sync;
669 extern hb_work_object_t hb_decmpeg2;
670 extern hb_work_object_t hb_decvobsub;
671 extern hb_work_object_t hb_encvobsub;
672 extern hb_work_object_t hb_deccc608;
673 extern hb_work_object_t hb_render;
674 extern hb_work_object_t hb_encavcodec;
675 extern hb_work_object_t hb_encx264;
676 extern hb_work_object_t hb_enctheora;
677 extern hb_work_object_t hb_deca52;
678 extern hb_work_object_t hb_decdca;
679 extern hb_work_object_t hb_decavcodec;
680 extern hb_work_object_t hb_decavcodecv;
681 extern hb_work_object_t hb_decavcodecvi;
682 extern hb_work_object_t hb_decavcodecai;
683 extern hb_work_object_t hb_declpcm;
684 extern hb_work_object_t hb_encfaac;
685 extern hb_work_object_t hb_enclame;
686 extern hb_work_object_t hb_encvorbis;
687 extern hb_work_object_t hb_encca_aac;
690 #define FILTER_DELAY 1
691 #define FILTER_FAILED 2
692 #define FILTER_DROP 3
694 struct hb_filter_object_s
701 hb_filter_private_t* (* init) ( int, int, int, char * );
703 int (* work) ( const hb_buffer_t *, hb_buffer_t **,
704 int, int, int, hb_filter_private_t * );
706 void (* close) ( hb_filter_private_t * );
708 hb_filter_private_t * private_data;
709 //hb_buffer_t * buffer;
713 extern hb_filter_object_t hb_filter_detelecine;
714 extern hb_filter_object_t hb_filter_deinterlace;
715 extern hb_filter_object_t hb_filter_deblock;
716 extern hb_filter_object_t hb_filter_denoise;
717 extern hb_filter_object_t hb_filter_decomb;
719 typedef void hb_error_handler_t( const char *errmsg );
721 extern void hb_register_error_handler( hb_error_handler_t * handler );