MPD
Data Structures | Macros | Functions
conf.h File Reference
#include <stdbool.h>
#include <glib.h>

Go to the source code of this file.

Data Structures

struct  block_param
 
struct  config_param
 

Macros

#define CONF_MUSIC_DIR   "music_directory"
 
#define CONF_PLAYLIST_DIR   "playlist_directory"
 
#define CONF_FOLLOW_INSIDE_SYMLINKS   "follow_inside_symlinks"
 
#define CONF_FOLLOW_OUTSIDE_SYMLINKS   "follow_outside_symlinks"
 
#define CONF_DB_FILE   "db_file"
 
#define CONF_STICKER_FILE   "sticker_file"
 
#define CONF_LOG_FILE   "log_file"
 
#define CONF_PID_FILE   "pid_file"
 
#define CONF_STATE_FILE   "state_file"
 
#define CONF_USER   "user"
 
#define CONF_GROUP   "group"
 
#define CONF_BIND_TO_ADDRESS   "bind_to_address"
 
#define CONF_PORT   "port"
 
#define CONF_LOG_LEVEL   "log_level"
 
#define CONF_ZEROCONF_NAME   "zeroconf_name"
 
#define CONF_ZEROCONF_ENABLED   "zeroconf_enabled"
 
#define CONF_PASSWORD   "password"
 
#define CONF_DEFAULT_PERMS   "default_permissions"
 
#define CONF_AUDIO_OUTPUT   "audio_output"
 
#define CONF_AUDIO_FILTER   "filter"
 
#define CONF_AUDIO_OUTPUT_FORMAT   "audio_output_format"
 
#define CONF_MIXER_TYPE   "mixer_type"
 
#define CONF_REPLAYGAIN   "replaygain"
 
#define CONF_REPLAYGAIN_PREAMP   "replaygain_preamp"
 
#define CONF_REPLAYGAIN_MISSING_PREAMP   "replaygain_missing_preamp"
 
#define CONF_REPLAYGAIN_LIMIT   "replaygain_limit"
 
#define CONF_VOLUME_NORMALIZATION   "volume_normalization"
 
#define CONF_SAMPLERATE_CONVERTER   "samplerate_converter"
 
#define CONF_AUDIO_BUFFER_SIZE   "audio_buffer_size"
 
#define CONF_BUFFER_BEFORE_PLAY   "buffer_before_play"
 
#define CONF_HTTP_PROXY_HOST   "http_proxy_host"
 
#define CONF_HTTP_PROXY_PORT   "http_proxy_port"
 
#define CONF_HTTP_PROXY_USER   "http_proxy_user"
 
#define CONF_HTTP_PROXY_PASSWORD   "http_proxy_password"
 
#define CONF_CONN_TIMEOUT   "connection_timeout"
 
#define CONF_MAX_CONN   "max_connections"
 
#define CONF_MAX_PLAYLIST_LENGTH   "max_playlist_length"
 
#define CONF_MAX_COMMAND_LIST_SIZE   "max_command_list_size"
 
#define CONF_MAX_OUTPUT_BUFFER_SIZE   "max_output_buffer_size"
 
#define CONF_FS_CHARSET   "filesystem_charset"
 
#define CONF_ID3V1_ENCODING   "id3v1_encoding"
 
#define CONF_METADATA_TO_USE   "metadata_to_use"
 
#define CONF_SAVE_ABSOLUTE_PATHS   "save_absolute_paths_in_playlists"
 
#define CONF_DECODER   "decoder"
 
#define CONF_INPUT   "input"
 
#define CONF_GAPLESS_MP3_PLAYBACK   "gapless_mp3_playback"
 
#define CONF_PLAYLIST_PLUGIN   "playlist_plugin"
 
#define CONF_AUTO_UPDATE   "auto_update"
 
#define CONF_AUTO_UPDATE_DEPTH   "auto_update_depth"
 
#define DEFAULT_PLAYLIST_MAX_LENGTH   (1024*16)
 
#define DEFAULT_PLAYLIST_SAVE_ABSOLUTE_PATHS   false
 
#define MAX_FILTER_CHAIN_LENGTH   255
 

Functions

static GQuark config_quark (void)
 A GQuark for GError instances, resulting from malformed configuration.
 
void config_global_init (void)
 
void config_global_finish (void)
 
void config_global_check (void)
 Call this function after all configuration has been evaluated.
 
bool config_read_file (const char *file, GError **error_r)
 
G_GNUC_PURE struct config_paramconfig_get_next_param (const char *name, const struct config_param *last)
 
