]> Shamusworld >> Repos - ardour-manual-diverged/commitdiff
Merge branch 'master' of http://shamusworld.gotdns.org/git/ardour-manual
authorShamus Hammons <jlhamm@acm.org>
Thu, 12 Jan 2017 19:12:18 +0000 (13:12 -0600)
committerShamus Hammons <jlhamm@acm.org>
Thu, 12 Jan 2017 19:12:18 +0000 (13:12 -0600)
1  2 
master-doc.txt

diff --combined master-doc.txt
index de2cb819f17422957404be7a5af90534b88358d6,d3aed91842fe7c173abbe903218ba66f59f1aa9e..8b349f6705890251eaf0b3c67bf7fffe48702bd6
@@@ -7009,16 -7009,35 +7009,35 @@@ title: Status Ba
  part: chapter
  ---
  
- <p class="fixme">Add content</p>
+ <img src="/images/status-bar.png" alt="The status bar">
+ <p>The status bar is an informative bar at the top of the window, showing:</p>
+ <ul>
+   <li><dfn>File:</dfn> the file format used in the session, including when recording</li>
+   <li><dfn>TC:</dfn> is the timecode, i.e. the number of frames per second used by the session (for videos)</li>
+   <li><dfn>Audio:</dfn> gives the sample rate used in the session, and the latency computed from the buffer size</li>
+   <li><dfn>Buffers:</dfn> decribe how much data is buffered, see below</li>
+   <li><dfn>DSP:</dfn> for Digital Sound Processing, shows how much of the CPU is used by Ardour and its plugins</li>
+   <li><dfn>X:</dfn> shows the number of xruns since Ardour's launch, see below</li>
+   <li><dfn>Disk:</dfn> reports the remaining hard disk space as the time that can be recorded with the current session setting</li>
+   <li><dfn>a Clock</dfn> showing the system time</li>
+   <li><dfn>a Log button</dfn> that indicates if Ardour has encountered any warning or error.</li>
+ </ul>
  
+ <p>The buffers are labelled as <kbd class="menu">p</kbd> for playback and <kbd class="menu">c</kbd> for capture. If the
+ system is fast enough, these buffers should be 100% full at all times, showing the system has time to precompute
+ all the data before delivering it to the audio system. A buffer constantly under 20% is a sign of an underpowered
+ computer system or of too much processing.</p>
+ <p>An Xrun (short for buffer over- or under-run) happens when the system has been forced to skip audio frames, e.g. if the latency
+ asked is too short for the computing power of the machine. It usually results in clicks, pops and crackles if it happens while recording.</p>
+ <p>The log button turns yellow when a warning is shows, and red when an error occurs. Clicking the log button gives acces to the log.</p>
  
  ---
  title: Transport bar and times
  part: chapter
  ---
  
- <p class="fixme">There is no discussion of starting playback anywhere in here. Starting/stopping needs to be explained</p>
  <p>
    Ardour offers many ways to <dfn>control playback</dfn> of your session, including the transport bar, key bindings and remote controls. You can also use markers to define locations or ranges within the session and rapidly move around between them.
  </p>
@@@ -7055,7 -7074,7 +7074,7 @@@ part: subchapte
    The <dfn>Transport Bar</dfn> groups all the actions regarding the control of playback and recording.
  </p>
  
 -<img src="/images/transport.png" alt="The transport controls" />
 +<p class="center"><img src="/images/transport.png" alt="The transport controls" /></p>
  
  <p>
    This bar is made of (from left to right):
  
  <ul>
    <li>
 -    <dfn>Midi Panic</dfn>: allows to immediately stop all midi output.
 +    <dfn>Midi Panic</dfn>: Immediately stops all midi output.
    </li>
    <li>
      <dfn>Enable/disable Audio Click</dfn>: Toggles (on/off) a click track (metronome) along the <a href="/tempo-meter/tempo-and-meter/">tempo</a>.
      <dfn>Go to End of the Session</dfn>: Jumps forward to the end of the session, as defined by the <a href="/working-with-markers/">end marker</a>.
    </li>
    <li>
 -    <dfn>Play Loop Range</dfn>: Repeats the defined <a href="/controlling-playback/looping-the-transport/">loop</a> as defined by the <a href="/working-with-markers/loop-range/">Loop range</a>, until the "Stop playback" button is pressed. Clicking the "Play loop Range" button while already active switches to normal Play mode, which allows to exit the loop without stopping and restarting the playback.
 +    <dfn>Play Loop Range</dfn>: Repeats the defined <a href="/controlling-playback/looping-the-transport/">loop</a> as defined by the <a href="/working-with-markers/loop-range/">Loop range</a>, until the "Stop playback" button is pressed. Clicking the "Play loop Range" button while already active switches to normal Play mode, which exits the loop without stopping and restarting playback.
    </li>
    <li>
      <dfn>Play Range/Selection</dfn>: If a range has been defined using the Range Mode button, plays the range, of if an audio or MIDI region is selected, plays this region. In both cases, the playback stops at the end of the range or selected region.
    </li>
    <li>
 -    <dfn>Play from playhead</dfn>: Starts the playback and optionally record (more bellow).
 +    <dfn>Play from playhead</dfn>: Starts the playback and optionally record (more below).
    </li>
    <li>
      <dfn>Stop</dfn>: Whatever the playing mode (loop, range, &hellip;) stops all playback. Depending on other settings, some effects (like chorus or reverb) might still be audible for a while.
    </li>
    <li>
 -    <dfn>Toggle Record</dfn>: Global switch button to activate/deactivate recording. While active, the button blinks red. The button doesn't start the recording itself: if one or more tracks are marked as record-enabled, pressing the "Play from Playhead" starts the recording on this/these track(s). See <a href="/recording/">Recording</a>.
 +    <dfn>Toggle Record</dfn>: Global switch button to activate/deactivate recording. While active, the button blinks red. The button doesn't start recording by itself: if one or more tracks are marked as record-enabled, pressing the "Play from Playhead" starts recording on those tracks. See <a href="/recording/">Recording</a>.
    </li>
  </ul>
  
 -<p class="fixme">Language in the above paragraphs is awkward</p>
 +<p class="fixme">Add default keyboard shortcuts to the above.</p>
  
  <p class="note">
    All these actions are bound to keyboard shortcuts, which allows for speedier use and more focused work.
      <dfn>Follow Edits</dfn> is a toggle that can be used to control whether or not making a selection (range or object) will move the playhead to the start of the selection.
    </li>
    <li>
 -    <dfn>Auto Return</dfn> is a toggle switch too. When active, pressing the Stop button returns the playhead to its previous position, and when inactive, pressing Stop keeps the playhead at its current location. Activating Auto Return can be useful for earing back the same part of the audio before and after having tweaked it, without having to loop on it.
 +    <dfn>Auto Return</dfn> is a toggle switch too. When active, pressing the Stop button returns the playhead to its previous position, and when inactive, pressing Stop keeps the playhead at its current location. Activating Auto Return can be useful for hearing the same piece of audio before and after tweaking it, without having to set a loop range on it.
    </li>
  </ul>