Skip to content

Commit

Permalink
Merge remote-tracking branch 'upstream/2.4' into 2.5
Browse files Browse the repository at this point in the history
  • Loading branch information
daschuer committed Oct 9, 2024
2 parents 0874769 + 0bc3088 commit 22f4209
Show file tree
Hide file tree
Showing 14 changed files with 87 additions and 25 deletions.
Binary file removed source/_static/Mixxx-200-Library-Add-to-Auto-DJ.png
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/_static/Mixxx-241-Library-Auto-DJ.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
39 changes: 39 additions & 0 deletions source/chapters/appendix/mixxx_controls.rst
Original file line number Diff line number Diff line change
Expand Up @@ -832,6 +832,45 @@ Any control listed above for :mixxx:cogroupref:`[ChannelN]` will work for a samp
.. versionadded:: 2.0.0


.. mixxx:control:: [ChannelN],shift_cues_earlier
[PreviewDeckN],shift_cues_earlier
[SamplerN],shift_cues_earlier
:range: binary
:feedback: All :term:`cue markers <cue marker>` move left by 10ms.

.. versionadded:: 2.3.0


.. mixxx:control:: [ChannelN],shift_cues_later
[PreviewDeckN],shift_cues_later
[SamplerN],shift_cues_later
:range: binary
:feedback: All :term:`cue markers <cue marker>` move right by 10ms.

.. versionadded:: 2.3.0


.. mixxx:control:: [ChannelN],shift_cues_earlier_small
[PreviewDeckN],shift_cues_earlier_small
[SamplerN],shift_cues_earlier_small
:range: binary
:feedback: All :term:`cue markers <cue marker>` move left by 1ms.

.. versionadded:: 2.3.0


.. mixxx:control:: [ChannelN],shift_cues_later_small
[PreviewDeckN],shift_cues_later_small
[SamplerN],shift_cues_later_small
:range: binary
:feedback: All :term:`cue markers <cue marker>` move right by 1ms.

.. versionadded:: 2.3.0

.. mixxx:control:: [ChannelN],beats_undo_adjustment
[PreviewDeckN],beats_undo_adjustment
[SamplerN],beats_undo_adjustment
Expand Down
22 changes: 17 additions & 5 deletions source/chapters/djing_with_mixxx.rst
Original file line number Diff line number Diff line change
Expand Up @@ -392,7 +392,7 @@ Auto DJ
.. sectionauthor::
S.Brandt <s.brandt@mixxx.org>

.. figure:: ../_static/Mixxx-111-Library-Auto-DJ.png
.. figure:: ../_static/Mixxx-241-Library-Auto-DJ.png
:align: center
:width: 100%
:figwidth: 100%
Expand All @@ -401,19 +401,31 @@ Auto DJ

Mixxx library - Auto DJ view

Auto DJ allows you to automatically load tracks from the Auto DJ playlist when
the current track is nearly finished, and crossfade into it. See
:ref:`library-auto-dj`.
Auto DJ automatically loads tracks in the decks and mixes them.
Tracks can be manually added to the Auto DJ playlist, or automatically from assigned source crates or from the entire library.

Auto DJ does not take into account the volume of each track, nor the frequency content, nor the rhythms, so it's not intended to be a replacement for a human DJ. However, it is good enough to give a human DJ a break without a major disruption to the mix.

For mixing, Auto DJ takes control of the :ref:`crossfader <interface-crossfader>`.
Auto DJ requires at least one deck to be assigned to the left and right side of the crossfader. This can be done with the deck orientation switches next to the crossfader. If a deck's orientation is centered, the crossfader can't affect it. Note that in the official Tango skin, these switches are in the decks' transport controls row, and in Shade skin they don't exist because decks are statically assigned to the left and right side (bus).

When Auto DJ is toggled on, it will use the first two opposing decks it finds. With default settings these would be decks 1 and 2, but depending on how the orientation switches are set, this could be any configuration, for example deck 4 on the left and deck 1 on the right. If no opposing decks are found Auto DJ won't start.

.. note:: Note that Auto DJ is currently not aware which decks are currently visible,
i.e. it might pick currently hidden decks 3 and/or 4. Refer to the
:ref:`skin settings <interface-skin-settings>` for how to toggle 4 decks.

When you toggle Auto DJ off, the crossfader will stay on its last position.

Each official Mixxx skin has an Auto DJ indicator icon, located either in the top toolbar or in the mixer. In some skins the crossfader is highlighted, too.

