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( __GNUC__ ) && !(defined( _WIN32 ) || defined( __MINGW32__ ))
22 # define HB_WPRINTF(s,v) __attribute__((format(printf,s,v)))
24 # define HB_WPRINTF(s,v)
27 #if defined( SYS_MINGW )
28 # define fseek fseeko64
29 # define ftell ftello64
31 # define fseeko fseeko64
33 # define ftello ftello64
34 # define flockfile(...)
35 # define funlockfile(...)
36 # define getc_unlocked getc
38 # define off_t off64_t
42 #define MIN( a, b ) ( (a) > (b) ? (b) : (a) )
45 #define MAX( a, b ) ( (a) > (b) ? (a) : (b) )
48 #define EVEN( a ) ( (a) + ( (a) & 1 ) )
49 #define MULTIPLE_16( a ) ( 16 * ( ( (a) + 8 ) / 16 ) )
50 #define MULTIPLE_MOD( a, b ) ((b==1)?a:( b * ( ( (a) + (b / 2) - 1) / b ) ))
52 #define HB_DVD_READ_BUFFER_SIZE 2048
54 typedef struct hb_handle_s hb_handle_t;
55 typedef struct hb_list_s hb_list_t;
56 typedef struct hb_rate_s hb_rate_t;
57 typedef struct hb_mixdown_s hb_mixdown_t;
58 typedef struct hb_job_s hb_job_t;
59 typedef struct hb_title_s hb_title_t;
60 typedef struct hb_chapter_s hb_chapter_t;
61 typedef struct hb_audio_s hb_audio_t;
62 typedef struct hb_audio_config_s hb_audio_config_t;
63 typedef struct hb_subtitle_s hb_subtitle_t;
64 typedef struct hb_subtitle_config_s hb_subtitle_config_t;
65 typedef struct hb_metadata_s hb_metadata_t;
66 typedef struct hb_state_s hb_state_t;
67 typedef union hb_esconfig_u hb_esconfig_t;
68 typedef struct hb_work_private_s hb_work_private_t;
69 typedef struct hb_work_object_s hb_work_object_t;
70 typedef struct hb_filter_private_s hb_filter_private_t;
71 typedef struct hb_filter_object_s hb_filter_object_t;
72 typedef struct hb_buffer_s hb_buffer_t;
73 typedef struct hb_fifo_s hb_fifo_t;
74 typedef struct hb_lock_s hb_lock_t;
84 hb_list_t * hb_list_init();
85 int hb_list_count( hb_list_t * );
86 void hb_list_add( hb_list_t *, void * );
87 void hb_list_rem( hb_list_t *, void * );
88 void * hb_list_item( hb_list_t *, int );
89 void hb_list_close( hb_list_t ** );
91 void hb_reduce( int *x, int *y, int num, int den );
93 #define HB_KEEP_WIDTH 0
94 #define HB_KEEP_HEIGHT 1
95 void hb_fix_aspect( hb_job_t * job, int keep );
97 int hb_calc_bitrate( hb_job_t *, int size );
99 hb_audio_t *hb_audio_copy(const hb_audio_t *src);
100 void hb_audio_config_init(hb_audio_config_t * audiocfg);
101 int hb_audio_add(const hb_job_t * job, const hb_audio_config_t * audiocfg);
102 hb_audio_config_t * hb_list_audio_config_item(hb_list_t * list, int i);
104 int hb_subtitle_add(const hb_job_t * job, const hb_subtitle_config_t * subtitlecfg, int track);
105 int hb_srt_add(const hb_job_t * job, const hb_subtitle_config_t * subtitlecfg,
117 char * human_readable_name;
118 char * internal_name;
123 struct hb_subtitle_config_s
125 enum subdest { RENDERSUB, PASSTHRUSUB } dest;
128 char src_filename[128];
129 char src_codeset[40];
133 #define HB_VIDEO_RATE_BASE 27000000
135 extern hb_rate_t hb_video_rates[];
136 extern int hb_video_rates_count;
137 extern hb_rate_t hb_audio_rates[];
138 extern int hb_audio_rates_count;
139 extern int hb_audio_rates_default;
140 extern hb_rate_t hb_audio_bitrates[];
141 extern int hb_audio_bitrates_count;
142 extern int hb_audio_bitrates_default;
143 extern hb_mixdown_t hb_audio_mixdowns[];
144 extern int hb_audio_mixdowns_count;
145 int hb_mixdown_get_mixdown_from_short_name( const char * short_name );
146 const char * hb_mixdown_get_short_name_from_mixdown( int amixdown );
148 /******************************************************************************
149 * hb_job_t: settings to be filled by the UI
150 *****************************************************************************/
153 /* ID assigned by UI so it can groups job passes together */
156 /* Pointer to the title to be ripped */
159 /* Chapter selection */
163 /* Include chapter marker track in mp4? */
167 crop: must be multiples of 2 (top/bottom/left/right)
169 width: must be a multiple of 16
170 height: must be a multiple of 16
171 keep_ratio: used by UIs
172 grayscale: black and white encoding
173 pixel_ratio: store pixel aspect ratio in the video
174 pixel_aspect_width: numerator for pixel aspect ratio
175 pixel_aspect_height: denominator for pixel aspect ratio
176 modulus: set a number besides 16 for dimensions to be multiples of
177 maxWidth: keep width below this
178 maxHeight: keep height below this */
196 int keep_display_aspect;
204 vquality: output quality (0.0..1.0)
205 if < 0.0 or > 1.0, bitrate is used instead,
206 except with x264, to use its real QP/RF scale
207 vbitrate: output bitrate (kbps)
208 vrate, vrate_base: output framerate is vrate / vrate_base
209 cfr: 0 (vfr), 1 (cfr), 2 (pfr) [see render.c]
210 pass: 0, 1 or 2 (or -1 for scan)
211 h264_level: vestigial boolean to decide if we're encoding for iPod
212 x264opts: string of extra x264 options
213 areBframes: boolean to note if b-frames are included in x264opts */
214 #define HB_VCODEC_MASK 0x0000FF
215 #define HB_VCODEC_FFMPEG 0x000001
216 #define HB_VCODEC_X264 0x000002
217 #define HB_VCODEC_THEORA 0x000004
233 /* List of audio settings. */
234 hb_list_t * list_audio;
238 hb_list_t * list_subtitle;
241 mux: output file format
243 #define HB_MUX_MASK 0xFF0000
244 #define HB_MUX_MP4 0x010000
245 #define HB_MUX_PSP 0x020000
246 #define HB_MUX_AVI 0x040000
247 #define HB_MUX_OGM 0x080000
248 #define HB_MUX_IPOD 0x100000
249 #define HB_MUX_MKV 0x200000
254 /* Allow MP4 files > 4 gigs */
260 hb_subtitle_config_t select_subtitle_config;
262 int angle; // dvd angle to encode
263 int frame_to_stop; // declare eof when we hit this frame
264 int64_t pts_to_stop; // declare eof when we pass this pts in
265 // the time-linearized input stream
266 int start_at_preview; // if non-zero, encoding will start
267 // at the position of preview n
268 int seek_points; // out of N previews
269 uint32_t frames_to_skip; // decode but discard this many frames
270 // initially (for frame accurate positioning
280 uint64_t st_pause_date;
283 hb_fifo_t * fifo_mpeg2; /* MPEG-2 video ES */
284 hb_fifo_t * fifo_raw; /* Raw pictures */
285 hb_fifo_t * fifo_sync; /* Raw pictures, framerate corrected */
286 hb_fifo_t * fifo_render; /* Raw pictures, scaled */
287 hb_fifo_t * fifo_mpeg4; /* MPEG-4 video ES */
289 hb_thread_t * reader;
292 hb_list_t * list_work;
294 hb_esconfig_t config;
296 hb_mux_data_t * mux_data;
300 /* Audio starts here */
302 #define HB_ACODEC_MASK 0x00FF00
303 #define HB_ACODEC_FAAC 0x000100
304 #define HB_ACODEC_LAME 0x000200
305 #define HB_ACODEC_VORBIS 0x000400
306 #define HB_ACODEC_AC3 0x000800
307 #define HB_ACODEC_MPGA 0x001000
308 #define HB_ACODEC_LPCM 0x002000
309 #define HB_ACODEC_DCA 0x004000
310 #define HB_ACODEC_FFMPEG 0x008000
311 #define HB_ACODEC_CA_AAC 0x010000
314 /* define some masks, used to extract the various information from the HB_AMIXDOWN_XXXX values */
315 #define HB_AMIXDOWN_DCA_FORMAT_MASK 0x00FFF000
316 #define HB_AMIXDOWN_A52_FORMAT_MASK 0x00000FF0
317 #define HB_AMIXDOWN_DISCRETE_CHANNEL_COUNT_MASK 0x0000000F
318 /* define the HB_AMIXDOWN_XXXX values */
319 #define HB_AMIXDOWN_MONO 0x01000001
320 // DCA_FORMAT of DCA_MONO = 0 = 0x000
321 // A52_FORMAT of A52_MONO = 1 = 0x01
322 // discrete channel count of 1
323 #define HB_AMIXDOWN_STEREO 0x02002022
324 // DCA_FORMAT of DCA_STEREO = 2 = 0x002
325 // A52_FORMAT of A52_STEREO = 2 = 0x02
326 // discrete channel count of 2
327 #define HB_AMIXDOWN_DOLBY 0x042070A2
328 // DCA_FORMAT of DCA_3F1R | DCA_OUT_DPLI = 519 = 0x207
329 // A52_FORMAT of A52_DOLBY = 10 = 0x0A
330 // discrete channel count of 2
331 #define HB_AMIXDOWN_DOLBYPLII 0x084094A2
332 // DCA_FORMAT of DCA_3F2R | DCA_OUT_DPLII = 1033 = 0x409
333 // A52_FORMAT of A52_DOLBY | A52_USE_DPLII = 74 = 0x4A
334 // discrete channel count of 2
335 #define HB_AMIXDOWN_6CH 0x10089176
336 // DCA_FORMAT of DCA_3F2R | DCA_LFE = 137 = 0x089
337 // A52_FORMAT of A52_3F2R | A52_LFE = 23 = 0x17
338 // discrete channel count of 6
339 /* define some macros to extract the various information from the HB_AMIXDOWN_XXXX values */
340 #define HB_AMIXDOWN_GET_DCA_FORMAT( a ) ( ( a & HB_AMIXDOWN_DCA_FORMAT_MASK ) >> 12 )
341 #define HB_AMIXDOWN_GET_A52_FORMAT( a ) ( ( a & HB_AMIXDOWN_A52_FORMAT_MASK ) >> 4 )
342 #define HB_AMIXDOWN_GET_DISCRETE_CHANNEL_COUNT( a ) ( ( a & HB_AMIXDOWN_DISCRETE_CHANNEL_COUNT_MASK ) )
344 /* Input Channel Layout */
345 /* define some masks, used to extract the various information from the HB_AMIXDOWN_XXXX values */
346 #define HB_INPUT_CH_LAYOUT_DISCRETE_FRONT_MASK 0x00F0000
347 #define HB_INPUT_CH_LAYOUT_DISCRETE_REAR_MASK 0x000F000
348 #define HB_INPUT_CH_LAYOUT_DISCRETE_LFE_MASK 0x0000F00
349 #define HB_INPUT_CH_LAYOUT_DISCRETE_NO_LFE_MASK 0xFFFF0FF
350 #define HB_INPUT_CH_LAYOUT_ENCODED_FRONT_MASK 0x00000F0
351 #define HB_INPUT_CH_LAYOUT_ENCODED_REAR_MASK 0x000000F
352 /* define the input channel layouts used to describe the channel layout of this audio */
353 #define HB_INPUT_CH_LAYOUT_MONO 0x0110010
354 #define HB_INPUT_CH_LAYOUT_STEREO 0x0220020
355 #define HB_INPUT_CH_LAYOUT_DOLBY 0x0320031
356 #define HB_INPUT_CH_LAYOUT_3F 0x0430030
357 #define HB_INPUT_CH_LAYOUT_2F1R 0x0521021
358 #define HB_INPUT_CH_LAYOUT_3F1R 0x0631031
359 #define HB_INPUT_CH_LAYOUT_2F2R 0x0722022
360 #define HB_INPUT_CH_LAYOUT_3F2R 0x0832032
361 #define HB_INPUT_CH_LAYOUT_4F2R 0x0942042
362 #define HB_INPUT_CH_LAYOUT_HAS_LFE 0x0000100
363 /* define some macros to extract the various information from the HB_AMIXDOWN_XXXX values */
364 #define HB_INPUT_CH_LAYOUT_GET_DISCRETE_FRONT_COUNT( a ) ( ( a & HB_INPUT_CH_LAYOUT_DISCRETE_FRONT_MASK ) >> 16 )
365 #define HB_INPUT_CH_LAYOUT_GET_DISCRETE_REAR_COUNT( a ) ( ( a & HB_INPUT_CH_LAYOUT_DISCRETE_REAR_MASK ) >> 12 )
366 #define HB_INPUT_CH_LAYOUT_GET_DISCRETE_LFE_COUNT( a ) ( ( a & HB_INPUT_CH_LAYOUT_DISCRETE_LFE_MASK ) >> 8 )
367 #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 ) )
368 #define HB_INPUT_CH_LAYOUT_GET_ENCODED_FRONT_COUNT( a ) ( ( a & HB_INPUT_CH_LAYOUT_ENCODED_FRONT_MASK ) >> 4 )
369 #define HB_INPUT_CH_LAYOUT_GET_ENCODED_REAR_COUNT( a ) ( ( a & HB_INPUT_CH_LAYOUT_ENCODED_REAR_MASK ) )
371 struct hb_audio_config_s
376 int track; /* Output track number */
377 uint32_t codec; /* Output audio codec.
378 * HB_ACODEC_AC3 means pass-through, then bitrate and samplerate
381 int samplerate; /* Output sample rate (Hz) */
382 int bitrate; /* Output bitrate (kbps) */
383 int mixdown; /* The mixdown format to be used for this audio track (see HB_AMIXDOWN_*) */
384 double dynamic_range_compression; /* Amount of DRC that gets applied to this track */
385 char * name; /* Output track name */
391 int track; /* Input track number */
392 PRIVATE uint32_t codec; /* Input audio codec */
393 PRIVATE uint32_t codec_param; /* per-codec config info */
394 PRIVATE uint32_t version; /* Bitsream version */
395 PRIVATE uint32_t mode; /* Bitstream mode, codec dependent encoding */
396 PRIVATE int samplerate; /* Input sample rate (Hz) */
397 PRIVATE int bitrate; /* Input bitrate (kbps) */
398 PRIVATE int channel_layout;
399 /* channel_layout is the channel layout of this audio this is used to
400 * provide a common way of describing the source audio
407 PRIVATE int ac3; /* flags.ac3 is only set when the source audio format is HB_ACODEC_AC3 */
408 PRIVATE int dca; /* flags.dca is only set when the source audio format is HB_ACODEC_DCA */
410 #define AUDIO_F_DOLBY (1 << 31) /* set if source uses Dolby Surround */
414 PRIVATE char description[1024];
415 PRIVATE char simple[1024];
416 PRIVATE char iso639_2[4];
417 PRIVATE uint8_t type; /* normal, visually impared, directors */
426 hb_audio_config_t config;
429 hb_fifo_t * fifo_in; /* AC3/MPEG/LPCM ES */
430 hb_fifo_t * fifo_raw; /* Raw audio */
431 hb_fifo_t * fifo_sync; /* Resampled, synced raw audio */
432 hb_fifo_t * fifo_out; /* MP3/AAC/Vorbis ES */
434 hb_esconfig_t config;
435 hb_mux_data_t * mux_data;
451 /* Visual-friendly duration */
456 /* Exact duration (in 1/90000s) */
459 /* Optional chapter title */
468 hb_subtitle_config_t config;
470 enum subtype { PICTURESUB, TEXTSUB } format;
471 enum subsource { VOBSUB, SRTSUB, CC608SUB, CC708SUB } source;
474 uint8_t type; /* Closed Caption, Childrens, Directors etc */
476 int hits; /* How many hits/occurrences of this subtitle */
477 int forced_hits; /* How many forced hits in this subtitle */
481 hb_fifo_t * fifo_in; /* SPU ES */
482 hb_fifo_t * fifo_raw; /* Decoded SPU */
483 hb_fifo_t * fifo_sync;/* Synced */
484 hb_fifo_t * fifo_out; /* Correct Timestamps, ready to be muxed */
485 hb_mux_data_t * mux_data;
494 char release_date[255];
498 uint32_t coverart_size;
516 /* Visual-friendly duration */
521 /* Exact duration (in 1/90000s) */
524 double aspect; // aspect ratio for the title's video
525 double container_aspect; // aspect ratio from container (0 if none)
528 int pixel_aspect_width;
529 int pixel_aspect_height;
533 enum { HB_MPEG2_PS_DEMUXER = 0, HB_MPEG2_TS_DEMUXER, HB_NULL_DEMUXER } demuxer;
534 int detected_interlacing;
535 int video_id; /* demuxer stream id for video */
536 int video_codec; /* worker object id of video codec */
537 int video_codec_param; /* codec specific config */
538 const char *video_codec_name;
540 const char *container_name;
543 uint32_t palette[16];
545 hb_metadata_t *metadata;
547 hb_list_t * list_chapter;
548 hb_list_t * list_audio;
549 hb_list_t * list_subtitle;
551 /* Job template for this title */
555 // set if video stream doesn't have IDR frames
556 #define HBTF_NO_IDR (1 << 0)
562 #define HB_STATE_IDLE 1
563 #define HB_STATE_SCANNING 2
564 #define HB_STATE_SCANDONE 4
565 #define HB_STATE_WORKING 8
566 #define HB_STATE_PAUSED 16
567 #define HB_STATE_WORKDONE 32
568 #define HB_STATE_MUXING 64
575 /* HB_STATE_SCANNING */
582 /* HB_STATE_WORKING */
596 /* HB_STATE_WORKDONE */
597 #define HB_ERROR_NONE 0
598 #define HB_ERROR_CANCELED 1
599 #define HB_ERROR_UNKNOWN 2
605 /* HB_STATE_MUXING */
611 typedef struct hb_work_info_s
623 struct { // info only valid for video decoders
626 int pixel_aspect_width;
627 int pixel_aspect_height;
630 struct { // info only valid for audio decoders
636 struct hb_work_object_s
642 int (* init) ( hb_work_object_t *, hb_job_t * );
643 int (* work) ( hb_work_object_t *, hb_buffer_t **,
645 void (* close) ( hb_work_object_t * );
646 /* the info entry point is used by scan to get bitstream information
647 * during a decode (i.e., it should only be called after at least one
648 * call to the 'work' entry point). currently it's only called for
649 * video streams & can be null for other work objects. */
650 int (* info) ( hb_work_object_t *, hb_work_info_t * );
651 /* the bitstream info entry point is used by scan to get bitstream
652 * information from a buffer. it doesn't have to be called during a
653 * decode (it can be called even if init & work haven't been).
654 * currently it's only called for audio streams & can be null for
655 * other work objects. */
656 int (* bsinfo) ( hb_work_object_t *, const hb_buffer_t *,
660 hb_fifo_t * fifo_out;
661 hb_esconfig_t * config;
663 /* Pointer hb_audio_t so we have access to the info in the audio worker threads. */
666 /* Pointer hb_subtitle_t so we have access to the info in the subtitle worker threads. */
667 hb_subtitle_t * subtitle;
669 hb_work_private_t * private_data;
671 hb_thread_t * thread;
677 hb_work_object_t * next;
678 int thread_sleep_interval;
682 extern hb_work_object_t hb_sync;
683 extern hb_work_object_t hb_decmpeg2;
684 extern hb_work_object_t hb_decvobsub;
685 extern hb_work_object_t hb_encvobsub;
686 extern hb_work_object_t hb_deccc608;
687 extern hb_work_object_t hb_decsrtsub;
688 extern hb_work_object_t hb_render;
689 extern hb_work_object_t hb_encavcodec;
690 extern hb_work_object_t hb_encx264;
691 extern hb_work_object_t hb_enctheora;
692 extern hb_work_object_t hb_deca52;
693 extern hb_work_object_t hb_decdca;
694 extern hb_work_object_t hb_decavcodec;
695 extern hb_work_object_t hb_decavcodecv;
696 extern hb_work_object_t hb_decavcodecvi;
697 extern hb_work_object_t hb_decavcodecai;
698 extern hb_work_object_t hb_declpcm;
699 extern hb_work_object_t hb_encfaac;
700 extern hb_work_object_t hb_enclame;
701 extern hb_work_object_t hb_encvorbis;
702 extern hb_work_object_t hb_encca_aac;
705 #define FILTER_DELAY 1
706 #define FILTER_FAILED 2
707 #define FILTER_DROP 3
709 struct hb_filter_object_s
716 hb_filter_private_t* (* init) ( int, int, int, char * );
718 int (* work) ( const hb_buffer_t *, hb_buffer_t **,
719 int, int, int, hb_filter_private_t * );
721 void (* close) ( hb_filter_private_t * );
723 hb_filter_private_t * private_data;
724 //hb_buffer_t * buffer;
728 extern hb_filter_object_t hb_filter_detelecine;
729 extern hb_filter_object_t hb_filter_deinterlace;
730 extern hb_filter_object_t hb_filter_deblock;
731 extern hb_filter_object_t hb_filter_denoise;
732 extern hb_filter_object_t hb_filter_decomb;
734 typedef void hb_error_handler_t( const char *errmsg );
736 extern void hb_register_error_handler( hb_error_handler_t * handler );