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>
22 #define MIN( a, b ) ( (a) > (b) ? (b) : (a) )
25 #define MAX( a, b ) ( (a) > (b) ? (a) : (b) )
28 #define EVEN( a ) ( (a) + ( (a) & 1 ) )
29 #define MULTIPLE_16( a ) ( 16 * ( ( (a) + 8 ) / 16 ) )
30 #define MULTIPLE_MOD( a, b ) ( b * ( ( (a) + (b / 2) - 1) / b ) )
32 #define HB_DVD_READ_BUFFER_SIZE 2048
34 typedef struct hb_handle_s hb_handle_t;
35 typedef struct hb_list_s hb_list_t;
36 typedef struct hb_rate_s hb_rate_t;
37 typedef struct hb_mixdown_s hb_mixdown_t;
38 typedef struct hb_job_s hb_job_t;
39 typedef struct hb_title_s hb_title_t;
40 typedef struct hb_chapter_s hb_chapter_t;
41 typedef struct hb_audio_s hb_audio_t;
42 typedef struct hb_audio_config_s hb_audio_config_t;
43 typedef struct hb_subtitle_s hb_subtitle_t;
44 typedef struct hb_metadata_s hb_metadata_t;
45 typedef struct hb_state_s hb_state_t;
46 typedef union hb_esconfig_u hb_esconfig_t;
47 typedef struct hb_work_private_s hb_work_private_t;
48 typedef struct hb_work_object_s hb_work_object_t;
49 typedef struct hb_filter_private_s hb_filter_private_t;
50 typedef struct hb_filter_object_s hb_filter_object_t;
51 typedef struct hb_buffer_s hb_buffer_t;
52 typedef struct hb_fifo_s hb_fifo_t;
53 typedef struct hb_lock_s hb_lock_t;
63 hb_list_t * hb_list_init();
64 int hb_list_count( hb_list_t * );
65 void hb_list_add( hb_list_t *, void * );
66 void hb_list_rem( hb_list_t *, void * );
67 void * hb_list_item( hb_list_t *, int );
68 void hb_list_close( hb_list_t ** );
70 void hb_reduce( int *x, int *y, int num, int den );
72 #define HB_KEEP_WIDTH 0
73 #define HB_KEEP_HEIGHT 1
74 void hb_fix_aspect( hb_job_t * job, int keep );
76 int hb_calc_bitrate( hb_job_t *, int size );
78 hb_audio_t *hb_audio_copy(const hb_audio_t *src);
79 void hb_audio_config_init(hb_audio_config_t * audiocfg);
80 int hb_audio_add(const hb_job_t * job, const hb_audio_config_t * audiocfg);
81 hb_audio_config_t * hb_list_audio_config_item(hb_list_t * list, int i);
91 char * human_readable_name;
97 #define HB_VIDEO_RATE_BASE 27000000
99 extern hb_rate_t hb_video_rates[];
100 extern int hb_video_rates_count;
101 extern hb_rate_t hb_audio_rates[];
102 extern int hb_audio_rates_count;
103 extern int hb_audio_rates_default;
104 extern hb_rate_t hb_audio_bitrates[];
105 extern int hb_audio_bitrates_count;
106 extern int hb_audio_bitrates_default;
107 extern hb_mixdown_t hb_audio_mixdowns[];
108 extern int hb_audio_mixdowns_count;
109 int hb_mixdown_get_mixdown_from_short_name( const char * short_name );
110 const char * hb_mixdown_get_short_name_from_mixdown( int amixdown );
112 /******************************************************************************
113 * hb_job_t: settings to be filled by the UI
114 *****************************************************************************/
117 /* ID assigned by UI so it can groups job passes together */
120 /* Pointer to the title to be ripped */
123 /* Chapter selection */
127 /* Include chapter marker track in mp4? */
131 crop: must be multiples of 2 (top/bottom/left/right)
133 width: must be a multiple of 16
134 height: must be a multiple of 16
135 keep_ratio: used by UIs
136 grayscale: black and white encoding
137 pixel_ratio: store pixel aspect ratio in the video
138 pixel_aspect_width: numerator for pixel aspect ratio
139 pixel_aspect_height: denominator for pixel aspect ratio
140 modulus: set a number besides 16 for dimensions to be multiples of
141 maxWidth: keep width below this
142 maxHeight: keep height below this */
167 vquality: output quality (0.0..1.0)
168 if < 0.0 or > 1.0, bitrate is used instead,
169 except with x264, to use its real QP/RF scale
170 vbitrate: output bitrate (kbps)
171 vrate, vrate_base: output framerate is vrate / vrate_base
172 vfr: boolean for variable frame rate detelecine
173 cfr: boolean to use constant frame rates instead of
174 passing through the source's frame durations.
175 pass: 0, 1 or 2 (or -1 for scan)
176 h264_level: vestigial boolean to decide if we're encoding for iPod
177 crf: boolean for whether to use constant rate factor with x264
178 x264opts: string of extra x264 options
179 areBframes: boolean to note if b-frames are included in x264opts */
180 #define HB_VCODEC_MASK 0x0000FF
181 #define HB_VCODEC_FFMPEG 0x000001
182 #define HB_VCODEC_XVID 0x000002
183 #define HB_VCODEC_X264 0x000004
184 #define HB_VCODEC_THEORA 0x000008
201 /* List of audio settings. */
202 hb_list_t * list_audio;
204 /* Subtitle settings:
205 subtitle: index in hb_title_t's subtitles list, starting
206 from 0. -1 means no subtitle */
208 int subtitleSmartAdjust;
211 mux: output file format
213 #define HB_MUX_MASK 0xFF0000
214 #define HB_MUX_MP4 0x010000
215 #define HB_MUX_PSP 0x020000
216 #define HB_MUX_AVI 0x040000
217 #define HB_MUX_OGM 0x080000
218 #define HB_MUX_IPOD 0x100000
219 #define HB_MUX_MKV 0x200000
224 /* Allow MP4 files > 4 gigs */
230 hb_subtitle_t ** select_subtitle;
232 char * native_language;
234 int frame_to_stop; // declare eof when we hit this frame
235 int64_t pts_to_stop; // declare eof when we pass this pts in
236 // the time-linearized input stream
237 int start_at_preview; // if non-zero, encoding will start
238 // at the position of preview n
239 int seek_points; // out of N previews
240 uint32_t frames_to_skip; // decode but discard this many frames
241 // initially (for frame accurate positioning
251 hb_fifo_t * fifo_mpeg2; /* MPEG-2 video ES */
252 hb_fifo_t * fifo_raw; /* Raw pictures */
253 hb_fifo_t * fifo_sync; /* Raw pictures, framerate corrected */
254 hb_fifo_t * fifo_render; /* Raw pictures, scaled */
255 hb_fifo_t * fifo_mpeg4; /* MPEG-4 video ES */
257 hb_thread_t * reader;
260 hb_list_t * list_work;
262 hb_esconfig_t config;
264 hb_mux_data_t * mux_data;
268 /* Audio starts here */
270 #define HB_ACODEC_MASK 0x00FF00
271 #define HB_ACODEC_FAAC 0x000100
272 #define HB_ACODEC_LAME 0x000200
273 #define HB_ACODEC_VORBIS 0x000400
274 #define HB_ACODEC_AC3 0x000800
275 #define HB_ACODEC_MPGA 0x001000
276 #define HB_ACODEC_LPCM 0x002000
277 #define HB_ACODEC_DCA 0x004000
278 #define HB_ACODEC_FFMPEG 0x008000
281 /* define some masks, used to extract the various information from the HB_AMIXDOWN_XXXX values */
282 #define HB_AMIXDOWN_DCA_FORMAT_MASK 0x00FFF000
283 #define HB_AMIXDOWN_A52_FORMAT_MASK 0x00000FF0
284 #define HB_AMIXDOWN_DISCRETE_CHANNEL_COUNT_MASK 0x0000000F
285 /* define the HB_AMIXDOWN_XXXX values */
286 #define HB_AMIXDOWN_MONO 0x01000001
287 // DCA_FORMAT of DCA_MONO = 0 = 0x000
288 // A52_FORMAT of A52_MONO = 1 = 0x01
289 // discrete channel count of 1
290 #define HB_AMIXDOWN_STEREO 0x02002022
291 // DCA_FORMAT of DCA_STEREO = 2 = 0x002
292 // A52_FORMAT of A52_STEREO = 2 = 0x02
293 // discrete channel count of 2
294 #define HB_AMIXDOWN_DOLBY 0x042070A2
295 // DCA_FORMAT of DCA_3F1R | DCA_OUT_DPLI = 519 = 0x207
296 // A52_FORMAT of A52_DOLBY = 10 = 0x0A
297 // discrete channel count of 2
298 #define HB_AMIXDOWN_DOLBYPLII 0x084094A2
299 // DCA_FORMAT of DCA_3F2R | DCA_OUT_DPLII = 1033 = 0x409
300 // A52_FORMAT of A52_DOLBY | A52_USE_DPLII = 74 = 0x4A
301 // discrete channel count of 2
302 #define HB_AMIXDOWN_6CH 0x10089176
303 // DCA_FORMAT of DCA_3F2R | DCA_LFE = 137 = 0x089
304 // A52_FORMAT of A52_3F2R | A52_LFE = 23 = 0x17
305 // discrete channel count of 6
306 /* define some macros to extract the various information from the HB_AMIXDOWN_XXXX values */
307 #define HB_AMIXDOWN_GET_DCA_FORMAT( a ) ( ( a & HB_AMIXDOWN_DCA_FORMAT_MASK ) >> 12 )
308 #define HB_AMIXDOWN_GET_A52_FORMAT( a ) ( ( a & HB_AMIXDOWN_A52_FORMAT_MASK ) >> 4 )
309 #define HB_AMIXDOWN_GET_DISCRETE_CHANNEL_COUNT( a ) ( ( a & HB_AMIXDOWN_DISCRETE_CHANNEL_COUNT_MASK ) )
311 /* Input Channel Layout */
312 /* define some masks, used to extract the various information from the HB_AMIXDOWN_XXXX values */
313 #define HB_INPUT_CH_LAYOUT_DISCRETE_FRONT_MASK 0x00F0000
314 #define HB_INPUT_CH_LAYOUT_DISCRETE_REAR_MASK 0x000F000
315 #define HB_INPUT_CH_LAYOUT_DISCRETE_LFE_MASK 0x0000F00
316 #define HB_INPUT_CH_LAYOUT_DISCRETE_NO_LFE_MASK 0xFFFF0FF
317 #define HB_INPUT_CH_LAYOUT_ENCODED_FRONT_MASK 0x00000F0
318 #define HB_INPUT_CH_LAYOUT_ENCODED_REAR_MASK 0x000000F
319 /* define the input channel layouts used to describe the channel layout of this audio */
320 #define HB_INPUT_CH_LAYOUT_MONO 0x0110010
321 #define HB_INPUT_CH_LAYOUT_STEREO 0x0220020
322 #define HB_INPUT_CH_LAYOUT_DOLBY 0x0320031
323 #define HB_INPUT_CH_LAYOUT_3F 0x0430030
324 #define HB_INPUT_CH_LAYOUT_2F1R 0x0521021
325 #define HB_INPUT_CH_LAYOUT_3F1R 0x0631031
326 #define HB_INPUT_CH_LAYOUT_2F2R 0x0722022
327 #define HB_INPUT_CH_LAYOUT_3F2R 0x0832032
328 #define HB_INPUT_CH_LAYOUT_4F2R 0x0942042
329 #define HB_INPUT_CH_LAYOUT_HAS_LFE 0x0000100
330 /* define some macros to extract the various information from the HB_AMIXDOWN_XXXX values */
331 #define HB_INPUT_CH_LAYOUT_GET_DISCRETE_FRONT_COUNT( a ) ( ( a & HB_INPUT_CH_LAYOUT_DISCRETE_FRONT_MASK ) >> 16 )
332 #define HB_INPUT_CH_LAYOUT_GET_DISCRETE_REAR_COUNT( a ) ( ( a & HB_INPUT_CH_LAYOUT_DISCRETE_REAR_MASK ) >> 12 )
333 #define HB_INPUT_CH_LAYOUT_GET_DISCRETE_LFE_COUNT( a ) ( ( a & HB_INPUT_CH_LAYOUT_DISCRETE_LFE_MASK ) >> 8 )
334 #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 ) )
335 #define HB_INPUT_CH_LAYOUT_GET_ENCODED_FRONT_COUNT( a ) ( ( a & HB_INPUT_CH_LAYOUT_ENCODED_FRONT_MASK ) >> 4 )
336 #define HB_INPUT_CH_LAYOUT_GET_ENCODED_REAR_COUNT( a ) ( ( a & HB_INPUT_CH_LAYOUT_ENCODED_REAR_MASK ) )
338 struct hb_audio_config_s
343 int track; /* Output track number */
344 uint32_t codec; /* Output audio codec.
345 * HB_ACODEC_AC3 means pass-through, then bitrate and samplerate
348 int samplerate; /* Output sample rate (Hz) */
349 int bitrate; /* Output bitrate (kbps) */
350 int mixdown; /* The mixdown format to be used for this audio track (see HB_AMIXDOWN_*) */
351 double dynamic_range_compression; /* Amount of DRC that gets applied to this track */
352 char * name; /* Output track name */
358 int track; /* Input track number */
359 PRIVATE uint32_t codec; /* Input audio codec */
360 PRIVATE uint32_t codec_param; /* per-codec config info */
361 PRIVATE uint32_t version; /* Bitsream version */
362 PRIVATE uint32_t mode; /* Bitstream mode, codec dependent encoding */
363 PRIVATE int samplerate; /* Input sample rate (Hz) */
364 PRIVATE int bitrate; /* Input bitrate (kbps) */
365 PRIVATE int channel_layout;
366 /* channel_layout is the channel layout of this audio this is used to
367 * provide a common way of describing the source audio
374 PRIVATE int ac3; /* flags.ac3 is only set when the source audio format is HB_ACODEC_AC3 */
375 PRIVATE int dca; /* flags.dca is only set when the source audio format is HB_ACODEC_DCA */
377 #define AUDIO_F_DOLBY (1 << 31) /* set if source uses Dolby Surround */
381 PRIVATE char description[1024];
382 PRIVATE char simple[1024];
383 PRIVATE char iso639_2[4];
384 PRIVATE uint8_t type; /* normal, visually impared, directors */
393 hb_audio_config_t config;
396 hb_fifo_t * fifo_in; /* AC3/MPEG/LPCM ES */
397 hb_fifo_t * fifo_raw; /* Raw audio */
398 hb_fifo_t * fifo_sync; /* Resampled, synced raw audio */
399 hb_fifo_t * fifo_out; /* MP3/AAC/Vorbis ES */
401 hb_esconfig_t config;
402 hb_mux_data_t * mux_data;
416 /* Visual-friendly duration */
421 /* Exact duration (in 1/90000s) */
424 /* Optional chapter title */
433 uint8_t type; /* Closed Caption, Childrens, Directors etc */
435 int hits; /* How many hits/occurrences of this subtitle */
436 int forced_hits; /* How many forced hits in this subtitle */
440 hb_fifo_t * fifo_in; /* SPU ES */
441 hb_fifo_t * fifo_raw; /* Decodec SPU */
450 char release_date[255];
454 enum arttype {UNKNOWN, BMP, GIF87A, GIF89A, JPG, PNG, TIFFL, TIFFB} coverart_type;
455 uint32_t coverart_size;
472 /* Visual-friendly duration */
477 /* Exact duration (in 1/90000s) */
480 double aspect; // aspect ratio for the title's video
481 double container_aspect; // aspect ratio from container (0 if none)
484 int pixel_aspect_width;
485 int pixel_aspect_height;
489 enum { HB_MPEG2_PS_DEMUXER = 0, HB_MPEG2_TS_DEMUXER, HB_NULL_DEMUXER } demuxer;
490 int detected_interlacing;
491 int video_id; /* demuxer stream id for video */
492 int video_codec; /* worker object id of video codec */
493 int video_codec_param; /* codec specific config */
494 const char *video_codec_name;
496 const char *container_name;
499 uint32_t palette[16];
501 hb_metadata_t *metadata;
503 hb_list_t * list_chapter;
504 hb_list_t * list_audio;
505 hb_list_t * list_subtitle;
507 /* Job template for this title */
511 // set if video stream doesn't have IDR frames
512 #define HBTF_NO_IDR (1 << 0)
518 #define HB_STATE_IDLE 1
519 #define HB_STATE_SCANNING 2
520 #define HB_STATE_SCANDONE 4
521 #define HB_STATE_WORKING 8
522 #define HB_STATE_PAUSED 16
523 #define HB_STATE_WORKDONE 32
524 #define HB_STATE_MUXING 64
531 /* HB_STATE_SCANNING */
538 /* HB_STATE_WORKING */
552 /* HB_STATE_WORKDONE */
553 #define HB_ERROR_NONE 0
554 #define HB_ERROR_CANCELED 1
555 #define HB_ERROR_UNKNOWN 2
561 /* HB_STATE_MUXING */
567 typedef struct hb_work_info_s
579 struct { // info only valid for video decoders
582 int pixel_aspect_width;
583 int pixel_aspect_height;
586 struct { // info only valid for audio decoders
592 struct hb_work_object_s
598 int (* init) ( hb_work_object_t *, hb_job_t * );
599 int (* work) ( hb_work_object_t *, hb_buffer_t **,
601 void (* close) ( hb_work_object_t * );
602 /* the info entry point is used by scan to get bitstream information
603 * during a decode (i.e., it should only be called after at least one
604 * call to the 'work' entry point). currently it's only called for
605 * video streams & can be null for other work objects. */
606 int (* info) ( hb_work_object_t *, hb_work_info_t * );
607 /* the bitstream info entry point is used by scan to get bitstream
608 * information from a buffer. it doesn't have to be called during a
609 * decode (it can be called even if init & work haven't been).
610 * currently it's only called for audio streams & can be null for
611 * other work objects. */
612 int (* bsinfo) ( hb_work_object_t *, const hb_buffer_t *,
616 hb_fifo_t * fifo_out;
617 hb_esconfig_t * config;
619 /* Pointer hb_audio_t so we have access to the info in the audio worker threads. */
622 hb_work_private_t * private_data;
624 hb_thread_t * thread;
629 hb_work_object_t * next;
630 int thread_sleep_interval;
634 extern hb_work_object_t hb_sync;
635 extern hb_work_object_t hb_decmpeg2;
636 extern hb_work_object_t hb_decsub;
637 extern hb_work_object_t hb_render;
638 extern hb_work_object_t hb_encavcodec;
639 extern hb_work_object_t hb_encxvid;
640 extern hb_work_object_t hb_encx264;
641 extern hb_work_object_t hb_enctheora;
642 extern hb_work_object_t hb_deca52;
643 extern hb_work_object_t hb_decdca;
644 extern hb_work_object_t hb_decavcodec;
645 extern hb_work_object_t hb_decavcodecv;
646 extern hb_work_object_t hb_decavcodecvi;
647 extern hb_work_object_t hb_decavcodecai;
648 extern hb_work_object_t hb_declpcm;
649 extern hb_work_object_t hb_encfaac;
650 extern hb_work_object_t hb_enclame;
651 extern hb_work_object_t hb_encvorbis;
654 #define FILTER_DELAY 1
655 #define FILTER_FAILED 2
656 #define FILTER_DROP 3
658 struct hb_filter_object_s
665 hb_filter_private_t* (* init) ( int, int, int, char * );
667 int (* work) ( const hb_buffer_t *, hb_buffer_t **,
668 int, int, int, hb_filter_private_t * );
670 void (* close) ( hb_filter_private_t * );
672 hb_filter_private_t * private_data;
673 //hb_buffer_t * buffer;
677 extern hb_filter_object_t hb_filter_detelecine;
678 extern hb_filter_object_t hb_filter_deinterlace;
679 extern hb_filter_object_t hb_filter_deblock;
680 extern hb_filter_object_t hb_filter_denoise;
681 extern hb_filter_object_t hb_filter_decomb;
683 typedef void hb_error_handler_t( const char *errmsg );
685 extern void hb_register_error_handler( hb_error_handler_t * handler );