forked from HandBrake/HandBrake
-
Notifications
You must be signed in to change notification settings - Fork 0
/
common.h
1446 lines (1274 loc) · 53.2 KB
/
common.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/* common.h
Copyright (c) 2003-2019 HandBrake Team
This file is part of the HandBrake source code
Homepage: <http://handbrake.fr/>.
It may be used under the terms of the GNU General Public License v2.
For full terms see the file COPYING file or visit http://www.gnu.org/licenses/gpl-2.0.html
*/
#ifndef HB_COMMON_H
#define HB_COMMON_H
#include "project.h"
#include "hbtypes.h"
#include "hb_dict.h"
#include <math.h>
#include <stdio.h>
#include <stdlib.h>
#include <stdarg.h>
#include <string.h>
#include <unistd.h>
#include <inttypes.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <dirent.h>
/*
* It seems WinXP doesn't align the stack of new threads to 16 bytes.
* To prevent crashes in SSE functions, we need to force stack alignment
* of new threads.
*/
#if defined( __GNUC__ ) && (defined( _WIN32 ) || defined( __MINGW32__ ))
# define attribute_align_thread __attribute__((force_align_arg_pointer))
#else
# define attribute_align_thread
#endif
#if defined( __GNUC__ ) && !(defined( _WIN32 ) || defined( __MINGW32__ ))
# define HB_WPRINTF(s,v) __attribute__((format(printf,s,v)))
#else
# define HB_WPRINTF(s,v)
#endif
#if defined( SYS_MINGW )
# define fseek fseeko64
# define ftell ftello64
# undef fseeko
# define fseeko fseeko64
# undef ftello
# define ftello ftello64
# define flockfile(...)
# define funlockfile(...)
# define getc_unlocked getc
# undef off_t
# define off_t off64_t
#endif
#ifndef MIN
#define MIN(a,b) (((a)<(b))?(a):(b))
#endif
#ifndef MAX
#define MAX(a,b) (((a)>(b))?(a):(b))
#endif
#ifndef ABS
#define ABS(a) ((a) > 0 ? (a) : (-(a)))
#endif
#define HB_ALIGN(x, a) (((x)+(a)-1)&~((a)-1))
#ifndef HB_DEBUG_ASSERT
#define HB_DEBUG_ASSERT(x, y) { if ((x)) { hb_error("ASSERT: %s", y); exit(1); } }
#endif
#define EVEN( a ) ((a) + ((a) & 1))
#define MULTIPLE_MOD(a, b) (((b) * (int)(((a) + ((b) / 2)) / (b))))
#define MULTIPLE_MOD_UP(a, b) (((b) * (int)(((a) + ((b) - 1)) / (b))))
#define MULTIPLE_MOD_DOWN(a, b) (((b) * (int)((a) / (b))))
#define HB_DVD_READ_BUFFER_SIZE 2048
#define HB_MIN_WIDTH 32
#define HB_MIN_HEIGHT 32
#define HB_MAX_WIDTH 20480
#define HB_MAX_HEIGHT 20480
typedef enum
{
HB_ERROR_NONE = 0,
HB_ERROR_CANCELED = 1,
HB_ERROR_WRONG_INPUT = 2,
HB_ERROR_INIT = 3,
HB_ERROR_UNKNOWN = 4,
HB_ERROR_READ = 5
} hb_error_code;
#include "ports.h"
#ifdef __LIBHB__
#include "internal.h"
#define PRIVATE
#else
#define PRIVATE const
#endif
#include "audio_remap.h"
#include "libavutil/channel_layout.h"
#if HB_PROJECT_FEATURE_QSV
#include "qsv_libav.h"
#endif
struct hb_buffer_list_s
{
hb_buffer_t *head;
hb_buffer_t *tail;
int count;
int size;
};
void hb_buffer_list_append(hb_buffer_list_t *list, hb_buffer_t *buf);
void hb_buffer_list_prepend(hb_buffer_list_t *list, hb_buffer_t *buf);
hb_buffer_t* hb_buffer_list_head(hb_buffer_list_t *list);
hb_buffer_t* hb_buffer_list_rem_head(hb_buffer_list_t *list);
hb_buffer_t* hb_buffer_list_tail(hb_buffer_list_t *list);
hb_buffer_t* hb_buffer_list_rem_tail(hb_buffer_list_t *list);
hb_buffer_t* hb_buffer_list_rem(hb_buffer_list_t *list, hb_buffer_t * b);
hb_buffer_t* hb_buffer_list_clear(hb_buffer_list_t *list);
hb_buffer_t* hb_buffer_list_set(hb_buffer_list_t *list, hb_buffer_t *buf);
void hb_buffer_list_close(hb_buffer_list_t *list);
int hb_buffer_list_count(hb_buffer_list_t *list);
int hb_buffer_list_size(hb_buffer_list_t *list);
hb_list_t * hb_list_init(void);
int hb_list_count( const hb_list_t * );
void hb_list_add( hb_list_t *, void * );
void hb_list_insert( hb_list_t * l, int pos, void * p );
void hb_list_rem( hb_list_t *, void * );
void * hb_list_item( const hb_list_t *, int );
void hb_list_close( hb_list_t ** );
void hb_reduce( int *x, int *y, int num, int den );
void hb_limit_rational( int *x, int *y, int num, int den, int limit );
void hb_reduce64( int64_t *x, int64_t *y, int64_t num, int64_t den );
void hb_limit_rational64( int64_t *x, int64_t *y, int64_t num, int64_t den, int64_t limit );
#define HB_KEEP_WIDTH 0x01
#define HB_KEEP_HEIGHT 0x02
#define HB_KEEP_DISPLAY_ASPECT 0x04
void hb_job_set_encoder_preset (hb_job_t *job, const char *preset);
void hb_job_set_encoder_tune (hb_job_t *job, const char *tune);
void hb_job_set_encoder_options(hb_job_t *job, const char *options);
void hb_job_set_encoder_profile(hb_job_t *job, const char *profile);
void hb_job_set_encoder_level (hb_job_t *job, const char *level);
void hb_job_set_file (hb_job_t *job, const char *file);
hb_audio_t *hb_audio_copy(const hb_audio_t *src);
hb_list_t *hb_audio_list_copy(const hb_list_t *src);
void hb_audio_close(hb_audio_t **audio);
void hb_audio_config_init(hb_audio_config_t * audiocfg);
int hb_audio_add(const hb_job_t * job, const hb_audio_config_t * audiocfg);
hb_audio_config_t * hb_list_audio_config_item(hb_list_t * list, int i);
int hb_subtitle_add_ssa_header(hb_subtitle_t *subtitle, const char *font,
int fs, int width, int height);
hb_subtitle_t *hb_subtitle_copy(const hb_subtitle_t *src);
hb_list_t *hb_subtitle_list_copy(const hb_list_t *src);
void hb_subtitle_close( hb_subtitle_t **sub );
int hb_subtitle_add(const hb_job_t * job, const hb_subtitle_config_t * subtitlecfg, int track);
int hb_import_subtitle_add( const hb_job_t * job,
const hb_subtitle_config_t * subtitlecfg,
const char *lang_code, int source );
int hb_srt_add(const hb_job_t * job, const hb_subtitle_config_t * subtitlecfg,
const char *lang);
int hb_subtitle_can_force( int source );
int hb_subtitle_can_burn( int source );
int hb_subtitle_can_pass( int source, int mux );
int hb_audio_can_apply_drc(uint32_t codec, uint32_t codec_param, int encoder);
int hb_audio_can_apply_drc2(hb_handle_t *h, int title_idx,
int audio_idx, int encoder);
hb_attachment_t *hb_attachment_copy(const hb_attachment_t *src);
hb_list_t *hb_attachment_list_copy(const hb_list_t *src);
void hb_attachment_close(hb_attachment_t **attachment);
hb_metadata_t * hb_metadata_init(void);
hb_metadata_t * hb_metadata_copy(const hb_metadata_t *src);
void hb_metadata_close(hb_metadata_t **metadata);
void hb_metadata_set_name( hb_metadata_t *metadata, const char *name );
void hb_metadata_set_artist( hb_metadata_t *metadata, const char *artist );
void hb_metadata_set_composer( hb_metadata_t *metadata, const char *composer );
void hb_metadata_set_release_date( hb_metadata_t *metadata, const char *release_date );
void hb_metadata_set_comment( hb_metadata_t *metadata, const char *comment );
void hb_metadata_set_genre( hb_metadata_t *metadata, const char *genre );
void hb_metadata_set_album( hb_metadata_t *metadata, const char *album );
void hb_metadata_set_album_artist( hb_metadata_t *metadata, const char *album_artist );
void hb_metadata_set_description( hb_metadata_t *metadata, const char *description );
void hb_metadata_set_long_description( hb_metadata_t *metadata, const char *long_description );
void hb_metadata_add_coverart( hb_metadata_t *metadata, const uint8_t *data, int size, int type );
void hb_metadata_rem_coverart( hb_metadata_t *metadata, int ii );
hb_chapter_t *hb_chapter_copy(const hb_chapter_t *src);
hb_list_t *hb_chapter_list_copy(const hb_list_t *src);
void hb_chapter_close(hb_chapter_t **chapter);
void hb_chapter_set_title(hb_chapter_t *chapter, const char *title);
// Update win/CS/HandBrake.Interop/HandBrakeInterop/HbLib/hb_rate_s.cs when changing this struct
struct hb_rate_s
{
const char *name;
int rate;
};
struct hb_dither_s
{
const char *description;
const char *short_name;
int method;
};
// Update win/CS/HandBrake.Interop/HandBrakeInterop/HbLib/hb_mixdown_s.cs when changing this struct
struct hb_mixdown_s
{
const char *name;
const char *short_name;
int amixdown;
};
// Update win/CS/HandBrake.Interop/HandBrakeInterop/HbLib/hb_encoder_s.cs when changing this struct
struct hb_encoder_s
{
const char *name; // note: used in presets
const char *short_name; // note: used in CLI
const char *long_name; // used in log
int codec; // HB_*CODEC_* define
int muxers; // supported muxers
};
// Update win/CS/HandBrake.Interop/HandBrakeInterop/HbLib/hb_container_s.cs when changing this struct
struct hb_container_s
{
const char *name;
const char *short_name;
const char *long_name;
const char *default_extension;
int format;
};
struct hb_rational_s
{
int num;
int den;
};
struct hb_geometry_s
{
int width;
int height;
hb_rational_t par;
};
struct hb_geometry_settings_s
{
int mode; // Anamorphic mode, see job struct anamorphic
int keep; // Specifies settings that shouldn't be changed
int itu_par; // use dvd dimensions to determine PAR
int modulus; // pixel alignment for loose anamorphic
int crop[4]; // Pixels cropped from source before scaling
int maxWidth; // max destination storage width
int maxHeight; // max destination storage height
hb_geometry_t geometry;
};
// Update win/CS/HandBrake.Interop/Interop/HbLib/hb_image_s.cs when changing this struct
struct hb_image_s
{
int format;
int max_plane;
int width;
int height;
uint8_t *data;
struct image_plane
{
uint8_t *data;
int width;
int height;
int stride;
int height_stride;
int size;
} plane[4];
};
void hb_image_close(hb_image_t **_image);
// Update win/CS/HandBrake.Interop/HandBrakeInterop/HbLib/hb_subtitle_config_s.cs when changing this struct
struct hb_subtitle_config_s
{
enum subdest { RENDERSUB, PASSTHRUSUB } dest;
int force;
int default_track;
const char * name;
/* SRT subtitle tracks only */
const char * src_filename;
char src_codeset[40];
int64_t offset;
};
/*******************************************************************************
* Lists of rates, mixdowns, encoders etc.
*******************************************************************************
*
* Use hb_*_get_next() to get the next list item (use NULL to get the first).
*
* Use hb_*_get_from_name() to get the value corresponding to a name.
* The name can be either the short or full name.
* Legacy names are sanitized to currently-supported values whenever possible.
* Returns 0 or -1 if no value could be found.
*
* Use hb_*_get_name() and hb_*_get_short_name() to get the corresponding value.
* Returns NULL if the value is invalid.
*
* Use hb_*_get_long_name() when the name is not descriptive enough for you.
*
* hb_*_sanitize_name() are convenience functions for use when dealing
* with full names (e.g. to translate legacy values while loading a preset).
*
* Names are case-insensitive; libhb will ensure that the lists do not contain
* more than one entry with the same name.
*
* Use hb_*_get_limits() to get the minimum/maximum for lists with numerically
* ordered values.
*
* Use hb_*_get_best() to sanitize a value based on other relevant parameters.
*
* Use hb_*_get_default() to get the default based on other relevant parameters.
*
*/
void hb_common_global_init(int);
int hb_video_framerate_get_from_name(const char *name);
const char* hb_video_framerate_get_name(int framerate);
const char* hb_video_framerate_sanitize_name(const char *name);
void hb_video_framerate_get_limits(int *low, int *high, int *clock);
const hb_rate_t* hb_video_framerate_get_next(const hb_rate_t *last);
int hb_video_framerate_get_close(hb_rational_t *framerate,
double thresh);
int hb_audio_samplerate_is_supported(int samplerate,
uint32_t codec);
int hb_audio_samplerate_find_closest(int samplerate,
uint32_t codec);
int hb_audio_samplerate_get_sr_shift(int samplerate);
int hb_audio_samplerate_get_from_name(const char *name);
const char* hb_audio_samplerate_get_name(int samplerate);
const hb_rate_t* hb_audio_samplerate_get_next(const hb_rate_t *last);
const hb_rate_t* hb_audio_samplerate_get_next_for_codec(const hb_rate_t *last,
uint32_t codec);
int hb_audio_bitrate_get_best(uint32_t codec, int bitrate, int samplerate, int mixdown);
int hb_audio_bitrate_get_default(uint32_t codec, int samplerate, int mixdown);
void hb_audio_bitrate_get_limits(uint32_t codec, int samplerate, int mixdown, int *low, int *high);
const hb_rate_t* hb_audio_bitrate_get_next(const hb_rate_t *last);
void hb_video_quality_get_limits(uint32_t codec, float *low, float *high, float *granularity, int *direction);
const char* hb_video_quality_get_name(uint32_t codec);
int hb_video_encoder_get_depth (int encoder);
const char* const* hb_video_encoder_get_presets (int encoder);
const char* const* hb_video_encoder_get_tunes (int encoder);
const char* const* hb_video_encoder_get_profiles(int encoder);
const char* const* hb_video_encoder_get_levels (int encoder);
void hb_audio_quality_get_limits(uint32_t codec, float *low, float *high, float *granularity, int *direction);
float hb_audio_quality_get_best(uint32_t codec, float quality);
float hb_audio_quality_get_default(uint32_t codec);
void hb_audio_compression_get_limits(uint32_t codec, float *low, float *high, float *granularity, int *direction);
float hb_audio_compression_get_best(uint32_t codec, float compression);
float hb_audio_compression_get_default(uint32_t codec);
int hb_audio_dither_get_default(void);
int hb_audio_dither_get_default_method(void); // default method, if enabled && supported
int hb_audio_dither_is_supported(uint32_t codec);
int hb_audio_dither_get_from_name(const char *name);
const char* hb_audio_dither_get_description(int method);
const hb_dither_t* hb_audio_dither_get_next(const hb_dither_t *last);
int hb_mixdown_is_supported(int mixdown, uint32_t codec, uint64_t layout);
int hb_mixdown_has_codec_support(int mixdown, uint32_t codec);
int hb_mixdown_has_remix_support(int mixdown, uint64_t layout);
int hb_mixdown_get_discrete_channel_count(int mixdown);
int hb_mixdown_get_low_freq_channel_count(int mixdown);
int hb_mixdown_get_best(uint32_t codec, uint64_t layout, int mixdown);
int hb_mixdown_get_default(uint32_t codec, uint64_t layout);
hb_mixdown_t* hb_mixdown_get_from_mixdown(int mixdown);
int hb_mixdown_get_from_name(const char *name);
const char* hb_mixdown_get_name(int mixdown);
const char* hb_mixdown_get_short_name(int mixdown);
const char* hb_mixdown_sanitize_name(const char *name);
const hb_mixdown_t* hb_mixdown_get_next(const hb_mixdown_t *last);
void hb_layout_get_name(char * name, int size, int64_t layout);
int hb_layout_get_discrete_channel_count(int64_t layout);
int hb_layout_get_low_freq_channel_count(int64_t layout);
int hb_video_encoder_get_default(int muxer);
hb_encoder_t* hb_video_encoder_get_from_codec(int codec);
int hb_video_encoder_get_from_name(const char *name);
const char* hb_video_encoder_get_name(int encoder);
const char* hb_video_encoder_get_short_name(int encoder);
const char* hb_video_encoder_get_long_name(int encoder);
const char* hb_video_encoder_sanitize_name(const char *name);
const hb_encoder_t* hb_video_encoder_get_next(const hb_encoder_t *last);
/*
* hb_audio_encoder_get_fallback_for_passthru() will sanitize a passthru codec
* to the matching audio encoder (if any is available).
*
* hb_audio_encoder_get_from_name(), hb_audio_encoder_sanitize_name() will
* sanitize legacy encoder names, but won't convert passthru to an encoder.
*/
int hb_audio_encoder_get_fallback_for_passthru(int passthru);
int hb_audio_encoder_get_default(int muxer);
hb_encoder_t* hb_audio_encoder_get_from_codec(int codec);
int hb_audio_encoder_get_from_name(const char *name);
const char* hb_audio_encoder_get_name(int encoder);
const char* hb_audio_encoder_get_short_name(int encoder);
const char* hb_audio_encoder_get_long_name(int encoder);
const char* hb_audio_encoder_sanitize_name(const char *name);
const hb_encoder_t* hb_audio_encoder_get_next(const hb_encoder_t *last);
const char* hb_audio_decoder_get_name(int codec, int codec_param);
/*
* Not typically used by the UIs
* (set hb_job_t.acodec_copy_mask, hb_job_t.acodec_fallback instead).
*/
void hb_autopassthru_apply_settings(hb_job_t *job);
void hb_autopassthru_print_settings(hb_job_t *job);
int hb_autopassthru_get_encoder(int in_codec, int copy_mask, int fallback, int muxer);
hb_container_t* hb_container_get_from_format(int format);
int hb_container_get_from_name(const char *name);
int hb_container_get_from_extension(const char *extension); // not really a container name
const char* hb_container_get_name(int format);
const char* hb_container_get_short_name(int format);
const char* hb_container_get_long_name(int format);
const char* hb_container_get_default_extension(int format);
const char* hb_container_sanitize_name(const char *name);
const hb_container_t* hb_container_get_next(const hb_container_t *last);
// Update win/CS/HandBrake.Interop/HandBrakeInterop/HbLib/hb_title_set_s.cs when changing this struct
struct hb_title_set_s
{
hb_list_t * list_title;
int feature; // Detected DVD feature title
const char * path;
};
typedef enum
{
HB_ANAMORPHIC_NONE,
HB_ANAMORPHIC_STRICT,
HB_ANAMORPHIC_LOOSE,
HB_ANAMORPHIC_CUSTOM,
HB_ANAMORPHIC_AUTO
} hb_anamorphic_mode_t;
/******************************************************************************
* hb_job_t: settings to be filled by the UI
* Update win/CS/HandBrake.Interop/HandBrakeInterop/HbLib/hb_job_s.cs when changing this struct
*****************************************************************************/
struct hb_job_s
{
const char * json; // JSON encoded job string
/* ID assigned by UI so it can groups job passes together */
int sequence_id;
/* Pointer to the title to be ripped */
hb_title_t * title;
int feature; // Detected DVD feature title
/* Chapter selection */
int chapter_start;
int chapter_end;
/* Include chapter marker track in mp4? */
int chapter_markers;
// Video filters
int grayscale; // Black and white encoding
hb_list_t * list_filter;
PRIVATE int crop[4];
PRIVATE int width;
PRIVATE int height;
hb_rational_t par;
/* Video settings:
vcodec: output codec
vquality: output quality (if invalid, bitrate is used instead)
vbitrate: output bitrate (Kbps)
vrate: output framerate
cfr: 0 (vfr), 1 (cfr), 2 (pfr) [see render.c]
pass: 0, 1 or 2 (or -1 for scan)
areBframes: boolean to note if b-frames are used */
#define HB_VCODEC_MASK 0x0FFFFFF
#define HB_VCODEC_INVALID 0x0000000
#define HB_VCODEC_THEORA 0x0000002
#define HB_VCODEC_FFMPEG_MPEG4 0x0000010
#define HB_VCODEC_FFMPEG_MPEG2 0x0000020
#define HB_VCODEC_FFMPEG_VP8 0x0000040
#define HB_VCODEC_FFMPEG_VP9 0x0000080
#define HB_VCODEC_FFMPEG_VCE_H264 0x00040000
#define HB_VCODEC_FFMPEG_VCE_H265 0x00080000
#define HB_VCODEC_FFMPEG_NVENC_H264 0x00100000
#define HB_VCODEC_FFMPEG_NVENC_H265 0x00200000
#define HB_VCODEC_FFMPEG_VT_H264 0x00400000
#define HB_VCODEC_FFMPEG_VT_H265 0x00800000
#define HB_VCODEC_FFMPEG_MASK (0x00000F0|HB_VCODEC_FFMPEG_VCE_H264|HB_VCODEC_FFMPEG_VCE_H265|HB_VCODEC_FFMPEG_NVENC_H264|HB_VCODEC_FFMPEG_NVENC_H265|HB_VCODEC_FFMPEG_VT_H264|HB_VCODEC_FFMPEG_VT_H265)
#define HB_VCODEC_QSV_H264 0x0000100
#define HB_VCODEC_QSV_H265_8BIT 0x0000200
#define HB_VCODEC_QSV_H265_10BIT 0x0000400
#define HB_VCODEC_QSV_H265_MASK 0x0000600
#define HB_VCODEC_QSV_H265 HB_VCODEC_QSV_H265_8BIT
#define HB_VCODEC_QSV_MASK 0x0000F00
#define HB_VCODEC_X264_8BIT 0x0010000
#define HB_VCODEC_X264 HB_VCODEC_X264_8BIT
#define HB_VCODEC_X264_10BIT 0x0020000
#define HB_VCODEC_X264_MASK 0x0030000
#define HB_VCODEC_H264_MASK (HB_VCODEC_X264_MASK|HB_VCODEC_QSV_H264|HB_VCODEC_FFMPEG_VCE_H264|HB_VCODEC_FFMPEG_NVENC_H264|HB_VCODEC_FFMPEG_VT_H264)
#define HB_VCODEC_X265_8BIT 0x0001000
#define HB_VCODEC_X265 HB_VCODEC_X265_8BIT
#define HB_VCODEC_X265_10BIT 0x0002000
#define HB_VCODEC_X265_12BIT 0x0004000
#define HB_VCODEC_X265_16BIT 0x0008000
#define HB_VCODEC_X265_MASK 0x000F000
#define HB_VCODEC_H265_MASK (HB_VCODEC_X265_MASK|HB_VCODEC_QSV_H265_MASK|HB_VCODEC_FFMPEG_VCE_H265|HB_VCODEC_FFMPEG_NVENC_H265|HB_VCODEC_FFMPEG_VT_H265)
/* define an invalid CQ value compatible with all CQ-capable codecs */
#define HB_INVALID_VIDEO_QUALITY (-1000.)
int vcodec;
double vquality;
int vbitrate;
hb_rational_t vrate;
// Some parameters that depend on vrate (like keyint) can't change
// between encoding passes. So orig_vrate is used to store the
// 1st pass rate.
hb_rational_t orig_vrate;
int cfr;
PRIVATE int pass_id;
int twopass; // Enable 2-pass encode. Boolean
int fastfirstpass;
char *encoder_preset;
char *encoder_tune;
char *encoder_options;
char *encoder_profile;
char *encoder_level;
int areBframes;
int pix_fmt;
int color_prim;
int color_transfer;
int color_matrix;
int color_range;
int color_prim_override;
int color_transfer_override;
int color_matrix_override;
// see https://developer.apple.com/library/content/technotes/tn2162/_index.html
// https://developer.apple.com/library/content/documentation/QuickTime/QTFF/QTFFChap3/qtff3.html#//apple_ref/doc/uid/TP40000939-CH205-125526
// libav pixfmt.h
#define HB_COLR_PRI_BT709 1
#define HB_COLR_PRI_UNDEF 2
#define HB_COLR_PRI_BT470M 4
#define HB_COLR_PRI_EBUTECH 5 // use for bt470bg
#define HB_COLR_PRI_SMPTEC 6 // smpte170m
#define HB_COLR_PRI_SMPTE240M 7
#define HB_COLR_PRI_FILM 8 // Illuminant C
#define HB_COLR_PRI_BT2020 9
#define HB_COLR_PRI_SMPTE428 10
#define HB_COLR_PRI_SMPTE431 11
#define HB_COLR_PRI_SMPTE432 12
#define HB_COLR_PRI_JEDEC_P22 22
// 0, 3-4, 7-8, 10-65535: reserved/not implemented
#define HB_COLR_TRA_BT709 1 // also use for bt470m, bt470bg, smpte170m, bt2020_10 and bt2020_12
#define HB_COLR_TRA_UNDEF 2
#define HB_COLR_TRA_GAMMA22 4
#define HB_COLR_TRA_GAMMA28 5
#define HB_COLR_TRA_SMPTE170M 6
#define HB_COLR_TRA_SMPTE240M 7
#define HB_COLR_TRA_LINEAR 8
#define HB_COLR_TRA_LOG 9
#define HB_COLR_TRA_LOG_SQRT 10
#define HB_COLR_TRA_IEC61966_2_4 11
#define HB_COLR_TRA_BT1361_ECG 12
#define HB_COLR_TRA_IEC61966_2_1 13
#define HB_COLR_TRA_BT2020_10 14
#define HB_COLR_TRA_BT2020_12 15
#define HB_COLR_TRA_SMPTEST2084 16
#define HB_COLR_TRA_SMPTE428 17
#define HB_COLR_TRA_ARIB_STD_B67 18 //known as "Hybrid log-gamma"
// 0, 3-6, 8-15, 17-65535: reserved/not implemented
#define HB_COLR_MAT_RGB 0
#define HB_COLR_MAT_BT709 1
#define HB_COLR_MAT_UNDEF 2
#define HB_COLR_MAT_FCC 4
#define HB_COLR_MAT_BT470BG 5
#define HB_COLR_MAT_SMPTE170M 6 // also use for fcc and bt470bg
#define HB_COLR_MAT_SMPTE240M 7
#define HB_COLR_MAT_YCGCO 8
#define HB_COLR_MAT_BT2020_NCL 9
#define HB_COLR_MAT_BT2020_CL 10
#define HB_COLR_MAT_SMPTE2085 11
#define HB_COLR_MAT_CD_NCL 12 // chromaticity derived non-constant lum
#define HB_COLR_MAT_CD_CL 13 // chromaticity derived constant lum
#define HB_COLR_MAT_ICTCP 14 // ITU-R BT.2100-0, ICtCp
// 0, 3-5, 8, 11-65535: reserved/not implemented
hb_list_t * list_chapter;
/* List of audio settings. */
hb_list_t * list_audio;
int acodec_copy_mask; // Auto Passthru allowed codecs
int acodec_fallback; // Auto Passthru fallback encoder
/* Subtitles */
hb_list_t * list_subtitle;
hb_list_t * list_attachment;
hb_metadata_t * metadata;
/*
* Muxer settings
* mux: output file format
* file: file path
*/
#define HB_MUX_MASK 0xFF0001
#define HB_MUX_INVALID 0x000000
#define HB_MUX_MP4V2 0x010000
#define HB_MUX_AV_MP4 0x020000
#define HB_MUX_MASK_MP4 0x030000
#define HB_MUX_LIBMKV 0x100000
#define HB_MUX_AV_MKV 0x200000
#define HB_MUX_AV_WEBM 0x400000
#define HB_MUX_MASK_MKV 0x300000
#define HB_MUX_MASK_AV 0x620000
#define HB_MUX_MASK_WEBM 0x400000
/* default muxer for each container */
#define HB_MUX_MP4 HB_MUX_AV_MP4
#define HB_MUX_MKV HB_MUX_AV_MKV
#define HB_MUX_WEBM HB_MUX_AV_WEBM
int mux;
char * file;
int inline_parameter_sets;
// Put h.264/h.265 SPS and PPS
// inline in the stream. This
// is necessary when constructing
// adaptive streaming dash files.
int align_av_start; // align A/V stream start times.
// This is used to work around mp4
// players that do not support edit
// lists. When this option is used
// the resulting stream is not a
// faithful reproduction of the source
// stream and may have blank frames
// added or initial frames dropped.
int mp4_optimize;
int ipod_atom;
int indepth_scan;
hb_subtitle_config_t select_subtitle_config;
int angle; // dvd angle to encode
int frame_to_start; // declare eof when we hit this frame
int64_t pts_to_start; // drop frames until we pass this pts
// in the time-linearized input stream
int frame_to_stop; // declare eof when we hit this frame
int64_t pts_to_stop; // declare eof when we pass this pts in
// the time-linearized input stream
int start_at_preview; // if non-zero, encoding will start
// at the position of preview n
int seek_points; // out of N previews
uint32_t frames_to_skip; // decode but discard this many frames
// initially (for frame accurate positioning
// to non-I frames).
PRIVATE int use_decomb;
PRIVATE int use_detelecine;
// QSV-specific settings
struct
{
int decode;
int async_depth;
#if HB_PROJECT_FEATURE_QSV
hb_qsv_context *ctx;
#endif
// shared encoding parameters
// initialized by the QSV encoder, then used upstream (e.g. by filters)
// to configure their output so that it matches what the encoder expects
struct
{
int pic_struct;
int align_width;
int align_height;
int is_init_done;
} enc_info;
} qsv;
#ifdef __LIBHB__
/* Internal data */
hb_handle_t * h;
volatile hb_error_code * done_error;
volatile int * die;
volatile int done;
uint64_t st_paused;
hb_fifo_t * fifo_mpeg2; /* MPEG-2 video ES */
hb_fifo_t * fifo_raw; /* Raw pictures */
hb_fifo_t * fifo_sync; /* Raw pictures, framerate corrected */
hb_fifo_t * fifo_render; /* Raw pictures, scaled */
hb_fifo_t * fifo_mpeg4; /* MPEG-4 video ES */
hb_list_t * list_work;
hb_esconfig_t config;
hb_mux_data_t * mux_data;
int64_t reader_pts_offset; // Reader can discard some video.
// Other pipeline stages need to know
// this. E.g. sync and decsrtsub
#endif
};
/* Audio starts here */
/* Audio Codecs: Update win/CS/HandBrake.Interop/HandBrakeInterop/HbLib/NativeConstants.cs when changing these consts */
#define HB_ACODEC_INVALID 0x00000000
#define HB_ACODEC_NONE 0x00000001
#define HB_ACODEC_MASK 0x07FFFF01
#define HB_ACODEC_LAME 0x00000200
#define HB_ACODEC_VORBIS 0x00000400
#define HB_ACODEC_AC3 0x00000800
#define HB_ACODEC_LPCM 0x00001000
#define HB_ACODEC_DCA 0x00002000
#define HB_ACODEC_CA_AAC 0x00004000
#define HB_ACODEC_CA_HAAC 0x00008000
#define HB_ACODEC_FFAAC 0x00010000
#define HB_ACODEC_FFMPEG 0x00020000
#define HB_ACODEC_DCA_HD 0x00040000
#define HB_ACODEC_MP3 0x00080000
#define HB_ACODEC_FFFLAC 0x00100000
#define HB_ACODEC_FFFLAC24 0x00200000
#define HB_ACODEC_FDK_AAC 0x00400000
#define HB_ACODEC_FDK_HAAC 0x00800000
#define HB_ACODEC_FFEAC3 0x01000000
#define HB_ACODEC_FFTRUEHD 0x02000000
#define HB_ACODEC_OPUS 0x04000000
#define HB_ACODEC_FF_MASK 0x07FF2800
#define HB_ACODEC_PASS_FLAG 0x40000000
#define HB_ACODEC_PASS_MASK (HB_ACODEC_AC3 | HB_ACODEC_DCA | HB_ACODEC_DCA_HD | HB_ACODEC_FFAAC | HB_ACODEC_FFEAC3 | HB_ACODEC_FFFLAC | HB_ACODEC_MP3 | HB_ACODEC_FFTRUEHD)
#define HB_ACODEC_AUTO_PASS (HB_ACODEC_PASS_FLAG | HB_ACODEC_PASS_MASK)
#define HB_ACODEC_ANY (HB_ACODEC_PASS_FLAG | HB_ACODEC_MASK)
#define HB_ACODEC_AAC_PASS (HB_ACODEC_PASS_FLAG | HB_ACODEC_FFAAC)
#define HB_ACODEC_AC3_PASS (HB_ACODEC_PASS_FLAG | HB_ACODEC_AC3)
#define HB_ACODEC_DCA_PASS (HB_ACODEC_PASS_FLAG | HB_ACODEC_DCA)
#define HB_ACODEC_DCA_HD_PASS (HB_ACODEC_PASS_FLAG | HB_ACODEC_DCA_HD)
#define HB_ACODEC_EAC3_PASS (HB_ACODEC_PASS_FLAG | HB_ACODEC_FFEAC3)
#define HB_ACODEC_FLAC_PASS (HB_ACODEC_PASS_FLAG | HB_ACODEC_FFFLAC)
#define HB_ACODEC_MP3_PASS (HB_ACODEC_PASS_FLAG | HB_ACODEC_MP3)
#define HB_ACODEC_TRUEHD_PASS (HB_ACODEC_PASS_FLAG | HB_ACODEC_FFTRUEHD)
#define HB_SUBSTREAM_BD_TRUEHD 0x72
#define HB_SUBSTREAM_BD_AC3 0x76
#define HB_SUBSTREAM_BD_DTSHD 0x72
#define HB_SUBSTREAM_BD_DTS 0x71
/* define an invalid VBR quality compatible with all VBR-capable codecs */
#define HB_INVALID_AUDIO_QUALITY (-3.)
#define HB_AUDIO_ATTR_NONE 0x00
#define HB_AUDIO_ATTR_NORMAL 0x01
#define HB_AUDIO_ATTR_VISUALLY_IMPAIRED 0x02
#define HB_AUDIO_ATTR_COMMENTARY 0x04
#define HB_AUDIO_ATTR_ALT_COMMENTARY 0x08
#define HB_AUDIO_ATTR_SECONDARY 0x10
#define HB_AUDIO_ATTR_DEFAULT 0x20
// This mask should contain all attributes that are allowed for default
// audio track selection
#define HB_AUDIO_ATTR_REGULAR_MASK 0x21
// Update win/CS/HandBrake.Interop/HandBrakeInterop/HbLib/hb_audio_config_s.cs when changing this struct
struct hb_audio_config_s
{
/* Output */
struct
{
enum
{
// make sure audio->config.out.mixdown isn't treated as unsigned
HB_INVALID_AMIXDOWN = -1,
HB_AMIXDOWN_NONE = 0,
HB_AMIXDOWN_MONO,
HB_AMIXDOWN_LEFT,
HB_AMIXDOWN_RIGHT,
HB_AMIXDOWN_STEREO,
HB_AMIXDOWN_DOLBY,
HB_AMIXDOWN_DOLBYPLII,
HB_AMIXDOWN_5POINT1,
HB_AMIXDOWN_6POINT1,
HB_AMIXDOWN_7POINT1,
HB_AMIXDOWN_5_2_LFE,
} mixdown; /* Audio mixdown */
int track; /* Output track number */
uint32_t codec; /* Output audio codec */
int samplerate; /* Output sample rate (Hz) */
int samples_per_frame; /* Number of samples per frame */
int bitrate; /* Output bitrate (Kbps) */
double quality; /* Output quality (encoder-specific) */
double compression_level; /* Output compression level (encoder-specific) */
double dynamic_range_compression; /* Amount of DRC applied to this track */
double gain; /* Gain (in dB), negative is quieter */
int normalize_mix_level; /* mix level normalization (boolean) */
int dither_method; /* dither algorithm */
const char * name; /* Output track name */
} out;
/* Input */
struct
{
int track; /* Input track number */
PRIVATE uint32_t codec; /* Input audio codec */
PRIVATE uint32_t codec_param; /* Per-codec config info */
PRIVATE uint32_t reg_desc; /* Registration descriptor of source */
PRIVATE uint32_t stream_type; /* Stream type from source stream */
PRIVATE uint32_t substream_type; /* Substream type for multiplexed streams */
PRIVATE uint32_t version; /* Bitsream version */
PRIVATE uint32_t flags; /* Bitstream flags, codec-specific */
PRIVATE uint32_t mode; /* Bitstream mode, codec-specific */
PRIVATE int samplerate; /* Input sample rate (Hz) */
PRIVATE int sample_bit_depth; /* Input samples' bit depth (0 if unknown) */
PRIVATE int samples_per_frame; /* Number of samples per frame */
PRIVATE int bitrate; /* Input bitrate (bps) */
PRIVATE int matrix_encoding; /* Source matrix encoding mode, set by the audio decoder */
PRIVATE uint64_t channel_layout; /* Source channel layout, set by the audio decoder */
PRIVATE hb_chan_map_t * channel_map; /* Source channel map, set by the audio decoder */
PRIVATE int encoder_delay; /* Encoder delay in samples.
* These samples should be dropped
* when decoding */
PRIVATE hb_rational_t timebase;
const char * name;
} in;
struct
{
PRIVATE char description[1024];
PRIVATE char simple[1024];
PRIVATE char iso639_2[4];
PRIVATE uint32_t attributes; /* normal, visually impaired, director's commentary */
} lang;
};
#ifdef __LIBHB__
// Update win/CS/HandBrake.Interop/HandBrakeInterop/HbLib/hb_audio_s.cs when changing this struct
struct hb_audio_s
{
int id;
hb_audio_config_t config;
struct {
hb_fifo_t * fifo_in; /* AC3/MPEG/LPCM ES */
hb_fifo_t * fifo_raw; /* Raw audio */
hb_fifo_t * fifo_sync; /* Resampled, synced raw audio */
hb_fifo_t * fifo_out; /* MP3/AAC/Vorbis ES */
hb_esconfig_t config;
hb_mux_data_t * mux_data;
hb_fifo_t * scan_cache;
} priv;
};
#endif
// Update win/CS/HandBrake.Interop/HandBrakeInterop/HbLib/hb_chapter_s.cs when changing this struct
struct hb_chapter_s
{
int index;
/* Visual-friendly duration */
int hours;
int minutes;
int seconds;
/* Exact duration (in 1/90000s) */
uint64_t duration;
/* Optional chapter title */
char *title;
};
/*
* A subtitle track.
*
* Required fields when a demuxer creates a subtitle track are:
* > id
* - ID of this track
* - must be unique for all tracks within a single job,
* since it is used to look up the appropriate in-FIFO with GetFifoForId()
* > format
* - format of the packets the subtitle decoder work-object sends to sub->fifo_raw
* - for passthru subtitles, is also the format of the final packets sent to sub->fifo_out
* - PICTURESUB for banded 8-bit YAUV pixels; see decvobsub.c documentation for more info
* - TEXTSUB for UTF-8 text marked up with <b>, <i>, or <u>
* - read by the muxers, and by the subtitle burn-in logic in the hb_sync_video work-object
* > source
* - used to create the appropriate subtitle decoder work-object in do_job()
* > config.dest
* - whether to render the subtitle on the video track (RENDERSUB) or
* to pass it through its own subtitle track in the output container (PASSTHRUSUB)
* - all newly created non-VOBSUB tracks should default to PASSTHRUSUB
* - all newly created VOBSUB tracks should default to RENDERSUB, for legacy compatibility
* > lang
* - user-readable description of the subtitle track
* - may correspond to the language of the track (see the 'iso639_2' field)
* - may correspond to the type of track (see the 'type' field; ex: "Closed Captions")
* > iso639_2
* - language code for the subtitle, or "und" if unknown
*
* Update win/CS/HandBrake.Interop/HandBrakeInterop/HbLib/hb_subtitle_s.cs when changing this struct
*/
#define HB_SUBTITLE_ATTR_UNKNOWN 0x0000
#define HB_SUBTITLE_ATTR_NORMAL 0x0001
#define HB_SUBTITLE_ATTR_LARGE 0x0002
#define HB_SUBTITLE_ATTR_CHILDREN 0x0004
#define HB_SUBTITLE_ATTR_CC 0x0008
#define HB_SUBTITLE_ATTR_FORCED 0x0010
#define HB_SUBTITLE_ATTR_COMMENTARY 0x0020
#define HB_SUBTITLE_ATTR_4_3 0x0040
#define HB_SUBTITLE_ATTR_WIDE 0x0080
#define HB_SUBTITLE_ATTR_LETTERBOX 0x0100
#define HB_SUBTITLE_ATTR_PANSCAN 0x0200
#define HB_SUBTITLE_ATTR_DEFAULT 0x0400
#define HB_SUBTITLE_IMPORT_TAG 0xFF000000
#define HB_SUBTITLE_EMBEDDED_CC_TAG 0xFE000000
struct hb_subtitle_s
{
int id;
int track;
int out_track;
hb_subtitle_config_t config;
enum subtype { PICTURESUB, TEXTSUB } format;
enum subsource { VOBSUB, CC608SUB, /*unused*/CC708SUB,
UTF8SUB, TX3GSUB, SSASUB, PGSSUB,
IMPORTSRT, IMPORTSSA, SRTSUB = IMPORTSRT } source;
const char * name;
char lang[1024];
char iso639_2[4];
uint32_t attributes; /* Closed Caption, Childrens, Directors etc */
// Color lookup table for VOB subtitle tracks. Each entry is in YCbCr format.
// Must be filled out by the demuxer for VOB subtitle tracks.
uint32_t palette[16];
uint8_t palette_set;
int width;
int height;
// Codec private data for subtitles originating from FFMPEG sources
uint8_t * extradata;
int extradata_size;
int hits; /* How many hits/occurrences of this subtitle */
int forced_hits; /* How many forced hits in this subtitle */
#ifdef __LIBHB__
/* Internal data */
uint32_t codec; /* Input "codec" */
uint32_t reg_desc; /* registration descriptor of source */
uint32_t stream_type; /* stream type from source stream */
uint32_t substream_type; /* substream for multiplexed streams */
hb_rational_t timebase;
hb_fifo_t * fifo_in; /* SPU ES */
hb_fifo_t * fifo_raw; /* Decoded SPU */
hb_fifo_t * fifo_out; /* Correct Timestamps, ready to be muxed */
hb_mux_data_t * mux_data;