npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

music-metadata-search

v2.3.0

Published

Search in your local music library using quick filters on metadata tags

Downloads

36

Readme

Music Metadata Search

npm version

Search in your local music library using quick filter on metadata tags.

My main usage is to find musics I want to play and pipe it to mpv but it can be used for different purposes (see "usage").

music-metadata-search ~/music --where "genre like '%sport%'" | mpv --playlist=-

It will:

  • walk in the given directory and parse metadata using music-metadata
  • Cache metadata inside a SQlite database using Drizzle ORM
  • do a SQL query to filters results
  • pipe results

My main objective is to have a CLI tool fast & convenient, for myself. It takes 45s for my library of 150go (5406 files), and then less than 1s using the cache.

Install

npm i music-metadata-search

CLI usage

Generate list of filepath matching where the genre contains "French":

music-metadata-search ~/music/ -g 'French'

Or you can pipe to mpv to play them. Example playlist my new Rock songs:

music-metadata-search ~/music/ -g 'rock' -s "mtime DESC" | mpv --playlist=-

Or you can export an old school French Touch playlist as .m3u file:

music-metadata-search ~/music/ -g 'French' --where 'year BETWEEN 2000 AND 2005' -f m3u > french-touch.m3u

Or getting the "Daft Punks albums before 2000" using JSON output and jq

music-metadata-search ~/music/ -a 'daft' --where 'year < 2000' -f json | jq '[.[].album] | unique'

Use music-metadata-search --help for more information.

Usage: music-metadata-search [options] [path]

Search in your local music library using quick filters on metadata tags

Arguments:
  path                             The directory of local files (default: "/home/alexandre/github/madeindjs/music-playlist-generator")

Options:
  -V, --version                    output the version number
  -q, --query [genre]              Search the term everywhere (in album, artist, title, genre)
  -w, --where [where]              SQL WHERE expression
                                   You can filters on columns: album, artist, title, genre, year, mtime, bpm, bitrate, duration
                                   Example: `genre LIKE "%Rock%" AND duration between 60 AND 120`
  -g, --genre [genre]              Filter by genre of the track using `LIKE` operator
                                   It's an alias of: `--where 'genre LIKE "%Electro%"'`
  -a, --artist [artist]            Filter by artist of the track using `LIKE` operator
                                   It's an alias of: `--where 'artist LIKE "%Daft%"'`
  -b, --album [album]              Filter by album of the track using `LIKE` operator
                                   It's an alias of: `--where 'album LIKE "%Discovery%"'`
  -y, --year [year]                Filter by year of the track
                                   If a single value is provided, it will filter by `=`, you can also give a range like `1..10 to filter using `BETWEEN`
                                   operator
  -t, --title [title]              Title of the track to search using `LIKE` operator
                                   It's an alias of: `--where 'title LIKE "%Verdis%"'`
  -d,--duration [duration]         Filter by duration of the track (in seconds)
                                   If a single value is provided, it will filter by `=`, you can also give a range like `1..10 to filter using `BETWEEN`
                                   operator
  --bpm [bpm]                      Filter by BPM of the track
                                   If a single value is provided, it will filter by `=`, you can also give a range like `1..10 to filter using `BETWEEN`
                                   operator
  --bitrate [bitrate]              Filter by bitrate of the track (in bits/seconds)
                                   If a single value is provided, it will filter by `=`, you can also give a range like `1..10 to filter using `BETWEEN`
                                   operator
  -l, --limit [limit]              Limit the number of tracks returned
  -s, --sort [order]               SQL ORDER BY expression
                                   You can order on columns: album, artist, title, genre, year, mtime, bpm, bitrate, duration.
                                   Example: `genre DESC`
  -f, --format [format]            Output format (choices: "txt", "json", "m3u", default: "txt")
  --ext [ext...]                   Extensions of Audio files to scan (default: [".mp3",".flac",".m4a",".ogg",".aac"])
  --log-level [logLevel]           Log level (choices: "trace", "debug", "info", "warn", "error", "fatal", default: "fatal")
  --cache-scan-ttl [cacheScanTtl]  time to live for the cache (in seconds) (default: 1 hour)
  -h, --help                       display help for command

Lib usage

import { search } from "music-metadata-search";

const tracks = await search("/home/alexandre/Musique/", {
  // Filter artist of the track using `LIKE` operator
  artist: "Daft",
  // Extensions of Audio files to scan
  ext: [".flac"],
  // Log level for [pino](https://www.npmjs.com/package/pino) (default to `'silent'`)
  logLevel: "debug",
  // SQL ORDER BY expression
  sort: "title desc",
  // Filter by title of the track to search using `LIKE` operator
  title: "One",
  // Limit the number of tracks returned
  limit: 10,
});

console.log(tracks);
/*
[
  {
    path: '/home/alexandre/Musique/Daft Punk/2007-12-04 -  Alive 2007/08 One More Time _ Aerodynamic.flac',
    title: 'One More Time / Aerodynamic',
    genre: 'Electronic',
    artist: 'Daft Punk',
    album: 'Alive 2007',
    year: 2007
  },
  {
    path: '/home/alexandre/Musique/Daft Punk/2001-03-13 -  Discovery/01 One More Time.flac',
    title: 'One More Time',
    genre: 'House',
    artist: 'Daft Punk',
    album: 'Discovery',
    year: 2001
  }
]
*/