notryanb / nu_plugin_id3 Goto Github PK

A Nushell plugin to get Id3 tag information as structured data.

Rust 100.00%

nu_plugin_id3's Introduction

nu_plugin_id3

The id3 is a plugin for nushell that helps you read the id3 metadata of your mp3 files. This is project is experimental and still under development. The public API for the user (flags, command input, etc...) may change while nushell is still pre 1.0.

This project is still lacking many features

Ability to parse Id3V1 tags
Show tag version information
Eliminate non-mp3 files from the output (nu command compact removes empty rows)
Missing several Id3V2 fields such as comments, data recorded, etc...
Ability to write to the tag (mutate artist, album, comments, lyrics, etc...)
Ability to convert from older Id3V1 to Id3V2.X

Installation

This project depends on a minimum of nushell 0.10.0 to be installed as that is when support for plugin names containing numbers started.

Cargo

cargo install nu_plugin_id3

Build from Source

Clone this repository and navigate to the project directory
cargo install --path .
You may need to restart nushell for it to recognize this plugin.

Usage

id3 will recursively walk a directory and try to parse id3 tags for each file it finds. The only parameter id3 takes is an optional path. If no optional path is given, id3 will search the current directory. You may specify an arbitrary directory or path to search.

// Searches the present working directory
id3

// Searches all directories inside of ~/mp3s/fugazi
id3 ~/mp3s/fugazi

To take advantage of some fun features of nushell like viewing images in your terminal, you'll need to have the binaryview plugin installed with nushell. You can install this via cargo install nu_plugin_binaryview.

// :)
id3 ~/mp3s/fugazi/repeater | get pictures | first | get data

nu_plugin_id3's People

Contributors

Stargazers

Watchers

Forkers

delapouite

nu_plugin_id3's Issues

Output tag version as a column

Once the tag version is parsed via #3 , it should be available to the user via a column.

Better public api

Currently id3 supports parsing the tags by expecting the input to be a file path. This means id3 currently has to be used in the following manner - ls | get name | id3.

This is not intuitive for the user and depends upon another command running first.

Investigate / Add Support for:

id3 . or just id3 where the plugin knows to look at files in the current directory
id3 <some file path> to look at a specific file
id3 <some directory> to look at all files in a specific directory.
open song.mp3 | id3 to parse from raw bytes

support for engine-q versions of nushell?

I'd love to see this support nushell version 0.59 and above. We're currently on 0.69.1. I was needed a mp3 tag reader to rename some files the other day and thought of this plugin.

Add support for more Id3v2.x fields

There are many fields not currently being output to the user.

comments
lyrics
date records
etc...

Review the rest of the rust id3 crates docs and output the rest of the available data.

async all the things

Support for #8 may mean performance problems if a user tries to give id3 their several-hundred gigabyte main media folder and they want to do recursive directory traversal. While having several hundred-thousand rows is not ideal for output, this should still be performant as possible.

example use case:

I want to catalog my entire mp3 collection into a single CSV or JSON file.