#LyX 1.4.3 created this file. For more info see http://www.lyx.org/
\lyxformat 245
\begin_document
\begin_header
\textclass article
\language english
\inputencoding auto
\fontscheme ae
\graphics default
\paperfontsize 12
\spacing single
\papersize a4paper
\use_geometry true
\use_amsmath 1
\cite_engine basic
\use_bibtopic false
\paperorientation portrait
\leftmargin 2cm
\topmargin 2cm
\rightmargin 2cm
\bottommargin 2cm
\headheight 1cm
\headsep 1cm
\footskip 1cm
\secnumdepth 3
\tocdepth 3
\paragraph_separation skip
\defskip medskip
\quotes_language english
\papercolumns 1
\papersides 1
\paperpagestyle default
\tracking_changes false
\output_changes false
\end_header

\begin_body

\begin_layout Title
mmSAP user manual
\end_layout

\begin_layout Section
Introduction
\end_layout

\begin_layout Subsection
Overview
\end_layout

\begin_layout Standard
mmSAP is a comfortable SAP player.
 SAP file format is used to store music for eight bit ATARI computers equipped
 with one or two POKEY chips.
 For decoding SAP files, the SAP Library v.
 2.0 by Adam Bienias is used.
 
\end_layout

\begin_layout Standard
The biggest SAP file archive can be found at: 
\family typewriter
http://asma.atari.org
\family default
.
 The maintainer of this archive is Zden\i \v{e}
k Eisenhammer (PG).
\end_layout

\begin_layout Standard
mmSAP comes to you from the Czech Republic.
\end_layout

\begin_layout Subsection
Other SAP players
\end_layout

\begin_layout Standard
You can try other SAP players - Slight Atari player, Another slight Atari
 player (ASAP), SAPER, PenguinSAP.
\end_layout

\begin_layout Subsection
Requierements
\end_layout

\begin_layout Standard
To run mmSAP, you need at least GTK+ 2.6, GTKmm+ 2.6 and ALSA or SDL.
 The binaries are for OpenSuSE  10.2.
 To use mmSAP with other distributions you may need to compile from sources
 by using scripts 
\family typewriter
compile-als
\family default
 or 
\family typewriter
compile-sdl
\family default
.
 Also 
\family typewriter
find
\family default
 and 
\family typewriter
sort
\family default
 programs are requiered to achieve full playlist functionality.
\end_layout

\begin_layout Subsection
Microsoft Windows
\end_layout

\begin_layout Standard
There is experimental version 1.6a for Microsoft Windows 2000 and XP.
 Seems to work fine.
\end_layout

\begin_layout Section
Using mmSAP
\end_layout

\begin_layout Standard
mmSAP accepts one command line parameter - SAP tune which will be played.
 mmSAP is controlled by graphical used interface.
 mmSAP's GUI has three main parts: the player, the menu and the playlist.
\end_layout

\begin_layout Standard
\noindent
\align center
\begin_inset Graphics
	filename fin_mainparts.png

\end_inset


\end_layout

\begin_layout Subsection
The player
\end_layout

\begin_layout Standard
The player is the most important part.
 Player provides 
\emph on
playback control buttons
\emph default
 (from left to right: Play/Pause, STOP, Go to previous subsong, Go to next
 subsong, Go to previous tune, Go to next tune).
\end_layout

\begin_layout Standard
To show or hide the playlist use 
\emph on
playlist show/hide button
\emph default
.
 When the playlist is shown, main window is resizable.
\end_layout

\begin_layout Standard
At playback part, there are also 
\emph on
subsong information
\emph default
, 
\emph on
POKEY volume register visualization bars
\emph default
 and
\emph on
 SAP tune info
\emph default
.
 SAP tune info can be expanded/shriked by clicking on the expander (small
 triangle) or its label.
\end_layout

\begin_layout Standard
The player part is also DnD target.
 You can drop single file here.
 It will be played back immediately.
 Dropping something else on the player is not supported.
\end_layout

\begin_layout Standard
The player can be also controlled by keyboard:
\newline
SPACE=Play/Pause, S=STOP,
 P=Go to previous subsong, N=Go to next subsong, F=Go to next tune, B=Go
 to previous tune.
\end_layout

\begin_layout Subsection
The menu
\end_layout

\begin_layout Standard
The menu provides comfortable access to advanced controls.
\end_layout

\begin_layout Subsubsection
File
\end_layout

\begin_layout Standard
This allows you to Load SAP file, setup preferences
\emph on
 
\emph default
and quit mmSAP.
\end_layout

\begin_layout Subsubsection
Mode
\end_layout

\begin_layout Standard
You can choose one of four playlist passing modes.
 
\emph on
No progress
\emph default
 means that when last subsong of current tune is finished, the playback
 will be stopped.
 
\emph on
Repeat subsong
\emph default
 means that current subsong will be repeated in infinite loop.
 
\emph on
Repeat tune 
\emph default
means that the current tune will be repeated in infinite loop.
 
\emph on
Repeat playlist
\emph default
 - the whole playlist will be repeated.
\end_layout

\begin_layout Subsubsection
Help
\end_layout

\begin_layout Standard

\emph on
About
\emph default
 will show 
\begin_inset Quotes eld
\end_inset

credits
\begin_inset Quotes erd
\end_inset

 and keyboard controls.
 
\emph on
Debug info to stdout
\emph default
 will enable/disable sending verbose information to standard output.
 If you happen to find a bug, please add this information to your bug report.
\end_layout

\begin_layout Subsubsection
Chip
\end_layout

\begin_layout Standard
This menu allows you to control the POKEY chip.
 You can mute selected channels or force POKEY to produce sounds similar
 to SID.
\end_layout

\begin_layout Subsection
The playlist
\end_layout

\begin_layout Standard
The playlist shows a list of files to be played back.
 You can perform standard playlist operations using playlist's menus.
 The list of files can be loaded from file (one file specifier per line,
 absolute or relative) or saved to file (in this case all relative file
 specifiers will be converted to absolute).
 mmSAP remembers last saved/loaded list of files and tries to load it on
 the next startup.
\end_layout

\begin_layout Standard
The playlist is DnD target and you can drop here: File,Files,Directory or
 Directories and combination of File(s) and Directory(ies).
 
\end_layout

\begin_layout Section
Special features
\end_layout

\begin_layout Subsection
Silence detector
\end_layout

\begin_layout Standard
SAP does not provide subsong length information.
 We can determine the end of subsong by detecting silence.
 You can set how many seconds of silence will result into 
\begin_inset Quotes eld
\end_inset

Subsong end event
\begin_inset Quotes erd
\end_inset

.
\end_layout

\begin_layout Subsection
Autocontine
\end_layout

\begin_layout Standard
Some SAP tunes can contain infinite loops, so silence detector fails to
 determine subsong end.
 Autocontine sets maximum subsong playback's length.
 This is dumb method.
\end_layout

\begin_layout Subsection
STI (SAP time information)
\end_layout

\begin_layout Standard
This is advanced feature implemented only in mmSAP.
 You can specify exact subsong lengths in additional file.
 If the SAP file name is 
\family typewriter
frogger.sap
\family default
 the STI is expected to be placed in 
\family typewriter
frogger.sap.sti.
\end_layout

\begin_layout Standard
The 
\family typewriter
.sti
\family default
 file contains subsong lengths in format minutes:seconds, one subsong length
 per line.
 If subsong length is 0:0, the STI for this subsong is ignored.
 If STI is found for some subsong, silence detector and autocontinue are
 disabled.
\end_layout

\end_body
\end_document
