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_VIDEO_RATE_BASE 27000000
98 extern hb_rate_t hb_video_rates[];
99 extern int hb_video_rates_count;
100 extern hb_rate_t hb_audio_rates[];
101 extern int hb_audio_rates_count;
102 extern int hb_audio_rates_default;
103 extern hb_rate_t hb_audio_bitrates[];
104 extern int hb_audio_bitrates_count;
105 extern int hb_audio_bitrates_default;
106 extern hb_mixdown_t hb_audio_mixdowns[];
107 extern int hb_audio_mixdowns_count;
108 int hb_mixdown_get_mixdown_from_short_name( const char * short_name );
109 const char * hb_mixdown_get_short_name_from_mixdown( int amixdown );
111 /******************************************************************************
112 * hb_job_t: settings to be filled by the UI
113 *****************************************************************************/
116 /* ID assigned by UI so it can groups job passes together */
119 /* Pointer to the title to be ripped */
122 /* Chapter selection */
126 /* Include chapter marker track in mp4? */
130 crop: must be multiples of 2 (top/bottom/left/right)
132 width: must be a multiple of 16
133 height: must be a multiple of 16
134 keep_ratio: used by UIs
135 grayscale: black and white encoding
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 modulus: set a number besides 16 for dimensions to be multiples of
140 maxWidth: keep width below this
141 maxHeight: keep height below this */
150 int pixel_aspect_width;
151 int pixel_aspect_height;
158 vquality: output quality (0.0..1.0)
159 if < 0.0 or > 1.0, bitrate is used instead,
160 except with x264, to use its real QP/RF scale
161 vbitrate: output bitrate (kbps)
162 vrate, vrate_base: output framerate is vrate / vrate_base
163 vfr: boolean for variable frame rate detelecine
164 cfr: boolean to use constant frame rates instead of
165 passing through the source's frame durations.
166 pass: 0, 1 or 2 (or -1 for scan)
167 h264_level: vestigial boolean to decide if we're encoding for iPod
168 crf: boolean for whether to use constant rate factor with x264
169 x264opts: string of extra x264 options
170 areBframes: boolean to note if b-frames are included in x264opts */
171 #define HB_VCODEC_MASK 0x0000FF
172 #define HB_VCODEC_FFMPEG 0x000001
173 #define HB_VCODEC_XVID 0x000002
174 #define HB_VCODEC_X264 0x000004
175 #define HB_VCODEC_THEORA 0x000008
191 /* List of audio settings. */
192 hb_list_t * list_audio;
194 /* Subtitle settings:
195 subtitle: index in hb_title_t's subtitles list, starting
196 from 0. -1 means no subtitle */
198 int subtitleSmartAdjust;
201 mux: output file format
203 #define HB_MUX_MASK 0xFF0000
204 #define HB_MUX_MP4 0x010000
205 #define HB_MUX_PSP 0x020000
206 #define HB_MUX_AVI 0x040000
207 #define HB_MUX_OGM 0x080000
208 #define HB_MUX_IPOD 0x100000
209 #define HB_MUX_MKV 0x200000
214 /* Allow MP4 files > 4 gigs */
220 hb_subtitle_t ** select_subtitle;
222 char * native_language;
231 hb_fifo_t * fifo_mpeg2; /* MPEG-2 video ES */
232 hb_fifo_t * fifo_raw; /* Raw pictures */
233 hb_fifo_t * fifo_sync; /* Raw pictures, framerate corrected */
234 hb_fifo_t * fifo_render; /* Raw pictures, scaled */
235 hb_fifo_t * fifo_mpeg4; /* MPEG-4 video ES */
237 hb_thread_t * reader;
240 hb_list_t * list_work;
242 hb_esconfig_t config;
244 hb_mux_data_t * mux_data;
248 /* Audio starts here */
250 #define HB_ACODEC_MASK 0x00FF00
251 #define HB_ACODEC_FAAC 0x000100
252 #define HB_ACODEC_LAME 0x000200
253 #define HB_ACODEC_VORBIS 0x000400
254 #define HB_ACODEC_AC3 0x000800
255 #define HB_ACODEC_MPGA 0x001000
256 #define HB_ACODEC_LPCM 0x002000
257 #define HB_ACODEC_DCA 0x004000
258 #define HB_ACODEC_FFMPEG 0x008000
261 /* define some masks, used to extract the various information from the HB_AMIXDOWN_XXXX values */
262 #define HB_AMIXDOWN_DCA_FORMAT_MASK 0x00FFF000
263 #define HB_AMIXDOWN_A52_FORMAT_MASK 0x00000FF0
264 #define HB_AMIXDOWN_DISCRETE_CHANNEL_COUNT_MASK 0x0000000F
265 /* define the HB_AMIXDOWN_XXXX values */
266 #define HB_AMIXDOWN_MONO 0x01000001
267 // DCA_FORMAT of DCA_MONO = 0 = 0x000
268 // A52_FORMAT of A52_MONO = 1 = 0x01
269 // discrete channel count of 1
270 #define HB_AMIXDOWN_STEREO 0x02002022
271 // DCA_FORMAT of DCA_STEREO = 2 = 0x002
272 // A52_FORMAT of A52_STEREO = 2 = 0x02
273 // discrete channel count of 2
274 #define HB_AMIXDOWN_DOLBY 0x042070A2
275 // DCA_FORMAT of DCA_3F1R | DCA_OUT_DPLI = 519 = 0x207
276 // A52_FORMAT of A52_DOLBY = 10 = 0x0A
277 // discrete channel count of 2
278 #define HB_AMIXDOWN_DOLBYPLII 0x084094A2
279 // DCA_FORMAT of DCA_3F2R | DCA_OUT_DPLII = 1033 = 0x409
280 // A52_FORMAT of A52_DOLBY | A52_USE_DPLII = 74 = 0x4A
281 // discrete channel count of 2
282 #define HB_AMIXDOWN_6CH 0x10089176
283 // DCA_FORMAT of DCA_3F2R | DCA_LFE = 137 = 0x089
284 // A52_FORMAT of A52_3F2R | A52_LFE = 23 = 0x17
285 // discrete channel count of 6
286 /* define some macros to extract the various information from the HB_AMIXDOWN_XXXX values */
287 #define HB_AMIXDOWN_GET_DCA_FORMAT( a ) ( ( a & HB_AMIXDOWN_DCA_FORMAT_MASK ) >> 12 )
288 #define HB_AMIXDOWN_GET_A52_FORMAT( a ) ( ( a & HB_AMIXDOWN_A52_FORMAT_MASK ) >> 4 )
289 #define HB_AMIXDOWN_GET_DISCRETE_CHANNEL_COUNT( a ) ( ( a & HB_AMIXDOWN_DISCRETE_CHANNEL_COUNT_MASK ) )
291 /* Input Channel Layout */
292 /* define some masks, used to extract the various information from the HB_AMIXDOWN_XXXX values */
293 #define HB_INPUT_CH_LAYOUT_DISCRETE_FRONT_MASK 0x00F0000
294 #define HB_INPUT_CH_LAYOUT_DISCRETE_REAR_MASK 0x000F000
295 #define HB_INPUT_CH_LAYOUT_DISCRETE_LFE_MASK 0x0000F00
296 #define HB_INPUT_CH_LAYOUT_DISCRETE_NO_LFE_MASK 0xFFFF0FF
297 #define HB_INPUT_CH_LAYOUT_ENCODED_FRONT_MASK 0x00000F0
298 #define HB_INPUT_CH_LAYOUT_ENCODED_REAR_MASK 0x000000F
299 /* define the input channel layouts used to describe the channel layout of this audio */
300 #define HB_INPUT_CH_LAYOUT_MONO 0x0110010
301 #define HB_INPUT_CH_LAYOUT_STEREO 0x0220020
302 #define HB_INPUT_CH_LAYOUT_DOLBY 0x0320031
303 #define HB_INPUT_CH_LAYOUT_3F 0x0430030
304 #define HB_INPUT_CH_LAYOUT_2F1R 0x0521021
305 #define HB_INPUT_CH_LAYOUT_3F1R 0x0631031
306 #define HB_INPUT_CH_LAYOUT_2F2R 0x0722022
307 #define HB_INPUT_CH_LAYOUT_3F2R 0x0832032
308 #define HB_INPUT_CH_LAYOUT_4F2R 0x0942042
309 #define HB_INPUT_CH_LAYOUT_HAS_LFE 0x0000100
310 /* define some macros to extract the various information from the HB_AMIXDOWN_XXXX values */
311 #define HB_INPUT_CH_LAYOUT_GET_DISCRETE_FRONT_COUNT( a ) ( ( a & HB_INPUT_CH_LAYOUT_DISCRETE_FRONT_MASK ) >> 16 )
312 #define HB_INPUT_CH_LAYOUT_GET_DISCRETE_REAR_COUNT( a ) ( ( a & HB_INPUT_CH_LAYOUT_DISCRETE_REAR_MASK ) >> 12 )
313 #define HB_INPUT_CH_LAYOUT_GET_DISCRETE_LFE_COUNT( a ) ( ( a & HB_INPUT_CH_LAYOUT_DISCRETE_LFE_MASK ) >> 8 )
314 #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 ) )
315 #define HB_INPUT_CH_LAYOUT_GET_ENCODED_FRONT_COUNT( a ) ( ( a & HB_INPUT_CH_LAYOUT_ENCODED_FRONT_MASK ) >> 4 )
316 #define HB_INPUT_CH_LAYOUT_GET_ENCODED_REAR_COUNT( a ) ( ( a & HB_INPUT_CH_LAYOUT_ENCODED_REAR_MASK ) )
318 struct hb_audio_config_s
323 int track; /* Output track number */
324 uint32_t codec; /* Output audio codec.
325 * HB_ACODEC_AC3 means pass-through, then bitrate and samplerate
328 int samplerate; /* Output sample rate (Hz) */
329 int bitrate; /* Output bitrate (kbps) */
330 int mixdown; /* The mixdown format to be used for this audio track (see HB_AMIXDOWN_*) */
331 double dynamic_range_compression; /* Amount of DRC that gets applied to this track */
337 int track; /* Input track number */
338 PRIVATE uint32_t codec; /* Input audio codec */
339 PRIVATE uint32_t codec_param; /* per-codec config info */
340 PRIVATE int samplerate; /* Input sample rate (Hz) */
341 PRIVATE int bitrate; /* Input bitrate (kbps) */
342 PRIVATE int channel_layout;
343 /* channel_layout is the channel layout of this audio this is used to
344 * provide a common way of describing the source audio
351 PRIVATE int ac3; /* flags.ac3 is only set when the source audio format is HB_ACODEC_AC3 */
352 PRIVATE int dca; /* flags.dca is only set when the source audio format is HB_ACODEC_DCA */
354 #define AUDIO_F_DOLBY (1 << 31) /* set if source uses Dolby Surround */
358 PRIVATE char description[1024];
359 PRIVATE char simple[1024];
360 PRIVATE char iso639_2[4];
369 hb_audio_config_t config;
372 hb_fifo_t * fifo_in; /* AC3/MPEG/LPCM ES */
373 hb_fifo_t * fifo_raw; /* Raw audio */
374 hb_fifo_t * fifo_sync; /* Resampled, synced raw audio */
375 hb_fifo_t * fifo_out; /* MP3/AAC/Vorbis ES */
377 hb_esconfig_t config;
378 hb_mux_data_t * mux_data;
392 /* Visual-friendly duration */
397 /* Exact duration (in 1/90000s) */
400 /* Optional chapter title */
410 int hits; /* How many hits/occurrences of this subtitle */
411 int forced_hits; /* How many forced hits in this subtitle */
415 hb_fifo_t * fifo_in; /* SPU ES */
416 hb_fifo_t * fifo_raw; /* Decodec SPU */
433 /* Visual-friendly duration */
438 /* Exact duration (in 1/90000s) */
441 double aspect; // aspect ratio for the title's video
442 double container_aspect; // aspect ratio from container (0 if none)
445 int pixel_aspect_width;
446 int pixel_aspect_height;
450 enum { HB_MPEG2_DEMUXER = 0, HB_NULL_DEMUXER } demuxer;
451 int detected_interlacing;
452 int video_id; /* demuxer stream id for video */
453 int video_codec; /* worker object id of video codec */
454 int video_codec_param; /* codec specific config */
456 const char *video_codec_name;
458 const char *container_name;
461 uint32_t palette[16];
463 hb_list_t * list_chapter;
464 hb_list_t * list_audio;
465 hb_list_t * list_subtitle;
467 /* Job template for this title */
474 #define HB_STATE_IDLE 1
475 #define HB_STATE_SCANNING 2
476 #define HB_STATE_SCANDONE 4
477 #define HB_STATE_WORKING 8
478 #define HB_STATE_PAUSED 16
479 #define HB_STATE_WORKDONE 32
480 #define HB_STATE_MUXING 64
487 /* HB_STATE_SCANNING */
494 /* HB_STATE_WORKING */
508 /* HB_STATE_WORKDONE */
509 #define HB_ERROR_NONE 0
510 #define HB_ERROR_CANCELED 1
511 #define HB_ERROR_UNKNOWN 2
517 /* HB_STATE_MUXING */
523 typedef struct hb_work_info_s
533 struct { // info only valid for video decoders
536 int pixel_aspect_width;
537 int pixel_aspect_height;
540 struct { // info only valid for audio decoders
546 struct hb_work_object_s
552 int (* init) ( hb_work_object_t *, hb_job_t * );
553 int (* work) ( hb_work_object_t *, hb_buffer_t **,
555 void (* close) ( hb_work_object_t * );
556 /* the info entry point is used by scan to get bitstream information
557 * during a decode (i.e., it should only be called after at least one
558 * call to the 'work' entry point). currently it's only called for
559 * video streams & can be null for other work objects. */
560 int (* info) ( hb_work_object_t *, hb_work_info_t * );
561 /* the bitstream info entry point is used by scan to get bitstream
562 * information from a buffer. it doesn't have to be called during a
563 * decode (it can be called even if init & work haven't been).
564 * currently it's only called for audio streams & can be null for
565 * other work objects. */
566 int (* bsinfo) ( hb_work_object_t *, const hb_buffer_t *,
570 hb_fifo_t * fifo_out;
571 hb_esconfig_t * config;
573 /* Pointer hb_audio_t so we have access to the info in the audio worker threads. */
576 hb_work_private_t * private_data;
578 hb_thread_t * thread;
583 hb_work_object_t * next;
584 int thread_sleep_interval;
588 extern hb_work_object_t hb_sync;
589 extern hb_work_object_t hb_decmpeg2;
590 extern hb_work_object_t hb_decsub;
591 extern hb_work_object_t hb_render;
592 extern hb_work_object_t hb_encavcodec;
593 extern hb_work_object_t hb_encxvid;
594 extern hb_work_object_t hb_encx264;
595 extern hb_work_object_t hb_enctheora;
596 extern hb_work_object_t hb_deca52;
597 extern hb_work_object_t hb_decdca;
598 extern hb_work_object_t hb_decavcodec;
599 extern hb_work_object_t hb_decavcodecv;
600 extern hb_work_object_t hb_decavcodecvi;
601 extern hb_work_object_t hb_decavcodecai;
602 extern hb_work_object_t hb_declpcm;
603 extern hb_work_object_t hb_encfaac;
604 extern hb_work_object_t hb_enclame;
605 extern hb_work_object_t hb_encvorbis;
608 #define FILTER_DELAY 1
609 #define FILTER_FAILED 2
610 #define FILTER_DROP 3
612 struct hb_filter_object_s
619 hb_filter_private_t* (* init) ( int, int, int, char * );
621 int (* work) ( const hb_buffer_t *, hb_buffer_t **,
622 int, int, int, hb_filter_private_t * );
624 void (* close) ( hb_filter_private_t * );
626 hb_filter_private_t * private_data;
627 //hb_buffer_t * buffer;
631 extern hb_filter_object_t hb_filter_detelecine;
632 extern hb_filter_object_t hb_filter_deinterlace;
633 extern hb_filter_object_t hb_filter_deblock;
634 extern hb_filter_object_t hb_filter_denoise;
635 extern hb_filter_object_t hb_filter_decomb;
637 typedef void hb_error_handler_t( const char *errmsg );
639 extern void hb_register_error_handler( hb_error_handler_t * handler );