tracktion_engine.h

Go to the documentation of this file.

 /*
    ,--.                     ,--.     ,--.  ,--.
  ,-'  '-.,--.--.,--,--.,---.|  |,-.,-'  '-.`--' ,---. ,--,--,      Copyright 2024
  '-.  .-'|  .--' ,-.  | .--'|     /'-.  .-',--.| .-. ||      \   Tracktion Software
    |  |  |  |  \ '-'  \ `--.|  \  \  |  |  |  |' '-' '|  ||  |       Corporation
    `---' `--'   `--`--'`---'`--'`--' `---' `--' `---' `--''--'    www.tracktion.com
 
    Tracktion Engine uses a GPL/commercial licence - see LICENCE.md for details.
*/
 
/*******************************************************************************
 The block below describes the properties of this module, and is read by
 the Projucer to automatically generate project code that uses it.
 For details about the syntax and how to create or use a module, see the
 JUCE Module Format.txt file.
 
 
 BEGIN_JUCE_MODULE_DECLARATION
 
  ID:               tracktion_engine
  vendor:           Tracktion Corporation
  version:          3.0.0
  name:             The Tracktion audio engine
  description:      Classes for manipulating and playing Tracktion projects
  website:          http://www.tracktion.com
  license:          Proprietary
 
  dependencies:     juce_audio_devices juce_audio_utils juce_dsp juce_osc, juce_gui_extra tracktion_graph
 
 END_JUCE_MODULE_DECLARATION
 
*******************************************************************************/
 
#pragma once
#define TRACKTION_ENGINE_H_INCLUDED
 
#if ! JUCE_PROJUCER_LIVE_BUILD
 
#include <memory>
#include <map>
#include <set>
#include <unordered_set>
#include <unordered_map>
#include <atomic>
#include <random>
#include <optional>
#include <variant>
#include <any>
#include <shared_mutex>
#include <span>
 
#include <juce_audio_basics/juce_audio_basics.h>
#include <juce_audio_utils/juce_audio_utils.h>
#include <juce_dsp/juce_dsp.h>
#include <juce_osc/juce_osc.h>
#include <juce_gui_extra/juce_gui_extra.h>
 
#if __has_include(<choc/audio/choc_SampleBuffers.h>)
 #include <choc/audio/choc_SampleBuffers.h>
 #include <choc/audio/choc_MIDI.h>
 #include <choc/containers/choc_SingleReaderSingleWriterFIFO.h>
 #include <choc/containers/choc_NonAllocatingStableSort.h>
#else
 #include "../3rd_party/choc/audio/choc_SampleBuffers.h"
 #include "../3rd_party/choc/audio/choc_MIDI.h"
 #include "../3rd_party/choc/containers/choc_SingleReaderSingleWriterFIFO.h"
 #include "../3rd_party/choc/containers/choc_NonAllocatingStableSort.h"
#endif
 
#include "../3rd_party/expected/expected.hpp"
 
#undef __TEXT
 
#ifndef TRACKTION_ENABLE_SINGLETONS
 #define TRACKTION_ENABLE_SINGLETONS 0
#endif
 
#ifndef TRACKTION_ENABLE_ARA
 #define TRACKTION_ENABLE_ARA 0
#endif
 
#ifndef TRACKTION_ENABLE_CMAJOR
 #define TRACKTION_ENABLE_CMAJOR 0
#endif
 
#ifndef TRACKTION_ENABLE_REWIRE
 #define TRACKTION_ENABLE_REWIRE 0
#endif
 
#ifndef TRACKTION_ENABLE_AUTOMAP
 #define TRACKTION_ENABLE_AUTOMAP 0
#endif
 
#ifndef TRACKTION_ENABLE_VIDEO
 #define TRACKTION_ENABLE_VIDEO 0
#endif
 
#ifndef TRACKTION_ENABLE_REX
 #define TRACKTION_ENABLE_REX 0
#endif
 
#ifndef TRACKTION_ENABLE_CONTROL_SURFACES
 #define TRACKTION_ENABLE_CONTROL_SURFACES 0
#endif
 
#ifndef TRACKTION_ENABLE_CONTROL_SURFACE_MACKIEC4
 #define TRACKTION_ENABLE_CONTROL_SURFACE_MACKIEC4 0
