Manager for User Preferences File (singleton) More...

#include <Preferences.h>

Inheritance diagram for Preferences:

Public Types
enum	{ USE_JACK_TRANSPORT = 0 , USE_JACK_TIMEBASE_CONTROL = 0 , SET_PLAY_ON = 0 , BC_ON = 0 , NO_JACK_TRANSPORT = 1 , NO_JACK_TIMEBASE_CONTROL = 1 , SET_PLAY_OFF = 1 , BC_OFF = 1 }

enum class	AudioDriver { None , Null , Fake , Disk , Auto , Jack , Oss , Alsa , PulseAudio , CoreAudio , PortAudio }

enum	Changes { None = 0x000 , Font = 0x001 , Colors = 0x002 , AppearanceTab = 0x004 , GeneralTab = 0x008 , AudioTab = 0x010 , MidiTab = 0x020 , OscTab = 0x040 }
	Bitwise or-able options showing which part of the Preferences were altered using the PreferencesDialog. More...

enum class	JackTrackOutputMode { postFader = 0 , preFader = 1 }
	Specifies which audio settings will be applied to the sample supplied in the JACK per track output ports. More...

Public Member Functions
	~Preferences ()

const QString &	getApplicationFontFamily () const

WindowProperties	getAudioEngineInfoProperties ()

InterfaceTheme::ColoringMethod	getColoringMethod () const

const std::shared_ptr< ColorTheme >	getColorTheme () const

const QString &	getDataDirectory ()

const QString &	getDefaultEditor ()

InterfaceTheme::Layout	getDefaultUILayout ()

WindowProperties	getDirectorProperties ()

float	getExportCompressionLevel () const

Filesystem::AudioFormat	getExportFormat () const

int	getExportModeIdx () const

int	getExportSampleDepthIdx () const

int	getExportSampleRateIdx () const

FontTheme::FontSize	getFontSize () const

QString	getH2ProcessName ()

bool	getHearNewNotes ()

InterfaceTheme::IconColor	getIconColor ()

WindowProperties	getInstrumentRackProperties ()

WindowProperties	getLadspaProperties (unsigned nFX)

QString	getLastAddSongToPlaylistDirectory () const

QString	getLastExportDrumkitDirectory () const

QString	getLastExportLilypondDirectory () const

QString	getLastExportMidiDirectory () const

QString	getLastExportPatternAsDirectory () const

QString	getLastExportSongDirectory () const

QString	getLastExportThemeDirectory () const

QString	getLastImportDrumkitDirectory () const

QString	getLastImportThemeDirectory () const

QString	getLastOpenLayerDirectory () const

QString	getLastOpenPatternDirectory () const

QString	getLastOpenPlaybackTrackDirectory () const

QString	getLastOpenSongDirectory () const

int	getLastOpenTab ()

QString	getLastPlaylistDirectory () const

const QString &	getLastPlaylistFilename ()

QString	getLastPlaylistScriptDirectory () const

QString	getLastSaveSongAsDirectory () const

const QString &	getLastSongFilename ()

const QString &	getLevel2FontFamily () const

const QString &	getLevel3FontFamily () const

bool	getLoadingSuccessful () const

WindowProperties	getMainFormProperties ()

int	getMaxBars () const

int	getMaxLayers () const

int	getMaxPatternColors () const

int	getMidiExportMode () const

float	getMixerFalloffSpeed ()

WindowProperties	getMixerProperties ()

QString	getNsmClientId (void)

QString	getNsmSongName (void)

bool	getOscFeedbackEnabled ()

bool	getOscServerEnabled ()

int	getOscServerPort ()

std::vector< QColor >	getPatternColors () const

unsigned	getPatternEditorGridHeight ()

int	getPatternEditorGridResolution ()

unsigned	getPatternEditorGridWidth ()

WindowProperties	getPatternEditorProperties ()

WindowProperties	getPlaylistDialogProperties ()

QString	getPreferencesOverwritePath ()
	Returns m_sPreferencesOverwritePath.

const QString &	getPreferredLanguage ()

int	getPunchInPos ()

int	getPunchOutPos ()

const QString &	getQTStyle ()

bool	getQuantizeEvents ()

std::vector< QString >	getRecentFiles () const

QStringList	getRecentFX ()

bool	getRecordEvents ()

int	getRubberBandBatchMode ()

bool	getShowAutomationArea ()

bool	getShowDevelWarning ()

bool	getShowNoteOverwriteWarning ()

bool	getShowPlaybackTrack () const

unsigned	getSongEditorGridHeight ()

unsigned	getSongEditorGridWidth ()

WindowProperties	getSongEditorProperties ()

const std::shared_ptr< Theme >	getTheme () const

InterfaceTheme::ScalingPolicy	getUIScalingPolicy ()

bool	getUseTimelineBpm ()
	Whether to use the bpm of the timeline.

int	getVisiblePatternColors () const

bool	getWaitForSessionHandler ()

bool	hideKeyboardCursor ()

bool	inPunchArea (int pos)

bool	isFXTabVisible ()

bool	isPatternEditorUsingTriplets ()

bool	isPlaylistUsingRelativeFilenames ()

bool	isRestoreLastPlaylistEnabled ()

bool	isRestoreLastSongEnabled ()

bool	loadPreferences (bool bGlobal)
	Load the preferences file.

bool	savePreferences ()
	Save the preferences file.

void	setApplicationFontFamily (const QString &family)

void	setAudioEngineInfoProperties (const WindowProperties &prop)

void	setColoringMethod (InterfaceTheme::ColoringMethod coloringMethod)

void	setColorTheme (const std::shared_ptr< ColorTheme > pNewColorTheme)

void	setDefaultEditor (QString editor)

void	setDefaultUILayout (InterfaceTheme::Layout layout)

void	setDirectorProperties (const WindowProperties &prop)

void	setExportCompressionLevel (float fCompressionLevel)

void	setExportFormat (Filesystem::AudioFormat format)

void	setExportModeIdx (int nExportMode)

void	setExportSampleDepthIdx (int nExportSampleDepthIdx)

void	setExportSampleRateIdx (int nExportSampleRateIdx)

void	setFontSize (FontTheme::FontSize fontSize)

void	setFXTabVisible (bool value)

void	setH2ProcessName (const QString &processName)

void	setHearNewNotes (bool value)

void	setHideKeyboardCursor (bool b)

void	setIconColor (InterfaceTheme::IconColor iconColor)

void	setInstrumentPeaks (bool value)

void	setInstrumentRackProperties (const WindowProperties &prop)

void	setLadspaProperties (unsigned nFX, const WindowProperties &prop)

void	setLastAddSongToPlaylistDirectory (QString sPath)

void	setLastExportDrumkitDirectory (QString sPath)

void	setLastExportLilypondDirectory (QString sPath)

void	setLastExportMidiDirectory (QString sPath)

void	setLastExportPatternAsDirectory (QString sPath)

void	setLastExportSongDirectory (QString sPath)

void	setLastExportThemeDirectory (QString sPath)

void	setLastImportDrumkitDirectory (QString sPath)

void	setLastImportThemeDirectory (QString sPath)

void	setLastOpenLayerDirectory (QString sPath)

void	setLastOpenPatternDirectory (QString sPath)

void	setLastOpenPlaybackTrackDirectory (QString sPath)

void	setLastOpenSongDirectory (QString sPath)

void	setLastOpenTab (int n)

void	setLastPlaylistDirectory (QString sPath)

void	setLastPlaylistFilename (const QString &filename)

void	setLastPlaylistScriptDirectory (QString sPath)

void	setLastSaveSongAsDirectory (QString sPath)

void	setLastSongFilename (const QString &filename)

void	setLevel2FontFamily (const QString &family)

void	setLevel3FontFamily (const QString &family)

void	setMainFormProperties (const WindowProperties &prop)

void	setMaxBars (const int bars)

void	setMaxLayers (const int layers)

void	setMaxPatternColors (int nValue)

void	setMidiExportMode (int nExportMode)

void	setMixerFalloffSpeed (float value)

void	setMixerProperties (const WindowProperties &prop)

void	setMostRecentFX (QString)

void	setNsmClientId (const QString &nsmClientId)

void	setNsmSongName (const QString &nsmSongName)

void	setOscFeedbackEnabled (bool val)

void	setOscServerEnabled (bool val)

void	setOscServerPort (int oscPort)

void	setPatternColors (std::vector< QColor > patternColors)

void	setPatternEditorGridHeight (unsigned value)

void	setPatternEditorGridResolution (int value)

void	setPatternEditorGridWidth (unsigned value)

void	setPatternEditorProperties (const WindowProperties &prop)

void	setPatternEditorUsingTriplets (bool value)

void	setPlaylistDialogProperties (const WindowProperties &prop)

void	setPreferencesOverwritePath (const QString &newPath)
	Setting m_sPreferencesOverwritePath.

void	setPreferredLanguage (const QString &sLanguage)

void	setPunchInPos (unsigned pos)

void	setPunchOutPos (unsigned pos)

void	setQTStyle (const QString &sStyle)

void	setQuantizeEvents (bool value)

void	setRecentFiles (const std::vector< QString > recentFiles)

