webminidisc/README.md

64 lines
4.2 KiB
Markdown
Raw Normal View History

2020-03-20 17:21:53 +00:00
# Web MiniDisc
2020-02-12 20:49:56 +00:00
2020-03-20 17:21:53 +00:00
*Brings NetMD Devices to the Web*
2020-02-12 20:49:56 +00:00
2020-03-21 19:46:48 +00:00
Live @ [https://stefano.brilli.me/webminidisc/](https://stefano.brilli.me/webminidisc/).</br>
2020-03-29 12:26:28 +01:00
How it works @ [https://www.youtube.com/watch?v=Frs8qhw0g9Y](https://www.youtube.com/watch?v=Frs8qhw0g9Y).</br>
Blogpost @ [https://stefano.brilli.me/blog/web-minidisc/](https://stefano.brilli.me/blog/web-minidisc/)
2020-02-12 20:49:56 +00:00
2020-03-20 17:21:53 +00:00
Requires *Chrome* or any other browser that supports both **WASM** and **WebUSB**
2020-02-12 20:49:56 +00:00
2020-03-20 17:44:44 +00:00
#### macOS
2020-03-20 17:21:53 +00:00
_it just works ®_ ... no need to download or install any software.
2020-02-12 20:49:56 +00:00
2020-03-20 17:44:44 +00:00
#### Linux
Follow the instructions here [https://github.com/glaubitz/linux-minidisc/tree/master/netmd/etc](https://github.com/glaubitz/linux-minidisc/tree/master/netmd/etc) to grant your user access to the device. If you skip this step you'll likely get an *Access denied* message when trying to connect.
2020-02-12 20:49:56 +00:00
2020-03-20 17:44:44 +00:00
#### Windows 10
The Windows USB stack requires a driver to be installed to communicate with any USB device. The bad news is that there are no official Windows 10 drivers for NetMD devices. The good news is that we don't need it!
We can just use a generic driver like *WinUSB* to access the device.
You can find installation instruction [here](https://docs.microsoft.com/en-us/windows-hardware/drivers/usbcon/winusb-installation), but the easiest way to install is to use [Zadig](https://zadig.akeo.ie/).<br/> Note: you'll need to restart your browser after installation.
2020-02-12 20:49:56 +00:00
#### Chrome OS
Works without any addtional set up - tested with 91 stable (91.0.4472.102). If your user account or device is managed (by your school or company) you may run into some issues. If you are using a personal google account on a personal chromebook you should be good to go.
2020-03-20 17:21:53 +00:00
### Don't know what is a MiniDisc?
2020-02-12 20:49:56 +00:00
2020-03-20 17:21:53 +00:00
- Where to start -> [https://en.wikipedia.org/wiki/MiniDisc](https://en.wikipedia.org/wiki/MiniDisc)
- Community -> [https://www.reddit.com/r/minidisc/](https://www.reddit.com/r/minidisc/)
2020-02-12 20:49:56 +00:00
2020-03-20 17:21:53 +00:00
### How to build
2020-02-12 20:49:56 +00:00
2020-03-20 17:21:53 +00:00
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app), so you can run:
- `npm start` to start the development server
- `npm build` to build for production
2020-02-12 20:49:56 +00:00
2020-03-20 17:21:53 +00:00
WASM modules are provided in the `public/` directory. However, if you wish to build those binaries yourself, instructions are provided in the `extra/` directory.
2020-02-12 20:49:56 +00:00
2020-03-29 12:26:28 +01:00
### How to Contribute
2020-03-20 17:21:53 +00:00
Every contribute is welcome but, please, reach out to me before working on any PR. I've built this app mainly for personal use and I wish to keep it as light as possible in terms of features.
2020-02-12 20:49:56 +00:00
2020-03-20 17:21:53 +00:00
### Bugs and Issues
There might be plenty of them, for sure :) . The thing is that I've not the time to fix all of them and to make sure this app works on every browser or device.
2020-02-12 20:49:56 +00:00
2020-03-20 17:21:53 +00:00
The best way to get a bug fixed, a feature implemented, or a device supported, is to fork the project and do it for yourself. I'll try to provide support as best as I can.
2020-02-12 20:49:56 +00:00
2020-03-20 17:21:53 +00:00
### Backstory
A few weeks ago I've found my old [MZ-N710](https://www.minidisc.org/part_Sony_MZ-N710.html) in the basement of my parents' house.
2020-02-12 20:49:56 +00:00
2020-03-20 17:44:44 +00:00
Determined to make it work on my modern Mac, after some googling, I found out about the [linux-minidisc](https://github.com/glaubitz/linux-minidisc) project. They've done an amazing job in reversing the NetMD protocol.
2020-02-12 20:49:56 +00:00
2020-03-20 20:33:28 +00:00
After a quick inspection to the source code I realized the project could be easily ported to javascript (either node and the browser) using the WebUSB api, so I created [netmd-js](https://github.com/cybercase/netmd-js). Then, on top of that I've built **Web MiniDisc** to manage the music on my device without the need of downloading and installing any dedicated software.
2020-02-12 20:49:56 +00:00
2020-03-20 17:21:53 +00:00
That's it. It was a LOT of fun :).
### Some OSS I've used
- [FFmpeg](https://www.ffmpeg.org/) and [ffmpegjs](https://github.com/ffmpegjs/FFmpeg), to read audio files (wav, mp3, ogg, mp4, etc...).
2020-03-20 17:21:53 +00:00
- [Atracdenc](https://github.com/dcherednik/atracdenc/), to support atrac3 encoding (lp2, lp4 audio formats).
- [Emscripten](https://emscripten.org/), to run both FFmpeg and Atracdenc in the browser.
- [netmd-js](https://github.com/cybercase/netmd-js), to send commands to NetMD devices using Javascript.
- [material-ui](https://material-ui.com/), to build the user interface.
- [linux-minidisc](https://github.com/linux-minidisc/linux-minidisc), to build the netmd-js library.