#endif
 
#ifndef TRACKTION_ENABLE_TIMESTRETCH_ELASTIQUE
 #define TRACKTION_ENABLE_TIMESTRETCH_ELASTIQUE 0
#endif
 
#ifndef TRACKTION_ENABLE_TIMESTRETCH_ELASTIQUE_IPP
 #define TRACKTION_ENABLE_TIMESTRETCH_ELASTIQUE_IPP TRACKTION_ENABLE_TIMESTRETCH_ELASTIQUE
#endif
 
#ifndef TRACKTION_ENABLE_TIMESTRETCH_RUBBERBAND
 #define TRACKTION_ENABLE_TIMESTRETCH_RUBBERBAND 0
#endif
 
#ifndef TRACKTION_BUILD_RUBBERBAND
 #define TRACKTION_BUILD_RUBBERBAND 0
#endif
 
#ifndef TRACKTION_ENABLE_TIMESTRETCH_SOUNDTOUCH
 #define TRACKTION_ENABLE_TIMESTRETCH_SOUNDTOUCH 0
#endif
 
#ifndef TRACKTION_ENABLE_ABLETON_LINK
 #define TRACKTION_ENABLE_ABLETON_LINK 0
#endif
 
#ifndef TRACKTION_ENABLE_FFMPEG
 #define TRACKTION_ENABLE_FFMPEG 0
#endif
 
#ifndef TRACKTION_UNIT_TESTS
 #define TRACKTION_UNIT_TESTS 0
#endif
 
#ifndef TRACKTION_BENCHMARKS
 #define TRACKTION_BENCHMARKS 0
#endif
 
#ifndef TRACKTION_CHECK_FOR_SLOW_RENDERING
 #define TRACKTION_CHECK_FOR_SLOW_RENDERING 0
#endif
 
#ifndef TRACKTION_AIR_WINDOWS
 #define TRACKTION_AIR_WINDOWS 0
#endif
 
#ifndef TRACKTION_LOG_DEVICES
 #define TRACKTION_LOG_DEVICES 1
#endif
 
 
//==============================================================================
#ifndef TRACKTION_LOG_ENABLED
 #define TRACKTION_LOG_ENABLED 1
#endif
 
#if TRACKTION_LOG_ENABLED
namespace Ase {
  void trkn_tracktion_log_msg   (const juce::String&);
  void trkn_tracktion_log_error (const juce::String&);
} // Ase
  #define TRACKTION_LOG(a)        Ase::trkn_tracktion_log_msg (a)
  #define TRACKTION_LOG_ERROR(a)  Ase::trkn_tracktion_log_error (a)
// #define TRACKTION_LOG(a)        juce::Logger::writeToLog(a)
// #define TRACKTION_LOG_ERROR(a)  juce::Logger::writeToLog (juce::String ("*** ERROR: ") + a);
#else
 #define TRACKTION_LOG(a)        {}
 #define TRACKTION_LOG_ERROR(a)  {}
#endif
 
//==============================================================================
#define TRACKTION_ASSERT_MESSAGE_THREAD \
    jassert (juce::MessageManager::getInstance()->currentThreadHasLockedMessageManager());
 
//==============================================================================
namespace tracktion { inline namespace graph
{
    class PlayHead;
}}
 
