code.delx.au - pulseaudio/blob - 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 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 <pulsecore/log.h>
  27 #include <pulsecore/macro.h>
  28 #include <pulsecore/core-util.h>
  29 #include <pulse/sample.h>
  30
  31 #ifdef HAVE_SYS_RESOURCE_H
  32 #include <sys/resource.h>
  33 #endif
  34
  35 /* The actual command to execute */
  36 typedef enum pa_daemon_conf_cmd {
  37     PA_CMD_DAEMON,  /* the default */
  38     PA_CMD_START,
  39     PA_CMD_HELP,
  40     PA_CMD_VERSION,
  41     PA_CMD_DUMP_CONF,
  42     PA_CMD_DUMP_MODULES,
  43     PA_CMD_KILL,
  44     PA_CMD_CHECK,
  45     PA_CMD_DUMP_RESAMPLE_METHODS,
  46     PA_CMD_CLEANUP_SHM
  47 } pa_daemon_conf_cmd_t;
  48
  49 #ifdef HAVE_SYS_RESOURCE_H
  50 typedef struct pa_rlimit {
  51     rlim_t value;
  52     pa_bool_t is_set;
  53 } pa_rlimit;
  54 #endif
  55
  56 /* A structure containing configuration data for the PulseAudio server . */
  57 typedef struct pa_daemon_conf {
  58     pa_daemon_conf_cmd_t cmd;
  59     pa_bool_t daemonize,
  60         fail,
  61         high_priority,
  62         realtime_scheduling,
  63         disallow_module_loading,
  64         use_pid_file,
  65         system_instance,
  66         no_cpu_limit,
  67         disable_shm,
  68         disable_remixing,
  69         disable_lfe_remixing,
  70         load_default_script_file,
  71         disallow_exit,
  72         log_meta,
  73         log_time;
  74     int exit_idle_time,
  75         scache_idle_time,
  76         auto_log_target,
  77         realtime_priority,
  78         nice_level,
  79         resample_method;
  80     char *script_commands, *dl_search_path, *default_script_file;
  81     pa_log_target_t log_target;
  82     pa_log_level_t log_level;
  83     unsigned log_backtrace;
  84     char *config_file;
  85
  86 #ifdef HAVE_SYS_RESOURCE_H
  87     pa_rlimit rlimit_fsize, rlimit_data, rlimit_stack, rlimit_core, rlimit_rss;
  88
  89 #ifdef RLIMIT_NOFILE
  90     pa_rlimit rlimit_nofile;
  91 #endif
  92 #ifdef RLIMIT_AS
  93     pa_rlimit rlimit_as;
  94 #endif
  95 #ifdef RLIMIT_NPROC
  96     pa_rlimit rlimit_nproc;
  97 #endif
  98 #ifdef RLIMIT_MEMLOCK
  99     pa_rlimit rlimit_memlock;
 100 #endif
 101 #ifdef RLIMIT_LOCKS
 102     pa_rlimit rlimit_locks;
 103 #endif
 104 #ifdef RLIMIT_SIGPENDING
 105     pa_rlimit rlimit_sigpending;
 106 #endif
 107 #ifdef RLIMIT_MSGQUEUE
 108     pa_rlimit rlimit_msgqueue;
 109 #endif
 110 #ifdef RLIMIT_NICE
 111     pa_rlimit rlimit_nice;
 112 #endif
 113 #ifdef RLIMIT_RTPRIO
 114     pa_rlimit rlimit_rtprio;
 115 #endif
 116 #ifdef RLIMIT_RTTIME
 117     pa_rlimit rlimit_rttime;
 118 #endif
 119 #endif
 120
 121     unsigned default_n_fragments, default_fragment_size_msec;
 122     pa_sample_spec default_sample_spec;
 123     size_t shm_size;
 124 } pa_daemon_conf;
 125
 126 /* Allocate a new structure and fill it with sane defaults */
 127 pa_daemon_conf* pa_daemon_conf_new(void);
 128 void pa_daemon_conf_free(pa_daemon_conf*c);
 129
 130 /* Load configuration data from the specified file overwriting the
 131  * current settings in *c. If filename is NULL load the default daemon
 132  * configuration file */
 133 int pa_daemon_conf_load(pa_daemon_conf *c, const char *filename);
 134
 135 /* Pretty print the current configuration data of the daemon. The
 136  * returned string has to be freed manually. The output of this
 137  * function may be parsed with pa_daemon_conf_load(). */
 138 char *pa_daemon_conf_dump(pa_daemon_conf *c);
 139
 140 /* Load the configuration data from the process' environment
 141  * overwriting the current settings in *c. */
 142 int pa_daemon_conf_env(pa_daemon_conf *c);
 143
 144 /* Set these configuration variables in the structure by passing a string */
 145 int pa_daemon_conf_set_log_target(pa_daemon_conf *c, const char *string);
 146 int pa_daemon_conf_set_log_level(pa_daemon_conf *c, const char *string);
 147 int pa_daemon_conf_set_resample_method(pa_daemon_conf *c, const char *string);
 148
 149 const char *pa_daemon_conf_get_default_script_file(pa_daemon_conf *c);
 150 FILE *pa_daemon_conf_open_default_script_file(pa_daemon_conf *c);
 151
 152 #endif