manual/rockbox_interface/main.tex

   1 % $Id$ %
   2 \chapter{\label{ref:rockbox_interface}Quick Start}
   3 \section{Basic overview}
   4 \subsection{The \daps{} controls}
   5
   6 \begin{center}
   7 % include the front image. Using \specimg makes this fairly easy,
   8 % but requires to use the exact value of \specimg in the filename!
   9 % The extension is selected in the preamble, so no further \ifpdfoutput
  10 % is necessary.
  11 \includegraphics[height=8cm]{rockbox_interface/images/\specimg-front}
  12
  13 \end{center}
  14
  15 Throughout this manual, the buttons on the \dap{} are labelled according to the
  16 picture above. When a table of button actions says ``Long'' before the button it
  17 means that you should make a long press on that button, in other words, press it
  18 for approximately 1 second. In detail the buttons are described in the following
  19 paragraph.
  20
  21 \blind{
  22   Additional information is available for blind users on the Rockbox website at
  23   \wikilink{BlindFAQ}.
  24
  25   %
  26   \opt{h1xx}{
  27   If you lay the \dap{} on the table with the joystick pointing
  28   towards you, and the curved sides at the top, you will find the following
  29   if you start from the top-right corner and follow the side of the \dap{} in a
  30   clockwise direction:
  31   On the right side the buttons \ButtonOn{}, \ButtonOff{}, \ButtonMode{} and
  32   the \ButtonHold{} switch. Next comes on the bottom the USB port,
  33   a small hole for resetting the \dap{}, charger plug. On the left side located
  34   is the button \ButtonRec{}. At least the top has headphone mini-jack plug,
  35   remote port, optical/line in and optical/line out.
  36   The joystick in the middle of the \dap{} is
  37   used to navigate menus by pressing it up, down, left and right. Pressing the
  38   joystick down is labelled \ButtonSelect{} throughout this manual. Its
  39   directions are labelled \ButtonRight{}, \ButtonDown{}, \ButtonLeft{} and
  40   \ButtonUp{}.
  41
  42   The internal microphone is located on the left hand side of the nit towards the
  43   top, and there is a small reset hole on the bottom of the unit between the
  44   power and USB sockets.  To perform a hard reset, insert a paperclip into this
  45   hole.}
  46   %
  47   \opt{h300}{
  48   Hold or lay the \dap{} so that the side with the button pad and
  49   LCD is facing towards you.  The buttons on the button pad are as follows:  top
  50   left corner: \ButtonOn{}, bottom left corner: \ButtonOff{}, top right corner:
  51   \ButtonRec, bottom right corner: \ButtonMode{}.  In the center of the button pad
  52   is a button labelled \ButtonSelect{}.  Surrounding the \ButtonSelect{} button are
  53   four directional buttons used to navigate up, down, left and right.
  54
  55   On the top panel of the \dap{}, from left to right, you can find the
  56   following: headphone mini jack plug, remote port, Line-in, Line-out.
  57
  58   On the bottom panel of the \dap{}, from left to right, you can find the
  59   following:  power jack and two USB ports.  The USB port on the right is used
  60   to connect your \dap{} to your computer.  The USB port on the left is not
  61   used in Rockbox.
  62   }
  63   %
  64   \opt{ipod4g,ipod3g,ipodcolor,ipodvideo,ipodmini}
  65   {
  66   The main controls on the \dap{} are a slightly indented scroll wheel
  67   with a flat round button in the center. Hold the \dap{} with these controls
  68   facing you.
  69
  70   The top of the player will have the following, from left to
  71   right:
  72   \opt{ipod4g, ipod3g ,ipodcolor}{remote connector, headphone jack, \ButtonHold{}
  73     switch.}
  74   \opt{ipodvideo}{\ButtonHold{} switch, headphone jack.}
  75   \opt{ipodmini}{\ButtonHold{} switch, remote connector, headphone jack.}
  76
  77   The dock connector that is used to connect your \dap{} to your computer is on
  78   the bottom panel of the \dap{}.
  79
  80   The button in the middle of the wheel is called \ButtonSelect{}. You can
  81   operate the wheel by pressing the top, bottom, left or right sections,
  82   or by sliding your finger around it.  The top is \ButtonMenu{}, the bottom is
  83   \ButtonPlay{}, the left is \ButtonLeft{}, and the right is \ButtonRight{}.
  84   When the manual says to \ButtonScrollFwd{}, it means to slide your finger
  85   clockwise around the wheel. \ButtonScrollBack{} means to slide your finger
  86   counterclockwise. Note that the wheel is sensitive, so you will need to move
  87   slowly at first and get a feel for how it works.
  88
  89   Note that when the \ButtonHold{} switch is pushed toward the center of the \dap{},
  90   hold is on, and none of the other controls do anything.  Be sure
  91   \ButtonHold{} is off before trying to use your player.
  92   }
  93   %
  94   \opt{ipodnano}{
  95   The main controls on the \dap{} are a slightly indented wheel with a
  96   flat round button in the center. Hold the \dap{} with these controls on the
  97   top surface. There is a \ButtonHold{} switch at one end, and headphone and USB
  98   jacks at the other; be sure the end with the switch is facing away from you.
  99
 100   The button in the middle of the wheel is called \ButtonSelect{}. You can
 101   operate the wheel by pressing the top, bottom, left or right sections,
 102   or by sliding your finger around it.  The top is \ButtonMenu{}, the bottom is
 103   \ButtonPlay, the left is \ButtonLeft, and the right is \ButtonRight{}.
 104   When the manual says to \ButtonScrollFwd{}, it means to slide your finger
 105   clockwise around the wheel. \ButtonScrollBack{} means to slide your finger
 106   counterclockwise. Note that the wheel is sensitive, so you will need to move
 107   slowly at first and get a feel for how it works.
 108
 109   Note that when the \ButtonHold{} switch is pushed toward the center of the \dap{},
 110   hold is on, and none of the other controls do anything; be sure \ButtonHold{} is
 111   off before trying to use your player.
 112   }
 113   %
 114   \opt{ondio}{
 115   The main characteristic of the Ondio case is the dent on its lower right side
 116   which is the MMC slot. Holding the \dap{} with this slot in the described position
 117   you'll find the following:
 118
 119   On the curved top it has the headphone jack to the left,
 120   the \ButtonOff{} button is in the middle%
 121   \opt{HAVE_RECORDING}{ and the line in jack to the right}.
 122   Apart from the already mentioned MMC slot you will find the USB connector on
 123   the \daps{} right side. Placed on the upper side of the device right below
 124   the flat display there is the main button pad of the \dap{}. A strong deepening
 125   marks the center of it and helps to operate the directional keys from there.
 126   \ButtonLeft{} and \ButtonRight{} form some sort of a strip and divide \ButtonUp{}
 127   and \ButtonDown{}. The raised button positioned in the lower left of this round
 128   crosspad is labelled \ButtonMenu{}.}
 129   %
 130   \opt{h10,h10_5gb}{
 131   Hold or lay the \dap{} so that the side with the scroll pad and
 132   LCD is facing towards you. In the centre below the lcd is the scroll pad. It
 133   is oriented vertically. Touching the top and bottom half of it acts as the
 134   \ButtonScrollUp{}  and \ButtonScrollDown{} buttons respectively. On the left
 135   of the scroll pad is the \ButtonLeft{} button and on the right is the
 136   \ButtonRight{} button.
 137
 138   There are three buttons on the right hand side of the \dap{}. From top to
 139   bottom, they are: \ButtonRew{}, \ButtonPlay{} and \ButtonFF{}. On the left
 140   hand side is the \ButtonPower{} button.
 141
 142   On the top panel of the \dap{}, from left to right, you can find the
 143   following: \ButtonHold() switch, \opt{h10}{reset pin hole, }remote port and
 144   headphone mini jack plug.
 145
 146   On the bottom panel of the \dap{}, is the data cable port.}
 147   %
 148   \opt{gigabeatf}{
 149   Hold the \dap{} with the screen on top and the controls on the right hand side.
 150   Below the screen is a cross-shaped touch sensitive pad which contains the
 151   \ButtonUp{}, \ButtonDown{}, \ButtonLeft{} and \ButtonRight{} controls.  On the
 152   top of the unit from left to right are the power socket, the \ButtonHold{}
 153   switch, and the headphone socket.  The \ButtonHold{} switch puts the \dap{} into
 154   hold mode when it is switched to the right
 155   of the unit. The buttons will have no effect when this is the case.
 156
 157   Starting from the left hand side on the bottom of the unit, nearer to the front
 158   than the back, is a recessed switch which
 159   controls whether the battery is on or off.  When this swtich is to the lwft,
 160   the battery is disconnected.  This can be used for a hard reset of the unit,
 161   or if the \dap{} is being placed in storage.  Next to that is a connector for
 162   the docking station and finally on the right hand side of the bottom of the
 163   unit is a mini USB socket for connecting directly to USB.
 164
 165   Finally on the right hand side of the unit are some control buttons.  Going from
 166   the bottom of the unit to the top there is a small round \ButtonA{} buttton then a
 167   rocker volume switch with of the \ButtonVolDown{} button below the \ButtonVolUp{}
 168   button.  Above that is are two more small round buttons, the \ButtonMenu{}
 169   button and nearest to the top of the unit the \ButtonPower{} button, which is held
 170   down to turn the \dap{} on or off.}
 171   %
 172   \opt{x5,m5}{
 173   The \dap{} is curved so that the end with the screen on it is thicker than the
 174   other end.  Hold the \dap{} wih the thick end towards the top and the screen
 175   facing towards you.  Half way up the front of the unit on the right hand side
 176   is a four way joystick which is the \ButtonUp{}, \ButtonDown{},
 177   \ButtonLeft{}, and \ButtonRight{} buttons. When pressed it serves as \ButtonSelect.
 178
 179   On the right hand side of the \dap{} from top to bottom, first there is a two
 180   way switch.  the \ButtonPower{} button is activated by pushing this switch up,
 181   and pusing this switch down until it clicks slightly will activate the
 182   \ButtonHold{} button.  When the switch is in this position, none of the other
 183   keys will have an effect.
 184
 185   Below the switch is a lozenge shaped button which is the \ButtonRec{}
 186   button, and below that the final button on this side of the unit, the
 187   \ButtonPlay{} button.  Just below this is a small hole which is difficult to
 188   locate by touch which is the internal microphone.  At the very bottom of
 189   this side of the unit is the reset hole, which can be used to perform a hard
 190   reset by inserting a paper clip.
 191
 192   On the bottom of the unit is the connector for the
 193   \playerman{} subpack or dock.  On the top of the unit is a charge
 194   indicator light, which may feel a bit like a button, but isn't.
 195
 196   From the top of the \dap{} on the left hand side is the headphone socket, then the
 197   remote connector.  Below this is a cover which protects the \opt{x5}{USB host
 198   connector.}\opt{m5}{USB and charging connector}.}
 199   %
 200   \opt{e200}{
 201   Hold the \dap{} with the turning wheel at the front and bottom.  On the bottom left
 202   of the front of the \dap{} is a raised round button, the \ButtonPower{} button.
 203   Above and to the left of this, on the outside of the turning wheel are four
 204   buttons.  These are the \ButtonUp{}, \ButtonDown{}, \ButtonLeft{} and
 205   \ButtonRight{} buttons.  Inside the wheel is thr \ButtonSelect{} button.  Turning
 206   the wheel to the right activates the \ButtonScrollDown{} function, and to the
 207   left, the \ButtonScrollUp{} function.
 208
 209   On the right of the unit is a slot for inserting flash cards.  On the bottom is
 210   the connector for the USB cable.  On the left is the \ButtonRec{} button, and
 211   on the top, there is the headphone socket to the right, and the \ButtonHold{}
 212   switch.  Moving this switch to the right activates hold mode in which none of the
 213   other buttons have any effect.  Just to the left of the \ButtonHold{} switch is a
 214   small hole which contains the internal microphone.}
 215   %
 216   \nopt{h1xx,h300,ipodnano,ipodvideo,ipodmini,ipod4g,ipod3g,ipodcolor,ondio,h10,h10_5gb,gigabeatf,x5,m5,e200}
 217   {
 218     \fixme{Write a section describing the \dap{} for blind users.}
 219   }
 220 }
 221
 222 \subsection{Turning the \dap{} on and off}
 223 To turn on and off your Rockbox enabled \dap{} use the following keys:
 224   \begin{table}
 225     \begin{btnmap}{}{}
 226       \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOn}%
 227       \opt{IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonMenu{} / \ButtonSelect}%
 228       \opt{ONDIO_PAD}{\ButtonOff}\opt{RECORDER_PAD,PLAYER_PAD}%
 229           {Hold \ButtonOn\ for 2--3s}%
 230       \opt{IAUDIO_X5_PAD,IRIVER_H10_PAD,SANSA_E200_PAD,GIGABEAT_PAD}
 231           {\ButtonPower}%
 232       & Start Rockbox\\
 233       \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{Hold \ButtonOff}%
 234       \opt{IPOD_4G_PAD,IPOD_3G_PAD}{Hold \ButtonPlay}%
 235       \opt{ONDIO_PAD,recorderv2fm}{Hold \ButtonOff}%
 236       \opt{recorder}{Double tap \ButtonOff\ when playback is stopped}%
 237       \opt{PLAYER_PAD}{From the Main Menu, select \textbf{Shutdown}}%
 238       \opt{IAUDIO_X5_PAD,IRIVER_H10_PAD,SANSA_E200_PAD,GIGABEAT_PAD}%
 239           {Hold \ButtonPower}%
 240       & Shutdown Rockbox\\
 241     \end{btnmap}
 242   \end{table}
 243
 244 \label{ref:Safeshutdown}On shutdown, Rockbox automatically saves its settings.
 245
 246 \opt{PLAYER_PAD,RECORDER_PAD,ONDIO_PAD}{%
 247   In the unlikely event of a software failure, a hardware power off can be
 248   performed by holding down
 249   \opt{PLAYER_PAD}{\ButtonStop}%
 250   \opt{RECORDER_PAD,ONDIO_PAD}{\ButtonOff}
 251   until the \nopt{ondiosp,ondiofm}{\dap{} power light}%
 252   \opt{ondiosp,ondiofm}{\daps{} display} goes off.%
 253 }
 254
 255 \nopt{gigabeat,m5,x5,archos}
 256   {
 257   \subsection{Starting the original firmware}
 258   \label{ref:Dualboot}
 259   \opt{ipod}
 260     {
 261     Rockbox has a dual-boot feature. To boot into the original firmware, shut
 262     down the device as described above. Turn on the \ButtonHold{} switch
 263     immediately after turning the player on. Once Rockbox displays the
 264     message ``Loading original firmware ...'' you may turn the \ButtonHold{}
 265     switch off. Rockbox will boot into the original firmware.
 266
 267     \note{The described method of dual-booting works with Rockbox bootloader
 268     version 2, which was released 16 December 2006. If you have the older
 269     bootloader, boot the original firmware by pressing \ButtonMenu{}
 270     immediately after turning on your Ipod.  Do not release the
 271     \ButtonMenu{} button until you see the ``Loading original firmware...''
 272     message on the screen.}
 273
 274     Regardless of which method you use to boot to the original firmware, you can
 275     return to Rockbox by pressing and holding \ButtonMenu{} and \ButtonSelect{}
 276     simultaneously until the player reboots.
 277     }
 278
 279   \opt{h1xx,h300}
 280     {
 281     Rockbox has a dual-boot feature. To boot into the original firmware,
 282     when the \dap{} is turned off, press and hold the \ButtonRec{} button,
 283     and then press the \ButtonOn{} button.
 284     }
 285
 286   \opt{h10,h10_5gb}
 287     {
 288     Rockbox has a dual-boot feature. To boot into the original firmware,
 289     press and hold the \ButtonRew{} button while turning on the player.
 290     \note{The iriver firmware doesn't shut down properly when you turn it off,
 291     it only goes to sleep. To get back into Rockbox when exiting from the
 292     iriver firmware, you will need to reset the player by \opt{h10}{inserting a
 293     pin in the reset hole}\opt{h10_5gb}{taking out battery}.}
 294     }
 295
 296   \opt{e200}
 297     {
 298     Rockbox has a dual-boot feature. To boot into the original firmware,
 299     press and hold the \ButtonLeft{} button while turning on the player.
 300     }
 301   }
 302
 303 \subsection{The first contact}
 304
 305 After you have first started the \dap{} you'll be presented by the
 306 \setting{Main Menu}. From this menu you can reach every function of Rockbox,
 307 for more information (see \reference{ref:main_menu}). To browse the files
 308 on you \dap{} select \setting{Files} (see \reference{ref:file_browser}), and to
 309 browse in a view that is based on the meta-data\footnote{ID3 Tags, Vorbis
 310 comments, etc.} of your audio files, select \setting{Database} (see
 311 \reference{ref:database}).
 312
 313 \subsection{Basic controls}
 314 When browsing files and moving through menus you usually get a list view
 315 presented. The navigation in these lists are usually the same and should be
 316 pretty intuitive.
 317 In the tree view use \ActionStdNext{} and \ActionStdPrev{} to move around
 318 the selection. Use \ActionStdOk{} to select an item. When browsing the file
 319 system selecting an audio file plays it. The view switches to the ``While
 320 playing screen'', usually abbreviated as ``WPS'' (see \reference{ref:WPS}. The
 321 dynamic playlist gets replaced with the contents of the current folder. This
 322 way you can easily treat folders as playlists. The created dynamic playlist can
 323 be extended or modified while playing. This is also known as
 324 ``on-the-fly playlist''.
 325 To go back to the \setting{File Browser} stop the playback with the
 326 \ActionWpsStop{} button or return to the file browser while keeping playback
 327 running using \ActionWpsBrowse{}.
 328 In list views you can go back one step with \ActionTreeParentDirectory.
 329
 330 \subsection{Basic concepts}
 331 \subsubsection{Playlists}
 332 Rockbox is playlist oriented. This means that every time you play an audio file,
 333 a so-called ``dynamic playlist'' is generated, unless you play a saved
 334 playlist. You can modify the dynamic playlist while playing and also save
 335 it to a file. If you don't want to use playlists you can simply play your
 336 files folder based.
 337 Playlists are covered in detail in \reference{ref:working_with_playlists}.
 338
 339 \subsubsection{Menu}
 340 From the menu you can customise Rockbox. Rockbox itself is very customisable.
 341 Also there are some special menus for quick access to frequently used
 342 functions.
 343
 344 \subsubsection{Context Menu}
 345 Some views, especially the file browser and the WPS have a context menu.
 346 From the file browser this can be accessed with \ActionStdContext{}.
 347 The contents of the context menu vary, depending on the situation it gets
 348 called. The context menu itself presents you with some operations you can
 349 perform with the currently highlighted file. In the file browser this is
 350 the file (or folder) that is highlighted by the cursor. From the WPS this is
 351 the currently playing file. Also there are some actions that don't apply
 352 to the current file but refer to the screen from which the context menu
 353 gets called. One example is the playback menu, which can be called using
 354 the context menu from within the WPS.
 355
 356 \section{Customising Rockbox}
 357 Rockbox' User Interface can be customised using ``Themes''. Themes usually
 358 only affect the visual appearance, but an advanced user can create a theme
 359 that also changes various other settings like file view, LCD settings and
 360 all other settings that can be modified using \fname{.cfg} files. This topic
 361 is discussed in more detail in \reference{ref:manage_settings}.
 362 The Rockbox distribution comes with some themes that should look nice on
 363 your \dap{}. \note{Some of the themes shipped with Rockbox need additional
 364 fonts from the fonts package, so make sure you installed them.
 365 Also, if you downloaded additional themes from the Internet make sure you
 366 have the needed fonts installed as otherwise the theme may get displayed
 367 garbled.}
 368
 369 \section{Menu overview}
 370 \fixme{include an overview of the menu structure here}
 371 %\input{rockbox_interface/menu_structure.tex}
 372
 373 \input{rockbox_interface/playback.tex}