void	setRecordEvents (bool value)

void	setRestoreLastPlaylistEnabled (bool restore)

void	setRestoreLastSongEnabled (bool restore)

void	setRubberBandBatchMode (int val)

void	setShowAutomationArea (bool value)

void	setShowDevelWarning (bool value)

void	setShowNoteOverwriteWarning (bool bValue)

void	setShowPlaybackTrack (bool val)

void	setSongEditorGridHeight (unsigned value)

void	setSongEditorGridWidth (unsigned value)

void	setSongEditorProperties (const WindowProperties &prop)

void	setTheme (const std::shared_ptr< Theme > pTheme)

void	setUIScalingPolicy (InterfaceTheme::ScalingPolicy policy)

void	setUseLash (bool b)

void	setUseRelativeFilenamesForPlaylists (bool value)

void	setUseTimelineBpm (bool val)
	Setting __useTimelineBpm.

void	setVisiblePatternColors (int nValue)

void	setWaitForSessionHandler (bool value)

bool	showInstrumentPeaks ()

void	unsetPunchArea ()

bool	useLash ()

Public Member Functions inherited from Object< Preferences >
	Object ()

	Object (const Object< Preferences > &other)

Public Member Functions inherited from Base
	Base ()

	Base (const Base &other)

virtual const char *	class_name () const

void	logBacktrace () const
	Print the current stack at point into the debug log.

void	Print (bool bShort=true) const
	Prints content of toQString() via DEBUGLOG.

virtual QString	toQString (const QString &sPrefix="", bool bShort=true) const
	Formatted string version for debugging purposes.

Static Public Member Functions
static QString	audioDriverToQString (const AudioDriver &driver)

static bool	checkJackSupport ()
	Attempts to call several JACK executables in order to check for existing JACK support.

static void	create_instance ()
	If __instance equals 0, a new Preferences singleton will be created and stored in it.

static Preferences *	get_instance ()
	Returns a pointer to the current Preferences singleton stored in __instance.

static QString	getNullMidiPort ()
	Choice of m_sMidiPortName and m_sMidiOutputPortName in case no port/device was selected.

static std::vector< AudioDriver >	getSupportedAudioDrivers ()

static AudioDriver	parseAudioDriver (const QString &sDriver)

Static Public Member Functions inherited from Base
static const char *	_class_name ()
	return the class name

static QString	base_clock (const QString &sMsg)
	Measures the current time and stores it in __last_clock.

static QString	base_clock_in (const QString &sMsg)

static int	bootstrap (Logger *logger, bool count=false)
	must be called before any Object instantiation !

static bool	count_active ()

static int	getAliveObjectCount ()

static object_map_t	getObjectMap ()

static Logger *	logger ()
	return the logger instance

static int	objects_count ()

static void	printObjectMapDiff (object_map_t map)
	Creates the difference between a snapshot of the object map and its current state and prints it to std::cout.

static void	set_count (bool flag)
	enable/disable class instances counting

static void	write_objects_map_to (std::ostream &out, object_map_t *map=nullptr)
	output the full objects map to a given ostream

static void	write_objects_map_to_cerr ()
	output objects map to stderr

Data Fields
bool	__expandPatternItem

bool	__expandSongItem

bool	__playsamplesonclicking

bool	__playselectedinstrument

AudioDriver	m_audioDriver
	Audio driver.

bool	m_bbc

bool	m_bEnableMidiFeedback

bool	m_bFollowPlayhead

bool	m_bJackConnectDefaults
	Toggles auto-connecting of the main stereo output ports to the system's default ports when starting the JACK server.

bool	m_bJackTimebaseEnabled
	External applications with a faulty JACK Timebase implementation can mess up the transport within Hydrogen.

int	m_bJackTimebaseMode
	Specifies if Hydrogen support the of JACK Timebase protocol.

bool	m_bJackTrackOuts
	If set to true, JackAudioDriver::makeTrackOutputs() will create two individual left and right output ports for every component of each instrument.

int	m_bJackTransportMode
	Specifies whether or not Hydrogen will use the JACK transport system.

bool	m_bMidiDiscardNoteAfterAction

bool	m_bMidiFixedMapping

bool	m_bMidiNoteOffIgnore

bool	m_bOscFeedbackEnabled
	Whether to send the current state of Hydrogen to the OSC clients.

bool	m_bOscServerEnabled
	Whether to start the OscServer thread.

bool	m_brestartLash

bool	m_bsetLash

bool	m_bShowExportDrumkitAttributionWarning

bool	m_bShowExportDrumkitCopyleftWarning

bool	m_bShowExportDrumkitLicenseWarning

bool	m_bShowExportSongLicenseWarning

bool	m_bUseMetronome
	If set to true, samples of the metronome will be added to H2Core::AudioEngine::m_songNoteQueue and thus played back on a regular basis.

int	m_countOffset

float	m_fMetronomeVolume
	Metronome volume FIXME: remove this volume!!

JackTrackOutputMode	m_JackTrackOutputMode
	Specifies which audio settings will be applied to the sample supplied in the JACK per track output ports.

bool	m_mmcsetplay

int	m_nAutosavesPerHour

unsigned	m_nBufferSize
	Buffer size of the audio.

int	m_nLatencyTarget

unsigned	m_nMaxNotes
	max notes

int	m_nMidiChannelFilter

int	m_nOscServerPort
	Port number the OscServer will be started at.

int	m_nOscTemporaryPort
	In case m_nOscServerPort is already occupied by another client, the alternative - random - port number provided by the OSC server will be stored in this variable.

unsigned	m_nSampleRate
	Sample rate of the audio.

std::list< QString >	m_patternCategories

QString	m_rubberBandCLIexecutable
	Rubberband CLI.

QString	m_sAlsaAudioDevice

QString	m_sCoreAudioDevice

QString	m_sDefaultEditor
	Default text editor (used by Playlisteditor)

QString	m_sJackPortName1

QString	m_sJackPortName2

QString	m_sMidiDriver
	MIDI driver.

QString	m_sMidiOutputPortName

QString	m_sMidiPortName

QString	m_sOSSDevice
	Device used for output.

QString	m_sPortAudioDevice

QString	m_sPortAudioHostAPI

int	m_startOffset

std::list< QString >	sServerList

Private Member Functions
	Preferences ()

WindowProperties	readWindowProperties (XMLNode parent, const QString &windowName, WindowProperties defaultProp)
	Read the xml nodes related to window properties.

void	writeWindowProperties (XMLNode parent, const QString &windowName, const WindowProperties &prop)
	Write the xml nodes related to window properties.

Private Attributes
bool	__useTimelineBpm
	Whether to use local speeds specified along the Timeline or a constant tempo for the whole Song in Hydrogen::getTimelineBpm() and Hydrogen::getTimelineBpm().

WindowProperties	audioEngineInfoProperties

bool	hearNewNotes

WindowProperties	instrumentRackProperties

bool	m_bHideKeyboardCursor

bool	m_bIsFXTabVisible

bool	m_bLoadingSuccessful

bool	m_bPatternEditorUsingTriplets

bool	m_brestoreLastPlaylist

bool	m_brestoreLastSong

bool	m_bShowAutomationArea

bool	m_bShowDevelWarning

bool	m_bShowInstrumentPeaks

bool	m_bShowNoteOverwriteWarning
	Last song used.

bool	m_bShowPlaybackTrack

bool	m_bUseLash
	Show development version warning?

bool	m_bUseRelativeFilenamesForPlaylists

WindowProperties	m_directorProperties

Filesystem::AudioFormat	m_exportFormat

float	m_fExportCompressionLevel

WindowProperties	m_ladspaProperties [MAX_FX]

QString	m_lastPlaylistFilename

QString	m_lastSongFilename

int	m_nExportModeIdx

int	m_nExportSampleDepthIdx

int	m_nExportSampleRateIdx

int	m_nLastOpenTab

int	m_nMaxBars
	Maximum number of bars shown in the Song Editor at once.

int	m_nMaxLayers
	Maximum number of layers to be used in the Instrument editor.

int	m_nMidiExportMode

unsigned	m_nPatternEditorGridHeight

int	m_nPatternEditorGridResolution

unsigned	m_nPatternEditorGridWidth

unsigned	m_nSongEditorGridHeight

unsigned	m_nSongEditorGridWidth

WindowProperties	m_playlistDialogProperties

std::shared_ptr< Theme >	m_pTheme

std::vector< QString >	m_recentFiles

QStringList	m_recentFX

QString	m_sH2ProcessName

QString	m_sLastAddSongToPlaylistDirectory

QString	m_sLastExportDrumkitDirectory

QString	m_sLastExportLilypondDirectory

QString	m_sLastExportMidiDirectory

QString	m_sLastExportPatternAsDirectory

QString	m_sLastExportSongDirectory

QString	m_sLastExportThemeDirectory

QString	m_sLastImportDrumkitDirectory

QString	m_sLastImportThemeDirectory

QString	m_sLastOpenLayerDirectory

QString	m_sLastOpenPatternDirectory

QString	m_sLastOpenPlaybackTrackDirectory

QString	m_sLastOpenSongDirectory

QString	m_sLastPlaylistDirectory