//==============================================================================
#include "../tracktion_core/tracktion_core.h"
 
 
//==============================================================================
namespace tracktion { inline namespace engine
{
    class EngineBehaviour;
    class Engine;
    class DeviceManager;
    class GrooveTemplateManager;
    class Edit;
    class Track;
    class Clip;
    class ClipOwner;
    class Plugin;
    struct PluginRenderContext;
    class AudioFile;
    class Project;
    class InputDevice;
    class OutputDevice;
    class WaveInputDevice;
    class MidiInputDevice;
    class FolderTrack;
    class ClipTrack;
    class AutomationTrack;
    class ArrangerTrack;
    class ChordTrack;
    class MarkerTrack;
    class MasterTrack;
    class TempoTrack;
    struct TrackInsertPoint;
    struct TrackList;
    class TrackCompManager;
    class CompFactory;
    class WarpTimeFactory;
    class TempoSequence;
    class WarpTimeManager;
    class ControlSurface;
    struct AudioFileInfo;
    class LoopInfo;
    class RenderOptions;
    class AutomatableParameter;
    class MacroParameterList;
    class MelodyneFileReader;
    struct ARADocumentHolder;
    class ClipEffects;
    class WaveAudioClip;
    class CollectionClip;
    class MidiClip;
    class EditClip;
    class MidiList;
    class MarkerManager;
    class TransportControl;
    class AbletonLink;
    class ParameterControlMappings;
    class ParameterChangeHandler;
    class AutomationRecordManager;
    class RenderManager;
    class EditPlaybackContext;
    class EditInputDevices;
    class InputDeviceInstance;
    class GrooveTemplate;
    class MidiOutputDevice;
    class LevelMeterPlugin;
    class VolumeAndPanPlugin;
    class VCAPlugin;
    class NovationAutomap;
    class ExternalController;
    class EditInsertPoint;
    class AudioFileManager;
    class AudioClipBase;
    class AudioTrack;
    class PluginList;
    class RackType;
    class RackInstance;
    class MidiControllerParser;
    class MidiInputDeviceInstanceBase;
    struct RetrospectiveMidiBuffer;
    class MidiLearnState;
    struct EditDeleter;
    struct ActiveEdits;
    class AudioFileFormatManager;
    class AutomatableEditItem;
    class RecordingThumbnailManager;
    class WaveInputRecordingThread;
    class ProjectManager;
    class ExternalAutomatableParameter;
    class PitchShiftPlugin;
    struct PluginUnloadInhibitor;
    class ChordClip;
    struct TimecodeSnapType;
    class MidiNote;
    class AutomationCurveSource;
    struct Modifier;
    class MidiTimecodeGenerator;
    class MidiClockGenerator;
    class MidiOutputDeviceInstance;
    class WaveInputDeviceInstance;
    class WaveOutputDeviceInstance;
    struct RetrospectiveRecordBuffer;
    class Clipboard;
    class PropertyStorage;
    class ClipSlotList;
    class ClipSlot;
    class LaunchHandle;
    class LaunchQuantisation;
    class BufferedAudioFileManager;
}} // namespace tracktion { inline namespace engine
 
#include <trkn/tracktion_decls.hh>      // Forward Decls for Ase
 
#ifdef __GNUC__
 #pragma GCC diagnostic push
 #pragma GCC diagnostic ignored "-Wfloat-equal"
#endif
 
//==============================================================================
#include "../tracktion_graph/utilities/tracktion_PerformanceMeasurement.h"
 
//==============================================================================
#include "utilities/tracktion_AppFunctions.h"
#include "utilities/tracktion_AtomicWrapper.h"
#include "utilities/tracktion_Identifiers.h"
#include "utilities/tracktion_ValueTreeUtilities.h"
#include "utilities/tracktion_CrashTracer.h"
#include "utilities/tracktion_AsyncFunctionUtils.h"
#include "utilities/tracktion_CpuMeasurement.h"
#include "utilities/tracktion_ConstrainedCachedValue.h"
#include "utilities/tracktion_FileUtilities.h"
#include "utilities/tracktion_AudioUtilities.h"
#include "utilities/tracktion_AudioScratchBuffer.h"
#include "utilities/tracktion_AudioFadeCurve.h"
#include "utilities/tracktion_Spline.h"
#include "utilities/tracktion_Ditherer.h"
#include "utilities/tracktion_ExternalPlayheadSynchroniser.h"
#include "selection/tracktion_Selectable.h"
#include "selection/tracktion_SelectableClass.h"
#include "selection/tracktion_SelectionManager.h"
#include "model/tracks/tracktion_EditTime.h"
#include "utilities/tracktion_BackgroundJobs.h"
#include "utilities/tracktion_MiscUtilities.h"
#include "utilities/tracktion_TemporaryFileManager.h"
#include "utilities/tracktion_Types.h"
#include "utilities/tracktion_PluginComponent.h"
#include "utilities/tracktion_BinaryData.h"
#include "utilities/tracktion_SettingID.h"
#include "utilities/tracktion_SharedTimer.h"
#include "utilities/tracktion_SafeScopedListener.h"
#include "utilities/tracktion_ScopedListener.h"
#include "utilities/tracktion_MouseHoverDetector.h"
#include "utilities/tracktion_CurveEditor.h"
#include "utilities/tracktion_Envelope.h"
#include "utilities/tracktion_Oscillators.h"
 
