Differences

This shows you the differences between two versions of the page.

--- doc:manual-en [2010/09/30 07:22]
shelagh fix up error
+++ doc:manual-en [2025/05/13 18:55] (current)
tedfelix [Audio segments]
@@ Line 2: / Line 2: @@
 We're moving to the wiki!
-As of Thorn, the Rosegarden Handbook will be maintained here on the wiki, and the help system will require internet access. All the broken help menus and help buttons will refer here.
+As of Thorn, the Rosegarden Handbook will be maintained here on the wiki, and the help system will require Internet access. All the broken help menus and help buttons will refer here.
 Depending on how painful this whole conversion and editing process is, the rest of Rosegarden's documentation may follow suit.  This would be a painful and arduous process if undertaken, but it might well be worth the pain in the long run.  I'd like to move the entire text of Rosegarden Companion here, along with all the tutorials.  This would require replacing hundreds of images, but all of the images are quite out of date anyway, and could do with freshening up.  We'll do the Handbook first, which has the shortest text and the highest text:image ratio, and see how it follows from there.
@@ Line 37: / Line 37: @@
 Rosegarden provides three distinct ways of viewing, editing, and entering MIDI events, including a powerful notation editor that provides many advanced features not typically found in the notation facility of MIDI sequencers. Underneath these three editors, Rosegarden provides a segment-based mechanism for arranging blocks of MIDI and audio data on a canvas that brings something akin to the flexibility of a layer-based image editing program to the realm of music.
