RemiXspf

NOTE: This library has been merged into RemiAudio and is no longer updated or maintained. Please migrate to RemiAudio instead.

RemiXspf is a small library for reading and writing playlists in the XSPF (XML Sharable Playlist Format) format and the related JSPF format. It is written entirely in Crystal and has no dependencies outside of the standard library.

Wanna support Remilia? Buy me a coffee on Ko-Fi, or support me through Liberapay.

How do I get set up?

You will need Fossil installed to clone this repo. You will also need Shards v0.17.1 or later. If you have an earlier version of Shards, you will need to to build the latest version manually.

Add this to your shard.yml file:

dependencies:
  remixspf:
    fossil: https://chiselapp.com/user/MistressRemilia/repository/remixspf

Usage

require "remixspf"

# Open an XSPF file.
playlist = File.open("/path/to/file.xspf", "r") do |file|
  RemiXspf::Playlist.read(file)
end

# Print the locations for every track
playlist.each do |trk|
  puts trk.locations
end

# Change some information
playlist.title = "Neat Playlist"
playlist.annotate = "This is just an example playlist."

# Add a new track
playlist.add(title: "Rabio", creator: "Partition 36", "/path/to/file/03 - Rabio.mp3")

# Write the playlist to disk in XML format
playlist.write("/path/to/dest.xspf")

# Also display it to standard output as JSON
puts playlist.write(format: RemiXspf::Playlist::Format::Json)

Development

Known Limitations

The current version does not support the <extension> tag and simply ignores it.

Style info

I use a somewhat non-standard style for my code.

• Keep lines 118 characters or shorter. Obviously sometimes you can't, but please try. Use 80 or 115 characters for Markdown files, though.
• Please use pascalCase for variable and method names. Use CamelCase for type names. Use UPPER_SNAKE_CASE for constants.
• Put parentheses around method parameters, except for these methods: puts, pp, p, raise, sleep, spawn, loop, and exit.
• Always the full do |foo|...end syntax with blocks, except when it's all on one line or an anonymous function, then use { and } or the normal do |foo|...end.
• The type name for exceptions end with Error. For example, ExternalProgramError.

How do I contribute?

1. Go to https://chiselapp.com/user/MistressRemilia/repository/remixspf and clone the Fossil repository.
2. Create a new branch for your feature.
3. Push locally to the new branch.
4. Create a bundle with Fossil that contains your changes.
5. Get in contact with me.

Contributors

• Remilia Scarlet - creator and maintainer
  • Homepage: https://remilia.sdf.org/
  • Mastodon: @MistressRemilia@social.sdf.org
  • Email: zremiliaz@postzeoz.jpz My real address does not contain Z's

Links and Licenses

RemiXspf is under the GNU Affero General Public License version 3.