4588 |
Compression = (Compression_t) ckScri->ReadUint32(); |
Compression = (Compression_t) ckScri->ReadUint32(); |
4589 |
Encoding = (Encoding_t) ckScri->ReadUint32(); |
Encoding = (Encoding_t) ckScri->ReadUint32(); |
4590 |
Language = (Language_t) ckScri->ReadUint32(); |
Language = (Language_t) ckScri->ReadUint32(); |
4591 |
Bypass = (Language_t) ckScri->ReadUint32() & 1; |
Bypass = ckScri->ReadUint32() & 1; |
4592 |
crc = ckScri->ReadUint32(); |
crc = ckScri->ReadUint32(); |
4593 |
uint32_t nameSize = ckScri->ReadUint32(); |
uint32_t nameSize = ckScri->ReadUint32(); |
4594 |
Name.resize(nameSize, ' '); |
Name.resize(nameSize, ' '); |
4595 |
for (int i = 0; i < nameSize; ++i) |
for (int i = 0; i < nameSize; ++i) |
4596 |
Name[i] = ckScri->ReadUint8(); |
Name[i] = ckScri->ReadUint8(); |
4597 |
|
// check if an uuid was already stored along with this script |
4598 |
|
if (headerSize >= 6*sizeof(int32_t) + nameSize + 16) { // yes ... |
4599 |
|
for (uint i = 0; i < 16; ++i) { |
4600 |
|
Uuid[i] = ckScri->ReadUint8(); |
4601 |
|
} |
4602 |
|
} else { // no uuid yet, generate one now ... |
4603 |
|
GenerateUuid(); |
4604 |
|
} |
4605 |
// to handle potential future extensions of the header |
// to handle potential future extensions of the header |
4606 |
ckScri->SetPos(sizeof(int32_t) + headerSize); |
ckScri->SetPos(sizeof(int32_t) + headerSize); |
4607 |
// read actual script data |
// read actual script data |
4616 |
Bypass = false; |
Bypass = false; |
4617 |
crc = 0; |
crc = 0; |
4618 |
Name = "Unnamed Script"; |
Name = "Unnamed Script"; |
4619 |
|
GenerateUuid(); |
4620 |
} |
} |
4621 |
} |
} |
4622 |
|
|
4671 |
__calculateCRC(&data[0], data.size(), crc); |
__calculateCRC(&data[0], data.size(), crc); |
4672 |
__finalizeCRC(crc); |
__finalizeCRC(crc); |
4673 |
// make sure chunk exists and has the required size |
// make sure chunk exists and has the required size |
4674 |
const file_offset_t chunkSize = (file_offset_t) 7*sizeof(int32_t) + Name.size() + data.size(); |
const file_offset_t chunkSize = |
4675 |
|
(file_offset_t) 7*sizeof(int32_t) + Name.size() + 16 + data.size(); |
4676 |
if (!pChunk) pChunk = pGroup->pList->AddSubChunk(CHUNK_ID_SCRI, chunkSize); |
if (!pChunk) pChunk = pGroup->pList->AddSubChunk(CHUNK_ID_SCRI, chunkSize); |
4677 |
else pChunk->Resize(chunkSize); |
else pChunk->Resize(chunkSize); |
4678 |
// fill the chunk data to be written to disk |
// fill the chunk data to be written to disk |
4679 |
uint8_t* pData = (uint8_t*) pChunk->LoadChunkData(); |
uint8_t* pData = (uint8_t*) pChunk->LoadChunkData(); |
4680 |
int pos = 0; |
int pos = 0; |
4681 |
store32(&pData[pos], uint32_t(6*sizeof(int32_t) + Name.size())); // total header size |
store32(&pData[pos], uint32_t(6*sizeof(int32_t) + Name.size() + 16)); // total header size |
4682 |
pos += sizeof(int32_t); |
pos += sizeof(int32_t); |
4683 |
store32(&pData[pos], Compression); |
store32(&pData[pos], Compression); |
4684 |
pos += sizeof(int32_t); |
pos += sizeof(int32_t); |
4694 |
pos += sizeof(int32_t); |
pos += sizeof(int32_t); |
4695 |
for (int i = 0; i < Name.size(); ++i, ++pos) |
for (int i = 0; i < Name.size(); ++i, ++pos) |
4696 |
pData[pos] = Name[i]; |
pData[pos] = Name[i]; |
4697 |
|
for (int i = 0; i < 16; ++i, ++pos) |
4698 |
|
pData[pos] = Uuid[i]; |
4699 |
for (int i = 0; i < data.size(); ++i, ++pos) |
for (int i = 0; i < data.size(); ++i, ++pos) |
4700 |
pData[pos] = data[i]; |
pData[pos] = data[i]; |
4701 |
} |
} |
4702 |
|
|
4703 |
/** |
/** |
4704 |
|
* Generate a new Universally Unique Identifier (UUID) for this script. |
4705 |
|
*/ |
4706 |
|
void Script::GenerateUuid() { |
4707 |
|
DLS::dlsid_t dlsid; |
4708 |
|
DLS::Resource::GenerateDLSID(&dlsid); |
4709 |
|
Uuid[0] = dlsid.ulData1 & 0xff; |
4710 |
|
Uuid[1] = dlsid.ulData1 >> 8 & 0xff; |
4711 |
|
Uuid[2] = dlsid.ulData1 >> 16 & 0xff; |
4712 |
|
Uuid[3] = dlsid.ulData1 >> 24 & 0xff; |
4713 |
|
Uuid[4] = dlsid.usData2 & 0xff; |
4714 |
|
Uuid[5] = dlsid.usData2 >> 8 & 0xff; |
4715 |
|
Uuid[6] = dlsid.usData3 & 0xff; |
4716 |
|
Uuid[7] = dlsid.usData3 >> 8 & 0xff; |
4717 |
|
Uuid[8] = dlsid.abData[0]; |
4718 |
|
Uuid[9] = dlsid.abData[1]; |
4719 |
|
Uuid[10] = dlsid.abData[2]; |
4720 |
|
Uuid[11] = dlsid.abData[3]; |
4721 |
|
Uuid[12] = dlsid.abData[4]; |
4722 |
|
Uuid[13] = dlsid.abData[5]; |
4723 |
|
Uuid[14] = dlsid.abData[6]; |
4724 |
|
Uuid[15] = dlsid.abData[7]; |
4725 |
|
} |
4726 |
|
|
4727 |
|
/** |
4728 |
* Move this script from its current ScriptGroup to another ScriptGroup |
* Move this script from its current ScriptGroup to another ScriptGroup |
4729 |
* given by @a pGroup. |
* given by @a pGroup. |
4730 |
* |
* |
4994 |
// own gig format extensions |
// own gig format extensions |
4995 |
RIFF::List* lst3LS = insList->GetSubList(LIST_TYPE_3LS); |
RIFF::List* lst3LS = insList->GetSubList(LIST_TYPE_3LS); |
4996 |
if (lst3LS) { |
if (lst3LS) { |
4997 |
|
// script slots (that is references to instrument scripts) |
4998 |
RIFF::Chunk* ckSCSL = lst3LS->GetSubChunk(CHUNK_ID_SCSL); |
RIFF::Chunk* ckSCSL = lst3LS->GetSubChunk(CHUNK_ID_SCSL); |
4999 |
if (ckSCSL) { |
if (ckSCSL) { |
5000 |
ckSCSL->SetPos(0); |
ckSCSL->SetPos(0); |
5014 |
} |
} |
5015 |
} |
} |
5016 |
} |
} |
5017 |
|
|
5018 |
|
// overridden script 'patch' variables |
5019 |
|
RIFF::Chunk* ckSCPV = lst3LS->GetSubChunk(CHUNK_ID_SCPV); |
5020 |
|
if (ckSCPV) { |
5021 |
|
ckSCPV->SetPos(0); |
5022 |
|
|
5023 |
|
int nScripts = ckSCPV->ReadUint32(); |
5024 |
|
for (int iScript = 0; iScript < nScripts; ++iScript) { |
5025 |
|
_UUID uuid; |
5026 |
|
for (int i = 0; i < 16; ++i) |
5027 |
|
uuid[i] = ckSCPV->ReadUint8(); |
5028 |
|
uint slot = ckSCPV->ReadUint32(); |
5029 |
|
ckSCPV->ReadUint32(); // unused, reserved 32 bit |
5030 |
|
int nVars = ckSCPV->ReadUint32(); |
5031 |
|
for (int iVar = 0; iVar < nVars; ++iVar) { |
5032 |
|
uint8_t type = ckSCPV->ReadUint8(); |
5033 |
|
ckSCPV->ReadUint8(); // unused, reserved byte |
5034 |
|
int blobSize = ckSCPV->ReadUint16(); |
5035 |
|
RIFF::file_offset_t pos = ckSCPV->GetPos(); |
5036 |
|
// assuming 1st bit is set in 'type', otherwise blob not |
5037 |
|
// supported for decoding |
5038 |
|
if (type & 1) { |
5039 |
|
String name, value; |
5040 |
|
int len = ckSCPV->ReadUint16(); |
5041 |
|
for (int i = 0; i < len; ++i) |
5042 |
|
name += (char) ckSCPV->ReadUint8(); |
5043 |
|
len = ckSCPV->ReadUint16(); |
5044 |
|
for (int i = 0; i < len; ++i) |
5045 |
|
value += (char) ckSCPV->ReadUint8(); |
5046 |
|
if (!name.empty()) // 'name' should never be empty, but just to be sure |
5047 |
|
scriptVars[uuid][slot][name] = value; |
5048 |
|
} |
5049 |
|
// also for potential future extensions: seek forward |
5050 |
|
// according to blob size |
5051 |
|
ckSCPV->SetPos(pos + blobSize); |
5052 |
|
} |
5053 |
|
} |
5054 |
|
} |
5055 |
} |
} |
5056 |
|
|
5057 |
if (pProgress) |
if (pProgress) |
5143 |
|
|
5144 |
RIFF::List* lst3LS = pCkInstrument->GetSubList(LIST_TYPE_3LS); |
RIFF::List* lst3LS = pCkInstrument->GetSubList(LIST_TYPE_3LS); |
5145 |
if (!lst3LS) lst3LS = pCkInstrument->AddSubList(LIST_TYPE_3LS); |
if (!lst3LS) lst3LS = pCkInstrument->AddSubList(LIST_TYPE_3LS); |
5146 |
|
|
5147 |
|
// save script slots (that is references to instrument scripts) |
5148 |
const int slotCount = (int) pScriptRefs->size(); |
const int slotCount = (int) pScriptRefs->size(); |
5149 |
const int headerSize = 3 * sizeof(uint32_t); |
const int headerSize = 3 * sizeof(uint32_t); |
5150 |
const int slotSize = 2 * sizeof(uint32_t); |
const int slotSize = 2 * sizeof(uint32_t); |
5169 |
store32(&pData[pos], (*pScriptRefs)[i].bypass ? 1 : 0); |
store32(&pData[pos], (*pScriptRefs)[i].bypass ? 1 : 0); |
5170 |
pos += sizeof(uint32_t); |
pos += sizeof(uint32_t); |
5171 |
} |
} |
5172 |
|
|
5173 |
|
// save overridden script 'patch' variables ... |
5174 |
|
|
5175 |
|
// the actual 'scriptVars' member variable might contain variables of |
5176 |
|
// scripts which are currently no longer assigned to any script slot |
5177 |
|
// of this instrument, we need to get rid of these variables here to |
5178 |
|
// prevent saving those persistently, however instead of touching the |
5179 |
|
// member variable 'scriptVars' directly, rather strip a separate |
5180 |
|
// copy such that the overridden values are not lost during an |
5181 |
|
// instrument editor session (i.e. if script might be re-assigned) |
5182 |
|
_VarsByScript vars = stripScriptVars(); |
5183 |
|
if (!vars.empty()) { |
5184 |
|
// determine total size required for 'SCPV' RIFF chunk, and the |
5185 |
|
// total amount of scripts being overridden (the latter is |
5186 |
|
// required because a script might be used on several script |
5187 |
|
// slots, hence vars.size() could then not be used here instead) |
5188 |
|
size_t totalChunkSize = 4; |
5189 |
|
size_t totalScriptsOverridden = 0; |
5190 |
|
for (const auto& script : vars) { |
5191 |
|
for (const auto& slot : script.second) { |
5192 |
|
totalScriptsOverridden++; |
5193 |
|
totalChunkSize += 16 + 4 + 4 + 4; |
5194 |
|
for (const auto& var : slot.second) { |
5195 |
|
totalChunkSize += 4 + 2 + var.first.length() + |
5196 |
|
2 + var.second.length(); |
5197 |
|
} |
5198 |
|
} |
5199 |
|
} |
5200 |
|
|
5201 |
|
// ensure 'SCPV' RIFF chunk exists (with required size) |
5202 |
|
RIFF::Chunk* ckSCPV = lst3LS->GetSubChunk(CHUNK_ID_SCPV); |
5203 |
|
if (!ckSCPV) ckSCPV = lst3LS->AddSubChunk(CHUNK_ID_SCPV, totalChunkSize); |
5204 |
|
else ckSCPV->Resize(totalChunkSize); |
5205 |
|
|
5206 |
|
// store the actual data to 'SCPV' RIFF chunk |
5207 |
|
uint8_t* pData = (uint8_t*) ckSCPV->LoadChunkData(); |
5208 |
|
int pos = 0; |
5209 |
|
store32(&pData[pos], (uint32_t) totalScriptsOverridden); // scripts count |
5210 |
|
pos += 4; |
5211 |
|
for (const auto& script : vars) { |
5212 |
|
for (const auto& slot : script.second) { |
5213 |
|
for (int i = 0; i < 16; ++i) |
5214 |
|
pData[pos+i] = script.first[i]; // uuid |
5215 |
|
pos += 16; |
5216 |
|
store32(&pData[pos], (uint32_t) slot.first); // slot index |
5217 |
|
pos += 4; |
5218 |
|
store32(&pData[pos], (uint32_t) 0); // unused, reserved 32 bit |
5219 |
|
pos += 4; |
5220 |
|
store32(&pData[pos], (uint32_t) slot.second.size()); // variables count |
5221 |
|
pos += 4; |
5222 |
|
for (const auto& var : slot.second) { |
5223 |
|
pData[pos++] = 1; // type |
5224 |
|
pData[pos++] = 0; // reserved byte |
5225 |
|
store16(&pData[pos], 2 + var.first.size() + 2 + var.second.size()); // blob size |
5226 |
|
pos += 2; |
5227 |
|
store16(&pData[pos], var.first.size()); // variable name length |
5228 |
|
pos += 2; |
5229 |
|
for (int i = 0; i < var.first.size(); ++i) |
5230 |
|
pData[pos++] = var.first[i]; |
5231 |
|
store16(&pData[pos], var.second.size()); // variable value length |
5232 |
|
pos += 2; |
5233 |
|
for (int i = 0; i < var.second.size(); ++i) |
5234 |
|
pData[pos++] = var.second[i]; |
5235 |
|
} |
5236 |
|
} |
5237 |
|
} |
5238 |
|
} else { |
5239 |
|
// no script variable overridden by this instrument, so get rid |
5240 |
|
// of 'SCPV' RIFF chunk (if any) |
5241 |
|
RIFF::Chunk* ckSCPV = lst3LS->GetSubChunk(CHUNK_ID_SCPV); |
5242 |
|
if (ckSCPV) lst3LS->DeleteSubChunk(ckSCPV); |
5243 |
|
} |
5244 |
} else { |
} else { |
5245 |
// no script slots, so get rid of any LS custom RIFF chunks (if any) |
// no script slots, so get rid of any LS custom RIFF chunks (if any) |
5246 |
RIFF::List* lst3LS = pCkInstrument->GetSubList(LIST_TYPE_3LS); |
RIFF::List* lst3LS = pCkInstrument->GetSubList(LIST_TYPE_3LS); |
5665 |
scriptPoolFileOffsets.at(index).bypass = bBypass; |
scriptPoolFileOffsets.at(index).bypass = bBypass; |
5666 |
} |
} |
5667 |
|
|
5668 |
|
/// type cast (by copy) uint8_t[16] -> std::array<uint8_t,16> |
5669 |
|
inline std::array<uint8_t,16> _UUIDFromCArray(const uint8_t* pData) { |
5670 |
|
std::array<uint8_t,16> uuid; |
5671 |
|
memcpy(&uuid[0], pData, 16); |
5672 |
|
return uuid; |
5673 |
|
} |
5674 |
|
|
5675 |
|
/** |
5676 |
|
* Returns true if this @c Instrument has any script slot which references |
5677 |
|
* the @c Script identified by passed @p uuid. |
5678 |
|
*/ |
5679 |
|
bool Instrument::ReferencesScriptWithUuid(const _UUID& uuid) { |
5680 |
|
const uint nSlots = ScriptSlotCount(); |
5681 |
|
for (uint iSlot = 0; iSlot < nSlots; ++iSlot) |
5682 |
|
if (_UUIDFromCArray(&GetScriptOfSlot(iSlot)->Uuid[0]) == uuid) |
5683 |
|
return true; |
5684 |
|
return false; |
5685 |
|
} |
5686 |
|
|
5687 |
|
/** @brief Checks whether a certain script 'patch' variable value is set. |
5688 |
|
* |
5689 |
|
* Returns @c true if the initial value for the requested script variable is |
5690 |
|
* currently overridden by this instrument. |
5691 |
|
* |
5692 |
|
* @remarks Real-time instrument scripts allow to declare special 'patch' |
5693 |
|
* variables, which essentially behave like regular variables of their data |
5694 |
|
* type, however their initial value may optionally be overridden on a per |
5695 |
|
* instrument basis. That allows to share scripts between instruments while |
5696 |
|
* still being able to fine tune certain aspects of the script for each |
5697 |
|
* instrument individually. |
5698 |
|
* |
5699 |
|
* @note This is an own format extension which did not exist i.e. in the |
5700 |
|
* GigaStudio 4 software. It will currently only work with LinuxSampler and |
5701 |
|
* Gigedit. |
5702 |
|
* |
5703 |
|
* @param slot - script slot index of the variable to be retrieved |
5704 |
|
* @param variable - name of the 'patch' variable in that script |
5705 |
|
*/ |
5706 |
|
bool Instrument::IsScriptPatchVariableSet(int slot, String variable) { |
5707 |
|
if (variable.empty()) return false; |
5708 |
|
Script* script = GetScriptOfSlot(slot); |
5709 |
|
if (!script) return false; |
5710 |
|
const _UUID uuid = _UUIDFromCArray(&script->Uuid[0]); |
5711 |
|
if (!scriptVars.count(uuid)) return false; |
5712 |
|
const _VarsBySlot& slots = scriptVars.find(uuid)->second; |
5713 |
|
if (slots.empty()) return false; |
5714 |
|
if (slots.count(slot)) |
5715 |
|
return slots.find(slot)->second.count(variable); |
5716 |
|
else |
5717 |
|
return slots.begin()->second.count(variable); |
5718 |
|
} |
5719 |
|
|
5720 |
|
/** @brief Get all overridden script 'patch' variables. |
5721 |
|
* |
5722 |
|
* Returns map of key-value pairs reflecting all patch variables currently |
5723 |
|
* being overridden by this instrument for the given script @p slot, where |
5724 |
|
* key is the variable name and value is the hereby currently overridden |
5725 |
|
* value for that variable. |
5726 |
|
* |
5727 |
|
* @remarks Real-time instrument scripts allow to declare special 'patch' |
5728 |
|
* variables, which essentially behave like regular variables of their data |
5729 |
|
* type, however their initial value may optionally be overridden on a per |
5730 |
|
* instrument basis. That allows to share scripts between instruments while |
5731 |
|
* still being able to fine tune certain aspects of the script for each |
5732 |
|
* instrument individually. |
5733 |
|
* |
5734 |
|
* @note This is an own format extension which did not exist i.e. in the |
5735 |
|
* GigaStudio 4 software. It will currently only work with LinuxSampler and |
5736 |
|
* Gigedit. |
5737 |
|
* |
5738 |
|
* @param slot - script slot index of the variable to be retrieved |
5739 |
|
*/ |
5740 |
|
std::map<String,String> Instrument::GetScriptPatchVariables(int slot) { |
5741 |
|
Script* script = GetScriptOfSlot(slot); |
5742 |
|
if (!script) return std::map<String,String>(); |
5743 |
|
const _UUID uuid = _UUIDFromCArray(&script->Uuid[0]); |
5744 |
|
if (!scriptVars.count(uuid)) return std::map<String,String>(); |
5745 |
|
const _VarsBySlot& slots = scriptVars.find(uuid)->second; |
5746 |
|
if (slots.empty()) return std::map<String,String>(); |
5747 |
|
const _PatchVars& vars = |
5748 |
|
(slots.count(slot)) ? |
5749 |
|
slots.find(slot)->second : slots.begin()->second; |
5750 |
|
return vars; |
5751 |
|
} |
5752 |
|
|
5753 |
|
/** @brief Get overridden initial value for 'patch' variable. |
5754 |
|
* |
5755 |
|
* Returns current initial value for the requested script variable being |
5756 |
|
* overridden by this instrument. |
5757 |
|
* |
5758 |
|
* @remarks Real-time instrument scripts allow to declare special 'patch' |
5759 |
|
* variables, which essentially behave like regular variables of their data |
5760 |
|
* type, however their initial value may optionally be overridden on a per |
5761 |
|
* instrument basis. That allows to share scripts between instruments while |
5762 |
|
* still being able to fine tune certain aspects of the script for each |
5763 |
|
* instrument individually. |
5764 |
|
* |
5765 |
|
* @note This is an own format extension which did not exist i.e. in the |
5766 |
|
* GigaStudio 4 software. It will currently only work with LinuxSampler and |
5767 |
|
* Gigedit. |
5768 |
|
* |
5769 |
|
* @param slot - script slot index of the variable to be retrieved |
5770 |
|
* @param variable - name of the 'patch' variable in that script |
5771 |
|
*/ |
5772 |
|
String Instrument::GetScriptPatchVariable(int slot, String variable) { |
5773 |
|
std::map<String,String> vars = GetScriptPatchVariables(slot); |
5774 |
|
return (vars.count(variable)) ? vars.find(variable)->second : ""; |
5775 |
|
} |
5776 |
|
|
5777 |
|
/** @brief Override initial value for 'patch' variable. |
5778 |
|
* |
5779 |
|
* Overrides initial value for the requested script variable for this |
5780 |
|
* instrument with the passed value. |
5781 |
|
* |
5782 |
|
* @remarks Real-time instrument scripts allow to declare special 'patch' |
5783 |
|
* variables, which essentially behave like regular variables of their data |
5784 |
|
* type, however their initial value may optionally be overridden on a per |
5785 |
|
* instrument basis. That allows to share scripts between instruments while |
5786 |
|
* still being able to fine tune certain aspects of the script for each |
5787 |
|
* instrument individually. |
5788 |
|
* |
5789 |
|
* @note This is an own format extension which did not exist i.e. in the |
5790 |
|
* GigaStudio 4 software. It will currently only work with LinuxSampler and |
5791 |
|
* Gigedit. |
5792 |
|
* |
5793 |
|
* @param slot - script slot index of the variable to be set |
5794 |
|
* @param variable - name of the 'patch' variable in that script |
5795 |
|
* @param value - overridden initial value for that script variable |
5796 |
|
* @throws gig::Exception if given script @p slot index is invalid or given |
5797 |
|
* @p variable name is empty |
5798 |
|
*/ |
5799 |
|
void Instrument::SetScriptPatchVariable(int slot, String variable, String value) { |
5800 |
|
if (variable.empty()) |
5801 |
|
throw Exception("Variable name must not be empty"); |
5802 |
|
Script* script = GetScriptOfSlot(slot); |
5803 |
|
if (!script) |
5804 |
|
throw Exception("No script slot with index " + ToString(slot)); |
5805 |
|
const _UUID uuid = _UUIDFromCArray(&script->Uuid[0]); |
5806 |
|
scriptVars[uuid][slot][variable] = value; |
5807 |
|
} |
5808 |
|
|
5809 |
|
/** @brief Drop overridden initial value(s) for 'patch' variable(s). |
5810 |
|
* |
5811 |
|
* Reverts initial value(s) for requested script variable(s) back to their |
5812 |
|
* default initial value(s) defined in the script itself. |
5813 |
|
* |
5814 |
|
* Both arguments of this method are optional. The most obvious use case of |
5815 |
|
* this method would be passing a valid script @p slot index and a |
5816 |
|
* (non-emtpy string as) @p variable name to this method, which would cause |
5817 |
|
* that single variable to be unset for that specific script slot (on this |
5818 |
|
* @c Instrument level). |
5819 |
|
* |
5820 |
|
* Not passing a value (or @c -1 for @p slot and/or empty string for |
5821 |
|
* @p variable) means 'wildcard'. So accordingly absence of argument(s) will |
5822 |
|
* cause all variables and/or for all script slots being unset. Hence this |
5823 |
|
* method serves 2^2 = 4 possible use cases in total and accordingly covers |
5824 |
|
* 4 different behaviours in one method. |
5825 |
|
* |
5826 |
|
* @remarks Real-time instrument scripts allow to declare special 'patch' |
5827 |
|
* variables, which essentially behave like regular variables of their data |
5828 |
|
* type, however their initial value may optionally be overridden on a per |
5829 |
|
* instrument basis. That allows to share scripts between instruments while |
5830 |
|
* still being able to fine tune certain aspects of the script for each |
5831 |
|
* instrument individually. |
5832 |
|
* |
5833 |
|
* @note This is an own format extension which did not exist i.e. in the |
5834 |
|
* GigaStudio 4 software. It will currently only work with LinuxSampler and |
5835 |
|
* Gigedit. |
5836 |
|
* |
5837 |
|
* @param slot - script slot index of the variable to be unset |
5838 |
|
* @param variable - name of the 'patch' variable in that script |
5839 |
|
*/ |
5840 |
|
void Instrument::UnsetScriptPatchVariable(int slot, String variable) { |
5841 |
|
Script* script = GetScriptOfSlot(slot); |
5842 |
|
|
5843 |
|
// option 1: unset a particular variable of one particular script slot |
5844 |
|
if (slot != -1 && !variable.empty()) { |
5845 |
|
if (!script) return; |
5846 |
|
const _UUID uuid = _UUIDFromCArray(&script->Uuid[0]); |
5847 |
|
if (!scriptVars.count(uuid)) return; |
5848 |
|
if (!scriptVars[uuid].count(slot)) return; |
5849 |
|
if (scriptVars[uuid][slot].count(variable)) |
5850 |
|
scriptVars[uuid][slot].erase( |
5851 |
|
scriptVars[uuid][slot].find(variable) |
5852 |
|
); |
5853 |
|
if (scriptVars[uuid][slot].empty()) |
5854 |
|
scriptVars[uuid].erase( scriptVars[uuid].find(slot) ); |
5855 |
|
if (scriptVars[uuid].empty()) |
5856 |
|
scriptVars.erase( scriptVars.find(uuid) ); |
5857 |
|
return; |
5858 |
|
} |
5859 |
|
|
5860 |
|
// option 2: unset all variables of all script slots |
5861 |
|
if (slot == -1 && variable.empty()) { |
5862 |
|
scriptVars.clear(); |
5863 |
|
return; |
5864 |
|
} |
5865 |
|
|
5866 |
|
// option 3: unset all variables of one particular script slot only |
5867 |
|
if (slot != -1) { |
5868 |
|
if (!script) return; |
5869 |
|
const _UUID uuid = _UUIDFromCArray(&script->Uuid[0]); |
5870 |
|
if (scriptVars.count(uuid)) |
5871 |
|
scriptVars.erase( scriptVars.find(uuid) ); |
5872 |
|
return; |
5873 |
|
} |
5874 |
|
|
5875 |
|
// option 4: unset a particular variable of all script slots |
5876 |
|
_VarsByScript::iterator itScript = scriptVars.begin(); |
5877 |
|
_VarsByScript::iterator endScript = scriptVars.end(); |
5878 |
|
while (itScript != endScript) { |
5879 |
|
_VarsBySlot& slots = itScript->second; |
5880 |
|
_VarsBySlot::iterator itSlot = slots.begin(); |
5881 |
|
_VarsBySlot::iterator endSlot = slots.end(); |
5882 |
|
while (itSlot != endSlot) { |
5883 |
|
_PatchVars& vars = itSlot->second; |
5884 |
|
if (vars.count(variable)) |
5885 |
|
vars.erase( vars.find(variable) ); |
5886 |
|
if (vars.empty()) |
5887 |
|
slots.erase(itSlot++); // postfix increment to avoid iterator invalidation |
5888 |
|
else |
5889 |
|
++itSlot; |
5890 |
|
} |
5891 |
|
if (slots.empty()) |
5892 |
|
scriptVars.erase(itScript++); // postfix increment to avoid iterator invalidation |
5893 |
|
else |
5894 |
|
++itScript; |
5895 |
|
} |
5896 |
|
} |
5897 |
|
|
5898 |
|
/** |
5899 |
|
* Returns stripped version of member variable @c scriptVars, where scripts |
5900 |
|
* no longer referenced by this @c Instrument are filtered out, and so are |
5901 |
|
* variables of meanwhile obsolete slots (i.e. a script still being |
5902 |
|
* referenced, but previously overridden on a script slot which either no |
5903 |
|
* longer exists or is hosting another script now). |
5904 |
|
*/ |
5905 |
|
Instrument::_VarsByScript Instrument::stripScriptVars() { |
5906 |
|
_VarsByScript vars; |
5907 |
|
_VarsByScript::const_iterator itScript = scriptVars.begin(); |
5908 |
|
_VarsByScript::const_iterator endScript = scriptVars.end(); |
5909 |
|
for (; itScript != endScript; ++itScript) { |
5910 |
|
const _UUID& uuid = itScript->first; |
5911 |
|
if (!ReferencesScriptWithUuid(uuid)) |
5912 |
|
continue; |
5913 |
|
const _VarsBySlot& slots = itScript->second; |
5914 |
|
_VarsBySlot::const_iterator itSlot = slots.begin(); |
5915 |
|
_VarsBySlot::const_iterator endSlot = slots.end(); |
5916 |
|
for (; itSlot != endSlot; ++itSlot) { |
5917 |
|
Script* script = GetScriptOfSlot(itSlot->first); |
5918 |
|
if (!script) continue; |
5919 |
|
if (_UUIDFromCArray(&script->Uuid[0]) != uuid) continue; |
5920 |
|
if (itSlot->second.empty()) continue; |
5921 |
|
vars[uuid][itSlot->first] = itSlot->second; |
5922 |
|
} |
5923 |
|
} |
5924 |
|
return vars; |
5925 |
|
} |
5926 |
|
|
5927 |
/** |
/** |
5928 |
* Make a (semi) deep copy of the Instrument object given by @a orig |
* Make a (semi) deep copy of the Instrument object given by @a orig |
5929 |
* and assign it to this object. |
* and assign it to this object. |
5958 |
PianoReleaseMode = orig->PianoReleaseMode; |
PianoReleaseMode = orig->PianoReleaseMode; |
5959 |
DimensionKeyRange = orig->DimensionKeyRange; |
DimensionKeyRange = orig->DimensionKeyRange; |
5960 |
scriptPoolFileOffsets = orig->scriptPoolFileOffsets; |
scriptPoolFileOffsets = orig->scriptPoolFileOffsets; |
5961 |
pScriptRefs = orig->pScriptRefs; |
// deep copy of pScriptRefs required (to avoid undefined behaviour) |
5962 |
|
if (pScriptRefs) delete pScriptRefs; |
5963 |
|
pScriptRefs = new std::vector<_ScriptPooolRef>; |
5964 |
|
if (orig->pScriptRefs) |
5965 |
|
*pScriptRefs = *orig->pScriptRefs; |
5966 |
|
scriptVars = orig->scriptVars; |
5967 |
|
|
5968 |
// free old midi rules |
// free old midi rules |
5969 |
for (int i = 0 ; pMidiRules[i] ; i++) { |
for (int i = 0 ; pMidiRules[i] ; i++) { |
6005 |
*/ |
*/ |
6006 |
bool Instrument::UsesAnyGigFormatExtension() const { |
bool Instrument::UsesAnyGigFormatExtension() const { |
6007 |
if (!pRegions) return false; |
if (!pRegions) return false; |
6008 |
|
if (!scriptVars.empty()) return true; |
6009 |
RegionList::const_iterator iter = pRegions->begin(); |
RegionList::const_iterator iter = pRegions->begin(); |
6010 |
RegionList::const_iterator end = pRegions->end(); |
RegionList::const_iterator end = pRegions->end(); |
6011 |
for (; iter != end; ++iter) { |
for (; iter != end; ++iter) { |