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 ) )
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_subtitle_s hb_subtitle_t
;
43 typedef struct hb_state_s hb_state_t
;
44 typedef union hb_esconfig_u hb_esconfig_t
;
45 typedef struct hb_work_private_s hb_work_private_t
;
46 typedef struct hb_work_object_s hb_work_object_t
;
47 typedef struct hb_filter_private_s hb_filter_private_t
;
48 typedef struct hb_filter_object_s hb_filter_object_t
;
49 typedef struct hb_buffer_s hb_buffer_t
;
50 typedef struct hb_fifo_s hb_fifo_t
;
51 typedef struct hb_lock_s hb_lock_t
;
58 hb_list_t
* hb_list_init();
59 int hb_list_count( hb_list_t
* );
60 void hb_list_add( hb_list_t
*, void * );
61 void hb_list_rem( hb_list_t
*, void * );
62 void * hb_list_item( hb_list_t
*, int );
63 void hb_list_close( hb_list_t
** );
65 void hb_reduce( int *x
, int *y
, int num
, int den
);
67 #define HB_KEEP_WIDTH 0
68 #define HB_KEEP_HEIGHT 1
69 void hb_fix_aspect( hb_job_t
* job
, int keep
);
71 int hb_calc_bitrate( hb_job_t
*, int size
);
81 char * human_readable_name
;
87 #define HB_ASPECT_BASE 9
88 #define HB_VIDEO_RATE_BASE 27000000
90 extern hb_rate_t hb_video_rates
[];
91 extern int hb_video_rates_count
;
92 extern hb_rate_t hb_audio_rates
[];
93 extern int hb_audio_rates_count
;
94 extern int hb_audio_rates_default
;
95 extern hb_rate_t hb_audio_bitrates
[];
96 extern int hb_audio_bitrates_count
;
97 extern int hb_audio_bitrates_default
;
98 extern hb_mixdown_t hb_audio_mixdowns
[];
99 extern int hb_audio_mixdowns_count
;
100 int hb_mixdown_get_mixdown_from_short_name( const char * short_name
);
101 const char * hb_mixdown_get_short_name_from_mixdown( int amixdown
);
103 /******************************************************************************
104 * hb_job_t: settings to be filled by the UI
105 *****************************************************************************/
108 /* ID assigned by UI so it can groups job passes together */
111 /* Pointer to the title to be ripped */
114 /* Chapter selection */
118 /* Include chapter marker track in mp4? */
122 crop: must be multiples of 2 (top/bottom/left/right)
124 width: must be a multiple of 16
125 height: must be a multiple of 16
126 keep_ratio: used by UIs
127 pixel_ratio: store pixel aspect ratio in the video
128 pixel_aspect_width: numerator for pixel aspect ratio
129 pixel_aspect_height: denominator for pixel aspect ratio
130 maxWidth: keep width below this
131 maxHeight: keep height below this */
141 int pixel_aspect_width
;
142 int pixel_aspect_height
;
150 vquality: output quality (0.0..1.0)
151 if < 0.0 or > 1.0, bitrate is used instead
152 vbitrate: output bitrate (kbps)
153 pass: 0, 1 or 2 (or -1 for scan)
154 vrate, vrate_base: output framerate is vrate / vrate_base
155 h264_level: boolean for whether or not we're encoding for iPod
156 crf: boolean for whether to use constant rate factor with x264
157 x264opts: string of extra x264 options
158 areBframes: boolean to note if b-frames are included in x264opts */
159 #define HB_VCODEC_MASK 0x0000FF
160 #define HB_VCODEC_FFMPEG 0x000001
161 #define HB_VCODEC_XVID 0x000002
162 #define HB_VCODEC_X264 0x000004
178 audios: Indexes in hb_title_t's audios list, starting from 0.
179 -1 indicates the end of the list
180 audio_mixdowns: The mixdown to be used for each audio track in audios[] */
182 /* define some masks, used to extract the various information from the HB_AMIXDOWN_XXXX values */
183 #define HB_AMIXDOWN_DCA_FORMAT_MASK 0x00FFF000
184 #define HB_AMIXDOWN_A52_FORMAT_MASK 0x00000FF0
185 #define HB_AMIXDOWN_DISCRETE_CHANNEL_COUNT_MASK 0x0000000F
187 /* define the HB_AMIXDOWN_XXXX values */
189 #define HB_AMIXDOWN_MONO 0x01000001
190 // DCA_FORMAT of DCA_MONO = 0 = 0x000
191 // A52_FORMAT of A52_MONO = 1 = 0x01
192 // discrete channel count of 1
194 #define HB_AMIXDOWN_STEREO 0x02002022
195 // DCA_FORMAT of DCA_STEREO = 2 = 0x002
196 // A52_FORMAT of A52_STEREO = 2 = 0x02
197 // discrete channel count of 2
199 #define HB_AMIXDOWN_DOLBY 0x042070A2
200 // DCA_FORMAT of DCA_3F1R | DCA_OUT_DPLI = 519 = 0x207
201 // A52_FORMAT of A52_DOLBY = 10 = 0x0A
202 // discrete channel count of 2
204 #define HB_AMIXDOWN_DOLBYPLII 0x084094A2
205 // DCA_FORMAT of DCA_3F2R | DCA_OUT_DPLII = 1033 = 0x409
206 // A52_FORMAT of A52_DOLBY | A52_USE_DPLII = 74 = 0x4A
207 // discrete channel count of 2
209 #define HB_AMIXDOWN_6CH 0x10089176
210 // DCA_FORMAT of DCA_3F2R | DCA_LFE = 137 = 0x089
211 // A52_FORMAT of A52_3F2R | A52_LFE = 23 = 0x17
212 // discrete channel count of 6
214 /* define some macros to extract the various information from the HB_AMIXDOWN_XXXX values */
215 #define HB_AMIXDOWN_GET_DCA_FORMAT( a ) ( ( a & HB_AMIXDOWN_DCA_FORMAT_MASK ) >> 12 )
216 #define HB_AMIXDOWN_GET_A52_FORMAT( a ) ( ( a & HB_AMIXDOWN_A52_FORMAT_MASK ) >> 4 )
217 #define HB_AMIXDOWN_GET_DISCRETE_CHANNEL_COUNT( a ) ( ( a & HB_AMIXDOWN_DISCRETE_CHANNEL_COUNT_MASK ) )
220 int audio_mixdowns
[8];
224 abitrate: output bitrate (kbps)
225 arate: output samplerate (Hz)
226 HB_ACODEC_AC3 means pass-through, then abitrate and arate are
228 #define HB_ACODEC_MASK 0x00FF00
229 #define HB_ACODEC_FAAC 0x000100
230 #define HB_ACODEC_LAME 0x000200
231 #define HB_ACODEC_VORBIS 0x000400
232 #define HB_ACODEC_AC3 0x000800
233 #define HB_ACODEC_MPGA 0x001000
234 #define HB_ACODEC_LPCM 0x002000
235 #define HB_ACODEC_DCA 0x004000
240 /* Subtitle settings:
241 subtitle: index in hb_title_t's subtitles list, starting
242 from 0. -1 means no subtitle */
244 int subtitleSmartAdjust
;
247 mux: output file format
249 #define HB_MUX_MASK 0xFF0000
250 #define HB_MUX_MP4 0x010000
251 #define HB_MUX_PSP 0x020000
252 #define HB_MUX_AVI 0x040000
253 #define HB_MUX_OGM 0x080000
254 #define HB_MUX_IPOD 0x100000
255 #define HB_MUX_MKV 0x200000
260 /* Allow MP4 files > 4 gigs */
265 hb_subtitle_t
** select_subtitle
;
267 char * native_language
;
276 hb_fifo_t
* fifo_mpeg2
; /* MPEG-2 video ES */
277 hb_fifo_t
* fifo_raw
; /* Raw pictures */
278 hb_fifo_t
* fifo_sync
; /* Raw pictures, framerate corrected */
279 hb_fifo_t
* fifo_render
; /* Raw pictures, scaled */
280 hb_fifo_t
* fifo_mpeg4
; /* MPEG-4 video ES */
282 hb_thread_t
* reader
;
285 hb_list_t
* list_work
;
287 hb_esconfig_t config
;
289 hb_mux_data_t
* mux_data
;
297 char lang_simple
[1024];
303 /* ac3flags is only set when the source audio format is HB_ACODEC_AC3 */
306 /* dcaflags is only set when the source audio format is HB_ACODEC_DCA */
309 /* define some masks, used to extract the various information from the HB_AMIXDOWN_XXXX values */
310 #define HB_INPUT_CH_LAYOUT_DISCRETE_FRONT_MASK 0x00F0000
311 #define HB_INPUT_CH_LAYOUT_DISCRETE_REAR_MASK 0x000F000
312 #define HB_INPUT_CH_LAYOUT_DISCRETE_LFE_MASK 0x0000F00
313 #define HB_INPUT_CH_LAYOUT_DISCRETE_NO_LFE_MASK 0xFFFF0FF
314 #define HB_INPUT_CH_LAYOUT_ENCODED_FRONT_MASK 0x00000F0
315 #define HB_INPUT_CH_LAYOUT_ENCODED_REAR_MASK 0x000000F
317 /* define the input channel layouts used to describe the channel layout of this audio */
318 #define HB_INPUT_CH_LAYOUT_MONO 0x0110010
319 #define HB_INPUT_CH_LAYOUT_STEREO 0x0220020
320 #define HB_INPUT_CH_LAYOUT_DOLBY 0x0320031
321 #define HB_INPUT_CH_LAYOUT_3F 0x0430030
322 #define HB_INPUT_CH_LAYOUT_2F1R 0x0521021
323 #define HB_INPUT_CH_LAYOUT_3F1R 0x0631031
324 #define HB_INPUT_CH_LAYOUT_2F2R 0x0722022
325 #define HB_INPUT_CH_LAYOUT_3F2R 0x0832032
326 #define HB_INPUT_CH_LAYOUT_4F2R 0x0942042
327 #define HB_INPUT_CH_LAYOUT_HAS_LFE 0x0000100
329 /* define some macros to extract the various information from the HB_AMIXDOWN_XXXX values */
330 #define HB_INPUT_CH_LAYOUT_GET_DISCRETE_FRONT_COUNT( a ) ( ( a & HB_INPUT_CH_LAYOUT_DISCRETE_FRONT_MASK ) >> 16 )
331 #define HB_INPUT_CH_LAYOUT_GET_DISCRETE_REAR_COUNT( a ) ( ( a & HB_INPUT_CH_LAYOUT_DISCRETE_REAR_MASK ) >> 12 )
332 #define HB_INPUT_CH_LAYOUT_GET_DISCRETE_LFE_COUNT( a ) ( ( a & HB_INPUT_CH_LAYOUT_DISCRETE_LFE_MASK ) >> 8 )
333 #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 ) )
334 #define HB_INPUT_CH_LAYOUT_GET_ENCODED_FRONT_COUNT( a ) ( ( a & HB_INPUT_CH_LAYOUT_ENCODED_FRONT_MASK ) >> 4 )
335 #define HB_INPUT_CH_LAYOUT_GET_ENCODED_REAR_COUNT( a ) ( ( a & HB_INPUT_CH_LAYOUT_ENCODED_REAR_MASK ) )
337 /* input_channel_layout is the channel layout of this audio */
338 /* this is used to provide a common way of describing the source audio */
339 int input_channel_layout
;
343 hb_fifo_t
* fifo_in
; /* AC3/MPEG/LPCM ES */
344 hb_fifo_t
* fifo_raw
; /* Raw audio */
345 hb_fifo_t
* fifo_sync
; /* Resampled, synced raw audio */
346 hb_fifo_t
* fifo_out
; /* MP3/AAC/Vorbis ES */
348 hb_esconfig_t config
;
349 hb_mux_data_t
* mux_data
;
351 /* amixdown is the mixdown format to be used for this audio track */
354 /* Source PID is only valid for MPEG Transport Streams */
368 /* Visual-friendly duration */
373 /* Exact duration (in 1/90000s) */
376 /* Optional chapter title */
386 int hits
; /* How many hits/occurrences of this subtitle */
387 int forced_hits
; /* How many forced hits in this subtitle */
391 hb_fifo_t
* fifo_in
; /* SPU ES */
392 hb_fifo_t
* fifo_raw
; /* Decodec SPU */
409 /* Visual-friendly duration */
414 /* Exact duration (in 1/90000s) */
424 uint32_t palette
[16];
426 hb_list_t
* list_chapter
;
427 hb_list_t
* list_audio
;
428 hb_list_t
* list_subtitle
;
430 /* Job template for this title */
437 #define HB_STATE_IDLE 1
438 #define HB_STATE_SCANNING 2
439 #define HB_STATE_SCANDONE 4
440 #define HB_STATE_WORKING 8
441 #define HB_STATE_PAUSED 16
442 #define HB_STATE_WORKDONE 32
443 #define HB_STATE_MUXING 64
450 /* HB_STATE_SCANNING */
457 /* HB_STATE_WORKING */
470 /* HB_STATE_WORKDONE */
471 #define HB_ERROR_NONE 0
472 #define HB_ERROR_CANCELED 1
473 #define HB_ERROR_UNKNOWN 2
479 /* HB_STATE_MUXING */
485 struct hb_work_object_s
491 int (* init
) ( hb_work_object_t
*, hb_job_t
* );
492 int (* work
) ( hb_work_object_t
*, hb_buffer_t
**,
494 void (* close
) ( hb_work_object_t
* );
497 hb_fifo_t
* fifo_out
;
498 hb_esconfig_t
* config
;
500 /* amixdown is the mixdown format to be used if the work object is an audio track */
502 /* source_acodec is the source audio codec if the work object is an audio track */
505 hb_work_private_t
* private_data
;
507 hb_thread_t
* thread
;
510 hb_work_object_t
* next
;
511 int thread_sleep_interval
;
515 extern hb_work_object_t hb_sync
;
516 extern hb_work_object_t hb_decmpeg2
;
517 extern hb_work_object_t hb_decsub
;
518 extern hb_work_object_t hb_render
;
519 extern hb_work_object_t hb_encavcodec
;
520 extern hb_work_object_t hb_encxvid
;
521 extern hb_work_object_t hb_encx264
;
522 extern hb_work_object_t hb_deca52
;
523 extern hb_work_object_t hb_decdca
;
524 extern hb_work_object_t hb_decavcodec
;
525 extern hb_work_object_t hb_declpcm
;
526 extern hb_work_object_t hb_encfaac
;
527 extern hb_work_object_t hb_enclame
;
528 extern hb_work_object_t hb_encvorbis
;
531 #define FILTER_DELAY 1
532 #define FILTER_FAILED 2
533 #define FILTER_DROP 3
535 struct hb_filter_object_s
542 hb_filter_private_t
* (* init
) ( int, int, int, char * );
544 int (* work
) ( const hb_buffer_t
*, hb_buffer_t
**,
545 int, int, int, hb_filter_private_t
* );
547 void (* close
) ( hb_filter_private_t
* );
549 hb_filter_private_t
* private_data
;
550 //hb_buffer_t * buffer;
554 extern hb_filter_object_t hb_filter_detelecine
;
555 extern hb_filter_object_t hb_filter_deinterlace
;
556 extern hb_filter_object_t hb_filter_deblock
;
557 extern hb_filter_object_t hb_filter_denoise
;
559 typedef void hb_error_handler_t( const char *errmsg
);
561 extern void hb_register_error_handler( hb_error_handler_t
* handler
);