From 23ad5e2e3b3693c4b8c8d536da3e2b76aa08633f Mon Sep 17 00:00:00 2001 From: David Rowland Date: Mon, 3 Aug 2026 15:00:11 +0100 Subject: [PATCH 1/5] Engine: Excluded the LFE from the loudness meter's channel weighting BS.1770-4 leaves the LFE out of the loudness sum, but channelWeight gave it the 1.41 surround weight, so a 5.1 file with any real LFE content measured too loud and a LUFS-normalised render of it landed correspondingly quiet. A full-scale LFE alongside a -6 LUFS stereo bed read -0.2 LUFS instead of -6. Plain buffers carry no layout information, so the LFE is found by position: only 5.1 and 7.1 have one and it sits at index 3 in both. --- .../audio_files/tracktion_LoudnessMeter.cpp | 16 +++-- .../tracktion_LoudnessMeter.test.cpp | 67 +++++++++++++++++++ 2 files changed, 79 insertions(+), 4 deletions(-) diff --git a/modules/tracktion_engine/audio_files/tracktion_LoudnessMeter.cpp b/modules/tracktion_engine/audio_files/tracktion_LoudnessMeter.cpp index 3719603a231..9e691345a7c 100644 --- a/modules/tracktion_engine/audio_files/tracktion_LoudnessMeter.cpp +++ b/modules/tracktion_engine/audio_files/tracktion_LoudnessMeter.cpp @@ -24,11 +24,19 @@ namespace loudness_utils return -0.691 + 10.0 * std::log10 (std::max (1.0e-12, power)); } - /** BS.1770 channel weights: 1.0 for left/right/centre, 1.41 for surrounds. - The LFE should be excluded, but plain buffers carry no layout info. + /** BS.1770 channel weights for a buffer in the usual ITU order + (L, R, C, LFE, Ls, Rs...): 1.0 for the front channels, 1.41 for the + surrounds, and the LFE excluded from the measurement entirely. + + Plain buffers carry no layout information, so the LFE has to be found by + position. Only the 5.1 and 7.1 layouts have one, and in both it sits at + index 3; 5.0 and below are taken to have no LFE. */ - static double channelWeight (int channelIndex) + static double channelWeight (int channelIndex, int totalChannels) { + if (totalChannels >= 6 && channelIndex == 3) + return 0.0; + return channelIndex >= 3 ? 1.41 : 1.0; } } @@ -163,7 +171,7 @@ void LoudnessMeter::processChunk (const float* const* channelData, int numChanne const double sample = channelData[ch][startSample + i]; const double filtered = state.highpass.process (state.shelf.process (sample)); - weightedSquares += channelWeight (ch) * filtered * filtered; + weightedSquares += channelWeight (ch, numChannelsToUse) * filtered * filtered; } blockEnergy += weightedSquares; diff --git a/modules/tracktion_engine/audio_files/tracktion_LoudnessMeter.test.cpp b/modules/tracktion_engine/audio_files/tracktion_LoudnessMeter.test.cpp index 0f6efe52231..5e9ea506e85 100644 --- a/modules/tracktion_engine/audio_files/tracktion_LoudnessMeter.test.cpp +++ b/modules/tracktion_engine/audio_files/tracktion_LoudnessMeter.test.cpp @@ -264,6 +264,73 @@ TEST_SUITE ("tracktion_engine") CHECK (readings.integratedValid); } + TEST_CASE ("LoudnessMeter channel weighting excludes the LFE") + { + using namespace loudness_meter_tests; + + // A 5.1 buffer (L, R, C, LFE, Ls, Rs) with a 997Hz tone on whichever + // channels the case asks for, so the weights can be read off the result + auto measure = [] (const std::vector& tonedChannels, float lfeAmplitude) + { + const auto numSamples = 4 * (int) testSampleRate; + juce::AudioBuffer buffer (6, numSamples); + buffer.clear(); + + for (auto ch : tonedChannels) + for (int i = 0; i < numSamples; ++i) + buffer.setSample (ch, i, sine (i, 997.0, ch == 3 ? lfeAmplitude : 0.5f)); + + LoudnessMeter meter; + meter.prepare (testSampleRate, 6, 8192); + processInBlocks (meter, buffer, { 512 }); + + return meter.getReadings(); + }; + + // Two channels at 1.0 weight each: 3.01dB above the -9.03 LUFS a single + // channel of this tone measures + const auto stereoOnly = measure ({ 0, 1 }, 0.0f); + REQUIRE (stereoOnly.integratedValid); + CHECK_EQ (stereoOnly.integratedLufs, doctest::Approx (-6.02).epsilon (0.01)); + + // Adding a full-scale LFE mustn't move the loudness at all + const auto withLFE = measure ({ 0, 1, 3 }, 1.0f); + CHECK_EQ (withLFE.integratedLufs, doctest::Approx (stereoOnly.integratedLufs).epsilon (0.0001)); + CHECK_EQ (withLFE.shortTermLufs, doctest::Approx (stereoOnly.shortTermLufs).epsilon (0.0001)); + CHECK_EQ (withLFE.momentaryLufs, doctest::Approx (stereoOnly.momentaryLufs).epsilon (0.0001)); + + // ...but the channel is genuinely being fed in: peak is measured across + // every channel, so a full-scale LFE still shows up there + CHECK_EQ (withLFE.samplePeakDb, doctest::Approx (0.0).epsilon (0.01)); + CHECK_GT (withLFE.samplePeakDb, stereoOnly.samplePeakDb + 3.0f); + + // A surround at the same level as the front channels adds its 1.41 + // weight, which keeps this from passing if every weight became zero + const auto withSurround = measure ({ 0, 1, 4 }, 0.0f); + CHECK_EQ (withSurround.integratedLufs, doctest::Approx (-3.70).epsilon (0.01)); + CHECK_GT (withSurround.integratedLufs, stereoOnly.integratedLufs + 2.0f); + + // 5.0 has no LFE, so index 3 is a surround there and does count + const auto fiveOh = [] + { + const auto numSamples = 4 * (int) testSampleRate; + juce::AudioBuffer buffer (5, numSamples); + buffer.clear(); + + for (auto ch : { 0, 1, 3 }) + for (int i = 0; i < numSamples; ++i) + buffer.setSample (ch, i, sine (i, 997.0, 0.5f)); + + LoudnessMeter meter; + meter.prepare (testSampleRate, 5, 8192); + processInBlocks (meter, buffer, { 512 }); + + return meter.getReadings(); + }(); + + CHECK_EQ (fiveOh.integratedLufs, doctest::Approx (-3.70).epsilon (0.01)); + } + TEST_CASE ("LoudnessMeter is invariant to the block sizes it's fed") { using namespace loudness_meter_tests; From 6bc1dc9a8fe1b1758a92501a44054ca5e7e125ab Mon Sep 17 00:00:00 2001 From: David Rowland Date: Mon, 3 Aug 2026 15:10:01 +0100 Subject: [PATCH 2/5] Engine: Registered the LAME and Signalsmith Stretch licences with the about box Neither library's licence was shipped anywhere, despite LAME's LGPL obligations being the stated reason it's dlopen'd rather than linked, and its own LICENSE file asking that anything using it acknowledges the project. Both now register through choc's OpenSourceLicenseList, which the host app already surfaces from its about box, so they appear wherever LLVM, QuickJS and the rest do. LAME's text is the GNU Library GPL v2 it actually ships - not the LGPL 2.1 - taken verbatim from the 4.0 tarball the build script pins. --- .../tracktion_LibLameEncoderAudioFormat.cpp | 502 ++++++++++++++++++ .../timestretch/tracktion_TimeStretch.cpp | 34 ++ 2 files changed, 536 insertions(+) diff --git a/modules/tracktion_engine/audio_files/formats/tracktion_LibLameEncoderAudioFormat.cpp b/modules/tracktion_engine/audio_files/formats/tracktion_LibLameEncoderAudioFormat.cpp index 559d5bf91e3..88a26be380c 100644 --- a/modules/tracktion_engine/audio_files/formats/tracktion_LibLameEncoderAudioFormat.cpp +++ b/modules/tracktion_engine/audio_files/formats/tracktion_LibLameEncoderAudioFormat.cpp @@ -624,3 +624,505 @@ std::unique_ptr LibLameEncoderAudioFormat::createWriter #endif } // namespace tracktion::inline engine + +#if TRACKTION_ENABLE_LIBLAME + +// Registers LAME's licence with the list the host app shows in its about box. +// LAME's own LICENSE file asks that anything using it acknowledges the project +// and links to the site, and the LGPL wants the licence text shipped alongside +// the binary - this is how both obligations are met. The library itself is +// dlopen'd rather than linked, so users can substitute their own build of it. +#include "../../../3rd_party/choc/choc/text/choc_OpenSourceLicenseList.h" + +CHOC_REGISTER_OPEN_SOURCE_LICENCE (LAME, R"LICENCE( +LAME (LAME Ain't an MP3 Encoder) - https://lame.sourceforge.io/ + +Waveform uses LAME to encode MP3 files. The library is loaded dynamically at +run time and is not linked into the application, so it may be replaced with +another build of the same library. + + GNU LIBRARY GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1991 Free Software Foundation, Inc. + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA + + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + +[This is the first released version of the library GPL. It is + numbered 2 because it goes with version 2 of the ordinary GPL.] + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +Licenses are intended to guarantee your freedom to share and change +free software--to make sure the software is free for all its users. + + This license, the Library General Public License, applies to some +specially designated Free Software Foundation software, and to any +other libraries whose authors decide to use it. You can use it for +your libraries, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if +you distribute copies of the library, or if you modify it. + + For example, if you distribute copies of the library, whether gratis +or for a fee, you must give the recipients all the rights that we gave +you. You must make sure that they, too, receive or can get the source +code. If you link a program with the library, you must provide +complete object files to the recipients so that they can relink them +with the library, after making changes to the library and recompiling +it. And you must show them these terms so they know their rights. + + Our method of protecting your rights has two steps: (1) copyright +the library, and (2) offer you this license which gives you legal +permission to copy, distribute and/or modify the library. + + Also, for each distributor's protection, we want to make certain +that everyone understands that there is no warranty for this free +library. If the library is modified by someone else and passed on, we +want its recipients to know that what they have is not the original +version, so that any problems introduced by others will not reflect on +the original authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that companies distributing free +software will individually obtain patent licenses, thus in effect +transforming the program into proprietary software. To prevent this, +we have made it clear that any patent must be licensed for everyone's +free use or not licensed at all. + + Most GNU software, including some libraries, is covered by the ordinary +GNU General Public License, which was designed for utility programs. This +license, the GNU Library General Public License, applies to certain +designated libraries. This license is quite different from the ordinary +one; be sure to read it in full, and don't assume that anything in it is +the same as in the ordinary license. + + The reason we have a separate public license for some libraries is that +they blur the distinction we usually make between modifying or adding to a +program and simply using it. Linking a program with a library, without +changing the library, is in some sense simply using the library, and is +analogous to running a utility program or application program. However, in +a textual and legal sense, the linked executable is a combined work, a +derivative of the original library, and the ordinary General Public License +treats it as such. + + Because of this blurred distinction, using the ordinary General +Public License for libraries did not effectively promote software +sharing, because most developers did not use the libraries. We +concluded that weaker conditions might promote sharing better. + + However, unrestricted linking of non-free programs would deprive the +users of those programs of all benefit from the free status of the +libraries themselves. This Library General Public License is intended to +permit developers of non-free programs to use free libraries, while +preserving your freedom as a user of such programs to change the free +libraries that are incorporated in them. (We have not seen how to achieve +this as regards changes in header files, but we have achieved it as regards +changes in the actual functions of the Library.) The hope is that this +will lead to faster development of free libraries. + + The precise terms and conditions for copying, distribution and +modification follow. Pay close attention to the difference between a +"work based on the library" and a "work that uses the library". The +former contains code derived from the library, while the latter only +works together with the library. + + Note that it is possible for a library to be covered by the ordinary +General Public License rather than by this special one. + + GNU LIBRARY GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License Agreement applies to any software library which +contains a notice placed by the copyright holder or other authorized +party saying it may be distributed under the terms of this Library +General Public License (also called "this License"). Each licensee is +addressed as "you". + + A "library" means a collection of software functions and/or data +prepared so as to be conveniently linked with application programs +(which use some of those functions and data) to form executables. + + The "Library", below, refers to any such software library or work +which has been distributed under these terms. A "work based on the +Library" means either the Library or any derivative work under +copyright law: that is to say, a work containing the Library or a +portion of it, either verbatim or with modifications and/or translated +straightforwardly into another language. (Hereinafter, translation is +included without limitation in the term "modification".) + + "Source code" for a work means the preferred form of the work for +making modifications to it. For a library, complete source code means +all the source code for all modules it contains, plus any associated +interface definition files, plus the scripts used to control compilation +and installation of the library. + + Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running a program using the Library is not restricted, and output from +such a program is covered only if its contents constitute a work based +on the Library (independent of the use of the Library in a tool for +writing it). Whether that is true depends on what the Library does +and what the program that uses the Library does. + + 1. You may copy and distribute verbatim copies of the Library's +complete source code as you receive it, in any medium, provided that +you conspicuously and appropriately publish on each copy an +appropriate copyright notice and disclaimer of warranty; keep intact +all the notices that refer to this License and to the absence of any +warranty; and distribute a copy of this License along with the +Library. + + You may charge a fee for the physical act of transferring a copy, +and you may at your option offer warranty protection in exchange for a +fee. + + 2. You may modify your copy or copies of the Library or any portion +of it, thus forming a work based on the Library, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) The modified work must itself be a software library. + + b) You must cause the files modified to carry prominent notices + stating that you changed the files and the date of any change. + + c) You must cause the whole of the work to be licensed at no + charge to all third parties under the terms of this License. + + d) If a facility in the modified Library refers to a function or a + table of data to be supplied by an application program that uses + the facility, other than as an argument passed when the facility + is invoked, then you must make a good faith effort to ensure that, + in the event an application does not supply such function or + table, the facility still operates, and performs whatever part of + its purpose remains meaningful. + + (For example, a function in a library to compute square roots has + a purpose that is entirely well-defined independent of the + application. Therefore, Subsection 2d requires that any + application-supplied function or table used by this function must + be optional: if the application does not supply it, the square + root function must still compute square roots.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Library, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Library, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote +it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Library. + +In addition, mere aggregation of another work not based on the Library +with the Library (or with a work based on the Library) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may opt to apply the terms of the ordinary GNU General Public +License instead of this License to a given copy of the Library. To do +this, you must alter all the notices that refer to this License, so +that they refer to the ordinary GNU General Public License, version 2, +instead of to this License. (If a newer version than version 2 of the +ordinary GNU General Public License has appeared, then you can specify +that version instead if you wish.) Do not make any other change in +these notices. + + Once this change is made in a given copy, it is irreversible for +that copy, so the ordinary GNU General Public License applies to all +subsequent copies and derivative works made from that copy. + + This option is useful when you wish to copy part of the code of +the Library into a program that is not a library. + + 4. You may copy and distribute the Library (or a portion or +derivative of it, under Section 2) in object code or executable form +under the terms of Sections 1 and 2 above provided that you accompany +it with the complete corresponding machine-readable source code, which +must be distributed under the terms of Sections 1 and 2 above on a +medium customarily used for software interchange. + + If distribution of object code is made by offering access to copy +from a designated place, then offering equivalent access to copy the +source code from the same place satisfies the requirement to +distribute the source code, even though third parties are not +compelled to copy the source along with the object code. + + 5. A program that contains no derivative of any portion of the +Library, but is designed to work with the Library by being compiled or +linked with it, is called a "work that uses the Library". Such a +work, in isolation, is not a derivative work of the Library, and +therefore falls outside the scope of this License. + + However, linking a "work that uses the Library" with the Library +creates an executable that is a derivative of the Library (because it +contains portions of the Library), rather than a "work that uses the +library". The executable is therefore covered by this License. +Section 6 states terms for distribution of such executables. + + When a "work that uses the Library" uses material from a header file +that is part of the Library, the object code for the work may be a +derivative work of the Library even though the source code is not. +Whether this is true is especially significant if the work can be +linked without the Library, or if the work is itself a library. The +threshold for this to be true is not precisely defined by law. + + If such an object file uses only numerical parameters, data +structure layouts and accessors, and small macros and small inline +functions (ten lines or less in length), then the use of the object +file is unrestricted, regardless of whether it is legally a derivative +work. (Executables containing this object code plus portions of the +Library will still fall under Section 6.) + + Otherwise, if the work is a derivative of the Library, you may +distribute the object code for the work under the terms of Section 6. +Any executables containing that work also fall under Section 6, +whether or not they are linked directly with the Library itself. + + 6. As an exception to the Sections above, you may also compile or +link a "work that uses the Library" with the Library to produce a +work containing portions of the Library, and distribute that work +under terms of your choice, provided that the terms permit +modification of the work for the customer's own use and reverse +engineering for debugging such modifications. + + You must give prominent notice with each copy of the work that the +Library is used in it and that the Library and its use are covered by +this License. You must supply a copy of this License. If the work +during execution displays copyright notices, you must include the +copyright notice for the Library among them, as well as a reference +directing the user to the copy of this License. Also, you must do one +of these things: + + a) Accompany the work with the complete corresponding + machine-readable source code for the Library including whatever + changes were used in the work (which must be distributed under + Sections 1 and 2 above); and, if the work is an executable linked + with the Library, with the complete machine-readable "work that + uses the Library", as object code and/or source code, so that the + user can modify the Library and then relink to produce a modified + executable containing the modified Library. (It is understood + that the user who changes the contents of definitions files in the + Library will not necessarily be able to recompile the application + to use the modified definitions.) + + b) Accompany the work with a written offer, valid for at + least three years, to give the same user the materials + specified in Subsection 6a, above, for a charge no more + than the cost of performing this distribution. + + c) If distribution of the work is made by offering access to copy + from a designated place, offer equivalent access to copy the above + specified materials from the same place. + + d) Verify that the user has already received a copy of these + materials or that you have already sent this user a copy. + + For an executable, the required form of the "work that uses the +Library" must include any data and utility programs needed for +reproducing the executable from it. However, as a special exception, +the source code distributed need not include anything that is normally +distributed (in either source or binary form) with the major +components (compiler, kernel, and so on) of the operating system on +which the executable runs, unless that component itself accompanies +the executable. + + It may happen that this requirement contradicts the license +restrictions of other proprietary libraries that do not normally +accompany the operating system. Such a contradiction means you cannot +use both them and the Library together in an executable that you +distribute. + + 7. You may place library facilities that are a work based on the +Library side-by-side in a single library together with other library +facilities not covered by this License, and distribute such a combined +library, provided that the separate distribution of the work based on +the Library and of the other library facilities is otherwise +permitted, and provided that you do these two things: + + a) Accompany the combined library with a copy of the same work + based on the Library, uncombined with any other library + facilities. This must be distributed under the terms of the + Sections above. + + b) Give prominent notice with the combined library of the fact + that part of it is a work based on the Library, and explaining + where to find the accompanying uncombined form of the same work. + + 8. You may not copy, modify, sublicense, link with, or distribute +the Library except as expressly provided under this License. Any +attempt otherwise to copy, modify, sublicense, link with, or +distribute the Library is void, and will automatically terminate your +rights under this License. However, parties who have received copies, +or rights, from you under this License will not have their licenses +terminated so long as such parties remain in full compliance. + + 9. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Library or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Library (or any work based on the +Library), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Library or works based on it. + + 10. Each time you redistribute the Library (or any work based on the +Library), the recipient automatically receives a license from the +original licensor to copy, distribute, link with or modify the Library +subject to these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 11. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Library at all. For example, if a patent +license would not permit royalty-free redistribution of the Library by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Library. + +If any portion of this section is held invalid or unenforceable under any +particular circumstance, the balance of the section is intended to apply, +and the section as a whole is intended to apply in other circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 12. If the distribution and/or use of the Library is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Library under this License may add +an explicit geographical distribution limitation excluding those countries, +so that distribution is permitted only in or among countries not thus +excluded. In such case, this License incorporates the limitation as if +written in the body of this License. + + 13. The Free Software Foundation may publish revised and/or new +versions of the Library General Public License from time to time. +Such new versions will be similar in spirit to the present version, +but may differ in detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Library +specifies a version number of this License which applies to it and +"any later version", you have the option of following the terms and +conditions either of that version or of any later version published by +the Free Software Foundation. If the Library does not specify a +license version number, you may choose any version ever published by +the Free Software Foundation. + + 14. If you wish to incorporate parts of the Library into other free +programs whose distribution conditions are incompatible with these, +write to the author to ask for permission. For software which is +copyrighted by the Free Software Foundation, write to the Free +Software Foundation; we sometimes make exceptions for this. Our +decision will be guided by the two goals of preserving the free status +of all derivatives of our free software and of promoting the sharing +and reuse of software generally. + + NO WARRANTY + + 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO +WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. +EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR +OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY +KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE +LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME +THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN +WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY +AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU +FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR +CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE +LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING +RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A +FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF +SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH +DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Libraries + + If you develop a new library, and you want it to be of the greatest +possible use to the public, we recommend making it free software that +everyone can redistribute and change. You can do so by permitting +redistribution under these terms (or, alternatively, under the terms of the +ordinary General Public License). + + To apply these terms, attach the following notices to the library. It is +safest to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Library General Public + License as published by the Free Software Foundation; either + version 2 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Library General Public License for more details. + + You should have received a copy of the GNU Library General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + +Also add information on how to contact you by electronic and paper mail. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the library, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the + library `Frob' (a library for tweaking knobs) written by James Random Hacker. + + , 1 April 1990 + Ty Coon, President of Vice + +That's all there is to it! +)LICENCE") + +#endif diff --git a/modules/tracktion_engine/timestretch/tracktion_TimeStretch.cpp b/modules/tracktion_engine/timestretch/tracktion_TimeStretch.cpp index 047128a0573..7528b86fe0c 100644 --- a/modules/tracktion_engine/timestretch/tracktion_TimeStretch.cpp +++ b/modules/tracktion_engine/timestretch/tracktion_TimeStretch.cpp @@ -938,6 +938,40 @@ struct SignalsmithStretcher : public TimeStretcher::Stretcher JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (SignalsmithStretcher) }; +// Registers Signalsmith Stretch's licence with the list the host app shows in +// its about box. MIT only asks that the notice ships with the binary. +} // namespace tracktion::inline engine +#include "../../3rd_party/choc/choc/text/choc_OpenSourceLicenseList.h" + +CHOC_REGISTER_OPEN_SOURCE_LICENCE (SignalsmithStretch, R"LICENCE( +Signalsmith Stretch - https://signalsmith-audio.co.uk/code/stretch/ + +MIT License + +Copyright (c) 2022 Geraint Luff / Signalsmith Audio Ltd. +Copyright (c) 2025 Signalsmith Audio (signalsmith-linear) + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. +)LICENCE") + +namespace tracktion::inline engine { + #endif // TRACKTION_ENABLE_TIMESTRETCH_SIGNALSMITH //============================================================================== From edc8444f319318ac38869d3689fddbd8d889180c Mon Sep 17 00:00:00 2001 From: David Rowland Date: Mon, 3 Aug 2026 15:10:01 +0100 Subject: [PATCH 3/5] Renderer: Noted that cancelling from onJobStarted still discards the old file The destination is deleted before the callback runs, so a job cancelled from within it leaves nothing where a previous render used to be. That's deliberate and tested, but it isn't obvious from the callback's own documentation. --- .../tracktion_engine/model/export/tracktion_RenderQueue.cpp | 3 +++ 1 file changed, 3 insertions(+) diff --git a/modules/tracktion_engine/model/export/tracktion_RenderQueue.cpp b/modules/tracktion_engine/model/export/tracktion_RenderQueue.cpp index d1415dbf410..99d59c4e8a4 100644 --- a/modules/tracktion_engine/model/export/tracktion_RenderQueue.cpp +++ b/modules/tracktion_engine/model/export/tracktion_RenderQueue.cpp @@ -200,6 +200,9 @@ void RenderQueue::startNextJob() destFile.existsAsFile() && job.planned.params.edit != nullptr) AudioFile (job.planned.params.edit->engine, destFile).deleteFile(); + // N.B. the delete above has already happened by the time this runs, so a + // callback that cancels the job leaves any pre-existing file at destFile + // gone with nothing rendered to replace it if (onJobStarted != nullptr) onJobStarted (job); From d303d93ace996a00ade19a3936cdba47c067fc72 Mon Sep 17 00:00:00 2001 From: David Rowland Date: Mon, 3 Aug 2026 15:19:33 +0100 Subject: [PATCH 4/5] Renderer: Added filtering by clips --- .../export/tracktion_RenderSpecification.cpp | 47 ++++++++++++- .../export/tracktion_RenderSpecification.h | 6 ++ .../tracktion_RenderSpecification.test.cpp | 69 +++++++++++++++++++ 3 files changed, 119 insertions(+), 3 deletions(-) diff --git a/modules/tracktion_engine/model/export/tracktion_RenderSpecification.cpp b/modules/tracktion_engine/model/export/tracktion_RenderSpecification.cpp index 064dff084c3..a1917fc0826 100644 --- a/modules/tracktion_engine/model/export/tracktion_RenderSpecification.cpp +++ b/modules/tracktion_engine/model/export/tracktion_RenderSpecification.cpp @@ -102,6 +102,7 @@ juce::var RenderSpecification::toJSON() const obj->setProperty ("tracks", EditItemID::listToString (tracks)); obj->setProperty ("mutedTracks", EditItemID::listToString (mutedTracks)); obj->setProperty ("includeSourceTracks", includeSourceTracks); + obj->setProperty ("clips", EditItemID::listToString (clips)); if (time) { @@ -143,7 +144,7 @@ juce::var RenderSpecification::toJSON() const RenderSpecification RenderSpecification::fromJSON (const juce::var& v, juce::StringArray* unknownKeys) { - static const juce::StringArray knownKeys { "tracks", "mutedTracks", "includeSourceTracks", "startTime", "endTime", + static const juce::StringArray knownKeys { "tracks", "mutedTracks", "includeSourceTracks", "clips", "startTime", "endTime", "wrapRemainder", "destination", "format", "sampleRate", "bitDepth", "quality", "channelLayout", "normalise", "normaliseByRMS", "normaliseByLUFS", "normaliseToLevelDb", @@ -170,6 +171,7 @@ RenderSpecification RenderSpecification::fromJSON (const juce::var& v, juce::Str spec.tracks = EditItemID::parseStringList (get ("tracks", juce::String())); spec.mutedTracks = EditItemID::parseStringList (get ("mutedTracks", juce::String())); spec.includeSourceTracks = get ("includeSourceTracks", spec.includeSourceTracks); + spec.clips = EditItemID::parseStringList (get ("clips", juce::String())); spec.wrapRemainder = get ("wrapRemainder", spec.wrapRemainder); spec.destination = juce::File (get ("destination", juce::String()).toString()); spec.format = renderFormatFromString (get ("format", toString (spec.format)).toString()) @@ -225,8 +227,39 @@ juce::Result validateRenderSpecification (Edit& edit, const RenderSpecification& if (! isMidiFormat (spec.format)) { - if (spec.bitDepth != 16 && spec.bitDepth != 24 && spec.bitDepth != 32) - return juce::Result::fail (TRANS("Invalid bit depth")); + // Ask the format what it can do rather than hard coding it here, so this keeps + // up as formats gain support. Without it an unsupported combination gets as far + // as createWriterFor() returning nullptr, which surfaces as "Couldn't write to + // target file" - a filesystem complaint about a settings problem - or, worse, + // is silently ignored: MP3 tops out at 48kHz and simply encodes at that rate. + auto* audioFormat = getFormat (edit.engine, spec.format); + + auto listOf = [] (const juce::Array& values) + { + juce::StringArray strings; + + for (auto v : values) + strings.add (juce::String (v)); + + return strings.joinIntoString (", "); + }; + + if (auto rates = audioFormat->getPossibleSampleRates(); + ! rates.isEmpty() && ! rates.contains (juce::roundToInt (spec.sampleRate))) + return juce::Result::fail (TRANS("XZZX doesn't support a sample rate of YZZY") + .replace ("XZZX", toString (spec.format)) + .replace ("YZZY", juce::String (spec.sampleRate, 0)) + + ". " + TRANS("Supported rates: XZZX").replace ("XZZX", listOf (rates))); + + // A format offering a single depth fixes its own and ignores whatever it is + // handed - Ogg reports 32 and MP3 16, but both encode the same file whatever + // is asked for - so there is nothing to validate in that case + if (auto depths = audioFormat->getPossibleBitDepths(); + depths.size() > 1 && ! depths.contains (spec.bitDepth)) + return juce::Result::fail (TRANS("XZZX doesn't support YZZY bit") + .replace ("XZZX", toString (spec.format)) + .replace ("YZZY", juce::String (spec.bitDepth)) + + ". " + TRANS("Supported bit depths: XZZX").replace ("XZZX", listOf (depths))); if (! isKnownChannelLayout (spec.channelLayout)) return juce::Result::fail (TRANS("Unknown channel layout: ") + spec.channelLayout); @@ -236,6 +269,10 @@ juce::Result validateRenderSpecification (Edit& edit, const RenderSpecification& || resolveTracks (edit, spec.mutedTracks).size() != spec.mutedTracks.size()) return juce::Result::fail (TRANS("The specification contains tracks which aren't in this Edit")); + for (auto id : spec.clips) + if (findClipForID (edit, id) == nullptr) + return juce::Result::fail (TRANS("The specification contains clips which aren't in this Edit")); + if (spec.time ? spec.time->isEmpty() : (edit.getLength() == TimeDuration())) return juce::Result::fail (TRANS("There is nothing to render in the time range")); @@ -373,6 +410,10 @@ std::optional createRenderJob (Edit& edit, const RenderSpecifi for (auto [track, index] : resolved) params.tracksToDo.setBit (index); + for (auto id : spec.clips) + if (auto clip = findClipForID (edit, id)) + params.allowedClips.add (clip); + auto mutedTracks = spec.mutedTracks; if (spec.includeSourceTracks && ! spec.tracks.isEmpty()) diff --git a/modules/tracktion_engine/model/export/tracktion_RenderSpecification.h b/modules/tracktion_engine/model/export/tracktion_RenderSpecification.h index f61f9073ecb..498ec4ffceb 100644 --- a/modules/tracktion_engine/model/export/tracktion_RenderSpecification.h +++ b/modules/tracktion_engine/model/export/tracktion_RenderSpecification.h @@ -79,6 +79,12 @@ struct RenderSpecification */ bool includeSourceTracks = false; + /** If not empty, only these clips play in the render: everything else on + the rendered tracks stays silent. The tracks' plugin chains still run. + @see Renderer::Parameters::allowedClips + */ + juce::Array clips; + /** The time range to render. If unset, the whole Edit length is used. */ std::optional time; diff --git a/modules/tracktion_engine/model/export/tracktion_RenderSpecification.test.cpp b/modules/tracktion_engine/model/export/tracktion_RenderSpecification.test.cpp index c0f65d693d3..4bd75a62f0c 100644 --- a/modules/tracktion_engine/model/export/tracktion_RenderSpecification.test.cpp +++ b/modules/tracktion_engine/model/export/tracktion_RenderSpecification.test.cpp @@ -26,6 +26,8 @@ TEST_SUITE ("tracktion_engine") spec.tracks.add (EditItemID::fromRawID (1002)); spec.mutedTracks.add (EditItemID::fromRawID (1003)); spec.includeSourceTracks = true; + spec.clips.add (EditItemID::fromRawID (2001)); + spec.clips.add (EditItemID::fromRawID (2002)); spec.time = TimeRange (TimePosition::fromSeconds (1.5), TimePosition::fromSeconds (4.25)); spec.wrapRemainder = true; spec.destination = juce::File::getSpecialLocation (juce::File::tempDirectory).getChildFile ("renders"); @@ -52,6 +54,7 @@ TEST_SUITE ("tracktion_engine") CHECK_EQ (restored.tracks, spec.tracks); CHECK_EQ (restored.mutedTracks, spec.mutedTracks); CHECK_EQ (restored.includeSourceTracks, spec.includeSourceTracks); + CHECK_EQ (restored.clips, spec.clips); REQUIRE (restored.time.has_value()); CHECK_EQ (restored.time->getStart(), spec.time->getStart()); CHECK_EQ (restored.time->getEnd(), spec.time->getEnd()); @@ -156,6 +159,72 @@ TEST_SUITE ("tracktion_engine") CHECK (validateRenderSpecification (*edit, spec).failed()); } + // What each format supports is read from the format itself, so these follow + // whatever JUCE and the encoders say rather than a list maintained here + SUBCASE ("a bit depth the format can't write is rejected, not left to the writer") + { + spec.format = RenderFormat::flac; + spec.destination = destFile.getFile().withFileExtension (".flac"); + + spec.bitDepth = 24; + CHECK (validateRenderSpecification (*edit, spec).wasOk()); + + // FLAC is 16 or 24 bit only; this used to reach createWriterFor(), come + // back null and be reported as "Couldn't write to target file" + spec.bitDepth = 32; + auto result = validateRenderSpecification (*edit, spec); + CHECK (result.failed()); + CHECK (result.getErrorMessage().contains ("16, 24")); + + // AIFF is 8, 16 or 24 + spec.format = RenderFormat::aiff; + spec.destination = destFile.getFile().withFileExtension (".aiff"); + CHECK (validateRenderSpecification (*edit, spec).failed()); + + spec.bitDepth = 8; + CHECK (validateRenderSpecification (*edit, spec).wasOk()); + } + + SUBCASE ("a lossy format's fixed bit depth isn't validated") + { + // Ogg reports only 32 and MP3 only 16, but both ignore what they are + // handed - and the spec's default is 16, so rejecting it would break + // every ogg render that doesn't name a depth + spec.format = RenderFormat::ogg; + spec.destination = destFile.getFile().withFileExtension (".ogg"); + + for (auto depth : { 16, 24, 32 }) + { + spec.bitDepth = depth; + CHECK (validateRenderSpecification (*edit, spec).wasOk()); + } + } + + SUBCASE ("a sample rate the format can't encode is rejected") + { + // Ogg goes all the way up, so 96k is fine there... + spec.format = RenderFormat::ogg; + spec.destination = destFile.getFile().withFileExtension (".ogg"); + spec.sampleRate = 96000.0; + CHECK (validateRenderSpecification (*edit, spec).wasOk()); + + // ...but MP3 stops at 48k, and used to silently encode at 48k anyway. + // TestRunner can't find the libmp3lame that ships in the app bundle, so + // this half only runs where the encoder is actually available + if (engine.getAudioFileFormatManager().getLameFormat() != nullptr) + { + spec.format = RenderFormat::mp3; + spec.destination = destFile.getFile().withFileExtension (".mp3"); + + auto result = validateRenderSpecification (*edit, spec); + CHECK (result.failed()); + CHECK (result.getErrorMessage().contains ("48000")); + + spec.sampleRate = 44100.0; + CHECK (validateRenderSpecification (*edit, spec).wasOk()); + } + } + SUBCASE ("unknown channel layout") { spec.channelLayout = "22.2"; From 93734eec39e5aec16c249f31d6dd8c4f7bfad5eb Mon Sep 17 00:00:00 2001 From: David Rowland Date: Mon, 3 Aug 2026 20:04:36 +0100 Subject: [PATCH 5/5] Renderer: Added tag metadata helpers and per-format translation --- .../model/export/tracktion_RenderOptions.cpp | 20 +-- .../export/tracktion_RenderSpecification.cpp | 114 +++++++++++++++++- .../export/tracktion_RenderSpecification.h | 37 ++++++ 3 files changed, 152 insertions(+), 19 deletions(-) diff --git a/modules/tracktion_engine/model/export/tracktion_RenderOptions.cpp b/modules/tracktion_engine/model/export/tracktion_RenderOptions.cpp index e0b82b21dea..a90ad8d8389 100644 --- a/modules/tracktion_engine/model/export/tracktion_RenderOptions.cpp +++ b/modules/tracktion_engine/model/export/tracktion_RenderOptions.cpp @@ -269,22 +269,6 @@ void RenderOptions::valueTreePropertyChanged (juce::ValueTree& v, const juce::Id } //============================================================================== -static juce::StringPairArray getMetadata (Edit& edit) -{ - juce::StringPairArray metadataList; - auto metadata = edit.getEditMetadata(); - - if (metadata.album.isNotEmpty()) metadataList.set ("id3album", metadata.album); - if (metadata.artist.isNotEmpty()) metadataList.set ("id3artist", metadata.artist); - if (metadata.comment.isNotEmpty()) metadataList.set ("id3comment", metadata.comment); - if (metadata.date.isNotEmpty()) metadataList.set ("id3date", metadata.date); - if (metadata.genre.isNotEmpty()) metadataList.set ("id3genre", metadata.genre); - if (metadata.title.isNotEmpty()) metadataList.set ("id3title", metadata.title); - if (metadata.trackNumber.isNotEmpty()) metadataList.set ("id3trackNumber", metadata.trackNumber); - - return metadataList; -} - ChannelConfiguration RenderOptions::getChannelConfiguration() const { auto s = channelConfigStr.get().trim(); @@ -404,7 +388,7 @@ Renderer::Parameters RenderOptions::getRenderParameters (Edit& edit, SelectionMa params.tracksToDo.setRange (0, allTracks.size(), true); if (addMetadata) - params.metadata = getMetadata (edit); + params.metadata = createTagMetadata (edit); if (addAcidMetadata) params.metadata.addArray (createAcidInfo (edit, params.time)); @@ -804,7 +788,7 @@ std::unique_ptr RenderOptions::forGeneralExporter (Edit& edit) for (auto t : getAllTracks (edit)) ro->tracks.add (t->itemID); - ro->addMetadata = getMetadata (edit).size() != 0; + ro->addMetadata = hasTagMetadata (edit); ro->updateDefaultFilename (&edit); ro->updateHash(); diff --git a/modules/tracktion_engine/model/export/tracktion_RenderSpecification.cpp b/modules/tracktion_engine/model/export/tracktion_RenderSpecification.cpp index a1917fc0826..26c396d8bd5 100644 --- a/modules/tracktion_engine/model/export/tracktion_RenderSpecification.cpp +++ b/modules/tracktion_engine/model/export/tracktion_RenderSpecification.cpp @@ -21,6 +21,118 @@ juce::String toString (RenderFormat f) return std::string (magic_enum::enum_name (f)); } +//============================================================================== +juce::StringPairArray createTagMetadata (Edit& edit) +{ + juce::StringPairArray metadataList; + auto metadata = edit.getEditMetadata(); + + if (metadata.album.isNotEmpty()) metadataList.set ("id3album", metadata.album); + if (metadata.artist.isNotEmpty()) metadataList.set ("id3artist", metadata.artist); + if (metadata.comment.isNotEmpty()) metadataList.set ("id3comment", metadata.comment); + if (metadata.date.isNotEmpty()) metadataList.set ("id3date", metadata.date); + if (metadata.genre.isNotEmpty()) metadataList.set ("id3genre", metadata.genre); + if (metadata.title.isNotEmpty()) metadataList.set ("id3title", metadata.title); + if (metadata.trackNumber.isNotEmpty()) metadataList.set ("id3trackNumber", metadata.trackNumber); + + return metadataList; +} + +bool hasTagMetadata (Edit& edit) +{ + // Not createTagMetadata().size(): getEditMetadata() fills the date in with + // the current year even for an Edit that has never been given a tag, so + // that would answer yes for every Edit. What counts is whether any tag has + // actually been stored + auto meta = edit.state.getChildWithName (IDs::ID3VORBISMETADATA); + + if (! meta.isValid()) + return false; + + for (auto& id : { IDs::album, IDs::artist, IDs::comment, IDs::date, + IDs::genre, IDs::title, IDs::trackNumber }) + if (meta[id].toString().isNotEmpty()) + return true; + + return false; +} + +bool formatSupportsTagMetadata (RenderFormat f) +{ + switch (f) + { + case RenderFormat::wav: + case RenderFormat::ogg: + case RenderFormat::mp3: return true; + + case RenderFormat::aiff: + case RenderFormat::flac: + case RenderFormat::midi: break; + } + + return false; +} + +/** The RIFF INFO key the WAV writer wants for a canonical id3 tag key, or + nullptr if that tag has no INFO equivalent. The WAV writer has no ID3 + support at all, so this is the only way a .wav carries tags. ICMT is the + comment field readers expect (JUCE's riffInfoComment is the rarer CMNT) and + ICRD the date one. +*/ +static const char* getRiffInfoKeyForTag (const juce::String& id3Key) +{ + if (id3Key == "id3album") return juce::WavAudioFormat::riffInfoProductName; + if (id3Key == "id3artist") return juce::WavAudioFormat::riffInfoArtist; + if (id3Key == "id3comment") return juce::WavAudioFormat::riffInfoComment2; + if (id3Key == "id3date") return juce::WavAudioFormat::riffInfoDateCreated; + if (id3Key == "id3genre") return juce::WavAudioFormat::riffInfoGenre; + if (id3Key == "id3title") return juce::WavAudioFormat::riffInfoTitle; + if (id3Key == "id3trackNumber") return juce::WavAudioFormat::riffInfoTrackNumber; + + return nullptr; +} + +juce::StringPairArray translateMetadataForFormat (const juce::StringPairArray& metadata, RenderFormat format) +{ + juce::StringPairArray result; + auto& keys = metadata.getAllKeys(); + auto& values = metadata.getAllValues(); + + for (int i = 0; i < metadata.size(); ++i) + { + const auto& key = keys[i]; + + // Anything that isn't a tag - ACID, BWAV - belongs to the format's own + // chunks and passes straight through + if (! key.startsWith ("id3")) + { + result.set (key, values[i]); + continue; + } + + switch (format) + { + case RenderFormat::ogg: + case RenderFormat::mp3: + result.set (key, values[i]); + break; + + case RenderFormat::wav: + if (auto riffKey = getRiffInfoKeyForTag (key)) + result.set (riffKey, values[i]); + + break; + + case RenderFormat::aiff: + case RenderFormat::flac: + case RenderFormat::midi: + break; + } + } + + return result; +} + namespace render_spec_utils { inline constexpr double maxWrapRemainderTailSeconds = 30.0; @@ -391,7 +503,7 @@ std::optional createRenderJob (Edit& edit, const RenderSpecifi params.truePeakCeilingDb = spec.truePeakCeilingDb; params.trimSilenceAtEnds = spec.trimSilence && ! spec.wrapRemainder; params.ditheringEnabled = spec.dither; - params.metadata = spec.metadata; + params.metadata = translateMetadataForFormat (spec.metadata, spec.format); if (spec.channelLayout == "mono") params.mustRenderInMono = true; else if (spec.channelLayout == "stereo") params.channelConfig = ChannelConfiguration::stereo(); diff --git a/modules/tracktion_engine/model/export/tracktion_RenderSpecification.h b/modules/tracktion_engine/model/export/tracktion_RenderSpecification.h index 498ec4ffceb..2816027215f 100644 --- a/modules/tracktion_engine/model/export/tracktion_RenderSpecification.h +++ b/modules/tracktion_engine/model/export/tracktion_RenderSpecification.h @@ -38,6 +38,43 @@ juce::String toString (RenderFormat); /** True for the format that writes notes rather than audio. */ inline bool isMidiFormat (RenderFormat f) { return f == RenderFormat::midi; } +//============================================================================== +/** Returns an Edit's tag metadata - title, artist, album, date, genre, comment + and track number - as the canonical "id3*" key/value pairs. + + These names are the single vocabulary tags are written in everywhere a + render carries them (presets, config files and the scripting API), whatever + the output format turns out to be: translateMetadataForFormat() converts + them to whatever the format's writer actually understands. Empty fields are + left out - but note getEditMetadata() fills the date in with the current + year, so an Edit with no tags at all still gets a date. + + @see Edit::getEditMetadata, translateMetadataForFormat +*/ +juce::StringPairArray createTagMetadata (Edit&); + +/** True if an Edit has actually been given any tags, which is what decides + whether tagging is enabled by default. This is not the same as + createTagMetadata() returning something - that always carries a date. +*/ +bool hasTagMetadata (Edit&); + +/** True if a format's writer can carry tag metadata at all: wav (in a RIFF + INFO chunk), ogg (Vorbis comments) and mp3 (ID3) can; aiff and flac have no + metadata support in their writers, and a MIDI file has nowhere to put it. +*/ +bool formatSupportsTagMetadata (RenderFormat); + +/** Converts canonical "id3*" tag pairs to the keys a format's writer + understands: passed through unchanged for ogg and mp3, mapped to the WAV + writer's RIFF INFO names for wav, and dropped for the formats which can't + carry tags. + + Pairs outside the "id3*" family - ACID or BWAV info, say - are always passed + through untouched, so this can be applied to a whole metadata set. +*/ +juce::StringPairArray translateMetadataForFormat (const juce::StringPairArray&, RenderFormat); + //============================================================================== /** A plain-data description of a single render operation: one output file.