QString	m_sLastPlaylistScriptDirectory

QString	m_sLastSaveSongAsDirectory

QString	m_sNsmClientId

QString	m_sNsmSongName

QString	m_sPreferencesOverwritePath
	Full path to local preferences file.

QString	m_sPreferredLanguage

bool	m_useTheRubberbandBpmChangeEvent
	rubberband bpm change queue

WindowProperties	mainFormProperties

WindowProperties	mixerProperties

WindowProperties	patternEditorProperties

int	punchInPos

int	punchOutPos

bool	quantizeEvents

bool	readPrefFileforotherplaces

bool	recordEvents

WindowProperties	songEditorProperties

bool	waitingForSessionHandler

Static Private Attributes
static Preferences *	__instance = nullptr
	Object holding the current Preferences singleton.

Additional Inherited Members
Static Public Attributes inherited from Base
static QString	sPrintIndention = " "
	String used to format the debugging string output of some core classes.

Protected Member Functions inherited from Object< Preferences >
	~Object ()

Protected Member Functions inherited from Base
	~Base ()

Static Protected Member Functions inherited from Base
static void	registerClass (const char name, const atomic_obj_cpt_t counters)

Static Protected Attributes inherited from Base
static bool	__count = false
	should we count class instances

static timeval	__last_clock = { 0, 0 }

static Logger *	__logger = nullptr

static bool	bLogColors = true

Detailed Description

Manager for User Preferences File (singleton)

Definition at line 78 of file Preferences.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
USE_JACK_TRANSPORT	Specifies whether or not to use JACK transport capabilities. If set, Hydrogen will start playing as soon as any over JACK client using its transport system is starting to play. Its counterpart is NO_JACK_TRANSPORT.
USE_JACK_TIMEBASE_CONTROL	Specifies that Hydrogen should attempt to acquire JACK Timebase control. This represent the state desired by the user. The actual one is stored in H2Core::JackAudioDriver::m_timebaseState. Its counterpart is NO_JACK_TIMEBASE_CONTROL.
SET_PLAY_ON
BC_ON
NO_JACK_TRANSPORT	Specifies whether or not to use JACK transport capabilities. If set, Hydrogen can be used independent of the JACK system while still using the JackAudioDriver. Its counterpart is USE_JACK_TRANSPORT.
NO_JACK_TIMEBASE_CONTROL	Specifies that Hydrogen should not be in control of JACK Timebase information. This could mean both that there is an external application controlling position and tempo of Hydrogen and that there are just equal JACK clients. This represent the state desired by the user. The actual one is stored in H2Core::JackAudioDriver::m_timebaseState. Its counterpart is USE_JACK_TIMEBASE_CONTROL.
SET_PLAY_OFF
BC_OFF

Definition at line 82 of file Preferences.h.

◆ AudioDriver

enum class AudioDriver

strong

Enumerator
None
Null
Fake
Disk
Auto
Jack
Oss
Alsa
PulseAudio
CoreAudio
PortAudio

Definition at line 174 of file Preferences.h.

◆ Changes

enum Changes

Bitwise or-able options showing which part of the Preferences were altered using the PreferencesDialog.

Enumerator
None
Font	Either the font size or font family have changed.
Colors	At least one of the colors has changed.
AppearanceTab	Any option in the Appearance tab excluding colors, font size, or font family. Those have to be indicated by or-ing the didicated option.
GeneralTab	Any option in the General tab appeared.
AudioTab	Any option in the Audio tab appeared.
MidiTab	Any option in the MIDI tab appeared.
OscTab	Any option in the OSC tab appeared.

Definition at line 128 of file Preferences.h.

◆ JackTrackOutputMode

enum class JackTrackOutputMode

strong

Specifies which audio settings will be applied to the sample supplied in the JACK per track output ports.

Enumerator
postFader	Applies layer, component, and instrument gain, note and instrument pan, note velocity, and main component and instrument volume to the samples.
preFader	Only layer gain and note velocity will be applied to the samples.

Definition at line 359 of file Preferences.h.

Constructor & Destructor Documentation

◆ ~Preferences()

~Preferences ( )

Definition at line 285 of file Preferences.cpp.

◆ Preferences()

Preferences ( )

private

Definition at line 62 of file Preferences.cpp.

Member Function Documentation

◆ audioDriverToQString()

QString audioDriverToQString ( const AudioDriver & driver )

static

Definition at line 1252 of file Preferences.cpp.

◆ checkJackSupport()

bool checkJackSupport ( )

static

Attempts to call several JACK executables in order to check for existing JACK support.

In an earlier version I tried checking the presence of the libjack.so shared library. But this one comes preinstalled with most Linux distribution regardless of JACK itself is present or not.

Returns: Whether or not JACK support appears to be functional.

Definition at line 1281 of file Preferences.cpp.

◆ create_instance()

void create_instance ( )

static

If __instance equals 0, a new Preferences singleton will be created and stored in it.

It is called in Hydrogen::create_instance().

Definition at line 55 of file Preferences.cpp.

◆ get_instance()

static Preferences * get_instance ( )

inlinestatic

Returns a pointer to the current Preferences singleton stored in __instance.

Definition at line 406 of file Preferences.h.

◆ getApplicationFontFamily()

const QString & getApplicationFontFamily ( ) const

inline

Definition at line 1185 of file Preferences.h.

◆ getAudioEngineInfoProperties()

WindowProperties getAudioEngineInfoProperties ( )

inline

Definition at line 1344 of file Preferences.h.

◆ getColoringMethod()

InterfaceTheme::ColoringMethod getColoringMethod ( ) const

inline

Definition at line 1304 of file Preferences.h.

◆ getColorTheme()

const std::shared_ptr< ColorTheme > getColorTheme ( ) const

inline

Definition at line 1372 of file Preferences.h.

◆ getDataDirectory()

const QString & getDataDirectory ( )

◆ getDefaultEditor()

const QString & getDefaultEditor ( )

inline

Definition at line 1013 of file Preferences.h.

◆ getDefaultUILayout()

InterfaceTheme::Layout getDefaultUILayout ( )

inline

Definition at line 1021 of file Preferences.h.

◆ getDirectorProperties()

WindowProperties getDirectorProperties ( )

inline

Definition at line 1365 of file Preferences.h.

◆ getExportCompressionLevel()

float getExportCompressionLevel ( ) const

inline

Definition at line 1003 of file Preferences.h.

◆ getExportFormat()

Filesystem::AudioFormat getExportFormat ( ) const

inline

Definition at line 993 of file Preferences.h.

◆ getExportModeIdx()

int getExportModeIdx ( ) const

inline

Definition at line 978 of file Preferences.h.

◆ getExportSampleDepthIdx()

int getExportSampleDepthIdx ( ) const

inline

Definition at line 963 of file Preferences.h.

◆ getExportSampleRateIdx()

int getExportSampleRateIdx ( ) const

inline

Definition at line 973 of file Preferences.h.

◆ getFontSize()

FontTheme::FontSize getFontSize ( ) const

inline

Definition at line 1206 of file Preferences.h.

◆ getH2ProcessName()

QString getH2ProcessName ( )

inline

Definition at line 1482 of file Preferences.h.

◆ getHearNewNotes()

bool getHearNewNotes ( )

inline

Definition at line 1119 of file Preferences.h.

◆ getIconColor()

InterfaceTheme::IconColor getIconColor ( )

inline

Definition at line 1037 of file Preferences.h.

◆ getInstrumentRackProperties()

WindowProperties getInstrumentRackProperties ( )

inline

Definition at line 1337 of file Preferences.h.

◆ getLadspaProperties()

WindowProperties getLadspaProperties ( unsigned nFX )

inline

Definition at line 1351 of file Preferences.h.

◆ getLastAddSongToPlaylistDirectory()

QString getLastAddSongToPlaylistDirectory ( ) const

inline

Definition at line 873 of file Preferences.h.

◆ getLastExportDrumkitDirectory()

QString getLastExportDrumkitDirectory ( ) const

inline

Definition at line 864 of file Preferences.h.

◆ getLastExportLilypondDirectory()

QString getLastExportLilypondDirectory ( ) const

inline

Definition at line 855 of file Preferences.h.

◆ getLastExportMidiDirectory()

QString getLastExportMidiDirectory ( ) const

inline

Definition at line 858 of file Preferences.h.

◆ getLastExportPatternAsDirectory()

QString getLastExportPatternAsDirectory ( ) const

inline

Definition at line 840 of file Preferences.h.

◆ getLastExportSongDirectory()

QString getLastExportSongDirectory ( ) const

inline

Definition at line 843 of file Preferences.h.

◆ getLastExportThemeDirectory()

QString getLastExportThemeDirectory ( ) const

inline

Definition at line 885 of file Preferences.h.

◆ getLastImportDrumkitDirectory()

QString getLastImportDrumkitDirectory ( ) const

inline

Definition at line 861 of file Preferences.h.

◆ getLastImportThemeDirectory()

QString getLastImportThemeDirectory ( ) const

inline

Definition at line 882 of file Preferences.h.

◆ getLastOpenLayerDirectory()

QString getLastOpenLayerDirectory ( ) const

