INTERACT FORUM

Please login or register.

Login with username, password and session length
Advanced search  
Pages: [1]   Go Down

Author Topic: The client-client model using continuous file synchronization  (Read 1302 times)

BryanC

  • MC Beta Team
  • Citizen of the Universe
  • *****
  • Posts: 2558

Introduction

My goals for using JRiver Media Center (MC) successfully are as follows:
  • Enjoy my music when I want, where I want
  • Make it easy to access
  • Keep my media library organized
  • Make it easy to add and remove media
  • Keep my media library consistent across many devices
  • Minimize the impact on my home’s bandwidth and ISP data caps
  • Automatically create redundant backups of my media
  • Make it stable
  • Make it automated
In the course of achieving these goals, my MC network has been in a state of flux for several years. However, I have eventually settled into a configuration that I have found works very well: pairing continuous file synchronization with MC automatic read and write tagging to synchronize media libraries among two or more MC clients, which I have termed the client-client model.

Pairing MC with continuous file synchronization

MC contains a powerful Media Server that enables clients to play and manage media in MC as if they were using a local copy of the library. It is certainly possible to use MC Media Server exclusively to manage and play your media from the server to your clients in the traditional server-client model.

MC Media Server pros:
  • Tag changes are synced seamlessly between all devices
  • Client devices are easy to add/remove

MC Media Server cons:
  • Internet-connectivity, bandwidth and latency. Media must always be streamed from the server to the playback clients, which means that clients must have internet connectivity to access the library. I travel frequently so streaming is not always a feasible option. Also, file operations will not be as responsive as using a local library because the library will need to buffer media during playback and sync tag changes.
  • Adding new music to the server must still be done through a third-party tool (e.g. sftp, rsync, etc.)

Con #1 can be alleviated by maintaining a duplicate local copy of the media files on a client device and enabling the option to Options>Media Network>Client Options>Play local file if one that matches Library Server file is found on the client’s copy of MC. However, this feature necessitates that the client and server file structures are identical, which is problematic for clients and servers running on different platforms (hopefully this limitation can be fixed at some point in the future by the MC developers).

Luckily, both cons can be eliminated if we introduce a third-party tool to keep the media libraries continuously in sync, so that 1) newly added media is propagated between the server and clients and 2) directory structure and filenames are always identical. The answer here is Syncthing, an open-source multi-platform tool for continuous file synchronization between many clients.

Syncthing

Syncthing is easily the most important tool in my arsenal to keep all of my various devices working in harmony. I use it on my smartphone (well, syncthing-fork for better battery life) to sync podcasts, photos, and documents to my laptop and desktop. I use it on my high-performance workstations to create rolling off-site backups. I use it on my servers to share configuration settings and dotfiles. Every second of every day I have bytes floating through my Syncthing cloud and it has yet to fail me.

Syncthing configuration is relatively straight-forward, thus I will not go into much depth here other than to highlight a few important settings for improving the reliability. If you have a client device that will not be adding or tagging media (in essence, a read-only client), then make sure to set the Syncthing share to “receive only” instead of the default “send and receive,” which will save a few CPU cycles and prevent read-only clients from accidentally altering your media library. Additionally, make sure that the filesystem watcher is enabled so that any changes to your media files are propagated as quickly as possible to other devices.



At this point you will have a fully in-sync media library residing on one or more computers. The real magic comes next when we start using MC to apply changes to file tags, which will also be propagated to other devices since tag changes will alter the file checksums. Since Syncthing is a block-based synchronization tool, any changes to a file’s tags will not necessitate the entire file to be transferred to other clients, only a small block of data (typically a few KB), which makes it fast and bandwidth-friendly.



Client-client model versus the traditional server-client model

Although our media files are now in sync, and we have configured MC to use local file playback to save bandwidth and improve latency, the server-client model using MC Media Server still requires internet connectivity to function, which limits its reliability. However, we can eschew the MC Media Server altogether and instead utilize Syncthing to keep the separate libraries on our clients nearly identical via file tags, with one caveat:

When using the client-client model, traditional playlists will not be automatically synced among clients since they are stored in the MC library and are only exported as files when manually triggered. Later on I will describe a method later on in this guide that can replace playlist functionality using MC smartlists and file tags.

