org.deepsymmetry.beatlink

Class CdjStatus

java.lang.Object

org.deepsymmetry.beatlink.DeviceUpdate

org.deepsymmetry.beatlink.CdjStatus

public class CdjStatus
extends DeviceUpdate

Represents a status update sent by a CDJ (or perhaps other player) on a DJ Link network.

Author:

James Elliott

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CdjStatus.PlayState1 The possible values of the first play state found in the packet, labeled P1 in Figure 11 of the Packet Analysis document.
static class	CdjStatus.PlayState2 The possible values of the second play state found in the packet, labeled P2 in Figure 11 of the Packet Analysis document.
static class	CdjStatus.PlayState3 The possible values of the third play state found in the packet, labeled P3 in Figure 11 of the Packet Analysis document.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MASTER_FLAG The bit within the status flag that indicates the player is the tempo master, as illustrated in Figure 12 of the Packet Analysis document.
static int	ON_AIR_FLAG The bit within the status flag that indicates the player is on the air, as illustrated in Figure 12 of the Packet Analysis document.
static int	PLAYING_FLAG The bit within the status flag that indicates the player is playing, as illustrated in Figure 12 of the Packet Analysis document.
static int	STATUS_FLAGS The byte within the packet which contains useful status information, labeled F in Figure 11 of the Packet Analysis document.
static int	SYNCED_FLAG The bit within the status flag that indicates the player is synced, as illustrated in Figure 12 of the Packet Analysis document.

Fields inherited from class org.deepsymmetry.beatlink.DeviceUpdate

address, deviceName, deviceNumber, packetBytes, timestamp

Constructor Summary

Constructors

Constructor and Description
CdjStatus(DatagramPacket packet) Constructor sets all the immutable interpreted fields based on the packet content.

Method Summary

Modifier and Type	Method and Description
String	formatCueCountdown() Format a cue countdown indicator in the same way as the CDJ would at this point in the track.
int	getBeatNumber() Identify the beat of the track that being played.
int	getBeatWithinBar() Get the position within a measure of music at which the most recent beat occurred (a value from 1 to 4, where 1 represents the down beat).
int	getBpm() Get the track BPM at the time of the update.
int	getCueCountdown() How many beats away is the next cue point in the track? If there is no saved cue point after the current play location, or if it is further than 64 bars ahead, the value 511 is returned (and the CDJ will display "--.- bars").
double	getEffectiveTempo() Get the effective tempo reflected by this update, which reflect both its track BPM and pitch as needed.
String	getFirmwareVersion() Return the firmware version string reported in the packet.
long	getPacketNumber() Return the sequence number of this update packet, a value that increments with each packet sent.
int	getPitch() Get the device pitch at the time of the update.
int	getPitch(int number) Get a specific copy of the device pitch information at the time of the update.
CdjStatus.PlayState1	getPlayState1() Get the first play state found in the packet, labeled P1 in Figure 11 of the Packet Analysis document.
CdjStatus.PlayState2	getPlayState2() Get the second play state found in the packet, labeled P2 in Figure 11 of the Packet Analysis document.
CdjStatus.PlayState3	getPlayState3() Get the third play state found in the packet, labeled P3 in Figure 11 of the Packet Analysis document.
int	getSyncNumber() Get the counter identifying how many times the tempo master has changed.
int	getTrackNumber() Get the track number of the loaded track.
boolean	isAtEnd() Is the player currently stopped at the end of a track?
boolean	isBeatWithinBarMeaningful() Returns true if this beat is coming from a device where getBeatWithinBar() can reasonably be expected to have musical significance, because it respects the way a track was configured within rekordbox.
boolean	isBusy() Check if the player is doing anything.
boolean	isCued() Is the player currently cued?
boolean	isLinkedUsbAvailable() Is USB media available somewhere on the network?
boolean	isLocalUsbEmpty() Is USB media absent from this particular CDJ?
boolean	isLocalUsbLoaded() Is USB media loaded in this particular CDJ?
boolean	isLocalUsbUnloading() Is USB media being unloaded from this particular CDJ?
boolean	isLooping() Is the player currently playing a loop?
boolean	isOnAir() Was the CDJ on the air when this update was sent? A player is considered to be on the air when it is connected to a mixer channel that is not faded out.
boolean	isPaused() Is the player currently paused?
boolean	isPlaying() Was the CDJ playing a track when this update was sent?
boolean	isPlayingBackwards() Is the player currently playing backwards?
boolean	isPlayingCdjMode() Is the player currently playing with the jog wheel in CDJ mode?
boolean	isPlayingForwards() Is the player currently playing forwards?
boolean	isPlayingVinylMode() Is the player currently playing with the jog wheel in Vinyl mode?
boolean	isSearching() Is the player currently searching?
boolean	isSynced() Was the CDJ in Sync mode when this update was sent?
boolean	isTempoMaster() Is this CDJ reporting itself to be the current tempo master?
boolean	isTrackLoaded() Is a track loaded?
String	toString()

Methods inherited from class org.deepsymmetry.beatlink.DeviceUpdate

