Fix playing back audio files & reading music metadata

[Borewit]

Replaced musicmetadata with music-metadata module. The original one appears to be no longer maintained.

Fixes bug #1320, playing back audio files broken: caused by stream incompatibility between musicmetadata & readable-stream.

Should be faster, more stable is able to read more metadata and format information.
Supports additional audio formats and metadata tag headers.

Added audio format & some release information to the lay screen.

You could also use the library to retrieve album art from the audio files.

[Borewit]

Would be great if one can review this proposal.

[Borewit]

Playing Opus audio and demonstrating visualization of its metadata:

[Borewit]

Added separate elements for year & album release information:

[Borewit]

@codealchemist: can you please review my commits?

[Borewit]

Fixed the Ogg metadata (make sure you clear cached metadata by removing and re-adding the torrent):

[Borewit]

@codealchemist:

If we can't get metadata maybe we can show the filename instead.
That should already be the case:

const title = common.title ? common.title : fileSummary.name

Recreated a torrent using the same test file, but stripped of all metadata:

[Borewit]

@DiegoRBaquero:

can you include automated tests?

Just to be on the same page, it is not something new I am introducing here. Although I did add additional fields in the player page, I believe it fixes and improves existing functionality. As far as I have seen nothing was unit tested yet. Given this context, I think it is a bit odd to require unit test prior to merge, but I do fully understand it is desired

The music-metadata is heavily unit tested, also the ogg file which was causing a problems has been added as a unit test.

But what you are looking for is probably some extension of the test-integration demonstrating the metadata resolving is working, right?

I don't mind to look into it, problem is that I did not manage get the tests running.

[Borewit]

@DiegoRBaquero: I am one step further with the test-integration. At least I can run the test-audio.js which actually did capture some metadata output testing via screenshot validation. I will update those accordingly.

[Borewit]

@DiegoRBaquero : I noticed βTorrent can you use a boost as well in audio playback functionality 😉

[Borewit]

@codealchemist can you please generate the darwin screenshots for me.

I tried to generate the OSX screenshots for the integration tests on VIrtualBox. I did not succeed. I set the resolution to 2304x1440, which I think is equivalent to the 2016 12" Macbook. I guess there is some (retina) scaling factor into play which causes my screen dumps from OSX to be to small.

I can add the transparency parts; if you just push the failed images, that would be great.

[DiegoRBaquero]

Works for me now.

@Borewit What would you want to include in BTorrent? The streaming is pretty much restricted to the native browser functionality.

[Borewit]

@DiegoRBaquero, in a couple of days I will open an issue on your repo with some ideas.

[codealchemist]

Retested with the problematic OGG file and now it works alright :)

I think there's still one problem with MP3 files that didn't finish downloading.
Looks like metadata is not yet available and we're displaying a blank screen.

[codealchemist]

Also, related to unfinished MP3 files: when the file finishes downloading it's not refreshing its metadata, which is available if I go back to the list and play it again.

[codealchemist]

An unfinished MP3 file, which shows a blank screen on WebTorrent Desktop, when opened with OSX Preview tool displays metadata:

[codealchemist]

Just tested reading that incomplete MP3 file with music-metadata on a unit test I'm adding and the content looks correct:

  Parsing MPEG / ID3v1
    should handle incomplete MP3 file
METADATA: { format:
   { lossless: false,
     dataformat: 'mp3',
     bitrate: 64000,
     sampleRate: 22050,
     numberOfChannels: 2,
     codecProfile: 'CBR',
     numberOfSamples: 95910336,
     duration: 4349.6751020408165,
     tagTypes: [ 'ID3v2.3', 'ID3v1.1' ] },
  native: undefined,
  common:
   { track: { no: null, of: null },
     disk: { no: null, of: null },
     picture: [ [Object] ],
     title: 'Al-An\'am',
     year: 2007,
     comment: [ 'www.TvQuran.com' ],
     album: 'www.TvQuran.com',
     genre: [ 'www.TvQuran.com' ],
     artist: 'Mishary Alafasi - www.TvQuran.com',
     artists: [ 'Mishary Alafasi - www.TvQuran.com' ] } }

[codealchemist]

@Borewit, BTW, this is really cool:

Nice integration and great coverage ;)

[DiegoRBaquero]

This is looking really promising.

[Borewit]

@feross: Can you please merge this one?

[codealchemist]

There are still some cases where a blank screen is shown for a period of time until metadata is successfully downloaded, but it's not that bad and I think I can easily add a fix to display the file name while metadata is being downloaded.

[codealchemist]

For MP3 files it seems like this promise is not resolved until the whole file is downloaded.
But the ID3 tags are already available.
Forcing onMetaData to be mm.parseFile(path.join(torrent.path, file.path), options) properly loads metadata on tested files.

We might need to check how ID3 tags are being read from the file.
I think we could load them before the full file is downloaded, at least on same cases.

Also, we might want to add a loading indication if we need to wait for the whole file to be downloaded to update the metadata.
Probable we can show the file name and an indication that metadata is being loading.

Cheers!

[Borewit]

Fantastic news, finally merged yeah!!

Thank you so much @codealchemist.

[DiegoRBaquero]

@feross we need a new release

[codealchemist]

I think we should wait until #1361 gets reviewed and merged before a new release.
:)

Thanks @DiegoRBaquero !

[feross]

Will wait until #1361 is merged before doing a new release. Does someone want to take a stab at PR'ing the changelog for the next version?

[codealchemist]

I'll take the stab at it.
:)