pulsar

Class Pulsar

java.lang.Object

metro.Metro

pulsar.Pulsar

All Implemented Interfaces:

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

public final class Pulsar
extends Metro
implements ApplicationComponent

Pulsar is a MIDI sequencer program which is controlled by a powerful computer language which is called Scheme. Pulsar is written in JAVA and uses JACK Audio Connection Kit to receive and send MIDI messages; Pulsar runs on any Linux boxes, hopefully OSX and Windows as well.

Pulsar dynamically composes music by writing programs by Scheme. Scheme is a dialect of a computer language which is called "lisp". Pulsar could be used to develop automatic DJ application or automatic backing track generators which composes on the fly.

Workflow

TODO

Document Model

This application has a slightly different concept of open/close files comparative to those general music players. When a user opens a scheme script on Pulsar, Pulsar merely executes it without any clean ups nor initializations. For example, if a user opens an empty scheme script while Pulsar is playing music, nothing will be happened and keeps the former state.

In Pulsar, scripts should implicitly initialize the state of the sequencer if it is necessary because Pulsar does not do it automatically.

Pulsar has two important parameters :

• main-file
• main-invokable

The main-file is a file path to the main file which Pulsar is currently referring. Pulsar keeps checking the timestamp of the file and trying to detect file modification. Whenever Pulsar detects any timestamp update on the file, Pulsar automatically reads it and execute.

The main-invokable is the invokable which initializes the state of the sequencer. This method is the place where Pulsar starts a new song.

If a script file sets main-invokable, this is effectively the application opens a new-file in the sense of general applications. A script file could also leave main-invokable untouched.

This behavior is designed to be useful in some scenarios. For example, when a user repeatedly updates/modifies the script file repeatedly in order to check how it sounds, this behavior might help the user. If Pulse initializes the sequencer whenever it reads a file, the music must restart from the beginning. Users usually prefer it to keep the music playing and modify the music slightly to see what will happen.

This behavior could probably be used as implementing sub-modules.

Pulsar API

Author:

Atsushi Oka

Field Summary

Fields inherited from class metro.Metro

client, inputPortList, jack, mainTrackId, outputPortList, thread

Constructor Summary

Constructors

Constructor and Description
Pulsar(SchemeEngine schemeEngine) Creates an instance of Pulsar object without opening any specific scheme file.

Method Summary

Modifier and Type	Method and Description
void	addCleanupHook(java.lang.Runnable runnable) Add a hook that will be invoked whenever reset() method is called.
void	close()
MetroTrack	createRecordingTrack(java.lang.Object name, java.util.Collection<java.lang.Object> tags, java.util.List<MetroPort> inputPorts, java.util.List<MetroPort> outputPorts, double recordLength, boolean looper)
static java.lang.Runnable	createTimer(java.lang.Runnable threadInitializer, long delay, long interval, Invokable invokable)
MetroTrack	createTrack(java.lang.Object name, java.util.Collection<java.lang.Object> tags, MetroSequence sequence)
MetroTrack	createTrack(java.lang.Object name, java.util.Collection<java.lang.Object> tags, gnu.mapping.Procedure procedure)
void	execCleanupHook()
java.io.File	getConfigDir()
java.io.File	getConfigFile()
static Pulsar	getCurrent()
java.io.File	getHistoryFile() This mechanism is currently not used.
Invokable	getMainProcedure() Returns the main-invokable object.
ApplicationComponent	getParentApplicationComponent()
SchemeEngine	getSchemeEngine()
pulsar.TempoTapper	getTempoTapper()
void	init()
static void	initScheme(kawa.standard.Scheme scheme) Initializes an environment of scheme engine and defines API for the scripts.
static boolean	isPresent()
protected void	onCreateThread()
void	processInit()
void	processQuit()
void	quit() Notify every interface to shutdown the application.
protected java.util.List<MetroPort>	readParamPort(java.lang.Object arg, java.util.List<MetroPort> portList)
protected static java.util.List<java.lang.Object>	readParamPortName(java.lang.Object arg)
static void	registerSchemeInitializers(SchemeEngine schemeEngine)
void	reset() reset() method resets the scheme environment.
void	rewind() rewind() method resets the state of the object and calls main invokable to back to the state of beginning of the project.
void	setBeatsPerMinute(double beatsPerMinute)
void	setMainProcedure(Invokable mainProcedure) Sets the main-invokable object.
void	setParentApplicationComponent(ApplicationComponent parentApplicationComponent)
void	shutdown()

Methods inherited from class metro.Metro

