From 8e1d1fbdd361f0ce6ec7d87eced92e092e7a5ab0 Mon Sep 17 00:00:00 2001 From: Daniel Wolf Date: Wed, 16 Nov 2016 11:49:25 +0100 Subject: [PATCH] Unified acronym capitalization See http://stackoverflow.com/a/27172000/52041 --- CMakeLists.txt | 20 ++++++++++---------- src/ExportFormat.cpp | 6 +++--- src/ExportFormat.h | 6 +++--- src/audio/{DCOffset.cpp => DcOffset.cpp} | 22 +++++++++++----------- src/audio/{DCOffset.h => DcOffset.h} | 14 +++++++------- src/audio/WaveFileReader.cpp | 6 +++--- src/audio/voiceActivityDetection.cpp | 4 ++-- src/exporters/JsonExporter.cpp | 6 +++--- src/exporters/JsonExporter.h | 2 +- src/exporters/TsvExporter.cpp | 2 +- src/exporters/TsvExporter.h | 2 +- src/exporters/XmlExporter.cpp | 2 +- src/exporters/XmlExporter.h | 2 +- src/main.cpp | 16 ++++++++-------- src/recognition/phoneRecognition.cpp | 4 ++-- src/recognition/tokenization.cpp | 2 +- src/tools/stringTools.cpp | 6 +++--- src/tools/stringTools.h | 4 ++-- src/tools/textFiles.cpp | 2 +- src/tools/textFiles.h | 2 +- tests/stringToolsTests.cpp | 8 ++++---- 21 files changed, 69 insertions(+), 69 deletions(-) rename src/audio/{DCOffset.cpp => DcOffset.cpp} (73%) rename src/audio/{DCOffset.h => DcOffset.h} (56%) diff --git a/CMakeLists.txt b/CMakeLists.txt index 696eed5..aabd239 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -111,7 +111,7 @@ set_target_properties(gtest_main PROPERTIES FOLDER lib) include_directories(SYSTEM "lib/gsl/include") # ... WebRTC -set(webRTCFiles +set(webRtcFiles lib/webrtc-8d2248ff/webrtc/common_audio/signal_processing/cross_correlation.c lib/webrtc-8d2248ff/webrtc/common_audio/signal_processing/division_operations.c lib/webrtc-8d2248ff/webrtc/common_audio/signal_processing/downsample_fast.c @@ -130,16 +130,16 @@ set(webRTCFiles lib/webrtc-8d2248ff/webrtc/common_audio/vad/vad_sp.c lib/webrtc-8d2248ff/webrtc/common_audio/vad/webrtc_vad.c ) -add_library(webRTC ${webRTCFiles}) -target_include_directories(webRTC SYSTEM PUBLIC "lib/webrtc-8d2248ff") -target_compile_options(webRTC PRIVATE ${disableWarningsFlags}) +add_library(webRtc ${webRtcFiles}) +target_include_directories(webRtc SYSTEM PUBLIC "lib/webrtc-8d2248ff") +target_compile_options(webRtc PRIVATE ${disableWarningsFlags}) if ("${CMAKE_CXX_COMPILER_ID}" STREQUAL "GNU") - target_compile_options(webRTC PRIVATE -pthread -lpthread) + target_compile_options(webRtc PRIVATE -pthread -lpthread) endif() if (NOT WIN32) - target_compile_definitions(webRTC PRIVATE WEBRTC_POSIX) + target_compile_definitions(webRtc PRIVATE WEBRTC_POSIX) endif() -set_target_properties(webRTC PROPERTIES FOLDER lib) +set_target_properties(webRtc PROPERTIES FOLDER lib) # ... whereami add_library(whereami lib/whereami/src/whereami.c) @@ -236,8 +236,8 @@ add_library(rhubarb-audio src/audio/AudioClip.h src/audio/AudioSegment.cpp src/audio/AudioSegment.h - src/audio/DCOffset.cpp - src/audio/DCOffset.h + src/audio/DcOffset.cpp + src/audio/DcOffset.h src/audio/ioTools.h src/audio/processing.cpp src/audio/processing.h @@ -252,7 +252,7 @@ add_library(rhubarb-audio ) target_include_directories(rhubarb-audio PUBLIC "src/audio") target_link_libraries(rhubarb-audio - webRTC + webRtc rhubarb-logging rhubarb-time rhubarb-tools diff --git a/src/ExportFormat.cpp b/src/ExportFormat.cpp index fe02199..5735bed 100644 --- a/src/ExportFormat.cpp +++ b/src/ExportFormat.cpp @@ -13,9 +13,9 @@ string ExportFormatConverter::getTypeName() { EnumConverter::member_data ExportFormatConverter::getMemberData() { return member_data{ - { ExportFormat::TSV, "TSV" }, - { ExportFormat::XML, "XML" }, - { ExportFormat::JSON, "JSON" } + { ExportFormat::Tsv, "tsv" }, + { ExportFormat::Xml, "xml" }, + { ExportFormat::Json, "json" } }; } diff --git a/src/ExportFormat.h b/src/ExportFormat.h index 648d2d8..d3801f1 100644 --- a/src/ExportFormat.h +++ b/src/ExportFormat.h @@ -3,9 +3,9 @@ #include "EnumConverter.h" enum class ExportFormat { - TSV, - XML, - JSON + Tsv, + Xml, + Json }; class ExportFormatConverter : public EnumConverter { diff --git a/src/audio/DCOffset.cpp b/src/audio/DcOffset.cpp similarity index 73% rename from src/audio/DCOffset.cpp rename to src/audio/DcOffset.cpp index 551c9d4..3a4a09c 100644 --- a/src/audio/DCOffset.cpp +++ b/src/audio/DcOffset.cpp @@ -1,27 +1,27 @@ -#include "DCOffset.h" +#include "DcOffset.h" #include using std::unique_ptr; using std::make_unique; -DCOffset::DCOffset(unique_ptr inputClip, float offset) : +DcOffset::DcOffset(unique_ptr inputClip, float offset) : inputClip(std::move(inputClip)), offset(offset), factor(1 / (1 + std::abs(offset))) {} -unique_ptr DCOffset::clone() const { - return make_unique(*this); +unique_ptr DcOffset::clone() const { + return make_unique(*this); } -SampleReader DCOffset::createUnsafeSampleReader() const { +SampleReader DcOffset::createUnsafeSampleReader() const { return [read = inputClip->createSampleReader(), factor = factor, offset = offset](size_type index) { float sample = read(index); return sample * factor + offset; }; } -float getDCOffset(const AudioClip& audioClip) { +float getDcOffset(const AudioClip& audioClip) { int flatMeanSampleCount, fadingMeanSampleCount; int sampleRate = audioClip.getSampleRate(); if (audioClip.size() > 4 * sampleRate) { @@ -49,16 +49,16 @@ float getDCOffset(const AudioClip& audioClip) { return static_cast(offset); } -AudioEffect addDCOffset(float offset, float epsilon) { +AudioEffect addDcOffset(float offset, float epsilon) { return [offset, epsilon](unique_ptr inputClip) -> unique_ptr { if (std::abs(offset) < epsilon) return std::move(inputClip); - return make_unique(std::move(inputClip), offset); + return make_unique(std::move(inputClip), offset); }; } -AudioEffect removeDCOffset(float epsilon) { +AudioEffect removeDcOffset(float epsilon) { return [epsilon](unique_ptr inputClip) { - float offset = getDCOffset(*inputClip); - return std::move(inputClip) | addDCOffset(-offset, epsilon); + float offset = getDcOffset(*inputClip); + return std::move(inputClip) | addDcOffset(-offset, epsilon); }; } diff --git a/src/audio/DCOffset.h b/src/audio/DcOffset.h similarity index 56% rename from src/audio/DCOffset.h rename to src/audio/DcOffset.h index ee2394e..d907fa9 100644 --- a/src/audio/DCOffset.h +++ b/src/audio/DcOffset.h @@ -4,9 +4,9 @@ // Applies a constant DC offset to an audio clip and reduces its amplitude // to prevent clipping -class DCOffset : public AudioClip { +class DcOffset : public AudioClip { public: - DCOffset(std::unique_ptr inputClip, float offset); + DcOffset(std::unique_ptr inputClip, float offset); std::unique_ptr clone() const override; int getSampleRate() const override; size_type size() const override; @@ -18,15 +18,15 @@ private: float factor; }; -inline int DCOffset::getSampleRate() const { +inline int DcOffset::getSampleRate() const { return inputClip->getSampleRate(); } -inline AudioClip::size_type DCOffset::size() const { +inline AudioClip::size_type DcOffset::size() const { return inputClip->size(); } -float getDCOffset(const AudioClip& audioClip); +float getDcOffset(const AudioClip& audioClip); -AudioEffect addDCOffset(float offset, float epsilon = 1.0f / 15000); -AudioEffect removeDCOffset(float epsilon = 1.0f / 15000); +AudioEffect addDcOffset(float offset, float epsilon = 1.0f / 15000); +AudioEffect removeDcOffset(float epsilon = 1.0f / 15000); diff --git a/src/audio/WaveFileReader.cpp b/src/audio/WaveFileReader.cpp index 7a5fc7f..7b2be10 100644 --- a/src/audio/WaveFileReader.cpp +++ b/src/audio/WaveFileReader.cpp @@ -26,7 +26,7 @@ int roundToEven(int i) { } namespace Codec { - constexpr int PCM = 0x01; + constexpr int Pcm = 0x01; constexpr int Float = 0x03; }; @@ -103,7 +103,7 @@ WaveFileReader::WaveFileReader(path filePath) : // Determine sample format int bytesPerSample; switch (codec) { - case Codec::PCM: + case Codec::Pcm: // Determine sample size. // According to the WAVE standard, sample sizes that are not multiples of 8 bits // (e.g. 12 bits) can be treated like the next-larger byte size. @@ -135,7 +135,7 @@ WaveFileReader::WaveFileReader(path filePath) : default: throw runtime_error(format( "Unsupported audio codec: '{}'. Only uncompressed codecs ('{}' and '{}') are supported.", - codecToString(codec), codecToString(Codec::PCM), codecToString(Codec::Float))); + codecToString(codec), codecToString(Codec::Pcm), codecToString(Codec::Float))); } formatInfo.bytesPerFrame = bytesPerSample * formatInfo.channelCount; break; diff --git a/src/audio/voiceActivityDetection.cpp b/src/audio/voiceActivityDetection.cpp index 3d50b11..354df32 100644 --- a/src/audio/voiceActivityDetection.cpp +++ b/src/audio/voiceActivityDetection.cpp @@ -1,5 +1,5 @@ #include "voiceActivityDetection.h" -#include "DCOffset.h" +#include "DcOffset.h" #include "SampleRateConverter.h" #include "logging.h" #include "pairs.h" @@ -68,7 +68,7 @@ BoundedTimeline webRtcDetectVoiceActivity(const AudioClip& audioClip, Prog BoundedTimeline detectVoiceActivity(const AudioClip& inputAudioClip, int maxThreadCount, ProgressSink& progressSink) { // Prepare audio for VAD - const unique_ptr audioClip = inputAudioClip.clone() | resample(16000) | removeDCOffset(); + const unique_ptr audioClip = inputAudioClip.clone() | resample(16000) | removeDcOffset(); BoundedTimeline activity(audioClip->getTruncatedRange()); std::mutex activityMutex; diff --git a/src/exporters/JsonExporter.cpp b/src/exporters/JsonExporter.cpp index 35287c9..093bdec 100644 --- a/src/exporters/JsonExporter.cpp +++ b/src/exporters/JsonExporter.cpp @@ -3,7 +3,7 @@ using std::string; -string escapeJSONString(const string& s) { +string escapeJsonString(const string& s) { string result; for (char c : s) { switch (c) { @@ -25,12 +25,12 @@ string escapeJSONString(const string& s) { return result; } -void JSONExporter::exportShapes(const boost::filesystem::path& inputFilePath, const ContinuousTimeline& shapes, std::ostream& outputStream) { +void JsonExporter::exportShapes(const boost::filesystem::path& inputFilePath, const ContinuousTimeline& shapes, std::ostream& outputStream) { // Export as JSON. // I'm not using a library because the code is short enough without one and it lets me control the formatting. outputStream << "{\n"; outputStream << " \"metadata\": {\n"; - outputStream << " \"soundFile\": \"" << escapeJSONString(inputFilePath.string()) << "\",\n"; + outputStream << " \"soundFile\": \"" << escapeJsonString(inputFilePath.string()) << "\",\n"; outputStream << " \"duration\": " << formatDuration(shapes.getRange().getDuration()) << "\n"; outputStream << " },\n"; outputStream << " \"mouthCues\": [\n"; diff --git a/src/exporters/JsonExporter.h b/src/exporters/JsonExporter.h index 7f151ed..13a43ab 100644 --- a/src/exporters/JsonExporter.h +++ b/src/exporters/JsonExporter.h @@ -2,7 +2,7 @@ #include "Exporter.h" -class JSONExporter : public Exporter { +class JsonExporter : public Exporter { public: void exportShapes(const boost::filesystem::path& inputFilePath, const ContinuousTimeline& shapes, std::ostream& outputStream) override; }; diff --git a/src/exporters/TsvExporter.cpp b/src/exporters/TsvExporter.cpp index f81d700..d594868 100644 --- a/src/exporters/TsvExporter.cpp +++ b/src/exporters/TsvExporter.cpp @@ -1,6 +1,6 @@ #include "TsvExporter.h" -void TSVExporter::exportShapes(const boost::filesystem::path& inputFilePath, const ContinuousTimeline& shapes, std::ostream& outputStream) { +void TsvExporter::exportShapes(const boost::filesystem::path& inputFilePath, const ContinuousTimeline& shapes, std::ostream& outputStream) { UNUSED(inputFilePath); // Output shapes with start times diff --git a/src/exporters/TsvExporter.h b/src/exporters/TsvExporter.h index ad42388..0539fff 100644 --- a/src/exporters/TsvExporter.h +++ b/src/exporters/TsvExporter.h @@ -2,7 +2,7 @@ #include "Exporter.h" -class TSVExporter : public Exporter { +class TsvExporter : public Exporter { public: void exportShapes(const boost::filesystem::path& inputFilePath, const ContinuousTimeline& shapes, std::ostream& outputStream) override; }; diff --git a/src/exporters/XmlExporter.cpp b/src/exporters/XmlExporter.cpp index 0b65d79..a8717b2 100644 --- a/src/exporters/XmlExporter.cpp +++ b/src/exporters/XmlExporter.cpp @@ -6,7 +6,7 @@ using std::string; using boost::property_tree::ptree; -void XMLExporter::exportShapes(const boost::filesystem::path& inputFilePath, const ContinuousTimeline& shapes, std::ostream& outputStream) { +void XmlExporter::exportShapes(const boost::filesystem::path& inputFilePath, const ContinuousTimeline& shapes, std::ostream& outputStream) { ptree tree; // Add metadata diff --git a/src/exporters/XmlExporter.h b/src/exporters/XmlExporter.h index f7b2c8a..d9114de 100644 --- a/src/exporters/XmlExporter.h +++ b/src/exporters/XmlExporter.h @@ -2,7 +2,7 @@ #include "Exporter.h" -class XMLExporter : public Exporter { +class XmlExporter : public Exporter { public: void exportShapes(const boost::filesystem::path& inputFilePath, const ContinuousTimeline& shapes, std::ostream& outputStream) override; }; diff --git a/src/main.cpp b/src/main.cpp index 464e134..cc3cc4e 100644 --- a/src/main.cpp +++ b/src/main.cpp @@ -68,12 +68,12 @@ void addFileSink(path path, logging::Level minLevel) { unique_ptr createExporter(ExportFormat exportFormat) { switch (exportFormat) { - case ExportFormat::TSV: - return make_unique(); - case ExportFormat::XML: - return make_unique(); - case ExportFormat::JSON: - return make_unique(); + case ExportFormat::Tsv: + return make_unique(); + case ExportFormat::Xml: + return make_unique(); + case ExportFormat::Json: + return make_unique(); default: throw std::runtime_error("Unknown export format."); } @@ -98,7 +98,7 @@ int main(int argc, char *argv[]) { tclap::ValueArg dialogFile("d", "dialogFile", "A file containing the text of the dialog.", false, string(), "string", cmd); auto exportFormats = vector(ExportFormatConverter::get().getValues()); tclap::ValuesConstraint exportFormatConstraint(exportFormats); - tclap::ValueArg exportFormat("f", "exportFormat", "The export format.", false, ExportFormat::TSV, &exportFormatConstraint, cmd); + tclap::ValueArg exportFormat("f", "exportFormat", "The export format.", false, ExportFormat::Tsv, &exportFormatConstraint, cmd); tclap::UnlabeledValueArg inputFileName("inputFile", "The input file. Must be a sound file in WAVE format.", true, "", "string", cmd); try { @@ -132,7 +132,7 @@ int main(int argc, char *argv[]) { // Animate the recording animation = animateWaveFile( inputFileName.getValue(), - dialogFile.isSet() ? readUTF8File(path(dialogFile.getValue())) : boost::optional(), + dialogFile.isSet() ? readUtf8File(path(dialogFile.getValue())) : boost::optional(), maxThreadCount.getValue(), progressBar); } diff --git a/src/recognition/phoneRecognition.cpp b/src/recognition/phoneRecognition.cpp index 50b62eb..5e6ab92 100644 --- a/src/recognition/phoneRecognition.cpp +++ b/src/recognition/phoneRecognition.cpp @@ -8,7 +8,7 @@ #include #include #include -#include "DCOffset.h" +#include "DcOffset.h" #include "Timeline.h" #include "voiceActivityDetection.h" #include "AudioSegment.h" @@ -427,7 +427,7 @@ BoundedTimeline recognizePhones( ProgressSink& dialogProgressSink = totalProgressMerger.addSink(15); // Make sure audio stream has no DC offset - const unique_ptr audioClip = inputAudioClip.clone() | removeDCOffset(); + const unique_ptr audioClip = inputAudioClip.clone() | removeDcOffset(); // Split audio into utterances BoundedTimeline utterances; diff --git a/src/recognition/tokenization.cpp b/src/recognition/tokenization.cpp index 239ec45..e2b9000 100644 --- a/src/recognition/tokenization.cpp +++ b/src/recognition/tokenization.cpp @@ -74,7 +74,7 @@ optional findSimilarDictionaryWord(const string& word, function tokenizeText(const u32string& text, function dictionaryContains) { - vector words = tokenizeViaFlite(toASCII(text)); + vector words = tokenizeViaFlite(toAscii(text)); // Join words separated by apostophes for (int i = words.size() - 1; i > 0; --i) { diff --git a/src/tools/stringTools.cpp b/src/tools/stringTools.cpp index ad4fec7..a95701a 100644 --- a/src/tools/stringTools.cpp +++ b/src/tools/stringTools.cpp @@ -91,7 +91,7 @@ wstring latin1ToWide(const string& s) { return result; } -optional toASCII(char32_t ch) { +optional toAscii(char32_t ch) { switch (ch) { #include "asciiCases.cpp" default: @@ -99,10 +99,10 @@ optional toASCII(char32_t ch) { } } -string toASCII(const u32string& s) { +string toAscii(const u32string& s) { string result; for (char32_t ch : s) { - optional ascii = toASCII(ch); + optional ascii = toAscii(ch); if (ascii) result.append(1, *ascii); } return result; diff --git a/src/tools/stringTools.h b/src/tools/stringTools.h index 0bca142..71363c8 100644 --- a/src/tools/stringTools.h +++ b/src/tools/stringTools.h @@ -12,9 +12,9 @@ std::vector wrapString(const std::string& s, int lineLength, int ha std::wstring latin1ToWide(const std::string& s); -boost::optional toASCII(char32_t ch); +boost::optional toAscii(char32_t ch); -std::string toASCII(const std::u32string& s); +std::string toAscii(const std::u32string& s); std::u32string utf8ToUtf32(const std::string& s); diff --git a/src/tools/textFiles.cpp b/src/tools/textFiles.cpp index 4dddd81..fd0ac6f 100644 --- a/src/tools/textFiles.cpp +++ b/src/tools/textFiles.cpp @@ -8,7 +8,7 @@ using std::string; using std::u32string; using boost::filesystem::path; -u32string readUTF8File(path filePath) { +u32string readUtf8File(path filePath) { if (!exists(filePath)) { throw std::invalid_argument(fmt::format("File {} does not exist.", filePath)); } diff --git a/src/tools/textFiles.h b/src/tools/textFiles.h index 5e0c03e..3c72a6c 100644 --- a/src/tools/textFiles.h +++ b/src/tools/textFiles.h @@ -2,4 +2,4 @@ #include -std::u32string readUTF8File(boost::filesystem::path filePath); \ No newline at end of file +std::u32string readUtf8File(boost::filesystem::path filePath); \ No newline at end of file diff --git a/tests/stringToolsTests.cpp b/tests/stringToolsTests.cpp index f5ab84b..3ecbd92 100644 --- a/tests/stringToolsTests.cpp +++ b/tests/stringToolsTests.cpp @@ -81,11 +81,11 @@ TEST(latin1ToWide, basic) { EXPECT_EQ(pangramWide, latin1ToWide(pangramLatin1)); } -// toASCII +// toAscii -TEST(toASCII, string) { +TEST(toAscii, string) { EXPECT_EQ( "A naive man called was having pina colada and creme brulee.", - toASCII(U"A naïve man called 晨 was having piña colada and crème brûlée.")); - EXPECT_EQ(string(""), toASCII(U"")); + toAscii(U"A naïve man called 晨 was having piña colada and crème brûlée.")); + EXPECT_EQ(string(""), toAscii(U"")); }