ggo/fade.ggo

   1 section "General options"
   2 #########################
   3
   4 option "mode" o
   5 #~~~~~~~~~~~~~~
   6 "how to fade volume"
   7         enum typestr = "mode"
   8         values = "sleep", "snooze", "fade"
   9         default = "sleep"
  10         optional
  11         details="
  12                 para_fade knows three different fading modes:
  13
  14                 sleep mode: Change to the initial volume and select
  15                 the initial afs mood/playlist. Then fade out until
  16                 the fade-out volume is reached. Switch to the
  17                 sleep mood/playlist until wake time minus fade-in
  18                 time. Finally switch to the wake mood/playlist and
  19                 fade to the fade-in volume.
  20
  21                 fade: Fade the volume to the given value in the
  22                 given time.
  23
  24                 snooze: Fade out, sleep a bit and fade in.
  25 "
  26
  27 option "config-file" c
  28 #~~~~~~~~~~~~~~~~~~~~~
  29 "(default='~/.paraslash/fade.conf')"
  30         string typestr = "filename"
  31         optional
  32
  33 option "mixer-device" m
  34 #~~~~~~~~~~~~~~~~~~~~~~
  35 "mixer device file"
  36         string typestr = "device"
  37         default = "/dev/mixer"
  38         optional
  39
  40 option "mixer-channel" C
  41 #~~~~~~~~~~~~~~~~~~~~~~~
  42 "select the analog mixer channel"
  43         enum typestr = "channel"
  44         values = "volume", "bass", "treble", "synth", "pcm", "speaker", "line",
  45                 "mic", "cd", "imix", "altpcm", "reclev", "igain", "ogain"
  46         default = "volume"
  47         optional
  48         details = "
  49                 Not all listed channels might be supported on any
  50                 particular hardware.
  51 "
  52
  53 section "Options for sleep mode"
  54 ################################
  55
  56 option "ivol" -
  57 #~~~~~~~~~~~~~~
  58 "set initial volume"
  59         int typestr = "volume"
  60         default = "60"
  61         optional
  62         details = "
  63                 Used as the start volume, before fading out to the
  64                 fade out volume.
  65         "
  66
  67 option "fo-mood" -
  68 #~~~~~~~~~~~~~~~~~
  69 "afs mood/playlist during fade out"
  70         string typestr = "mood_spec"
  71         default = "m/fade"
  72         optional
  73         details = "
  74                 Select this mood right after setting the
  75                 volume. Example: --fo-mood m/sleep
  76 "
  77
  78 option "fo-time" -
  79 #~~~~~~~~~~~~~~~~~
  80 "fall asleep fade out time"
  81         int typestr = "seconds"
  82         default = "1800"
  83         optional
  84         details = "
  85                 No fading if set to 0.
  86         "
  87
  88 option "fo-vol" -
  89 #~~~~~~~~~~~~~~~~
  90 "volume to fade out to"
  91         int typestr = "volume"
  92         default = "20"
  93         optional
  94
  95 option "sleep-mood" -
  96 #~~~~~~~~~~~~~~~~~~~~
  97 "sleep time afs mood/playlist"
  98         string typestr = "mood_spec"
  99         default = "m/sleep"
 100         optional
 101         details = "
 102                 Select the given afs mood/playlist after the fade
 103                 out is complete. If unset, the \"stop\" command is
 104                 sent to para_server.
 105         "
 106
 107 option "wake-hour" H
 108 #~~~~~~~~~~~~~~~~~~~
 109 "(0-23) (default: now + 9 hours)"
 110         int typestr = "hour"
 111         optional
 112
 113 option "wake-min" M
 114 #~~~~~~~~~~~~~~~~~~
 115 "(0-59)"
 116         int typestr = "minutes"
 117         default = "0"
 118         optional
 119
 120 option "fi-mood" -
 121 #~~~~~~~~~~~~~~~~~
 122 "afs mood/playlist during fade in"
 123         string typestr = "mood_spec"
 124         default = "m/wake"
 125         optional
 126         details = "
 127                 Change to this afs mood/playlist on wake time.
 128         "
 129
 130 option "fi-time" -
 131 #~~~~~~~~~~~~~~~~~
 132 "wake up fade in time"
 133         int typestr="seconds"
 134         default="1200"
 135         optional
 136         details = "
 137                 No fading in if set to 0.
 138         "
 139
 140 option "fi-vol" -
 141 #~~~~~~~~~~~~~~~~
 142 "volume to fade to at wake time"
 143         int typestr = "volume"
 144         default = "80"
 145         optional
 146
 147 section "Options for snooze mode"
 148 #################################
 149
 150 option "so-time" -
 151 #~~~~~~~~~~~~~~~~~
 152 "snooze-out time"
 153         int typestr = "seconds"
 154         default = "30"
 155         optional
 156
 157 option "so-vol" -
 158 #~~~~~~~~~~~~~~~~
 159 "volume to fade to before snooze"
 160         int typestr = "volume"
 161         default = "20"
 162         optional
 163
 164 option "snooze-time" -
 165 #~~~~~~~~~~~~~~~~~~~~~
 166 "delay"
 167         int typestr = "seconds"
 168         default = "600"
 169         optional
 170
 171 option "si-time" -
 172 #~~~~~~~~~~~~~~~~~
 173 "snooze-in time"
 174         int typestr = "seconds"
 175         default = "180"
 176         optional
 177
 178 option "si-vol" -
 179 #~~~~~~~~~~~~~~~~
 180 "volume to fade to after snooze"
 181         int typestr = "volume"
 182         default = "80"
 183         optional
 184
 185 section "Options for fade mode"
 186 ###############################
 187
 188 option "fade-vol" f
 189 #~~~~~~~~~~~~~~~~~~
 190 "volume to fade to"
 191         int typestr = "volume"
 192         default = "50"
 193         optional
 194
 195 option "fade-time" t
 196 #~~~~~~~~~~~~~~~~~~~
 197 "fading time"
 198         int typestr = "seconds"
 199         default = "5"
 200         optional