Rant: On several occasions, I have asked the MC developers to consider adding an automatic playlist export core command so that Syncthing could also sync the playlist files, but they have chosen not to do so thus far. You can get close by using the RESTful MCWS interface and appropriate MC core command:
Code: [Select]
curl -s -o /dev/null -u username:password http://localhost:52199/MCWS/v1/Control/MCC?Command=20004,1 However MC will still prompt you for the export directory and playlist format so it cannot be automated.

The benefits of the client-client model over the server-client model include:
  • Automatic redundancy of the media library
  • Each client has access to the media library even when offline
  • Each client can maintain its own set of views, playlists, and smartlists
  • Useful if you want to give read-only access to a client and allow it to store and display its own set of ratings from a custom tag
  • Low bandwidth and low latency for playback
  • Cross-platform since file structure does not have to be identical

All that must be done to enable this functionality is to set up Auto-Import on each client to point at your shared (via Syncthing) media folder!

Consistent tagging is the key to the client-client model

The real magic here is to store as much information as possible in the file tags so that they are synced via Syncthing between MC clients. This can include basic information like ratings, artwork, audio analysis data (R128 normalization) or more advanced information like user-defined fields that can be used to keep smartlists in sync (see Advanced tagging below for more information).

Sending metadata
To propagate changes from a client to other clients, we will need to enable Edit>Edit File Tags When File Info Changes on any MC client that we want to have read-write access to the file metadata. If you leave this option unchecked on a client then that client will maintain its own set of metadata in the MC database without propagating changes. If you want to edit the actual file tags without affecting other clients (e.g. you are moving files on the client to a handheld device), then go ahead and enable the option but set your Syncthing client to Receive Only so that it maintains its own local database state. I also recommend enabling automatic file tagging during file analysis upon Auto-Import Options>Library & Folders>Configure auto-import>Tasks>Write file tags when analyzing audio… so that analysis only needs to be performed once on the client that performs the initial file import.

Receiving metadata
In order to receive metadata updates from other clients, you’ll want to use MC Auto-Import to watch the Syncthing music directory for changes and enable Options>Library & Folders>Configure auto-import>Tasks>Update for external changes.



Advanced tagging

Below I will describe two examples of expanding the functionality of the client-client model using file tags.

Tracking newly added media

Sometimes it is useful to keep track of which client has added a particular file to the Syncthing network. You can do this by creating a custom user-defined string field in MC (Options>Library & Folders>Manage Library Fields) named Imported From and check the box to Save in file tags (when possible). Then configure each client to apply their specific client name to the field upon auto-import: In Options>Library & Folders>Configure auto-import select your auto-import directory that you are sharing with Syncthing, click Edit… and under Apply these tags (optional)>Add>Custom select the field you just created and enter the client name as the value. For instance I have named my clients HTPC, Laptop, VPS, and Work. In this manner you can track where your files were originally imported from.



It can also be useful to use a smartlist to track newly imported media to make sure that you actually listen to it before it falls to the proverbial wayside. In this case, follow the strategy above to create a check field called Newly Imported that is tagged as “1” upon auto-import. Then just create a smartlist on each client that lists files with a Newly Imported value of 1 (optionally sorted by [Date Imported]). After you watch or listen to the file, simply clear the Newly Imported field to remove it from the smartlist on every client!

Smartlists as pseudo-playlists

As I outlined above it is possible use file tags in conjunction with smartlists to keep advanced file information and file lists in sync between clients. In this manner it is also possible to partially restore the ability to sync playlists between clients. In order to do this, create a new User Field named User Playlists with a data type of List. Use this field to create a semi-colon delimited list of pseudo-playlists. On each client, create a smartlist that only displays files with the matching string in the User Playlists field. When you want to add a file to the pseudo-playlist, simply add that playlist string to the User Playlists field. One drawback of this method is that it is not easy to manually reorder the smartlist for specific track ordering, but it can be done if necessary using additional user fields and/or smartlist rules to maintain the track order.





This is just the tip of the iceberg when it comes to using file tags to share library information between clients in the client-client model.

Conclusions

In this guide you have been shown the benefits of using a client-client MC network model over the traditional server-client network model used by MC Media Server. The client-client model allow individual clients to maintain their own instances of the file library and MC database, while propagating changes to other clients using file-based synchronization.

Source: https://blog.bryanroessler.com/2019-06-12-jriver-client-client-model-with-syncthing/
Logged

JimH

  • Administrator
  • Citizen of the Universe
  • *****
  • Posts: 71499
  • Where did I put my teeth?
