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.m0k.org/>.
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 ) )
31 #define HB_DVD_READ_BUFFER_SIZE 2048
33 typedef struct hb_handle_s hb_handle_t;
34 typedef struct hb_list_s hb_list_t;
35 typedef struct hb_rate_s hb_rate_t;
36 typedef struct hb_mixdown_s hb_mixdown_t;
37 typedef struct hb_job_s hb_job_t;
38 typedef struct hb_title_s hb_title_t;
39 typedef struct hb_chapter_s hb_chapter_t;
40 typedef struct hb_audio_s hb_audio_t;
41 typedef struct hb_subtitle_s hb_subtitle_t;
42 typedef struct hb_state_s hb_state_t;
43 typedef union hb_esconfig_u hb_esconfig_t;
44 typedef struct hb_work_private_s hb_work_private_t;
45 typedef struct hb_work_object_s hb_work_object_t;
46 typedef struct hb_filter_private_s hb_filter_private_t;
47 typedef struct hb_filter_object_s hb_filter_object_t;
48 typedef struct hb_buffer_s hb_buffer_t;
49 typedef struct hb_fifo_s hb_fifo_t;
50 typedef struct hb_lock_s hb_lock_t;
57 hb_list_t * hb_list_init();
58 int hb_list_count( hb_list_t * );
59 void hb_list_add( hb_list_t *, void * );
60 void hb_list_rem( hb_list_t *, void * );
61 void * hb_list_item( hb_list_t *, int );
62 void hb_list_close( hb_list_t ** );
64 void hb_reduce( int *x, int *y, int num, int den );
66 #define HB_KEEP_WIDTH 0
67 #define HB_KEEP_HEIGHT 1
68 void hb_fix_aspect( hb_job_t * job, int keep );
70 int hb_calc_bitrate( hb_job_t *, int size );
80 char * human_readable_name;
86 #define HB_ASPECT_BASE 9
87 #define HB_VIDEO_RATE_BASE 27000000
89 extern hb_rate_t hb_video_rates[];
90 extern int hb_video_rates_count;
91 extern hb_rate_t hb_audio_rates[];
92 extern int hb_audio_rates_count;
93 extern int hb_audio_rates_default;
94 extern hb_rate_t hb_audio_bitrates[];
95 extern int hb_audio_bitrates_count;
96 extern int hb_audio_bitrates_default;
97 extern hb_mixdown_t hb_audio_mixdowns[];
98 extern int hb_audio_mixdowns_count;
99 int hb_mixdown_get_mixdown_from_short_name( const char * short_name );
100 const char * hb_mixdown_get_short_name_from_mixdown( int amixdown );
102 /******************************************************************************
103 * hb_job_t: settings to be filled by the UI
104 *****************************************************************************/
107 /* ID assigned by UI so it can groups job passes together */
110 /* Pointer to the title to be ripped */
113 /* Chapter selection */
117 /* Include chapter marker track in mp4? */
121 crop: must be multiples of 2 (top/bottom/left/right)
123 width: must be a multiple of 16
124 height: must be a multiple of 16
125 keep_ratio: used by UIs
126 pixel_ratio: store pixel aspect ratio in the video
127 pixel_aspect_width: numerator for pixel aspect ratio
128 pixel_aspect_height: denominator for pixel aspect ratio
129 maxWidth: keep width below this
130 maxHeight: keep height below this */
140 int pixel_aspect_width;
141 int pixel_aspect_height;
148 vquality: output quality (0.0..1.0)
149 if < 0.0 or > 1.0, bitrate is used instead
150 vbitrate: output bitrate (kbps)
151 pass: 0, 1 or 2 (or -1 for scan)
152 vrate, vrate_base: output framerate is vrate / vrate_base
153 h264_level: boolean for whether or not we're encoding for iPod
154 crf: boolean for whether to use constant rate factor with x264
155 x264opts: string of extra x264 options
156 areBframes: boolean to note if b-frames are included in x264opts */
157 #define HB_VCODEC_MASK 0x0000FF
158 #define HB_VCODEC_FFMPEG 0x000001
159 #define HB_VCODEC_XVID 0x000002
160 #define HB_VCODEC_X264 0x000004
175 audios: Indexes in hb_title_t's audios list, starting from 0.
176 -1 indicates the end of the list
177 audio_mixdowns: The mixdown to be used for each audio track in audios[] */
179 /* define some masks, used to extract the various information from the HB_AMIXDOWN_XXXX values */
180 #define HB_AMIXDOWN_DCA_FORMAT_MASK 0x00FFF000
181 #define HB_AMIXDOWN_A52_FORMAT_MASK 0x00000FF0
182 #define HB_AMIXDOWN_DISCRETE_CHANNEL_COUNT_MASK 0x0000000F
184 /* define the HB_AMIXDOWN_XXXX values */
186 #define HB_AMIXDOWN_MONO 0x01000001
187 // DCA_FORMAT of DCA_MONO = 0 = 0x000
188 // A52_FORMAT of A52_MONO = 1 = 0x01
189 // discrete channel count of 1
191 #define HB_AMIXDOWN_STEREO 0x02002022
192 // DCA_FORMAT of DCA_STEREO = 2 = 0x002
193 // A52_FORMAT of A52_STEREO = 2 = 0x02
194 // discrete channel count of 2
196 #define HB_AMIXDOWN_DOLBY 0x042070A2
197 // DCA_FORMAT of DCA_3F1R | DCA_OUT_DPLI = 519 = 0x207
198 // A52_FORMAT of A52_DOLBY = 10 = 0x0A
199 // discrete channel count of 2
201 #define HB_AMIXDOWN_DOLBYPLII 0x084094A2
202 // DCA_FORMAT of DCA_3F2R | DCA_OUT_DPLII = 1033 = 0x409
203 // A52_FORMAT of A52_DOLBY | A52_USE_DPLII = 74 = 0x4A
204 // discrete channel count of 2
206 #define HB_AMIXDOWN_6CH 0x10089176
207 // DCA_FORMAT of DCA_3F2R | DCA_LFE = 137 = 0x089
208 // A52_FORMAT of A52_3F2R | A52_LFE = 23 = 0x17
209 // discrete channel count of 6
211 /* define some macros to extract the various information from the HB_AMIXDOWN_XXXX values */
212 #define HB_AMIXDOWN_GET_DCA_FORMAT( a ) ( ( a & HB_AMIXDOWN_DCA_FORMAT_MASK ) >> 12 )
213 #define HB_AMIXDOWN_GET_A52_FORMAT( a ) ( ( a & HB_AMIXDOWN_A52_FORMAT_MASK ) >> 4 )
214 #define HB_AMIXDOWN_GET_DISCRETE_CHANNEL_COUNT( a ) ( ( a & HB_AMIXDOWN_DISCRETE_CHANNEL_COUNT_MASK ) )
217 int audio_mixdowns[8];
221 abitrate: output bitrate (kbps)
222 arate: output samplerate (Hz)
223 HB_ACODEC_AC3 means pass-through, then abitrate and arate are
225 #define HB_ACODEC_MASK 0x00FF00
226 #define HB_ACODEC_FAAC 0x000100
227 #define HB_ACODEC_LAME 0x000200
228 #define HB_ACODEC_VORBIS 0x000400
229 #define HB_ACODEC_AC3 0x000800
230 #define HB_ACODEC_MPGA 0x001000
231 #define HB_ACODEC_LPCM 0x002000
232 #define HB_ACODEC_DCA 0x004000
237 /* Subtitle settings:
238 subtitle: index in hb_title_t's subtitles list, starting
239 from 0. -1 means no subtitle */
241 int subtitleSmartAdjust;
244 mux: output file format
246 #define HB_MUX_MASK 0xFF0000
247 #define HB_MUX_MP4 0x010000
248 #define HB_MUX_PSP 0x020000
249 #define HB_MUX_AVI 0x040000
250 #define HB_MUX_OGM 0x080000
251 #define HB_MUX_IPOD 0x100000
252 #define HB_MUX_MKV 0x200000
257 /* Allow MP4 files > 4 gigs */
262 hb_subtitle_t ** select_subtitle;
264 char * native_language;
273 hb_fifo_t * fifo_mpeg2; /* MPEG-2 video ES */
274 hb_fifo_t * fifo_raw; /* Raw pictures */
275 hb_fifo_t * fifo_sync; /* Raw pictures, framerate corrected */
276 hb_fifo_t * fifo_render; /* Raw pictures, scaled */
277 hb_fifo_t * fifo_mpeg4; /* MPEG-4 video ES */
279 hb_thread_t * reader;
282 hb_list_t * list_work;
284 hb_esconfig_t config;
286 hb_mux_data_t * mux_data;
294 char lang_simple[1024];
300 /* ac3flags is only set when the source audio format is HB_ACODEC_AC3 */
303 /* dcaflags is only set when the source audio format is HB_ACODEC_DCA */
306 /* define some masks, used to extract the various information from the HB_AMIXDOWN_XXXX values */
307 #define HB_INPUT_CH_LAYOUT_DISCRETE_FRONT_MASK 0x00F0000
308 #define HB_INPUT_CH_LAYOUT_DISCRETE_REAR_MASK 0x000F000
309 #define HB_INPUT_CH_LAYOUT_DISCRETE_LFE_MASK 0x0000F00
310 #define HB_INPUT_CH_LAYOUT_DISCRETE_NO_LFE_MASK 0xFFFF0FF
311 #define HB_INPUT_CH_LAYOUT_ENCODED_FRONT_MASK 0x00000F0
312 #define HB_INPUT_CH_LAYOUT_ENCODED_REAR_MASK 0x000000F
314 /* define the input channel layouts used to describe the channel layout of this audio */
315 #define HB_INPUT_CH_LAYOUT_MONO 0x0110010
316 #define HB_INPUT_CH_LAYOUT_STEREO 0x0220020
317 #define HB_INPUT_CH_LAYOUT_DOLBY 0x0320031
318 #define HB_INPUT_CH_LAYOUT_3F 0x0430030
319 #define HB_INPUT_CH_LAYOUT_2F1R 0x0521021
320 #define HB_INPUT_CH_LAYOUT_3F1R 0x0631031
321 #define HB_INPUT_CH_LAYOUT_2F2R 0x0722022
322 #define HB_INPUT_CH_LAYOUT_3F2R 0x0832032
323 #define HB_INPUT_CH_LAYOUT_4F2R 0x0942042
324 #define HB_INPUT_CH_LAYOUT_HAS_LFE 0x0000100
326 /* define some macros to extract the various information from the HB_AMIXDOWN_XXXX values */
327 #define HB_INPUT_CH_LAYOUT_GET_DISCRETE_FRONT_COUNT( a ) ( ( a & HB_INPUT_CH_LAYOUT_DISCRETE_FRONT_MASK ) >> 16 )
328 #define HB_INPUT_CH_LAYOUT_GET_DISCRETE_REAR_COUNT( a ) ( ( a & HB_INPUT_CH_LAYOUT_DISCRETE_REAR_MASK ) >> 12 )
329 #define HB_INPUT_CH_LAYOUT_GET_DISCRETE_LFE_COUNT( a ) ( ( a & HB_INPUT_CH_LAYOUT_DISCRETE_LFE_MASK ) >> 8 )
330 #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 ) )
331 #define HB_INPUT_CH_LAYOUT_GET_ENCODED_FRONT_COUNT( a ) ( ( a & HB_INPUT_CH_LAYOUT_ENCODED_FRONT_MASK ) >> 4 )
332 #define HB_INPUT_CH_LAYOUT_GET_ENCODED_REAR_COUNT( a ) ( ( a & HB_INPUT_CH_LAYOUT_ENCODED_REAR_MASK ) )
334 /* input_channel_layout is the channel layout of this audio */
335 /* this is used to provide a common way of describing the source audio */
336 int input_channel_layout;
340 hb_fifo_t * fifo_in; /* AC3/MPEG/LPCM ES */
341 hb_fifo_t * fifo_raw; /* Raw audio */
342 hb_fifo_t * fifo_sync; /* Resampled, synced raw audio */
343 hb_fifo_t * fifo_out; /* MP3/AAC/Vorbis ES */
345 hb_esconfig_t config;
346 hb_mux_data_t * mux_data;
348 /* amixdown is the mixdown format to be used for this audio track */
351 /* Source PID is only valid for MPEG Transport Streams */
365 /* Visual-friendly duration */
370 /* Exact duration (in 1/90000s) */
373 /* Optional chapter title */
383 int hits; /* How many hits/occurrences of this subtitle */
384 int forced_hits; /* How many forced hits in this subtitle */
388 hb_fifo_t * fifo_in; /* SPU ES */
389 hb_fifo_t * fifo_raw; /* Decodec SPU */
406 /* Visual-friendly duration */
411 /* Exact duration (in 1/90000s) */
421 uint32_t palette[16];
423 hb_list_t * list_chapter;
424 hb_list_t * list_audio;
425 hb_list_t * list_subtitle;
427 /* Job template for this title */
434 #define HB_STATE_IDLE 1
435 #define HB_STATE_SCANNING 2
436 #define HB_STATE_SCANDONE 4
437 #define HB_STATE_WORKING 8
438 #define HB_STATE_PAUSED 16
439 #define HB_STATE_WORKDONE 32
440 #define HB_STATE_MUXING 64
447 /* HB_STATE_SCANNING */
454 /* HB_STATE_WORKING */
467 /* HB_STATE_WORKDONE */
468 #define HB_ERROR_NONE 0
469 #define HB_ERROR_CANCELED 1
470 #define HB_ERROR_UNKNOWN 2
476 /* HB_STATE_MUXING */
482 struct hb_work_object_s
488 int (* init) ( hb_work_object_t *, hb_job_t * );
489 int (* work) ( hb_work_object_t *, hb_buffer_t **,
491 void (* close) ( hb_work_object_t * );
494 hb_fifo_t * fifo_out;
495 hb_esconfig_t * config;
497 /* amixdown is the mixdown format to be used if the work object is an audio track */
499 /* source_acodec is the source audio codec if the work object is an audio track */
502 hb_work_private_t * private_data;
504 hb_thread_t * thread;
507 hb_work_object_t * next;
508 int thread_sleep_interval;
512 extern hb_work_object_t hb_sync;
513 extern hb_work_object_t hb_decmpeg2;
514 extern hb_work_object_t hb_decsub;
515 extern hb_work_object_t hb_render;
516 extern hb_work_object_t hb_encavcodec;
517 extern hb_work_object_t hb_encxvid;
518 extern hb_work_object_t hb_encx264;
519 extern hb_work_object_t hb_deca52;
520 extern hb_work_object_t hb_decdca;
521 extern hb_work_object_t hb_decavcodec;
522 extern hb_work_object_t hb_declpcm;
523 extern hb_work_object_t hb_encfaac;
524 extern hb_work_object_t hb_enclame;
525 extern hb_work_object_t hb_encvorbis;
528 #define FILTER_DELAY 1
529 #define FILTER_FAILED 2
530 #define FILTER_DROP 3
532 struct hb_filter_object_s
539 hb_filter_private_t* (* init) ( int, int, int, char * );
541 int (* work) ( const hb_buffer_t *, hb_buffer_t **,
542 int, int, int, hb_filter_private_t * );
544 void (* close) ( hb_filter_private_t * );
546 hb_filter_private_t * private_data;
547 //hb_buffer_t * buffer;
551 extern hb_filter_object_t hb_filter_detelecine;
552 extern hb_filter_object_t hb_filter_deinterlace;
553 extern hb_filter_object_t hb_filter_deblock;
554 extern hb_filter_object_t hb_filter_denoise;
556 typedef void hb_error_handler_t( const char *errmsg );
558 extern void hb_register_error_handler( hb_error_handler_t * handler );