The JUCE cross-platform C++ framework, with DISTRHO/KXStudio specific changes
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

2343 lines
88KB

  1. /*
  2. ==============================================================================
  3. This file is part of the JUCE examples.
  4. Copyright (c) 2022 - Raw Material Software Limited
  5. The code included in this file is provided under the terms of the ISC license
  6. http://www.isc.org/downloads/software-support-policy/isc-license. Permission
  7. To use, copy, modify, and/or distribute this software for any purpose with or
  8. without fee is hereby granted provided that the above copyright notice and
  9. this permission notice appear in all copies.
  10. THE SOFTWARE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES,
  11. WHETHER EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR
  12. PURPOSE, ARE DISCLAIMED.
  13. ==============================================================================
  14. */
  15. /*******************************************************************************
  16. The block below describes the properties of this PIP. A PIP is a short snippet
  17. of code that can be read by the Projucer and used to generate a JUCE project.
  18. BEGIN_JUCE_PIP_METADATA
  19. name: ARAPluginDemo
  20. version: 1.0.0
  21. vendor: JUCE
  22. website: http://juce.com
  23. description: Audio plugin using the ARA API.
  24. dependencies: juce_audio_basics, juce_audio_devices, juce_audio_formats,
  25. juce_audio_plugin_client, juce_audio_processors,
  26. juce_audio_utils, juce_core, juce_data_structures,
  27. juce_events, juce_graphics, juce_gui_basics, juce_gui_extra
  28. exporters: xcode_mac, vs2022
  29. moduleFlags: JUCE_STRICT_REFCOUNTEDPOINTER=1
  30. type: AudioProcessor
  31. mainClass: ARADemoPluginAudioProcessor
  32. documentControllerClass: ARADemoPluginDocumentControllerSpecialisation
  33. useLocalCopy: 1
  34. END_JUCE_PIP_METADATA
  35. *******************************************************************************/
  36. #pragma once
  37. #include <ARA_Library/Utilities/ARAPitchInterpretation.h>
  38. #include <ARA_Library/Utilities/ARATimelineConversion.h>
  39. //==============================================================================
  40. class ARADemoPluginAudioModification : public ARAAudioModification
  41. {
  42. public:
  43. ARADemoPluginAudioModification (ARAAudioSource* audioSource,
  44. ARA::ARAAudioModificationHostRef hostRef,
  45. const ARAAudioModification* optionalModificationToClone)
  46. : ARAAudioModification (audioSource, hostRef, optionalModificationToClone)
  47. {
  48. if (optionalModificationToClone != nullptr)
  49. dimmed = static_cast<const ARADemoPluginAudioModification*> (optionalModificationToClone)->dimmed;
  50. }
  51. bool isDimmed() const { return dimmed; }
  52. void setDimmed (bool shouldDim) { dimmed = shouldDim; }
  53. private:
  54. bool dimmed = false;
  55. };
  56. //==============================================================================
  57. struct PreviewState
  58. {
  59. std::atomic<double> previewTime { 0.0 };
  60. std::atomic<ARAPlaybackRegion*> previewedRegion { nullptr };
  61. };
  62. class SharedTimeSliceThread : public TimeSliceThread
  63. {
  64. public:
  65. SharedTimeSliceThread()
  66. : TimeSliceThread (String (JucePlugin_Name) + " ARA Sample Reading Thread")
  67. {
  68. startThread (Priority::high); // Above default priority so playback is fluent, but below realtime
  69. }
  70. };
  71. class AsyncConfigurationCallback : private AsyncUpdater
  72. {
  73. public:
  74. explicit AsyncConfigurationCallback (std::function<void()> callbackIn)
  75. : callback (std::move (callbackIn)) {}
  76. ~AsyncConfigurationCallback() override { cancelPendingUpdate(); }
  77. template <typename RequiresLock>
  78. auto withLock (RequiresLock&& fn)
  79. {
  80. const SpinLock::ScopedTryLockType scope (processingFlag);
  81. return fn (scope.isLocked());
  82. }
  83. void startConfigure() { triggerAsyncUpdate(); }
  84. private:
  85. void handleAsyncUpdate() override
  86. {
  87. const SpinLock::ScopedLockType scope (processingFlag);
  88. callback();
  89. }
  90. std::function<void()> callback;
  91. SpinLock processingFlag;
  92. };
  93. static void crossfade (const float* sourceA,
  94. const float* sourceB,
  95. float aProportionAtStart,
  96. float aProportionAtFinish,
  97. float* destinationBuffer,
  98. int numSamples)
  99. {
  100. AudioBuffer<float> destination { &destinationBuffer, 1, numSamples };
  101. destination.copyFromWithRamp (0, 0, sourceA, numSamples, aProportionAtStart, aProportionAtFinish);
  102. destination.addFromWithRamp (0, 0, sourceB, numSamples, 1.0f - aProportionAtStart, 1.0f - aProportionAtFinish);
  103. }
  104. class Looper
  105. {
  106. public:
  107. Looper() : inputBuffer (nullptr), pos (loopRange.getStart())
  108. {
  109. }
  110. Looper (const AudioBuffer<float>* buffer, Range<int64> range)
  111. : inputBuffer (buffer), loopRange (range), pos (range.getStart())
  112. {
  113. }
  114. void writeInto (AudioBuffer<float>& buffer)
  115. {
  116. if (loopRange.getLength() == 0)
  117. {
  118. buffer.clear();
  119. return;
  120. }
  121. const auto numChannelsToCopy = std::min (inputBuffer->getNumChannels(), buffer.getNumChannels());
  122. const auto actualCrossfadeLengthSamples = std::min (loopRange.getLength() / 2, (int64) desiredCrossfadeLengthSamples);
  123. for (auto samplesCopied = 0; samplesCopied < buffer.getNumSamples();)
  124. {
  125. const auto [needsCrossfade, samplePosOfNextCrossfadeTransition] = [&]() -> std::pair<bool, int64>
  126. {
  127. if (const auto endOfFadeIn = loopRange.getStart() + actualCrossfadeLengthSamples; pos < endOfFadeIn)
  128. return { true, endOfFadeIn };
  129. return { false, loopRange.getEnd() - actualCrossfadeLengthSamples };
  130. }();
  131. const auto samplesToNextCrossfadeTransition = samplePosOfNextCrossfadeTransition - pos;
  132. const auto numSamplesToCopy = std::min (buffer.getNumSamples() - samplesCopied,
  133. (int) samplesToNextCrossfadeTransition);
  134. const auto getFadeInGainAtPos = [this, actualCrossfadeLengthSamples] (auto p)
  135. {
  136. return jmap ((float) p, (float) loopRange.getStart(), (float) loopRange.getStart() + (float) actualCrossfadeLengthSamples - 1.0f, 0.0f, 1.0f);
  137. };
  138. for (int i = 0; i < numChannelsToCopy; ++i)
  139. {
  140. if (needsCrossfade)
  141. {
  142. const auto overlapStart = loopRange.getEnd() - actualCrossfadeLengthSamples
  143. + (pos - loopRange.getStart());
  144. crossfade (inputBuffer->getReadPointer (i, (int) pos),
  145. inputBuffer->getReadPointer (i, (int) overlapStart),
  146. getFadeInGainAtPos (pos),
  147. getFadeInGainAtPos (pos + numSamplesToCopy),
  148. buffer.getWritePointer (i, samplesCopied),
  149. numSamplesToCopy);
  150. }
  151. else
  152. {
  153. buffer.copyFrom (i, samplesCopied, *inputBuffer, i, (int) pos, numSamplesToCopy);
  154. }
  155. }
  156. samplesCopied += numSamplesToCopy;
  157. pos += numSamplesToCopy;
  158. jassert (pos <= loopRange.getEnd() - actualCrossfadeLengthSamples);
  159. if (pos == loopRange.getEnd() - actualCrossfadeLengthSamples)
  160. pos = loopRange.getStart();
  161. }
  162. }
  163. private:
  164. static constexpr int desiredCrossfadeLengthSamples = 50;
  165. const AudioBuffer<float>* inputBuffer;
  166. Range<int64> loopRange;
  167. int64 pos;
  168. };
  169. //==============================================================================
  170. // Returns the modified sample range in the output buffer.
  171. inline std::optional<Range<int64>> readPlaybackRangeIntoBuffer (Range<double> playbackRange,
  172. const ARAPlaybackRegion* playbackRegion,
  173. AudioBuffer<float>& buffer,
  174. const std::function<AudioFormatReader* (ARAAudioSource*)>& getReader)
  175. {
  176. const auto rangeInAudioModificationTime = playbackRange - playbackRegion->getStartInPlaybackTime()
  177. + playbackRegion->getStartInAudioModificationTime();
  178. const auto audioModification = playbackRegion->getAudioModification<ARADemoPluginAudioModification>();
  179. const auto audioSource = audioModification->getAudioSource();
  180. const auto audioModificationSampleRate = audioSource->getSampleRate();
  181. const Range<int64_t> sampleRangeInAudioModification {
  182. ARA::roundSamplePosition (rangeInAudioModificationTime.getStart() * audioModificationSampleRate),
  183. ARA::roundSamplePosition (rangeInAudioModificationTime.getEnd() * audioModificationSampleRate) - 1
  184. };
  185. const auto inputOffset = jlimit ((int64_t) 0, audioSource->getSampleCount(), sampleRangeInAudioModification.getStart());
  186. // With the output offset it can always be said of the output buffer, that the zeroth element
  187. // corresponds to beginning of the playbackRange.
  188. const auto outputOffset = std::max (-sampleRangeInAudioModification.getStart(), (int64_t) 0);
  189. /* TODO: Handle different AudioSource and playback sample rates.
  190. The conversion should be done inside a specialized AudioFormatReader so that we could use
  191. playbackSampleRate everywhere in this function and we could still read `readLength` number of samples
  192. from the source.
  193. The current implementation will be incorrect when sampling rates differ.
  194. */
  195. const auto readLength = [&]
  196. {
  197. const auto sourceReadLength =
  198. std::min (sampleRangeInAudioModification.getEnd(), audioSource->getSampleCount()) - inputOffset;
  199. const auto outputReadLength =
  200. std::min (outputOffset + sourceReadLength, (int64_t) buffer.getNumSamples()) - outputOffset;
  201. return std::min (sourceReadLength, outputReadLength);
  202. }();
  203. if (readLength == 0)
  204. return Range<int64>();
  205. auto* reader = getReader (audioSource);
  206. if (reader != nullptr && reader->read (&buffer, (int) outputOffset, (int) readLength, inputOffset, true, true))
  207. {
  208. if (audioModification->isDimmed())
  209. buffer.applyGain ((int) outputOffset, (int) readLength, 0.25f);
  210. return Range<int64>::withStartAndLength (outputOffset, readLength);
  211. }
  212. return {};
  213. }
  214. class PossiblyBufferedReader
  215. {
  216. public:
  217. PossiblyBufferedReader() = default;
  218. explicit PossiblyBufferedReader (std::unique_ptr<BufferingAudioReader> readerIn)
  219. : setTimeoutFn ([ptr = readerIn.get()] (int ms) { ptr->setReadTimeout (ms); }),
  220. reader (std::move (readerIn))
  221. {}
  222. explicit PossiblyBufferedReader (std::unique_ptr<AudioFormatReader> readerIn)
  223. : setTimeoutFn(),
  224. reader (std::move (readerIn))
  225. {}
  226. void setReadTimeout (int ms)
  227. {
  228. NullCheckedInvocation::invoke (setTimeoutFn, ms);
  229. }
  230. AudioFormatReader* get() const { return reader.get(); }
  231. private:
  232. std::function<void (int)> setTimeoutFn;
  233. std::unique_ptr<AudioFormatReader> reader;
  234. };
  235. struct ProcessingLockInterface
  236. {
  237. virtual ~ProcessingLockInterface() = default;
  238. virtual ScopedTryReadLock getProcessingLock() = 0;
  239. };
  240. //==============================================================================
  241. class PlaybackRenderer : public ARAPlaybackRenderer
  242. {
  243. public:
  244. PlaybackRenderer (ARA::PlugIn::DocumentController* dc, ProcessingLockInterface& lockInterfaceIn)
  245. : ARAPlaybackRenderer (dc), lockInterface (lockInterfaceIn) {}
  246. void prepareToPlay (double sampleRateIn,
  247. int maximumSamplesPerBlockIn,
  248. int numChannelsIn,
  249. AudioProcessor::ProcessingPrecision,
  250. AlwaysNonRealtime alwaysNonRealtime) override
  251. {
  252. numChannels = numChannelsIn;
  253. sampleRate = sampleRateIn;
  254. maximumSamplesPerBlock = maximumSamplesPerBlockIn;
  255. tempBuffer.reset (new AudioBuffer<float> (numChannels, maximumSamplesPerBlock));
  256. useBufferedAudioSourceReader = alwaysNonRealtime == AlwaysNonRealtime::no;
  257. for (const auto playbackRegion : getPlaybackRegions())
  258. {
  259. auto audioSource = playbackRegion->getAudioModification()->getAudioSource();
  260. if (audioSourceReaders.find (audioSource) == audioSourceReaders.end())
  261. {
  262. auto reader = std::make_unique<ARAAudioSourceReader> (audioSource);
  263. if (! useBufferedAudioSourceReader)
  264. {
  265. audioSourceReaders.emplace (audioSource,
  266. PossiblyBufferedReader { std::move (reader) });
  267. }
  268. else
  269. {
  270. const auto readAheadSize = jmax (4 * maximumSamplesPerBlock,
  271. roundToInt (2.0 * sampleRate));
  272. audioSourceReaders.emplace (audioSource,
  273. PossiblyBufferedReader { std::make_unique<BufferingAudioReader> (reader.release(),
  274. *sharedTimesliceThread,
  275. readAheadSize) });
  276. }
  277. }
  278. }
  279. }
  280. void releaseResources() override
  281. {
  282. audioSourceReaders.clear();
  283. tempBuffer.reset();
  284. }
  285. bool processBlock (AudioBuffer<float>& buffer,
  286. AudioProcessor::Realtime realtime,
  287. const AudioPlayHead::PositionInfo& positionInfo) noexcept override
  288. {
  289. const auto lock = lockInterface.getProcessingLock();
  290. if (! lock.isLocked())
  291. return true;
  292. const auto numSamples = buffer.getNumSamples();
  293. jassert (numSamples <= maximumSamplesPerBlock);
  294. jassert (numChannels == buffer.getNumChannels());
  295. jassert (realtime == AudioProcessor::Realtime::no || useBufferedAudioSourceReader);
  296. const auto timeInSamples = positionInfo.getTimeInSamples().orFallback (0);
  297. const auto isPlaying = positionInfo.getIsPlaying();
  298. bool success = true;
  299. bool didRenderAnyRegion = false;
  300. if (isPlaying)
  301. {
  302. const auto blockRange = Range<int64>::withStartAndLength (timeInSamples, numSamples);
  303. for (const auto& playbackRegion : getPlaybackRegions())
  304. {
  305. // Evaluate region borders in song time, calculate sample range to render in song time.
  306. // Note that this example does not use head- or tailtime, so the includeHeadAndTail
  307. // parameter is set to false here - this might need to be adjusted in actual plug-ins.
  308. const auto playbackSampleRange = playbackRegion->getSampleRange (sampleRate, ARAPlaybackRegion::IncludeHeadAndTail::no);
  309. auto renderRange = blockRange.getIntersectionWith (playbackSampleRange);
  310. if (renderRange.isEmpty())
  311. continue;
  312. // Evaluate region borders in modification/source time and calculate offset between
  313. // song and source samples, then clip song samples accordingly
  314. // (if an actual plug-in supports time stretching, this must be taken into account here).
  315. Range<int64> modificationSampleRange { playbackRegion->getStartInAudioModificationSamples(),
  316. playbackRegion->getEndInAudioModificationSamples() };
  317. const auto modificationSampleOffset = modificationSampleRange.getStart() - playbackSampleRange.getStart();
  318. renderRange = renderRange.getIntersectionWith (modificationSampleRange.movedToStartAt (playbackSampleRange.getStart()));
  319. if (renderRange.isEmpty())
  320. continue;
  321. // Get the audio source for the region and find the reader for that source.
  322. // This simplified example code only produces audio if sample rate and channel count match -
  323. // a robust plug-in would need to do conversion, see ARA SDK documentation.
  324. const auto audioSource = playbackRegion->getAudioModification()->getAudioSource();
  325. const auto readerIt = audioSourceReaders.find (audioSource);
  326. if (std::make_tuple (audioSource->getChannelCount(), audioSource->getSampleRate()) != std::make_tuple (numChannels, sampleRate)
  327. || (readerIt == audioSourceReaders.end()))
  328. {
  329. success = false;
  330. continue;
  331. }
  332. auto& reader = readerIt->second;
  333. reader.setReadTimeout (realtime == AudioProcessor::Realtime::no ? 100 : 0);
  334. // Calculate buffer offsets.
  335. const int numSamplesToRead = (int) renderRange.getLength();
  336. const int startInBuffer = (int) (renderRange.getStart() - blockRange.getStart());
  337. auto startInSource = renderRange.getStart() + modificationSampleOffset;
  338. // Read samples:
  339. // first region can write directly into output, later regions need to use local buffer.
  340. auto& readBuffer = (didRenderAnyRegion) ? *tempBuffer : buffer;
  341. if (! reader.get()->read (&readBuffer, startInBuffer, numSamplesToRead, startInSource, true, true))
  342. {
  343. success = false;
  344. continue;
  345. }
  346. // Apply dim if enabled
  347. if (playbackRegion->getAudioModification<ARADemoPluginAudioModification>()->isDimmed())
  348. readBuffer.applyGain (startInBuffer, numSamplesToRead, 0.25f); // dim by about 12 dB
  349. // Mix output of all regions
  350. if (didRenderAnyRegion)
  351. {
  352. // Mix local buffer into the output buffer.
  353. for (int c = 0; c < numChannels; ++c)
  354. buffer.addFrom (c, startInBuffer, *tempBuffer, c, startInBuffer, numSamplesToRead);
  355. }
  356. else
  357. {
  358. // Clear any excess at start or end of the region.
  359. if (startInBuffer != 0)
  360. buffer.clear (0, startInBuffer);
  361. const int endInBuffer = startInBuffer + numSamplesToRead;
  362. const int remainingSamples = numSamples - endInBuffer;
  363. if (remainingSamples != 0)
  364. buffer.clear (endInBuffer, remainingSamples);
  365. didRenderAnyRegion = true;
  366. }
  367. }
  368. }
  369. // If no playback or no region did intersect, clear buffer now.
  370. if (! didRenderAnyRegion)
  371. buffer.clear();
  372. return success;
  373. }
  374. using ARAPlaybackRenderer::processBlock;
  375. private:
  376. //==============================================================================
  377. ProcessingLockInterface& lockInterface;
  378. SharedResourcePointer<SharedTimeSliceThread> sharedTimesliceThread;
  379. std::map<ARAAudioSource*, PossiblyBufferedReader> audioSourceReaders;
  380. bool useBufferedAudioSourceReader = true;
  381. int numChannels = 2;
  382. double sampleRate = 48000.0;
  383. int maximumSamplesPerBlock = 128;
  384. std::unique_ptr<AudioBuffer<float>> tempBuffer;
  385. };
  386. class EditorRenderer : public ARAEditorRenderer,
  387. private ARARegionSequence::Listener
  388. {
  389. public:
  390. EditorRenderer (ARA::PlugIn::DocumentController* documentController,
  391. const PreviewState* previewStateIn,
  392. ProcessingLockInterface& lockInterfaceIn)
  393. : ARAEditorRenderer (documentController),
  394. lockInterface (lockInterfaceIn),
  395. previewState (previewStateIn)
  396. {
  397. jassert (previewState != nullptr);
  398. }
  399. ~EditorRenderer() override
  400. {
  401. for (const auto& rs : regionSequences)
  402. rs->removeListener (this);
  403. }
  404. void didAddPlaybackRegionToRegionSequence (ARARegionSequence*, ARAPlaybackRegion*) override
  405. {
  406. asyncConfigCallback.startConfigure();
  407. }
  408. void didAddRegionSequence (ARA::PlugIn::RegionSequence* rs) noexcept override
  409. {
  410. auto* sequence = static_cast<ARARegionSequence*> (rs);
  411. sequence->addListener (this);
  412. regionSequences.insert (sequence);
  413. asyncConfigCallback.startConfigure();
  414. }
  415. void didAddPlaybackRegion (ARA::PlugIn::PlaybackRegion*) noexcept override
  416. {
  417. asyncConfigCallback.startConfigure();
  418. }
  419. /* An ARA host could be using either the `addPlaybackRegion()` or `addRegionSequence()` interface
  420. so we need to check the other side of both.
  421. The callback must have a signature of `bool (ARAPlaybackRegion*)`
  422. */
  423. template <typename Callback>
  424. void forEachPlaybackRegion (Callback&& cb)
  425. {
  426. for (const auto& playbackRegion : getPlaybackRegions())
  427. if (! cb (playbackRegion))
  428. return;
  429. for (const auto& regionSequence : getRegionSequences())
  430. for (const auto& playbackRegion : regionSequence->getPlaybackRegions())
  431. if (! cb (playbackRegion))
  432. return;
  433. }
  434. void prepareToPlay (double sampleRateIn,
  435. int maximumExpectedSamplesPerBlock,
  436. int numChannels,
  437. AudioProcessor::ProcessingPrecision,
  438. AlwaysNonRealtime alwaysNonRealtime) override
  439. {
  440. sampleRate = sampleRateIn;
  441. previewBuffer = std::make_unique<AudioBuffer<float>> (numChannels, (int) (2 * sampleRateIn));
  442. ignoreUnused (maximumExpectedSamplesPerBlock, alwaysNonRealtime);
  443. }
  444. void releaseResources() override
  445. {
  446. audioSourceReaders.clear();
  447. }
  448. void reset() override
  449. {
  450. previewBuffer->clear();
  451. }
  452. bool processBlock (AudioBuffer<float>& buffer,
  453. AudioProcessor::Realtime realtime,
  454. const AudioPlayHead::PositionInfo& positionInfo) noexcept override
  455. {
  456. ignoreUnused (realtime);
  457. const auto lock = lockInterface.getProcessingLock();
  458. if (! lock.isLocked())
  459. return true;
  460. return asyncConfigCallback.withLock ([&] (bool locked)
  461. {
  462. if (! locked)
  463. return true;
  464. const auto fadeOutIfNecessary = [this, &buffer]
  465. {
  466. if (std::exchange (wasPreviewing, false))
  467. {
  468. previewLooper.writeInto (buffer);
  469. const auto fadeOutStart = std::max (0, buffer.getNumSamples() - 50);
  470. buffer.applyGainRamp (fadeOutStart, buffer.getNumSamples() - fadeOutStart, 1.0f, 0.0f);
  471. }
  472. };
  473. if (positionInfo.getIsPlaying())
  474. {
  475. fadeOutIfNecessary();
  476. return true;
  477. }
  478. if (const auto previewedRegion = previewState->previewedRegion.load())
  479. {
  480. const auto regionIsAssignedToEditor = [&]()
  481. {
  482. bool regionIsAssigned = false;
  483. forEachPlaybackRegion ([&previewedRegion, &regionIsAssigned] (const auto& region)
  484. {
  485. if (region == previewedRegion)
  486. {
  487. regionIsAssigned = true;
  488. return false;
  489. }
  490. return true;
  491. });
  492. return regionIsAssigned;
  493. }();
  494. if (regionIsAssignedToEditor)
  495. {
  496. const auto previewTime = previewState->previewTime.load();
  497. const auto previewDimmed = previewedRegion->getAudioModification<ARADemoPluginAudioModification>()
  498. ->isDimmed();
  499. if (lastPreviewTime != previewTime
  500. || lastPlaybackRegion != previewedRegion
  501. || lastPreviewDimmed != previewDimmed)
  502. {
  503. Range<double> previewRangeInPlaybackTime { previewTime - 0.25, previewTime + 0.25 };
  504. previewBuffer->clear();
  505. const auto rangeInOutput = readPlaybackRangeIntoBuffer (previewRangeInPlaybackTime,
  506. previewedRegion,
  507. *previewBuffer,
  508. [this] (auto* source) -> auto*
  509. {
  510. const auto iter = audioSourceReaders.find (source);
  511. return iter != audioSourceReaders.end() ? iter->second.get() : nullptr;
  512. });
  513. if (rangeInOutput)
  514. {
  515. lastPreviewTime = previewTime;
  516. lastPlaybackRegion = previewedRegion;
  517. lastPreviewDimmed = previewDimmed;
  518. previewLooper = Looper (previewBuffer.get(), *rangeInOutput);
  519. }
  520. }
  521. else
  522. {
  523. previewLooper.writeInto (buffer);
  524. if (! std::exchange (wasPreviewing, true))
  525. {
  526. const auto fadeInLength = std::min (50, buffer.getNumSamples());
  527. buffer.applyGainRamp (0, fadeInLength, 0.0f, 1.0f);
  528. }
  529. }
  530. }
  531. }
  532. else
  533. {
  534. fadeOutIfNecessary();
  535. }
  536. return true;
  537. });
  538. }
  539. using ARAEditorRenderer::processBlock;
  540. private:
  541. void configure()
  542. {
  543. forEachPlaybackRegion ([this, maximumExpectedSamplesPerBlock = 1000] (const auto& playbackRegion)
  544. {
  545. const auto audioSource = playbackRegion->getAudioModification()->getAudioSource();
  546. if (audioSourceReaders.find (audioSource) == audioSourceReaders.end())
  547. {
  548. audioSourceReaders[audioSource] = std::make_unique<BufferingAudioReader> (
  549. new ARAAudioSourceReader (playbackRegion->getAudioModification()->getAudioSource()),
  550. *timeSliceThread,
  551. std::max (4 * maximumExpectedSamplesPerBlock, (int) sampleRate));
  552. }
  553. return true;
  554. });
  555. }
  556. ProcessingLockInterface& lockInterface;
  557. const PreviewState* previewState = nullptr;
  558. AsyncConfigurationCallback asyncConfigCallback { [this] { configure(); } };
  559. double lastPreviewTime = 0.0;
  560. ARAPlaybackRegion* lastPlaybackRegion = nullptr;
  561. bool lastPreviewDimmed = false;
  562. bool wasPreviewing = false;
  563. std::unique_ptr<AudioBuffer<float>> previewBuffer;
  564. Looper previewLooper;
  565. double sampleRate = 48000.0;
  566. SharedResourcePointer<SharedTimeSliceThread> timeSliceThread;
  567. std::map<ARAAudioSource*, std::unique_ptr<BufferingAudioReader>> audioSourceReaders;
  568. std::set<ARARegionSequence*> regionSequences;
  569. };
  570. //==============================================================================
  571. class ARADemoPluginDocumentControllerSpecialisation : public ARADocumentControllerSpecialisation,
  572. private ProcessingLockInterface
  573. {
  574. public:
  575. using ARADocumentControllerSpecialisation::ARADocumentControllerSpecialisation;
  576. PreviewState previewState;
  577. protected:
  578. void willBeginEditing (ARADocument*) override
  579. {
  580. processBlockLock.enterWrite();
  581. }
  582. void didEndEditing (ARADocument*) override
  583. {
  584. processBlockLock.exitWrite();
  585. }
  586. ARAAudioModification* doCreateAudioModification (ARAAudioSource* audioSource,
  587. ARA::ARAAudioModificationHostRef hostRef,
  588. const ARAAudioModification* optionalModificationToClone) noexcept override
  589. {
  590. return new ARADemoPluginAudioModification (audioSource,
  591. hostRef,
  592. static_cast<const ARADemoPluginAudioModification*> (optionalModificationToClone));
  593. }
  594. ARAPlaybackRenderer* doCreatePlaybackRenderer() noexcept override
  595. {
  596. return new PlaybackRenderer (getDocumentController(), *this);
  597. }
  598. EditorRenderer* doCreateEditorRenderer() noexcept override
  599. {
  600. return new EditorRenderer (getDocumentController(), &previewState, *this);
  601. }
  602. bool doRestoreObjectsFromStream (ARAInputStream& input,
  603. const ARARestoreObjectsFilter* filter) noexcept override
  604. {
  605. // Start reading data from the archive, starting with the number of audio modifications in the archive
  606. const auto numAudioModifications = input.readInt64();
  607. // Loop over stored audio modification data
  608. for (int64 i = 0; i < numAudioModifications; ++i)
  609. {
  610. const auto progressVal = (float) i / (float) numAudioModifications;
  611. getDocumentController()->getHostArchivingController()->notifyDocumentUnarchivingProgress (progressVal);
  612. // Read audio modification persistent ID and analysis result from archive
  613. const String persistentID = input.readString();
  614. const bool dimmed = input.readBool();
  615. // Find audio modification to restore the state to (drop state if not to be loaded)
  616. auto audioModification = filter->getAudioModificationToRestoreStateWithID<ARADemoPluginAudioModification> (persistentID.getCharPointer());
  617. if (audioModification == nullptr)
  618. continue;
  619. const bool dimChanged = (dimmed != audioModification->isDimmed());
  620. audioModification->setDimmed (dimmed);
  621. // If the dim state changed, send a sample content change notification without notifying the host
  622. if (dimChanged)
  623. {
  624. audioModification->notifyContentChanged (ARAContentUpdateScopes::samplesAreAffected(), false);
  625. for (auto playbackRegion : audioModification->getPlaybackRegions())
  626. playbackRegion->notifyContentChanged (ARAContentUpdateScopes::samplesAreAffected(), false);
  627. }
  628. }
  629. getDocumentController()->getHostArchivingController()->notifyDocumentUnarchivingProgress (1.0f);
  630. return ! input.failed();
  631. }
  632. bool doStoreObjectsToStream (ARAOutputStream& output, const ARAStoreObjectsFilter* filter) noexcept override
  633. {
  634. // This example implementation only deals with audio modification states
  635. const auto& audioModificationsToPersist { filter->getAudioModificationsToStore<ARADemoPluginAudioModification>() };
  636. const auto reportProgress = [archivingController = getDocumentController()->getHostArchivingController()] (float p)
  637. {
  638. archivingController->notifyDocumentArchivingProgress (p);
  639. };
  640. const ScopeGuard scope { [&reportProgress] { reportProgress (1.0f); } };
  641. // Write the number of audio modifications we are persisting
  642. const auto numAudioModifications = audioModificationsToPersist.size();
  643. if (! output.writeInt64 ((int64) numAudioModifications))
  644. return false;
  645. // For each audio modification to persist, persist its ID followed by whether it's dimmed
  646. for (size_t i = 0; i < numAudioModifications; ++i)
  647. {
  648. // Write persistent ID and dim state
  649. if (! output.writeString (audioModificationsToPersist[i]->getPersistentID()))
  650. return false;
  651. if (! output.writeBool (audioModificationsToPersist[i]->isDimmed()))
  652. return false;
  653. const auto progressVal = (float) i / (float) numAudioModifications;
  654. reportProgress (progressVal);
  655. }
  656. return true;
  657. }
  658. private:
  659. ScopedTryReadLock getProcessingLock() override
  660. {
  661. return ScopedTryReadLock { processBlockLock };
  662. }
  663. ReadWriteLock processBlockLock;
  664. };
  665. struct PlayHeadState
  666. {
  667. void update (const Optional<AudioPlayHead::PositionInfo>& info)
  668. {
  669. if (info.hasValue())
  670. {
  671. isPlaying.store (info->getIsPlaying(), std::memory_order_relaxed);
  672. timeInSeconds.store (info->getTimeInSeconds().orFallback (0), std::memory_order_relaxed);
  673. isLooping.store (info->getIsLooping(), std::memory_order_relaxed);
  674. const auto loopPoints = info->getLoopPoints();
  675. if (loopPoints.hasValue())
  676. {
  677. loopPpqStart = loopPoints->ppqStart;
  678. loopPpqEnd = loopPoints->ppqEnd;
  679. }
  680. }
  681. else
  682. {
  683. isPlaying.store (false, std::memory_order_relaxed);
  684. isLooping.store (false, std::memory_order_relaxed);
  685. }
  686. }
  687. std::atomic<bool> isPlaying { false },
  688. isLooping { false };
  689. std::atomic<double> timeInSeconds { 0.0 },
  690. loopPpqStart { 0.0 },
  691. loopPpqEnd { 0.0 };
  692. };
  693. //==============================================================================
  694. class ARADemoPluginAudioProcessorImpl : public AudioProcessor,
  695. public AudioProcessorARAExtension
  696. {
  697. public:
  698. //==============================================================================
  699. ARADemoPluginAudioProcessorImpl()
  700. : AudioProcessor (getBusesProperties())
  701. {}
  702. ~ARADemoPluginAudioProcessorImpl() override = default;
  703. //==============================================================================
  704. void prepareToPlay (double sampleRate, int samplesPerBlock) override
  705. {
  706. playHeadState.update (nullopt);
  707. prepareToPlayForARA (sampleRate, samplesPerBlock, getMainBusNumOutputChannels(), getProcessingPrecision());
  708. }
  709. void releaseResources() override
  710. {
  711. playHeadState.update (nullopt);
  712. releaseResourcesForARA();
  713. }
  714. bool isBusesLayoutSupported (const BusesLayout& layouts) const override
  715. {
  716. if (layouts.getMainOutputChannelSet() != AudioChannelSet::mono()
  717. && layouts.getMainOutputChannelSet() != AudioChannelSet::stereo())
  718. return false;
  719. return true;
  720. }
  721. void processBlock (AudioBuffer<float>& buffer, MidiBuffer& midiMessages) override
  722. {
  723. ignoreUnused (midiMessages);
  724. ScopedNoDenormals noDenormals;
  725. auto* audioPlayHead = getPlayHead();
  726. playHeadState.update (audioPlayHead->getPosition());
  727. if (! processBlockForARA (buffer, isRealtime(), audioPlayHead))
  728. processBlockBypassed (buffer, midiMessages);
  729. }
  730. using AudioProcessor::processBlock;
  731. //==============================================================================
  732. const String getName() const override { return "ARAPluginDemo"; }
  733. bool acceptsMidi() const override { return true; }
  734. bool producesMidi() const override { return true; }
  735. double getTailLengthSeconds() const override
  736. {
  737. double tail;
  738. if (getTailLengthSecondsForARA (tail))
  739. return tail;
  740. return 0.0;
  741. }
  742. //==============================================================================
  743. int getNumPrograms() override { return 0; }
  744. int getCurrentProgram() override { return 0; }
  745. void setCurrentProgram (int) override {}
  746. const String getProgramName (int) override { return "None"; }
  747. void changeProgramName (int, const String&) override {}
  748. //==============================================================================
  749. void getStateInformation (MemoryBlock&) override {}
  750. void setStateInformation (const void*, int) override {}
  751. PlayHeadState playHeadState;
  752. private:
  753. //==============================================================================
  754. static BusesProperties getBusesProperties()
  755. {
  756. return BusesProperties().withInput ("Input", AudioChannelSet::stereo(), true)
  757. .withOutput ("Output", AudioChannelSet::stereo(), true);
  758. }
  759. JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (ARADemoPluginAudioProcessorImpl)
  760. };
  761. //==============================================================================
  762. class TimeToViewScaling
  763. {
  764. public:
  765. class Listener
  766. {
  767. public:
  768. virtual ~Listener() = default;
  769. virtual void zoomLevelChanged (double newPixelPerSecond) = 0;
  770. };
  771. void addListener (Listener* l) { listeners.add (l); }
  772. void removeListener (Listener* l) { listeners.remove (l); }
  773. TimeToViewScaling() = default;
  774. void zoom (double factor)
  775. {
  776. zoomLevelPixelPerSecond = jlimit (minimumZoom, minimumZoom * 32, zoomLevelPixelPerSecond * factor);
  777. setZoomLevel (zoomLevelPixelPerSecond);
  778. }
  779. void setZoomLevel (double pixelPerSecond)
  780. {
  781. zoomLevelPixelPerSecond = pixelPerSecond;
  782. listeners.call ([this] (Listener& l) { l.zoomLevelChanged (zoomLevelPixelPerSecond); });
  783. }
  784. int getXForTime (double time) const
  785. {
  786. return roundToInt (time * zoomLevelPixelPerSecond);
  787. }
  788. double getTimeForX (int x) const
  789. {
  790. return x / zoomLevelPixelPerSecond;
  791. }
  792. private:
  793. static constexpr auto minimumZoom = 10.0;
  794. double zoomLevelPixelPerSecond = minimumZoom * 4;
  795. ListenerList<Listener> listeners;
  796. };
  797. class RulersView : public Component,
  798. public SettableTooltipClient,
  799. private Timer,
  800. private TimeToViewScaling::Listener,
  801. private ARAMusicalContext::Listener
  802. {
  803. public:
  804. class CycleMarkerComponent : public Component
  805. {
  806. void paint (Graphics& g) override
  807. {
  808. g.setColour (Colours::yellow.darker (0.2f));
  809. const auto bounds = getLocalBounds().toFloat();
  810. g.drawRoundedRectangle (bounds.getX(), bounds.getY(), bounds.getWidth(), bounds.getHeight(), 6.0f, 2.0f);
  811. }
  812. };
  813. RulersView (PlayHeadState& playHeadStateIn, TimeToViewScaling& timeToViewScalingIn, ARADocument& document)
  814. : playHeadState (playHeadStateIn), timeToViewScaling (timeToViewScalingIn), araDocument (document)
  815. {
  816. timeToViewScaling.addListener (this);
  817. addChildComponent (cycleMarker);
  818. cycleMarker.setInterceptsMouseClicks (false, false);
  819. setTooltip ("Double-click to start playback, click to stop playback or to reposition, drag horizontal range to set cycle.");
  820. startTimerHz (30);
  821. }
  822. ~RulersView() override
  823. {
  824. stopTimer();
  825. timeToViewScaling.removeListener (this);
  826. selectMusicalContext (nullptr);
  827. }
  828. void paint (Graphics& g) override
  829. {
  830. auto drawBounds = g.getClipBounds();
  831. const auto drawStartTime = timeToViewScaling.getTimeForX (drawBounds.getX());
  832. const auto drawEndTime = timeToViewScaling.getTimeForX (drawBounds.getRight());
  833. const auto bounds = getLocalBounds();
  834. g.setColour (getLookAndFeel().findColour (ResizableWindow::backgroundColourId));
  835. g.fillRect (bounds);
  836. g.setColour (getLookAndFeel().findColour (ResizableWindow::backgroundColourId).contrasting());
  837. g.drawRect (bounds);
  838. const auto rulerHeight = bounds.getHeight() / 3;
  839. g.drawRect (drawBounds.getX(), rulerHeight, drawBounds.getRight(), rulerHeight);
  840. g.setFont (Font (12.0f));
  841. const int lightLineWidth = 1;
  842. const int heavyLineWidth = 3;
  843. if (selectedMusicalContext != nullptr)
  844. {
  845. const ARA::PlugIn::HostContentReader<ARA::kARAContentTypeTempoEntries> tempoReader (selectedMusicalContext);
  846. const ARA::TempoConverter<decltype (tempoReader)> tempoConverter (tempoReader);
  847. // chord ruler: one rect per chord, skipping empty "no chords"
  848. const auto chordBounds = drawBounds.removeFromTop (rulerHeight);
  849. const ARA::PlugIn::HostContentReader<ARA::kARAContentTypeSheetChords> chordsReader (selectedMusicalContext);
  850. if (tempoReader && chordsReader)
  851. {
  852. const ARA::ChordInterpreter interpreter (true);
  853. for (auto itChord = chordsReader.begin(); itChord != chordsReader.end(); ++itChord)
  854. {
  855. if (interpreter.isNoChord (*itChord))
  856. continue;
  857. const auto chordStartTime = (itChord == chordsReader.begin()) ? 0 : tempoConverter.getTimeForQuarter (itChord->position);
  858. if (chordStartTime >= drawEndTime)
  859. break;
  860. auto chordRect = chordBounds;
  861. chordRect.setLeft (timeToViewScaling.getXForTime (chordStartTime));
  862. if (std::next (itChord) != chordsReader.end())
  863. {
  864. const auto nextChordStartTime = tempoConverter.getTimeForQuarter (std::next (itChord)->position);
  865. if (nextChordStartTime < drawStartTime)
  866. continue;
  867. chordRect.setRight (timeToViewScaling.getXForTime (nextChordStartTime));
  868. }
  869. g.drawRect (chordRect);
  870. g.drawText (convertARAString (interpreter.getNameForChord (*itChord).c_str()),
  871. chordRect.withTrimmedLeft (2),
  872. Justification::centredLeft);
  873. }
  874. }
  875. // beat ruler: evaluates tempo and bar signatures to draw a line for each beat
  876. const ARA::PlugIn::HostContentReader<ARA::kARAContentTypeBarSignatures> barSignaturesReader (selectedMusicalContext);
  877. if (barSignaturesReader)
  878. {
  879. const ARA::BarSignaturesConverter<decltype (barSignaturesReader)> barSignaturesConverter (barSignaturesReader);
  880. const double beatStart = barSignaturesConverter.getBeatForQuarter (tempoConverter.getQuarterForTime (drawStartTime));
  881. const double beatEnd = barSignaturesConverter.getBeatForQuarter (tempoConverter.getQuarterForTime (drawEndTime));
  882. const int endBeat = roundToInt (std::floor (beatEnd));
  883. RectangleList<int> rects;
  884. for (int beat = roundToInt (std::ceil (beatStart)); beat <= endBeat; ++beat)
  885. {
  886. const auto quarterPos = barSignaturesConverter.getQuarterForBeat (beat);
  887. const int x = timeToViewScaling.getXForTime (tempoConverter.getTimeForQuarter (quarterPos));
  888. const auto barSignature = barSignaturesConverter.getBarSignatureForQuarter (quarterPos);
  889. const int lineWidth = (quarterPos == barSignature.position) ? heavyLineWidth : lightLineWidth;
  890. const int beatsSinceBarStart = roundToInt( barSignaturesConverter.getBeatDistanceFromBarStartForQuarter (quarterPos));
  891. const int lineHeight = (beatsSinceBarStart == 0) ? rulerHeight : rulerHeight / 2;
  892. rects.addWithoutMerging (Rectangle<int> (x - lineWidth / 2, 2 * rulerHeight - lineHeight, lineWidth, lineHeight));
  893. }
  894. g.fillRectList (rects);
  895. }
  896. }
  897. // time ruler: one tick for each second
  898. {
  899. RectangleList<int> rects;
  900. for (auto time = std::floor (drawStartTime); time <= drawEndTime; time += 1.0)
  901. {
  902. const int lineWidth = (std::fmod (time, 60.0) <= 0.001) ? heavyLineWidth : lightLineWidth;
  903. const int lineHeight = (std::fmod (time, 10.0) <= 0.001) ? rulerHeight : rulerHeight / 2;
  904. rects.addWithoutMerging (Rectangle<int> (timeToViewScaling.getXForTime (time) - lineWidth / 2,
  905. bounds.getHeight() - lineHeight,
  906. lineWidth,
  907. lineHeight));
  908. }
  909. g.fillRectList (rects);
  910. }
  911. }
  912. void mouseDrag (const MouseEvent& m) override
  913. {
  914. isDraggingCycle = true;
  915. auto cycleRect = getBounds();
  916. cycleRect.setLeft (jmin (m.getMouseDownX(), m.x));
  917. cycleRect.setRight (jmax (m.getMouseDownX(), m.x));
  918. cycleMarker.setBounds (cycleRect);
  919. }
  920. void mouseUp (const MouseEvent& m) override
  921. {
  922. auto playbackController = araDocument.getDocumentController()->getHostPlaybackController();
  923. if (playbackController != nullptr)
  924. {
  925. const auto startTime = timeToViewScaling.getTimeForX (jmin (m.getMouseDownX(), m.x));
  926. const auto endTime = timeToViewScaling.getTimeForX (jmax (m.getMouseDownX(), m.x));
  927. if (playHeadState.isPlaying.load (std::memory_order_relaxed))
  928. playbackController->requestStopPlayback();
  929. else
  930. playbackController->requestSetPlaybackPosition (startTime);
  931. if (isDraggingCycle)
  932. playbackController->requestSetCycleRange (startTime, endTime - startTime);
  933. }
  934. isDraggingCycle = false;
  935. }
  936. void mouseDoubleClick (const MouseEvent&) override
  937. {
  938. if (auto* playbackController = araDocument.getDocumentController()->getHostPlaybackController())
  939. {
  940. if (! playHeadState.isPlaying.load (std::memory_order_relaxed))
  941. playbackController->requestStartPlayback();
  942. }
  943. }
  944. void selectMusicalContext (ARAMusicalContext* newSelectedMusicalContext)
  945. {
  946. if (auto* oldSelection = std::exchange (selectedMusicalContext, newSelectedMusicalContext);
  947. oldSelection != selectedMusicalContext)
  948. {
  949. if (oldSelection != nullptr)
  950. oldSelection->removeListener (this);
  951. if (selectedMusicalContext != nullptr)
  952. selectedMusicalContext->addListener (this);
  953. repaint();
  954. }
  955. }
  956. void zoomLevelChanged (double) override
  957. {
  958. repaint();
  959. }
  960. void doUpdateMusicalContextContent (ARAMusicalContext*, ARAContentUpdateScopes) override
  961. {
  962. repaint();
  963. }
  964. private:
  965. void updateCyclePosition()
  966. {
  967. if (selectedMusicalContext != nullptr)
  968. {
  969. const ARA::PlugIn::HostContentReader<ARA::kARAContentTypeTempoEntries> tempoReader (selectedMusicalContext);
  970. const ARA::TempoConverter<decltype (tempoReader)> tempoConverter (tempoReader);
  971. const auto loopStartTime = tempoConverter.getTimeForQuarter (playHeadState.loopPpqStart.load (std::memory_order_relaxed));
  972. const auto loopEndTime = tempoConverter.getTimeForQuarter (playHeadState.loopPpqEnd.load (std::memory_order_relaxed));
  973. auto cycleRect = getBounds();
  974. cycleRect.setLeft (timeToViewScaling.getXForTime (loopStartTime));
  975. cycleRect.setRight (timeToViewScaling.getXForTime (loopEndTime));
  976. cycleMarker.setVisible (true);
  977. cycleMarker.setBounds (cycleRect);
  978. }
  979. else
  980. {
  981. cycleMarker.setVisible (false);
  982. }
  983. }
  984. void timerCallback() override
  985. {
  986. if (! isDraggingCycle)
  987. updateCyclePosition();
  988. }
  989. private:
  990. PlayHeadState& playHeadState;
  991. TimeToViewScaling& timeToViewScaling;
  992. ARADocument& araDocument;
  993. ARAMusicalContext* selectedMusicalContext = nullptr;
  994. CycleMarkerComponent cycleMarker;
  995. bool isDraggingCycle = false;
  996. };
  997. class RulersHeader : public Component
  998. {
  999. public:
  1000. RulersHeader()
  1001. {
  1002. chordsLabel.setText ("Chords", NotificationType::dontSendNotification);
  1003. addAndMakeVisible (chordsLabel);
  1004. barsLabel.setText ("Bars", NotificationType::dontSendNotification);
  1005. addAndMakeVisible (barsLabel);
  1006. timeLabel.setText ("Time", NotificationType::dontSendNotification);
  1007. addAndMakeVisible (timeLabel);
  1008. }
  1009. void resized() override
  1010. {
  1011. auto bounds = getLocalBounds();
  1012. const auto rulerHeight = bounds.getHeight() / 3;
  1013. for (auto* label : { &chordsLabel, &barsLabel, &timeLabel })
  1014. label->setBounds (bounds.removeFromTop (rulerHeight));
  1015. }
  1016. void paint (Graphics& g) override
  1017. {
  1018. auto bounds = getLocalBounds();
  1019. const auto rulerHeight = bounds.getHeight() / 3;
  1020. g.setColour (getLookAndFeel().findColour (ResizableWindow::backgroundColourId));
  1021. g.fillRect (bounds);
  1022. g.setColour (getLookAndFeel().findColour (ResizableWindow::backgroundColourId).contrasting());
  1023. g.drawRect (bounds);
  1024. bounds.removeFromTop (rulerHeight);
  1025. g.drawRect (bounds.removeFromTop (rulerHeight));
  1026. }
  1027. private:
  1028. Label chordsLabel, barsLabel, timeLabel;
  1029. };
  1030. //==============================================================================
  1031. struct WaveformCache : private ARAAudioSource::Listener
  1032. {
  1033. WaveformCache() : thumbnailCache (20)
  1034. {
  1035. }
  1036. ~WaveformCache() override
  1037. {
  1038. for (const auto& entry : thumbnails)
  1039. {
  1040. entry.first->removeListener (this);
  1041. }
  1042. }
  1043. //==============================================================================
  1044. void willDestroyAudioSource (ARAAudioSource* audioSource) override
  1045. {
  1046. removeAudioSource (audioSource);
  1047. }
  1048. AudioThumbnail& getOrCreateThumbnail (ARAAudioSource* audioSource)
  1049. {
  1050. const auto iter = thumbnails.find (audioSource);
  1051. if (iter != std::end (thumbnails))
  1052. return *iter->second;
  1053. auto thumb = std::make_unique<AudioThumbnail> (128, dummyManager, thumbnailCache);
  1054. auto& result = *thumb;
  1055. ++hash;
  1056. thumb->setReader (new ARAAudioSourceReader (audioSource), hash);
  1057. audioSource->addListener (this);
  1058. thumbnails.emplace (audioSource, std::move (thumb));
  1059. return result;
  1060. }
  1061. private:
  1062. void removeAudioSource (ARAAudioSource* audioSource)
  1063. {
  1064. audioSource->removeListener (this);
  1065. thumbnails.erase (audioSource);
  1066. }
  1067. int64 hash = 0;
  1068. AudioFormatManager dummyManager;
  1069. AudioThumbnailCache thumbnailCache;
  1070. std::map<ARAAudioSource*, std::unique_ptr<AudioThumbnail>> thumbnails;
  1071. };
  1072. class PlaybackRegionView : public Component,
  1073. public ChangeListener,
  1074. public SettableTooltipClient,
  1075. private ARAAudioSource::Listener,
  1076. private ARAPlaybackRegion::Listener,
  1077. private ARAEditorView::Listener
  1078. {
  1079. public:
  1080. PlaybackRegionView (ARAEditorView& editorView, ARAPlaybackRegion& region, WaveformCache& cache)
  1081. : araEditorView (editorView), playbackRegion (region), waveformCache (cache), previewRegionOverlay (*this)
  1082. {
  1083. auto* audioSource = playbackRegion.getAudioModification()->getAudioSource();
  1084. waveformCache.getOrCreateThumbnail (audioSource).addChangeListener (this);
  1085. audioSource->addListener (this);
  1086. playbackRegion.addListener (this);
  1087. araEditorView.addListener (this);
  1088. addAndMakeVisible (previewRegionOverlay);
  1089. setTooltip ("Double-click to toggle dim state of the region, click and hold to prelisten region near click.");
  1090. }
  1091. ~PlaybackRegionView() override
  1092. {
  1093. auto* audioSource = playbackRegion.getAudioModification()->getAudioSource();
  1094. audioSource->removeListener (this);
  1095. playbackRegion.removeListener (this);
  1096. araEditorView.removeListener (this);
  1097. waveformCache.getOrCreateThumbnail (audioSource).removeChangeListener (this);
  1098. }
  1099. void mouseDown (const MouseEvent& m) override
  1100. {
  1101. const auto relativeTime = (double) m.getMouseDownX() / getLocalBounds().getWidth();
  1102. const auto previewTime = playbackRegion.getStartInPlaybackTime()
  1103. + relativeTime * playbackRegion.getDurationInPlaybackTime();
  1104. auto& previewState = ARADocumentControllerSpecialisation::getSpecialisedDocumentController<ARADemoPluginDocumentControllerSpecialisation> (playbackRegion.getDocumentController())->previewState;
  1105. previewState.previewTime.store (previewTime);
  1106. previewState.previewedRegion.store (&playbackRegion);
  1107. previewRegionOverlay.update();
  1108. }
  1109. void mouseUp (const MouseEvent&) override
  1110. {
  1111. auto& previewState = ARADocumentControllerSpecialisation::getSpecialisedDocumentController<ARADemoPluginDocumentControllerSpecialisation> (playbackRegion.getDocumentController())->previewState;
  1112. previewState.previewTime.store (0.0);
  1113. previewState.previewedRegion.store (nullptr);
  1114. previewRegionOverlay.update();
  1115. }
  1116. void mouseDoubleClick (const MouseEvent&) override
  1117. {
  1118. // Set the dim flag on our region's audio modification when double-clicked
  1119. auto audioModification = playbackRegion.getAudioModification<ARADemoPluginAudioModification>();
  1120. audioModification->setDimmed (! audioModification->isDimmed());
  1121. // Send a content change notification for the modification and all associated playback regions
  1122. audioModification->notifyContentChanged (ARAContentUpdateScopes::samplesAreAffected(), true);
  1123. for (auto region : audioModification->getPlaybackRegions())
  1124. region->notifyContentChanged (ARAContentUpdateScopes::samplesAreAffected(), true);
  1125. }
  1126. void changeListenerCallback (ChangeBroadcaster*) override
  1127. {
  1128. repaint();
  1129. }
  1130. void didEnableAudioSourceSamplesAccess (ARAAudioSource*, bool) override
  1131. {
  1132. repaint();
  1133. }
  1134. void willUpdatePlaybackRegionProperties (ARAPlaybackRegion*,
  1135. ARAPlaybackRegion::PropertiesPtr newProperties) override
  1136. {
  1137. if (playbackRegion.getName() != newProperties->name
  1138. || playbackRegion.getColor() != newProperties->color)
  1139. {
  1140. repaint();
  1141. }
  1142. }
  1143. void didUpdatePlaybackRegionContent (ARAPlaybackRegion*, ARAContentUpdateScopes) override
  1144. {
  1145. repaint();
  1146. }
  1147. void onNewSelection (const ARAViewSelection& viewSelection) override
  1148. {
  1149. const auto& selectedPlaybackRegions = viewSelection.getPlaybackRegions();
  1150. const bool selected = std::find (selectedPlaybackRegions.begin(), selectedPlaybackRegions.end(), &playbackRegion) != selectedPlaybackRegions.end();
  1151. if (selected != isSelected)
  1152. {
  1153. isSelected = selected;
  1154. repaint();
  1155. }
  1156. }
  1157. void paint (Graphics& g) override
  1158. {
  1159. g.fillAll (convertOptionalARAColour (playbackRegion.getEffectiveColor(), Colours::black));
  1160. const auto* audioModification = playbackRegion.getAudioModification<ARADemoPluginAudioModification>();
  1161. g.setColour (audioModification->isDimmed() ? Colours::darkgrey.darker() : Colours::darkgrey.brighter());
  1162. if (audioModification->getAudioSource()->isSampleAccessEnabled())
  1163. {
  1164. auto& thumbnail = waveformCache.getOrCreateThumbnail (playbackRegion.getAudioModification()->getAudioSource());
  1165. thumbnail.drawChannels (g,
  1166. getLocalBounds(),
  1167. playbackRegion.getStartInAudioModificationTime(),
  1168. playbackRegion.getEndInAudioModificationTime(),
  1169. 1.0f);
  1170. }
  1171. else
  1172. {
  1173. g.setFont (Font (12.0f));
  1174. g.drawText ("Audio Access Disabled", getLocalBounds(), Justification::centred);
  1175. }
  1176. g.setColour (Colours::white.withMultipliedAlpha (0.9f));
  1177. g.setFont (Font (12.0f));
  1178. g.drawText (convertOptionalARAString (playbackRegion.getEffectiveName()),
  1179. getLocalBounds(),
  1180. Justification::topLeft);
  1181. if (audioModification->isDimmed())
  1182. g.drawText ("DIMMED", getLocalBounds(), Justification::bottomLeft);
  1183. g.setColour (isSelected ? Colours::white : Colours::black);
  1184. g.drawRect (getLocalBounds());
  1185. }
  1186. void resized() override
  1187. {
  1188. repaint();
  1189. }
  1190. private:
  1191. class PreviewRegionOverlay : public Component
  1192. {
  1193. static constexpr auto previewLength = 0.5;
  1194. public:
  1195. PreviewRegionOverlay (PlaybackRegionView& ownerIn) : owner (ownerIn)
  1196. {
  1197. }
  1198. void update()
  1199. {
  1200. const auto& previewState = owner.getDocumentController()->previewState;
  1201. if (previewState.previewedRegion.load() == &owner.playbackRegion)
  1202. {
  1203. const auto previewStartTime = previewState.previewTime.load() - owner.playbackRegion.getStartInPlaybackTime();
  1204. const auto pixelPerSecond = owner.getWidth() / owner.playbackRegion.getDurationInPlaybackTime();
  1205. setBounds (roundToInt ((previewStartTime - previewLength / 2) * pixelPerSecond),
  1206. 0,
  1207. roundToInt (previewLength * pixelPerSecond),
  1208. owner.getHeight());
  1209. setVisible (true);
  1210. }
  1211. else
  1212. {
  1213. setVisible (false);
  1214. }
  1215. repaint();
  1216. }
  1217. void paint (Graphics& g) override
  1218. {
  1219. g.setColour (Colours::yellow.withAlpha (0.5f));
  1220. g.fillRect (getLocalBounds());
  1221. }
  1222. private:
  1223. PlaybackRegionView& owner;
  1224. };
  1225. ARADemoPluginDocumentControllerSpecialisation* getDocumentController() const
  1226. {
  1227. return ARADocumentControllerSpecialisation::getSpecialisedDocumentController<ARADemoPluginDocumentControllerSpecialisation> (playbackRegion.getDocumentController());
  1228. }
  1229. ARAEditorView& araEditorView;
  1230. ARAPlaybackRegion& playbackRegion;
  1231. WaveformCache& waveformCache;
  1232. PreviewRegionOverlay previewRegionOverlay;
  1233. bool isSelected = false;
  1234. };
  1235. class RegionSequenceView : public Component,
  1236. public ChangeBroadcaster,
  1237. private TimeToViewScaling::Listener,
  1238. private ARARegionSequence::Listener,
  1239. private ARAPlaybackRegion::Listener
  1240. {
  1241. public:
  1242. RegionSequenceView (ARAEditorView& editorView, TimeToViewScaling& scaling, ARARegionSequence& rs, WaveformCache& cache)
  1243. : araEditorView (editorView), timeToViewScaling (scaling), regionSequence (rs), waveformCache (cache)
  1244. {
  1245. regionSequence.addListener (this);
  1246. for (auto* playbackRegion : regionSequence.getPlaybackRegions())
  1247. createAndAddPlaybackRegionView (playbackRegion);
  1248. updatePlaybackDuration();
  1249. timeToViewScaling.addListener (this);
  1250. }
  1251. ~RegionSequenceView() override
  1252. {
  1253. timeToViewScaling.removeListener (this);
  1254. regionSequence.removeListener (this);
  1255. for (const auto& it : playbackRegionViews)
  1256. it.first->removeListener (this);
  1257. }
  1258. //==============================================================================
  1259. // ARA Document change callback overrides
  1260. void willUpdateRegionSequenceProperties (ARARegionSequence*,
  1261. ARARegionSequence::PropertiesPtr newProperties) override
  1262. {
  1263. if (regionSequence.getColor() != newProperties->color)
  1264. {
  1265. for (auto& pbr : playbackRegionViews)
  1266. pbr.second->repaint();
  1267. }
  1268. }
  1269. void willRemovePlaybackRegionFromRegionSequence (ARARegionSequence*,
  1270. ARAPlaybackRegion* playbackRegion) override
  1271. {
  1272. playbackRegion->removeListener (this);
  1273. removeChildComponent (playbackRegionViews[playbackRegion].get());
  1274. playbackRegionViews.erase (playbackRegion);
  1275. updatePlaybackDuration();
  1276. }
  1277. void didAddPlaybackRegionToRegionSequence (ARARegionSequence*, ARAPlaybackRegion* playbackRegion) override
  1278. {
  1279. createAndAddPlaybackRegionView (playbackRegion);
  1280. updatePlaybackDuration();
  1281. }
  1282. void willDestroyPlaybackRegion (ARAPlaybackRegion* playbackRegion) override
  1283. {
  1284. playbackRegion->removeListener (this);
  1285. removeChildComponent (playbackRegionViews[playbackRegion].get());
  1286. playbackRegionViews.erase (playbackRegion);
  1287. updatePlaybackDuration();
  1288. }
  1289. void didUpdatePlaybackRegionProperties (ARAPlaybackRegion*) override
  1290. {
  1291. updatePlaybackDuration();
  1292. }
  1293. void zoomLevelChanged (double) override
  1294. {
  1295. resized();
  1296. }
  1297. void resized() override
  1298. {
  1299. for (auto& pbr : playbackRegionViews)
  1300. {
  1301. const auto playbackRegion = pbr.first;
  1302. pbr.second->setBounds (
  1303. getLocalBounds()
  1304. .withTrimmedLeft (timeToViewScaling.getXForTime (playbackRegion->getStartInPlaybackTime()))
  1305. .withWidth (timeToViewScaling.getXForTime (playbackRegion->getDurationInPlaybackTime())));
  1306. }
  1307. }
  1308. auto getPlaybackDuration() const noexcept
  1309. {
  1310. return playbackDuration;
  1311. }
  1312. private:
  1313. void createAndAddPlaybackRegionView (ARAPlaybackRegion* playbackRegion)
  1314. {
  1315. playbackRegionViews[playbackRegion] = std::make_unique<PlaybackRegionView> (araEditorView,
  1316. *playbackRegion,
  1317. waveformCache);
  1318. playbackRegion->addListener (this);
  1319. addAndMakeVisible (*playbackRegionViews[playbackRegion]);
  1320. }
  1321. void updatePlaybackDuration()
  1322. {
  1323. const auto iter = std::max_element (
  1324. playbackRegionViews.begin(),
  1325. playbackRegionViews.end(),
  1326. [] (const auto& a, const auto& b) { return a.first->getEndInPlaybackTime() < b.first->getEndInPlaybackTime(); });
  1327. playbackDuration = iter != playbackRegionViews.end() ? iter->first->getEndInPlaybackTime()
  1328. : 0.0;
  1329. sendChangeMessage();
  1330. }
  1331. ARAEditorView& araEditorView;
  1332. TimeToViewScaling& timeToViewScaling;
  1333. ARARegionSequence& regionSequence;
  1334. WaveformCache& waveformCache;
  1335. std::unordered_map<ARAPlaybackRegion*, std::unique_ptr<PlaybackRegionView>> playbackRegionViews;
  1336. double playbackDuration = 0.0;
  1337. };
  1338. class ZoomControls : public Component
  1339. {
  1340. public:
  1341. ZoomControls()
  1342. {
  1343. addAndMakeVisible (zoomInButton);
  1344. addAndMakeVisible (zoomOutButton);
  1345. }
  1346. void setZoomInCallback (std::function<void()> cb) { zoomInButton.onClick = std::move (cb); }
  1347. void setZoomOutCallback (std::function<void()> cb) { zoomOutButton.onClick = std::move (cb); }
  1348. void resized() override
  1349. {
  1350. FlexBox fb;
  1351. fb.justifyContent = FlexBox::JustifyContent::flexEnd;
  1352. for (auto* button : { &zoomInButton, &zoomOutButton })
  1353. fb.items.add (FlexItem (*button).withMinHeight (30.0f).withMinWidth (30.0f).withMargin ({ 5, 5, 5, 0 }));
  1354. fb.performLayout (getLocalBounds());
  1355. }
  1356. private:
  1357. TextButton zoomInButton { "+" }, zoomOutButton { "-" };
  1358. };
  1359. class PlayheadPositionLabel : public Label,
  1360. private Timer
  1361. {
  1362. public:
  1363. PlayheadPositionLabel (PlayHeadState& playHeadStateIn)
  1364. : playHeadState (playHeadStateIn)
  1365. {
  1366. startTimerHz (30);
  1367. }
  1368. ~PlayheadPositionLabel() override
  1369. {
  1370. stopTimer();
  1371. }
  1372. void selectMusicalContext (ARAMusicalContext* newSelectedMusicalContext)
  1373. {
  1374. selectedMusicalContext = newSelectedMusicalContext;
  1375. }
  1376. private:
  1377. void timerCallback() override
  1378. {
  1379. const auto timePosition = playHeadState.timeInSeconds.load (std::memory_order_relaxed);
  1380. auto text = timeToTimecodeString (timePosition);
  1381. if (playHeadState.isPlaying.load (std::memory_order_relaxed))
  1382. text += " (playing)";
  1383. else
  1384. text += " (stopped)";
  1385. if (selectedMusicalContext != nullptr)
  1386. {
  1387. const ARA::PlugIn::HostContentReader<ARA::kARAContentTypeTempoEntries> tempoReader (selectedMusicalContext);
  1388. const ARA::PlugIn::HostContentReader<ARA::kARAContentTypeBarSignatures> barSignaturesReader (selectedMusicalContext);
  1389. if (tempoReader && barSignaturesReader)
  1390. {
  1391. const ARA::TempoConverter<decltype (tempoReader)> tempoConverter (tempoReader);
  1392. const ARA::BarSignaturesConverter<decltype (barSignaturesReader)> barSignaturesConverter (barSignaturesReader);
  1393. const auto quarterPosition = tempoConverter.getQuarterForTime (timePosition);
  1394. const auto barIndex = barSignaturesConverter.getBarIndexForQuarter (quarterPosition);
  1395. const auto beatDistance = barSignaturesConverter.getBeatDistanceFromBarStartForQuarter (quarterPosition);
  1396. const auto quartersPerBeat = 4.0 / (double) barSignaturesConverter.getBarSignatureForQuarter (quarterPosition).denominator;
  1397. const auto beatIndex = (int) beatDistance;
  1398. const auto tickIndex = juce::roundToInt ((beatDistance - beatIndex) * quartersPerBeat * 960.0);
  1399. text += newLine;
  1400. text += String::formatted ("bar %d | beat %d | tick %03d", (barIndex >= 0) ? barIndex + 1 : barIndex, beatIndex + 1, tickIndex + 1);
  1401. text += " - ";
  1402. const ARA::PlugIn::HostContentReader<ARA::kARAContentTypeSheetChords> chordsReader (selectedMusicalContext);
  1403. if (chordsReader && chordsReader.getEventCount() > 0)
  1404. {
  1405. const auto begin = chordsReader.begin();
  1406. const auto end = chordsReader.end();
  1407. auto it = begin;
  1408. while (it != end && it->position <= quarterPosition)
  1409. ++it;
  1410. if (it != begin)
  1411. --it;
  1412. const ARA::ChordInterpreter interpreter (true);
  1413. text += "chord ";
  1414. text += String (interpreter.getNameForChord (*it));
  1415. }
  1416. else
  1417. {
  1418. text += "(no chords provided)";
  1419. }
  1420. }
  1421. }
  1422. setText (text, NotificationType::dontSendNotification);
  1423. }
  1424. // Copied from AudioPluginDemo.h: quick-and-dirty function to format a timecode string
  1425. static String timeToTimecodeString (double seconds)
  1426. {
  1427. auto millisecs = roundToInt (seconds * 1000.0);
  1428. auto absMillisecs = std::abs (millisecs);
  1429. return String::formatted ("%02d:%02d:%02d.%03d",
  1430. millisecs / 3600000,
  1431. (absMillisecs / 60000) % 60,
  1432. (absMillisecs / 1000) % 60,
  1433. absMillisecs % 1000);
  1434. }
  1435. PlayHeadState& playHeadState;
  1436. ARAMusicalContext* selectedMusicalContext = nullptr;
  1437. };
  1438. class TrackHeader : public Component,
  1439. private ARARegionSequence::Listener,
  1440. private ARAEditorView::Listener
  1441. {
  1442. public:
  1443. TrackHeader (ARAEditorView& editorView, ARARegionSequence& regionSequenceIn)
  1444. : araEditorView (editorView), regionSequence (regionSequenceIn)
  1445. {
  1446. updateTrackName (regionSequence.getName());
  1447. onNewSelection (araEditorView.getViewSelection());
  1448. addAndMakeVisible (trackNameLabel);
  1449. regionSequence.addListener (this);
  1450. araEditorView.addListener (this);
  1451. }
  1452. ~TrackHeader() override
  1453. {
  1454. araEditorView.removeListener (this);
  1455. regionSequence.removeListener (this);
  1456. }
  1457. void willUpdateRegionSequenceProperties (ARARegionSequence*, ARARegionSequence::PropertiesPtr newProperties) override
  1458. {
  1459. if (regionSequence.getName() != newProperties->name)
  1460. updateTrackName (newProperties->name);
  1461. if (regionSequence.getColor() != newProperties->color)
  1462. repaint();
  1463. }
  1464. void resized() override
  1465. {
  1466. trackNameLabel.setBounds (getLocalBounds().reduced (2));
  1467. }
  1468. void paint (Graphics& g) override
  1469. {
  1470. const auto backgroundColour = getLookAndFeel().findColour (ResizableWindow::backgroundColourId);
  1471. g.setColour (isSelected ? backgroundColour.brighter() : backgroundColour);
  1472. g.fillRoundedRectangle (getLocalBounds().reduced (2).toFloat(), 6.0f);
  1473. g.setColour (backgroundColour.contrasting());
  1474. g.drawRoundedRectangle (getLocalBounds().reduced (2).toFloat(), 6.0f, 1.0f);
  1475. if (auto colour = regionSequence.getColor())
  1476. {
  1477. g.setColour (convertARAColour (colour));
  1478. g.fillRect (getLocalBounds().removeFromTop (16).reduced (6));
  1479. g.fillRect (getLocalBounds().removeFromBottom (16).reduced (6));
  1480. }
  1481. }
  1482. void onNewSelection (const ARAViewSelection& viewSelection) override
  1483. {
  1484. const auto& selectedRegionSequences = viewSelection.getRegionSequences();
  1485. const bool selected = std::find (selectedRegionSequences.begin(), selectedRegionSequences.end(), &regionSequence) != selectedRegionSequences.end();
  1486. if (selected != isSelected)
  1487. {
  1488. isSelected = selected;
  1489. repaint();
  1490. }
  1491. }
  1492. private:
  1493. void updateTrackName (ARA::ARAUtf8String optionalName)
  1494. {
  1495. trackNameLabel.setText (optionalName ? optionalName : "No track name",
  1496. NotificationType::dontSendNotification);
  1497. }
  1498. ARAEditorView& araEditorView;
  1499. ARARegionSequence& regionSequence;
  1500. Label trackNameLabel;
  1501. bool isSelected = false;
  1502. };
  1503. constexpr auto trackHeight = 60;
  1504. class VerticalLayoutViewportContent : public Component
  1505. {
  1506. public:
  1507. void resized() override
  1508. {
  1509. auto bounds = getLocalBounds();
  1510. for (auto* component : getChildren())
  1511. {
  1512. component->setBounds (bounds.removeFromTop (trackHeight));
  1513. component->resized();
  1514. }
  1515. }
  1516. };
  1517. class VerticalLayoutViewport : public Viewport
  1518. {
  1519. public:
  1520. VerticalLayoutViewport()
  1521. {
  1522. setViewedComponent (&content, false);
  1523. }
  1524. void paint (Graphics& g) override
  1525. {
  1526. g.fillAll (getLookAndFeel().findColour (ResizableWindow::backgroundColourId).brighter());
  1527. }
  1528. std::function<void (Rectangle<int>)> onVisibleAreaChanged;
  1529. VerticalLayoutViewportContent content;
  1530. private:
  1531. void visibleAreaChanged (const Rectangle<int>& newVisibleArea) override
  1532. {
  1533. NullCheckedInvocation::invoke (onVisibleAreaChanged, newVisibleArea);
  1534. }
  1535. };
  1536. class OverlayComponent : public Component,
  1537. private Timer,
  1538. private TimeToViewScaling::Listener
  1539. {
  1540. public:
  1541. class PlayheadMarkerComponent : public Component
  1542. {
  1543. void paint (Graphics& g) override { g.fillAll (Colours::yellow.darker (0.2f)); }
  1544. };
  1545. OverlayComponent (PlayHeadState& playHeadStateIn, TimeToViewScaling& timeToViewScalingIn)
  1546. : playHeadState (playHeadStateIn), timeToViewScaling (timeToViewScalingIn)
  1547. {
  1548. addChildComponent (playheadMarker);
  1549. setInterceptsMouseClicks (false, false);
  1550. startTimerHz (30);
  1551. timeToViewScaling.addListener (this);
  1552. }
  1553. ~OverlayComponent() override
  1554. {
  1555. timeToViewScaling.removeListener (this);
  1556. stopTimer();
  1557. }
  1558. void resized() override
  1559. {
  1560. updatePlayHeadPosition();
  1561. }
  1562. void setHorizontalOffset (int offset)
  1563. {
  1564. horizontalOffset = offset;
  1565. }
  1566. void setSelectedTimeRange (std::optional<ARA::ARAContentTimeRange> timeRange)
  1567. {
  1568. selectedTimeRange = timeRange;
  1569. repaint();
  1570. }
  1571. void zoomLevelChanged (double) override
  1572. {
  1573. updatePlayHeadPosition();
  1574. repaint();
  1575. }
  1576. void paint (Graphics& g) override
  1577. {
  1578. if (selectedTimeRange)
  1579. {
  1580. auto bounds = getLocalBounds();
  1581. bounds.setLeft (timeToViewScaling.getXForTime (selectedTimeRange->start));
  1582. bounds.setRight (timeToViewScaling.getXForTime (selectedTimeRange->start + selectedTimeRange->duration));
  1583. g.setColour (getLookAndFeel().findColour (ResizableWindow::backgroundColourId).brighter().withAlpha (0.3f));
  1584. g.fillRect (bounds);
  1585. g.setColour (Colours::whitesmoke.withAlpha (0.5f));
  1586. g.drawRect (bounds);
  1587. }
  1588. }
  1589. private:
  1590. void updatePlayHeadPosition()
  1591. {
  1592. if (playHeadState.isPlaying.load (std::memory_order_relaxed))
  1593. {
  1594. const auto markerX = timeToViewScaling.getXForTime (playHeadState.timeInSeconds.load (std::memory_order_relaxed));
  1595. const auto playheadLine = getLocalBounds().withTrimmedLeft ((int) (markerX - markerWidth / 2.0) - horizontalOffset)
  1596. .removeFromLeft ((int) markerWidth);
  1597. playheadMarker.setVisible (true);
  1598. playheadMarker.setBounds (playheadLine);
  1599. }
  1600. else
  1601. {
  1602. playheadMarker.setVisible (false);
  1603. }
  1604. }
  1605. void timerCallback() override
  1606. {
  1607. updatePlayHeadPosition();
  1608. }
  1609. static constexpr double markerWidth = 2.0;
  1610. PlayHeadState& playHeadState;
  1611. TimeToViewScaling& timeToViewScaling;
  1612. int horizontalOffset = 0;
  1613. std::optional<ARA::ARAContentTimeRange> selectedTimeRange;
  1614. PlayheadMarkerComponent playheadMarker;
  1615. };
  1616. class DocumentView : public Component,
  1617. public ChangeListener,
  1618. public ARAMusicalContext::Listener,
  1619. private ARADocument::Listener,
  1620. private ARAEditorView::Listener
  1621. {
  1622. public:
  1623. DocumentView (ARAEditorView& editorView, PlayHeadState& playHeadState)
  1624. : araEditorView (editorView),
  1625. araDocument (*editorView.getDocumentController()->getDocument<ARADocument>()),
  1626. rulersView (playHeadState, timeToViewScaling, araDocument),
  1627. overlay (playHeadState, timeToViewScaling),
  1628. playheadPositionLabel (playHeadState)
  1629. {
  1630. if (araDocument.getMusicalContexts().size() > 0)
  1631. selectMusicalContext (araDocument.getMusicalContexts().front());
  1632. addAndMakeVisible (rulersHeader);
  1633. viewport.content.addAndMakeVisible (rulersView);
  1634. viewport.onVisibleAreaChanged = [this] (const auto& r)
  1635. {
  1636. viewportHeightOffset = r.getY();
  1637. overlay.setHorizontalOffset (r.getX());
  1638. resized();
  1639. };
  1640. addAndMakeVisible (viewport);
  1641. addAndMakeVisible (overlay);
  1642. addAndMakeVisible (playheadPositionLabel);
  1643. zoomControls.setZoomInCallback ([this] { zoom (2.0); });
  1644. zoomControls.setZoomOutCallback ([this] { zoom (0.5); });
  1645. addAndMakeVisible (zoomControls);
  1646. invalidateRegionSequenceViews();
  1647. araDocument.addListener (this);
  1648. araEditorView.addListener (this);
  1649. }
  1650. ~DocumentView() override
  1651. {
  1652. araEditorView.removeListener (this);
  1653. araDocument.removeListener (this);
  1654. selectMusicalContext (nullptr);
  1655. }
  1656. //==============================================================================
  1657. // ARADocument::Listener overrides
  1658. void didAddMusicalContextToDocument (ARADocument*, ARAMusicalContext* musicalContext) override
  1659. {
  1660. if (selectedMusicalContext == nullptr)
  1661. selectMusicalContext (musicalContext);
  1662. }
  1663. void willDestroyMusicalContext (ARAMusicalContext* musicalContext) override
  1664. {
  1665. if (selectedMusicalContext == musicalContext)
  1666. selectMusicalContext (nullptr);
  1667. }
  1668. void didReorderRegionSequencesInDocument (ARADocument*) override
  1669. {
  1670. invalidateRegionSequenceViews();
  1671. }
  1672. void didAddRegionSequenceToDocument (ARADocument*, ARARegionSequence*) override
  1673. {
  1674. invalidateRegionSequenceViews();
  1675. }
  1676. void willRemoveRegionSequenceFromDocument (ARADocument*, ARARegionSequence* regionSequence) override
  1677. {
  1678. removeRegionSequenceView (regionSequence);
  1679. }
  1680. void didEndEditing (ARADocument*) override
  1681. {
  1682. rebuildRegionSequenceViews();
  1683. update();
  1684. }
  1685. //==============================================================================
  1686. void changeListenerCallback (ChangeBroadcaster*) override
  1687. {
  1688. update();
  1689. }
  1690. //==============================================================================
  1691. // ARAEditorView::Listener overrides
  1692. void onNewSelection (const ARAViewSelection& viewSelection) override
  1693. {
  1694. auto getNewSelectedMusicalContext = [&viewSelection]() -> ARAMusicalContext*
  1695. {
  1696. if (! viewSelection.getRegionSequences().empty())
  1697. return viewSelection.getRegionSequences<ARARegionSequence>().front()->getMusicalContext();
  1698. else if (! viewSelection.getPlaybackRegions().empty())
  1699. return viewSelection.getPlaybackRegions<ARAPlaybackRegion>().front()->getRegionSequence()->getMusicalContext();
  1700. return nullptr;
  1701. };
  1702. if (auto* newSelectedMusicalContext = getNewSelectedMusicalContext())
  1703. if (newSelectedMusicalContext != selectedMusicalContext)
  1704. selectMusicalContext (newSelectedMusicalContext);
  1705. if (const auto timeRange = viewSelection.getTimeRange())
  1706. overlay.setSelectedTimeRange (*timeRange);
  1707. else
  1708. overlay.setSelectedTimeRange (std::nullopt);
  1709. }
  1710. void onHideRegionSequences (const std::vector<ARARegionSequence*>& regionSequences) override
  1711. {
  1712. hiddenRegionSequences = regionSequences;
  1713. invalidateRegionSequenceViews();
  1714. }
  1715. //==============================================================================
  1716. void paint (Graphics& g) override
  1717. {
  1718. g.fillAll (getLookAndFeel().findColour (ResizableWindow::backgroundColourId).darker());
  1719. }
  1720. void resized() override
  1721. {
  1722. auto bounds = getLocalBounds();
  1723. FlexBox fb;
  1724. fb.justifyContent = FlexBox::JustifyContent::spaceBetween;
  1725. fb.items.add (FlexItem (playheadPositionLabel).withWidth (450.0f).withMinWidth (250.0f));
  1726. fb.items.add (FlexItem (zoomControls).withMinWidth (80.0f));
  1727. fb.performLayout (bounds.removeFromBottom (40));
  1728. auto headerBounds = bounds.removeFromLeft (headerWidth);
  1729. rulersHeader.setBounds (headerBounds.removeFromTop (trackHeight));
  1730. layOutVertically (headerBounds, trackHeaders, viewportHeightOffset);
  1731. viewport.setBounds (bounds);
  1732. overlay.setBounds (bounds.reduced (1));
  1733. const auto width = jmax (timeToViewScaling.getXForTime (timelineLength), viewport.getWidth());
  1734. const auto height = (int) (regionSequenceViews.size() + 1) * trackHeight;
  1735. viewport.content.setSize (width, height);
  1736. viewport.content.resized();
  1737. }
  1738. //==============================================================================
  1739. static constexpr int headerWidth = 120;
  1740. private:
  1741. struct RegionSequenceViewKey
  1742. {
  1743. explicit RegionSequenceViewKey (ARARegionSequence* regionSequence)
  1744. : orderIndex (regionSequence->getOrderIndex()), sequence (regionSequence)
  1745. {
  1746. }
  1747. bool operator< (const RegionSequenceViewKey& other) const
  1748. {
  1749. return std::tie (orderIndex, sequence) < std::tie (other.orderIndex, other.sequence);
  1750. }
  1751. ARA::ARAInt32 orderIndex;
  1752. ARARegionSequence* sequence;
  1753. };
  1754. void selectMusicalContext (ARAMusicalContext* newSelectedMusicalContext)
  1755. {
  1756. if (auto oldContext = std::exchange (selectedMusicalContext, newSelectedMusicalContext);
  1757. oldContext != selectedMusicalContext)
  1758. {
  1759. if (oldContext != nullptr)
  1760. oldContext->removeListener (this);
  1761. if (selectedMusicalContext != nullptr)
  1762. selectedMusicalContext->addListener (this);
  1763. rulersView.selectMusicalContext (selectedMusicalContext);
  1764. playheadPositionLabel.selectMusicalContext (selectedMusicalContext);
  1765. }
  1766. }
  1767. void zoom (double factor)
  1768. {
  1769. timeToViewScaling.zoom (factor);
  1770. update();
  1771. }
  1772. template <typename T>
  1773. void layOutVertically (Rectangle<int> bounds, T& components, int verticalOffset = 0)
  1774. {
  1775. bounds = bounds.withY (bounds.getY() - verticalOffset).withHeight (bounds.getHeight() + verticalOffset);
  1776. for (auto& component : components)
  1777. {
  1778. component.second->setBounds (bounds.removeFromTop (trackHeight));
  1779. component.second->resized();
  1780. }
  1781. }
  1782. void update()
  1783. {
  1784. timelineLength = 0.0;
  1785. for (const auto& view : regionSequenceViews)
  1786. timelineLength = std::max (timelineLength, view.second->getPlaybackDuration());
  1787. resized();
  1788. }
  1789. void addTrackViews (ARARegionSequence* regionSequence)
  1790. {
  1791. const auto insertIntoMap = [](auto& map, auto key, auto value) -> auto&
  1792. {
  1793. auto it = map.insert ({ std::move (key), std::move (value) });
  1794. return *(it.first->second);
  1795. };
  1796. auto& regionSequenceView = insertIntoMap (
  1797. regionSequenceViews,
  1798. RegionSequenceViewKey { regionSequence },
  1799. std::make_unique<RegionSequenceView> (araEditorView, timeToViewScaling, *regionSequence, waveformCache));
  1800. regionSequenceView.addChangeListener (this);
  1801. viewport.content.addAndMakeVisible (regionSequenceView);
  1802. auto& trackHeader = insertIntoMap (trackHeaders,
  1803. RegionSequenceViewKey { regionSequence },
  1804. std::make_unique<TrackHeader> (araEditorView, *regionSequence));
  1805. addAndMakeVisible (trackHeader);
  1806. }
  1807. void removeRegionSequenceView (ARARegionSequence* regionSequence)
  1808. {
  1809. const auto& view = regionSequenceViews.find (RegionSequenceViewKey { regionSequence });
  1810. if (view != regionSequenceViews.cend())
  1811. {
  1812. removeChildComponent (view->second.get());
  1813. regionSequenceViews.erase (view);
  1814. }
  1815. invalidateRegionSequenceViews();
  1816. }
  1817. void invalidateRegionSequenceViews()
  1818. {
  1819. regionSequenceViewsAreValid = false;
  1820. rebuildRegionSequenceViews();
  1821. }
  1822. void rebuildRegionSequenceViews()
  1823. {
  1824. if (! regionSequenceViewsAreValid && ! araDocument.getDocumentController()->isHostEditingDocument())
  1825. {
  1826. for (auto& view : regionSequenceViews)
  1827. removeChildComponent (view.second.get());
  1828. regionSequenceViews.clear();
  1829. for (auto& view : trackHeaders)
  1830. removeChildComponent (view.second.get());
  1831. trackHeaders.clear();
  1832. for (auto* regionSequence : araDocument.getRegionSequences())
  1833. if (std::find (hiddenRegionSequences.begin(), hiddenRegionSequences.end(), regionSequence) == hiddenRegionSequences.end())
  1834. addTrackViews (regionSequence);
  1835. update();
  1836. regionSequenceViewsAreValid = true;
  1837. }
  1838. }
  1839. ARAEditorView& araEditorView;
  1840. ARADocument& araDocument;
  1841. bool regionSequenceViewsAreValid = false;
  1842. TimeToViewScaling timeToViewScaling;
  1843. double timelineLength = 0.0;
  1844. ARAMusicalContext* selectedMusicalContext = nullptr;
  1845. std::vector<ARARegionSequence*> hiddenRegionSequences;
  1846. WaveformCache waveformCache;
  1847. std::map<RegionSequenceViewKey, std::unique_ptr<TrackHeader>> trackHeaders;
  1848. std::map<RegionSequenceViewKey, std::unique_ptr<RegionSequenceView>> regionSequenceViews;
  1849. RulersHeader rulersHeader;
  1850. RulersView rulersView;
  1851. VerticalLayoutViewport viewport;
  1852. OverlayComponent overlay;
  1853. ZoomControls zoomControls;
  1854. PlayheadPositionLabel playheadPositionLabel;
  1855. TooltipWindow tooltip;
  1856. int viewportHeightOffset = 0;
  1857. };
  1858. class ARADemoPluginProcessorEditor : public AudioProcessorEditor,
  1859. public AudioProcessorEditorARAExtension
  1860. {
  1861. public:
  1862. explicit ARADemoPluginProcessorEditor (ARADemoPluginAudioProcessorImpl& p)
  1863. : AudioProcessorEditor (&p),
  1864. AudioProcessorEditorARAExtension (&p)
  1865. {
  1866. if (auto* editorView = getARAEditorView())
  1867. documentView = std::make_unique<DocumentView> (*editorView, p.playHeadState);
  1868. addAndMakeVisible (documentView.get());
  1869. // ARA requires that plugin editors are resizable to support tight integration
  1870. // into the host UI
  1871. setResizable (true, false);
  1872. setSize (800, 300);
  1873. }
  1874. //==============================================================================
  1875. void paint (Graphics& g) override
  1876. {
  1877. g.fillAll (getLookAndFeel().findColour (ResizableWindow::backgroundColourId));
  1878. if (! isARAEditorView())
  1879. {
  1880. g.setColour (Colours::white);
  1881. g.setFont (15.0f);
  1882. g.drawFittedText ("ARA host isn't detected. This plugin only supports ARA mode",
  1883. getLocalBounds(),
  1884. Justification::centred,
  1885. 1);
  1886. }
  1887. }
  1888. void resized() override
  1889. {
  1890. if (documentView != nullptr)
  1891. documentView->setBounds (getLocalBounds());
  1892. }
  1893. private:
  1894. std::unique_ptr<Component> documentView;
  1895. JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (ARADemoPluginProcessorEditor)
  1896. };
  1897. class ARADemoPluginAudioProcessor : public ARADemoPluginAudioProcessorImpl
  1898. {
  1899. public:
  1900. bool hasEditor() const override { return true; }
  1901. AudioProcessorEditor* createEditor() override { return new ARADemoPluginProcessorEditor (*this); }
  1902. };