calcOneBarLengthInFrames, clearAllPorts, clearTracks, clientShutdown, connectPort, connectPort, createInputPort, createOutputPort, destroyInputPort, destroyOutputPort, disconnectPort, dumpTracks, enterTrackChangeBlock, getAvailableInputPorts, getAvailableOutputPorts, getBeatsPerBar, getBeatsPerMinute, getInputPorts, getMainTrack, getMetroLock, getOneBarLengthInFrames, getOutputPorts, getPlaying, getThreadInitializer, getThreadInitializerCollection, getTrackByTag, getUpdateSequenceThreshold, inputPortNumberToPort, isOpened, leaveTrackChangeBlock, notifyTrackChange, open, outputPortNumberToPort, postMessage, process, putTrack, putTrack, registerTrack, registerTrack, removeTrack, removeTrack, replicateAllTracks, run, searchInputPort, searchInputPort, searchOutputPort, searchOutputPort, searchTrack, searchTrack, searchTracksByTag, searchTracksByTagSet, setBeatsPerBar, setMainTrackId, setPlaying, setUpdateSequenceThreshold, startClient, togglePlaying, unregisterTrack, unregisterTrack, updatePosition

Methods inherited from class java.lang.Object

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

Methods inherited from interface quartz.lib.app.ApplicationComponent

requestInit, requestQuit

Constructor Detail

Pulsar

public Pulsar(SchemeEngine schemeEngine)

Creates an instance of Pulsar object without opening any specific scheme file. When a user creates an object by this constructor, the sequencer remains closed after the application boots up. The user must explicitly open a file to use the application. (Sun, 24 Nov 2019 12:45:26 +0900) This comment is extremely outdated.

Method Detail

registerSchemeInitializers

public static void registerSchemeInitializers(SchemeEngine schemeEngine)

getParentApplicationComponent

public ApplicationComponent getParentApplicationComponent()

Specified by:

getParentApplicationComponent in interface ApplicationComponent

setParentApplicationComponent

public void setParentApplicationComponent(ApplicationComponent parentApplicationComponent)

Specified by:

setParentApplicationComponent in interface ApplicationComponent

processInit

public void processInit()

Specified by:

processInit in interface ApplicationComponent

processQuit

public void processQuit()

Specified by:

processQuit in interface ApplicationComponent

getCurrent

public static Pulsar getCurrent()

isPresent

public static boolean isPresent()

onCreateThread

protected void onCreateThread()

Overrides:

onCreateThread in class Metro

init

public void init()

quit

public void quit()

Notify every interface to shutdown the application. Then shutdown.

close

public void close()

Overrides:

close in class Metro

shutdown

public void shutdown()

reset

public void reset()

reset() method resets the scheme environment.

getSchemeEngine

public SchemeEngine getSchemeEngine()

setMainProcedure

public void setMainProcedure(Invokable mainProcedure)

Sets the main-invokable object.

See Also:

mainProcedure

getMainProcedure

public Invokable getMainProcedure()

Returns the main-invokable object.

See Also:

mainProcedure

rewind

public void rewind()

rewind() method resets the state of the object and calls main invokable to back to the state of beginning of the project. This method:9 effectively invoke the main invokable. See mainProcedure

addCleanupHook

public void addCleanupHook(java.lang.Runnable runnable)

Add a hook that will be invoked whenever reset() method is called.

execCleanupHook

public void execCleanupHook()

getConfigDir

public java.io.File getConfigDir()

getConfigFile

public java.io.File getConfigFile()

getHistoryFile

public java.io.File getHistoryFile()

This mechanism is currently not used. See #readHistoryFile(JComboBox)

Returns:

createTimer

public static java.lang.Runnable createTimer(java.lang.Runnable threadInitializer,
                                             long delay,
                                             long interval,
                                             Invokable invokable)

getTempoTapper

public pulsar.TempoTapper getTempoTapper()

setBeatsPerMinute

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

Overrides:

setBeatsPerMinute in class Metro

Throws:

org.jaudiolibs.jnajack.JackException

createTrack

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

Overrides:

createTrack in class Metro

createTrack

public MetroTrack createTrack(java.lang.Object name,
                              java.util.Collection<java.lang.Object> tags,
                              gnu.mapping.Procedure procedure)

createRecordingTrack

public MetroTrack createRecordingTrack(java.lang.Object name,
                                       java.util.Collection<java.lang.Object> tags,
                                       java.util.List<MetroPort> inputPorts,
                                       java.util.List<MetroPort> outputPorts,
                                       double recordLength,
                                       boolean looper)

readParamPortName

protected static java.util.List<java.lang.Object> readParamPortName(java.lang.Object arg)

readParamPort

protected java.util.List<MetroPort> readParamPort(java.lang.Object arg,
                                                  java.util.List<MetroPort> portList)

initScheme

public static void initScheme(kawa.standard.Scheme scheme)

Initializes an environment of scheme engine and defines API for the scripts.

Parameters:

scheme - the scheme instance to initialize.