inline

Definition at line 867 of file Preferences.h.

◆ getLastOpenPatternDirectory()

QString getLastOpenPatternDirectory ( ) const

inline

Definition at line 852 of file Preferences.h.

◆ getLastOpenPlaybackTrackDirectory()

QString getLastOpenPlaybackTrackDirectory ( ) const

inline

Definition at line 870 of file Preferences.h.

◆ getLastOpenSongDirectory()

QString getLastOpenSongDirectory ( ) const

inline

Definition at line 849 of file Preferences.h.

◆ getLastOpenTab()

int getLastOpenTab ( )

inline

Definition at line 1471 of file Preferences.h.

◆ getLastPlaylistDirectory()

QString getLastPlaylistDirectory ( ) const

inline

Definition at line 876 of file Preferences.h.

◆ getLastPlaylistFilename()

const QString & getLastPlaylistFilename ( )

inline

Definition at line 1112 of file Preferences.h.

◆ getLastPlaylistScriptDirectory()

QString getLastPlaylistScriptDirectory ( ) const

inline

Definition at line 879 of file Preferences.h.

◆ getLastSaveSongAsDirectory()

QString getLastSaveSongAsDirectory ( ) const

inline

Definition at line 846 of file Preferences.h.

◆ getLastSongFilename()

const QString & getLastSongFilename ( )

inline

Definition at line 1105 of file Preferences.h.

◆ getLevel2FontFamily()

const QString & getLevel2FontFamily ( ) const

inline

Definition at line 1192 of file Preferences.h.

◆ getLevel3FontFamily()

const QString & getLevel3FontFamily ( ) const

inline

Definition at line 1199 of file Preferences.h.

◆ getLoadingSuccessful()

bool getLoadingSuccessful ( ) const

inline

Definition at line 1491 of file Preferences.h.

◆ getMainFormProperties()

WindowProperties getMainFormProperties ( )

inline

Definition at line 1308 of file Preferences.h.

◆ getMaxBars()

int getMaxBars ( ) const

inline

Returns: m_nMaxBars.

Definition at line 1390 of file Preferences.h.

◆ getMaxLayers()

int getMaxLayers ( ) const

inline

Returns: m_nMaxLayers.

Definition at line 1398 of file Preferences.h.

◆ getMaxPatternColors()

int getMaxPatternColors ( ) const

inline

Definition at line 1296 of file Preferences.h.

◆ getMidiExportMode()

int getMidiExportMode ( ) const

inline

Definition at line 953 of file Preferences.h.

◆ getMixerFalloffSpeed()

float getMixerFalloffSpeed ( )

inline

Definition at line 1213 of file Preferences.h.

◆ getMixerProperties()

WindowProperties getMixerProperties ( )

inline

Definition at line 1315 of file Preferences.h.

◆ getNsmClientId()

QString getNsmClientId ( void )

inline

Definition at line 1415 of file Preferences.h.

◆ getNsmSongName()

QString getNsmSongName ( void )

inline

Definition at line 1423 of file Preferences.h.

◆ getNullMidiPort()

static QString getNullMidiPort ( )

inlinestatic

Choice of m_sMidiPortName and m_sMidiOutputPortName in case no port/device was selected.

Pinning its value to "None" will prevent Hydrogen to connect to ports/devices using this exact name but is still done for backward compatibility.

Definition at line 272 of file Preferences.h.

◆ getOscFeedbackEnabled()

bool getOscFeedbackEnabled ( )

inline

Returns: m_bOscFeedbackEnabled

Definition at line 1436 of file Preferences.h.

◆ getOscServerEnabled()

bool getOscServerEnabled ( )

inline

Returns: m_bOscServerEnabled

Definition at line 1429 of file Preferences.h.

◆ getOscServerPort()

int getOscServerPort ( )

inline

Returns: m_nOscServerPort

Definition at line 1443 of file Preferences.h.

◆ getPatternColors()

std::vector< QColor > getPatternColors ( ) const

inline

Definition at line 1284 of file Preferences.h.

◆ getPatternEditorGridHeight()

unsigned getPatternEditorGridHeight ( )

inline

Definition at line 1268 of file Preferences.h.

◆ getPatternEditorGridResolution()

int getPatternEditorGridResolution ( )

inline

Definition at line 1226 of file Preferences.h.

◆ getPatternEditorGridWidth()

unsigned getPatternEditorGridWidth ( )

inline

Definition at line 1274 of file Preferences.h.

◆ getPatternEditorProperties()

WindowProperties getPatternEditorProperties ( )

inline

Definition at line 1322 of file Preferences.h.

◆ getPlaylistDialogProperties()

WindowProperties getPlaylistDialogProperties ( )

inline

Definition at line 1358 of file Preferences.h.

◆ getPreferencesOverwritePath()

QString getPreferencesOverwritePath ( )

Returns m_sPreferencesOverwritePath.

Returns: m_sPreferencesOverwritePath

◆ getPreferredLanguage()

const QString & getPreferredLanguage ( )

inline

Definition at line 1046 of file Preferences.h.

◆ getPunchInPos()

int getPunchInPos ( )

inline

Definition at line 1133 of file Preferences.h.

◆ getPunchOutPos()

int getPunchOutPos ( )

inline

Definition at line 1140 of file Preferences.h.

◆ getQTStyle()

const QString & getQTStyle ( )

inline

Definition at line 1179 of file Preferences.h.

◆ getQuantizeEvents()

bool getQuantizeEvents ( )

inline

Definition at line 1162 of file Preferences.h.

◆ getRecentFiles()

std::vector< QString > getRecentFiles ( ) const

inline

Definition at line 1169 of file Preferences.h.

◆ getRecentFX()

QStringList getRecentFX ( )

inline

Definition at line 1173 of file Preferences.h.

◆ getRecordEvents()

bool getRecordEvents ( )

inline

Definition at line 1126 of file Preferences.h.

◆ getRubberBandBatchMode()

int getRubberBandBatchMode ( )

inline

Definition at line 1464 of file Preferences.h.

◆ getShowAutomationArea()

bool getShowAutomationArea ( )

inline

Definition at line 1247 of file Preferences.h.

◆ getShowDevelWarning()

bool getShowDevelWarning ( )

inline

Definition at line 1070 of file Preferences.h.

◆ getShowNoteOverwriteWarning()

bool getShowNoteOverwriteWarning ( )

inline

Definition at line 1074 of file Preferences.h.

◆ getShowPlaybackTrack()

bool getShowPlaybackTrack ( ) const

inline

Definition at line 1460 of file Preferences.h.

◆ getSongEditorGridHeight()

unsigned getSongEditorGridHeight ( )

inline

Definition at line 1255 of file Preferences.h.

◆ getSongEditorGridWidth()

unsigned getSongEditorGridWidth ( )

inline

Definition at line 1261 of file Preferences.h.

◆ getSongEditorProperties()

WindowProperties getSongEditorProperties ( )

inline

Definition at line 1329 of file Preferences.h.

◆ getSupportedAudioDrivers()

std::vector< Preferences::AudioDriver > getSupportedAudioDrivers ( )

static

Definition at line 1376 of file Preferences.cpp.

◆ getTheme()

const std::shared_ptr< Theme > getTheme ( ) const

inline

Definition at line 1488 of file Preferences.h.

◆ getUIScalingPolicy()

InterfaceTheme::ScalingPolicy getUIScalingPolicy ( )

inline

Definition at line 1029 of file Preferences.h.

◆ getUseTimelineBpm()

bool getUseTimelineBpm ( )

inline

Whether to use the bpm of the timeline.

Returns: __useTimelineBpm

Definition at line 1450 of file Preferences.h.

◆ getVisiblePatternColors()

int getVisiblePatternColors ( ) const

inline

Definition at line 1290 of file Preferences.h.

◆ getWaitForSessionHandler()

bool getWaitForSessionHandler ( )

inline

Definition at line 1406 of file Preferences.h.

◆ hideKeyboardCursor()

bool hideKeyboardCursor ( )

inline

Definition at line 1086 of file Preferences.h.

◆ inPunchArea()

bool inPunchArea ( int pos )

inline

Definition at line 1144 of file Preferences.h.

◆ isFXTabVisible()

bool isFXTabVisible ( )

inline

Definition at line 1240 of file Preferences.h.

◆ isPatternEditorUsingTriplets()

bool isPatternEditorUsingTriplets ( )

inline

Definition at line 1233 of file Preferences.h.

◆ isPlaylistUsingRelativeFilenames()

bool isPlaylistUsingRelativeFilenames ( )

inline

Definition at line 1098 of file Preferences.h.

◆ isRestoreLastPlaylistEnabled()

bool isRestoreLastPlaylistEnabled ( )

inline

Definition at line 1094 of file Preferences.h.

◆ isRestoreLastSongEnabled()

bool isRestoreLastSongEnabled ( )

inline

Definition at line 1090 of file Preferences.h.

◆ loadPreferences()

bool loadPreferences ( bool bGlobal )

Load the preferences file.

Definition at line 294 of file Preferences.cpp.

◆ parseAudioDriver()

Preferences::AudioDriver parseAudioDriver ( const QString & sDriver )

static

