CHANGES: Change md file extension to txt.
[asterisk/asterisk.git] / include / asterisk / options.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2005, Digium, Inc.
5  *
6  * Mark Spencer <markster@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*! \file
20  * \brief Options provided by main asterisk program
21  */
22
23 #ifndef _ASTERISK_OPTIONS_H
24 #define _ASTERISK_OPTIONS_H
25
26 #include "asterisk/autoconfig.h"
27
28 #if defined(__cplusplus) || defined(c_plusplus)
29 extern "C" {
30 #endif
31
32 #define AST_CACHE_DIR_LEN       512
33 #define AST_FILENAME_MAX        80
34 #define AST_CHANNEL_NAME    80  /*!< Max length of an ast_channel name */
35
36
37 /*! \ingroup main_options */
38 enum ast_option_flags {
39         /*! Allow \#exec in config files */
40         AST_OPT_FLAG_EXEC_INCLUDES = (1 << 0),
41         /*! Do not fork() */
42         AST_OPT_FLAG_NO_FORK = (1 << 1),
43         /*! Keep quiet */
44         AST_OPT_FLAG_QUIET = (1 << 2),
45         /*! Console mode */
46         AST_OPT_FLAG_CONSOLE = (1 << 3),
47         /*! Run in realtime Linux priority */
48         AST_OPT_FLAG_HIGH_PRIORITY = (1 << 4),
49         /*! Initialize keys for RSA authentication */
50         AST_OPT_FLAG_INIT_KEYS = (1 << 5),
51         /*! Remote console */
52         AST_OPT_FLAG_REMOTE = (1 << 6),
53         /*! Execute an asterisk CLI command upon startup */
54         AST_OPT_FLAG_EXEC = (1 << 7),
55         /*! Don't use termcap colors */
56         AST_OPT_FLAG_NO_COLOR = (1 << 8),
57         /*! Are we fully started yet? */
58         AST_OPT_FLAG_FULLY_BOOTED = (1 << 9),
59         /*! Trascode via signed linear */
60         AST_OPT_FLAG_TRANSCODE_VIA_SLIN = (1 << 10),
61         /*! Invoke the stdexten using the legacy macro method. */
62         AST_OPT_FLAG_STDEXTEN_MACRO = (1 << 11),
63         /*! Dump core on a seg fault */
64         AST_OPT_FLAG_DUMP_CORE = (1 << 12),
65         /*! Cache sound files */
66         AST_OPT_FLAG_CACHE_RECORD_FILES = (1 << 13),
67         /*! Display timestamp in CLI verbose output */
68         AST_OPT_FLAG_TIMESTAMP = (1 << 14),
69         /*! Cache media frames for performance */
70         AST_OPT_FLAG_CACHE_MEDIA_FRAMES = (1 << 15),
71         /*! Reconnect */
72         AST_OPT_FLAG_RECONNECT = (1 << 16),
73         /*! Transmit Silence during Record() and DTMF Generation */
74         AST_OPT_FLAG_TRANSMIT_SILENCE = (1 << 17),
75         /*! Suppress some warnings */
76         AST_OPT_FLAG_DONT_WARN = (1 << 18),
77         /*! Reference Debugging */
78         AST_OPT_FLAG_REF_DEBUG = (1 << 20),
79         /*! Always fork, even if verbose or debug settings are non-zero */
80         AST_OPT_FLAG_ALWAYS_FORK = (1 << 21),
81         /*! Disable log/verbose output to remote consoles */
82         AST_OPT_FLAG_MUTE = (1 << 22),
83         /*! There is a per-module debug setting */
84         AST_OPT_FLAG_DEBUG_MODULE = (1 << 23),
85         /*! Terminal colors should be adjusted for a light-colored background */
86         AST_OPT_FLAG_LIGHT_BACKGROUND = (1 << 25),
87         /*! Make the global Message channel an internal channel to suppress AMI events */
88         AST_OPT_FLAG_HIDE_MESSAGING_AMI_EVENTS = (1 << 26),
89         /*! Force black background */
90         AST_OPT_FLAG_FORCE_BLACK_BACKGROUND = (1 << 27),
91         /*! Hide remote console connect messages on console */
92         AST_OPT_FLAG_HIDE_CONSOLE_CONNECT = (1 << 28),
93         /*! Protect the configuration file path with a lock */
94         AST_OPT_FLAG_LOCK_CONFIG_DIR = (1 << 29),
95         /*! Generic PLC */
96         AST_OPT_FLAG_GENERIC_PLC = (1 << 30),
97         /*! Generic PLC onm equal codecs */
98         AST_OPT_FLAG_GENERIC_PLC_ON_EQUAL_CODECS = (1 << 31),
99 };
100
101 /*! These are the options that set by default when Asterisk starts */
102 #define AST_DEFAULT_OPTIONS (AST_OPT_FLAG_TRANSCODE_VIA_SLIN | AST_OPT_FLAG_CACHE_MEDIA_FRAMES)
103
104 #define ast_opt_exec_includes           ast_test_flag(&ast_options, AST_OPT_FLAG_EXEC_INCLUDES)
105 #define ast_opt_no_fork                 ast_test_flag(&ast_options, AST_OPT_FLAG_NO_FORK)
106 #define ast_opt_quiet                   ast_test_flag(&ast_options, AST_OPT_FLAG_QUIET)
107 #define ast_opt_console                 ast_test_flag(&ast_options, AST_OPT_FLAG_CONSOLE)
108 #define ast_opt_high_priority           ast_test_flag(&ast_options, AST_OPT_FLAG_HIGH_PRIORITY)
109 #define ast_opt_init_keys               ast_test_flag(&ast_options, AST_OPT_FLAG_INIT_KEYS)
110 #define ast_opt_remote                  ast_test_flag(&ast_options, AST_OPT_FLAG_REMOTE)
111 #define ast_opt_exec                    ast_test_flag(&ast_options, AST_OPT_FLAG_EXEC)
112 #define ast_opt_no_color                ast_test_flag(&ast_options, AST_OPT_FLAG_NO_COLOR)
113 #define ast_fully_booted                ast_test_flag(&ast_options, AST_OPT_FLAG_FULLY_BOOTED)
114 #define ast_opt_transcode_via_slin      ast_test_flag(&ast_options, AST_OPT_FLAG_TRANSCODE_VIA_SLIN)
115 /*! Invoke the stdexten using the legacy macro method. */
116 #define ast_opt_stdexten_macro          ast_test_flag(&ast_options, AST_OPT_FLAG_STDEXTEN_MACRO)
117 #define ast_opt_dump_core               ast_test_flag(&ast_options, AST_OPT_FLAG_DUMP_CORE)
118 #define ast_opt_cache_record_files      ast_test_flag(&ast_options, AST_OPT_FLAG_CACHE_RECORD_FILES)
119 #define ast_opt_cache_media_frames      ast_test_flag(&ast_options, AST_OPT_FLAG_CACHE_MEDIA_FRAMES)
120 #define ast_opt_timestamp               ast_test_flag(&ast_options, AST_OPT_FLAG_TIMESTAMP)
121 #define ast_opt_reconnect               ast_test_flag(&ast_options, AST_OPT_FLAG_RECONNECT)
122 #define ast_opt_transmit_silence        ast_test_flag(&ast_options, AST_OPT_FLAG_TRANSMIT_SILENCE)
123 #define ast_opt_dont_warn               ast_test_flag(&ast_options, AST_OPT_FLAG_DONT_WARN)
124 #define ast_opt_always_fork             ast_test_flag(&ast_options, AST_OPT_FLAG_ALWAYS_FORK)
125 #define ast_opt_mute                    ast_test_flag(&ast_options, AST_OPT_FLAG_MUTE)
126 #define ast_opt_dbg_module              ast_test_flag(&ast_options, AST_OPT_FLAG_DEBUG_MODULE)
127 #define ast_opt_light_background        ast_test_flag(&ast_options, AST_OPT_FLAG_LIGHT_BACKGROUND)
128 #define ast_opt_force_black_background  ast_test_flag(&ast_options, AST_OPT_FLAG_FORCE_BLACK_BACKGROUND)
129 #define ast_opt_hide_connect            ast_test_flag(&ast_options, AST_OPT_FLAG_HIDE_CONSOLE_CONNECT)
130 #define ast_opt_lock_confdir            ast_test_flag(&ast_options, AST_OPT_FLAG_LOCK_CONFIG_DIR)
131 #define ast_opt_generic_plc         ast_test_flag(&ast_options, AST_OPT_FLAG_GENERIC_PLC)
132 #define ast_opt_ref_debug           ast_test_flag(&ast_options, AST_OPT_FLAG_REF_DEBUG)
133 #define ast_opt_generic_plc_on_equal_codecs  ast_test_flag(&ast_options, AST_OPT_FLAG_GENERIC_PLC_ON_EQUAL_CODECS)
134 #define ast_opt_hide_messaging_ami_events  ast_test_flag(&ast_options, AST_OPT_FLAG_HIDE_MESSAGING_AMI_EVENTS)
135
136 /*! Maximum log level defined by PJPROJECT. */
137 #define MAX_PJ_LOG_MAX_LEVEL            6
138 /*!
139  * Normal PJPROJECT active log level used by Asterisk.
140  *
141  * These levels are usually mapped to Error and
142  * Warning Asterisk log levels which shouldn't
143  * normally be suppressed.
144  */
145 #define DEFAULT_PJ_LOG_MAX_LEVEL        2
146
147 /*!
148  * \brief Get maximum log level pjproject was compiled with.
149  *
150  * \details
151  * Determine the maximum log level the pjproject we are running
152  * with supports.
153  *
154  * When pjproject is initially loaded the default log level in
155  * effect is the maximum log level the library was compiled to
156  * generate.  We must save this value off somewhere before we
157  * change it to what we want to use as the default level.
158  *
159  * \note This must be done before calling pj_init() so the level
160  * we want to use as the default level is in effect while the
161  * library initializes.
162  */
163 #define AST_PJPROJECT_INIT_LOG_LEVEL()                                                  \
164         do {                                                                                                            \
165                 if (ast_pjproject_max_log_level < 0) {                                  \
166                         ast_pjproject_max_log_level = pj_log_get_level();       \
167                 }                                                                                                               \
168                 pj_log_set_level(ast_option_pjproject_log_level);               \
169         } while (0)
170
171 /*! Current linked pjproject maximum logging level */
172 extern int ast_pjproject_max_log_level;
173
174 #define DEFAULT_PJPROJECT_CACHE_POOLS   1
175
176 /*! Current pjproject pool caching enable */
177 extern int ast_option_pjproject_cache_pools;
178
179 /*! Current pjproject logging level */
180 extern int ast_option_pjproject_log_level;
181
182 extern struct ast_flags ast_options;
183
184 extern int option_verbose;
185 extern int ast_option_maxfiles;         /*!< Max number of open file handles (files, sockets) */
186 extern int option_debug;                /*!< Debugging */
187 extern int ast_option_maxcalls;         /*!< Maximum number of simultaneous channels */
188 extern unsigned int option_dtmfminduration;     /*!< Minimum duration of DTMF (channel.c) in ms */
189 extern double ast_option_maxload;
190 #if defined(HAVE_SYSINFO)
191 extern long option_minmemfree;          /*!< Minimum amount of free system memory - stop accepting calls if free memory falls below this watermark */
192 #endif
193 extern char ast_defaultlanguage[];
194
195 extern struct timeval ast_startuptime;
196 extern struct timeval ast_lastreloadtime;
197 extern pid_t ast_mainpid;
198
199 extern char record_cache_dir[AST_CACHE_DIR_LEN];
200
201 extern int ast_language_is_prefix;
202
203 extern int ast_option_rtpusedynamic;
204 extern unsigned int ast_option_rtpptdynamic;
205
206 #if defined(__cplusplus) || defined(c_plusplus)
207 }
208 #endif
209
210 #endif /* _ASTERISK_OPTIONS_H */