Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[POC] Markdown support #712

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ sphinx-intl
sphinx-notfound-page
graphviz
markupsafe
myst-parser
transifex-client
sphinxcontrib-svg2pdfconverter
sphinx-rtd-theme
Expand Down
124 changes: 124 additions & 0 deletions source/chapters/example_setups.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,124 @@
# Example Setups

This chapter presents some example hardware setups with instructions for how to configure Mixxx to work with them.

## See Also

* [Hardware](#hardware): background information about different types of equipment.

Check warning on line 7 in source/chapters/example_setups.md

View workflow job for this annotation

GitHub Actions / Build Check

no target found for cross-reference 'hardware'

Check warning on line 7 in source/chapters/example_setups.md

View workflow job for this annotation

GitHub Actions / Build Check

no target found for cross-reference 'hardware'

Check warning on line 7 in source/chapters/example_setups.md

View workflow job for this annotation

GitHub Actions / Build Check

more than one target found for 'myst' cross-reference hardware: could be :std:ref:`Hardware` or :std:doc:`Hardware` [myst.xref_ambiguous]
* [Getting Started with Sound I/O](#getting-started-sound-io): details about each available input and output option.

Check warning on line 8 in source/chapters/example_setups.md

View workflow job for this annotation

GitHub Actions / Build Check

no target found for cross-reference 'getting-started-sound-io'

Check warning on line 8 in source/chapters/example_setups.md

View workflow job for this annotation

GitHub Actions / Build Check

no target found for cross-reference 'getting-started-sound-io'
* [Microphones](#microphones): details for configuring Mixxx to work with microphones.

Check warning on line 9 in source/chapters/example_setups.md

View workflow job for this annotation

GitHub Actions / Build Check

no target found for cross-reference 'microphones'

Check warning on line 9 in source/chapters/example_setups.md

View workflow job for this annotation

GitHub Actions / Build Check

no target found for cross-reference 'microphones'

Check warning on line 9 in source/chapters/example_setups.md

View workflow job for this annotation

GitHub Actions / Build Check

more than one target found for 'myst' cross-reference microphones: could be :std:ref:`Microphones` or :std:doc:`Microphones` [myst.xref_ambiguous]
* [DJ Hardware Guide](https://github.com/mixxxdj/mixxx/wiki/Hardware-Compatibility): lists specific devices with information about their prices, features, and compatibility with Mixxx.

## Computer Only

The built-in audio interface on most computers comes with a single stereo line-out and a microphone input. This can be set up with Mixxx in two ways:

### Practicing Mixing / Broadcasting

This setup can be used with a single audio output for speakers or headphones to practice DJing without investing in any equipment other than a computer and a set of speakers or headphones. With this configuration, use the [Pre/Main Knob](#interface-head-main) to switch back and forth between the main mix and [PFL](#pfl) signal. This setup cannot be used to play for a live audience because the main mix is not sent to an audio interface output. However, it can be used by radio DJs who only need to send the main mix to a broadcast audience.

Check warning on line 18 in source/chapters/example_setups.md

View workflow job for this annotation

GitHub Actions / Build Check

no target found for cross-reference 'interface-head-main'

Check warning on line 18 in source/chapters/example_setups.md

View workflow job for this annotation

GitHub Actions / Build Check

no target found for cross-reference 'interface-head-main'

1. Open `Preferences --> Sound Hardware`
2. Select the `Output` tab
3. From the `Headphones` drop-down menu, select your built-in audio interface, then `Channels 1-2`. Although this is labeled `Headphones`, you can also plug speakers into the output jack of your computer.
4. Depending on your audio interface, you can specify a [microphone](#microphones)
a. Use your built-in microphone or connect a microphone to your computer
b. Check that your microphone is detected by your [OS](#os)
c. Open the `Input` tab
d. From the `Microphone` drop-down menu, select the input your microphone is connected to
5. Click `Apply` to save the changes.

### Playing for an Audience

This setup allows for playing to an audience without headphone [cueing](#cueing).

![Using Mixxx with your built-in sound card](../_static/Mixxx-111-Preferences-Soundhardware.png)

1. Open `Preferences --> Sound Hardware`
2. Select the `Output` tab
3. From the `Main` drop-down menu, select your built-in audio interface, then `Channels 1-2`
4. Depending on your audio interface, you can specify a [microphone](#interface-mic)
a. Use your built-in microphone or connect a microphone to your computer
b. Check that your microphone is detected by your [OS](#os)
c. Open the `Input` tab
d. From the `Microphone` drop-down menu, select the input your microphone is connected to
5. Click `Apply` to save the changes.

## Laptop and Splitter Cable

The cheapest way to DJ and [cue](#cue) with headphones uses a stereo-to-mono DJ splitter cable (also known as a “Y cable”) plugged into the headphone jack of a laptop or other computer. This cable divides the stereo output from a single jack into two separate mono signals.

This setup allows you to start DJing without having to invest in expensive equipment. However, because the signals are in mono, you and your audience will not be able to enjoy music producers' positioning of sound in space (although many club PA systems are wired in mono anyway). Furthermore, audio interfaces built into computers are usually low quality and often pick up interference from other components of the computer.

**Using a built-in audio interface and a stereo-to-mono splitter**

1. Open `Preferences --> Sound Hardware`
2. Select the `Output` tab
3. Check that your headphones are plugged into the side of the cable with a headphones symbol and that the speakers are plugged into the side of the cable with a speaker symbol.
4. From the `Main` drop-down menu, select your built-in audio interface, then `Channel 1`
5. From the `Headphones` drop-down menu, select your built-in audio interface, then `Channel 2`
6. Click `Apply` to save the changes.

> **Warning:** Most splitter cables, particularly those marketed as headphone splitter cables, output the same stereo signal to two headphone jacks and will not work for this DJ setup. Also, if you use a generic stereo-to-mono splitter adapter, you may only be able to hear out of one side of your speakers and headphones. DJ splitter cables allow you to hear the same mono signal on both sides of your headphones and speakers.

## Laptop and External USB Audio Interface

![Using Mixxx together with an external audio interface](../_static/mixxx_setup_ext_audio_interface.png)

**Using two audio interfaces (built-in + external)**

1. Open `Preferences --> Sound Hardware`
2. Select the `Output` tab
3. From the `Main` drop-down menu, select the external audio interface, then `Channels 1-2`
4. From the `Headphones` drop-down menu, select the built-in audio interface, then `Channels 1-2`

**Using an external multi-channel audio interface**

1. Open `Preferences --> Sound Hardware`
2. Select the `Output` tab
3. From the `Main` drop-down menu, select the external audio interface, then `Channels 1-2`
4. From the `Headphones` drop-down menu, select the external audio interface, then `Channels 3-4`
5. Click `Apply` to save the changes.

## Laptop and MIDI or HID Controller

## See Also

* The [hardware controllers](#hardware-controllers) section of the [hardware](#hardware) chapter has background information about controllers.

### Controllers with an integrated audio interface

Many DJ controllers include an integrated *multi-channel* audio interface. A setup with this kind of controller may look like the diagram below:

![Using Mixxx together with a DJ controller and integrated audio interface](../_static/mixxx_setup_midi_integrated_audio_interface.png)

**Using a controller with an integrated multi-channel audio interface**

1. Open `Preferences --> Sound Hardware`
2. Select the `Output` tab
3. From the `Main` drop-down menu, select your controller's audio interface, then `Channels 1-2`
4. From the `Headphones` drop-down menu, select your controller's audio interface, then `Channels 3-4`
5. Click `Apply` to save the changes.

### Controllers without an integrated audio interface

Controllers without an integrated audio interface can be used together with a USB audio interface as depicted in the diagram below:

![Using Mixxx together with a DJ controller and external audio interface](../_static/mixxx_setup_midi_with_ext_audio_interface.png)

**Using a controller without an integrated audio interface**

1. Open `Preferences --> Sound Hardware`
2. Select the `Output` tab
3. From the `Main` drop-down menu, select the external audio interface, then `Channels 1-2`
4. From the `Headphones` drop-down menu, select the built-in audio interface, then `Channels 1-2`
5. Click `Apply` to save the changes.

## Laptop, External Hardware Mixer and Vinyl Control

![Using Mixxx together with turntables and external mixer](../_static/mixxx_setup_timecode_vc.png)

This setup allows DJs to use the techniques of DJing with vinyl record turntables combined with the portability and flexibility of a laptop computer. Instead of carrying crates of records or CDs, DJs can carry their entire music collection on their laptop. In addition to a laptop and headphones, this setup requires an audio interface with at least two pairs of stereo inputs and outputs as well as a pair of [timecode](#timecode) records.

## See Also

* Go to the chapter [vinyl control](#vinyl-control) for detailed information.
248 changes: 0 additions & 248 deletions source/chapters/example_setups.rst

This file was deleted.

2 changes: 2 additions & 0 deletions source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@
"sphinxcontrib.rsvgconverter",
"sphinx_rtd_theme",
"sphinx_multiversion",
"myst_parser",
"sphinx_mixxx",
"notfound.extension",
]
Expand All @@ -47,6 +48,7 @@
# The suffix of source filenames.
source_suffix = {
".rst": "restructuredtext",
".md": "markdown",
}

# The encoding of source files.
Expand Down
Loading