#include "project/tracktion_ProjectItemID.h"
 
#include "playback/devices/tracktion_WaveDeviceDescription.h"
 
//==============================================================================
#include "model/automation/tracktion_AutomationCurve.h"
#include "model/edit/tracktion_EditItem.h"
#include "model/automation/tracktion_AutomatableParameterTree.h"
#include "model/automation/tracktion_AutomatableParameter.h"
#include "model/automation/tracktion_AutomatableEditItem.h"
#include "model/automation/tracktion_MacroParameter.h"
#include "model/automation/tracktion_Modifier.h"
#include "model/automation/modifiers/tracktion_ModifierCommon.h"
#include "model/automation/modifiers/tracktion_BreakpointOscillatorModifier.h"
#include "model/automation/modifiers/tracktion_EnvelopeFollowerModifier.h"
#include "model/automation/modifiers/tracktion_LFOModifier.h"
#include "model/automation/modifiers/tracktion_MIDITrackerModifier.h"
#include "model/automation/modifiers/tracktion_RandomModifier.h"
#include "model/automation/modifiers/tracktion_StepModifier.h"
 
#include "model/export/tracktion_Exportable.h"
 
#include "control_surfaces/tracktion_ExternalControllerManager.h"
 
#include "midi/tracktion_Musicality.h"
#include "midi/tracktion_MidiNote.h"
#include "../tracktion_graph/utilities/tracktion_MidiMessageArray.h"
#include "midi/tracktion_ActiveNoteList.h"
 
#include "midi/tracktion_MidiProgramManager.h"
#include "midi/tracktion_MidiControllerEvent.h"
#include "midi/tracktion_MidiSysexEvent.h"
#include "midi/tracktion_MidiExpression.h"
#include "midi/tracktion_MidiChannel.h"
#include "midi/tracktion_MidiList.h"
 
#include "plugins/tracktion_PluginWindowState.h"
#include "plugins/tracktion_Plugin.h"
#include "plugins/tracktion_PluginList.h"
#include "plugins/tracktion_PluginManager.h"
 
#include "project/tracktion_ProjectItem.h"
#include "project/tracktion_ProjectSearchIndex.h"
#include "project/tracktion_Project.h"
#include "project/tracktion_ProjectManager.h"
 
#include "utilities/tracktion_PropertyStorage.h"
#include "utilities/tracktion_UIBehaviour.h"
#include "utilities/tracktion_Engine.h"
 
#include "playback/tracktion_LevelMeasurer.h"
 
#include "plugins/external/tracktion_VSTXML.h"
#include "plugins/external/tracktion_ExternalPlugin.h"
 
#include "plugins/internal/tracktion_VCA.h"
#include "plugins/internal/tracktion_VolumeAndPan.h"
#include "plugins/internal/tracktion_RackType.h"
#include "plugins/internal/tracktion_RackInstance.h"
#include "plugins/internal/tracktion_AuxReturn.h"
#include "plugins/internal/tracktion_AuxSend.h"
#include "plugins/effects/tracktion_Equaliser.h"
 
#include "model/clips/tracktion_LaunchHandle.h"
#include "model/edit/tracktion_EditSnapshot.h"
#include "model/edit/tracktion_EditInsertPoint.h"
#include "model/tracks/tracktion_TrackItem.h"
#include "model/tracks/tracktion_Track.h"
#include "model/edit/tracktion_Scene.h"
#include "model/edit/tracktion_TimeSigSetting.h"
#include "model/edit/tracktion_TempoSetting.h"
#include "model/edit/tracktion_TempoSequence.h"
#include "model/edit/tracktion_TimecodeDisplayFormat.h"
#include "model/edit/tracktion_PitchSetting.h"
#include "model/edit/tracktion_PitchSequence.h"
#include "model/edit/tracktion_Edit.h"
#include "model/edit/tracktion_EditFileOperations.h"
 
