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>
21 #if defined( SYS_MINGW )
22 # define fseek fseeko64
23 # define ftell ftello64
25 # define fseeko fseeko64
27 # define ftello ftello64
28 # define flockfile(...)
29 # define funlockfile(...)
30 # define getc_unlocked getc
32 # define off_t off64_t
36 #define MIN( a, b ) ( (a) > (b) ? (b) : (a) )
39 #define MAX( a, b ) ( (a) > (b) ? (a) : (b) )
42 #define EVEN( a ) ( (a) + ( (a) & 1 ) )
43 #define MULTIPLE_16( a ) ( 16 * ( ( (a) + 8 ) / 16 ) )
44 #define MULTIPLE_MOD( a, b ) ((b==1)?a:( b * ( ( (a) + (b / 2) - 1) / b ) ))
46 #define HB_DVD_READ_BUFFER_SIZE 2048
48 typedef struct hb_handle_s hb_handle_t;
49 typedef struct hb_list_s hb_list_t;
50 typedef struct hb_rate_s hb_rate_t;
51 typedef struct hb_mixdown_s hb_mixdown_t;
52 typedef struct hb_job_s hb_job_t;
53 typedef struct hb_title_s hb_title_t;
54 typedef struct hb_chapter_s hb_chapter_t;
55 typedef struct hb_audio_s hb_audio_t;
56 typedef struct hb_audio_config_s hb_audio_config_t;
57 typedef struct hb_subtitle_s hb_subtitle_t;
58 typedef struct hb_metadata_s hb_metadata_t;
59 typedef struct hb_state_s hb_state_t;
60 typedef union hb_esconfig_u hb_esconfig_t;
61 typedef struct hb_work_private_s hb_work_private_t;
62 typedef struct hb_work_object_s hb_work_object_t;
63 typedef struct hb_filter_private_s hb_filter_private_t;
64 typedef struct hb_filter_object_s hb_filter_object_t;
65 typedef struct hb_buffer_s hb_buffer_t;
66 typedef struct hb_fifo_s hb_fifo_t;
67 typedef struct hb_lock_s hb_lock_t;
77 hb_list_t * hb_list_init();
78 int hb_list_count( hb_list_t * );
79 void hb_list_add( hb_list_t *, void * );
80 void hb_list_rem( hb_list_t *, void * );
81 void * hb_list_item( hb_list_t *, int );
82 void hb_list_close( hb_list_t ** );
84 void hb_reduce( int *x, int *y, int num, int den );
86 #define HB_KEEP_WIDTH 0
87 #define HB_KEEP_HEIGHT 1
88 void hb_fix_aspect( hb_job_t * job, int keep );
90 int hb_calc_bitrate( hb_job_t *, int size );
92 hb_audio_t *hb_audio_copy(const hb_audio_t *src);
93 void hb_audio_config_init(hb_audio_config_t * audiocfg);
94 int hb_audio_add(const hb_job_t * job, const hb_audio_config_t * audiocfg);
95 hb_audio_config_t * hb_list_audio_config_item(hb_list_t * list, int i);
105 char * human_readable_name;
106 char * internal_name;
111 #define HB_VIDEO_RATE_BASE 27000000
113 extern hb_rate_t hb_video_rates[];
114 extern int hb_video_rates_count;
115 extern hb_rate_t hb_audio_rates[];
116 extern int hb_audio_rates_count;
117 extern int hb_audio_rates_default;
118 extern hb_rate_t hb_audio_bitrates[];
119 extern int hb_audio_bitrates_count;
120 extern int hb_audio_bitrates_default;
121 extern hb_mixdown_t hb_audio_mixdowns[];
122 extern int hb_audio_mixdowns_count;
123 int hb_mixdown_get_mixdown_from_short_name( const char * short_name );
124 const char * hb_mixdown_get_short_name_from_mixdown( int amixdown );
126 /******************************************************************************
127 * hb_job_t: settings to be filled by the UI
128 *****************************************************************************/
131 /* ID assigned by UI so it can groups job passes together */
134 /* Pointer to the title to be ripped */
137 /* Chapter selection */
141 /* Include chapter marker track in mp4? */
145 crop: must be multiples of 2 (top/bottom/left/right)
147 width: must be a multiple of 16
148 height: must be a multiple of 16
149 keep_ratio: used by UIs
150 grayscale: black and white encoding
151 pixel_ratio: store pixel aspect ratio in the video
152 pixel_aspect_width: numerator for pixel aspect ratio
153 pixel_aspect_height: denominator for pixel aspect ratio
154 modulus: set a number besides 16 for dimensions to be multiples of
155 maxWidth: keep width below this
156 maxHeight: keep height below this */
181 vquality: output quality (0.0..1.0)
182 if < 0.0 or > 1.0, bitrate is used instead,
183 except with x264, to use its real QP/RF scale
184 vbitrate: output bitrate (kbps)
185 vrate, vrate_base: output framerate is vrate / vrate_base
186 vfr: boolean for variable frame rate detelecine
187 cfr: boolean to use constant frame rates instead of
188 passing through the source's frame durations.
189 pass: 0, 1 or 2 (or -1 for scan)
190 h264_level: vestigial boolean to decide if we're encoding for iPod
191 crf: boolean for whether to use constant rate factor with x264
192 x264opts: string of extra x264 options
193 areBframes: boolean to note if b-frames are included in x264opts */
194 #define HB_VCODEC_MASK 0x0000FF
195 #define HB_VCODEC_FFMPEG 0x000001
196 #define HB_VCODEC_XVID 0x000002
197 #define HB_VCODEC_X264 0x000004
198 #define HB_VCODEC_THEORA 0x000008
215 /* List of audio settings. */
216 hb_list_t * list_audio;
218 /* Subtitle settings:
219 subtitle: index in hb_title_t's subtitles list, starting
220 from 0. -1 means no subtitle */
222 int subtitleSmartAdjust;
225 mux: output file format
227 #define HB_MUX_MASK 0xFF0000
228 #define HB_MUX_MP4 0x010000
229 #define HB_MUX_PSP 0x020000
230 #define HB_MUX_AVI 0x040000
231 #define HB_MUX_OGM 0x080000
232 #define HB_MUX_IPOD 0x100000
233 #define HB_MUX_MKV 0x200000
238 /* Allow MP4 files > 4 gigs */
244 hb_subtitle_t ** select_subtitle;
246 char * native_language;
248 int frame_to_stop; // declare eof when we hit this frame
249 int64_t pts_to_stop; // declare eof when we pass this pts in
250 // the time-linearized input stream
251 int start_at_preview; // if non-zero, encoding will start
252 // at the position of preview n
253 int seek_points; // out of N previews
254 uint32_t frames_to_skip; // decode but discard this many frames
255 // initially (for frame accurate positioning
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;
282 /* Audio starts here */
284 #define HB_ACODEC_MASK 0x00FF00
285 #define HB_ACODEC_FAAC 0x000100
286 #define HB_ACODEC_LAME 0x000200
287 #define HB_ACODEC_VORBIS 0x000400
288 #define HB_ACODEC_AC3 0x000800
289 #define HB_ACODEC_MPGA 0x001000
290 #define HB_ACODEC_LPCM 0x002000
291 #define HB_ACODEC_DCA 0x004000
292 #define HB_ACODEC_FFMPEG 0x008000
295 /* define some masks, used to extract the various information from the HB_AMIXDOWN_XXXX values */
296 #define HB_AMIXDOWN_DCA_FORMAT_MASK 0x00FFF000
297 #define HB_AMIXDOWN_A52_FORMAT_MASK 0x00000FF0
298 #define HB_AMIXDOWN_DISCRETE_CHANNEL_COUNT_MASK 0x0000000F
299 /* define the HB_AMIXDOWN_XXXX values */
300 #define HB_AMIXDOWN_MONO 0x01000001
301 // DCA_FORMAT of DCA_MONO = 0 = 0x000
302 // A52_FORMAT of A52_MONO = 1 = 0x01
303 // discrete channel count of 1
304 #define HB_AMIXDOWN_STEREO 0x02002022
305 // DCA_FORMAT of DCA_STEREO = 2 = 0x002
306 // A52_FORMAT of A52_STEREO = 2 = 0x02
307 // discrete channel count of 2
308 #define HB_AMIXDOWN_DOLBY 0x042070A2
309 // DCA_FORMAT of DCA_3F1R | DCA_OUT_DPLI = 519 = 0x207
310 // A52_FORMAT of A52_DOLBY = 10 = 0x0A
311 // discrete channel count of 2
312 #define HB_AMIXDOWN_DOLBYPLII 0x084094A2
313 // DCA_FORMAT of DCA_3F2R | DCA_OUT_DPLII = 1033 = 0x409
314 // A52_FORMAT of A52_DOLBY | A52_USE_DPLII = 74 = 0x4A
315 // discrete channel count of 2
316 #define HB_AMIXDOWN_6CH 0x10089176
317 // DCA_FORMAT of DCA_3F2R | DCA_LFE = 137 = 0x089
318 // A52_FORMAT of A52_3F2R | A52_LFE = 23 = 0x17
319 // discrete channel count of 6
320 /* define some macros to extract the various information from the HB_AMIXDOWN_XXXX values */
321 #define HB_AMIXDOWN_GET_DCA_FORMAT( a ) ( ( a & HB_AMIXDOWN_DCA_FORMAT_MASK ) >> 12 )
322 #define HB_AMIXDOWN_GET_A52_FORMAT( a ) ( ( a & HB_AMIXDOWN_A52_FORMAT_MASK ) >> 4 )
323 #define HB_AMIXDOWN_GET_DISCRETE_CHANNEL_COUNT( a ) ( ( a & HB_AMIXDOWN_DISCRETE_CHANNEL_COUNT_MASK ) )
325 /* Input Channel Layout */
326 /* define some masks, used to extract the various information from the HB_AMIXDOWN_XXXX values */
327 #define HB_INPUT_CH_LAYOUT_DISCRETE_FRONT_MASK 0x00F0000
328 #define HB_INPUT_CH_LAYOUT_DISCRETE_REAR_MASK 0x000F000
329 #define HB_INPUT_CH_LAYOUT_DISCRETE_LFE_MASK 0x0000F00
330 #define HB_INPUT_CH_LAYOUT_DISCRETE_NO_LFE_MASK 0xFFFF0FF
331 #define HB_INPUT_CH_LAYOUT_ENCODED_FRONT_MASK 0x00000F0
332 #define HB_INPUT_CH_LAYOUT_ENCODED_REAR_MASK 0x000000F
333 /* define the input channel layouts used to describe the channel layout of this audio */
334 #define HB_INPUT_CH_LAYOUT_MONO 0x0110010
335 #define HB_INPUT_CH_LAYOUT_STEREO 0x0220020
336 #define HB_INPUT_CH_LAYOUT_DOLBY 0x0320031
337 #define HB_INPUT_CH_LAYOUT_3F 0x0430030
338 #define HB_INPUT_CH_LAYOUT_2F1R 0x0521021
339 #define HB_INPUT_CH_LAYOUT_3F1R 0x0631031
340 #define HB_INPUT_CH_LAYOUT_2F2R 0x0722022
341 #define HB_INPUT_CH_LAYOUT_3F2R 0x0832032
342 #define HB_INPUT_CH_LAYOUT_4F2R 0x0942042
343 #define HB_INPUT_CH_LAYOUT_HAS_LFE 0x0000100
344 /* define some macros to extract the various information from the HB_AMIXDOWN_XXXX values */
345 #define HB_INPUT_CH_LAYOUT_GET_DISCRETE_FRONT_COUNT( a ) ( ( a & HB_INPUT_CH_LAYOUT_DISCRETE_FRONT_MASK ) >> 16 )
346 #define HB_INPUT_CH_LAYOUT_GET_DISCRETE_REAR_COUNT( a ) ( ( a & HB_INPUT_CH_LAYOUT_DISCRETE_REAR_MASK ) >> 12 )
347 #define HB_INPUT_CH_LAYOUT_GET_DISCRETE_LFE_COUNT( a ) ( ( a & HB_INPUT_CH_LAYOUT_DISCRETE_LFE_MASK ) >> 8 )
348 #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 ) )
349 #define HB_INPUT_CH_LAYOUT_GET_ENCODED_FRONT_COUNT( a ) ( ( a & HB_INPUT_CH_LAYOUT_ENCODED_FRONT_MASK ) >> 4 )
350 #define HB_INPUT_CH_LAYOUT_GET_ENCODED_REAR_COUNT( a ) ( ( a & HB_INPUT_CH_LAYOUT_ENCODED_REAR_MASK ) )
352 struct hb_audio_config_s
357 int track; /* Output track number */
358 uint32_t codec; /* Output audio codec.
359 * HB_ACODEC_AC3 means pass-through, then bitrate and samplerate
362 int samplerate; /* Output sample rate (Hz) */
363 int bitrate; /* Output bitrate (kbps) */
364 int mixdown; /* The mixdown format to be used for this audio track (see HB_AMIXDOWN_*) */
365 double dynamic_range_compression; /* Amount of DRC that gets applied to this track */
366 char * name; /* Output track name */
372 int track; /* Input track number */
373 PRIVATE uint32_t codec; /* Input audio codec */
374 PRIVATE uint32_t codec_param; /* per-codec config info */
375 PRIVATE uint32_t version; /* Bitsream version */
376 PRIVATE uint32_t mode; /* Bitstream mode, codec dependent encoding */
377 PRIVATE int samplerate; /* Input sample rate (Hz) */
378 PRIVATE int bitrate; /* Input bitrate (kbps) */
379 PRIVATE int channel_layout;
380 /* channel_layout is the channel layout of this audio this is used to
381 * provide a common way of describing the source audio
388 PRIVATE int ac3; /* flags.ac3 is only set when the source audio format is HB_ACODEC_AC3 */
389 PRIVATE int dca; /* flags.dca is only set when the source audio format is HB_ACODEC_DCA */
391 #define AUDIO_F_DOLBY (1 << 31) /* set if source uses Dolby Surround */
395 PRIVATE char description[1024];
396 PRIVATE char simple[1024];
397 PRIVATE char iso639_2[4];
398 PRIVATE uint8_t type; /* normal, visually impared, directors */
407 hb_audio_config_t config;
410 hb_fifo_t * fifo_in; /* AC3/MPEG/LPCM ES */
411 hb_fifo_t * fifo_raw; /* Raw audio */
412 hb_fifo_t * fifo_sync; /* Resampled, synced raw audio */
413 hb_fifo_t * fifo_out; /* MP3/AAC/Vorbis ES */
415 hb_esconfig_t config;
416 hb_mux_data_t * mux_data;
430 /* Visual-friendly duration */
435 /* Exact duration (in 1/90000s) */
438 /* Optional chapter title */
447 uint8_t type; /* Closed Caption, Childrens, Directors etc */
449 int hits; /* How many hits/occurrences of this subtitle */
450 int forced_hits; /* How many forced hits in this subtitle */
454 hb_fifo_t * fifo_in; /* SPU ES */
455 hb_fifo_t * fifo_raw; /* Decodec SPU */
464 char release_date[255];
468 uint32_t coverart_size;
485 /* Visual-friendly duration */
490 /* Exact duration (in 1/90000s) */
493 double aspect; // aspect ratio for the title's video
494 double container_aspect; // aspect ratio from container (0 if none)
497 int pixel_aspect_width;
498 int pixel_aspect_height;
502 enum { HB_MPEG2_PS_DEMUXER = 0, HB_MPEG2_TS_DEMUXER, HB_NULL_DEMUXER } demuxer;
503 int detected_interlacing;
504 int video_id; /* demuxer stream id for video */
505 int video_codec; /* worker object id of video codec */
506 int video_codec_param; /* codec specific config */
507 const char *video_codec_name;
509 const char *container_name;
512 uint32_t palette[16];
514 hb_metadata_t *metadata;
516 hb_list_t * list_chapter;
517 hb_list_t * list_audio;
518 hb_list_t * list_subtitle;
520 /* Job template for this title */
524 // set if video stream doesn't have IDR frames
525 #define HBTF_NO_IDR (1 << 0)
531 #define HB_STATE_IDLE 1
532 #define HB_STATE_SCANNING 2
533 #define HB_STATE_SCANDONE 4
534 #define HB_STATE_WORKING 8
535 #define HB_STATE_PAUSED 16
536 #define HB_STATE_WORKDONE 32
537 #define HB_STATE_MUXING 64
544 /* HB_STATE_SCANNING */
551 /* HB_STATE_WORKING */
565 /* HB_STATE_WORKDONE */
566 #define HB_ERROR_NONE 0
567 #define HB_ERROR_CANCELED 1
568 #define HB_ERROR_UNKNOWN 2
574 /* HB_STATE_MUXING */
580 typedef struct hb_work_info_s
592 struct { // info only valid for video decoders
595 int pixel_aspect_width;
596 int pixel_aspect_height;
599 struct { // info only valid for audio decoders
605 struct hb_work_object_s
611 int (* init) ( hb_work_object_t *, hb_job_t * );
612 int (* work) ( hb_work_object_t *, hb_buffer_t **,
614 void (* close) ( hb_work_object_t * );
615 /* the info entry point is used by scan to get bitstream information
616 * during a decode (i.e., it should only be called after at least one
617 * call to the 'work' entry point). currently it's only called for
618 * video streams & can be null for other work objects. */
619 int (* info) ( hb_work_object_t *, hb_work_info_t * );
620 /* the bitstream info entry point is used by scan to get bitstream
621 * information from a buffer. it doesn't have to be called during a
622 * decode (it can be called even if init & work haven't been).
623 * currently it's only called for audio streams & can be null for
624 * other work objects. */
625 int (* bsinfo) ( hb_work_object_t *, const hb_buffer_t *,
629 hb_fifo_t * fifo_out;
630 hb_esconfig_t * config;
632 /* Pointer hb_audio_t so we have access to the info in the audio worker threads. */
635 hb_work_private_t * private_data;
637 hb_thread_t * thread;
642 hb_work_object_t * next;
643 int thread_sleep_interval;
647 extern hb_work_object_t hb_sync;
648 extern hb_work_object_t hb_decmpeg2;
649 extern hb_work_object_t hb_decsub;
650 extern hb_work_object_t hb_render;
651 extern hb_work_object_t hb_encavcodec;
652 extern hb_work_object_t hb_encxvid;
653 extern hb_work_object_t hb_encx264;
654 extern hb_work_object_t hb_enctheora;
655 extern hb_work_object_t hb_deca52;
656 extern hb_work_object_t hb_decdca;
657 extern hb_work_object_t hb_decavcodec;
658 extern hb_work_object_t hb_decavcodecv;
659 extern hb_work_object_t hb_decavcodecvi;
660 extern hb_work_object_t hb_decavcodecai;
661 extern hb_work_object_t hb_declpcm;
662 extern hb_work_object_t hb_encfaac;
663 extern hb_work_object_t hb_enclame;
664 extern hb_work_object_t hb_encvorbis;
667 #define FILTER_DELAY 1
668 #define FILTER_FAILED 2
669 #define FILTER_DROP 3
671 struct hb_filter_object_s
678 hb_filter_private_t* (* init) ( int, int, int, char * );
680 int (* work) ( const hb_buffer_t *, hb_buffer_t **,
681 int, int, int, hb_filter_private_t * );
683 void (* close) ( hb_filter_private_t * );
685 hb_filter_private_t * private_data;
686 //hb_buffer_t * buffer;
690 extern hb_filter_object_t hb_filter_detelecine;
691 extern hb_filter_object_t hb_filter_deinterlace;
692 extern hb_filter_object_t hb_filter_deblock;
693 extern hb_filter_object_t hb_filter_denoise;
694 extern hb_filter_object_t hb_filter_decomb;
696 typedef void hb_error_handler_t( const char *errmsg );
698 extern void hb_register_error_handler( hb_error_handler_t * handler );