mirror of
https://github.com/koel/koel
synced 2024-11-24 13:13:05 +00:00
108 lines
3.3 KiB
PHP
108 lines
3.3 KiB
PHP
<?php
|
|
|
|
namespace App\Values;
|
|
|
|
use App\Models\Album;
|
|
use App\Models\Artist;
|
|
use App\Services\Helper;
|
|
use Illuminate\Contracts\Support\Arrayable;
|
|
use Illuminate\Support\Arr;
|
|
|
|
final class SongScanInformation implements Arrayable
|
|
{
|
|
private function __construct(
|
|
public ?string $title,
|
|
public ?string $albumName,
|
|
public ?string $artistName,
|
|
public ?string $albumArtistName,
|
|
public ?int $track,
|
|
public ?int $disc,
|
|
public ?string $lyrics,
|
|
public ?float $length,
|
|
public ?array $cover,
|
|
public ?string $path,
|
|
public ?int $mTime,
|
|
) {
|
|
}
|
|
|
|
public static function fromGetId3Info(array $info): self
|
|
{
|
|
// We prefer ID3v2 tags over ID3v1 tags.
|
|
$tags = array_merge(
|
|
Arr::get($info, 'tags.id3v1', []),
|
|
Arr::get($info, 'tags.id3v2', []),
|
|
Arr::get($info, 'comments', []),
|
|
);
|
|
|
|
$comments = Arr::get($info, 'comments', []);
|
|
|
|
$albumArtistName = self::getTag($tags, ['albumartist', 'album_artist', 'band']);
|
|
|
|
// If the song is explicitly marked as a compilation but there's no album artist name, use the umbrella
|
|
// "Various Artists" artist.
|
|
if (self::getTag($tags, 'part_of_a_compilation') && !$albumArtistName) {
|
|
$albumArtistName = Artist::VARIOUS_NAME;
|
|
}
|
|
|
|
$path = Arr::get($info, 'filenamepath');
|
|
|
|
$cover = [self::getTag($comments, 'cover', null)];
|
|
|
|
if ($cover[0] === null) {
|
|
$cover = self::getTag($comments, 'picture', []);
|
|
}
|
|
|
|
$lyrics = html_entity_decode(self::getTag($tags, [
|
|
'unsynchronised_lyric',
|
|
'unsychronised_lyric',
|
|
'unsyncedlyrics',
|
|
]));
|
|
|
|
return new self(
|
|
title: html_entity_decode(self::getTag($tags, 'title', pathinfo($path, PATHINFO_FILENAME))),
|
|
albumName: html_entity_decode(self::getTag($tags, 'album', Album::UNKNOWN_NAME)),
|
|
artistName: html_entity_decode(self::getTag($tags, 'artist', Artist::UNKNOWN_NAME)),
|
|
albumArtistName: html_entity_decode($albumArtistName),
|
|
track: (int) self::getTag($tags, ['track', 'tracknumber', 'track_number']),
|
|
disc: (int) self::getTag($tags, ['discnumber', 'part_of_a_set'], 1),
|
|
lyrics: $lyrics,
|
|
length: (float) Arr::get($info, 'playtime_seconds'),
|
|
cover: $cover,
|
|
path: $path,
|
|
mTime: Helper::getModifiedTime($path),
|
|
);
|
|
}
|
|
|
|
private static function getTag(array $arr, string | array $keys, $default = ''): mixed
|
|
{
|
|
$keys = Arr::wrap($keys);
|
|
|
|
for ($i = 0; $i < count($keys); ++$i) {
|
|
$value = Arr::get($arr, $keys[$i] . '.0');
|
|
|
|
if ($value) {
|
|
break;
|
|
}
|
|
}
|
|
|
|
return $value ?? $default;
|
|
}
|
|
|
|
/** @return array<mixed> */
|
|
public function toArray(): array
|
|
{
|
|
return [
|
|
'title' => $this->title,
|
|
'album' => $this->albumName,
|
|
'artist' => $this->artistName,
|
|
'albumartist' => $this->albumArtistName,
|
|
'track' => $this->track,
|
|
'disc' => $this->disc,
|
|
'lyrics' => $this->lyrics,
|
|
'length' => $this->length,
|
|
'cover' => $this->cover,
|
|
'path' => $this->path,
|
|
'mtime' => $this->mTime,
|
|
];
|
|
}
|
|
}
|