#include "playback/tracktion_TransportControl.h"
#include "playback/tracktion_AbletonLink.h"
 
#include "control_surfaces/tracktion_ControlSurface.h"
#include "control_surfaces/tracktion_ExternalController.h"
 
#include "model/clips/tracktion_AudioSegmentList.h"
#include "audio_files/tracktion_LoopInfo.h"
#include "audio_files/tracktion_AudioFile.h"
#include "model/edit/tracktion_SourceFileReference.h"
#include "model/clips/tracktion_FollowActions.h"
#include "model/clips/tracktion_Clip.h"
 
#include "utilities/tracktion_EngineBehaviour.h"
#include "utilities/tracktion_Pitch.h"
 
#include "audio_files/tracktion_AudioFileCache.h"
#include "audio_files/tracktion_SmartThumbnail.h"
#include "audio_files/tracktion_AudioProxyGenerator.h"
#include "audio_files/tracktion_AudioFileManager.h"
#include "audio_files/tracktion_AudioFileWriter.h"
#include "audio_files/tracktion_BufferedAudioReader.h"
 
#include "model/clips/tracktion_CompManager.h"
 
#include "audio_files/tracktion_AudioFormatManager.h"
#include "audio_files/tracktion_AudioFileUtils.h"
#include "audio_files/tracktion_AudioFifo.h"
#include "audio_files/tracktion_RecordingThumbnailManager.h"
#include "audio_files/formats/tracktion_FFmpegEncoderAudioFormat.h"
#include "audio_files/formats/tracktion_FloatAudioFileFormat.h"
#include "audio_files/formats/tracktion_MemoryMappedFileReader.h"
#include "audio_files/formats/tracktion_LAMEManager.h"
#include "audio_files/formats/tracktion_RexFileFormat.h"
 
#include "midi/tracktion_SelectedMidiEvents.h"
 
#include "model/automation/tracktion_AutomationRecordManager.h"
#include "model/automation/tracktion_ParameterChangeHandler.h"
#include "model/automation/tracktion_ParameterControlMappings.h"
 
#include "playback/devices/tracktion_OutputDevice.h"
 
#include "model/tracks/tracktion_TrackOutput.h"
#include "model/clips/tracktion_ClipOwner.h"
#include "model/tracks/tracktion_ClipTrack.h"
#include "model/tracks/tracktion_AudioTrack.h"
 
#include "timestretch/tracktion_BeatDetect.h"
#include "timestretch/tracktion_TimeStretch.h"
#include "timestretch/tracktion_ReadAheadTimeStretcher.h"
 
#include "model/export/tracktion_ArchiveFile.h"
#include "model/export/tracktion_ExportJob.h"
#include "model/export/tracktion_ReferencedMaterialList.h"
#include "model/export/tracktion_Renderer.h"
#include "model/export/tracktion_RenderManager.h"
 
#include "model/edit/tracktion_QuantisationType.h"
 
#include "model/clips/tracktion_WarpTimeManager.h"
#include "model/clips/tracktion_ArrangerClip.h"
#include "model/clips/tracktion_AudioClipBase.h"
#include "model/clips/tracktion_ChordClip.h"
#include "model/clips/tracktion_ClipEffects.h"
#include "model/clips/tracktion_CollectionClip.h"
#include "model/clips/tracktion_ContainerClip.h"
#include "model/clips/tracktion_LauncherClipPlaybackHandle.h"
#include "model/clips/tracktion_MarkerClip.h"
#include "model/clips/tracktion_MidiClip.h"
#include "model/clips/tracktion_ReverseRenderJob.h"
#include "model/clips/tracktion_StepClip.h"
#include "model/clips/tracktion_WarpTimeRenderJob.h"
#include "model/clips/tracktion_WaveAudioClip.h"
 
#include "model/edit/tracktion_GrooveTemplate.h"
#include "model/edit/tracktion_LaunchQuantisation.h"
#include "model/edit/tracktion_MarkerManager.h"
 
#include "model/clips/tracktion_EditClip.h"
 
