[Imp] Stream Export: FLAC: Enable multi-threading by default. It can be disabled via a new hidden setting [Export]FLACMultithreading=true. This depends on <xiph/flac#822>, and is a no-op until our libflac supports multi-threading.

[Imp] FLAC Samples: Add hidden setting [Sample Editor]FLACMultithreading=false. As samples are short for the most part, thread creation overhead might dominate the encoding, so this is disabled by default. This has not been benchmarked. This depends on <xiph/flac#822>, and is a no-op until our libflac supports multi-threading.
[Imp] openmpt123: Enable FLAC multithreading unconditionally.

git-svn-id: https://source.openmpt.org/svn/openmpt/trunk/OpenMPT@23042 56274372-70c3-4bfc-bfc3-4c3a0b034d27

Author: manxorist

mptrack/StreamEncoderSettings.cpp

@@ -69,6 +69,7 @@ EncoderSettingsConf::operator Encoder::Settings() const
 
 StreamEncoderSettingsConf::StreamEncoderSettingsConf(SettingsContainer &conf, const mpt::ustring &section)
 	: FLACCompressionLevel(conf, section, U_("FLACCompressionLevel"), Encoder::StreamSettings().FLACCompressionLevel)
+	, FLACMultithreading(conf, section, U_("FLACMultithreading"), Encoder::StreamSettings().FLACMultithreading)
 	, AUPaddingAlignHint(conf, section, U_("AUPaddingAlignHint"), Encoder::StreamSettings().AUPaddingAlignHint)
 	, MP3ID3v2MinPadding(conf, section, U_("MP3ID3v2MinPadding"), Encoder::StreamSettings().MP3ID3v2MinPadding)
 	, MP3ID3v2PaddingAlignHint(conf, section, U_("MP3ID3v2PaddingAlignHint"), Encoder::StreamSettings().MP3ID3v2PaddingAlignHint)