getAddress, getDeviceName, getDeviceNumber, getPacketBytes, getTimestamp

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

STATUS_FLAGS

public static final int STATUS_FLAGS

The byte within the packet which contains useful status information, labeled F in Figure 11 of the Packet Analysis document.

See Also:

Constant Field Values

ON_AIR_FLAG

public static final int ON_AIR_FLAG

The bit within the status flag that indicates the player is on the air, as illustrated in Figure 12 of the Packet Analysis document. A player is considered to be on the air when it is connected to a mixer channel that is not faded out. Only Nexus mixers seem to support this capability.

See Also:

Constant Field Values

SYNCED_FLAG

public static final int SYNCED_FLAG

The bit within the status flag that indicates the player is synced, as illustrated in Figure 12 of the Packet Analysis document.

See Also:

Constant Field Values

MASTER_FLAG

public static final int MASTER_FLAG

The bit within the status flag that indicates the player is the tempo master, as illustrated in Figure 12 of the Packet Analysis document.

See Also:

Constant Field Values

PLAYING_FLAG

public static final int PLAYING_FLAG

The bit within the status flag that indicates the player is playing, as illustrated in Figure 12 of the Packet Analysis document.

See Also:

Constant Field Values

Constructor Detail

CdjStatus

public CdjStatus(DatagramPacket packet)

Constructor sets all the immutable interpreted fields based on the packet content.

Parameters:

packet - the beat announcement packet that was received

Method Detail

getPlayState1

public CdjStatus.PlayState1 getPlayState1()

Get the first play state found in the packet, labeled P₁ in Figure 11 of the Packet Analysis document.

Returns:

the first play state element

getPlayState2

public CdjStatus.PlayState2 getPlayState2()

Get the second play state found in the packet, labeled P₂ in Figure 11 of the Packet Analysis document.

Returns:

the second play state element

getPlayState3

public CdjStatus.PlayState3 getPlayState3()

Get the third play state found in the packet, labeled P₃ in Figure 11 of the Packet Analysis document.

Returns:

the third play state element

getPitch

public int getPitch()

Get the device pitch at the time of the update. This is an integer ranging from 0 to 2097152, which corresponds to a range between completely stopping playback to playing at twice normal tempo. The equivalent percentage value can be obtained by passing the pitch to Util.pitchToPercentage(long), and the corresponding fractional scaling value by passing it to Util.pitchToMultiplier(long).

CDJ update packets actually have four copies of the pitch value which behave slightly differently under different circumstances. This method returns one which seems to provide the most useful information (labeled Pitch₁ in Figure 11 of the Packet Analysis document), reflecting the effective BPM currently being played when it is combined with the track BPM. To probe the other pitch values that were reported, you can use getPitch(int).

Returns:

the raw effective device pitch at the time of the update

getPitch

public int getPitch(int number)

Get a specific copy of the device pitch information at the time of the update. This is an integer ranging from 0 to 2097152, which corresponds to a range between completely stopping playback to playing at twice normal tempo. The equivalent percentage value can be obtained by passing the pitch to Util.pitchToPercentage(long), and the corresponding fractional scaling value by passing it to Util.pitchToMultiplier(long).

CDJ update packets contain four copies of the pitch value which behave slightly differently under different circumstances, labeled Pitch₁ through Pitch₄ in Figure 11 of the Packet Analysis document. This method returns the one you choose by specifying number. If all you want is the current effective pitch, you can use getPitch().

Parameters:

number - the subscript identifying the copy of the pitch information you are interested in

Returns:

the specified raw device pitch information copy found in the update

getBpm

public int getBpm()

Get the track BPM at the time of the update. This is an integer representing the BPM times 100, so a track running at 120.5 BPM would be represented by the value 12050.

When the CDJ has just started up and no track has been loaded, it will report a BPM of 65535.

Returns:

the track BPM to two decimal places multiplied by 100

getBeatWithinBar

public int getBeatWithinBar()

Get the position within a measure of music at which the most recent beat occurred (a value from 1 to 4, where 1 represents the down beat). This value will be accurate when the track was properly configured within rekordbox (and if the music follows a standard House 4/4 time signature).

When the track being played has not been analyzed by rekordbox, or is playing on a non-nexus player, this value will always be zero.

Specified by:

getBeatWithinBar in class DeviceUpdate

Returns:

the beat number within the current measure of music

isBeatWithinBarMeaningful

public boolean isBeatWithinBarMeaningful()

Returns true if this beat is coming from a device where getBeatWithinBar() can reasonably be expected to have musical significance, because it respects the way a track was configured within rekordbox. For CDJs this is true whenever the value is not zero (i.e. this is a nexus player playing a track that was analyzed by rekordbox), because players report their beats according to rekordbox-identified measures.

Specified by:

isBeatWithinBarMeaningful in class DeviceUpdate

Returns:

true whenever we are reporting a non-zero value

isTempoMaster

public boolean isTempoMaster()

Is this CDJ reporting itself to be the current tempo master?

Specified by:

isTempoMaster in class DeviceUpdate

Returns:

true if the player that sent this update is the master

getEffectiveTempo

public double getEffectiveTempo()

