summaryrefslogtreecommitdiffstats
path: root/manual/configure_rockbox/voice.tex
blob: 6aaf000e471e0060eb1aebad7849fd46c2db2255 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
% $Id$ %
\section{\label{ref:Voiceconfiguration}Voice}

  \begin{description}
  \item[Voice Menus.]
    This option turns on the Voice User Interface, which will read out menu
    items and settings as they are selected by the cursor.  In order for this
    to work, a voice file must be present in the \fname{/.rockbox/lang/}
    directory on the \dap.  Voice files are large (1.5MB) and are not 
    shipped with Rockbox by default.
    The voice file is the name of the language for which it is made, followed
    by the extension \fname{.voice}.  So for English, the file name would be 
    \fname{english.voice}.
    This option is on by default.  It will do nothing unless the 
    appropriate voice file is installed in the correct place on the \dap.
    The Voice Menus have several limitations:
    \begin{itemize}
    \item Setting the Sound Option \setting{Channels} to \setting{Karaoke} may 
      disable voice menus.
    \item Plugins \opt{CONFIG_RTC}{and the wake up alarm} do not support
      voice features.
    \end{itemize}

  \item[Voice Directories.]
    This option turns on the speaking of directory names.  The \dap{} 
    is not powerful enough to produce these voices in real time, so a number 
    of options are available.
    \begin{description}
    \item[.talk mp3 clip.]
      Use special pre-recorded MP3 files (\fname{\_dirname.talk}) in each 
      directory.  These must be generated in advance, and are typically 
      produced synthetically using a text to speech engine on a PC.
      If no such file exists, the output is as for the \setting{numbers}
      option below.
    \item[Spell.]
      Speak the directory name by spelling it out letter by letter.  Support
      is provided only for the most common letters and punctuation.
    \item[Numbers.]
      Each directory is assigned a number based upon its position in the
      file list.  They are then announced as ``Directory 1'', ``Directory 2''
      etc.
    \item[Off.]
      No attempt will be made to speak directory names.
    \end{description}

  \item[Voice Filenames.]
    This option turns on the speaking of filenames.  The options provided
    are \setting{Spell}, \setting{Numbers}, and \setting{Off} which function 
    the same as for \setting{Voice Directories} and \setting{.talk mp3 clip},
    which functions as above except that the files are named with the same
    name as the music file (e.g. \fname{Punkadiddle.mp3} would require a
    file called \fname{Punkadiddle.mp3.talk}).

  \end{description}

See \wikilink{VoiceHowto} for more details on configuring speech support in Rockbox.