metro

Class Metro

java.lang.Object

metro.Metro

All Implemented Interfaces:

java.lang.Runnable, MetroLock, org.jaudiolibs.jnajack.JackProcessCallback, org.jaudiolibs.jnajack.JackShutdownCallback, org.jaudiolibs.jnajack.JackTimebaseCallback, ThreadInitializerCollectionContainer, ThreadInitializerContainer<Metro>

Direct Known Subclasses:

Pulsar

public class Metro
extends java.lang.Object
implements MetroLock, org.jaudiolibs.jnajack.JackProcessCallback, org.jaudiolibs.jnajack.JackShutdownCallback, org.jaudiolibs.jnajack.JackTimebaseCallback, java.lang.Runnable, ThreadInitializerContainer<Metro>, ThreadInitializerCollectionContainer

Author:

Ats Oka

Field Summary

Fields

Modifier and Type	Field and Description
protected org.jaudiolibs.jnajack.JackClient	client
protected java.util.ArrayList<MetroPort>	inputPortList
protected org.jaudiolibs.jnajack.Jack	jack
static java.lang.Object	mainTrackId
protected java.util.ArrayList<MetroPort>	outputPortList
protected java.lang.Thread	thread

Constructor Summary

Constructors

Constructor and Description
Metro()

Method Summary

Modifier and Type	Method and Description
static int	calcOneBarLengthInFrames(Metro metro, org.jaudiolibs.jnajack.JackClient client, org.jaudiolibs.jnajack.JackPosition position)
void	clearAllPorts()
void	clearTracks()
void	clientShutdown(org.jaudiolibs.jnajack.JackClient client)
void	close()
void	connectPort(java.util.Map<java.lang.String,java.lang.String> map)
void	connectPort(java.lang.String from, java.lang.String to)
MetroPort	createInputPort(java.lang.Object portName)
MetroPort	createOutputPort(java.lang.Object portName)
MetroTrack	createTrack(java.lang.Object name, java.util.Collection<java.lang.Object> tags, MetroSequence sequence)
boolean	destroyInputPort(MetroPort port)
boolean	destroyOutputPort(MetroPort port)
void	disconnectPort(java.lang.String from, java.lang.String to)
void	dumpTracks() For debug-purpose only.
void	enterTrackChangeBlock()
java.util.List<java.lang.String>	getAvailableInputPorts()
java.util.List<java.lang.String>	getAvailableOutputPorts()
long	getBeatsPerBar()
double	getBeatsPerMinute()
static Metro	getCurrent()
java.util.List<MetroPort>	getInputPorts()
MetroTrack	getMainTrack() A field which tracks a reference to the main track by best effort.
java.lang.Object	getMetroLock() The every routines which access to the `tracks` field must synchronize to the object which can be retrieved by this getMetroLock() method.
int	getOneBarLengthInFrames()
java.util.List<MetroPort>	getOutputPorts()
boolean	getPlaying()
ThreadInitializer<Metro>	getThreadInitializer()
ThreadInitializerCollection	getThreadInitializerCollection()
java.util.Collection<MetroTrack>	getTrackByTag(java.lang.String tag)
double	getUpdateSequenceThreshold()
MetroPort	inputPortNumberToPort(int i)
boolean	isOpened()
static boolean	isPresent()
void	leaveTrackChangeBlock()
void	notifyTrackChange() Any caller of the methods registerTrack(MetroTrack) and unregisterTrack(MetroTrack) has responsibility to call notifyTrackChange() method after calling.
protected void	onCreateThread()
void	open(java.lang.String clientName)
MetroPort	outputPortNumberToPort(int i)
void	postMessage(java.lang.Runnable runnable) Post a new message which is denoted by a runnable objects.
boolean	process(org.jaudiolibs.jnajack.JackClient client, int nframes) This method handles JACK's process event.
void	putTrack(java.util.Collection<MetroTrack> trackList, MetroSyncType syncType, MetroTrack syncTrack, double syncOffset)
void	putTrack(MetroTrack track, MetroSyncType syncType, MetroTrack syncTrack, double syncOffset)
void	registerTrack(java.util.Collection<MetroTrack> trackList)
void	registerTrack(MetroTrack track) This registers the specified track.
void	removeTrack(java.util.Collection<MetroTrack> trackList, MetroSyncType syncType, MetroTrack syncTrack, double syncOffset)
void	removeTrack(MetroTrack track, MetroSyncType syncType, MetroTrack syncTrack, double syncOffset)
java.util.List<MetroTrack>	replicateAllTracks()
void	run() Note that this method is called by another thread.
java.util.List<MetroPort>	searchInputPort(Invokable condition)
java.util.List<MetroPort>	searchInputPort(java.lang.Object name)
java.util.List<MetroPort>	searchOutputPort(Invokable condition)
java.util.List<MetroPort>	searchOutputPort(java.lang.Object name)
java.util.List<MetroTrack>	searchTrack(Invokable invokable)
java.util.List<MetroTrack>	searchTrack(java.lang.Object name)
java.util.Collection<MetroTrack>	searchTracksByTag(java.lang.String tag)
java.util.Collection<MetroTrack>	searchTracksByTagSet(java.util.Collection<java.lang.String> tagSet)
void	setBeatsPerBar(long beatsPerBar)
void	setBeatsPerMinute(double beatsPerMinute)
static void	setMainTrackId(java.lang.Object id)
void	setPlaying(boolean playing)
void	setUpdateSequenceThreshold(double value)
static Metro	startClient(java.lang.String clientName, MetroSequence sequence) This is a utility method to create a Metro instance with a single sequence.
boolean	togglePlaying()
void	unregisterTrack(java.util.Collection<MetroTrack> trackList)
void	unregisterTrack(MetroTrack track) This method unregister the specified track.
void	updatePosition(org.jaudiolibs.jnajack.JackClient invokingClient, org.jaudiolibs.jnajack.JackTransportState state, int nframes, org.jaudiolibs.jnajack.JackPosition position, boolean newPosition)