-Rosegarden is built using [[http://qt.nokia.com|Qt]] -- A cross-platform application and UI framework.  It uses ALSA to provide MIDI support, and JACK for audio, both of which limit Rosegarden to Linux for the time being, but that should hopefully change in the future, with OS-X being the next most accessible platform, and Windows the most difficult to reach.
+Rosegarden is built using [[http://qt-project.org/|Qt]] -- A cross-platform application and UI framework.  It uses ALSA to provide MIDI support, and JACK for audio, both of which limit Rosegarden to Linux for the time being, but that should hopefully change in the future, with OS-X being the next most accessible platform, and Windows the most difficult to reach.
 ==== About this Manual ====
@@ Line 131: / Line 131: @@
 {{doc:rg-trackbutton-labels.png|Rosegarden's Track buttons showing track labels}}
-The button area to the left of the segment canvas shows you the track number, mute and record status, and the label of the track. You can mute or unmute a track by clicking on the blue LED-style button, and select a particular track as a record target by clicking on the red one. To change the track label, double-click on it.
+The button area to the left of the segment canvas shows you the track number, mute and record status, and the label of the track. You can mute or unmute a track by clicking on the blue LED-style button, and select a particular track as a record target by clicking on the yellow one. To change the track label, double-click on it.
 {{doc:rg-trackbutton-instruments.png|Rosegarden's Track buttons showing instrument assignments}}
-Track labels are only shown if the **Settings → Show Track Labels** menu option is enabled. Otherwise, as in this picture, the instrument assignments for the tracks are shown instead
+Track labels are only shown if the **View → Show Track Labels** menu option is enabled. Otherwise, as in this picture, the instrument assignments for the tracks are shown instead
 ===== Tracks and instruments =====
@@ Line 171: / Line 171: @@
 ===== Audio segments =====
-An audio segment contains recorded or sampled audio data, instead of editable note-event data. Rosegarden allows you to record, play, arrange and split audio segments, but does not contain audio waveform editing facilities.
+An audio segment contains recorded or sampled audio data, instead of editable note-event data. Rosegarden allows you to record, play, arrange and split audio segments.
 To create an audio segment, you can [[doc:manual-en#recording|record]] from an audio source onto a track assigned to an audio instrument, or you can work with existing WAV files. To do this, you need to use the [[audiomanager-en|audio file manager]] **File → Manage Audio Files**.
+While Rosegarden cannot edit audio waveforms on its own, it //can// launch the audio editor of your choice (e.g. Audacity) when you double-click on an audio segment.  Be aware that making changes and exporting them over top of the original WAV file is **destructive**, so make backups and be careful.  Also make sure you export in the format Rosegarden expects: 32-bit float.  Otherwise you will hear some very unpleasantly loud noise.
 ===== Manipulating segments =====
@@ Line 290: / Line 292: @@
 ===== Overview =====
-{{http://rosegardenmusic.com/wiki/rg-transport.png|Rosegarden's Transport window}}
+{{doc:rg-transport.png|Rosegarden's Transport window}}
-If the transport isn't visible, you can activate it with **Settings → Show Transport**.
+If the transport isn't visible, you can activate it with **View → Show Transport**.
 The transport shows the time reached by the playback pointer, in seconds by default.
@@ Line 439: / Line 441: @@
 These provide an alternative mechanism to the [[/#segment-view-instruments|menu-based system]] of instrument assignment.
 ==== Track recording filters ====
 These provide you a way to control what events are recorded to this track. If you leave the default values “all” for both parameters, every received event will be stored in the track. This setting is safe and convenient if you are recording only one MIDI track. Otherwise, you should adjust one or both parameters to select only the desired events for the track.
-Device
+**Device**
-You can record from only one of the available devices marked for recording in the [[/#studio-device-editor|device manager]], or from all of them simultaneously.
-Channel
+You can record from only one of the available devices marked for recording in the [[doc:device-manager-en#managing_midi_devices|device manager]], or from all of them simultaneously.
+**Channel**
 You can record from all channels, or limit recording to only one of the 16 available MIDI channels. In this case, only MIDI channel messages matching the channel number will be recorded, and system messages not having a channel (as system exclusive events) will be discarded.
@@ Line 454: / Line 457: @@
 Both parameters are cummulative: you can filter only a device, only a channel, or both a device and a channel simultaneously. It is not mandatory to ensure mutually exclusive selections for all the armed tracks, but if you don't do so you will find duplicated events at several recorded tracks.
-The recording filters are also used to [[/#studio-midi-routing|route MIDI events ]] to the assigned track instrument when you are recording.
+The recording filters are also used to [[doc:device-manager-en#midi_routing|route MIDI events ]] to the assigned track instrument when you are recording.
 ==== Staff export options ====
@@ Line 462: / Line 465: @@
 You are responsible for creating a series of bracket start and end markers that will yield a functional result, and if you make a mistake with these, it is likely that your file will not export or preview correctly in LilyPond.
-For a detailed, hands-on demonstration of brackets in action, please see [[http://www.rosegardenmusic.com/tutorials/supplemental/fidelio/index.html|this online tutorial]].
+For a detailed, hands-on demonstration of brackets in action, please see [[http://www.rosegardenmusic.com/tutorials/supplemental/fidelio/index.html|this online tutorial]].==== Create segments with ====
-==== Create segments with ====
+These provide you with a means of controlling many of the [[doc:manual-en#the_segment_parameter_box|segment parameters]] for segments that don't yet exist. They are aimed especially at notation users, and they facilitate operations that require you to use more than one segment on a track (as when using [[doc:manual-en#the_segment_parameter_box|repeats]], or [[/#nv-lilypond-directives|alternative endings]]), by allowing you to create a series of new segments that all have the same properties by default. FIXME: I can't find the reference to alternative endings SOM
-These provide you with a means of controlling many of the [[/#segment-view-segmentparameterbox|segment parameters]] for segments that don't yet exist. They are aimed especially at notation users, and they facilitate operations that require you to use more than one segment on a track (as when using [[/#segment-view-segmentparameterbox|repeats]], or [[/#nv-lilypond-directives|alternative endings]]), by allowing you to create a series of new segments that all have the same properties by default.
+**Preset**
-Preset
 The Load button launches a dialog that allows you to pick a pre-defined collection of parameters that provide guidelines for how you should write parts for real-world instruments, and optionally convert any existing segments on this track to take on these new parameters.
@@ Line 474: / Line 475: @@
 {{http://rosegardenmusic.com/wiki/rg-loadpreset.png}}
-You first pick a Category, then an Instrument, and finally choose whether you wish to write a part for an amateur or a professional player. <sup>[[[/#ftn.id597235|3]]]</sup> The Scope controls allow you to choose whether these parameters will only affect segments that don't yet exist (which you will subsequently record, or draw with the pencil) or should convert any existing segments to take these parameters as well. (For a demonstration of the latter case in action, please see [[http://rosegarden.sourceforge.net/tutorial/supplemental/fidelio/| this online tutorial.)]] Clicking the OK button injects the appropriate parameters into the remaining widgets in this part of the track parameters box, where you can tweak them if you desire.<sup>[[[/#ftn.id597261|4]]]</sup>
+You first pick a Category, then an Instrument, and finally choose whether you wish to write a part for an amateur or a professional player.  The Scope controls allow you to choose whether these parameters will only affect segments that don't yet exist (which you will subsequently record, or draw with the pencil) or should convert any existing segments to take these parameters as well. (For a demonstration of the latter case in action, please see [[http://rosegarden.sourceforge.net/tutorial/supplemental/fidelio/| this online tutorial.)]] Clicking the OK button injects the appropriate parameters into the remaining widgets in this part of the track parameters box, where you can tweak them if you desire.
 Once you have loaded a preset, the name of your chosen preset will be used as the label for any segments you subsequently draw or record on this track, even if you change some or all of the associated parameters away from the values you just loaded.
-Clef
+**Clef**
 This lets you choose the clef for any segments you subsequently draw or record on this track. Clefs are events, not properties. Your segments will be created with an initial clef event of the appropriate type (which you may subsequently alter or delete, should you have some occasion to do so.)
@@ Line 484: / Line 485: @@
 The clefs available include a variety of named clefs representing standard clefs with various octave offsets.
-Transpose
+**Transpose**
 This causes segments on this track to be created so that their note events sound at a given transposition. Useful, especially, for writing parts for transposing instruments.
-Colour
+**Colour**
 This causes segments on this track to be created using a given colour.
-Range
+**Range**
 The Low: and High: buttons, launch a dialog that allows you to pick a pitch using a staff. The lowest and highest pitches you select will then appear right on these buttons.
@@ Line 498: / Line 499: @@
 These represent the lowest and highest playable notes, respectively, on the instrument for which you are writing notation. In some cases, these limits will be hard and fast, like the low B on a Transverse Flute (B foot). In others, they may only serve as guidelines to help you make good choices for instruments with which you are not intimately familiar.
-If you enter, record, or import data that has pitches exceeding the values specified, the note heads will appear in red by default. You can turn this behavior off with Settings → Configure Rosegarden → Notation → Show notes outside playable range in red
+If you enter, record, or import data that has pitches exceeding the values specified, the note heads will appear in red by default. You can turn this behavior off with **Preferences → Notation → Show notes outside playable range in red**
 ===== The Segment Parameter Box =====
-{{http://rosegardenmusic.com/wiki/rg-segmentparameterbox.png|Rosegarden's segment parameter box}}
+{{ :doc:rg-segment-parameters-box.png|Rosegarden's segment parameter box}}
-The segment parameter box can be found at the left side of the Rosegarden main window. If you can't see it, try using Settings → Show Special Parameters. It allows you to modify some aspects of the selected segments.
+The segment parameter box can be found at the left side of the Rosegarden main window. If you can't see it, try using **View → Show Special Parameters**. It allows you to modify some aspects of the selected segments.
 If a single segment is currently selected, its parameters will be shown in the segment parameter box and can be edited there. If several segments are selected, the parameter box will only show the current values where they are the same for all of the selected segments – but you can still edit them, and your changes will apply to the whole selection.
-Label
+**Label**
 Shows the label of the selected segment (or segments, if they all have the same label). Click the Editbutton to edit the label.
-Repeat
+**Repeat**
 Switches repeat on or off for the selected segments. A repeating segment will repeat until the start of the following segment on the same track, or until the end of the composition if there is no following segment.
-The repeated parts of a repeating segment are shown on the main canvas in a fainter colour than the original segment. You can turn them into real editable copies of the original segment either by using Segments → Turn Repeats into Copies, or simply by double-clicking on the individual repeating blocks.
+The repeated parts of a repeating segment are shown on the main canvas in a fainter colour than the original segment. You can turn them into real editable copies of the original segment either by using **Segments → Turn Repeats into Copies**, or simply by double-clicking on the individual repeating blocks.
-Quantize
+**Quantize**
-Shows the quantization setting for the selected segments. You can change this to quickly quantize the start times of all their notes. For more advanced quantization, use Segments → Quantize.... See [[/#quantization|Quantization]] for more details.
+Shows the quantization setting for the selected segments. You can change this to quickly quantize the start times of all their notes. For more advanced quantization, use **Segments → Quantize....** See [[doc:manual-en#quantization|Quantization]] for more details.
-Transpose
+**Transpose**
 Shows the transposition (in semitones) currently applied to the selected segments. This transposition is applied when the segment is played, and is not shown in the notes displayed in the matrix, notation or event list editors. You can use this to quickly change the pitch of part or all of a composition, and it is commonly used with segments containing notation written for transposing instruments, such as the clarinet.
-Delay
+**Delay**
 Shows the delay currently in effect on the selected segments. You can set a delay here in order to cause an entire segment to play later than written. This delay is applied when the segment is played, and is not shown in the notes displayed in the matrix, notation or event list editors.
@@ Line 532: / Line 532: @@
 You can set a delay either in musical time (by choosing a note duration from the delay dropdown), in which time the exact delay will depend on the tempo, or in real time (by choosing a time in milliseconds from the dropdown).
-Colour
+**Colour**
 Shows the colour being used for the display of the selected segments. You can choose another colour from the dropdown, or choose the “Add New Colour” option at the very bottom of the list of colours if you want a colour not in the dropdown.
-You can also manage and rename colours using Composition → Edit Document Properties... and choose the Colour page on the document properties dialog. The modified colour palette will be saved with the composition in the Rosegarden file.
+{{:doc:rg-colour-manager1.png|Rosegarden's colour manager }}
-{{http://rosegardenmusic.com/wiki/rg-colours.png|Rosegarden's colour manager}}
+<del>You can also manage and rename colours using Composition → Edit Document Properties... and choose the Colour page on the document properties dialog. The modified colour palette will be saved with the composition in the Rosegarden file.</del> FIXME: I don't think is relevant anymore. I couldn't find this where it said it was. Have we got rid of this? SOM
 ===== The Instrument Parameter Box =====
-The instrument parameter box can be found at the left side of the Rosegarden main window, near the [[/#segment-view-segmentparameterbox|Segment Parameter Box]]. If you can't see it, try using Settings → Show Special Parameters.
+The instrument parameter box can be found at the left side of the Rosegarden main window, near the [[doc:manual-en#the_segment_parameter_box|Segment Parameter Box]]. If you can't see it, try using **View → Show Special Parameters**.
 It shows you which instrument is assigned to the current selected track, and contains all of the editable controls for that instrument. Remember that because any number of tracks can be assigned to the same instrument, the settings in this box may affect more than one track at a time.
 The layout and contents of the instrument parameter box depend on the type of instrument: MIDI, audio, or synth plugin.
 ==== MIDI Instrument Parameters ====
+{{ :doc:rg-instrument-parameters1.png|Rosegarden's instrument parameter box for a MIDI instrument}}
-{{http://rosegardenmusic.com/wiki/rg-ipb-midi.png|Rosegarden's instrument parameter box for a MIDI instrument}}
 When you select a track assigned to a MIDI instrument, the instrument parameter box shows MIDI parameters.
@@ Line 556: / Line 554: @@
 At the top, this box shows the name of the instrument and the connection that its device is using.
-Below that, you can see and edit the MIDI channel number and the [[/#studio-bank-editor|bank and program]] settings that should be sent to the instrument at the start of playback including a percussion toggle that controls whether only percussion programs should be offered in these settings.
+Below that, you can see and edit the [[/doc:bankeditordialog-en|bank and program]] settings that should be sent to the instrument at the start of playback including a percussion toggle that controls whether only percussion programs should be offered in these settings.
-Finally this box shows you the controllers available for this device (those for a General MIDI device are shown above). Any settings you make here will be sent to this instrument's channel at the start of playback.
+Some devices organize their patches in terms of variations.  If the device file is configured properly, you will see Program and Variation settings instead of Bank and Program.  See the "Show Variation list based on MSB/LSB" setting in the [[/doc:bankeditordialog-en|Manage MIDI Banks and Programs window]] (Studio > Manage MIDI Devices > Banks...).
+The Channel setting allows you to select either "Fixed" channel assignment, where the channel will be assigned sequentially for each track, or "Auto" channel assignment, where channels will be assigned on an as-needed basis.  "Auto" channel assignment can be helpful for compositions that require more than 15 instruments, but never use more than 15 at a single time.
+The "Receive external" toggle allows for easier selection of a bank/program via a MIDI device.  The banks and programs tend to be rather arbitrarily organized in the bank and program dropdowns.  With the "Receive external" toggle, you can use your keyboard or other MIDI device to select the bank/program.
+Finally this box shows you the controllers available for this device (those for a General MIDI device are shown above). Any settings you make here will be sent to this instrument's channel at the start of playback.
 ==== Audio Instrument Parameters ====
-{{http://rosegardenmusic.com/wiki/rg-ipb-audio.png|Rosegarden's instrument parameter box for an audio instrument}}
+{{:doc:rg-instrument-parameters2.png |Rosegarden's instrument parameter box for an audio instrument}}
-When you select an audio track, the instrument parameter box shows audio parameters.
+ When you select an audio track, the instrument parameter box shows audio parameters.
 The box has two main faders, one with a blue surround for playback level and the other with a red surround for the record level when recording to this instrument. Between them is a playback level meter.
-The two menus at the top of the box are used to select the input and output [[/#studio-audio-routing|audio routing]] for this instrument. Below them you can select whether the instrument is mono or stereo, and the pan setting for position in the stereo field. <sup>[[[/#ftn.id597861|5]]]</sup>
+The two menus at the top of the box are used to select the input and output [[doc:device-manager-en#audio_routing|audio routing]] for this instrument. Below them you can select whether the instrument is mono or stereo, and the pan setting for position in the stereo field.
+The column of five buttons at lower left are the effects slots. Click on them to select and activate plugin effects for this audio instrument, and to control them using the [[/#studio-plugins|plugin editor dialog]]FIXME (CAN'T FIND). These are insert effects, applied in order from top to bottom before the fader and pan.
-The column of five buttons at lower left are the effects slots. Click on them to select and activate plugin effects for this audio instrument, and to control them using the [[/#studio-plugins|plugin editor dialog]]. These are insert effects, applied in order from top to bottom before the fader and pan.
 ==== Synth Plugin Instrument Parameters ====