Loading tracks into Auto DJ
---------------------------

To play tracks automatically, they must first be loaded into the Auto DJ
playlist. The Auto DJ playlist is empty by default.

.. figure:: ../_static/Mixxx-200-Library-Add-to-Auto-DJ.png
.. figure:: ../_static/Mixxx-241-Library-Add-to-Auto-DJ.png
:align: center
:width: 50%
:figwidth: 100%
Expand Down
29 changes: 15 additions & 14 deletions source/chapters/library.rst
Original file line number Diff line number Diff line change
Expand Up @@ -375,8 +375,7 @@ a crate, or even the whole library) for tracks that match your search query.
* Type your search term(s). Mixxx filters the tracks as you type and shows only
those matching the search term(s). Search terms can include an artist's name,
a song title, BPM, etc.
* To clear the search string hit :kbd:`ESC` or click the clear button right next
to the input field.
* To clear the search string click the clear button right next to the input field.
* Hit :kbd:`TAB` to cycle between the search and the list of results in the
library. Use the :kbd:`` and :kbd:`` keys to scroll in the
list of results.
Expand Down Expand Up @@ -699,24 +698,26 @@ mixing or for using Mixxx as media player.

The Auto DJ features in detail:

* **Shuffle button**: Randomizes the order of tracks in the Auto DJ playlist.
* **Add Random button**: Adds a random track from track sources (crates) to the
* **Enable** toggle: Toggles the Auto DJ mode on or off.
* **Fade now** button: Triggers the transition to the next track.
* **Skip track** button: Skips the next track in the Auto DJ playlist.
* **Transition mode** selector: Choose a transition mode.
* **Transition time** spin-box: Determines the duration of the transition. A
negative value will add a pause between tracks.
* **Shuffle** button: Randomizes the order of tracks in the Auto DJ playlist.
* **Add Random track** button: Adds a random track from track sources (crates) to the
Auto DJ queue. If no track sources are configured, the track is added from the
library instead.
* **Skip track button**: Skips the next track in the Auto DJ playlist.
* **Fade now button**: Triggers the transition to the next track.
* **Transition time spin-box**: Determines the duration of the transition. A
negative value will add a pause between tracks.
* **Selection Info label**: Displays the duration and number of selected tracks.
* **Repeat the playlist** toggle: Re-queue played tracks.
* **Selection Info** label: Displays the duration and number of selected tracks.
Press :kbd:`Ctrl` + :kbd:`A` to get the total duration of the AutoDJ queue.
* **Enable Auto DJ button**: Toggles the Auto DJ mode on or off.

The :guilabel:`Skip track`, :guilabel:`Add Random` and :guilabel:`Fade now`
buttons are only accessible if the Auto DJ mode is enabled. The Search field in
the upper left corner is disabled in Auto DJ. By default, Auto DJ removes tracks
after playing them but if you want it to play the same tracks over and over
again, you can activate the :guilabel:`Auto DJ Requeue` option in
:menuselection:`Preferences --> Auto DJ --> Re-queue tracks after playback`.
the upper left corner is disabled in Auto DJ.

By default, Auto DJ removes tracks after playing them but if you want it to play the same
tracks over and over again, you can activate the :guilabel:`Repeat the playlist` toggle.

.. _library-auto-dj-crates:

Expand Down
2 changes: 1 addition & 1 deletion source/chapters/livebroadcasting.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Streaming Servers
server for stability and reliability reasons. Keep in mind that if want to
stream audio to a significant number of listeners, you'll need enough
bandwidth. Read the
`Shoutcast documentation <http://wiki.winamp.com/wiki/SHOUTcast_Getting_Started_Guide>`_
`Shoutcast documentation <https://web.archive.org/web/20240118132730/http://wiki.winamp.com/wiki/SHOUTcast_Getting_Started_Guide>`_
or
`Icecast documentation <http://www.icecast.org/docs/>`_ for server setup
instructions.
Expand Down
5 changes: 5 additions & 0 deletions source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -444,6 +444,8 @@
# Ignore Twitter links because for some reason valid links sometimes fail
# with "400 Bad Request"
r"^https://twitter.com/\w+$",
# Ignore NI links entirely because they trip 403 in general.
r"^https://(?:www.)?native-instruments.com",
# Ignore support links because we get 403 Client Errors (bad User Agent?)
r"^https://support.native-instruments.com/",
r"^https://support.serato.com/",
Expand All @@ -456,6 +458,9 @@
"https://support.pioneerdj.com/hc/sections/*",
"https://www.roland.com/global/products/dj-505/*",
"https://web.archive.org/web/*",
"https://www.allen-heath.com/ahproducts/*",
"https://www.allen-heath.com/content/uploads/*",
"https://www.allen-heath.com/support/",
]

