Moves the filters' logging info to work.c, adds parameter info. I also changed the...
[HandBrake.git] / libhb / hb.h
blobf1a3690551cb0194bf896afbfb9d827cfd4e49dd
1 #ifndef HB_HB_H
2 #define HB_HB_H
4 #ifdef __cplusplus
5 extern "C" {
6 #endif
8 #include "common.h"
10 /* hb_init()
11 Initializes a libhb session (launches his own thread, detects CPUs,
12 etc) */
13 #define HB_DEBUG_NONE 0
14 #define HB_DEBUG_ALL 1
15 void hb_register( hb_work_object_t * );
16 hb_handle_t * hb_init_real( int verbose, int update_check );
17 hb_handle_t * hb_init_dl ( int verbose, int update_check ); // hb_init for use with dylib
19 #define hb_init(v,u) \
20 hb_init_real( v, u ); \
21 hb_register( &hb_sync ); \
22 hb_register( &hb_decmpeg2 ); \
23 hb_register( &hb_decsub ); \
24 hb_register( &hb_render ); \
25 hb_register( &hb_encavcodec ); \
26 hb_register( &hb_encxvid ); \
27 hb_register( &hb_encx264 ); \
28 hb_register( &hb_deca52 ); \
29 hb_register( &hb_decdca ); \
30 hb_register( &hb_decavcodec ); \
31 hb_register( &hb_declpcm ); \
32 hb_register( &hb_encfaac ); \
33 hb_register( &hb_enclame ); \
34 hb_register( &hb_encvorbis ); \
36 #define hb_init_express(v,u) \
37 hb_init_real( v, u ); \
38 hb_register( &hb_sync ); \
39 hb_register( &hb_decmpeg2 ); \
40 hb_register( &hb_decsub ); \
41 hb_register( &hb_render ); \
42 hb_register( &hb_encavcodec ); \
43 hb_register( &hb_encx264 ); \
44 hb_register( &hb_deca52 ); \
45 hb_register( &hb_decdca ); \
46 hb_register( &hb_decavcodec ); \
47 hb_register( &hb_declpcm ); \
48 hb_register( &hb_encfaac ); \
50 /* hb_get_version() */
51 char * hb_get_version( hb_handle_t * );
52 int hb_get_build( hb_handle_t * );
54 /* hb_check_update()
55 Checks for an update on the website. If there is, returns the build
56 number and points 'version' to a version description. Returns a
57 negative value otherwise. */
58 int hb_check_update( hb_handle_t * h, char ** version );
60 /* hb_set_cpu_count()
61 Force libhb to act as if you had X CPU(s).
62 Default is to use the detected count (see also hb_get_cpu_count() in
63 ports.h) */
64 void hb_set_cpu_count( hb_handle_t *, int );
66 char * hb_dvd_name( char * path );
68 /* hb_scan()
69 Scan the specified path. Can be a DVD device, a VIDEO_TS folder or
70 a VOB file. If title_index is 0, scan all titles. */
71 void hb_scan( hb_handle_t *, const char * path,
72 int title_index );
74 /* hb_get_titles()
75 Returns the list of valid titles detected by the latest scan. */
76 hb_list_t * hb_get_titles( hb_handle_t * );
78 void hb_get_preview( hb_handle_t *, hb_title_t *, int,
79 uint8_t * );
80 void hb_set_size( hb_job_t *, int ratio, int pixels );
82 /* Handling jobs */
83 int hb_count( hb_handle_t * );
84 hb_job_t * hb_job( hb_handle_t *, int );
85 void hb_add( hb_handle_t *, hb_job_t * );
86 void hb_rem( hb_handle_t *, hb_job_t * );
88 void hb_start( hb_handle_t * );
89 void hb_pause( hb_handle_t * );
90 void hb_resume( hb_handle_t * );
91 void hb_stop( hb_handle_t * );
93 /* hb_get_state()
94 Should be regularly called by the UI (like 5 or 10 times a second).
95 Look at test/test.c to see how to use it. */
96 void hb_get_state( hb_handle_t *, hb_state_t * );
97 /* hb_get_scancount() is called by the MacGui in UpdateUI to
98 check for a new scan during HB_STATE_WORKING phase */
99 int hb_get_scancount( hb_handle_t * );
101 /* hb_close()
102 Aborts all current jobs if any, frees memory. */
103 void hb_close( hb_handle_t ** );
105 #ifdef __cplusplus
107 #endif
109 #endif