updated manual

6 files changed, 96 insertions, 2 deletions

diff --git a/muse2/ChangeLog b/muse2/ChangeLog
index c82420b5..11b56da3 100644
--- a/muse2/ChangeLog
+++ b/muse2/ChangeLog
@@ -1,3 +1,5 @@
+09.09.2012:
+         - Added instructions on how to record audio with MusE to the new manual (rj)
 08.09.2012:
          - Follow up to Improved Wave Editor: Added Edit -> Adjust Wave Offset. Helps compensate for latency. (Tim) 
            FIXME: Respect clones! If operating on two selected clones of the same part, an extra event is created.
diff --git a/muse2/doc/documentation.tex b/muse2/doc/documentation.tex
index 5775333d..bc34c7ec 100644
--- a/muse2/doc/documentation.tex
+++ b/muse2/doc/documentation.tex
@@ -1,4 +1,5 @@
 %% (c) 2012 florian jung
+%% (c) 2012 Robert Jonsson
 %% we should consider putting this under a proper license. GPL, or
 %% some GPL-like documentation license??
 
@@ -63,6 +64,20 @@
 %%   label. (LaTeX will insert the section number instead of \ref)
 %%   For this to work, you might need to recompile the .tex twice.
 %%
+%% 
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%
+%% Dependencies:
+%% To produce pdf output from this document the following packages are
+%% needed (atleast under Ubuntu derivatives)
+%% latex???-base
+%% texlive-latex-recommended
+%% texlive-latex-extra
+%%
+%% To produce a pdf version of this manual type:
+%% pdflatex documentation.tex <enter>
+%% A file documentation.pdf should be generated.
+%%
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 
@@ -269,7 +284,7 @@ midi, start MusE with the -A option: \shell{\$> muse2 -A}
 \subsection{Beginners tutorial}
 To get a quick grip of what MusE can achieve please follow this beginners
 tutorial.
-\subsubsection{Setup}
+\subsubsection{Midi Setup}
 First off, fire up MusE as was described in the previous chapter, making
 sure that the jack audio server is started with sufficient configuration
 to allow for audio output without breakup. Also make sure your system can
@@ -348,8 +363,85 @@ document is not enough, try googling your problem and/or get in touch with
 one of the online forums for MusE or Linux audio in general. See some pointers
 in the Support chapter.}
 
-\subsubsection{Recording}                                                %TODO: walkthrough of recording midi
+
+\subsubsection{Recording Midi}                                                %TODO: walkthrough of recording midi
 TBD
+\subsubsection{Recording Audio}
+At this point we'll make a a slight detour into full on audio recording. Getting
+audio out of MusE has already been covered in the previous chapters so we will
+concentrate on the additional steps needed to record onto an audio track.\\
+\\
+When MusE is first fired up, the
+output track has already been created (more about this in the chapter about 
+templates), to proceed with audio recording we need to add two additional tracks, a 
+wave track and an input track.\\
+When MusE is first started right click in an empty space on the track view
+\begin{figure}[htp]
+\centering \includegraphics[width=\screenshotwidth]
+{pics/main_window_add_track}
+\caption{Add track}
+\label{fig:Add track}
+\end{figure}
+and select \menu{Add Audio Input}. Right click again and also select 
+\menu{Add Wave Track}. Two additional tracks are now visible in the Arranger, 
+"Input 1" and "Track 1", bring up the mixer with \menu{F10} and you should see 
+the following configuration.
+\begin{figure}[htp]
+\centering \includegraphics[width=0.25\textwidth]{pics/mixer_with_one_input} 
+\caption{Mixer with one input}
+\label{fig:Mixer with one input}
+\end{figure}
+\\
+Note the buttons on each mixer strip. hover over them to see their 
+functionality. For more information on all the buttons see coming chapters 
+about the mixer. For now lets just do what we must.\\
+1. click on the stereo symbol over the slider to change the input to a mono track.\\
+2. do the same for the wave track (optional)\\
+3. click on the Mute (gray speaker) icon on the input track to unmute it.\\
+4. click on the input routing button (see the tooltip, it looks like a tele plug) 
+on the input track and select an appropriate connection from your system.\\
+5. click on the output routing button on the input track and select 
+\textbf{Track 1}\\
+\\
+Already after the meter on the input track should be able to display that there
+is incoming sound from your sound source. If there actually is sound coming 
+from your sound source, that is.\\
+We are now nearly ready to start recording. First we need to select a location
+to store the files. MusE does not use a centralized storage of soundfiles but
+uses the path of the song-file (extension .med) as guidance as to where the
+audio files should be placed. Now as it happens MusE will prohibit us from
+starting a recording until the songfile has been stored. So lets take advantage
+of this behaviour and just go ahead and try to record. Let's get started.\\
+In the mixer click on the red \textbf{record} dot on the Audio Track to arm it
+for recording (or enable if you will). Now when there is audio coming into the
+input it will also show up on the Audio Track. Also note that all the input and
+output routing buttons on the tracks now have the same gray color, this means
+that all of the tracks have a proper connection.
+\begin{figure}[htp]
+\centering \includegraphics[width=0.25\textwidth]{pics/mixer_with_one_input_buttons} 
+\caption{Mixer buttons}
+\label{fig:Mixer buttons}
+\end{figure}
+\\
+All fine and dandy. Now bring up the arranger window and find the round, red on
+white  \textbf{record} button and click on it. This is your queue to MusE to
+prepare for recording. However since we have not saved our song we are presented
+with a dialog to do just that.\\
+\begin{figure}[htp]
+\centering \includegraphics[width=0.6\textwidth]{pics/project_my_first_song} 
+\caption{Save song}
+\label{fig:Save song}
+\end{figure}
+Note the check box for creating a project folder, when working with audio this
+is very much recommended or you may soon loose track of what audio files belong
+to which song.\\
+Finally we are ready to start recording! The process is completed by clicking
+on the \textbf{Play} button in the Arranger. If all went well MusE then starts
+to record a wave file from the Input Track placed in your song directory.\\
+When you wish to stop recording press \textbf{Stop} in the Arranger, now the 
+resulting waveform should be visible in the Arranger. After rewinding the Play 
+position and pressing \textbf{Play} again the resulting sound should be audible
+through the connected output.
 
 
 \section{Basic overview}
diff --git a/muse2/doc/pics/main_window_add_track.png b/muse2/doc/pics/main_window_add_track.png
new file mode 100644
index 00000000..7750ca7f
--- /dev/null
+++ b/muse2/doc/pics/main_window_add_track.png
diff --git a/muse2/doc/pics/mixer_with_one_input.png b/muse2/doc/pics/mixer_with_one_input.png
new file mode 100644
index 00000000..629328d7
--- /dev/null
+++ b/muse2/doc/pics/mixer_with_one_input.png
diff --git a/muse2/doc/pics/mixer_with_one_input_buttons.png b/muse2/doc/pics/mixer_with_one_input_buttons.png
new file mode 100644
index 00000000..c6ad7b0c
--- /dev/null
+++ b/muse2/doc/pics/mixer_with_one_input_buttons.png
diff --git a/muse2/doc/pics/project_my_first_song.png b/muse2/doc/pics/project_my_first_song.png
new file mode 100644
index 00000000..488faad2
--- /dev/null
+++ b/muse2/doc/pics/project_my_first_song.png