# Avoid freezing during linkcheck
Expand Down
4 changes: 4 additions & 0 deletions source/glossary.rst
Original file line number Diff line number Diff line change
Expand Up @@ -386,6 +386,10 @@ Glossary of Terms
track. DJs usually place hotcues at distinctive positions within a track
such as drops, breaks or kicks and snares. Mixxx supports up to 36 hotcues.

cue marker
A catch-all term used in mixxx to refer to the :term:`cue point`,
:term:`hotcues <hotcue>` and :ref:`intro and outro cues<djing-intro-outro-cues>`.

bar
In musical notation, a bar (or measure) is a segment of time defined by a
given number of beats. Typically, a piece consists of several bars of the
Expand Down
4 changes: 2 additions & 2 deletions source/hardware/controllers/allen_heath_xone_k2_k1.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ Xone K1 is the same as the Xone K2 but without the built in audio
interface and does not come with the EVA travel case that the K2 comes
with.

- `Manufacturer’s product page <http://www.allen-heath.com/ahproducts/xonek2/>`__
- `Manufacturer’s product page <https://www.allen-heath.com/ahproducts/xonek2/>`__
- `Forum thread <https://mixxx.discourse.group/t/allen-heath-xone-k2/12506>`__
- `Manufacturer’s User Guide <https://www.allen-heath.com/content/uploads/2023/06/XoneK2_UG_AP8509_3.pdf>`__
- `Blank template diagrams <http://www.allen-heath.com/media/Xone+K2+Blank+Overlays.zip>`__
- `Blank template diagrams <https://www.allen-heath.com/content/uploads/2023/06/XoneK2BlankOverlays.zip>`__

.. versionadded:: 1.11

Expand Down
2 changes: 1 addition & 1 deletion source/hardware/controllers/hercules_djcontrol_air.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Mapping Description
:alt: Hercules DJControl AIR (schematic view)
:figclass: pretty-figures

Hercules DJControl AIR (schematic view). This picture is taken from the `Getting Started Tutorial <http://ts.hercules.com/download/sound/manuals/DJ_AIR/DJCAir_GettingStartedTutorial_ENG.pdf>`__ (courtesy of Guillemot Corporation S.A.).
Hercules DJControl AIR (schematic view). This picture is taken from the Getting Started Tutorial (courtesy of Guillemot Corporation S.A.).

We assume from the annotated picture above that each decks have same controls.

Expand Down
1 change: 0 additions & 1 deletion source/hardware/controllers/hercules_djcontrol_compact.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ Hercules DJControl Compact
==========================

- `Manufacturer’s product page <https://support.hercules.com/en/product/djcontrolcompact-en/>`__
- `MIDI mapping manual <http://ts.hercules.com/download/sound/manuals/DJC_Compact/DJC_Compact_MIDI_Mapping.pdf>`__

The Hercules DJControl Compact is a simple controller for basic
two-channel mixing. This device does not have a built in sound card, so
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Controls
:alt: Hercules DJControl Instinct (schematic view)
:figclass: pretty-figures

Hercules DJControl Instinct (schematic view). This picture is taken from `product poster <http://ts.hercules.com/download/sound/manuals/DJ_Instinct/Poster/Poster_DJCInstinct_UK.pdf>`__ (courtesy of Guillemot Corporation S.A.).
Hercules DJControl Instinct (schematic view). This picture is taken from the product poster in the device manual (courtesy of Guillemot Corporation S.A.).

1. Jog Wheel for the deck on the side of the wheel
2. Action buttons for the deck on the side of the controls, depending on
Expand Down
2 changes: 2 additions & 0 deletions source/hardware/controllers/korg_kaoss_dj.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ Korg Kaoss DJ controller
- `Forum thread <https://mixxx.discourse.group/t/korg-kaoss-dj-midi-mapping-help/16093>`__
- `Pull request on Github <https://github.com/mixxxdj/mixxx/pull/1509>`__

macOS: Please note that the Korg Kaoss DJ is only supported until `macOS Monterey <https://www.korg.com/download/global/support/os/pdf/mac_compatibilitychart_KORG_en.pdf>`__

.. versionadded:: 2.1

Mapping
Expand Down

0 comments on commit 22f4209

Please sign in to comment.