zhaarey/go-mp4tag
1
0
Fork 0
mirror of https://github.com/zhaarey/go-mp4tag.git synced 2025-10-23 15:11:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Sorrow446
2022-06-14 03:08:41 +01:00
committed by GitHub
parent 937c18206b
commit 261153a403
1 changed files with 55 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

60
README.md
View File

@@ -1,7 +1,10 @@
# go-mp4tag
MP4 tagger written in Go.
MP4 tagging library & CLI tagger written in Go.
[Windows, Linux, macOS and Android binaries](https://github.com/Sorrow446/go-mp4tag/releases)
## Setup
## Library
### Setup
```
go get github.com/Sorrow446/go-mp4tag
```
@@ -9,7 +12,7 @@ go get github.com/Sorrow446/go-mp4tag
import "github.com/Sorrow446/go-mp4tag"
```
## Usage Examples
### Usage Examples
```go
tags := &mp4tag.Tags{
Album: "album",
@@ -36,7 +39,7 @@ import "github.com/Sorrow446/go-mp4tag"
"CUSTOMFIELD": "custom field",
"CUSTOMFIELD2": "custom field 2",
},
Delete: []string{"genre", "cover"},
Delete: []string{"cover", "genre"},
}
err := mp4tag.Write("1.m4a", tags)
if err != nil {
@@ -61,7 +64,7 @@ Write two custom fields named `CUSTOMFIELD` and `CUSTOMFIELD2`, delete genre tag
```
Write cover from `cover.jpg`.
## Misc
### Misc
```go
type Tags struct {
Album string
@@ -86,6 +89,53 @@ iTunes-style metadata only.
Delete strings: album, albumartist, artist, comment, composer, cover, disk, genre, label, title, track, year.
Custom tag deletion is not implemented yet.
## CLI
go-mp4 tag also has a CLI version if you'd like to call it outside of Go.
```
Usage: mp4tag_x64.exe [--album ALBUM] [--albumArtist ALBUMARTIST] [--artist ARTIST] [--comment COMMENT] [--composer COMPOSER] [--cover COVER] [--custom CUSTOM] [--delete DELETE] [--diskNumber DISKNUMBER] [--diskTotal DISKTOTAL] [--genre GENRE] [--label LABEL] [--title TITLE] [--trackNumber TRACKNUMBER] [--trackTotal TRACKTOTAL] [--year YEAR] FILEPATH
Positional arguments:
FILEPATH Path of file to write to.
Options:
--album ALBUM Write album tag.
--albumArtist ALBUMARTIST
Write album artist tag.
--artist ARTIST Write artist tag.
--comment COMMENT Write comment tag.
--composer COMPOSER Write composer tag.
--cover COVER Path of cover to write. JPEG is recommended.
--custom CUSTOM Write custom tags. Multiple tags with the same field name can be written.
Example: "--custom MYCUSTOMFIELD1=value1 MYCUSTOMFIELD2=value2"
--delete DELETE, -d DELETE
Tags to delete.
Options: album, albumartist, artist, comment, composer, cover, disk, genre, label, title, track, year.
Example: "-d album albumartist"
--diskNumber DISKNUMBER
Write disk number tag.
--diskTotal DISKTOTAL
Write disk total tag. Can't be written without disk number tag.
--genre GENRE Write genre tag.
--label LABEL Write label tag.
--title TITLE Write title tag.
--trackNumber TRACKNUMBER
Write track number tag.
--trackTotal TRACKTOTAL
Write track total tag. Can't be written without track number tag.
--year YEAR Write year tag.
--help, -h display this help and exit
```
You must use double quotes for values with spaces in.
`mp4tag_x64.exe 1.m4a --artist artist --albumArtist "album artist"`
Write artist and album artist tags.
`mp4tag_x64.exe 1.m4a --cover cover.jpg"`
Write cover from `cover.jpg`
`mp4tag_x64.exe 1.m4a --custom "MY CUSTOM FIELD WITH SPACES"=value1 MYCUSTOMFIELD1="value with spaces" -d cover genre"`
Write two custom fields named `MY CUSTOM FIELD WITH SPACES`, and `MYCUSTOMFIELD1`, delete genre tag, and remove cover.
## Thank you
go-mp4tag relies heavily on abema's go-mp4 library.