Definition at line 1221 of file Preferences.cpp.

◆ readWindowProperties()

WindowProperties readWindowProperties	(	XMLNode	parent,
		const QString &	windowName,
		WindowProperties	defaultProp )

private

Read the xml nodes related to window properties.

Definition at line 1440 of file Preferences.cpp.

◆ savePreferences()

bool savePreferences ( )

Save the preferences file.

Definition at line 835 of file Preferences.cpp.

◆ setApplicationFontFamily()

void setApplicationFontFamily ( const QString & family )

inline

Definition at line 1188 of file Preferences.h.

◆ setAudioEngineInfoProperties()

void setAudioEngineInfoProperties ( const WindowProperties & prop )

inline

Definition at line 1347 of file Preferences.h.

◆ setColoringMethod()

void setColoringMethod ( InterfaceTheme::ColoringMethod coloringMethod )

inline

Definition at line 1300 of file Preferences.h.

◆ setColorTheme()

void setColorTheme ( const std::shared_ptr< ColorTheme > pNewColorTheme )

inline

Definition at line 1375 of file Preferences.h.

◆ setDefaultEditor()

void setDefaultEditor ( QString editor )

inline

Definition at line 1017 of file Preferences.h.

◆ setDefaultUILayout()

void setDefaultUILayout ( InterfaceTheme::Layout layout )

inline

Definition at line 1025 of file Preferences.h.

◆ setDirectorProperties()

void setDirectorProperties ( const WindowProperties & prop )

inline

Definition at line 1368 of file Preferences.h.

◆ setExportCompressionLevel()

void setExportCompressionLevel ( float fCompressionLevel )

inline

Definition at line 1008 of file Preferences.h.

◆ setExportFormat()

void setExportFormat ( Filesystem::AudioFormat format )

inline

Definition at line 998 of file Preferences.h.

◆ setExportModeIdx()

void setExportModeIdx ( int nExportMode )

inline

Definition at line 983 of file Preferences.h.

◆ setExportSampleDepthIdx()

void setExportSampleDepthIdx ( int nExportSampleDepthIdx )

inline

Definition at line 968 of file Preferences.h.

◆ setExportSampleRateIdx()

void setExportSampleRateIdx ( int nExportSampleRateIdx )

inline

Definition at line 988 of file Preferences.h.

◆ setFontSize()

void setFontSize ( FontTheme::FontSize fontSize )

inline

Definition at line 1209 of file Preferences.h.

◆ setFXTabVisible()

void setFXTabVisible ( bool value )

inline

Definition at line 1243 of file Preferences.h.

◆ setH2ProcessName()

void setH2ProcessName ( const QString & processName )

inline

Definition at line 1478 of file Preferences.h.

◆ setHearNewNotes()

void setHearNewNotes ( bool value )

inline

Definition at line 1116 of file Preferences.h.

◆ setHideKeyboardCursor()

void setHideKeyboardCursor ( bool b )

inline

Definition at line 1082 of file Preferences.h.

◆ setIconColor()

void setIconColor ( InterfaceTheme::IconColor iconColor )

inline

Definition at line 1041 of file Preferences.h.

◆ setInstrumentPeaks()

void setInstrumentPeaks ( bool value )

inline

Definition at line 1222 of file Preferences.h.

◆ setInstrumentRackProperties()

void setInstrumentRackProperties ( const WindowProperties & prop )

inline

Definition at line 1340 of file Preferences.h.

◆ setLadspaProperties()

void setLadspaProperties	(	unsigned	nFX,
		const WindowProperties &	prop )

inline

Definition at line 1354 of file Preferences.h.

◆ setLastAddSongToPlaylistDirectory()

void setLastAddSongToPlaylistDirectory ( QString sPath )

inline

Definition at line 932 of file Preferences.h.

◆ setLastExportDrumkitDirectory()

void setLastExportDrumkitDirectory ( QString sPath )

inline

Definition at line 920 of file Preferences.h.

◆ setLastExportLilypondDirectory()

void setLastExportLilypondDirectory ( QString sPath )

inline

Definition at line 908 of file Preferences.h.

◆ setLastExportMidiDirectory()

void setLastExportMidiDirectory ( QString sPath )

inline

Definition at line 912 of file Preferences.h.

◆ setLastExportPatternAsDirectory()

void setLastExportPatternAsDirectory ( QString sPath )

inline

Definition at line 888 of file Preferences.h.

◆ setLastExportSongDirectory()

void setLastExportSongDirectory ( QString sPath )

inline

Definition at line 892 of file Preferences.h.

◆ setLastExportThemeDirectory()

void setLastExportThemeDirectory ( QString sPath )

inline

Definition at line 948 of file Preferences.h.

◆ setLastImportDrumkitDirectory()

void setLastImportDrumkitDirectory ( QString sPath )

inline

Definition at line 916 of file Preferences.h.

◆ setLastImportThemeDirectory()

void setLastImportThemeDirectory ( QString sPath )

inline

Definition at line 944 of file Preferences.h.

◆ setLastOpenLayerDirectory()

void setLastOpenLayerDirectory ( QString sPath )

inline

Definition at line 924 of file Preferences.h.

◆ setLastOpenPatternDirectory()

void setLastOpenPatternDirectory ( QString sPath )

inline

Definition at line 904 of file Preferences.h.

◆ setLastOpenPlaybackTrackDirectory()

void setLastOpenPlaybackTrackDirectory ( QString sPath )

inline

Definition at line 928 of file Preferences.h.

◆ setLastOpenSongDirectory()

void setLastOpenSongDirectory ( QString sPath )

inline

Definition at line 900 of file Preferences.h.

◆ setLastOpenTab()

void setLastOpenTab ( int n )

inline

Definition at line 1474 of file Preferences.h.

◆ setLastPlaylistDirectory()

void setLastPlaylistDirectory ( QString sPath )

inline

Definition at line 936 of file Preferences.h.

◆ setLastPlaylistFilename()

void setLastPlaylistFilename ( const QString & filename )

inline

Definition at line 1109 of file Preferences.h.

◆ setLastPlaylistScriptDirectory()

void setLastPlaylistScriptDirectory ( QString sPath )

inline

Definition at line 940 of file Preferences.h.

◆ setLastSaveSongAsDirectory()

void setLastSaveSongAsDirectory ( QString sPath )

inline

Definition at line 896 of file Preferences.h.

◆ setLastSongFilename()

void setLastSongFilename ( const QString & filename )

inline

Definition at line 1102 of file Preferences.h.

◆ setLevel2FontFamily()

void setLevel2FontFamily ( const QString & family )

inline

Definition at line 1195 of file Preferences.h.

◆ setLevel3FontFamily()

void setLevel3FontFamily ( const QString & family )

inline

Definition at line 1202 of file Preferences.h.

◆ setMainFormProperties()

void setMainFormProperties ( const WindowProperties & prop )

inline

Definition at line 1311 of file Preferences.h.

◆ setMaxBars()

void setMaxBars ( const int bars )

inline

Parameters

bars	Sets m_nMaxBars.

Definition at line 1386 of file Preferences.h.

◆ setMaxLayers()

void setMaxLayers ( const int layers )

inline

Parameters

layers Sets m_nMaxLayers.

Definition at line 1394 of file Preferences.h.

◆ setMaxPatternColors()

void setMaxPatternColors ( int nValue )

inline

Definition at line 1293 of file Preferences.h.

◆ setMidiExportMode()

void setMidiExportMode ( int nExportMode )

inline

Definition at line 958 of file Preferences.h.

◆ setMixerFalloffSpeed()

void setMixerFalloffSpeed ( float value )

inline

Definition at line 1216 of file Preferences.h.

◆ setMixerProperties()

void setMixerProperties ( const WindowProperties & prop )

inline

Definition at line 1318 of file Preferences.h.

◆ setMostRecentFX()

void setMostRecentFX ( QString FX_name )

Definition at line 1428 of file Preferences.cpp.

◆ setNsmClientId()

void setNsmClientId ( const QString & nsmClientId )

inline

Definition at line 1411 of file Preferences.h.

◆ setNsmSongName()

void setNsmSongName ( const QString & nsmSongName )

inline

Definition at line 1419 of file Preferences.h.

◆ setOscFeedbackEnabled()

void setOscFeedbackEnabled ( bool val )

inline

Parameters

val	Sets m_bOscFeedbackEnabled

Definition at line 1439 of file Preferences.h.

◆ setOscServerEnabled()

void setOscServerEnabled ( bool val )

inline

Parameters

val	Sets m_bOscServerEnabled

Definition at line 1432 of file Preferences.h.

◆ setOscServerPort()

void setOscServerPort ( int oscPort )

inline

Parameters

oscPort Sets m_nOscServerPort

Definition at line 1446 of file Preferences.h.

◆ setPatternColors()

void setPatternColors ( std::vector< QColor > patternColors )

inline

Definition at line 1281 of file Preferences.h.

◆ setPatternEditorGridHeight()

void setPatternEditorGridHeight ( unsigned value )

inline

Definition at line 1271 of file Preferences.h.

◆ setPatternEditorGridResolution()

void setPatternEditorGridResolution ( int value )

inline

