]> code.delx.au - pulseaudio/blob - src/daemon/daemon-conf.h
daemon: optionally call mlockall() on startup
[pulseaudio] / src / daemon / daemon-conf.h
1 #ifndef foodaemonconfhfoo
2 #define foodaemonconfhfoo
3
4 /***
5 This file is part of PulseAudio.
6
7 Copyright 2004-2006 Lennart Poettering
8 Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB
9
10 PulseAudio is free software; you can redistribute it and/or modify
11 it under the terms of the GNU Lesser General Public License as published
12 by the Free Software Foundation; either version 2.1 of the License,
13 or (at your option) any later version.
14
15 PulseAudio is distributed in the hope that it will be useful, but
16 WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 General Public License for more details.
19
20 You should have received a copy of the GNU Lesser General Public License
21 along with PulseAudio; if not, write to the Free Software
22 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
23 USA.
24 ***/
25
26 #include <pulse/sample.h>
27 #include <pulse/channelmap.h>
28
29 #include <pulsecore/log.h>
30 #include <pulsecore/macro.h>
31 #include <pulsecore/core-util.h>
32
33 #ifdef HAVE_SYS_RESOURCE_H
34 #include <sys/resource.h>
35 #endif
36
37 /* The actual command to execute */
38 typedef enum pa_daemon_conf_cmd {
39 PA_CMD_DAEMON, /* the default */
40 PA_CMD_START,
41 PA_CMD_HELP,
42 PA_CMD_VERSION,
43 PA_CMD_DUMP_CONF,
44 PA_CMD_DUMP_MODULES,
45 PA_CMD_KILL,
46 PA_CMD_CHECK,
47 PA_CMD_DUMP_RESAMPLE_METHODS,
48 PA_CMD_CLEANUP_SHM
49 } pa_daemon_conf_cmd_t;
50
51 #ifdef HAVE_SYS_RESOURCE_H
52 typedef struct pa_rlimit {
53 rlim_t value;
54 pa_bool_t is_set;
55 } pa_rlimit;
56 #endif
57
58 /* A structure containing configuration data for the PulseAudio server . */
59 typedef struct pa_daemon_conf {
60 pa_daemon_conf_cmd_t cmd;
61 pa_bool_t daemonize,
62 fail,
63 high_priority,
64 realtime_scheduling,
65 disallow_module_loading,
66 use_pid_file,
67 system_instance,
68 no_cpu_limit,
69 disable_shm,
70 disable_remixing,
71 disable_lfe_remixing,
72 load_default_script_file,
73 disallow_exit,
74 log_meta,
75 log_time,
76 flat_volumes,
77 lock_memory;
78 int exit_idle_time,
79 scache_idle_time,
80 auto_log_target,
81 realtime_priority,
82 nice_level,
83 resample_method;
84 char *script_commands, *dl_search_path, *default_script_file;
85 pa_log_target_t log_target;
86 pa_log_level_t log_level;
87 unsigned log_backtrace;
88 char *config_file;
89
90 #ifdef HAVE_SYS_RESOURCE_H
91 pa_rlimit rlimit_fsize, rlimit_data, rlimit_stack, rlimit_core;
92 #ifdef RLIMIT_RSS
93 pa_rlimit rlimit_rss;
94 #endif
95 #ifdef RLIMIT_NOFILE
96 pa_rlimit rlimit_nofile;
97 #endif
98 #ifdef RLIMIT_AS
99 pa_rlimit rlimit_as;
100 #endif
101 #ifdef RLIMIT_NPROC
102 pa_rlimit rlimit_nproc;
103 #endif
104 #ifdef RLIMIT_MEMLOCK
105 pa_rlimit rlimit_memlock;
106 #endif
107 #ifdef RLIMIT_LOCKS
108 pa_rlimit rlimit_locks;
109 #endif
110 #ifdef RLIMIT_SIGPENDING
111 pa_rlimit rlimit_sigpending;
112 #endif
113 #ifdef RLIMIT_MSGQUEUE
114 pa_rlimit rlimit_msgqueue;
115 #endif
116 #ifdef RLIMIT_NICE
117 pa_rlimit rlimit_nice;
118 #endif
119 #ifdef RLIMIT_RTPRIO
120 pa_rlimit rlimit_rtprio;
121 #endif
122 #ifdef RLIMIT_RTTIME
123 pa_rlimit rlimit_rttime;
124 #endif
125 #endif
126
127 unsigned default_n_fragments, default_fragment_size_msec;
128 pa_sample_spec default_sample_spec;
129 pa_channel_map default_channel_map;
130 size_t shm_size;
131 } pa_daemon_conf;
132
133 /* Allocate a new structure and fill it with sane defaults */
134 pa_daemon_conf* pa_daemon_conf_new(void);
135 void pa_daemon_conf_free(pa_daemon_conf*c);
136
137 /* Load configuration data from the specified file overwriting the
138 * current settings in *c. If filename is NULL load the default daemon
139 * configuration file */
140 int pa_daemon_conf_load(pa_daemon_conf *c, const char *filename);
141
142 /* Pretty print the current configuration data of the daemon. The
143 * returned string has to be freed manually. The output of this
144 * function may be parsed with pa_daemon_conf_load(). */
145 char *pa_daemon_conf_dump(pa_daemon_conf *c);
146
147 /* Load the configuration data from the process' environment
148 * overwriting the current settings in *c. */
149 int pa_daemon_conf_env(pa_daemon_conf *c);
150
151 /* Set these configuration variables in the structure by passing a string */
152 int pa_daemon_conf_set_log_target(pa_daemon_conf *c, const char *string);
153 int pa_daemon_conf_set_log_level(pa_daemon_conf *c, const char *string);
154 int pa_daemon_conf_set_resample_method(pa_daemon_conf *c, const char *string);
155
156 const char *pa_daemon_conf_get_default_script_file(pa_daemon_conf *c);
157 FILE *pa_daemon_conf_open_default_script_file(pa_daemon_conf *c);
158
159 #endif