|
tracktion-engine 3.0-10-g034fdde4aa5
Tracktion Engine — High level data model for audio applications
« « « Anklang Documentation |
Represents a set of user properties used to control a render operation, using a ValueTree to hold them so that they can be saved and reloaded. More...
#include "tracktion_RenderOptions.h"
Public Types | |
| enum | TargetFileFormat { wav , aiff , flac , ogg , mp3 , midi , numFormats } |
| enum | AddRenderOptions { addTrack , replaceTrack , nextTrack , thisTrack , replaceClips , none } |
| Enum to set the options for renders. More... | |
| enum class | RenderType { editClip , clip , track , midi , allExport } |
| Enum to determine the type of UI this RenderOptions represents. More... | |
Public Member Functions | |
| RenderOptions (Engine &) | |
| RenderOptions (const RenderOptions &, juce::UndoManager *) | |
| RenderOptions (Engine &, const juce::ValueTree &, juce::UndoManager *) | |
| RenderOptions (const RenderOptions &)=delete | |
| RenderOptions (RenderOptions &&)=delete | |
| RenderOptions | operator= (const RenderOptions &)=delete |
| RenderOptions | operator= (RenderOptions &&)=delete |
| void | loadFromUserSettings () |
| void | saveToUserSettings () |
| void | setToDefault () |
| RenderManager::Job::Ptr | performBackgroundRender (Edit &, SelectionManager *, TimeRange timeRangeToRender) |
| Performs the render operation on a background thread. | |
| HashCode | getHash () const noexcept |
| Returns a hash representing the current set of render options. | |
| Renderer::Parameters | getRenderParameters (Edit &, SelectionManager *, TimeRange markedRegion) |
| Returns a set of renderer parameters which can be used to describe a render operation. | |
| Renderer::Parameters | getRenderParameters (Edit &) |
| Renderer::Parameters | getRenderParameters (EditClip &) |
| Renderer::Parameters | getRenderParameters (MidiClip &) |
| juce::AudioFormat * | getAudioFormat () |
| Returns an AudioFormat to use for the current render properties. | |
| Clip::Ptr | applyRenderToEdit (Edit &, ProjectItem::Ptr, TimeRange time, SelectionManager *) const |
| Adds the given ProjectItem to the Edit using the render properties for positioning info. | |
| bool | getUINeedsRefresh () |
| If you've chnaged a property that will cause the UI configuration to change this will return true which you should rebuild the property set from. | |
| void | setUINeedsRefresh () |
| bool | isEditClipRender () const |
| bool | isClipRender () const |
| bool | isTrackRender () const |
| bool | isMidiRender () const |
| bool | isExportAll () const |
| bool | isRender () const |
| TargetFileFormat | setFormat (TargetFileFormat) |
| void | setFormatType (const juce::String &typeString) |
| juce::String | getFormatTypeName (TargetFileFormat) |
| juce::Array< EditItemID > | getTrackIDs () const |
| void | setTrackIDs (const juce::Array< EditItemID > &) |
| HashCode | getTracksHash () const |
| void | setSampleRate (int) |
| void | setBitDepth (int depth) |
| juce::StringArray | getQualitiesList () const |
| int | getQualityIndex () const |
| void | setQualityIndex (int q) |
| juce::File | getDestFile () const noexcept |
| juce::String | getFileExtension () const |
| TargetFileFormat | getFormat () const noexcept |
| int | getBitDepth () const |
| bool | getStereo () const |
| double | getSampleRate () const |
| bool | shouldAddMetadata () const |
| bool | shouldAddAcidMetadata () const |
| juce::BigInteger | getTrackIndexes (const Edit &) const |
| bool | getRemoveSilence () const noexcept |
| bool | getMarkedRegion () const noexcept |
| int | getNumTracks () const noexcept |
| void | setSelected (bool onlySelectedTrackAndClips) |
| void | setMarkedRegion (bool onlyMarked) |
| void | setIncludePlugins (bool includePlugins) |
| void | setAddRenderOption (AddRenderOptions options) |
| void | setEndAllowance (TimeDuration time) |
| void | setFilename (juce::String, bool canPromptToOverwriteExisting) |
| void | updateHash () |
| juce::StringArray | getFormatTypes () |
| juce::StringArray | getAddRenderOptionText () |
Static Public Member Functions | |
| static std::unique_ptr< RenderOptions > | forGeneralExporter (Edit &) |
| Creates a default RenderOptions object for a general purpose exporter. | |
| static std::unique_ptr< RenderOptions > | forTrackRender (juce::Array< Track * > tracks, AddRenderOptions addOption) |
| static std::unique_ptr< RenderOptions > | forClipRender (juce::Array< Clip * > clips, bool midiNotes) |
| static std::unique_ptr< RenderOptions > | forEditClip (Clip &editClip) |
| static TimeDuration | findEndAllowance (Edit &, juce::Array< EditItemID > *tracks, juce::Array< Clip * > *) |
| static bool | isMarkedRegionBigEnough (TimeRange) |
Represents a set of user properties used to control a render operation, using a ValueTree to hold them so that they can be saved and reloaded.
They can also be converted into a set of Renderer::Properties.
Definition at line 19 of file tracktion_RenderOptions.h.
Enum to set the options for renders.
Definition at line 34 of file tracktion_RenderOptions.h.
|
strong |
Enum to determine the type of UI this RenderOptions represents.
Definition at line 96 of file tracktion_RenderOptions.h.
| enum tracktion::engine::RenderOptions::TargetFileFormat |
Definition at line 22 of file tracktion_RenderOptions.h.
| tracktion::engine::RenderOptions::RenderOptions | ( | Engine & | e | ) |
Definition at line 842 of file tracktion_RenderOptions.cpp.
| tracktion::engine::RenderOptions::RenderOptions | ( | const RenderOptions & | other, |
| juce::UndoManager * | um | ||
| ) |
Definition at line 854 of file tracktion_RenderOptions.cpp.
| tracktion::engine::RenderOptions::RenderOptions | ( | Engine & | e, |
| const juce::ValueTree & | s, | ||
| juce::UndoManager * | um | ||
| ) |
Definition at line 847 of file tracktion_RenderOptions.cpp.
|
override |
Definition at line 859 of file tracktion_RenderOptions.cpp.
| Clip::Ptr tracktion::engine::RenderOptions::applyRenderToEdit | ( | Edit & | edit, |
| ProjectItem::Ptr | projectItem, | ||
| TimeRange | time, | ||
| SelectionManager * | selectionManager | ||
| ) | const |
Adds the given ProjectItem to the Edit using the render properties for positioning info.
Definition at line 485 of file tracktion_RenderOptions.cpp.
|
static |
Definition at line 14 of file tracktion_RenderOptions.cpp.
|
static |
Definition at line 779 of file tracktion_RenderOptions.cpp.
|
static |
Definition at line 832 of file tracktion_RenderOptions.cpp.
|
static |
Creates a default RenderOptions object for a general purpose exporter.
Definition at line 737 of file tracktion_RenderOptions.cpp.
|
static |
Definition at line 754 of file tracktion_RenderOptions.cpp.
| juce::StringArray tracktion::engine::RenderOptions::getAddRenderOptionText | ( | ) |
Definition at line 1098 of file tracktion_RenderOptions.cpp.
| juce::AudioFormat * tracktion::engine::RenderOptions::getAudioFormat | ( | ) |
Returns an AudioFormat to use for the current render properties.
Definition at line 461 of file tracktion_RenderOptions.cpp.
| int tracktion::engine::RenderOptions::getBitDepth | ( | ) | const |
Definition at line 132 of file tracktion_RenderOptions.h.
|
noexcept |
Definition at line 128 of file tracktion_RenderOptions.h.
|
noexcept |
Definition at line 131 of file tracktion_RenderOptions.h.
| juce::String tracktion::engine::RenderOptions::getFormatTypeName | ( | TargetFileFormat | fmt | ) |
Definition at line 911 of file tracktion_RenderOptions.cpp.
| juce::StringArray tracktion::engine::RenderOptions::getFormatTypes | ( | ) |
Definition at line 1071 of file tracktion_RenderOptions.cpp.
|
noexcept |
Returns a hash representing the current set of render options.
Definition at line 66 of file tracktion_RenderOptions.h.
|
noexcept |
Definition at line 141 of file tracktion_RenderOptions.h.
|
noexcept |
Definition at line 142 of file tracktion_RenderOptions.h.
| juce::StringArray tracktion::engine::RenderOptions::getQualitiesList | ( | ) | const |
Definition at line 1129 of file tracktion_RenderOptions.cpp.
| int tracktion::engine::RenderOptions::getQualityIndex | ( | ) | const |
Definition at line 125 of file tracktion_RenderOptions.h.
|
noexcept |
Definition at line 140 of file tracktion_RenderOptions.h.
| Renderer::Parameters tracktion::engine::RenderOptions::getRenderParameters | ( | Edit & | edit | ) |
Definition at line 291 of file tracktion_RenderOptions.cpp.
| Renderer::Parameters tracktion::engine::RenderOptions::getRenderParameters | ( | Edit & | edit, |
| SelectionManager * | selectionManager, | ||
| TimeRange | markedRegion | ||
| ) |
Returns a set of renderer parameters which can be used to describe a render operation.
Definition at line 296 of file tracktion_RenderOptions.cpp.
| Renderer::Parameters tracktion::engine::RenderOptions::getRenderParameters | ( | EditClip & | clip | ) |
Definition at line 389 of file tracktion_RenderOptions.cpp.
| Renderer::Parameters tracktion::engine::RenderOptions::getRenderParameters | ( | MidiClip & | clip | ) |
Definition at line 429 of file tracktion_RenderOptions.cpp.
| double tracktion::engine::RenderOptions::getSampleRate | ( | ) | const |
Definition at line 134 of file tracktion_RenderOptions.h.
| bool tracktion::engine::RenderOptions::getStereo | ( | ) | const |
Definition at line 133 of file tracktion_RenderOptions.h.
| juce::Array< EditItemID > tracktion::engine::RenderOptions::getTrackIDs | ( | ) | const |
Definition at line 117 of file tracktion_RenderOptions.h.
| juce::BigInteger tracktion::engine::RenderOptions::getTrackIndexes | ( | const Edit & | ed | ) | const |
Definition at line 959 of file tracktion_RenderOptions.cpp.
| HashCode tracktion::engine::RenderOptions::getTracksHash | ( | ) | const |
Definition at line 936 of file tracktion_RenderOptions.cpp.
| bool tracktion::engine::RenderOptions::getUINeedsRefresh | ( | ) |
If you've chnaged a property that will cause the UI configuration to change this will return true which you should rebuild the property set from.
Definition at line 872 of file tracktion_RenderOptions.cpp.
| bool tracktion::engine::RenderOptions::isClipRender | ( | ) | const |
Definition at line 106 of file tracktion_RenderOptions.h.
| bool tracktion::engine::RenderOptions::isEditClipRender | ( | ) | const |
Definition at line 105 of file tracktion_RenderOptions.h.
| bool tracktion::engine::RenderOptions::isExportAll | ( | ) | const |
Definition at line 109 of file tracktion_RenderOptions.h.
|
static |
Definition at line 1124 of file tracktion_RenderOptions.cpp.
| bool tracktion::engine::RenderOptions::isMidiRender | ( | ) | const |
Definition at line 108 of file tracktion_RenderOptions.h.
| bool tracktion::engine::RenderOptions::isRender | ( | ) | const |
Definition at line 110 of file tracktion_RenderOptions.h.
| bool tracktion::engine::RenderOptions::isTrackRender | ( | ) | const |
Definition at line 107 of file tracktion_RenderOptions.h.
| void tracktion::engine::RenderOptions::loadFromUserSettings | ( | ) |
Definition at line 83 of file tracktion_RenderOptions.cpp.
| RenderManager::Job::Ptr tracktion::engine::RenderOptions::performBackgroundRender | ( | Edit & | edit, |
| SelectionManager * | sm, | ||
| TimeRange | timeRangeToRender | ||
| ) |
Performs the render operation on a background thread.
Definition at line 192 of file tracktion_RenderOptions.cpp.
| void tracktion::engine::RenderOptions::saveToUserSettings | ( | ) |
Definition at line 141 of file tracktion_RenderOptions.cpp.
| void tracktion::engine::RenderOptions::setAddRenderOption | ( | AddRenderOptions | options | ) |
Definition at line 147 of file tracktion_RenderOptions.h.
| void tracktion::engine::RenderOptions::setBitDepth | ( | int | depth | ) |
Definition at line 122 of file tracktion_RenderOptions.h.
| void tracktion::engine::RenderOptions::setEndAllowance | ( | TimeDuration | time | ) |
Definition at line 148 of file tracktion_RenderOptions.h.
| void tracktion::engine::RenderOptions::setFilename | ( | juce::String | value, |
| bool | canPromptToOverwriteExisting | ||
| ) |
Definition at line 978 of file tracktion_RenderOptions.cpp.
| RenderOptions::TargetFileFormat tracktion::engine::RenderOptions::setFormat | ( | TargetFileFormat | f | ) |
Definition at line 882 of file tracktion_RenderOptions.cpp.
| void tracktion::engine::RenderOptions::setFormatType | ( | const juce::String & | typeString | ) |
Definition at line 898 of file tracktion_RenderOptions.cpp.
| void tracktion::engine::RenderOptions::setIncludePlugins | ( | bool | includePlugins | ) |
Definition at line 146 of file tracktion_RenderOptions.h.
| void tracktion::engine::RenderOptions::setMarkedRegion | ( | bool | onlyMarked | ) |
Definition at line 145 of file tracktion_RenderOptions.h.
| void tracktion::engine::RenderOptions::setQualityIndex | ( | int | q | ) |
Definition at line 126 of file tracktion_RenderOptions.h.
| void tracktion::engine::RenderOptions::setSampleRate | ( | int | sr | ) |
Definition at line 946 of file tracktion_RenderOptions.cpp.
| void tracktion::engine::RenderOptions::setSelected | ( | bool | onlySelectedTrackAndClips | ) |
Definition at line 972 of file tracktion_RenderOptions.cpp.
| void tracktion::engine::RenderOptions::setToDefault | ( | ) |
Definition at line 693 of file tracktion_RenderOptions.cpp.
| void tracktion::engine::RenderOptions::setTrackIDs | ( | const juce::Array< EditItemID > & | trackIDs | ) |
Definition at line 928 of file tracktion_RenderOptions.cpp.
| void tracktion::engine::RenderOptions::setUINeedsRefresh | ( | ) |
Definition at line 867 of file tracktion_RenderOptions.cpp.
| bool tracktion::engine::RenderOptions::shouldAddAcidMetadata | ( | ) | const |
Definition at line 137 of file tracktion_RenderOptions.h.
| bool tracktion::engine::RenderOptions::shouldAddMetadata | ( | ) | const |
Definition at line 135 of file tracktion_RenderOptions.h.
| void tracktion::engine::RenderOptions::updateHash | ( | ) |
Definition at line 1147 of file tracktion_RenderOptions.cpp.
| juce::CachedValue<bool> tracktion::engine::RenderOptions::addAcidMetadata |
Definition at line 176 of file tracktion_RenderOptions.h.
| juce::CachedValue<bool> tracktion::engine::RenderOptions::addMetadata |
Definition at line 176 of file tracktion_RenderOptions.h.
| juce::CachedValue<AddRenderOptions> tracktion::engine::RenderOptions::addRenderOptions |
Definition at line 175 of file tracktion_RenderOptions.h.
| juce::CachedValue<bool> tracktion::engine::RenderOptions::addRenderToLibrary |
Definition at line 176 of file tracktion_RenderOptions.h.
| juce::CachedValue<bool> tracktion::engine::RenderOptions::adjustBasedOnRMS |
Definition at line 171 of file tracktion_RenderOptions.h.
| juce::CachedValue<int> tracktion::engine::RenderOptions::bitDepth |
Definition at line 168 of file tracktion_RenderOptions.h.
| juce::CachedValue<bool> tracktion::engine::RenderOptions::createMidiFile |
Definition at line 164 of file tracktion_RenderOptions.h.
| juce::CachedValue<bool> tracktion::engine::RenderOptions::dither |
Definition at line 171 of file tracktion_RenderOptions.h.
| Engine& tracktion::engine::RenderOptions::engine |
Definition at line 159 of file tracktion_RenderOptions.h.
| juce::CachedValue<TargetFileFormat> tracktion::engine::RenderOptions::format |
Definition at line 165 of file tracktion_RenderOptions.h.
| juce::CachedValue<bool> tracktion::engine::RenderOptions::markedRegion |
Definition at line 172 of file tracktion_RenderOptions.h.
| juce::CachedValue<bool> tracktion::engine::RenderOptions::normalise |
Definition at line 171 of file tracktion_RenderOptions.h.
| std::function<void(AudioClipBase&)> tracktion::engine::RenderOptions::offerToAddClipToLibrary |
Definition at line 180 of file tracktion_RenderOptions.h.
| std::function<void(const juce::File&)> tracktion::engine::RenderOptions::offerToAddFileToLibrary |
Definition at line 181 of file tracktion_RenderOptions.h.
| juce::CachedValue<double> tracktion::engine::RenderOptions::peakLevelDb |
Definition at line 169 of file tracktion_RenderOptions.h.
| juce::CachedValue<int> tracktion::engine::RenderOptions::qualityIndex |
Definition at line 168 of file tracktion_RenderOptions.h.
| juce::CachedValue<bool> tracktion::engine::RenderOptions::realTime |
Definition at line 173 of file tracktion_RenderOptions.h.
| juce::CachedValue<bool> tracktion::engine::RenderOptions::removeSilence |
Definition at line 171 of file tracktion_RenderOptions.h.
| juce::CachedValue<bool> tracktion::engine::RenderOptions::reverseRender |
Definition at line 176 of file tracktion_RenderOptions.h.
| juce::CachedValue<double> tracktion::engine::RenderOptions::rmsLevelDb |
Definition at line 169 of file tracktion_RenderOptions.h.
| juce::CachedValue<double> tracktion::engine::RenderOptions::sampleRate |
Definition at line 167 of file tracktion_RenderOptions.h.
| juce::CachedValue<bool> tracktion::engine::RenderOptions::selectedClips |
Definition at line 172 of file tracktion_RenderOptions.h.
| juce::CachedValue<bool> tracktion::engine::RenderOptions::selectedTracks |
Definition at line 172 of file tracktion_RenderOptions.h.
| juce::CachedValue<bool> tracktion::engine::RenderOptions::stereo |
Definition at line 166 of file tracktion_RenderOptions.h.
| juce::CachedValue<juce::String> tracktion::engine::RenderOptions::tracksProperty |
Definition at line 162 of file tracktion_RenderOptions.h.
| juce::CachedValue<bool> tracktion::engine::RenderOptions::tracksToSeparateFiles |
Definition at line 173 of file tracktion_RenderOptions.h.
| juce::CachedValue<RenderType> tracktion::engine::RenderOptions::type |
Definition at line 161 of file tracktion_RenderOptions.h.
| juce::CachedValue<bool> tracktion::engine::RenderOptions::usePlugins |
Definition at line 173 of file tracktion_RenderOptions.h.