Methods inherited from class java.lang.Object

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

Field Detail

mainTrackId

public static java.lang.Object mainTrackId

jack

protected org.jaudiolibs.jnajack.Jack jack

client

protected org.jaudiolibs.jnajack.JackClient client

thread

protected java.lang.Thread thread

inputPortList

protected final java.util.ArrayList<MetroPort> inputPortList

outputPortList

protected final java.util.ArrayList<MetroPort> outputPortList

Constructor Detail

Metro

public Metro()

Method Detail

setMainTrackId

public static void setMainTrackId(java.lang.Object id)

getMetroLock

public final java.lang.Object getMetroLock()

The every routines which access to the `tracks` field must synchronize to the object which can be retrieved by this getMetroLock() method.

Specified by:

getMetroLock in interface MetroLock

getThreadInitializer

public ThreadInitializer<Metro> getThreadInitializer()

Specified by:

getThreadInitializer in interface ThreadInitializerContainer<Metro>

getCurrent

public static Metro getCurrent()

isPresent

public static boolean isPresent()

getThreadInitializerCollection

public ThreadInitializerCollection getThreadInitializerCollection()

Specified by:

getThreadInitializerCollection in interface ThreadInitializerCollectionContainer

getMainTrack

public MetroTrack getMainTrack()

A field which tracks a reference to the main track by best effort. This field occasionally points to an outdated main track. This field is not used by the internal process; This is intended to be used as a cache of the referencde to the main track in order to avoid searching the main track frequently.

getBeatsPerMinute

public double getBeatsPerMinute()

setBeatsPerMinute

public void setBeatsPerMinute(double beatsPerMinute)
                       throws org.jaudiolibs.jnajack.JackException

Throws:

org.jaudiolibs.jnajack.JackException

getBeatsPerBar

public long getBeatsPerBar()

setBeatsPerBar

public void setBeatsPerBar(long beatsPerBar)
                    throws org.jaudiolibs.jnajack.JackException

Throws:

org.jaudiolibs.jnajack.JackException

setUpdateSequenceThreshold

public void setUpdateSequenceThreshold(double value)

getUpdateSequenceThreshold