@@ -87,6 +88,7 @@ StreamEncoderSettingsConf::operator Encoder::StreamSettings() const
 {
 	Encoder::StreamSettings result;
 	result.FLACCompressionLevel = FLACCompressionLevel;
+	result.FLACMultithreading = FLACMultithreading;
 	result.AUPaddingAlignHint = AUPaddingAlignHint;
 	result.MP3ID3v2MinPadding = MP3ID3v2MinPadding;
 	result.MP3ID3v2PaddingAlignHint = MP3ID3v2PaddingAlignHint;

mptrack/StreamEncoderSettings.h

@@ -96,6 +96,7 @@ struct EncoderSettingsConf
 struct StreamEncoderSettingsConf
 {
 	Setting<int32> FLACCompressionLevel;
+	Setting<bool> FLACMultithreading;
 	Setting<uint32> AUPaddingAlignHint;
 	Setting<uint32> MP3ID3v2MinPadding;
 	Setting<uint32> MP3ID3v2PaddingAlignHint;

mptrack/TrackerSettings.cpp

@@ -294,6 +294,7 @@ TrackerSettings::TrackerSettings(SettingsContainer &conf)
 	, sampleEditorDefaultResampler(conf, UL_("Sample Editor"), UL_("DefaultResampler"), SRCMODE_DEFAULT)
 	, m_nFinetuneStep(conf, UL_("Sample Editor"), UL_("FinetuneStep"), 10)
 	, m_FLACCompressionLevel(conf, UL_("Sample Editor"), UL_("FLACCompressionLevel"), 5)
+	, m_FLACMultithreading(conf, UL_("Sample Editor"), UL_("FLACMultithreading"), false)
 	, compressITI(conf, UL_("Sample Editor"), UL_("CompressITI"), true)
 	, m_MayNormalizeSamplesOnLoad(conf, UL_("Sample Editor"), UL_("MayNormalizeSamplesOnLoad"), true)
 	, previewInFileDialogs(conf, UL_("Sample Editor"), UL_("PreviewInFileDialogs"), false)

mptrack/TrackerSettings.h

@@ -878,6 +878,7 @@ class TrackerSettings
 	Setting<ResamplingMode> sampleEditorDefaultResampler;
 	Setting<int32> m_nFinetuneStep;	// Increment finetune by x cents when using spin control.
 	Setting<int32> m_FLACCompressionLevel;	// FLAC compression level for saving (0...8)
+	Setting<bool> m_FLACMultithreading;
 	Setting<bool> compressITI;
 	Setting<bool> m_MayNormalizeSamplesOnLoad;
 	Setting<bool> previewInFileDialogs;

openmpt123/openmpt123_flac.hpp

@@ -18,6 +18,11 @@
 #include "mpt/base/detect.hpp"
 #include "mpt/base/saturate_round.hpp"
 
+#include <algorithm>
+#if MPT_PLATFORM_MULTITHREADED && !defined(MPT_COMPILER_QUIRK_NO_STDCPP_THREADS)
+#include <thread>
+#endif
+
 #if defined(_MSC_VER) && defined(__clang__) && defined(__c2__)
 #include <sys/types.h>
 #if __STDC__
@@ -66,6 +71,9 @@ class flac_stream_raii : public file_audio_stream_base {
 		FLAC__stream_encoder_set_bits_per_sample( encoder, flags.use_float ? 24 : 16 );
 		FLAC__stream_encoder_set_sample_rate( encoder, flags.samplerate );
 		FLAC__stream_encoder_set_compression_level( encoder, 8 );
+#if (FLAC_API_VERSION_CURRENT >= 14) && MPT_PLATFORM_MULTITHREADED && !defined(MPT_COMPILER_QUIRK_NO_STDCPP_THREADS)
+		FLAC__stream_encoder_set_num_threads(encoder, static_cast<std::uint32_t>(std::max(std::thread::hardware_concurrency(), static_cast<unsigned int>(1))));
+#endif
 	}
 	~flac_stream_raii() {
 		if ( encoder ) {

soundlib/SampleFormatFLAC.cpp

@@ -34,6 +34,10 @@
 #include "mpt/parse/parse.hpp"
 //#include "mpt/crc/crc.hpp"
 #include "OggStream.h"
+#include <algorithm>
+#if MPT_PLATFORM_MULTITHREADED && !defined(MPT_COMPILER_QUIRK_NO_STDCPP_THREADS)
+#include <thread>
+#endif
 #ifdef MPT_WITH_OGG
 #if MPT_COMPILER_CLANG
 #pragma clang diagnostic push
@@ -689,6 +693,10 @@ bool CSoundFile::SaveFLACSample(SAMPLEINDEX nSample, std::ostream &f) const
 	FLAC__stream_encoder_set_metadata(encoder, metadata.data(), numBlocks);
 #ifdef MODPLUG_TRACKER
 	FLAC__stream_encoder_set_compression_level(encoder, TrackerSettings::Instance().m_FLACCompressionLevel);
+#if (FLAC_API_VERSION_CURRENT >= 14) && MPT_PLATFORM_MULTITHREADED && !defined(MPT_COMPILER_QUIRK_NO_STDCPP_THREADS)
+	uint32 threads = TrackerSettings::Instance().m_FLACMultithreading ? static_cast<uint32>(std::max(std::thread::hardware_concurrency(), static_cast<unsigned int>(1))) : static_cast<uint32>(1);
+	FLAC__stream_encoder_set_num_threads(encoder, threads);
+#endif
 #endif // MODPLUG_TRACKER
 
 	bool success = FLAC__stream_encoder_init_stream(encoder, &FLAC__StreamEncoder_RAII::StreamEncoderWriteCallback, &FLAC__StreamEncoder_RAII::StreamEncoderSeekCallback, &FLAC__StreamEncoder_RAII::StreamEncoderTellCallback, nullptr, &encoder.f) == FLAC__STREAM_ENCODER_INIT_STATUS_OK;

src/openmpt/streamencoder/StreamEncoder.hpp

@@ -213,6 +213,7 @@ struct Traits
 struct StreamSettings
 {
 	int32 FLACCompressionLevel = 5;  // 8
+	bool FLACMultithreading = true;
 	uint32 AUPaddingAlignHint = 4096;
 	uint32 MP3ID3v2MinPadding = 1024;
 	uint32 MP3ID3v2PaddingAlignHint = 4096;

src/openmpt/streamencoder/StreamEncoderFLAC.cpp

@@ -8,6 +8,7 @@
 #include "openmpt/streamencoder/StreamEncoderFLAC.hpp"
 
 #include "mpt/base/bit.hpp"
+#include "mpt/base/detect.hpp"
 #include "mpt/base/macros.hpp"
 #include "mpt/base/pointer.hpp"
 #include "mpt/base/saturate_cast.hpp"
@@ -25,8 +26,12 @@
 #include "openmpt/soundfile_data/tags.hpp"
 #include "openmpt/streamencoder/StreamEncoder.hpp"
 
+#include <algorithm>
 #include <memory>
 #include <string>
+#if MPT_PLATFORM_MULTITHREADED && !defined(MPT_COMPILER_QUIRK_NO_STDCPP_THREADS)
+#include <thread>
+#endif
 #include <vector>
 
 #include <cassert>
@@ -123,6 +128,11 @@ class FLACStreamWriter : public StreamWriterBase
 		int compressionLevel = settings.Details.FLACCompressionLevel;
 		FLAC__stream_encoder_set_compression_level(encoder, compressionLevel);
 
+#if (FLAC_API_VERSION_CURRENT >= 14) && MPT_PLATFORM_MULTITHREADED && !defined(MPT_COMPILER_QUIRK_NO_STDCPP_THREADS)
+		uint32 threads = settings.Details.FLACMultithreading ? static_cast<uint32>(std::max(std::thread::hardware_concurrency(), static_cast<unsigned int>(1))) : static_cast<uint32>(1);
+		FLAC__stream_encoder_set_num_threads(encoder, threads);
+#endif
+
 		if(settings.Tags)
 		{
 			flac_metadata[0] = FLAC__metadata_object_new(FLAC__METADATA_TYPE_VORBIS_COMMENT);