Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
bin
 
 
 
 
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 

media-inspector

NPM package Github: CI CD codecov Codacy Badge Codacy Badge

Find media files by searching in the metadata

Requirements

  • Node 12 or newer
  • NPM 7 series (for development) - automatically installs peer dependencies
  • ffmpeg executable in $PATH
  • mediainfo executable in $PATH

Supported media mime-types

The current list of supported mime-types is

  • video/

However, as Mediainfo is utilised for reading the metadata, it should be fairly simple to expand that to include both audio and image/.

Usage

$ npm install -g media-inspector
$ media-inspector COMMAND
running command...
$ media-inspector (-v|--version|version)
media-inspector/0.4.2 darwin-x64 node-v14.17.3
$ media-inspector --help [COMMAND]
USAGE
  $ media-inspector COMMAND
...

Commands

media-inspector autocomplete [SHELL]

display autocomplete installation instructions

USAGE
  $ media-inspector autocomplete [SHELL]

ARGUMENTS
  SHELL  shell type

OPTIONS
  -r, --refresh-cache  Refresh cache (ignores displaying instructions)

EXAMPLES
  $ media-inspector autocomplete
  $ media-inspector autocomplete bash
  $ media-inspector autocomplete zsh
  $ media-inspector autocomplete --refresh-cache

See code: @oclif/plugin-autocomplete

media-inspector cache

Cache metadata for a directory structure as JSON

USAGE
  $ media-inspector cache

OPTIONS
  -r, --read=read    (required) Path of a directory or file to read
  -w, --write=write  (required) Path of where to write the metadata cache as JSON

EXAMPLES
  $ media-inspector cache -r ~/Downloads -w downloads.json
  $ media-inspector cache -r ~/Downloads/file.ext -w file.json
  $ media-inspector cache -r /Users/username/Downloads -w ~/Desktop/downloads.json

See code: src/cli/commands/cache.ts

media-inspector help [COMMAND]

display help for media-inspector

USAGE
  $ media-inspector help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

media-inspector inspect

Inspect input with filter

USAGE
  $ media-inspector inspect

OPTIONS
  -f, --filter=filter     (required) Path of the filter to apply in JSON or JSON5
  -i, --includeAuxiliary  Will also include empty directories and 'container' directories
  -r, --read=read         (required) Path of a directory or file, or a metadata cache file to read
  -v, --verbose           Enable to get detailed information and progress

EXAMPLES
  $ media-inspector inspect -r ~/Downloads -f ./examples/filter-default.json5
  $ media-inspector inspect -r ~/Downloads/file.ext -f ./examples/filter-default.json5
  $ media-inspector inspect -r downloads.json -f ./examples/filter-default.json5
  $ media-inspector inspect -r downloads.json -f ./examples/filter-default.json5 -i -v

See code: src/cli/commands/inspect.ts

media-inspector validate-filter FILTERPATH

Validate filter

USAGE
  $ media-inspector validate-filter FILTERPATH

ARGUMENTS
  FILTERPATH  Path to filter in JSON or JSON5

EXAMPLE
  $ media-inspector validate-filter ./examples/filter-default.json5

See code: src/cli/commands/validate-filter.ts

media-inspector video-errors VIDEOPATH

Checks video files for errors by decoding them

USAGE
  $ media-inspector video-errors VIDEOPATH

ARGUMENTS
  VIDEOPATH  Path to video file or directory of video files

OPTIONS
  -d, --demux-only         Skip decode and demux only
  -e, --ext=ext            File extensions to match - default: all
  -p, --parallel=parallel  (required) [default: 1] Number of parallel processes to utilise for decoding - default: 1
  -v, --verbose            Enable to get detailed information and progress

EXAMPLES
  $ media-inspector video-errors ./path/to/video.ext
  $ media-inspector video-errors ./path/to/directory-with-video-files
  $ media-inspector video-errors ./path/to/directory-with-video-files --ext .ts,.mp4 --parallel 4

See code: src/cli/commands/video-errors.ts

How filters work

A filter is a list of rules. A rule is a prioritised list of conditions. A rule is considered satisfied when all its conditions are satisfied. When a media file satisfies all the conditions of any rule, that media-file is considered a match.

Notes

Test files

https://www.sample-videos.com/about.php

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published