-
-
Notifications
You must be signed in to change notification settings - Fork 4
/
PlaylistMetadataScanner.Parsers.cs
655 lines (536 loc) · 25.9 KB
/
PlaylistMetadataScanner.Parsers.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
// Copyright (c) Arlo Godfrey. All Rights Reserved.
// Licensed under the GNU Lesser General Public License, Version 3.0 with additional terms.
// See the LICENSE, LICENSE.LESSER and LICENSE.ADDITIONAL files in the project root for more information.
using System;
using System.Collections.Generic;
using System.Globalization;
using System.IO;
using System.Linq;
using System.Text;
using System.Text.RegularExpressions;
using System.Threading.Tasks;
using System.Xml;
using System.Xml.Linq;
using System.Xml.Serialization;
using OwlCore.AbstractStorage;
using OwlCore.Extensions;
using StrixMusic.Sdk.FileMetadata.Models;
using StrixMusic.Sdk.FileMetadata.Models.Playlist.Smil;
namespace StrixMusic.Sdk.FileMetadata.Scanners
{
public partial class PlaylistMetadataScanner
{
/// <summary>
/// Scans playlist file for metadata.
/// </summary>
/// <param name="rootFolder">The most folder that we have permission to access files.</param>
/// <param name="playlistFile">The path to the file.</param>
/// <param name="files">The relevant files to link data to.</param>
/// <returns>Fully scanned <see cref="PlaylistMetadata"/>.</returns>
public static async Task<PlaylistMetadata?> ScanPlaylistMetadata(IFolderData rootFolder, IFileData playlistFile, IEnumerable<Models.FileMetadata> files)
{
PlaylistMetadata? playlistMetadata;
switch (playlistFile.FileExtension)
{
case ".zpl":
case ".wpl":
case ".smil":
playlistMetadata = await GetSmilMetadata(playlistFile, files);
break;
case ".m3u":
case ".m3u8":
case ".vlc":
playlistMetadata = await GetM3UMetadata(playlistFile, files);
break;
case ".xspf":
playlistMetadata = await GetXspfMetadata(playlistFile, files);
break;
case ".asx":
playlistMetadata = await GetAsxMetadata(playlistFile, files);
break;
case ".mpcpl":
playlistMetadata = await GetMpcplMetadata(playlistFile, files);
break;
case ".fpl":
playlistMetadata = await GetFplMetadata(playlistFile, files);
break;
case ".pls":
playlistMetadata = await GetPlsMetadata(playlistFile, files);
break;
case ".aimppl4":
playlistMetadata = await GetAimpplMetadata(playlistFile, files);
break;
default:
// Format not supported
return null;
}
return playlistMetadata;
}
/// <summary>
/// Gets tracks from the SMIL metatdata in <paramref name="playlistFile"/> and links them to the given <paramref name="files"/>.
/// </summary>
/// <param name="playlistFile">The path to the file.</param>
/// <param name="files">The scanned metadata files.</param>
/// <remarks>Recognizes Zune's ZPL and WMP's WPL.</remarks>
private static async Task<PlaylistMetadata?> GetSmilMetadata(IFileData playlistFile, IEnumerable<Models.FileMetadata> files)
{
var ser = new XmlSerializer(typeof(Smil));
using var stream = await playlistFile.GetStreamAsync();
using var xmlReader = new XmlTextReader(stream);
var smil = ser.Deserialize(xmlReader) as Smil;
var playlist = new PlaylistMetadata
{
Id = playlistFile.Path.HashMD5Fast(),
};
var mediaList = smil?.Body?.Seq?.Media?.ToList();
playlist.Title = smil?.Head?.Title;
if (mediaList == null)
return null;
playlist.TrackIds = new HashSet<string>();
foreach (var media in mediaList)
{
if (media.Src != null)
{
if (Uri.TryCreate(media.Src, UriKind.RelativeOrAbsolute, out Uri uri))
{
var hash = TryGetHashFromExistingTracks(uri, files);
if (hash != null)
{
playlist.Duration ??= default;
playlist.TrackIds.Add(media.Src.HashMD5Fast());
}
}
}
playlist.TotalTrackCount++;
}
return playlist;
}
/// <summary>
/// Gets tracks from the M3U metatdata in <paramref name="playlistFile"/> and links them to the given <paramref name="files"/>.
/// </summary>
/// <param name="playlistFile">The path to the file.</param>
/// <param name="files">The relevant files to link data to.</param>
/// <remarks>Recognizes both M3U (default encoding) and M3U8 (UTF-8 encoding).</remarks>
private static async Task<PlaylistMetadata?> GetM3UMetadata(IFileData playlistFile, IEnumerable<Models.FileMetadata> files)
{
using var stream = await playlistFile.GetStreamAsync();
using var content = playlistFile.FileExtension == ".m3u8" ? new StreamReader(stream, Encoding.UTF8) : new StreamReader(stream);
var playlist = new PlaylistMetadata()
{
Id = playlistFile.Path.HashMD5Fast(),
};
while (!content.EndOfStream)
{
var line = await content.ReadLineAsync();
// Handle M3U directives
if (line[0] == '#')
{
// --++ Extended M3U ++--
// Playlist display title
if (line.StartsWith("#PLAYLIST:", StringComparison.InvariantCulture))
{
playlist.Title = line.Split(':')[1];
}
}
else
{
if (Uri.TryCreate(line, UriKind.RelativeOrAbsolute, out Uri uri))
{
var hash = TryGetHashFromExistingTracks(uri, files);
if (hash != null)
{
playlist.TrackIds ??= new HashSet<string>();
playlist.TrackIds.Add(hash);
}
}
}
}
playlist.Title ??= playlistFile.Name; // If the title is null, filename is assigned because if a playlist has no title its not visible to the user on UI.
return playlist;
}
/// <summary>
/// Gets tracks from the XSPF metatdata in <paramref name="playlistFile"/> and links them to the given <paramref name="files"/>.
/// </summary>
/// <remarks>Does not support any application extensions.</remarks>
/// <param name="playlistFile">The file to scan for metadata.</param>
/// <param name="files">The scanned metadata files.</param>
private static async Task<PlaylistMetadata?> GetXspfMetadata(IFileData playlistFile, IEnumerable<Models.FileMetadata> files)
{
using var stream = await playlistFile.GetStreamAsync();
var doc = XDocument.Load(stream);
var xmlRoot = doc.Root;
var xmlns = xmlRoot.GetDefaultNamespace().NamespaceName;
var trackList = xmlRoot.Element(XName.Get("trackList", xmlns));
var trackListElements = trackList.Elements(XName.Get("track", xmlns));
var listElements = trackListElements as XElement[] ?? trackListElements.ToArray();
var playlist = new PlaylistMetadata()
{
Id = playlistFile.Path.HashMD5Fast(),
Title = xmlRoot.Element(XName.Get("title", xmlns))?.Value,
TotalTrackCount = listElements.Length,
Description = xmlRoot.Element(XName.Get("annotation", xmlns))?.Value,
};
var url = xmlRoot.Element(XName.Get("info", xmlns))?.Value;
if (url != null)
playlist.Url = new Uri(url);
foreach (var media in listElements)
{
var location = media.Element(XName.Get("location", xmlns))?.Value;
if (location != null)
{
if (Uri.TryCreate(location, UriKind.RelativeOrAbsolute, out Uri localPath))
{
playlist.TrackIds ??= new HashSet<string>();
localPath = new Uri(location);
var hash = TryGetHashFromExistingTracks(localPath, files);
if (hash != null)
playlist.TrackIds.Add(hash);
}
}
}
return playlist;
}
/// <summary>
/// Gets tracks from the ASX metatdata in <paramref name="playlistFile"/> and links them to the given <paramref name="files"/>.
/// </summary>
/// <param name="playlistFile">The file to scan for metadata.</param>
/// <param name="files">The scanned metadata files.</param>
/// <remarks>Does not support ENTRYREF.</remarks>
private static async Task<PlaylistMetadata?> GetAsxMetadata(IFileData playlistFile, IEnumerable<Models.FileMetadata> files)
{
using var stream = await playlistFile.GetStreamAsync();
var doc = XDocument.Load(stream);
var asx = doc.Root;
var entries = asx.Elements("entry");
var baseUrl = asx.Element("base")?.Value ?? string.Empty;
var playlist = new PlaylistMetadata()
{
Id = playlistFile.Path.HashMD5Fast(),
Title = asx.Element("title")?.Value,
};
foreach (var entry in entries)
{
var entryBaseUrl = entry.Element("base")?.Value ?? string.Empty;
// TODO: Where does the track ID come from?
var path = $"{baseUrl} {entryBaseUrl} {entry.Element("ref")?.Attribute("href")?.Value}";
if (Uri.TryCreate(path, UriKind.RelativeOrAbsolute, out Uri uri))
{
var hash = TryGetHashFromExistingTracks(uri, files);
playlist.TrackIds ??= new HashSet<string>();
if (hash != null)
{
playlist.TrackIds.Add(hash);
}
}
}
return playlist;
}
/// <summary>
/// Gets tracks from the MPC-PL metatdata in <paramref name="playlistFile"/> and links them to the given <paramref name="files"/>.
/// </summary>
/// <param name="playlistFile">The file to scan for metadata.</param>
/// <param name="files">The scanned metadata files.</param>
private static async Task<PlaylistMetadata?> GetMpcplMetadata(IFileData playlistFile, IEnumerable<Models.FileMetadata> files)
{
using var stream = await playlistFile.GetStreamAsync();
using var content = new StreamReader(stream);
var metadata = new PlaylistMetadata();
var tracks = new List<TrackMetadata>();
// Make sure the file is either a "pointer" to a folder
// or an MPC playlist
var firstLine = await content.ReadLineAsync();
if (firstLine != "MPCPLAYLIST")
return null;
while (!content.EndOfStream)
{
var trackMetadata = new TrackMetadata();
var line = await content.ReadLineAsync();
var components = Regex.Match(line, @"^(?<idx>[0-9]+),(?<attr>[A-z]+),(?<val>.+)$").Groups;
switch (components["attr"].Value)
{
case "filename":
var fullPath = ResolveFilePath(components["val"].Value, playlistFile.Path);
trackMetadata.Url = fullPath;
var idx = int.Parse(components["idx"].Value, CultureInfo.InvariantCulture);
if (idx >= tracks.Count)
tracks.Add(trackMetadata);
else
tracks.Insert(idx, trackMetadata);
break;
case "type":
// No idea what this is supposed to mean.
// It's not documented anywhere. Probably supposed to be an enum.
default:
// Unsupported attribute
break;
}
}
return metadata;
}
/// <summary>
/// Gets tracks from the FPL metatdata in <paramref name="playlistFile"/> and links them to the given <paramref name="files"/>.
/// </summary>
/// <param name="playlistFile">The file to scan for metadata.</param>
/// <param name="files">The scanned metadata files.</param>
/// <remarks>
/// Supports playlists created by foobar2000 v0.9.1 and newer.
/// Based on the specification here: https://github.com/rr-/fpl_reader/blob/master/fpl-format.md
/// </remarks>
private static async Task<PlaylistMetadata?> GetFplMetadata(IFileData playlistFile, IEnumerable<Models.FileMetadata> files)
{
try
{
// The magic field is a 16-byte magic number.
// More details: https://github.com/rr-/fpl_reader/blob/master/fpl-format.md#magic
byte[] fplMagic = new byte[]
{
0xE1, 0xA0, 0x9C, 0x91, 0xF8, 0x3C, 0x77, 0x42, 0x85, 0x2C, 0x3B, 0xCC, 0x14, 0x01, 0xD3, 0xF2
};
using var stream = await playlistFile.GetStreamAsync();
using var content = new BinaryReader(stream);
var playlist = new PlaylistMetadata()
{
Id = playlistFile.Path.HashMD5Fast()
};
// Make sure the file is an FPL
var fileMagic = content.ReadBytes(fplMagic.Length);
if (!fileMagic.SequenceEqual(fplMagic))
return null;
// foobar2000 playlists don't have titles, so set it
// to the file name
playlist.Title = playlistFile.DisplayName;
// Get size of meta
var metaSize = content.ReadUInt32();
// Read meta strings (null-terminated)
var metaBytes = new byte[metaSize];
var metaPos = stream.Position;
await stream.ReadAsync(metaBytes, 0, metaBytes.Length);
var metas = new List<string>();
if (metas == null) return null;
var metaTemp = string.Empty;
foreach (var b in metaBytes)
{
if (b == 0x00)
{
// End of string
metas.Add(metaTemp);
metaTemp = string.Empty;
}
else
{
// TODO: Is there a better way to do this?
metaTemp += Encoding.UTF8.GetChars(new[] { b })[0];
}
}
// Get track count
var trackCount = content.ReadUInt32();
for (var i = 0; i < trackCount; i++)
{
// Get flags
var flags = content.ReadInt32();
// Get file name offset
var fileNameOffset = content.ReadUInt32();
// Retrieve file name
var curPos = stream.Position;
stream.Seek(metaPos + fileNameOffset, SeekOrigin.Begin);
var pathToTrack = stream.ReadNullTerminatedString(Encoding.UTF8);
stream.Seek(curPos, SeekOrigin.Begin);
playlist.TrackIds ??= new HashSet<string>();
// Get track file size
var fileSize = content.ReadUInt64();
// Get track file time (last modified)
var fileTime = content.ReadUInt64();
// Get track duration
var durationSeconds = content.ReadDouble();
// Get rpg_album, rpg_track, rpk_album, rpk_track
// We don't need it but might as well read it
var rpgAlbum = content.ReadSingle();
var rpgTrack = content.ReadSingle();
var rpkAlbum = content.ReadSingle();
var rpkTrack = content.ReadSingle();
// Get entry count
var entryCount = (int)content.ReadUInt32();
var primaryKeyCount = (int)content.ReadUInt32();
var secondaryKeyCount = (int)content.ReadUInt32();
var secondaryKeysOffset = (int)content.ReadUInt32();
var primaryPairs = new Dictionary<string, string>(primaryKeyCount);
// Get primary keys
var primaryKeys = new Dictionary<uint, string>(primaryKeyCount);
for (var x = 0; x < primaryKeyCount; x++)
{
var id = content.ReadUInt32();
var nameOffset = content.ReadUInt32();
curPos = stream.Position;
stream.Seek(metaPos + nameOffset, SeekOrigin.Begin);
primaryKeys[id] = stream.ReadNullTerminatedString(Encoding.UTF8);
stream.Seek(curPos, SeekOrigin.Begin);
}
// Read 'unk0', no idea what it does
var unk0 = content.ReadUInt32();
// Get primary pair values
var previousPrimaryKey = primaryKeys.First().Value;
for (uint x = 0; x < primaryKeyCount; x++)
{
if (!string.IsNullOrEmpty(pathToTrack))
{
var valueOffset = content.ReadUInt32();
curPos = stream.Position;
stream.Seek(metaPos + valueOffset, SeekOrigin.Begin);
var value = stream.ReadNullTerminatedString(Encoding.UTF8);
stream.Seek(curPos, SeekOrigin.Begin);
if (Uri.TryCreate(pathToTrack, UriKind.RelativeOrAbsolute, out Uri uri))
{
var hash = TryGetHashFromExistingTracks(uri, files);
if (hash != null)
{
playlist.TrackIds ??= new HashSet<string>();
playlist.TrackIds.Add(hash);
}
}
if (primaryKeys.TryGetValue(x, out string val))
previousPrimaryKey = val;
primaryPairs.Add(previousPrimaryKey, value);
}
}
}
return playlist;
}
catch (Exception)
{
return null;
}
}
/// <summary>
/// Gets tracks from the PLS metatdata in <paramref name="playlistFile"/> and links them to the given <paramref name="files"/>.
/// </summary>
private static async Task<PlaylistMetadata?> GetPlsMetadata(IFileData playlistFile, IEnumerable<Models.FileMetadata> files)
{
using var stream = await playlistFile.GetStreamAsync();
using var content = new StreamReader(stream);
var playlist = new PlaylistMetadata()
{
Id = playlistFile.Path.HashMD5Fast(),
Title = playlistFile.DisplayName
};
// Make sure the file is really a PLS file
var firstLine = await content.ReadLineAsync();
// Not a valid PLS playlist
if (firstLine != "[playlist]")
return null;
var matches = new List<Match>();
while (!content.EndOfStream)
{
var line = await content.ReadLineAsync();
var match = Regex.Match(line, @"^(?<key>[A-Za-z]+)(?<idx>[0-9]*)=(?<val>.+)$", RegexOptions.Compiled);
if (match.Success)
matches.Add(match);
}
var trackCountMatch = matches.First(m => m.Groups["key"].Value == "NumberOfEntries");
var trackCount = uint.Parse(trackCountMatch.Groups["val"].Value, CultureInfo.InvariantCulture);
matches.Remove(trackCountMatch);
var tracksTable = new Dictionary<int, TrackMetadata>((int)trackCount);
foreach (var match in matches)
{
var value = match.Groups["val"].Value;
var indexStr = match.Groups["idx"]?.Value;
if (int.TryParse(indexStr, out var index))
{
if (!tracksTable.ContainsKey(index))
tracksTable[index] = new TrackMetadata();
}
switch (match.Groups["key"].Value)
{
case "File":
if (Uri.TryCreate(ResolveFilePath(value, playlistFile), UriKind.RelativeOrAbsolute, out Uri uri))
{
var hash = TryGetHashFromExistingTracks(uri, files);
if (hash != null)
{
playlist.TrackIds ??= new HashSet<string>();
playlist.TrackIds.Add(hash);
}
}
break;
}
}
// Collapse the tracks table to a plain list
var tracks = tracksTable.Select(t => t.Value).PruneNull().ToList();
return playlist;
}
/// <summary>
/// Gets tracks from the AIMPPL metatdata in <paramref name="playlistFile"/> and links them to the given <paramref name="files"/>.
/// </summary>
/// <remarks>Only tested with AIMPPL4 files.</remarks>
/// <param name="playlistFile">The file to scan for metadata.</param>
/// <param name="files">The relevant files to link data to.</param>
private static async Task<PlaylistMetadata?> GetAimpplMetadata(IFileData playlistFile, IEnumerable<Models.FileMetadata> files)
{
// Adapted from https://github.com/ApexWeed/aimppl-copy/
using var stream = await playlistFile.GetStreamAsync();
using var content = new StreamReader(stream);
var playlist = new PlaylistMetadata()
{
Id = playlistFile.Path.HashMD5Fast(),
};
var mode = AimpplPlaylistMode.Summary;
while (!content.EndOfStream)
{
var line = await content.ReadLineAsync();
if (string.IsNullOrWhiteSpace(line))
continue;
switch (line)
{
case "#-----SUMMARY-----#":
mode = AimpplPlaylistMode.Summary;
continue;
case "#-----SETTINGS-----#":
mode = AimpplPlaylistMode.Settings;
continue;
case "#-----CONTENT-----#":
mode = AimpplPlaylistMode.Content;
continue;
default:
switch (mode)
{
case AimpplPlaylistMode.Summary:
{
var split = line.IndexOf('=');
var variable = line.Substring(0, split);
var value = line.Substring(split + 1);
if (variable == "Name")
playlist.Title = value;
break;
}
case AimpplPlaylistMode.Settings:
break;
case AimpplPlaylistMode.Content:
{
if (string.IsNullOrWhiteSpace(line))
continue;
if (line.StartsWith("-", StringComparison.InvariantCulture))
break;
var trackComponents = line.Split('|');
if (trackComponents.FirstOrDefault() != null)
{
if (Uri.TryCreate(trackComponents[0], UriKind.RelativeOrAbsolute, out Uri uri))
{
var hash = TryGetHashFromExistingTracks(uri, files);
if (hash != null)
{
playlist.TrackIds ??= new HashSet<string>();
playlist.TrackIds.Add(hash);
}
}
}
break;
}
default:
throw new ArgumentOutOfRangeException();
}
break;
}
}
return playlist;
}
}
}