Skip to content

Commit

Permalink
update desktop README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@kdoren
kdoren committed Dec 26, 2020
1 parent c711b50 commit cb72495
Showing 1 changed file with 43 additions and 31 deletions.
74 changes: 43 additions & 31 deletions stage3/04-install-sw/files/README.md
View file
Original file line number Diff line number Diff line change
@@ -1,25 +1,24 @@
# Jambox: Jamulus on Raspberry Pi 4
# Jambox: Jamming on Raspberry Pi

## Quickstart:

### Get Wired:
- **Ethernet cable** between Raspberry Pi and your router (can't use wireless with Jamulus)
- **Headphones** to Headphone Amplifier (Rockville HPA-4 recommended) or headphone out of audio interface.
- **Headphone Amp power supply**
- **Raspberry Pi power supply** to USB-C port on Raspberry Pi
- **Raspberry Pi power supply** to USB-C port on Raspberry Pi 4, or micro USB port on Raspberry Pi 3B
- **USB Audio Interface** to a USB port on Raspberry Pi
- Behringer UM2 is a good choice
- verified to work with Behringer UCA222
- verified to work with Focusrite 2i2
- other 2-channel interfaces are likely to work
- other interfaces may require editing parameters in /etc/jackrdc.conf
- **Microphone and/or instrument** to USB Audio Interface
- Microphone preamp requires XLR cable (do not connect microphone to 1/4" jack)
- Microphone preamp requires XLR cable (don't connect microphone to 1/4" jack)
- Guitar/Bass to channel 2 (so channel 1 can be used for talkback)
- Keyboard can be wired as mono into channel 2, using channel 1 for talkback microphone.
- Stereo keyboard sounds best when using both channels (1/4" jacks)
- But in that case, talkback mic will requre a mixer in front of the USB Audio Interface

### Fire It Up:
- **Turn On Power** to Raspberry Pi using the switch in the power cable.
- **Wait a Minute or Two** for the Raspberry Pi to boot up.
Expand All @@ -30,38 +29,51 @@
- If more than 1 Jambox on same local network, use the full url from the label on the box
- click "Connect" on noVNC screen to bring up Raspberry Pi desktop

### Connect to a Jamulus Server:
- Jamulus is set to automatically launch on boot.
- Otherwise, double-click on the "Jamulus Start" icon on the desktop.
- After 2 hours of Jamulus, system will automatically shut the system down
- If it shuts down and you need more time, power off & back on)
- If you close Jamulus before the 2 hour timeout, it won't automatically shut down.
- If Jamulus isn't running, double-click "Jamulus Start" to launch Jamulus startup script.
## Connect using Jamulus (server-based) or SonoBus (peer-to-peer)

### Personalize It:
- View -> My Profile, then set your Name, Instrument, City, and Skill.
- View -> Chat to see the chat window. Not yet clear if/how this will be used by JNS ensembles.
- Settings:
- Jitter Buffer: recommend leaving set to *Auto*
- Enable Small Network Buffers: lowers delay, but uses more bandwidth, with a bit more audio breakup.
- Audio Channels: *Mono-in/Stereo-out* will mix both channels from USB Audio Interface into one (for mic or guitar)
- Audio Channels: *Stereo* is good for stereo keyboard, but talkback mic will require an external mixer.
- Audio Quality: *High* uses more bandwidth than *Normal* but sounds somewhat better.
###Jamulus
+ **Connect to a Jamulus Server:**
- Jamulus may be set to automatically launch on boot. It may also be set to auto-connect to a server.
- Otherwise, double-click on the "Jamulus Start" icon on the desktop.
- After 2 hours of Jamulus, system will automatically shut down
- If it shuts down and you need more time, power off & back on)
- If you close Jamulus before the 2 hour timeout, it won't automatically shut down.
- If Jamulus isn't running, double-click "Jamulus Start" to launch Jamulus startup script.
+ **Personalize It:**
- View -> My Profile, then set your Name, Instrument, City, and Skill.
- View -> Chat to see the chat window to message other musicians.
+ **Jamulus Features:**
- Input level meters: This is the audio you are sending; keep it out of the red.
- Level and Pan controls for each musician (your own Personal Mix!)
- **Listen to the mix coming from the server.** Your brain will quickly adapt to any delay, up to a point.
+ **Jamulus Settings:**
- Jitter Buffer: Start with *Auto*, wait a min or 2 to settle, then increase each jitter buffer by 2 for less breakup.
- Enable Small Network Buffers: Recommended. Lowers delay, but uses more bandwidth.
- Audio Channels: *Mono-in/Stereo-out* - recommended for most users. It will mix both channels from USB Audio Interface into one (for mic or mono instrument)
- Audio Channels: *Stereo* is for stereo sources like stereo keyboard or multiple microphones.
- Audio Quality: *High*: Recommended. Uses more bandwidth than *Normal* but sounds somewhat better.
- Skin: *Fancy* looks nice, but *Normal* and especially *Compact* fit more musicians on the screen.
- Overall Delay: Useful number to watch. 30 ms = Fun; 50 ms = Not so much
+ **Jamulus Software Manual:** [https://jamulus.io/wiki/Software-Manual](https://jamulus.io/wiki/Software-Manual)

### SonoBus
+ **Connect with your group:**
- Click "Connect" to get started
- Enter your group's chosen "Group Name" that your group will use to find each other.
- Enter "Your Displayed Name" for others in your group to see
- Click "Connect to Group"
+ **SonoBus Features:**
- "Monitor Level is what you hear (has no effect on what others hear).
- "Output Level" is the what you are sending to others.
+ **SonoBus User Guide:** [https://www.sonobus.net/sonobus_userguide.html](https://www.sonobus.net/sonobus_userguide.html)

### Play!
- **Make sure that "Direct Monitor" on USB Audio Interface is "off" (pushbutton out for Behringer UM2).**
- **Listen to the Mix coming from the server.** Your brain will quickly adapt to any delay, up to a point.
- Jamulus features:
- Input level meters: This is the audio you are sending; keep it out of the red.
- Level and Pan controls for each musician (your own Personal Mix!)
- The Behringer UM2 features:
- Clipping LED for each channel
- Input Level controls for both channels: (try to avoid lots of clipping)
- **Make sure that "Direct Monitor" on your USB Audio Interface is "off" (pushbutton out for Behringer UM2).**
- If you run a simultaneous video call to see each other, don't use it for audio - all call participants should mute their mics.


### Wrap up
- Jamulus "Disconnect" button will kill your server connection.
- Closing Jamulus ("x" in upper right) will exit the Jamulus startup script, stopping the 2-hour timer.
### Wrap Up
- Jamulus and Sonobus each have a "Disconnect" button which will kill your connection.
- Closing the program ("x" in upper right) will exit the startup script.
- To shut the system down, double-click the "Stop Sign" button on the desktop, then wait 1 min for full shutdown.
- Try to avoid shutting down by simply killing power, it can corrupt the SD card and make system unbootable.

0 comments on commit cb72495

Please sign in to comment.