Description copied from class: DeviceUpdate

Get the effective tempo reflected by this update, which reflect both its track BPM and pitch as needed.

Specified by:

getEffectiveTempo in class DeviceUpdate

Returns:

the beats per minute this device is reporting

isPlaying

public boolean isPlaying()

Was the CDJ playing a track when this update was sent?

Returns:

true if the play flag was set, or, if this seems to be a non-nexus player, if P₁ has a value corresponding to a playing state.

isSynced

public boolean isSynced()

Was the CDJ in Sync mode when this update was sent?

Returns:

true if the sync flag was set

isOnAir

public boolean isOnAir()

Was the CDJ on the air when this update was sent? A player is considered to be on the air when it is connected to a mixer channel that is not faded out. Only Nexus mixers seem to support this capability.

Returns:

true if the on-air flag was set

isLocalUsbLoaded

public boolean isLocalUsbLoaded()

Is USB media loaded in this particular CDJ?

Returns:

true if there is a USB drive mounted locally

isLocalUsbUnloading

public boolean isLocalUsbUnloading()

Is USB media being unloaded from this particular CDJ?

Returns:

true if there is a local USB drive currently being unmounted

isLocalUsbEmpty

public boolean isLocalUsbEmpty()

Is USB media absent from this particular CDJ?

Returns:

true if there is no local USB drive mounted

isTrackLoaded

public boolean isTrackLoaded()

Is a track loaded?

Returns:

true if a track has been loaded

isLooping

public boolean isLooping()

Is the player currently playing a loop?

Returns:

true if a loop is being played

isPaused

public boolean isPaused()

Is the player currently paused?

Returns:

true if the player is paused, whether or not at the cue point

isCued

public boolean isCued()

Is the player currently cued?

Returns:

true if the player is paused at the cue point

isSearching

public boolean isSearching()

Is the player currently searching?

Returns:

true if the player is searching forwards or backwards

isAtEnd

public boolean isAtEnd()

Is the player currently stopped at the end of a track?

Returns:

true if playback stopped because a track ended

isPlayingForwards

public boolean isPlayingForwards()

Is the player currently playing forwards?

Returns:

true if forward playback is underway

isPlayingBackwards

public boolean isPlayingBackwards()

Is the player currently playing backwards?

Returns:

true if reverse playback is underway

isPlayingVinylMode

public boolean isPlayingVinylMode()

Is the player currently playing with the jog wheel in Vinyl mode?

Returns:

true if forward playback in vinyl mode is underway

isPlayingCdjMode

public boolean isPlayingCdjMode()

Is the player currently playing with the jog wheel in CDJ mode?

Returns:

true if forward playback in CDJ mode is underway

isLinkedUsbAvailable

public boolean isLinkedUsbAvailable()

Is USB media available somewhere on the network?

Returns:

true if some player has USB media that can be linked to

isBusy

public boolean isBusy()

Check if the player is doing anything.

Returns:

true if the player is playing, searching, or loading a track

getTrackNumber

public int getTrackNumber()

Get the track number of the loaded track. Identifies the track within a playlist or other scrolling list of tracks in the CDJ's browse interface.

Returns:

the index of the current track

getSyncNumber

public int getSyncNumber()

Get the counter identifying how many times the tempo master has changed.

Returns:

a number that seems to increment whenever a new player becomes tempo master.

getBeatNumber

public int getBeatNumber()

Identify the beat of the track that being played. This counter starts at beat 1 as the track is played, and increments on each beat. When the player is paused at the start of the track before playback begins, the value reported is 0.

When the track being played has not been analyzed by rekordbox, or is being played on a non-nexus player, this information is not available, and the value -1 is returned.

Returns:

the number of the beat within the track that is currently being played, or -1 if unknown

getCueCountdown

public int getCueCountdown()

How many beats away is the next cue point in the track? If there is no saved cue point after the current play location, or if it is further than 64 bars ahead, the value 511 is returned (and the CDJ will display "--.- bars"). As soon as there are just 64 bars (256 beats) to go before the next cue point, this value becomes 256. This is the point at which the CDJ starts to display a countdown, which it displays as "63.4 Bars". As each beat goes by, this value decrements by 1, until the cue point is about to be reached, at which point the value is 1 and the CDJ displays "00.1 Bars". On the beat on which the cue point was saved the value is 0 and the CDJ displays "00.0 Bars". On the next beat, the value becomes determined by the next cue point (if any) in the track.

Returns:

the cue beat countdown, or 511 if no countdown is in effect

See Also:

formatCueCountdown()

formatCueCountdown

public String formatCueCountdown()

Format a cue countdown indicator in the same way as the CDJ would at this point in the track.

Returns:

the value that the CDJ would display to indicate the distance to the next cue

See Also:

getCueCountdown()

getFirmwareVersion

public String getFirmwareVersion()

Return the firmware version string reported in the packet.

Returns:

the version of the firmware in the player

getPacketNumber

public long getPacketNumber()

Return the sequence number of this update packet, a value that increments with each packet sent.

Returns:

the number of this packet

toString

public String toString()

Overrides:

toString in class Object