owen/lms
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Subsonic API: added bitDepth, samplingRate and channelCount, see https://github.com/opensubsonic/open-subsonic-api/pull/83

Browse Source
This commit is contained in:
emeric
2024-04-14 16:17:45 +02:00
parent b23f38facf
commit 0cda12a8bf
19 changed files with 161 additions and 65 deletions
Download Patch File Download Diff File Expand all files Collapse all files
SUBSONIC.md
+6
View File
@@ -11,6 +11,7 @@ OpenSubsonic is an initiative to patch and extend the legacy Subsonic API. You'l
## Extra fields
The following extra fields are implemented:
* `Album` response:
* `mediaType`
* `played`
* `musicBrainzId`
* `genres`
@@ -22,6 +23,10 @@ The following extra fields are implemented:
* `isCompilation`
* `discTitles`: discs with no subtitle are omitted
* `Child` response:
* `bitDepth`
* `samplingRate`
* `channelCount`
* `mediaType`
* `played`
* `musicBrainzId`: note this is actually the recording MBID when this response refers to a song
* `genres`
@@ -33,6 +38,7 @@ The following extra fields are implemented:
* `moods`
* `replayGain`
* `Artist` response:
* `mediaType`
* `musicBrainzId`
* `sortName`
* `roles`
src/libs/av/impl/AudioFile.cpp
+3
View File
@@ -281,9 +281,12 @@ namespace lms::av
res.emplace();
res->index = streamIndex;
res->bitrate = static_cast<std::size_t>(avstream->codecpar->bit_rate);
res->bitsPerSample = static_cast<std::size_t>(avstream->codecpar->bits_per_coded_sample);
res->channelCount = static_cast<std::size_t>(avstream->codecpar->ch_layout.nb_channels);
res->codec = avcodecToDecodingCodec(avstream->codecpar->codec_id);
res->codecName = ::avcodec_get_name(avstream->codecpar->codec_id);
assert(!res->codecName.empty()); // doc says it is never NULL
res->sampleRate = static_cast<std::size_t>(avstream->codecpar->sample_rate);
return res;
}
src/libs/av/include/av/IAudioFile.hpp
+3
View File
@@ -75,6 +75,9 @@ namespace lms::av
{
size_t index{};
std::size_t bitrate{};
std::size_t bitsPerSample{};
std::size_t channelCount{};
std::size_t sampleRate{};
DecodingCodec codec;
std::string codecName;
};
src/libs/database/impl/Migration.cpp
+12 -1
View File
@@ -34,7 +34,7 @@ namespace lms::db
{
namespace
{
static constexpr Version LMS_DATABASE_VERSION{ 55 };
static constexpr Version LMS_DATABASE_VERSION{ 56 };
}
VersionInfo::VersionInfo()
@@ -441,6 +441,16 @@ SELECT
session.getDboSession()->execute("UPDATE scan_settings SET scan_version = scan_version + 1");
}
void migrateFromV55(Session& session)
{
// Add bitsPerSample, channelCount and sampleRate
session.getDboSession()->execute("ALTER TABLE track ADD bits_per_sample INTEGER NOT NULL DEFAULT(0)");
session.getDboSession()->execute("ALTER TABLE track ADD channel_count INTEGER NOT NULL DEFAULT(0)");
session.getDboSession()->execute("ALTER TABLE track ADD sample_rate INTEGER NOT NULL DEFAULT(0)");
// Just increment the scan version of the settings to make the next scheduled scan rescan everything
session.getDboSession()->execute("UPDATE scan_settings SET scan_version = scan_version + 1");
}
void doDbMigration(Session& session)
{
@@ -474,6 +484,7 @@ SELECT
{52, migrateFromV52},
{53, migrateFromV53},
{54, migrateFromV54},
{55, migrateFromV55},
};
{
src/libs/database/include/database/Track.hpp
+16 -4
View File
@@ -133,10 +133,13 @@ namespace lms::db
void setAbsoluteFilePath(const std::filesystem::path& filePath);
void setRelativeFilePath(const std::filesystem::path& filePath);
void setFileSize(std::size_t fileSize) { _fileSize = fileSize; }
void setDuration(std::chrono::milliseconds duration) { _duration = duration; }
void setBitrate(std::size_t bitrate) { _bitrate = bitrate; }
void setLastWriteTime(Wt::WDateTime time) { _fileLastWrite = time; }
void setAddedTime(Wt::WDateTime time) { _fileAdded = time; }
void setBitrate(std::size_t bitrate) { _bitrate = bitrate; }
void setBitsPerSample(std::size_t bitsPerSample) { _bitsPerSample = bitsPerSample; }
void setDuration(std::chrono::milliseconds duration) { _duration = duration; }
void setChannelCount(std::size_t channelCount) { _channelCount = channelCount; }
void setSampleRate(std::size_t channelCount) { _sampleRate = channelCount; }
void setDate(const Wt::WDate& date) { _date = date; }
void setYear(std::optional<int> year) { _year = year; }
void setOriginalDate(const Wt::WDate& date) { _originalDate = date; }
@@ -164,8 +167,11 @@ namespace lms::db
const std::filesystem::path& getAbsoluteFilePath() const { return _absoluteFilePath; }
const std::filesystem::path& getRelativeFilePath() const { return _relativeFilePath; }
long long getFileSize() const { return _fileSize; }
std::chrono::milliseconds getDuration() const { return _duration; }
std::size_t getBitrate() const { return _bitrate; }
std::size_t getBitsPerSample() const { return _bitsPerSample; }
std::size_t getChannelCount() const { return _channelCount; }
std::chrono::milliseconds getDuration() const { return _duration; }
std::size_t getSampleRate() const { return _sampleRate; }
const Wt::WDateTime& getLastWritten() const { return _fileLastWrite; }
const Wt::WDate& getDate() const { return _date; }
std::optional<int> getYear() const { return _year; }
@@ -203,6 +209,9 @@ namespace lms::db
Wt::Dbo::field(a, _name, "name");
Wt::Dbo::field(a, _duration, "duration");
Wt::Dbo::field(a, _bitrate, "bitrate");
Wt::Dbo::field(a, _bitsPerSample, "bits_per_sample");
Wt::Dbo::field(a, _channelCount, "channel_count");
Wt::Dbo::field(a, _sampleRate, "sample_rate");
Wt::Dbo::field(a, _date, "date");
Wt::Dbo::field(a, _year, "year");
Wt::Dbo::field(a, _originalDate, "original_date");
@@ -240,8 +249,11 @@ namespace lms::db
std::optional<int> _totalTrack{};
std::string _discSubtitle;
std::string _name;
std::chrono::duration<int, std::milli> _duration{};
int _bitrate{}; // in bps
int _bitsPerSample{};
int _channelCount{};
std::chrono::duration<int, std::milli> _duration{};
int _sampleRate{};
Wt::WDate _date;
std::optional<int> _year;
Wt::WDate _originalDate;
src/libs/database/test/Track.cpp
+24
View File
@@ -342,4 +342,28 @@ namespace lms::db::tests
EXPECT_EQ(track->getRelativeFilePath(), "foo/file.path");
}
}
TEST_F(DatabaseFixture, Track_audioProperties)
{
ScopedTrack track{ session };
{
auto transaction{ session.createWriteTransaction() };
track.get().modify()->setBitrate(128000);
track.get().modify()->setBitsPerSample(16);
track.get().modify()->setDuration(std::chrono::minutes{ 3 });
track.get().modify()->setChannelCount(2);
track.get().modify()->setSampleRate(44100);
}
{
auto transaction{ session.createReadTransaction() };
EXPECT_EQ(track->getBitrate(), 128000);
EXPECT_EQ(track->getBitsPerSample(), 16);
EXPECT_EQ(track->getDuration(), std::chrono::minutes{ 3 });
EXPECT_EQ(track->getChannelCount(), 2);
EXPECT_EQ(track->getSampleRate(), 44100);
}
}
}
src/libs/metadata/impl/AvFormatTagReader.cpp
+11
View File
@@ -144,6 +144,17 @@ namespace lms::metadata
try
{
const auto audioFile{ av::parseAudioFile(p) };
_audioProperties.duration = audioFile->getContainerInfo().duration;
const auto bestAudioStream{ audioFile->getBestStreamInfo() };
if (bestAudioStream)
{
_audioProperties.bitrate = bestAudioStream->bitrate;
_audioProperties.bitsPerSample = bestAudioStream->bitsPerSample;
_audioProperties.channelCount = bestAudioStream->channelCount;
_audioProperties.sampleRate = bestAudioStream->sampleRate;
}
_containerInfo = audioFile->getContainerInfo();
_metaDataMap = audioFile->getMetaData();
src/libs/metadata/impl/AvFormatTagReader.hpp
+2 -5
View File
@@ -40,12 +40,9 @@ namespace lms::metadata
void visitTagValues(std::string_view tag, TagValueVisitor visitor) const override;
void visitPerformerTags(PerformerVisitor visitor) const override;
bool hasEmbeddedCover() const override { return _hasEmbeddedCover; }
const AudioProperties& getAudioProperties() const override { return _audioProperties; }
std::chrono::milliseconds getDuration() const override { return _containerInfo.duration; }
std::size_t getBitrate() const override { return _containerInfo.bitrate; }
std::size_t getBitsPerSample() const override { return 0; }
std::size_t getSampleRate() const override { return 0; }
AudioProperties _audioProperties;
av::IAudioFile::MetadataMap _metaDataMap;
av::ContainerInfo _containerInfo;
bool _hasEmbeddedCover{};
src/libs/metadata/impl/ITagReader.hpp
+1 -5
View File
@@ -153,10 +153,6 @@ namespace lms::metadata
virtual void visitPerformerTags(PerformerVisitor visitor) const = 0;
virtual bool hasEmbeddedCover() const = 0;
virtual std::chrono::milliseconds getDuration() const = 0;
virtual std::size_t getBitrate() const = 0;
virtual std::size_t getBitsPerSample() const = 0;
virtual std::size_t getSampleRate() const = 0;
virtual const AudioProperties& getAudioProperties() const = 0;
};
} // namespace lms::metadata
src/libs/metadata/impl/Parser.cpp
+1 -7
View File
@@ -235,18 +235,12 @@ namespace lms::metadata
{
auto track{ std::make_unique<Track>() };
processAudioProperties(tagReader, *track);
track->audioProperties = tagReader.getAudioProperties();
processTags(tagReader, *track);
return track;
}
void Parser::processAudioProperties(const ITagReader& tagReader, Track& track)
{
track.duration = tagReader.getDuration();
track.bitrate = tagReader.getBitrate();
}
void Parser::processTags(const ITagReader& tagReader, Track& track)
{
track.hasCover = tagReader.hasEmbeddedCover();
src/libs/metadata/impl/Parser.hpp
-1
View File
@@ -37,7 +37,6 @@ namespace lms::metadata
void setArtistTagDelimiters(std::span<const std::string> delimiters) override { _artistTagDelimiters.assign(std::cbegin(delimiters), std::cend(delimiters)); }
void setDefaultTagDelimiters(std::span<const std::string> delimiters) override { _defaultTagDelimiters.assign(std::cbegin(delimiters), std::cend(delimiters)); }
void processAudioProperties(const ITagReader& reader, Track& track);
void processTags(const ITagReader& reader, Track& track);
std::optional<Medium> getMedium(const ITagReader& tagReader);
src/libs/metadata/impl/TagLibTagReader.cpp
+25 -20
View File
@@ -21,6 +21,7 @@
#include <unordered_map>
#include <taglib/apeproperties.h>
#include <taglib/apetag.h>
#include <taglib/asffile.h>
#include <taglib/id3v2tag.h>
@@ -198,6 +199,8 @@ namespace lms::metadata
throw ParsingFailedException{};
}
computeAudioProperties();
_propertyMap = _file.file()->properties();
// Some tags may not be known by TagLib
@@ -305,6 +308,28 @@ namespace lms::metadata
}
}
void TagLibTagReader::computeAudioProperties()
{
const TagLib::AudioProperties* properties{ _file.audioProperties() };
// Common properties
_audioProperties.bitrate = static_cast<std::size_t>(properties->bitrate() * 1000);
_audioProperties.channelCount = static_cast<std::size_t>(_file.audioProperties()->channels());
_audioProperties.duration = std::chrono::milliseconds{ properties->lengthInMilliseconds() };
_audioProperties.sampleRate = static_cast<std::size_t>(properties->sampleRate());
if (const auto * apeProperties{ dynamic_cast<const TagLib::APE::Properties*>(properties) })
_audioProperties.bitsPerSample = apeProperties->bitsPerSample();
if (const auto * asfProperties{ dynamic_cast<const TagLib::ASF::Properties*>(properties) })
_audioProperties.bitsPerSample = asfProperties->bitsPerSample();
else if (const auto * flacProperties{ dynamic_cast<const TagLib::FLAC::Properties*>(properties) })
_audioProperties.bitsPerSample = flacProperties->bitsPerSample();
else if (const auto * mp4Properties{ dynamic_cast<const TagLib::MP4::Properties*>(properties) })
_audioProperties.bitsPerSample = mp4Properties->bitsPerSample();
else if (const auto * wavePackProperties{ dynamic_cast<const TagLib::WavPack::Properties*>(properties) })
_audioProperties.bitsPerSample = wavePackProperties->bitsPerSample();
}
void TagLibTagReader::visitTagValues(TagType tag, TagValueVisitor visitor) const
{
auto itTagNames{ tagMapping.find(tag) };
@@ -362,24 +387,4 @@ namespace lms::metadata
}
}
}
std::chrono::milliseconds TagLibTagReader::getDuration() const
{
return std::chrono::milliseconds{ _file.audioProperties()->lengthInMilliseconds() };
}
std::size_t TagLibTagReader::getBitrate() const
{
return static_cast<std::size_t>(_file.audioProperties()->bitrate() * 1000);
}
std::size_t TagLibTagReader::getBitsPerSample() const
{
return 0; // TODO
}
std::size_t TagLibTagReader::getSampleRate() const
{
return static_cast<std::size_t>(_file.audioProperties()->sampleRate());
}
} // namespace lms::metadata
src/libs/metadata/impl/TagLibTagReader.hpp
+3 -4
View File
@@ -38,17 +38,16 @@ namespace lms::metadata
TagLibTagReader(const TagLibTagReader&) = delete;
TagLibTagReader& operator=(const TagLibTagReader&) = delete;
void computeAudioProperties();
void visitTagValues(TagType tag, TagValueVisitor visitor) const override;
void visitTagValues(std::string_view tag, TagValueVisitor visitor) const override;
void visitPerformerTags(PerformerVisitor visitor) const override;
bool hasEmbeddedCover() const override { return _hasEmbeddedCover; }
std::chrono::milliseconds getDuration() const override;
std::size_t getBitrate() const override;
std::size_t getBitsPerSample() const override;
std::size_t getSampleRate() const override;
const AudioProperties& getAudioProperties() const override { return _audioProperties; }
const TagLib::FileRef _file;
AudioProperties _audioProperties;
TagLib::PropertyMap _propertyMap; // case-insensitive keys
bool _hasEmbeddedCover{};
};
src/libs/metadata/include/metadata/IParser.hpp
+10 -2
View File
@@ -83,8 +83,18 @@ namespace lms::metadata
}
};
struct AudioProperties
{
std::size_t bitrate{};
std::size_t bitsPerSample{};
std::size_t channelCount{};
std::chrono::milliseconds duration{};
std::size_t sampleRate{};
};
struct Track
{
AudioProperties audioProperties;
std::optional<core::UUID> mbid;
std::optional<core::UUID> recordingMBID;
std::string title;
@@ -96,8 +106,6 @@ namespace lms::metadata
std::vector<std::string> labels;
std::vector<std::string> languages;
Tags userExtraTags;
std::chrono::milliseconds duration{};
std::size_t bitrate{};
std::optional<int> year{};
Wt::WDate date;
std::optional<int> originalYear{};
src/libs/metadata/test/Parser.cpp
+10 -2
View File
@@ -88,6 +88,16 @@ namespace lms::metadata
std::unique_ptr<Track> track{ parser.parse(testTags) };
// Audio properties
{
const AudioProperties& audioProperties{ testTags.getAudioProperties() };
EXPECT_EQ(track->audioProperties.bitrate, audioProperties.bitrate);
EXPECT_EQ(track->audioProperties.bitsPerSample, audioProperties.bitsPerSample);
EXPECT_EQ(track->audioProperties.channelCount, audioProperties.channelCount);
EXPECT_EQ(track->audioProperties.duration, audioProperties.duration);
EXPECT_EQ(track->audioProperties.sampleRate, audioProperties.sampleRate);
}
EXPECT_EQ(track->acoustID, core::UUID::fromString("e987a441-e134-4960-8019-274eddacc418"));
EXPECT_EQ(track->artistDisplayName, "MyArtist1 & MyArtist2");
ASSERT_EQ(track->artists.size(), 2);
@@ -97,7 +107,6 @@ namespace lms::metadata
EXPECT_EQ(track->artists[1].name, "MyArtist2");
EXPECT_EQ(track->artists[1].sortName, "MyArtist2SortName");
EXPECT_EQ(track->artists[1].mbid, core::UUID::fromString("5e2cf87f-c8d7-4504-8a86-954dc0840229"));
EXPECT_EQ(track->bitrate, TestTagReader::trackBitrate);
ASSERT_EQ(track->composerArtists.size(), 2);
EXPECT_EQ(track->composerArtists[0].name, "MyComposer1");
EXPECT_EQ(track->composerArtists[0].sortName, "MyComposerSortOrder1");
@@ -112,7 +121,6 @@ namespace lms::metadata
EXPECT_EQ(track->date.year(), 2020);
EXPECT_EQ(track->date.month(), 3);
EXPECT_EQ(track->date.day(), 4);
EXPECT_EQ(track->duration, TestTagReader::trackDuration);
EXPECT_FALSE(track->hasCover);
ASSERT_EQ(track->genres.size(), 2);
EXPECT_EQ(track->genres[0], "Genre1");
src/libs/metadata/test/TestTagReader.hpp
+9 -8
View File
@@ -28,10 +28,14 @@ namespace lms::metadata
class TestTagReader : public ITagReader
{
public:
static constexpr std::chrono::milliseconds trackDuration{ 180 };
static constexpr std::size_t trackBitrate{ 128000 };
static constexpr std::size_t trackBitsPerSample{ 16 };
static constexpr std::size_t trackSampleRate{ 44000 };
static constexpr AudioProperties audioProperties
{
.bitrate = 128000,
.bitsPerSample = 16,
.channelCount = 2,
.duration = std::chrono::seconds{180},
.sampleRate = 44000,
};
using Tags = std::unordered_map<TagType, std::vector<std::string_view>>;
using Performers = std::unordered_map<std::string_view, std::vector<std::string_view>>;
@@ -73,10 +77,7 @@ namespace lms::metadata
bool hasEmbeddedCover() const override { return false; };
std::chrono::milliseconds getDuration() const override { return trackDuration; }
std::size_t getBitrate() const override { return trackBitrate; }
std::size_t getBitsPerSample() const override { return trackBitsPerSample; }
std::size_t getSampleRate() const override { return trackSampleRate; }
const AudioProperties& getAudioProperties() const override { return audioProperties; }
private:
const Tags _tags;
src/libs/services/scanner/impl/ScanStepScanFiles.cpp
+8 -3
View File
@@ -593,7 +593,7 @@ namespace lms::scanner
}
// We estimate this is an audio file if the duration is not null
if (trackMetadata.duration == std::chrono::milliseconds::zero())
if (trackMetadata.audioProperties.duration == std::chrono::milliseconds::zero())
{
LMS_LOG(DBUPDATER, DEBUG, "Skipped '" << file.string() << "' (duration is 0)");
@@ -631,6 +631,13 @@ namespace lms::scanner
// Track related data
assert(track);
// Audio properties
track.modify()->setBitrate(trackMetadata.audioProperties.bitrate);
track.modify()->setBitsPerSample(trackMetadata.audioProperties.bitsPerSample);
track.modify()->setChannelCount(trackMetadata.audioProperties.channelCount);
track.modify()->setDuration(trackMetadata.audioProperties.duration);
track.modify()->setSampleRate(trackMetadata.audioProperties.sampleRate);
track.modify()->setRelativeFilePath(fileInfo->relativePath);
track.modify()->setFileSize(fileInfo->fileSize);
track.modify()->setLastWriteTime(fileInfo->lastWriteTime);
@@ -683,8 +690,6 @@ namespace lms::scanner
track.modify()->setDiscSubtitle(trackMetadata.medium ? trackMetadata.medium->name : "");
track.modify()->setClusters(getOrCreateClusters(dbSession, trackMetadata));
track.modify()->setName(title);
track.modify()->setDuration(trackMetadata.duration);
track.modify()->setBitrate(trackMetadata.bitrate);
track.modify()->setAddedTime(Wt::WDateTime::currentDateTime());
track.modify()->setTrackNumber(trackMetadata.position);
track.modify()->setDiscNumber(trackMetadata.medium ? trackMetadata.medium->position : std::nullopt);
src/libs/subsonic/impl/responses/Song.cpp
+4
View File
@@ -139,6 +139,10 @@ namespace lms::api::subsonic
if (!context.enableOpenSubsonic)
return trackResponse;
trackResponse.setAttribute("bitDepth", track->getBitsPerSample());
trackResponse.setAttribute("samplingRate", track->getSampleRate());
trackResponse.setAttribute("channelCount", track->getChannelCount());
trackResponse.setAttribute("mediaType", "song");
{
src/tools/metadata/LmsMetadata.cpp
+13 -3
View File
@@ -32,6 +32,17 @@
namespace lms::metadata
{
std::ostream& operator<<(std::ostream& os, const AudioProperties& audioProperties)
{
os << "\tBitrate: " << audioProperties.bitrate << " bps" << std::endl;
os << "\tBitsPerSample: " << audioProperties.bitsPerSample << std::endl;
os << "\tChannelCount: " << audioProperties.channelCount << std::endl;
os << "\tDuration: " << std::fixed << std::setprecision(2) << audioProperties.duration.count() / 1000. << "s" << std::endl;
os << "\tSampleRate: " << audioProperties.sampleRate << std::endl;
return os;
}
std::ostream& operator<<(std::ostream& os, const Artist& artist)
{
os << artist.name;
@@ -107,6 +118,8 @@ namespace lms::metadata
std::cout << "Parsing time: " << std::fixed << std::setprecision(2) << std::chrono::duration_cast<std::chrono::microseconds>(end - start).count() / 1000. << "ms" << std::endl;
std::cout << "Audio properties:\n" << track->audioProperties << std::endl;
std::cout << "Parsed metadata:" << std::endl;
if (!track->artistDisplayName.empty())
@@ -178,9 +191,6 @@ namespace lms::metadata
}
}
std::cout << "Duration: " << std::fixed << std::setprecision(2) << track->duration.count() / 1000. << "s" << std::endl;
std::cout << "Bitrate: " << track->bitrate << " bps" << std::endl;
if (track->position)
std::cout << "Position: " << *track->position << std::endl;