Definition at line 1229 of file Preferences.h.

◆ setPatternEditorGridWidth()

void setPatternEditorGridWidth ( unsigned value )

inline

Definition at line 1277 of file Preferences.h.

◆ setPatternEditorProperties()

void setPatternEditorProperties ( const WindowProperties & prop )

inline

Definition at line 1325 of file Preferences.h.

◆ setPatternEditorUsingTriplets()

void setPatternEditorUsingTriplets ( bool value )

inline

Definition at line 1236 of file Preferences.h.

◆ setPlaylistDialogProperties()

void setPlaylistDialogProperties ( const WindowProperties & prop )

inline

Definition at line 1361 of file Preferences.h.

◆ setPreferencesOverwritePath()

void setPreferencesOverwritePath ( const QString & newPath )

Setting m_sPreferencesOverwritePath.

Parameters

newPath Path to a local preferences file.

◆ setPreferredLanguage()

void setPreferredLanguage ( const QString & sLanguage )

inline

Definition at line 1050 of file Preferences.h.

◆ setPunchInPos()

void setPunchInPos ( unsigned pos )

inline

Definition at line 1130 of file Preferences.h.

◆ setPunchOutPos()

void setPunchOutPos ( unsigned pos )

inline

Definition at line 1137 of file Preferences.h.

◆ setQTStyle()

void setQTStyle ( const QString & sStyle )

inline

Definition at line 1182 of file Preferences.h.

◆ setQuantizeEvents()

void setQuantizeEvents ( bool value )

inline

Definition at line 1159 of file Preferences.h.

◆ setRecentFiles()

void setRecentFiles ( const std::vector< QString > recentFiles )

inline

Definition at line 1166 of file Preferences.h.

◆ setRecordEvents()

void setRecordEvents ( bool value )

inline

Definition at line 1123 of file Preferences.h.

◆ setRestoreLastPlaylistEnabled()

void setRestoreLastPlaylistEnabled ( bool restore )

inline

Definition at line 1058 of file Preferences.h.

◆ setRestoreLastSongEnabled()

void setRestoreLastSongEnabled ( bool restore )

inline

Definition at line 1054 of file Preferences.h.

◆ setRubberBandBatchMode()

void setRubberBandBatchMode ( int val )

inline

Definition at line 1467 of file Preferences.h.

◆ setShowAutomationArea()

void setShowAutomationArea ( bool value )

inline

Definition at line 1250 of file Preferences.h.

◆ setShowDevelWarning()

void setShowDevelWarning ( bool value )

inline

Definition at line 1066 of file Preferences.h.

◆ setShowNoteOverwriteWarning()

void setShowNoteOverwriteWarning ( bool bValue )

inline

Definition at line 1078 of file Preferences.h.

◆ setShowPlaybackTrack()

void setShowPlaybackTrack ( bool val )

inline

Definition at line 1457 of file Preferences.h.

◆ setSongEditorGridHeight()

void setSongEditorGridHeight ( unsigned value )

inline

Definition at line 1258 of file Preferences.h.

◆ setSongEditorGridWidth()

void setSongEditorGridWidth ( unsigned value )

inline

Definition at line 1264 of file Preferences.h.

◆ setSongEditorProperties()

void setSongEditorProperties ( const WindowProperties & prop )

inline

Definition at line 1332 of file Preferences.h.

◆ setTheme()

void setTheme ( const std::shared_ptr< Theme > pTheme )

inline

Definition at line 1485 of file Preferences.h.

◆ setUIScalingPolicy()

void setUIScalingPolicy ( InterfaceTheme::ScalingPolicy policy )

inline

Definition at line 1033 of file Preferences.h.

◆ setUseLash()

void setUseLash ( bool b )

inline

Definition at line 1382 of file Preferences.h.

◆ setUseRelativeFilenamesForPlaylists()

void setUseRelativeFilenamesForPlaylists ( bool value )

inline

Definition at line 1062 of file Preferences.h.

◆ setUseTimelineBpm()

void setUseTimelineBpm ( bool val )

inline

Setting __useTimelineBpm.

Parameters

val	New choice.

Definition at line 1453 of file Preferences.h.

◆ setVisiblePatternColors()

void setVisiblePatternColors ( int nValue )

inline

Definition at line 1287 of file Preferences.h.

◆ setWaitForSessionHandler()

void setWaitForSessionHandler ( bool value )

inline

Definition at line 1402 of file Preferences.h.

◆ showInstrumentPeaks()

bool showInstrumentPeaks ( )

inline

Definition at line 1219 of file Preferences.h.

◆ unsetPunchArea()

void unsetPunchArea ( )

inline

Definition at line 1154 of file Preferences.h.

◆ useLash()

bool useLash ( )

inline

Definition at line 1379 of file Preferences.h.

◆ writeWindowProperties()

void writeWindowProperties	(	XMLNode	parent,
		const QString &	windowName,
		const WindowProperties &	prop )

private

Write the xml nodes related to window properties.

Definition at line 1464 of file Preferences.cpp.

Field Documentation

◆ __expandPatternItem

bool __expandPatternItem

Definition at line 160 of file Preferences.h.

◆ __expandSongItem

bool __expandSongItem

Definition at line 159 of file Preferences.h.

◆ __instance

Preferences * __instance = nullptr

staticprivate

Object holding the current Preferences singleton.

It is initialized with NULL, set with create_instance(), and accessed with get_instance().

Definition at line 694 of file Preferences.h.

◆ __playsamplesonclicking

bool __playsamplesonclicking

Definition at line 148 of file Preferences.h.

◆ __playselectedinstrument

bool __playselectedinstrument

Definition at line 150 of file Preferences.h.

◆ __useTimelineBpm

bool __useTimelineBpm

private

Whether to use local speeds specified along the Timeline or a constant tempo for the whole Song in Hydrogen::getTimelineBpm() and Hydrogen::getTimelineBpm().

It is set using setUseTimelineBpm() and accessed via getUseTimelineBpm().

Definition at line 757 of file Preferences.h.

◆ audioEngineInfoProperties

WindowProperties audioEngineInfoProperties

private

Definition at line 779 of file Preferences.h.

◆ hearNewNotes

bool hearNewNotes

private

Definition at line 738 of file Preferences.h.

◆ instrumentRackProperties

WindowProperties instrumentRackProperties

private

Definition at line 778 of file Preferences.h.

◆ m_audioDriver

AudioDriver m_audioDriver

Audio driver.

Used in the audioEngine_startAudioDrivers() to create an audio driver using createDriver().

These choices are support:

"Auto" : audioEngine_startAudioDrivers() will try different drivers itself.
"Jack" : createDriver() will create a JackAudioDriver.
"Alsa" : createDriver() will create a AlsaAudioDriver.
"CoreAudio" : createDriver() will create a CoreAudioDriver.
"PortAudio" : createDriver() will create a PortAudioDriver.
"Oss" : createDriver() will create a OssDriver.
"PulseAudio" : createDriver() will create a PulseAudioDriver.
"Fake" : createDriver() will create a FakeDriver.

Definition at line 221 of file Preferences.h.

◆ m_bbc

bool m_bbc

Definition at line 163 of file Preferences.h.

◆ m_bEnableMidiFeedback

bool m_bEnableMidiFeedback

Definition at line 280 of file Preferences.h.

◆ m_bFollowPlayhead

bool m_bFollowPlayhead

Definition at line 152 of file Preferences.h.

◆ m_bHideKeyboardCursor

bool m_bHideKeyboardCursor

private

Definition at line 719 of file Preferences.h.

◆ m_bIsFXTabVisible

bool m_bIsFXTabVisible

private

Definition at line 767 of file Preferences.h.

◆ m_bJackConnectDefaults

bool m_bJackConnectDefaults

Toggles auto-connecting of the main stereo output ports to the system's default ports when starting the JACK server.

Definition at line 348 of file Preferences.h.

◆ m_bJackTimebaseEnabled

bool m_bJackTimebaseEnabled

External applications with a faulty JACK Timebase implementation can mess up the transport within Hydrogen.

To guarantee the basic functionality, the user can disable Timebase support and make Hydrogen only listen to the frame number broadcast by the JACK server.

Definition at line 377 of file Preferences.h.

◆ m_bJackTimebaseMode

int m_bJackTimebaseMode

Specifies if Hydrogen support the of JACK Timebase protocol.

It has two states: Preferences::USE_JACK_TIMEBASE_CONTROL and Preferences::NO_JACK_TIMEBASE_CONTROL. It is set to Preferences::NO_JACK_TIMEBASE_CONTROL by the JackAudioDriver::initTimebaseControl() if Hydrogen couldn't acquire Timebase control.

Definition at line 385 of file Preferences.h.

◆ m_bJackTrackOuts

bool m_bJackTrackOuts

If set to true, JackAudioDriver::makeTrackOutputs() will create two individual left and right output ports for every component of each instrument.

If false, one usual stereo output will be created.

Definition at line 355 of file Preferences.h.

◆ m_bJackTransportMode

int m_bJackTransportMode

Specifies whether or not Hydrogen will use the JACK transport system.

It has two different states: USE_JACK_TRANSPORT and NO_JACK_TRANSPORT.