static G_GNUC_PURE struct
config_param
config_get_param (const char *name)
 
G_GNUC_PURE const char * config_get_string (const char *name, const char *default_value)
 
G_GNUC_PURE const char * config_get_path (const char *name)
 Returns an optional configuration variable which contains an absolute path.
 
G_GNUC_PURE unsigned config_get_unsigned (const char *name, unsigned default_value)
 
G_GNUC_PURE unsigned config_get_positive (const char *name, unsigned default_value)
 
G_GNUC_PURE struct block_paramconfig_get_block_param (const struct config_param *param, const char *name)
 
G_GNUC_PURE bool config_get_bool (const char *name, bool default_value)
 
G_GNUC_PURE const char * config_get_block_string (const struct config_param *param, const char *name, const char *default_value)
 
static char * config_dup_block_string (const struct config_param *param, const char *name, const char *default_value)
 
G_GNUC_PURE unsigned config_get_block_unsigned (const struct config_param *param, const char *name, unsigned default_value)
 
G_GNUC_PURE bool config_get_block_bool (const struct config_param *param, const char *name, bool default_value)
 
struct config_paramconfig_new_param (const char *value, int line)
 
bool config_add_block_param (struct config_param *param, const char *name, const char *value, int line, GError **error_r)
 

Macro Definition Documentation

#define CONF_AUDIO_BUFFER_SIZE   "audio_buffer_size"

Definition at line 54 of file conf.h.

#define CONF_AUDIO_FILTER   "filter"

Definition at line 45 of file conf.h.

#define CONF_AUDIO_OUTPUT   "audio_output"

Definition at line 44 of file conf.h.

#define CONF_AUDIO_OUTPUT_FORMAT   "audio_output_format"

Definition at line 46 of file conf.h.

#define CONF_AUTO_UPDATE   "auto_update"

Definition at line 73 of file conf.h.

#define CONF_AUTO_UPDATE_DEPTH   "auto_update_depth"

Definition at line 74 of file conf.h.

#define CONF_BIND_TO_ADDRESS   "bind_to_address"

Definition at line 37 of file conf.h.

#define CONF_BUFFER_BEFORE_PLAY   "buffer_before_play"

Definition at line 55 of file conf.h.

#define CONF_CONN_TIMEOUT   "connection_timeout"

Definition at line 60 of file conf.h.

#define CONF_DB_FILE   "db_file"

Definition at line 30 of file conf.h.

#define CONF_DECODER   "decoder"

Definition at line 69 of file conf.h.

#define CONF_DEFAULT_PERMS   "default_permissions"

Definition at line 43 of file conf.h.

#define CONF_FOLLOW_INSIDE_SYMLINKS   "follow_inside_symlinks"

Definition at line 28 of file conf.h.

#define CONF_FOLLOW_OUTSIDE_SYMLINKS   "follow_outside_symlinks"

Definition at line 29 of file conf.h.

#define CONF_FS_CHARSET   "filesystem_charset"

Definition at line 65 of file conf.h.

#define CONF_GAPLESS_MP3_PLAYBACK   "gapless_mp3_playback"

Definition at line 71 of file conf.h.

#define CONF_GROUP   "group"

Definition at line 36 of file conf.h.

#define CONF_HTTP_PROXY_HOST   "http_proxy_host"

Definition at line 56 of file conf.h.

#define CONF_HTTP_PROXY_PASSWORD   "http_proxy_password"

Definition at line 59 of file conf.h.

#define CONF_HTTP_PROXY_PORT   "http_proxy_port"

Definition at line 57 of file conf.h.

#define CONF_HTTP_PROXY_USER   "http_proxy_user"

Definition at line 58 of file conf.h.

#define CONF_ID3V1_ENCODING   "id3v1_encoding"

Definition at line 66 of file conf.h.

#define CONF_INPUT   "input"

Definition at line 70 of file conf.h.

#define CONF_LOG_FILE   "log_file"

Definition at line 32 of file conf.h.

#define CONF_LOG_LEVEL   "log_level"

Definition at line 39 of file conf.h.

#define CONF_MAX_COMMAND_LIST_SIZE   "max_command_list_size"

Definition at line 63 of file conf.h.

#define CONF_MAX_CONN   "max_connections"

Definition at line 61 of file conf.h.

#define CONF_MAX_OUTPUT_BUFFER_SIZE   "max_output_buffer_size"

Definition at line 64 of file conf.h.

#define CONF_MAX_PLAYLIST_LENGTH   "max_playlist_length"

Definition at line 62 of file conf.h.

#define CONF_METADATA_TO_USE   "metadata_to_use"

