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) ) / 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_state_s hb_state_t;
45 typedef union hb_esconfig_u hb_esconfig_t;
46 typedef struct hb_work_private_s hb_work_private_t;
47 typedef struct hb_work_object_s hb_work_object_t;
48 typedef struct hb_filter_private_s hb_filter_private_t;
49 typedef struct hb_filter_object_s hb_filter_object_t;
50 typedef struct hb_buffer_s hb_buffer_t;
51 typedef struct hb_fifo_s hb_fifo_t;
52 typedef struct hb_lock_s hb_lock_t;
62 hb_list_t * hb_list_init();
63 int hb_list_count( hb_list_t * );
64 void hb_list_add( hb_list_t *, void * );
65 void hb_list_rem( hb_list_t *, void * );
66 void * hb_list_item( hb_list_t *, int );
67 void hb_list_close( hb_list_t ** );
69 void hb_reduce( int *x, int *y, int num, int den );
71 #define HB_KEEP_WIDTH 0
72 #define HB_KEEP_HEIGHT 1
73 void hb_fix_aspect( hb_job_t * job, int keep );
75 int hb_calc_bitrate( hb_job_t *, int size );
77 hb_audio_t *hb_audio_copy(const hb_audio_t *src);
78 void hb_audio_config_init(hb_audio_config_t * audiocfg);
79 int hb_audio_add(const hb_job_t * job, const hb_audio_config_t * audiocfg);
80 hb_audio_config_t * hb_list_audio_config_item(hb_list_t * list, int i);
90 char * human_readable_name;
96 #define HB_ASPECT_BASE 9
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 pixel_ratio: store pixel aspect ratio in the video
137 pixel_aspect_width: numerator for pixel aspect ratio
138 pixel_aspect_height: denominator for pixel aspect ratio
139 maxWidth: keep width below this
140 maxHeight: keep height below this */
150 int pixel_aspect_width;
151 int pixel_aspect_height;
159 vquality: output quality (0.0..1.0)
160 if < 0.0 or > 1.0, bitrate is used instead
161 vbitrate: output bitrate (kbps)
162 pass: 0, 1 or 2 (or -1 for scan)
163 vrate, vrate_base: output framerate is vrate / vrate_base
164 h264_level: boolean for whether or not we're encoding for iPod
165 crf: boolean for whether to use constant rate factor with x264
166 x264opts: string of extra x264 options
167 areBframes: boolean to note if b-frames are included in x264opts */
168 #define HB_VCODEC_MASK 0x0000FF
169 #define HB_VCODEC_FFMPEG 0x000001
170 #define HB_VCODEC_XVID 0x000002
171 #define HB_VCODEC_X264 0x000004
172 #define HB_VCODEC_THEORA 0x000008
187 /* List of audio settings. */
188 hb_list_t * list_audio;
190 /* Subtitle settings:
191 subtitle: index in hb_title_t's subtitles list, starting
192 from 0. -1 means no subtitle */
194 int subtitleSmartAdjust;
197 mux: output file format
199 #define HB_MUX_MASK 0xFF0000
200 #define HB_MUX_MP4 0x010000
201 #define HB_MUX_PSP 0x020000
202 #define HB_MUX_AVI 0x040000
203 #define HB_MUX_OGM 0x080000
204 #define HB_MUX_IPOD 0x100000
205 #define HB_MUX_MKV 0x200000
210 /* Allow MP4 files > 4 gigs */
216 hb_subtitle_t ** select_subtitle;
218 char * native_language;
227 hb_fifo_t * fifo_mpeg2; /* MPEG-2 video ES */
228 hb_fifo_t * fifo_raw; /* Raw pictures */
229 hb_fifo_t * fifo_sync; /* Raw pictures, framerate corrected */
230 hb_fifo_t * fifo_render; /* Raw pictures, scaled */
231 hb_fifo_t * fifo_mpeg4; /* MPEG-4 video ES */
233 hb_thread_t * reader;
236 hb_list_t * list_work;
238 hb_esconfig_t config;
240 hb_mux_data_t * mux_data;
244 /* Audio starts here */
246 #define HB_ACODEC_MASK 0x00FF00
247 #define HB_ACODEC_FAAC 0x000100
248 #define HB_ACODEC_LAME 0x000200
249 #define HB_ACODEC_VORBIS 0x000400
250 #define HB_ACODEC_AC3 0x000800
251 #define HB_ACODEC_MPGA 0x001000
252 #define HB_ACODEC_LPCM 0x002000
253 #define HB_ACODEC_DCA 0x004000
256 /* define some masks, used to extract the various information from the HB_AMIXDOWN_XXXX values */
257 #define HB_AMIXDOWN_DCA_FORMAT_MASK 0x00FFF000
258 #define HB_AMIXDOWN_A52_FORMAT_MASK 0x00000FF0
259 #define HB_AMIXDOWN_DISCRETE_CHANNEL_COUNT_MASK 0x0000000F
260 /* define the HB_AMIXDOWN_XXXX values */
261 #define HB_AMIXDOWN_MONO 0x01000001
262 // DCA_FORMAT of DCA_MONO = 0 = 0x000
263 // A52_FORMAT of A52_MONO = 1 = 0x01
264 // discrete channel count of 1
265 #define HB_AMIXDOWN_STEREO 0x02002022
266 // DCA_FORMAT of DCA_STEREO = 2 = 0x002
267 // A52_FORMAT of A52_STEREO = 2 = 0x02
268 // discrete channel count of 2
269 #define HB_AMIXDOWN_DOLBY 0x042070A2
270 // DCA_FORMAT of DCA_3F1R | DCA_OUT_DPLI = 519 = 0x207
271 // A52_FORMAT of A52_DOLBY = 10 = 0x0A
272 // discrete channel count of 2
273 #define HB_AMIXDOWN_DOLBYPLII 0x084094A2
274 // DCA_FORMAT of DCA_3F2R | DCA_OUT_DPLII = 1033 = 0x409
275 // A52_FORMAT of A52_DOLBY | A52_USE_DPLII = 74 = 0x4A
276 // discrete channel count of 2
277 #define HB_AMIXDOWN_6CH 0x10089176
278 // DCA_FORMAT of DCA_3F2R | DCA_LFE = 137 = 0x089
279 // A52_FORMAT of A52_3F2R | A52_LFE = 23 = 0x17
280 // discrete channel count of 6
281 /* define some macros to extract the various information from the HB_AMIXDOWN_XXXX values */
282 #define HB_AMIXDOWN_GET_DCA_FORMAT( a ) ( ( a & HB_AMIXDOWN_DCA_FORMAT_MASK ) >> 12 )
283 #define HB_AMIXDOWN_GET_A52_FORMAT( a ) ( ( a & HB_AMIXDOWN_A52_FORMAT_MASK ) >> 4 )
284 #define HB_AMIXDOWN_GET_DISCRETE_CHANNEL_COUNT( a ) ( ( a & HB_AMIXDOWN_DISCRETE_CHANNEL_COUNT_MASK ) )
286 /* Input Channel Layout */
287 /* define some masks, used to extract the various information from the HB_AMIXDOWN_XXXX values */
288 #define HB_INPUT_CH_LAYOUT_DISCRETE_FRONT_MASK 0x00F0000
289 #define HB_INPUT_CH_LAYOUT_DISCRETE_REAR_MASK 0x000F000
290 #define HB_INPUT_CH_LAYOUT_DISCRETE_LFE_MASK 0x0000F00
291 #define HB_INPUT_CH_LAYOUT_DISCRETE_NO_LFE_MASK 0xFFFF0FF
292 #define HB_INPUT_CH_LAYOUT_ENCODED_FRONT_MASK 0x00000F0
293 #define HB_INPUT_CH_LAYOUT_ENCODED_REAR_MASK 0x000000F
294 /* define the input channel layouts used to describe the channel layout of this audio */
295 #define HB_INPUT_CH_LAYOUT_MONO 0x0110010
296 #define HB_INPUT_CH_LAYOUT_STEREO 0x0220020
297 #define HB_INPUT_CH_LAYOUT_DOLBY 0x0320031
298 #define HB_INPUT_CH_LAYOUT_3F 0x0430030
299 #define HB_INPUT_CH_LAYOUT_2F1R 0x0521021
300 #define HB_INPUT_CH_LAYOUT_3F1R 0x0631031
301 #define HB_INPUT_CH_LAYOUT_2F2R 0x0722022
302 #define HB_INPUT_CH_LAYOUT_3F2R 0x0832032
303 #define HB_INPUT_CH_LAYOUT_4F2R 0x0942042
304 #define HB_INPUT_CH_LAYOUT_HAS_LFE 0x0000100
305 /* define some macros to extract the various information from the HB_AMIXDOWN_XXXX values */
306 #define HB_INPUT_CH_LAYOUT_GET_DISCRETE_FRONT_COUNT( a ) ( ( a & HB_INPUT_CH_LAYOUT_DISCRETE_FRONT_MASK ) >> 16 )
307 #define HB_INPUT_CH_LAYOUT_GET_DISCRETE_REAR_COUNT( a ) ( ( a & HB_INPUT_CH_LAYOUT_DISCRETE_REAR_MASK ) >> 12 )
308 #define HB_INPUT_CH_LAYOUT_GET_DISCRETE_LFE_COUNT( a ) ( ( a & HB_INPUT_CH_LAYOUT_DISCRETE_LFE_MASK ) >> 8 )
309 #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 ) )
310 #define HB_INPUT_CH_LAYOUT_GET_ENCODED_FRONT_COUNT( a ) ( ( a & HB_INPUT_CH_LAYOUT_ENCODED_FRONT_MASK ) >> 4 )
311 #define HB_INPUT_CH_LAYOUT_GET_ENCODED_REAR_COUNT( a ) ( ( a & HB_INPUT_CH_LAYOUT_ENCODED_REAR_MASK ) )
313 struct hb_audio_config_s
318 int track; /* Output track number */
319 uint32_t codec; /* Output audio codec.
320 * HB_ACODEC_AC3 means pass-through, then bitrate and samplerate
323 int samplerate; /* Output sample rate (Hz) */
324 int bitrate; /* Output bitrate (kbps) */
325 int mixdown; /* The mixdown format to be used for this audio track (see HB_AMIXDOWN_*) */
326 double dynamic_range_compression; /* Amount of DRC that gets applied to this track */
332 int track; /* Input track number */
333 PRIVATE uint32_t codec; /* Input audio codec */
334 PRIVATE int samplerate; /* Input sample rate (Hz) */
335 PRIVATE int bitrate; /* Input bitrate (kbps) */
336 PRIVATE int channel_layout;
337 /* channel_layout is the channel layout of this audio this is used to
338 * provide a common way of describing the source audio
345 PRIVATE int ac3; /* flags.ac3 is only set when the source audio format is HB_ACODEC_AC3 */
346 PRIVATE int dca; /* flags.dca is only set when the source audio format is HB_ACODEC_DCA */
351 PRIVATE char description[1024];
352 PRIVATE char simple[1024];
353 PRIVATE char iso639_2[4];
362 hb_audio_config_t config;
365 hb_fifo_t * fifo_in; /* AC3/MPEG/LPCM ES */
366 hb_fifo_t * fifo_raw; /* Raw audio */
367 hb_fifo_t * fifo_sync; /* Resampled, synced raw audio */
368 hb_fifo_t * fifo_out; /* MP3/AAC/Vorbis ES */
370 hb_esconfig_t config;
371 hb_mux_data_t * mux_data;
385 /* Visual-friendly duration */
390 /* Exact duration (in 1/90000s) */
393 /* Optional chapter title */
403 int hits; /* How many hits/occurrences of this subtitle */
404 int forced_hits; /* How many forced hits in this subtitle */
408 hb_fifo_t * fifo_in; /* SPU ES */
409 hb_fifo_t * fifo_raw; /* Decodec SPU */
426 /* Visual-friendly duration */
431 /* Exact duration (in 1/90000s) */
440 int detected_interlacing;
442 uint32_t palette[16];
444 hb_list_t * list_chapter;
445 hb_list_t * list_audio;
446 hb_list_t * list_subtitle;
448 /* Job template for this title */
455 #define HB_STATE_IDLE 1
456 #define HB_STATE_SCANNING 2
457 #define HB_STATE_SCANDONE 4
458 #define HB_STATE_WORKING 8
459 #define HB_STATE_PAUSED 16
460 #define HB_STATE_WORKDONE 32
461 #define HB_STATE_MUXING 64
468 /* HB_STATE_SCANNING */
475 /* HB_STATE_WORKING */
489 /* HB_STATE_WORKDONE */
490 #define HB_ERROR_NONE 0
491 #define HB_ERROR_CANCELED 1
492 #define HB_ERROR_UNKNOWN 2
498 /* HB_STATE_MUXING */
504 struct hb_work_object_s
510 int (* init) ( hb_work_object_t *, hb_job_t * );
511 int (* work) ( hb_work_object_t *, hb_buffer_t **,
513 void (* close) ( hb_work_object_t * );
516 hb_fifo_t * fifo_out;
517 hb_esconfig_t * config;
519 /* Pointer hb_audio_t so we have access to the info in the audio worker threads. */
522 hb_work_private_t * private_data;
524 hb_thread_t * thread;
528 hb_work_object_t * next;
529 int thread_sleep_interval;
533 extern hb_work_object_t hb_sync;
534 extern hb_work_object_t hb_decmpeg2;
535 extern hb_work_object_t hb_decsub;
536 extern hb_work_object_t hb_render;
537 extern hb_work_object_t hb_encavcodec;
538 extern hb_work_object_t hb_encxvid;
539 extern hb_work_object_t hb_encx264;
540 extern hb_work_object_t hb_enctheora;
541 extern hb_work_object_t hb_deca52;
542 extern hb_work_object_t hb_decdca;
543 extern hb_work_object_t hb_decavcodec;
544 extern hb_work_object_t hb_declpcm;
545 extern hb_work_object_t hb_encfaac;
546 extern hb_work_object_t hb_enclame;
547 extern hb_work_object_t hb_encvorbis;
550 #define FILTER_DELAY 1
551 #define FILTER_FAILED 2
552 #define FILTER_DROP 3
554 struct hb_filter_object_s
561 hb_filter_private_t* (* init) ( int, int, int, char * );
563 int (* work) ( const hb_buffer_t *, hb_buffer_t **,
564 int, int, int, hb_filter_private_t * );
566 void (* close) ( hb_filter_private_t * );
568 hb_filter_private_t * private_data;
569 //hb_buffer_t * buffer;
573 extern hb_filter_object_t hb_filter_detelecine;
574 extern hb_filter_object_t hb_filter_deinterlace;
575 extern hb_filter_object_t hb_filter_deblock;
576 extern hb_filter_object_t hb_filter_denoise;
578 typedef void hb_error_handler_t( const char *errmsg );
580 extern void hb_register_error_handler( hb_error_handler_t * handler );