Re: The client-client model using continuous file synchronization
« Reply #1 on: June 19, 2019, 07:13:08 pm »

Thanks for the write-up, Bryan!
Logged

NorthGeorgiaWX

  • Recent member
  • *
  • Posts: 27
  • It's a jeep thing... you wouldn't understand
Re: The client-client model using continuous file synchronization
« Reply #2 on: July 05, 2019, 06:28:13 am »

Nice write up Brian. Here are my observations from my personal experience so far with MC (I've only been using it for about a week or so now). You have answered some questions for me about the sync process in the MC25 section of the forum, and thank you for that.

I installed the Sync program you are referring to yesterday and tried it for a little while. What I'm finding with that program, and the TreeComp program that I use, is that MC is always modifying the files in the background (tag updates etc), so it's a very dynamic process that never ends. As an example... I copied about 442 GB of FLAC files to one of the MC25 installations yesterday. 6 hours later I went back and looked and I had about 6000 files out of sync already. I suppose my mistake is using MC as a media server on all the installs, but I'm not sure that if I use a couple of them as clients that I won't have the same issue, especially if the files are also kept locally (Identical file and folder structure on the same drive letter).

I was also a little concerned about CPU utilization in maintaining a sync between three machines and it really ends up being a lot of network traffic for a large library.

What has your experience been with CPU utilization while doing this?

Logged

BryanC

  • MC Beta Team
  • Citizen of the Universe
  • *****
  • Posts: 2558
Re: The client-client model using continuous file synchronization
« Reply #3 on: July 05, 2019, 07:51:20 am »

Nice write up Brian. Here are my observations from my personal experience so far with MC (I've only been using it for about a week or so now). You have answered some questions for me about the sync process in the MC25 section of the forum, and thank you for that.

I installed the Sync program you are referring to yesterday and tried it for a little while. What I'm finding with that program, and the TreeComp program that I use, is that MC is always modifying the files in the background (tag updates etc), so it's a very dynamic process that never ends. As an example... I copied about 442 GB of FLAC files to one of the MC25 installations yesterday. 6 hours later I went back and looked and I had about 6000 files out of sync already. I suppose my mistake is using MC as a media server on all the installs, but I'm not sure that if I use a couple of them as clients that I won't have the same issue, especially if the files are also kept locally (Identical file and folder structure on the same drive letter).

I was also a little concerned about CPU utilization in maintaining a sync between three machines and it really ends up being a lot of network traffic for a large library.

What has your experience been with CPU utilization while doing this?

Following the initial scan, CPU utilization will typically be low because Syncthing is bottlenecked by disk I/O. Of course since you will be maxing out I/O it's best if your media library resides on its own drive. A fast NVMe drive can speed up resyncing by orders of magnitude.

If you are making a ton of changes constantly to your library, you will probably want to pause Syncthing and fire it back up again after you are done editing (the other option is to disable MC writing to tags, and then run an update to tags (from library) on the whole library when you are finished). The good news here is that there isn't actually much network traffic because Syncthing will only modify the file blocks that have changed, typically only the few KBs that contain the tags at the beginning of the file. The "out-of-sync" files are just queued to be re-read from the disk to have the new tag applied. You can confirm this by looking at the network utilization in Syncthing, for tag edits the amount of data actually being transferred is a small fraction of the total library size.

The #1 thing you can do to improve Syncthing performance on your LAN is to specify the internal IP address and port of each of your machines, as opposed to using the default "dynamic" setting. When you run into firewall or other configuration issues, Syncthing will default to using its relay network to sync the files. Of course this will be several times slower than syncing over the LAN directly. For improving WAN performance, you should specify a unique port for each of your machines in the listening settings (say 22000, 22001, 22002, etc, for each individual machine) and then configure your port forwarding accordingly.

Once MC is set up with a stably tagged library, there really should be very little tag writing happening in MC by default. Typically the only time a file will be modified is when it is played, which results in a a few KBs worth of data being sent to the other clients. If MC is doing heavy tag writes, it's possible that your MC clients are trying to reanalyze audio or you may be running into issues with the HDCD analysis that was recently introduced. It's best to start with a library that's in decent shape (audio analyzed) before adding it as a Syncthing share. The only time I run into major resyncs is when I batch edit genre tags. I typically disable automatic tag updates, edit the genres en masse, and then re-enable tag updates and run an update tags (from library) to begin the synchronization.
Logged
Pages: [1]   Go Up