public double getUpdateSequenceThreshold()

getPlaying

public boolean getPlaying()

setPlaying

public void setPlaying(boolean playing)

togglePlaying

public boolean togglePlaying()

startClient

public static Metro startClient(java.lang.String clientName,
                                MetroSequence sequence)
                         throws org.jaudiolibs.jnajack.JackException

This is a utility method to create a Metro instance with a single sequence.

Parameters:

clientName -

sequence -

Returns:

Throws:

org.jaudiolibs.jnajack.JackException

createInputPort

public MetroPort createInputPort(java.lang.Object portName)
                          throws org.jaudiolibs.jnajack.JackException

Throws:

org.jaudiolibs.jnajack.JackException

createOutputPort

public MetroPort createOutputPort(java.lang.Object portName)
                           throws org.jaudiolibs.jnajack.JackException

Throws:

org.jaudiolibs.jnajack.JackException

destroyOutputPort

public boolean destroyOutputPort(MetroPort port)
                          throws org.jaudiolibs.jnajack.JackException

Throws:

org.jaudiolibs.jnajack.JackException

destroyInputPort

public boolean destroyInputPort(MetroPort port)
                         throws org.jaudiolibs.jnajack.JackException

Throws:

org.jaudiolibs.jnajack.JackException

getInputPorts

public java.util.List<MetroPort> getInputPorts()

getOutputPorts

public java.util.List<MetroPort> getOutputPorts()

searchInputPort

public java.util.List<MetroPort> searchInputPort(Invokable condition)

searchOutputPort

public java.util.List<MetroPort> searchOutputPort(Invokable condition)

searchInputPort

public java.util.List<MetroPort> searchInputPort(java.lang.Object name)

searchOutputPort

public java.util.List<MetroPort> searchOutputPort(java.lang.Object name)

dumpTracks

public void dumpTracks()

For debug-purpose only.

getTrackByTag

public java.util.Collection<MetroTrack> getTrackByTag(java.lang.String tag)

createTrack

public MetroTrack createTrack(java.lang.Object name,
                              java.util.Collection<java.lang.Object> tags,
                              MetroSequence sequence)

replicateAllTracks

public java.util.List<MetroTrack> replicateAllTracks()

searchTrack

public java.util.List<MetroTrack> searchTrack(Invokable invokable)

searchTrack

public java.util.List<MetroTrack> searchTrack(java.lang.Object name)

searchTracksByTag

public java.util.Collection<MetroTrack> searchTracksByTag(java.lang.String tag)

searchTracksByTagSet

public java.util.Collection<MetroTrack> searchTracksByTagSet(java.util.Collection<java.lang.String> tagSet)

open

public void open(java.lang.String clientName)
          throws org.jaudiolibs.jnajack.JackException

Throws:

org.jaudiolibs.jnajack.JackException

isOpened

public boolean isOpened()

onCreateThread

protected void onCreateThread()

close

public void close()

clearTracks

public void clearTracks()

run

public void run()

Note that this method is called by another thread.

Specified by:

run in interface java.lang.Runnable

getAvailableOutputPorts

public java.util.List<java.lang.String> getAvailableOutputPorts()
                                                         throws org.jaudiolibs.jnajack.JackException

Throws:

org.jaudiolibs.jnajack.JackException

getAvailableInputPorts

public java.util.List<java.lang.String> getAvailableInputPorts()
                                                        throws org.jaudiolibs.jnajack.JackException

Throws:

org.jaudiolibs.jnajack.JackException

connectPort

public void connectPort(java.util.Map<java.lang.String,java.lang.String> map)

connectPort

public void connectPort(java.lang.String from,
                        java.lang.String to)
                 throws org.jaudiolibs.jnajack.JackException

Throws:

org.jaudiolibs.jnajack.JackException

disconnectPort

public void disconnectPort(java.lang.String from,
                           java.lang.String to)
                    throws org.jaudiolibs.jnajack.JackException

Throws:

org.jaudiolibs.jnajack.JackException

clearAllPorts

public void clearAllPorts()
                   throws org.jaudiolibs.jnajack.JackException