Definition at line 67 of file conf.h.

#define CONF_MIXER_TYPE   "mixer_type"

Definition at line 47 of file conf.h.

#define CONF_MUSIC_DIR   "music_directory"

Definition at line 26 of file conf.h.

#define CONF_PASSWORD   "password"

Definition at line 42 of file conf.h.

#define CONF_PID_FILE   "pid_file"

Definition at line 33 of file conf.h.

#define CONF_PLAYLIST_DIR   "playlist_directory"

Definition at line 27 of file conf.h.

#define CONF_PLAYLIST_PLUGIN   "playlist_plugin"

Definition at line 72 of file conf.h.

#define CONF_PORT   "port"

Definition at line 38 of file conf.h.

#define CONF_REPLAYGAIN   "replaygain"

Definition at line 48 of file conf.h.

#define CONF_REPLAYGAIN_LIMIT   "replaygain_limit"

Definition at line 51 of file conf.h.

#define CONF_REPLAYGAIN_MISSING_PREAMP   "replaygain_missing_preamp"

Definition at line 50 of file conf.h.

#define CONF_REPLAYGAIN_PREAMP   "replaygain_preamp"

Definition at line 49 of file conf.h.

#define CONF_SAMPLERATE_CONVERTER   "samplerate_converter"

Definition at line 53 of file conf.h.

#define CONF_SAVE_ABSOLUTE_PATHS   "save_absolute_paths_in_playlists"

Definition at line 68 of file conf.h.

#define CONF_STATE_FILE   "state_file"

Definition at line 34 of file conf.h.

#define CONF_STICKER_FILE   "sticker_file"

Definition at line 31 of file conf.h.

#define CONF_USER   "user"

Definition at line 35 of file conf.h.

#define CONF_VOLUME_NORMALIZATION   "volume_normalization"

Definition at line 52 of file conf.h.

#define CONF_ZEROCONF_ENABLED   "zeroconf_enabled"

Definition at line 41 of file conf.h.

#define CONF_ZEROCONF_NAME   "zeroconf_name"

Definition at line 40 of file conf.h.

#define DEFAULT_PLAYLIST_MAX_LENGTH   (1024*16)

Definition at line 76 of file conf.h.

#define DEFAULT_PLAYLIST_SAVE_ABSOLUTE_PATHS   false

Definition at line 77 of file conf.h.

#define MAX_FILTER_CHAIN_LENGTH   255

Definition at line 79 of file conf.h.

Function Documentation

bool config_add_block_param ( struct config_param param,
const char *  name,
const char *  value,
int  line,
GError **  error_r 
)
static char* config_dup_block_string ( const struct config_param param,
const char *  name,
const char *  default_value 
)
inlinestatic

Definition at line 188 of file conf.h.

G_GNUC_PURE bool config_get_block_bool ( const struct config_param param,
const char *  name,
bool  default_value 
)
G_GNUC_PURE struct block_param* config_get_block_param ( const struct config_param param,
const char *  name 
)
read
G_GNUC_PURE const char* config_get_block_string ( const struct config_param param,
const char *  name,
const char *  default_value 
)
G_GNUC_PURE unsigned config_get_block_unsigned ( const struct config_param param,
const char *  name,
unsigned  default_value 
)
G_GNUC_PURE bool config_get_bool ( const char *  name,
bool  default_value 
)
G_GNUC_PURE struct config_param* config_get_next_param ( const char *  name,
const struct config_param last 
)
read
static G_GNUC_PURE struct config_param* config_get_param ( const char *  name)
staticread

Definition at line 137 of file conf.h.

G_GNUC_PURE const char* config_get_path ( const char *  name)

Returns an optional configuration variable which contains an absolute path.

If there is a tilde prefix, it is expanded. Aborts MPD if the path is not a valid absolute path.

G_GNUC_PURE unsigned config_get_positive ( const char *  name,
unsigned  default_value 
)
G_GNUC_PURE const char* config_get_string ( const char *  name,
const char *  default_value 
)
G_GNUC_PURE unsigned config_get_unsigned ( const char *  name,
unsigned  default_value 
)
void config_global_check ( void  )

Call this function after all configuration has been evaluated.

It checks for unused parameters, and logs warnings.

void config_global_finish ( void  )
void config_global_init ( void  )
struct config_param* config_new_param ( const char *  value,
int  line 
)
read
static GQuark config_quark ( void  )
inlinestatic

A GQuark for GError instances, resulting from malformed configuration.

Definition at line 112 of file conf.h.

bool config_read_file ( const char *  file,
GError **  error_r 
)