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_subtitle_config_s hb_subtitle_config_t;
59 typedef struct hb_metadata_s hb_metadata_t;
60 typedef struct hb_state_s hb_state_t;
61 typedef union hb_esconfig_u hb_esconfig_t;
62 typedef struct hb_work_private_s hb_work_private_t;
63 typedef struct hb_work_object_s hb_work_object_t;
64 typedef struct hb_filter_private_s hb_filter_private_t;
65 typedef struct hb_filter_object_s hb_filter_object_t;
66 typedef struct hb_buffer_s hb_buffer_t;
67 typedef struct hb_fifo_s hb_fifo_t;
68 typedef struct hb_lock_s hb_lock_t;
78 hb_list_t * hb_list_init();
79 int hb_list_count( hb_list_t * );
80 void hb_list_add( hb_list_t *, void * );
81 void hb_list_rem( hb_list_t *, void * );
82 void * hb_list_item( hb_list_t *, int );
83 void hb_list_close( hb_list_t ** );
85 void hb_reduce( int *x, int *y, int num, int den );
87 #define HB_KEEP_WIDTH 0
88 #define HB_KEEP_HEIGHT 1
89 void hb_fix_aspect( hb_job_t * job, int keep );
91 int hb_calc_bitrate( hb_job_t *, int size );
93 hb_audio_t *hb_audio_copy(const hb_audio_t *src);
94 void hb_audio_config_init(hb_audio_config_t * audiocfg);
95 int hb_audio_add(const hb_job_t * job, const hb_audio_config_t * audiocfg);
96 hb_audio_config_t * hb_list_audio_config_item(hb_list_t * list, int i);
98 int hb_subtitle_add(const hb_job_t * job, const hb_subtitle_config_t * subtitlecfg, int track);
99 int hb_srt_add(const hb_job_t * job, const hb_subtitle_config_t * subtitlecfg,
111 char * human_readable_name;
112 char * internal_name;
117 struct hb_subtitle_config_s
119 enum subdest { RENDERSUB, PASSTHRUSUB } dest;
122 char src_filename[128];
123 char src_codeset[40];
127 #define HB_VIDEO_RATE_BASE 27000000
129 extern hb_rate_t hb_video_rates[];
130 extern int hb_video_rates_count;
131 extern hb_rate_t hb_audio_rates[];
132 extern int hb_audio_rates_count;
133 extern int hb_audio_rates_default;
134 extern hb_rate_t hb_audio_bitrates[];
135 extern int hb_audio_bitrates_count;
136 extern int hb_audio_bitrates_default;
137 extern hb_mixdown_t hb_audio_mixdowns[];
138 extern int hb_audio_mixdowns_count;
139 int hb_mixdown_get_mixdown_from_short_name( const char * short_name );
140 const char * hb_mixdown_get_short_name_from_mixdown( int amixdown );
142 /******************************************************************************
143 * hb_job_t: settings to be filled by the UI
144 *****************************************************************************/
147 /* ID assigned by UI so it can groups job passes together */
150 /* Pointer to the title to be ripped */
153 /* Chapter selection */
157 /* Include chapter marker track in mp4? */
161 crop: must be multiples of 2 (top/bottom/left/right)
163 width: must be a multiple of 16
164 height: must be a multiple of 16
165 keep_ratio: used by UIs
166 grayscale: black and white encoding
167 pixel_ratio: store pixel aspect ratio in the video
168 pixel_aspect_width: numerator for pixel aspect ratio
169 pixel_aspect_height: denominator for pixel aspect ratio
170 modulus: set a number besides 16 for dimensions to be multiples of
171 maxWidth: keep width below this
172 maxHeight: keep height below this */
190 int keep_display_aspect;
198 vquality: output quality (0.0..1.0)
199 if < 0.0 or > 1.0, bitrate is used instead,
200 except with x264, to use its real QP/RF scale
201 vbitrate: output bitrate (kbps)
202 vrate, vrate_base: output framerate is vrate / vrate_base
203 cfr: 0 (vfr), 1 (cfr), 2 (pfr) [see render.c]
204 pass: 0, 1 or 2 (or -1 for scan)
205 h264_level: vestigial boolean to decide if we're encoding for iPod
206 crf: boolean for whether to use constant rate factor with x264
207 x264opts: string of extra x264 options
208 areBframes: boolean to note if b-frames are included in x264opts */
209 #define HB_VCODEC_MASK 0x0000FF
210 #define HB_VCODEC_FFMPEG 0x000001
211 #define HB_VCODEC_X264 0x000002
212 #define HB_VCODEC_THEORA 0x000004
229 /* List of audio settings. */
230 hb_list_t * list_audio;
234 hb_list_t * list_subtitle;
237 mux: output file format
239 #define HB_MUX_MASK 0xFF0000
240 #define HB_MUX_MP4 0x010000
241 #define HB_MUX_PSP 0x020000
242 #define HB_MUX_AVI 0x040000
243 #define HB_MUX_OGM 0x080000
244 #define HB_MUX_IPOD 0x100000
245 #define HB_MUX_MKV 0x200000
250 /* Allow MP4 files > 4 gigs */
256 hb_subtitle_config_t select_subtitle_config;
258 int angle; // dvd angle to encode
259 int frame_to_stop; // declare eof when we hit this frame
260 int64_t pts_to_stop; // declare eof when we pass this pts in
261 // the time-linearized input stream
262 int start_at_preview; // if non-zero, encoding will start
263 // at the position of preview n
264 int seek_points; // out of N previews
265 uint32_t frames_to_skip; // decode but discard this many frames
266 // initially (for frame accurate positioning
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;
293 /* Audio starts here */
295 #define HB_ACODEC_MASK 0x00FF00
296 #define HB_ACODEC_FAAC 0x000100
297 #define HB_ACODEC_LAME 0x000200
298 #define HB_ACODEC_VORBIS 0x000400
299 #define HB_ACODEC_AC3 0x000800
300 #define HB_ACODEC_MPGA 0x001000
301 #define HB_ACODEC_LPCM 0x002000
302 #define HB_ACODEC_DCA 0x004000
303 #define HB_ACODEC_FFMPEG 0x008000
304 #define HB_ACODEC_CA_AAC 0x010000
307 /* define some masks, used to extract the various information from the HB_AMIXDOWN_XXXX values */
308 #define HB_AMIXDOWN_DCA_FORMAT_MASK 0x00FFF000
309 #define HB_AMIXDOWN_A52_FORMAT_MASK 0x00000FF0
310 #define HB_AMIXDOWN_DISCRETE_CHANNEL_COUNT_MASK 0x0000000F
311 /* define the HB_AMIXDOWN_XXXX values */
312 #define HB_AMIXDOWN_MONO 0x01000001
313 // DCA_FORMAT of DCA_MONO = 0 = 0x000
314 // A52_FORMAT of A52_MONO = 1 = 0x01
315 // discrete channel count of 1
316 #define HB_AMIXDOWN_STEREO 0x02002022
317 // DCA_FORMAT of DCA_STEREO = 2 = 0x002
318 // A52_FORMAT of A52_STEREO = 2 = 0x02
319 // discrete channel count of 2
320 #define HB_AMIXDOWN_DOLBY 0x042070A2
321 // DCA_FORMAT of DCA_3F1R | DCA_OUT_DPLI = 519 = 0x207
322 // A52_FORMAT of A52_DOLBY = 10 = 0x0A
323 // discrete channel count of 2
324 #define HB_AMIXDOWN_DOLBYPLII 0x084094A2
325 // DCA_FORMAT of DCA_3F2R | DCA_OUT_DPLII = 1033 = 0x409
326 // A52_FORMAT of A52_DOLBY | A52_USE_DPLII = 74 = 0x4A
327 // discrete channel count of 2
328 #define HB_AMIXDOWN_6CH 0x10089176
329 // DCA_FORMAT of DCA_3F2R | DCA_LFE = 137 = 0x089
330 // A52_FORMAT of A52_3F2R | A52_LFE = 23 = 0x17
331 // discrete channel count of 6
332 /* define some macros to extract the various information from the HB_AMIXDOWN_XXXX values */
333 #define HB_AMIXDOWN_GET_DCA_FORMAT( a ) ( ( a & HB_AMIXDOWN_DCA_FORMAT_MASK ) >> 12 )
334 #define HB_AMIXDOWN_GET_A52_FORMAT( a ) ( ( a & HB_AMIXDOWN_A52_FORMAT_MASK ) >> 4 )
335 #define HB_AMIXDOWN_GET_DISCRETE_CHANNEL_COUNT( a ) ( ( a & HB_AMIXDOWN_DISCRETE_CHANNEL_COUNT_MASK ) )
337 /* Input Channel Layout */
338 /* define some masks, used to extract the various information from the HB_AMIXDOWN_XXXX values */
339 #define HB_INPUT_CH_LAYOUT_DISCRETE_FRONT_MASK 0x00F0000
340 #define HB_INPUT_CH_LAYOUT_DISCRETE_REAR_MASK 0x000F000
341 #define HB_INPUT_CH_LAYOUT_DISCRETE_LFE_MASK 0x0000F00
342 #define HB_INPUT_CH_LAYOUT_DISCRETE_NO_LFE_MASK 0xFFFF0FF
343 #define HB_INPUT_CH_LAYOUT_ENCODED_FRONT_MASK 0x00000F0
344 #define HB_INPUT_CH_LAYOUT_ENCODED_REAR_MASK 0x000000F
345 /* define the input channel layouts used to describe the channel layout of this audio */
346 #define HB_INPUT_CH_LAYOUT_MONO 0x0110010
347 #define HB_INPUT_CH_LAYOUT_STEREO 0x0220020
348 #define HB_INPUT_CH_LAYOUT_DOLBY 0x0320031
349 #define HB_INPUT_CH_LAYOUT_3F 0x0430030
350 #define HB_INPUT_CH_LAYOUT_2F1R 0x0521021
351 #define HB_INPUT_CH_LAYOUT_3F1R 0x0631031
352 #define HB_INPUT_CH_LAYOUT_2F2R 0x0722022
353 #define HB_INPUT_CH_LAYOUT_3F2R 0x0832032
354 #define HB_INPUT_CH_LAYOUT_4F2R 0x0942042
355 #define HB_INPUT_CH_LAYOUT_HAS_LFE 0x0000100
356 /* define some macros to extract the various information from the HB_AMIXDOWN_XXXX values */
357 #define HB_INPUT_CH_LAYOUT_GET_DISCRETE_FRONT_COUNT( a ) ( ( a & HB_INPUT_CH_LAYOUT_DISCRETE_FRONT_MASK ) >> 16 )
358 #define HB_INPUT_CH_LAYOUT_GET_DISCRETE_REAR_COUNT( a ) ( ( a & HB_INPUT_CH_LAYOUT_DISCRETE_REAR_MASK ) >> 12 )
359 #define HB_INPUT_CH_LAYOUT_GET_DISCRETE_LFE_COUNT( a ) ( ( a & HB_INPUT_CH_LAYOUT_DISCRETE_LFE_MASK ) >> 8 )
360 #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 ) )
361 #define HB_INPUT_CH_LAYOUT_GET_ENCODED_FRONT_COUNT( a ) ( ( a & HB_INPUT_CH_LAYOUT_ENCODED_FRONT_MASK ) >> 4 )
362 #define HB_INPUT_CH_LAYOUT_GET_ENCODED_REAR_COUNT( a ) ( ( a & HB_INPUT_CH_LAYOUT_ENCODED_REAR_MASK ) )
364 struct hb_audio_config_s
369 int track; /* Output track number */
370 uint32_t codec; /* Output audio codec.
371 * HB_ACODEC_AC3 means pass-through, then bitrate and samplerate
374 int samplerate; /* Output sample rate (Hz) */
375 int bitrate; /* Output bitrate (kbps) */
376 int mixdown; /* The mixdown format to be used for this audio track (see HB_AMIXDOWN_*) */
377 double dynamic_range_compression; /* Amount of DRC that gets applied to this track */
378 char * name; /* Output track name */
384 int track; /* Input track number */
385 PRIVATE uint32_t codec; /* Input audio codec */
386 PRIVATE uint32_t codec_param; /* per-codec config info */
387 PRIVATE uint32_t version; /* Bitsream version */
388 PRIVATE uint32_t mode; /* Bitstream mode, codec dependent encoding */
389 PRIVATE int samplerate; /* Input sample rate (Hz) */
390 PRIVATE int bitrate; /* Input bitrate (kbps) */
391 PRIVATE int channel_layout;
392 /* channel_layout is the channel layout of this audio this is used to
393 * provide a common way of describing the source audio
400 PRIVATE int ac3; /* flags.ac3 is only set when the source audio format is HB_ACODEC_AC3 */
401 PRIVATE int dca; /* flags.dca is only set when the source audio format is HB_ACODEC_DCA */
403 #define AUDIO_F_DOLBY (1 << 31) /* set if source uses Dolby Surround */
407 PRIVATE char description[1024];
408 PRIVATE char simple[1024];
409 PRIVATE char iso639_2[4];
410 PRIVATE uint8_t type; /* normal, visually impared, directors */
419 hb_audio_config_t config;
422 hb_fifo_t * fifo_in; /* AC3/MPEG/LPCM ES */
423 hb_fifo_t * fifo_raw; /* Raw audio */
424 hb_fifo_t * fifo_sync; /* Resampled, synced raw audio */
425 hb_fifo_t * fifo_out; /* MP3/AAC/Vorbis ES */
427 hb_esconfig_t config;
428 hb_mux_data_t * mux_data;
444 /* Visual-friendly duration */
449 /* Exact duration (in 1/90000s) */
452 /* Optional chapter title */
461 hb_subtitle_config_t config;
463 enum subtype { PICTURESUB, TEXTSUB } format;
464 enum subsource { VOBSUB, SRTSUB, CC608SUB, CC708SUB } source;
467 uint8_t type; /* Closed Caption, Childrens, Directors etc */
469 int hits; /* How many hits/occurrences of this subtitle */
470 int forced_hits; /* How many forced hits in this subtitle */
474 hb_fifo_t * fifo_in; /* SPU ES */
475 hb_fifo_t * fifo_raw; /* Decoded SPU */
476 hb_fifo_t * fifo_sync;/* Synced */
477 hb_fifo_t * fifo_out; /* Correct Timestamps, ready to be muxed */
478 hb_mux_data_t * mux_data;
487 char release_date[255];
491 uint32_t coverart_size;
509 /* Visual-friendly duration */
514 /* Exact duration (in 1/90000s) */
517 double aspect; // aspect ratio for the title's video
518 double container_aspect; // aspect ratio from container (0 if none)
521 int pixel_aspect_width;
522 int pixel_aspect_height;
526 enum { HB_MPEG2_PS_DEMUXER = 0, HB_MPEG2_TS_DEMUXER, HB_NULL_DEMUXER } demuxer;
527 int detected_interlacing;
528 int video_id; /* demuxer stream id for video */
529 int video_codec; /* worker object id of video codec */
530 int video_codec_param; /* codec specific config */
531 const char *video_codec_name;
533 const char *container_name;
536 uint32_t palette[16];
538 hb_metadata_t *metadata;
540 hb_list_t * list_chapter;
541 hb_list_t * list_audio;
542 hb_list_t * list_subtitle;
544 /* Job template for this title */
548 // set if video stream doesn't have IDR frames
549 #define HBTF_NO_IDR (1 << 0)
555 #define HB_STATE_IDLE 1
556 #define HB_STATE_SCANNING 2
557 #define HB_STATE_SCANDONE 4
558 #define HB_STATE_WORKING 8
559 #define HB_STATE_PAUSED 16
560 #define HB_STATE_WORKDONE 32
561 #define HB_STATE_MUXING 64
568 /* HB_STATE_SCANNING */
575 /* HB_STATE_WORKING */
589 /* HB_STATE_WORKDONE */
590 #define HB_ERROR_NONE 0
591 #define HB_ERROR_CANCELED 1
592 #define HB_ERROR_UNKNOWN 2
598 /* HB_STATE_MUXING */
604 typedef struct hb_work_info_s
616 struct { // info only valid for video decoders
619 int pixel_aspect_width;
620 int pixel_aspect_height;
623 struct { // info only valid for audio decoders
629 struct hb_work_object_s
635 int (* init) ( hb_work_object_t *, hb_job_t * );
636 int (* work) ( hb_work_object_t *, hb_buffer_t **,
638 void (* close) ( hb_work_object_t * );
639 /* the info entry point is used by scan to get bitstream information
640 * during a decode (i.e., it should only be called after at least one
641 * call to the 'work' entry point). currently it's only called for
642 * video streams & can be null for other work objects. */
643 int (* info) ( hb_work_object_t *, hb_work_info_t * );
644 /* the bitstream info entry point is used by scan to get bitstream
645 * information from a buffer. it doesn't have to be called during a
646 * decode (it can be called even if init & work haven't been).
647 * currently it's only called for audio streams & can be null for
648 * other work objects. */
649 int (* bsinfo) ( hb_work_object_t *, const hb_buffer_t *,
653 hb_fifo_t * fifo_out;
654 hb_esconfig_t * config;
656 /* Pointer hb_audio_t so we have access to the info in the audio worker threads. */
659 /* Pointer hb_subtitle_t so we have access to the info in the subtitle worker threads. */
660 hb_subtitle_t * subtitle;
662 hb_work_private_t * private_data;
664 hb_thread_t * thread;
670 hb_work_object_t * next;
671 int thread_sleep_interval;
675 extern hb_work_object_t hb_sync;
676 extern hb_work_object_t hb_decmpeg2;
677 extern hb_work_object_t hb_decvobsub;
678 extern hb_work_object_t hb_encvobsub;
679 extern hb_work_object_t hb_deccc608;
680 extern hb_work_object_t hb_decsrtsub;
681 extern hb_work_object_t hb_render;
682 extern hb_work_object_t hb_encavcodec;
683 extern hb_work_object_t hb_encx264;
684 extern hb_work_object_t hb_enctheora;
685 extern hb_work_object_t hb_deca52;
686 extern hb_work_object_t hb_decdca;
687 extern hb_work_object_t hb_decavcodec;
688 extern hb_work_object_t hb_decavcodecv;
689 extern hb_work_object_t hb_decavcodecvi;
690 extern hb_work_object_t hb_decavcodecai;
691 extern hb_work_object_t hb_declpcm;
692 extern hb_work_object_t hb_encfaac;
693 extern hb_work_object_t hb_enclame;
694 extern hb_work_object_t hb_encvorbis;
695 extern hb_work_object_t hb_encca_aac;
698 #define FILTER_DELAY 1
699 #define FILTER_FAILED 2
700 #define FILTER_DROP 3
702 struct hb_filter_object_s
709 hb_filter_private_t* (* init) ( int, int, int, char * );
711 int (* work) ( const hb_buffer_t *, hb_buffer_t **,
712 int, int, int, hb_filter_private_t * );
714 void (* close) ( hb_filter_private_t * );
716 hb_filter_private_t * private_data;
717 //hb_buffer_t * buffer;
721 extern hb_filter_object_t hb_filter_detelecine;
722 extern hb_filter_object_t hb_filter_deinterlace;
723 extern hb_filter_object_t hb_filter_deblock;
724 extern hb_filter_object_t hb_filter_denoise;
725 extern hb_filter_object_t hb_filter_decomb;
727 typedef void hb_error_handler_t( const char *errmsg );
729 extern void hb_register_error_handler( hb_error_handler_t * handler );