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 typedef struct hb_handle_s hb_handle_t;
32 typedef struct hb_list_s hb_list_t;
33 typedef struct hb_rate_s hb_rate_t;
34 typedef struct hb_mixdown_s hb_mixdown_t;
35 typedef struct hb_job_s hb_job_t;
36 typedef struct hb_title_s hb_title_t;
37 typedef struct hb_chapter_s hb_chapter_t;
38 typedef struct hb_audio_s hb_audio_t;
39 typedef struct hb_subtitle_s hb_subtitle_t;
40 typedef struct hb_state_s hb_state_t;
41 typedef union hb_esconfig_u hb_esconfig_t;
42 typedef struct hb_work_private_s hb_work_private_t;
43 typedef struct hb_work_object_s hb_work_object_t;
44 typedef struct hb_buffer_s hb_buffer_t;
45 typedef struct hb_fifo_s hb_fifo_t;
46 typedef struct hb_lock_s hb_lock_t;
53 hb_list_t * hb_list_init();
54 int hb_list_count( hb_list_t * );
55 void hb_list_add( hb_list_t *, void * );
56 void hb_list_rem( hb_list_t *, void * );
57 void * hb_list_item( hb_list_t *, int );
58 void hb_list_close( hb_list_t ** );
60 void hb_reduce( int *x, int *y, int num, int den );
62 #define HB_KEEP_WIDTH 0
63 #define HB_KEEP_HEIGHT 1
64 void hb_fix_aspect( hb_job_t * job, int keep );
66 int hb_calc_bitrate( hb_job_t *, int size );
76 char * human_readable_name;
82 #define HB_ASPECT_BASE 9
83 #define HB_VIDEO_RATE_BASE 27000000
85 extern hb_rate_t hb_video_rates[];
86 extern int hb_video_rates_count;
87 extern hb_rate_t hb_audio_rates[];
88 extern int hb_audio_rates_count;
89 extern int hb_audio_rates_default;
90 extern hb_rate_t hb_audio_bitrates[];
91 extern int hb_audio_bitrates_count;
92 extern int hb_audio_bitrates_default;
93 extern hb_mixdown_t hb_audio_mixdowns[];
94 extern int hb_audio_mixdowns_count;
95 int hb_mixdown_get_mixdown_from_short_name( const char * short_name );
96 const char * hb_mixdown_get_short_name_from_mixdown( int amixdown );
98 /******************************************************************************
99 * hb_job_t: settings to be filled by the UI
100 *****************************************************************************/
103 /* Pointer to the title to be ripped */
106 /* Chapter selection */
110 /* Include chapter marker track in mp4? */
114 crop: must be multiples of 2 (top/bottom/left/right)
116 width: must be a multiple of 16
117 height: must be a multiple of 16
118 keep_ratio: used by UIs
119 pixel_ratio: store pixel aspect ratio in the video
120 pixel_aspect_width: numerator for pixel aspect ratio
121 pixel_aspect_height: denominator for pixel aspect ratio
122 maxWidth: keep width below this
123 maxHeight: keep height below this */
132 int pixel_aspect_width;
133 int pixel_aspect_height;
140 vquality: output quality (0.0..1.0)
141 if < 0.0 or > 1.0, bitrate is used instead
142 vbitrate: output bitrate (kbps)
144 vrate, vrate_base: output framerate is vrate / vrate_base
145 h264_level: boolean for whether or not we're encoding for iPod
146 crf: boolean for whether to use constant rate factor with x264
147 x264opts: string of extra x264 options
148 areBframes: boolean to note if b-frames are included in x264opts */
149 #define HB_VCODEC_MASK 0x0000FF
150 #define HB_VCODEC_FFMPEG 0x000001
151 #define HB_VCODEC_XVID 0x000002
152 #define HB_VCODEC_X264 0x000004
167 audios: Indexes in hb_title_t's audios list, starting from 0.
168 -1 indicates the end of the list
169 audio_mixdowns: The mixdown to be used for each audio track in audios[] */
171 /* define some masks, used to extract the various information from the HB_AMIXDOWN_XXXX values */
172 #define HB_AMIXDOWN_DCA_FORMAT_MASK 0x00FFF000
173 #define HB_AMIXDOWN_A52_FORMAT_MASK 0x00000FF0
174 #define HB_AMIXDOWN_DISCRETE_CHANNEL_COUNT_MASK 0x0000000F
176 /* define the HB_AMIXDOWN_XXXX values */
178 #define HB_AMIXDOWN_MONO 0x01000001
179 // DCA_FORMAT of DCA_MONO = 0 = 0x000
180 // A52_FORMAT of A52_MONO = 1 = 0x01
181 // discrete channel count of 1
183 #define HB_AMIXDOWN_STEREO 0x02002022
184 // DCA_FORMAT of DCA_STEREO = 2 = 0x002
185 // A52_FORMAT of A52_STEREO = 2 = 0x02
186 // discrete channel count of 2
188 #define HB_AMIXDOWN_DOLBY 0x042070A2
189 // DCA_FORMAT of DCA_3F1R | DCA_OUT_DPLI = 519 = 0x207
190 // A52_FORMAT of A52_DOLBY = 10 = 0x0A
191 // discrete channel count of 2
193 #define HB_AMIXDOWN_DOLBYPLII 0x084094A2
194 // DCA_FORMAT of DCA_3F2R | DCA_OUT_DPLII = 1033 = 0x409
195 // A52_FORMAT of A52_DOLBY | A52_USE_DPLII = 74 = 0x4A
196 // discrete channel count of 2
198 #define HB_AMIXDOWN_6CH 0x10089176
199 // DCA_FORMAT of DCA_3F2R | DCA_LFE = 137 = 0x089
200 // A52_FORMAT of A52_3F2R | A52_LFE = 23 = 0x17
201 // discrete channel count of 6
203 /* define some macros to extract the various information from the HB_AMIXDOWN_XXXX values */
204 #define HB_AMIXDOWN_GET_DCA_FORMAT( a ) ( ( a & HB_AMIXDOWN_DCA_FORMAT_MASK ) >> 12 )
205 #define HB_AMIXDOWN_GET_A52_FORMAT( a ) ( ( a & HB_AMIXDOWN_A52_FORMAT_MASK ) >> 4 )
206 #define HB_AMIXDOWN_GET_DISCRETE_CHANNEL_COUNT( a ) ( ( a & HB_AMIXDOWN_DISCRETE_CHANNEL_COUNT_MASK ) )
209 int audio_mixdowns[8];
213 abitrate: output bitrate (kbps)
214 arate: output samplerate (Hz)
215 HB_ACODEC_AC3 means pass-through, then abitrate and arate are
217 #define HB_ACODEC_MASK 0x00FF00
218 #define HB_ACODEC_FAAC 0x000100
219 #define HB_ACODEC_LAME 0x000200
220 #define HB_ACODEC_VORBIS 0x000400
221 #define HB_ACODEC_AC3 0x000800
222 #define HB_ACODEC_MPGA 0x001000
223 #define HB_ACODEC_LPCM 0x002000
224 #define HB_ACODEC_DCA 0x004000
229 /* Subtitle settings:
230 subtitle: index in hb_title_t's subtitles list, starting
231 from 0. -1 means no subtitle */
233 int subtitleSmartAdjust;
236 mux: output file format
238 #define HB_MUX_MASK 0xFF0000
239 #define HB_MUX_MP4 0x010000
240 #define HB_MUX_PSP 0x020000
241 #define HB_MUX_AVI 0x040000
242 #define HB_MUX_OGM 0x080000
243 #define HB_MUX_IPOD 0x100000
255 hb_fifo_t * fifo_mpeg2; /* MPEG-2 video ES */
256 hb_fifo_t * fifo_raw; /* Raw pictures */
257 hb_fifo_t * fifo_sync; /* Raw pictures, framerate corrected */
258 hb_fifo_t * fifo_render; /* Raw pictures, scaled */
259 hb_fifo_t * fifo_mpeg4; /* MPEG-4 video ES */
261 hb_thread_t * reader;
264 hb_list_t * list_work;
266 hb_esconfig_t config;
268 hb_mux_data_t * mux_data;
276 char lang_simple[1024];
281 /* src_discrete_front_channels: The # of discrete front channels in the source audio
282 src_discrete_rear_channels: The # of discrete rear channels in the source audio
283 src_discrete_lfe_channels: The # of discrete lfe channels in the source audio
284 src_encoded_front_channels: The # of front channels encoded into the source audio
285 src_encoded_rear_channels: The # of rear channels encoded into the source audio */
286 int src_discrete_front_channels;
287 int src_discrete_rear_channels;
288 int src_discrete_lfe_channels;
289 int src_encoded_front_channels;
290 int src_encoded_rear_channels;
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 0xF0000
300 #define HB_INPUT_CH_LAYOUT_DISCRETE_REAR_MASK 0x0F000
301 #define HB_INPUT_CH_LAYOUT_DISCRETE_LFE_MASK 0x00F00
302 #define HB_INPUT_CH_LAYOUT_ENCODED_FRONT_MASK 0x000F0
303 #define HB_INPUT_CH_LAYOUT_ENCODED_REAR_MASK 0x0000F
305 /* define the input channel layouts used to describe the channel layout of this audio */
306 #define HB_INPUT_CH_LAYOUT_MONO 0x0110010
307 #define HB_INPUT_CH_LAYOUT_STEREO 0x0220020
308 #define HB_INPUT_CH_LAYOUT_DOLBY 0x0320031
309 #define HB_INPUT_CH_LAYOUT_3F 0x0430030
310 #define HB_INPUT_CH_LAYOUT_2F1R 0x0521021
311 #define HB_INPUT_CH_LAYOUT_3F1R 0x0631031
312 #define HB_INPUT_CH_LAYOUT_2F2R 0x0722022
313 #define HB_INPUT_CH_LAYOUT_3F2R 0x0832032
314 #define HB_INPUT_CH_LAYOUT_3F2RLFE 0x0A32132
315 #define HB_INPUT_CH_LAYOUT_4F2R 0x0942042
317 /* define some macros to extract the various information from the HB_AMIXDOWN_XXXX values */
318 #define HB_INPUT_CH_LAYOUT_GET_DISCRETE_FRONT_COUNT( a ) ( ( a & HB_INPUT_CH_LAYOUT_DISCRETE_FRONT_MASK ) >> 16 )
319 #define HB_INPUT_CH_LAYOUT_GET_DISCRETE_REAR_COUNT( a ) ( ( a & HB_INPUT_CH_LAYOUT_DISCRETE_REAR_MASK ) >> 12 )
320 #define HB_INPUT_CH_LAYOUT_GET_DISCRETE_LFE_COUNT( a ) ( ( a & HB_INPUT_CH_LAYOUT_DISCRETE_LFE_MASK ) >> 8 )
321 #define HB_INPUT_CH_LAYOUT_GET_ENCODED_FRONT_COUNT( a ) ( ( a & HB_INPUT_CH_LAYOUT_ENCODED_FRONT_MASK ) >> 4 )
322 #define HB_INPUT_CH_LAYOUT_GET_ENCODED_REAR_COUNT( a ) ( ( a & HB_INPUT_CH_LAYOUT_ENCODED_REAR_MASK ) )
324 /* input_channel_layout is the channel layout of this audio */
325 /* this is used to provide a common way of describing the source audio */
326 int input_channel_layout;
330 hb_fifo_t * fifo_in; /* AC3/MPEG/LPCM ES */
331 hb_fifo_t * fifo_raw; /* Raw audio */
332 hb_fifo_t * fifo_sync; /* Resampled, synced raw audio */
333 hb_fifo_t * fifo_out; /* MP3/AAC/Vorbis ES */
335 hb_esconfig_t config;
336 hb_mux_data_t * mux_data;
338 /* amixdown is the mixdown format to be used for this audio track */
353 /* Visual-friendly duration */
358 /* Exact duration (in 1/90000s) */
361 /* Optional chapter title */
373 hb_fifo_t * fifo_in; /* SPU ES */
374 hb_fifo_t * fifo_raw; /* Decodec SPU */
391 /* Visual-friendly duration */
396 /* Exact duration (in 1/90000s) */
406 uint32_t palette[16];
408 hb_list_t * list_chapter;
409 hb_list_t * list_audio;
410 hb_list_t * list_subtitle;
412 /* Job template for this title */
419 #define HB_STATE_IDLE 1
420 #define HB_STATE_SCANNING 2
421 #define HB_STATE_SCANDONE 4
422 #define HB_STATE_WORKING 8
423 #define HB_STATE_PAUSED 16
424 #define HB_STATE_WORKDONE 32
425 #define HB_STATE_MUXING 64
432 /* HB_STATE_SCANNING */
439 /* HB_STATE_WORKING */
452 /* HB_STATE_WORKDONE */
453 #define HB_ERROR_NONE 0
454 #define HB_ERROR_CANCELED 1
455 #define HB_ERROR_UNKNOWN 2
461 /* HB_STATE_MUXING */
467 struct hb_work_object_s
473 int (* init) ( hb_work_object_t *, hb_job_t * );
474 int (* work) ( hb_work_object_t *, hb_buffer_t **,
476 void (* close) ( hb_work_object_t * );
479 hb_fifo_t * fifo_out;
480 hb_esconfig_t * config;
482 /* amixdown is the mixdown format to be used if the work object is an audio track */
485 hb_work_private_t * private_data;
487 hb_thread_t * thread;
490 hb_work_object_t * next;
491 int thread_sleep_interval;
495 extern hb_work_object_t hb_sync;
496 extern hb_work_object_t hb_decmpeg2;
497 extern hb_work_object_t hb_decsub;
498 extern hb_work_object_t hb_render;
499 extern hb_work_object_t hb_encavcodec;
500 extern hb_work_object_t hb_encxvid;
501 extern hb_work_object_t hb_encx264;
502 extern hb_work_object_t hb_deca52;
503 extern hb_work_object_t hb_decdca;
504 extern hb_work_object_t hb_decavcodec;
505 extern hb_work_object_t hb_declpcm;
506 extern hb_work_object_t hb_encfaac;
507 extern hb_work_object_t hb_enclame;
508 extern hb_work_object_t hb_encvorbis;