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_buffer_s hb_buffer_t;
47 typedef struct hb_fifo_s hb_fifo_t;
48 typedef struct hb_lock_s hb_lock_t;
55 hb_list_t * hb_list_init();
56 int hb_list_count( hb_list_t * );
57 void hb_list_add( hb_list_t *, void * );
58 void hb_list_rem( hb_list_t *, void * );
59 void * hb_list_item( hb_list_t *, int );
60 void hb_list_close( hb_list_t ** );
62 void hb_reduce( int *x, int *y, int num, int den );
64 #define HB_KEEP_WIDTH 0
65 #define HB_KEEP_HEIGHT 1
66 void hb_fix_aspect( hb_job_t * job, int keep );
68 int hb_calc_bitrate( hb_job_t *, int size );
78 char * human_readable_name;
84 #define HB_ASPECT_BASE 9
85 #define HB_VIDEO_RATE_BASE 27000000
87 extern hb_rate_t hb_video_rates[];
88 extern int hb_video_rates_count;
89 extern hb_rate_t hb_audio_rates[];
90 extern int hb_audio_rates_count;
91 extern int hb_audio_rates_default;
92 extern hb_rate_t hb_audio_bitrates[];
93 extern int hb_audio_bitrates_count;
94 extern int hb_audio_bitrates_default;
95 extern hb_mixdown_t hb_audio_mixdowns[];
96 extern int hb_audio_mixdowns_count;
97 int hb_mixdown_get_mixdown_from_short_name( const char * short_name );
98 const char * hb_mixdown_get_short_name_from_mixdown( int amixdown );
100 /******************************************************************************
101 * hb_job_t: settings to be filled by the UI
102 *****************************************************************************/
105 /* Pointer to the title to be ripped */
108 /* Chapter selection */
112 /* Include chapter marker track in mp4? */
116 crop: must be multiples of 2 (top/bottom/left/right)
118 width: must be a multiple of 16
119 height: must be a multiple of 16
120 keep_ratio: used by UIs
121 pixel_ratio: store pixel aspect ratio in the video
122 pixel_aspect_width: numerator for pixel aspect ratio
123 pixel_aspect_height: denominator for pixel aspect ratio
124 maxWidth: keep width below this
125 maxHeight: keep height below this */
134 int pixel_aspect_width;
135 int pixel_aspect_height;
142 vquality: output quality (0.0..1.0)
143 if < 0.0 or > 1.0, bitrate is used instead
144 vbitrate: output bitrate (kbps)
146 vrate, vrate_base: output framerate is vrate / vrate_base
147 h264_level: boolean for whether or not we're encoding for iPod
148 crf: boolean for whether to use constant rate factor with x264
149 x264opts: string of extra x264 options
150 areBframes: boolean to note if b-frames are included in x264opts */
151 #define HB_VCODEC_MASK 0x0000FF
152 #define HB_VCODEC_FFMPEG 0x000001
153 #define HB_VCODEC_XVID 0x000002
154 #define HB_VCODEC_X264 0x000004
169 audios: Indexes in hb_title_t's audios list, starting from 0.
170 -1 indicates the end of the list
171 audio_mixdowns: The mixdown to be used for each audio track in audios[] */
173 /* define some masks, used to extract the various information from the HB_AMIXDOWN_XXXX values */
174 #define HB_AMIXDOWN_DCA_FORMAT_MASK 0x00FFF000
175 #define HB_AMIXDOWN_A52_FORMAT_MASK 0x00000FF0
176 #define HB_AMIXDOWN_DISCRETE_CHANNEL_COUNT_MASK 0x0000000F
178 /* define the HB_AMIXDOWN_XXXX values */
180 #define HB_AMIXDOWN_MONO 0x01000001
181 // DCA_FORMAT of DCA_MONO = 0 = 0x000
182 // A52_FORMAT of A52_MONO = 1 = 0x01
183 // discrete channel count of 1
185 #define HB_AMIXDOWN_STEREO 0x02002022
186 // DCA_FORMAT of DCA_STEREO = 2 = 0x002
187 // A52_FORMAT of A52_STEREO = 2 = 0x02
188 // discrete channel count of 2
190 #define HB_AMIXDOWN_DOLBY 0x042070A2
191 // DCA_FORMAT of DCA_3F1R | DCA_OUT_DPLI = 519 = 0x207
192 // A52_FORMAT of A52_DOLBY = 10 = 0x0A
193 // discrete channel count of 2
195 #define HB_AMIXDOWN_DOLBYPLII 0x084094A2
196 // DCA_FORMAT of DCA_3F2R | DCA_OUT_DPLII = 1033 = 0x409
197 // A52_FORMAT of A52_DOLBY | A52_USE_DPLII = 74 = 0x4A
198 // discrete channel count of 2
200 #define HB_AMIXDOWN_6CH 0x10089176
201 // DCA_FORMAT of DCA_3F2R | DCA_LFE = 137 = 0x089
202 // A52_FORMAT of A52_3F2R | A52_LFE = 23 = 0x17
203 // discrete channel count of 6
205 /* define some macros to extract the various information from the HB_AMIXDOWN_XXXX values */
206 #define HB_AMIXDOWN_GET_DCA_FORMAT( a ) ( ( a & HB_AMIXDOWN_DCA_FORMAT_MASK ) >> 12 )
207 #define HB_AMIXDOWN_GET_A52_FORMAT( a ) ( ( a & HB_AMIXDOWN_A52_FORMAT_MASK ) >> 4 )
208 #define HB_AMIXDOWN_GET_DISCRETE_CHANNEL_COUNT( a ) ( ( a & HB_AMIXDOWN_DISCRETE_CHANNEL_COUNT_MASK ) )
211 int audio_mixdowns[8];
215 abitrate: output bitrate (kbps)
216 arate: output samplerate (Hz)
217 HB_ACODEC_AC3 means pass-through, then abitrate and arate are
219 #define HB_ACODEC_MASK 0x00FF00
220 #define HB_ACODEC_FAAC 0x000100
221 #define HB_ACODEC_LAME 0x000200
222 #define HB_ACODEC_VORBIS 0x000400
223 #define HB_ACODEC_AC3 0x000800
224 #define HB_ACODEC_MPGA 0x001000
225 #define HB_ACODEC_LPCM 0x002000
226 #define HB_ACODEC_DCA 0x004000
231 /* Subtitle settings:
232 subtitle: index in hb_title_t's subtitles list, starting
233 from 0. -1 means no subtitle */
235 int subtitleSmartAdjust;
238 mux: output file format
240 #define HB_MUX_MASK 0xFF0000
241 #define HB_MUX_MP4 0x010000
242 #define HB_MUX_PSP 0x020000
243 #define HB_MUX_AVI 0x040000
244 #define HB_MUX_OGM 0x080000
245 #define HB_MUX_IPOD 0x100000
250 /* Allow MP4 files > 4 gigs */
255 hb_subtitle_t ** select_subtitle;
256 char * native_language;
265 hb_fifo_t * fifo_mpeg2; /* MPEG-2 video ES */
266 hb_fifo_t * fifo_raw; /* Raw pictures */
267 hb_fifo_t * fifo_sync; /* Raw pictures, framerate corrected */
268 hb_fifo_t * fifo_render; /* Raw pictures, scaled */
269 hb_fifo_t * fifo_mpeg4; /* MPEG-4 video ES */
271 hb_thread_t * reader;
274 hb_list_t * list_work;
276 hb_esconfig_t config;
278 hb_mux_data_t * mux_data;
286 char lang_simple[1024];
292 /* ac3flags is only set when the source audio format is HB_ACODEC_AC3 */
295 /* dcaflags is only set when the source audio format is HB_ACODEC_DCA */
298 /* define some masks, used to extract the various information from the HB_AMIXDOWN_XXXX values */
299 #define HB_INPUT_CH_LAYOUT_DISCRETE_FRONT_MASK 0x00F0000
300 #define HB_INPUT_CH_LAYOUT_DISCRETE_REAR_MASK 0x000F000
301 #define HB_INPUT_CH_LAYOUT_DISCRETE_LFE_MASK 0x0000F00
302 #define HB_INPUT_CH_LAYOUT_DISCRETE_NO_LFE_MASK 0xFFFF0FF
303 #define HB_INPUT_CH_LAYOUT_ENCODED_FRONT_MASK 0x00000F0
304 #define HB_INPUT_CH_LAYOUT_ENCODED_REAR_MASK 0x000000F
306 /* define the input channel layouts used to describe the channel layout of this audio */
307 #define HB_INPUT_CH_LAYOUT_MONO 0x0110010
308 #define HB_INPUT_CH_LAYOUT_STEREO 0x0220020
309 #define HB_INPUT_CH_LAYOUT_DOLBY 0x0320031
310 #define HB_INPUT_CH_LAYOUT_3F 0x0430030
311 #define HB_INPUT_CH_LAYOUT_2F1R 0x0521021
312 #define HB_INPUT_CH_LAYOUT_3F1R 0x0631031
313 #define HB_INPUT_CH_LAYOUT_2F2R 0x0722022
314 #define HB_INPUT_CH_LAYOUT_3F2R 0x0832032
315 #define HB_INPUT_CH_LAYOUT_4F2R 0x0942042
316 #define HB_INPUT_CH_LAYOUT_HAS_LFE 0x0000100
318 /* define some macros to extract the various information from the HB_AMIXDOWN_XXXX values */
319 #define HB_INPUT_CH_LAYOUT_GET_DISCRETE_FRONT_COUNT( a ) ( ( a & HB_INPUT_CH_LAYOUT_DISCRETE_FRONT_MASK ) >> 16 )
320 #define HB_INPUT_CH_LAYOUT_GET_DISCRETE_REAR_COUNT( a ) ( ( a & HB_INPUT_CH_LAYOUT_DISCRETE_REAR_MASK ) >> 12 )
321 #define HB_INPUT_CH_LAYOUT_GET_DISCRETE_LFE_COUNT( a ) ( ( a & HB_INPUT_CH_LAYOUT_DISCRETE_LFE_MASK ) >> 8 )
322 #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 ) )
323 #define HB_INPUT_CH_LAYOUT_GET_ENCODED_FRONT_COUNT( a ) ( ( a & HB_INPUT_CH_LAYOUT_ENCODED_FRONT_MASK ) >> 4 )
324 #define HB_INPUT_CH_LAYOUT_GET_ENCODED_REAR_COUNT( a ) ( ( a & HB_INPUT_CH_LAYOUT_ENCODED_REAR_MASK ) )
326 /* input_channel_layout is the channel layout of this audio */
327 /* this is used to provide a common way of describing the source audio */
328 int input_channel_layout;
332 hb_fifo_t * fifo_in; /* AC3/MPEG/LPCM ES */
333 hb_fifo_t * fifo_raw; /* Raw audio */
334 hb_fifo_t * fifo_sync; /* Resampled, synced raw audio */
335 hb_fifo_t * fifo_out; /* MP3/AAC/Vorbis ES */
337 hb_esconfig_t config;
338 hb_mux_data_t * mux_data;
340 /* amixdown is the mixdown format to be used for this audio track */
343 /* Source PID is only valid for MPEG Transport Streams */
357 /* Visual-friendly duration */
362 /* Exact duration (in 1/90000s) */
365 /* Optional chapter title */
375 int hits; /* How many hits/occurrences of this subtitle */
379 hb_fifo_t * fifo_in; /* SPU ES */
380 hb_fifo_t * fifo_raw; /* Decodec SPU */
397 /* Visual-friendly duration */
402 /* Exact duration (in 1/90000s) */
412 uint32_t palette[16];
414 hb_list_t * list_chapter;
415 hb_list_t * list_audio;
416 hb_list_t * list_subtitle;
418 /* Job template for this title */
425 #define HB_STATE_IDLE 1
426 #define HB_STATE_SCANNING 2
427 #define HB_STATE_SCANDONE 4
428 #define HB_STATE_WORKING 8
429 #define HB_STATE_PAUSED 16
430 #define HB_STATE_WORKDONE 32
431 #define HB_STATE_MUXING 64
438 /* HB_STATE_SCANNING */
445 /* HB_STATE_WORKING */
458 /* HB_STATE_WORKDONE */
459 #define HB_ERROR_NONE 0
460 #define HB_ERROR_CANCELED 1
461 #define HB_ERROR_UNKNOWN 2
467 /* HB_STATE_MUXING */
473 struct hb_work_object_s
479 int (* init) ( hb_work_object_t *, hb_job_t * );
480 int (* work) ( hb_work_object_t *, hb_buffer_t **,
482 void (* close) ( hb_work_object_t * );
485 hb_fifo_t * fifo_out;
486 hb_esconfig_t * config;
488 /* amixdown is the mixdown format to be used if the work object is an audio track */
490 /* source_acodec is the source audio codec if the work object is an audio track */
493 hb_work_private_t * private_data;
495 hb_thread_t * thread;
498 hb_work_object_t * next;
499 int thread_sleep_interval;
503 extern hb_work_object_t hb_sync;
504 extern hb_work_object_t hb_decmpeg2;
505 extern hb_work_object_t hb_decsub;
506 extern hb_work_object_t hb_render;
507 extern hb_work_object_t hb_encavcodec;
508 extern hb_work_object_t hb_encxvid;
509 extern hb_work_object_t hb_encx264;
510 extern hb_work_object_t hb_deca52;
511 extern hb_work_object_t hb_decdca;
512 extern hb_work_object_t hb_decavcodec;
513 extern hb_work_object_t hb_declpcm;
514 extern hb_work_object_t hb_encfaac;
515 extern hb_work_object_t hb_enclame;
516 extern hb_work_object_t hb_encvorbis;