Throws:

org.jaudiolibs.jnajack.JackException

process

public boolean process(org.jaudiolibs.jnajack.JackClient client,
                       int nframes)

This method handles JACK's process event. This is possibly called by JACK's thread.

Specified by:

process in interface org.jaudiolibs.jnajack.JackProcessCallback

outputPortNumberToPort

public MetroPort outputPortNumberToPort(int i)

inputPortNumberToPort

public MetroPort inputPortNumberToPort(int i)

notifyTrackChange

public void notifyTrackChange()

Any caller of the methods registerTrack(MetroTrack) and unregisterTrack(MetroTrack) has responsibility to call notifyTrackChange() method after calling. When multiple tracks are registered/unregistered at once, the caller must call notifyTrackChange() at least once a session and not necessarily call every time registering a track.

It is preferable that a user who performs any bulk-registering calls notifyTrackChange() method only once after the registering a set of track and they should avoid to redundantly call notifyTrackChange() multiple times.

Any caller of this method should place the calling inside a synchronized block of an object which you can retrieve by getMetroLock() method; otherwise you will get an unexpected result.

 synchronized (getMetroLock()) {
  MetroTrack track = createTrack(...);
  registerTrack(track);
  notifyCheckBuffer();
 }
 

Parameters:

track -

enterTrackChangeBlock

public void enterTrackChangeBlock()

leaveTrackChangeBlock

public void leaveTrackChangeBlock()

registerTrack

public void registerTrack(MetroTrack track)

This registers the specified track. This method should be called with the same protocol with registerTrack(MetroTrack) method.

Parameters:

track -

See Also:

#registerTrack(MetroTrack)}

registerTrack

public void registerTrack(java.util.Collection<MetroTrack> trackList)

unregisterTrack

public void unregisterTrack(MetroTrack track)

This method unregister the specified track. This method should be called with the same protocol with registerTrack(MetroTrack) method.

Parameters:

track -

See Also:

#registerTrack(MetroTrack)}

unregisterTrack

public void unregisterTrack(java.util.Collection<MetroTrack> trackList)

postMessage

public void postMessage(java.lang.Runnable runnable)

Post a new message which is denoted by a runnable objects. The messages are invoked by the main thread of this Metro instance.

Parameters:

runnable - the procedure to run at a later time.

putTrack

public void putTrack(MetroTrack track,
                     MetroSyncType syncType,
                     MetroTrack syncTrack,
                     double syncOffset)

putTrack

public void putTrack(java.util.Collection<MetroTrack> trackList,
                     MetroSyncType syncType,
                     MetroTrack syncTrack,
                     double syncOffset)

removeTrack

public void removeTrack(MetroTrack track,
                        MetroSyncType syncType,
                        MetroTrack syncTrack,
                        double syncOffset)

removeTrack

public void removeTrack(java.util.Collection<MetroTrack> trackList,
                        MetroSyncType syncType,
                        MetroTrack syncTrack,
                        double syncOffset)

clientShutdown

public void clientShutdown(org.jaudiolibs.jnajack.JackClient client)

Specified by:

clientShutdown in interface org.jaudiolibs.jnajack.JackShutdownCallback

updatePosition

public void updatePosition(org.jaudiolibs.jnajack.JackClient invokingClient,
                           org.jaudiolibs.jnajack.JackTransportState state,
                           int nframes,
                           org.jaudiolibs.jnajack.JackPosition position,
                           boolean newPosition)

Specified by:

updatePosition in interface org.jaudiolibs.jnajack.JackTimebaseCallback

getOneBarLengthInFrames

public int getOneBarLengthInFrames()
                            throws org.jaudiolibs.jnajack.JackException

Throws:

org.jaudiolibs.jnajack.JackException

calcOneBarLengthInFrames

public static int calcOneBarLengthInFrames(Metro metro,
                                           org.jaudiolibs.jnajack.JackClient client,
                                           org.jaudiolibs.jnajack.JackPosition position)
                                    throws org.jaudiolibs.jnajack.JackException

Throws:

org.jaudiolibs.jnajack.JackException