Definition at line 345 of file Preferences.h.

◆ m_bLoadingSuccessful

bool m_bLoadingSuccessful

private

Definition at line 837 of file Preferences.h.

◆ m_bMidiDiscardNoteAfterAction

bool m_bMidiDiscardNoteAfterAction

Definition at line 279 of file Preferences.h.

◆ m_bMidiFixedMapping

bool m_bMidiFixedMapping

Definition at line 278 of file Preferences.h.

◆ m_bMidiNoteOffIgnore

bool m_bMidiNoteOffIgnore

Definition at line 277 of file Preferences.h.

◆ m_bOscFeedbackEnabled

bool m_bOscFeedbackEnabled

Whether to send the current state of Hydrogen to the OSC clients.

If set to true, the current state of Hydrogen will be sent to all known OSC clients using CoreActionController::initExternalControlInterfaces() and OscServer::handleAction() via OSC messages each time it gets updated..

Set by setOscFeedbackEnabled() and queried by getOscFeedbackEnabled().

Definition at line 309 of file Preferences.h.

◆ m_bOscServerEnabled

bool m_bOscServerEnabled

Whether to start the OscServer thread.

If set to true, the OscServer::start() function of the OscServer singleton will be called in Hydrogen::Hydrogen(). This will register all OSC message handlers and makes the server listen to port m_nOscServerPort.

Set by setOscServerEnabled() and queried by getOscServerEnabled().

Definition at line 295 of file Preferences.h.

◆ m_bPatternEditorUsingTriplets

bool m_bPatternEditorUsingTriplets

private

Definition at line 765 of file Preferences.h.

◆ m_brestartLash

bool m_brestartLash

Definition at line 155 of file Preferences.h.

◆ m_brestoreLastPlaylist

bool m_brestoreLastPlaylist

private

Definition at line 705 of file Preferences.h.

◆ m_brestoreLastSong

bool m_brestoreLastSong

private

Definition at line 704 of file Preferences.h.

◆ m_bsetLash

bool m_bsetLash

Definition at line 156 of file Preferences.h.

◆ m_bShowAutomationArea

bool m_bShowAutomationArea

private

Definition at line 768 of file Preferences.h.

◆ m_bShowDevelWarning

bool m_bShowDevelWarning

private

Definition at line 708 of file Preferences.h.

◆ m_bShowExportDrumkitAttributionWarning

bool m_bShowExportDrumkitAttributionWarning

Definition at line 674 of file Preferences.h.

◆ m_bShowExportDrumkitCopyleftWarning

bool m_bShowExportDrumkitCopyleftWarning

Definition at line 673 of file Preferences.h.

◆ m_bShowExportDrumkitLicenseWarning

bool m_bShowExportDrumkitLicenseWarning

Definition at line 672 of file Preferences.h.

◆ m_bShowExportSongLicenseWarning

bool m_bShowExportSongLicenseWarning

Definition at line 671 of file Preferences.h.

◆ m_bShowInstrumentPeaks

bool m_bShowInstrumentPeaks

private

Definition at line 766 of file Preferences.h.

◆ m_bShowNoteOverwriteWarning

bool m_bShowNoteOverwriteWarning

private

Last song used.

Definition at line 709 of file Preferences.h.

◆ m_bShowPlaybackTrack

bool m_bShowPlaybackTrack

private

Definition at line 762 of file Preferences.h.

◆ m_bUseLash

bool m_bUseLash

private

Show development version warning?

Definition at line 706 of file Preferences.h.

◆ m_bUseMetronome

bool m_bUseMetronome

If set to true, samples of the metronome will be added to H2Core::AudioEngine::m_songNoteQueue and thus played back on a regular basis.

Definition at line 225 of file Preferences.h.

◆ m_bUseRelativeFilenamesForPlaylists

bool m_bUseRelativeFilenamesForPlaylists

private

Definition at line 769 of file Preferences.h.

◆ m_countOffset

int m_countOffset

Definition at line 166 of file Preferences.h.

◆ m_directorProperties

WindowProperties m_directorProperties

private

Definition at line 782 of file Preferences.h.

◆ m_exportFormat

Filesystem::AudioFormat m_exportFormat

private

Definition at line 808 of file Preferences.h.

◆ m_fExportCompressionLevel

float m_fExportCompressionLevel

private

Definition at line 809 of file Preferences.h.

◆ m_fMetronomeVolume

float m_fMetronomeVolume

Metronome volume FIXME: remove this volume!!

Definition at line 227 of file Preferences.h.

◆ m_JackTrackOutputMode

JackTrackOutputMode m_JackTrackOutputMode

Specifies which audio settings will be applied to the sample supplied in the JACK per track output ports.

Definition at line 369 of file Preferences.h.

◆ m_ladspaProperties

WindowProperties m_ladspaProperties[MAX_FX]

private

Definition at line 780 of file Preferences.h.

◆ m_lastPlaylistFilename

QString m_lastPlaylistFilename

private

Definition at line 712 of file Preferences.h.

◆ m_lastSongFilename

QString m_lastSongFilename

private

Definition at line 711 of file Preferences.h.

◆ m_mmcsetplay

bool m_mmcsetplay

Definition at line 164 of file Preferences.h.

◆ m_nAutosavesPerHour

int m_nAutosavesPerHour

Definition at line 390 of file Preferences.h.

◆ m_nBufferSize

unsigned m_nBufferSize

Buffer size of the audio.

It is set e.g. by JackAudioDriver::init() to the buffer size of the freshly opened JACK client.

Definition at line 236 of file Preferences.h.

◆ m_nExportModeIdx

int m_nExportModeIdx

private

Definition at line 805 of file Preferences.h.

◆ m_nExportSampleDepthIdx

int m_nExportSampleDepthIdx

private

Definition at line 807 of file Preferences.h.

◆ m_nExportSampleRateIdx

int m_nExportSampleRateIdx

private

Definition at line 806 of file Preferences.h.

◆ m_nLastOpenTab

int m_nLastOpenTab

private

Definition at line 761 of file Preferences.h.

◆ m_nLatencyTarget

int m_nLatencyTarget

Definition at line 332 of file Preferences.h.

◆ m_nMaxBars

int m_nMaxBars

private

Maximum number of bars shown in the Song Editor at once.

It is set by setMaxBars() and queried by getMaxBars(). In order to change this value, you have to manually edit the <maxBars> tag in the configuration file of Hydrogen in your home folder. Default value assigned in constructor: 400.

Definition at line 728 of file Preferences.h.

◆ m_nMaxLayers

int m_nMaxLayers

private

Maximum number of layers to be used in the Instrument editor.

It is set by setMaxLayers() and queried by getMaxLayers(). It is setIn order to change this value, you have to manually edit the <maxLayers> tag in the configuration file of Hydrogen in your home folder. Default value assigned in constructor: 16.

Definition at line 737 of file Preferences.h.

◆ m_nMaxNotes

unsigned m_nMaxNotes

max notes

Definition at line 229 of file Preferences.h.

◆ m_nMidiChannelFilter

int m_nMidiChannelFilter

Definition at line 276 of file Preferences.h.

◆ m_nMidiExportMode

int m_nMidiExportMode

private

Definition at line 813 of file Preferences.h.

◆ m_nOscServerPort

int m_nOscServerPort

Port number the OscServer will be started at.

Set by setOscServerPort() and queried by getOscServerPort().

Definition at line 324 of file Preferences.h.

◆ m_nOscTemporaryPort

int m_nOscTemporaryPort

In case m_nOscServerPort is already occupied by another client, the alternative - random - port number provided by the OSC server will be stored in this variable.

If the connection using the default port succeeded, the variable will be set to -1.

Definition at line 317 of file Preferences.h.

◆ m_nPatternEditorGridHeight

unsigned m_nPatternEditorGridHeight

private

Definition at line 770 of file Preferences.h.

◆ m_nPatternEditorGridResolution

int m_nPatternEditorGridResolution

private

Definition at line 764 of file Preferences.h.

◆ m_nPatternEditorGridWidth

unsigned m_nPatternEditorGridWidth

private

Definition at line 771 of file Preferences.h.

◆ m_nSampleRate

unsigned m_nSampleRate

Sample rate of the audio.

It is set e.g. by JackAudioDriver::init() to the sample rate of the freshly opened JACK client.

Definition at line 243 of file Preferences.h.

◆ m_nSongEditorGridHeight

unsigned m_nSongEditorGridHeight

private

Definition at line 772 of file Preferences.h.

◆ m_nSongEditorGridWidth

unsigned m_nSongEditorGridWidth

private

Definition at line 773 of file Preferences.h.

◆ m_patternCategories

std::list<QString> m_patternCategories

Definition at line 171 of file Preferences.h.

◆ m_playlistDialogProperties

WindowProperties m_playlistDialogProperties

private

Definition at line 781 of file Preferences.h.

◆ m_pTheme

std::shared_ptr<Theme> m_pTheme

private

Definition at line 696 of file Preferences.h.

◆ m_recentFiles

std::vector<QString> m_recentFiles

private

Definition at line 741 of file Preferences.h.

◆ m_recentFX

QStringList m_recentFX