#include "model/tracks/tracktion_TrackUtils.h"
#include "model/tracks/tracktion_ArrangerTrack.h"
#include "model/tracks/tracktion_AutomationTrack.h"
#include "model/tracks/tracktion_ChordTrack.h"
#include "model/tracks/tracktion_FolderTrack.h"
#include "model/tracks/tracktion_MarkerTrack.h"
#include "model/tracks/tracktion_MasterTrack.h"
#include "model/tracks/tracktion_TempoTrack.h"
#include "model/tracks/tracktion_TrackCompManager.h"
#include "model/export/tracktion_RenderOptions.h"
#include "model/clips/tracktion_EditClipRenderJob.h"
 
#include "selection/tracktion_Clipboard.h"
 
#include "playback/devices/tracktion_InputDevice.h"
#include "playback/devices/tracktion_MidiInputDevice.h"
#include "playback/devices/tracktion_PhysicalMidiInputDevice.h"
#include "playback/devices/tracktion_VirtualMidiInputDevice.h"
#include "playback/devices/tracktion_MidiOutputDevice.h"
#include "playback/devices/tracktion_WaveInputDevice.h"
#include "playback/devices/tracktion_WaveOutputDevice.h"
 
#include "model/tracks/tracktion_ClipSlot.h"
 
#include "model/edit/tracktion_EditUtilities.h"
 
#if JUCE_ANDROID
 #include "playback/tracktion_ScopedSteadyLoad.h"
#endif
 
#include "playback/tracktion_DeviceManager.h"
#include "playback/tracktion_HostedAudioDevice.h"
#include "playback/tracktion_MidiNoteDispatcher.h"
#include "playback/tracktion_EditPlaybackContext.h"
#include "playback/tracktion_EditInputDevices.h"
 
#if TRACKTION_AIR_WINDOWS
#include "plugins/airwindows/tracktion_AirWindows.h"
#endif
 
#include "plugins/internal/tracktion_LevelMeter.h"
#include "plugins/internal/tracktion_FreezePoint.h"
#include "plugins/internal/tracktion_InsertPlugin.h"
#include "plugins/internal/tracktion_ReWirePlugin.h"
#include "plugins/internal/tracktion_TextPlugin.h"
 
#include "plugins/effects/tracktion_Compressor.h"
#include "plugins/effects/tracktion_Delay.h"
#include "plugins/effects/tracktion_Chorus.h"
#include "plugins/effects/tracktion_FourOscPlugin.h"
#include "plugins/effects/tracktion_ImpulseResponsePlugin.h"
#include "plugins/effects/tracktion_LatencyPlugin.h"
#include "plugins/effects/tracktion_LowPass.h"
#include "plugins/effects/tracktion_MidiModifier.h"
#include "plugins/effects/tracktion_MidiPatchBay.h"
#include "plugins/effects/tracktion_PatchBay.h"
#include "plugins/effects/tracktion_Phaser.h"
#include "plugins/effects/tracktion_PitchShift.h"
#include "plugins/effects/tracktion_Reverb.h"
#include "plugins/effects/tracktion_SamplerPlugin.h"
#include "plugins/effects/tracktion_ToneGenerator.h"
 
#include "plugins/cmajor/tracktion_CmajorPluginFormat.h"
 
#include "plugins/ARA/tracktion_MelodyneFileReader.h"
 
#if TRACKTION_ENABLE_CONTROL_SURFACES
 #include "control_surfaces/types/tracktion_NovationAutomap.h"
#endif
 
#include "control_surfaces/tracktion_CustomControlSurface.h"
 
#if TRACKTION_ENABLE_CONTROL_SURFACES
 #include "control_surfaces/types/tracktion_AlphaTrack.h"
 #include "control_surfaces/types/tracktion_MackieC4.h"
 #include "control_surfaces/types/tracktion_MackieMCU.h"
 #include "control_surfaces/types/tracktion_MackieXT.h"
 #include "control_surfaces/types/tracktion_IconProG2.h"
 #include "control_surfaces/types/tracktion_NovationRemoteSl.h"
 #include "control_surfaces/types/tracktion_RemoteSLCompact.h"
 #include "control_surfaces/types/tracktion_Tranzport.h"
#endif
 
#include "model/automation/tracktion_MidiLearn.h"
 
#ifdef __GNUC__
 #pragma GCC diagnostic pop
#endif
 
#endif