private

Definition at line 740 of file Preferences.h.

◆ m_rubberBandCLIexecutable

QString m_rubberBandCLIexecutable

Rubberband CLI.

Definition at line 393 of file Preferences.h.

◆ m_sAlsaAudioDevice

QString m_sAlsaAudioDevice

Definition at line 327 of file Preferences.h.

◆ m_sCoreAudioDevice

QString m_sCoreAudioDevice

Definition at line 335 of file Preferences.h.

◆ m_sDefaultEditor

QString m_sDefaultEditor

Default text editor (used by Playlisteditor)

Definition at line 389 of file Preferences.h.

◆ m_sH2ProcessName

QString m_sH2ProcessName

private

Definition at line 699 of file Preferences.h.

◆ m_sJackPortName1

QString m_sJackPortName1

Definition at line 338 of file Preferences.h.

◆ m_sJackPortName2

QString m_sJackPortName2

Definition at line 339 of file Preferences.h.

◆ m_sLastAddSongToPlaylistDirectory

QString m_sLastAddSongToPlaylistDirectory

private

Definition at line 798 of file Preferences.h.

◆ m_sLastExportDrumkitDirectory

QString m_sLastExportDrumkitDirectory

private

Definition at line 795 of file Preferences.h.

◆ m_sLastExportLilypondDirectory

QString m_sLastExportLilypondDirectory

private

Definition at line 792 of file Preferences.h.

◆ m_sLastExportMidiDirectory

QString m_sLastExportMidiDirectory

private

Definition at line 793 of file Preferences.h.

◆ m_sLastExportPatternAsDirectory

QString m_sLastExportPatternAsDirectory

private

Definition at line 787 of file Preferences.h.

◆ m_sLastExportSongDirectory

QString m_sLastExportSongDirectory

private

Definition at line 788 of file Preferences.h.

◆ m_sLastExportThemeDirectory

QString m_sLastExportThemeDirectory

private

Definition at line 802 of file Preferences.h.

◆ m_sLastImportDrumkitDirectory

QString m_sLastImportDrumkitDirectory

private

Definition at line 794 of file Preferences.h.

◆ m_sLastImportThemeDirectory

QString m_sLastImportThemeDirectory

private

Definition at line 801 of file Preferences.h.

◆ m_sLastOpenLayerDirectory

QString m_sLastOpenLayerDirectory

private

Definition at line 796 of file Preferences.h.

◆ m_sLastOpenPatternDirectory

QString m_sLastOpenPatternDirectory

private

Definition at line 791 of file Preferences.h.

◆ m_sLastOpenPlaybackTrackDirectory

QString m_sLastOpenPlaybackTrackDirectory

private

Definition at line 797 of file Preferences.h.

◆ m_sLastOpenSongDirectory

QString m_sLastOpenSongDirectory

private

Definition at line 790 of file Preferences.h.

◆ m_sLastPlaylistDirectory

QString m_sLastPlaylistDirectory

private

Definition at line 799 of file Preferences.h.

◆ m_sLastPlaylistScriptDirectory

QString m_sLastPlaylistScriptDirectory

private

Definition at line 800 of file Preferences.h.

◆ m_sLastSaveSongAsDirectory

QString m_sLastSaveSongAsDirectory

private

Definition at line 789 of file Preferences.h.

◆ m_sMidiDriver

QString m_sMidiDriver

MIDI driver.

Used in the audioEngine_startAudioDrivers() to create an MIDI driver.

These choices are support:

"JackMidi" : A JackMidiDriver will be called.
"ALSA" : An AlsaMidiDriver will be called.
"CoreMidi" : A CoreMidiDriver will be called.
"PortMidi" : A PortMidiDriver will be called.

Definition at line 261 of file Preferences.h.

◆ m_sMidiOutputPortName

QString m_sMidiOutputPortName

Definition at line 263 of file Preferences.h.

◆ m_sMidiPortName

QString m_sMidiPortName

Definition at line 262 of file Preferences.h.

◆ m_sNsmClientId

QString m_sNsmClientId

private

Definition at line 744 of file Preferences.h.

◆ m_sNsmSongName

QString m_sNsmSongName

private

Definition at line 745 of file Preferences.h.

◆ m_sOSSDevice

QString m_sOSSDevice

Device used for output.

Definition at line 246 of file Preferences.h.

◆ m_sPortAudioDevice

QString m_sPortAudioDevice

Definition at line 330 of file Preferences.h.

◆ m_sPortAudioHostAPI

QString m_sPortAudioHostAPI

Definition at line 331 of file Preferences.h.

◆ m_sPreferencesOverwritePath

QString m_sPreferencesOverwritePath

private

Full path to local preferences file.

Used in nsm_open_cb() to specify a preferences file specific to the current session.

If non-empty, the local file will be loaded instead of Filesystem::usr_config_path() or Filesystem::sys_config_path(). In general the underlying file does not have to be named "hydrogen.conf". But for the sake of consistency the latter naming is strongly recommended.

Note that this variable is a session variable, which won't be stored in the hydrogen.conf preferences file!

Definition at line 830 of file Preferences.h.

◆ m_sPreferredLanguage

QString m_sPreferredLanguage

private

Definition at line 784 of file Preferences.h.

◆ m_startOffset

int m_startOffset

Definition at line 167 of file Preferences.h.

◆ m_useTheRubberbandBpmChangeEvent

bool m_useTheRubberbandBpmChangeEvent

private

rubberband bpm change queue

Restore last song?

Definition at line 701 of file Preferences.h.

◆ mainFormProperties

WindowProperties mainFormProperties

private

Definition at line 774 of file Preferences.h.

◆ mixerProperties

WindowProperties mixerProperties

private

Definition at line 775 of file Preferences.h.

◆ patternEditorProperties

WindowProperties patternEditorProperties

private

Definition at line 776 of file Preferences.h.

◆ punchInPos

int punchInPos

private

Definition at line 717 of file Preferences.h.

◆ punchOutPos

int punchOutPos

private

Definition at line 718 of file Preferences.h.

◆ quantizeEvents

bool quantizeEvents

private

Definition at line 714 of file Preferences.h.

◆ readPrefFileforotherplaces

bool readPrefFileforotherplaces

private

Definition at line 716 of file Preferences.h.

◆ recordEvents

bool recordEvents

private

Definition at line 715 of file Preferences.h.

◆ songEditorProperties

WindowProperties songEditorProperties

private

Definition at line 777 of file Preferences.h.

◆ sServerList

std::list<QString> sServerList

Definition at line 170 of file Preferences.h.

◆ waitingForSessionHandler

bool waitingForSessionHandler

private

Definition at line 748 of file Preferences.h.

Public Types

Public Member Functions

Static Public Member Functions

Data Fields

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

◆ AudioDriver

◆ Changes

◆ JackTrackOutputMode

Constructor & Destructor Documentation

◆ ~Preferences()

◆ Preferences()

Member Function Documentation

◆ audioDriverToQString()

◆ checkJackSupport()

◆ create_instance()

◆ get_instance()

◆ getApplicationFontFamily()

◆ getAudioEngineInfoProperties()

◆ getColoringMethod()

◆ getColorTheme()

◆ getDataDirectory()

◆ getDefaultEditor()

◆ getDefaultUILayout()

◆ getDirectorProperties()

◆ getExportCompressionLevel()

◆ getExportFormat()

◆ getExportModeIdx()

◆ getExportSampleDepthIdx()

◆ getExportSampleRateIdx()

◆ getFontSize()

◆ getH2ProcessName()

◆ getHearNewNotes()

◆ getIconColor()

◆ getInstrumentRackProperties()

◆ getLadspaProperties()

◆ getLastAddSongToPlaylistDirectory()

◆ getLastExportDrumkitDirectory()

◆ getLastExportLilypondDirectory()

◆ getLastExportMidiDirectory()

◆ getLastExportPatternAsDirectory()

◆ getLastExportSongDirectory()

◆ getLastExportThemeDirectory()

◆ getLastImportDrumkitDirectory()

◆ getLastImportThemeDirectory()

◆ getLastOpenLayerDirectory()

◆ getLastOpenPatternDirectory()

◆ getLastOpenPlaybackTrackDirectory()

◆ getLastOpenSongDirectory()

◆ getLastOpenTab()

◆ getLastPlaylistDirectory()

◆ getLastPlaylistFilename()

◆ getLastPlaylistScriptDirectory()

◆ getLastSaveSongAsDirectory()

◆ getLastSongFilename()

◆ getLevel2FontFamily()

◆ getLevel3FontFamily()

◆ getLoadingSuccessful()

◆ getMainFormProperties()

◆ getMaxBars()

◆ getMaxLayers()

◆ getMaxPatternColors()

◆ getMidiExportMode()

◆ getMixerFalloffSpeed()

◆ getMixerProperties()

◆ getNsmClientId()

◆ getNsmSongName()

◆ getNullMidiPort()

◆ getOscFeedbackEnabled()

◆ getOscServerEnabled()

◆ getOscServerPort()

◆ getPatternColors()

◆ getPatternEditorGridHeight()

◆ getPatternEditorGridResolution()

◆ getPatternEditorGridWidth()