Initial pass at making it work

Author: gabek

.gitignore

@@ -1,3 +1,7 @@
+output/*.txt
+output/*.jpg
+output/*.json
+
 # Binaries for programs and plugins
 *.exe
 *.exe~

README.md

@@ -1,2 +1,78 @@
-# supbox
-Pull details about the currently playing track from Rekordbox v6 in formats compatible with Audio Hijack, OBS or just in JSON.
+This tool is for users of Pioneer's [Rekordbox v6](https://rekordbox.com/en/) to gain access to their currently playing track.  This data can be used for any number of purposes, but a large one is online streaming of audio and video.  Built-in support for OBS and Audio Hijack are included.
+
+# Currently only supported on macOS
+
+Since I use macOS, and I have an install of Rekordbox on macOS that's what I have it working with.  **However**, there's no reason that somebody who's using Rekordbox on Windows can't help out and make the tweaks needed to point to the file locations on a Windows install.  If there's any demand maybe I'll install a VM and install Rekordbox and I'll do it myself.
+
+# Overview
+
+1. Open the _config/config.yaml_ file.
+2. Make sure the _application_ path points to your copy of Rekordbox.app (version 6) on your computer.
+3. Decide where you want the output files to go such as an "output" directory.  Create this directory if needed.
+4. Decide if you are using [OBS](https://obsproject.com/), [Audio Hijack](https://rogueamoeba.com/audiohijack/), or JSON output.
+5. You can remove any of the config file output destinations you're not using.
+
+
+# Using with [OBS](https://obsproject.com/)
+
+If you're using OBS the file path of _nowplaying-obs-*_ would generate three files: 
+* nowplaying-obs-artist.txt (just the artist name)
+* nowplaying-obs-track.txt (just the track name)
+* nowplaying-obs-track.jpg (just the track image)
+
+[Within OBS you can then point to these files](https://www.reddit.com/r/Twitch/comments/4k6jpv/obs_studio_text_source_from_file/) and add the Metadata to your broadcast.
+
+Here's an example setup:
+
+<center>
+  <a href="doc/obs1.png">
+    <img src="doc/obs1.png" width=40% style="padding: 20px">
+  </a>
+  <a href="doc/obs2.png">
+    <img src="doc/obs2.png" width=40% style="padding: 20px">
+  </a>
+</center>
+
+# Using with [Rogue Ameba Audio Hijack](https://rogueamoeba.com/audiohijack/)
+
+You can point Audio Hijack at a specially formatted text file and the software will read it and treat it as the current Metadata.  This file location is configured in the config file as _audioHijack_ under _output_.
+
+For example you can set it to _output/nowplaying-audiohijack.txt_ and the contents of the file would look something like
+
+```
+Title: Retaliate
+Artist: VNV Nation
+Artwork: /Users/me/Library/Pioneer/rekordbox/share/PIONEER/Artwork/bd3/82718-334f-482d-ad0a-82a1f8ba2507/artwork.jpg
+```
+
+Here's an example setup:
+
+<center>
+  <a href="doc/audioHijack1.png">
+    <img src="doc/audioHijack1.png" width=40% style="padding: 20px">
+  </a>
+  <a href="doc/audioHijack2.png">
+    <img src="doc/audioHijack2.png" width=40% style="padding: 20px">
+  </a>
+</center>
+
+[Please read the details that Rogue Ameba has provided](https://rogueamoeba.com/support/knowledgebase/?showArticle=AudioHijack-Metadata) under the __Metadata from a “Now Playing.txt” file__ section if you have questions.
+
+# JSON Output
+
+An option to generate a JSON file with the Metadata is available for other uses.  Upload it to a web server, have your text to speech engine read the current track, whatever ideas you can come up with.
+
+```
+{"ID":"6d655f64-f2e5-4ec9-bd51-3a2c86984c8e","artist":"VNV Nation","track":"Retaliate","imagePath":"/Users/gabek/Library/Pioneer/rekordbox/share/PIONEER/Artwork/bd3/82718-334f-482d-ad0a-82a1f8ba2507/artwork.jpg"}
+```
+
+# Disclaimers
+
+* This tool relies on Rekordbox marking a track as **"played"** before we know it's the most recently played track.  I've found this currently happens one minute into playback.  **This is not optimal**, as I'd really love to know this immediately.  However, this is what Rekordbox is doing and I'll keep looking to see if there's any other way to work with this.
+
+* We're doing things with Recordbox that are unsupported and even likely completely unwanted by Pioneer.  Things could change by them at any moment and even shut this down completely.
+
+# Thank yous
+
+* rekordcloud went into detail about the internals of Rekordbox v6 https://rekord.cloud/blog/technical-inspection-of-rekordbox-6-and-its-new-internals.
+* LePopal's PRACT-OBS had some code that pointed me in the right direction with getting the database decryption to work and gave me the idea to add OBS support.  https://github.com/LePopal/PRACT-OBS/ 

audioHijackOutput.go

@@ -0,0 +1,28 @@
+package main
+
+import (
+	"fmt"
+	"os"
+)
+
+func writeAudioHijackFileOutput(track Track, filename string) {
+	f, err := os.Create(filename)
+	if err != nil {
+		panic(err)
+	}
+
+	defer f.Close()
+
+	if track.Name != "" {
+		fmt.Fprintln(f, "Title:", track.Name)
+	}
+
+	if track.Artist != "" {
+		fmt.Fprintln(f, "Artist:", track.Artist)
+	}
+
+	if track.ImagePath != "" {
+		fmt.Fprintln(f, "Artwork:", "file://"+track.ImagePath)
+	}
+
+}

config.go

@@ -0,0 +1,43 @@
+package main
+
+import (
+	"io/ioutil"
+	"log"
+
+	"gopkg.in/yaml.v2"
+)
+
+// Config struct
+type Config struct {
+	Rekordbox       Rekordbox `yaml:"rekordbox"`
+	Output          Output    `yaml:"output"`
+	PollingInterval string    `yaml:"pollingInterval"`
+}
+
+type Rekordbox struct {
+	OptionsFile     string `yaml:"optionsFile"`
+	ApplicationPath string `yaml:"application"`
+}
+
+type Output struct {
+	AudioHijackStyleFile string `yaml:"audioHijack"`
+	JSONStyleFile        string `yaml:"json"`
+	OBSStyleFileTemplate string `yaml:"obs"`
+}
+
+func getConfig() Config {
+	filePath := "config/config.yaml"
+
+	if !FileExists(filePath) {
+		log.Fatal("ERROR: valid config/config.yaml is required")
+	}
+
+	yamlFile, err := ioutil.ReadFile(filePath)
+
+	var config Config
+	err = yaml.Unmarshal(yamlFile, &config)
+	if err != nil {
+		panic(err)
+	}
+	return config
+}

config/config.yaml

@@ -0,0 +1,9 @@
+pollingInterval: 5s
+
+rekordbox:
+  application: /Applications/rekordbox 6/rekordbox.app
+
+output:
+  audioHijack: output/nowplaying-audiohijack.txt
+  json: output/nowplaying.json
+  obs: output/nowplaying-obs-*

crypto.go

@@ -0,0 +1,21 @@
+package main
+
+import (
+	"github.com/andreburgaud/crypt2go/ecb"
+	_ "github.com/xeodou/go-sqlcipher"
+	"golang.org/x/crypto/blowfish"
+)
+
+func decrypt(ct, key []byte) []byte {
+	block, err := blowfish.NewCipher(key)
+	if err != nil {
+		panic(err.Error())
+	}
+	mode := ecb.NewECBDecrypter(block)
+	pt := make([]byte, len(ct))
+	mode.CryptBlocks(pt, ct)
+	if err != nil {
+		panic(err.Error())
+	}
+	return pt
+}

database.go

@@ -0,0 +1,29 @@
+package main
+
+import (
+	"database/sql"
+	"fmt"
+)
+
+func getDatabaseDSN(filePath string, encryptionKey string) string {
+	dsn := fmt.Sprintf("file:"+filePath+"?_key='%s'", encryptionKey)
+	return dsn
+}
+
+func getRecentTrack(db *sql.DB, config Config) Track {
+	row := db.QueryRow("SELECT h.ID, Title, Name, ImagePath FROM djmdSongHistory AS h JOIN djmdContent AS c on h.ContentID = c.ID LEFT JOIN djmdArtist as a on c.ArtistID = a.ID GROUP BY h.created_at ORDER BY h.created_at DESC LIMIT 1")
+
+	var ID string
+	var Title string
+	var Name string
+	var ImagePath string
+
+	row.Scan(&ID, &Title, &Name, &ImagePath)
+
+	if ImagePath != "" {
+		dataPath := getDataPath()
+		ImagePath = getImagePath(dataPath, ImagePath)
+	}
+
+	return Track{ID: ID, Artist: Name, Name: Title, ImagePath: ImagePath}
+}

doc/audioHijack1.png

@@ -0,0 +1,11 @@
+module github.com/gabek/supbox
+
+go 1.14
+
+require (
+	github.com/andreburgaud/crypt2go v0.11.0
+	github.com/mattn/go-sqlite3 v2.0.3+incompatible // indirect
+	github.com/mutecomm/go-sqlcipher v0.0.0-20190227152316-55dbde17881f // indirect
+	github.com/xeodou/go-sqlcipher v0.0.0-20200505024025-122bc51f252d // indirect
+	gopkg.in/yaml.v2 v2.3.0 // indirect
+)

doc/audioHijack2.png

@@ -0,0 +1,32 @@
+github.com/PuerkitoBio/goquery v1.5.1/go.mod h1:GsLWisAFVj4WgDibEWF4pvYnkVQBpKBKeU+7zCJoLcc=
+github.com/andreburgaud/crypt2go v0.11.0 h1:2V2ccmaEDZuWTEU8tVMJkzueMknwpGPPQW5yqtjKeso=
+github.com/andreburgaud/crypt2go v0.11.0/go.mod h1:CNP8Da8FgPs0UEwpNh63NTb0zCPfQVlbY80BmdT42uw=
+github.com/andybalholm/cascadia v1.1.0/go.mod h1:GsXiBklL0woXo1j/WYWtSYYC4ouU9PqHO0sqidkEA4Y=
+github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/mattn/go-sqlite3 v1.13.0 h1:LnJI81JidiW9r7pS/hXe6cFeO5EXNq7KbfvoJLRI69c=
+github.com/mattn/go-sqlite3 v2.0.3+incompatible h1:gXHsfypPkaMZrKbD5209QV9jbUTJKjyR5WD3HYQSd+U=
+github.com/mattn/go-sqlite3 v2.0.3+incompatible/go.mod h1:FPy6KqzDD04eiIsT53CuJW3U88zkxoIYsOqkbpncsNc=
+github.com/mutecomm/go-sqlcipher v0.0.0-20190227152316-55dbde17881f h1:hd3r+uv9DNLScbOrnlj82rBldHQf3XWmCeXAWbw8euQ=
+github.com/mutecomm/go-sqlcipher v0.0.0-20190227152316-55dbde17881f/go.mod h1:MyUWrZlB1aI5bs7j9/pJ8ckLLZ4QcCYcNiSbsAW32D4=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
+github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
+github.com/xeodou/go-sqlcipher v0.0.0-20200505024025-122bc51f252d h1:VI0yV4ELL01PdNuEwVVqWUYujcwWsq2P5N6ZNAlRI0I=
+github.com/xeodou/go-sqlcipher v0.0.0-20200505024025-122bc51f252d/go.mod h1:aZ06jyRpOCqbZdcLUsn8agGfXzlKkHbQp/CjwRKwxSQ=
+golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
+golang.org/x/crypto v0.0.0-20200317142112-1b76d66859c6 h1:TjszyFsQsyZNHwdVdZ5m7bjmreu0znc2kRYsEml9/Ww=
+golang.org/x/crypto v0.0.0-20200317142112-1b76d66859c6/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
+golang.org/x/net v0.0.0-20180218175443-cbe0f9307d01/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
+golang.org/x/net v0.0.0-20190225153610-fe579d43d832/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
+golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
+golang.org/x/net v0.0.0-20200202094626-16171245cfb2/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
+golang.org/x/net v0.0.0-20200324143707-d3edc9973b7e h1:3G+cUijn7XD+S4eJFddp53Pv7+slrESplyjG25HgL+k=
+golang.org/x/net v0.0.0-20200324143707-d3edc9973b7e/go.mod h1:qpuaurCH72eLCgpAm/N6yyVIVM9cpaDIP3A8BGJEC5A=
+golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
+golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20200323222414-85ca7c5b95cd/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v2 v2.3.0 h1:clyUAQHOM3G0M3f5vQj7LuJrETvjVot3Z5el9nffUtU=
+gopkg.in/yaml.v2 v2.3.0/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=

doc/obs1.png

@@ -0,0 +1,28 @@
+package main
+
+import (
+	"encoding/json"
+	"fmt"
+	"os"
+)
+
+func getJSONForTrack(track Track) string {
+	b, err := json.Marshal(track)
+	if err != nil {
+		panic(err)
+	}
+
+	return string(b)
+}
+
+func writeNowPlayingJSONOutput(track Track, filename string) {
+	f, err := os.Create(filename)
+	if err != nil {
+		panic(err)
+	}
+
+	defer f.Close()
+
+	json := getJSONForTrack(track)
+	fmt.Fprintln(f, json)
+}

doc/obs2.png

@@ -0,0 +1,82 @@
+package main
+
+import (
+	"encoding/base64"
+	"log"
+
+	"database/sql"
+	"time"
+)
+
+var config Config = getConfig()
+
+var database *sql.DB
+
+var currentTrackID string
+
+func main() {
+	// Files and paths
+	rekordboxConfig := getRekordboxConfig(config.Rekordbox.OptionsFile)
+	asarFilePath := getAsarFilePath(config.Rekordbox.ApplicationPath)
+	dataPath := getDataPath()
+	databaseFilePath := getDatabaseFilePath(dataPath)
+
+	// Database decryption
+	encodedPasswordData := getEncryptedPasswordDataFromConfig(rekordboxConfig)
+	decodedPasswordData, err := base64.StdEncoding.DecodeString(encodedPasswordData)
+	passwordString := getEncryptedPassword(asarFilePath)
+	password := []byte(passwordString)
+	decryptedBytes := decrypt(decodedPasswordData, password)
+	encryptionKey := string(decryptedBytes)
+
+	// Open the Database
+	dsn := getDatabaseDSN(databaseFilePath, encryptionKey)
+	db, err := sql.Open("sqlite3", dsn)
+
+	if err != nil {
+		panic(err)
+	}
+
+	database = db
+	defer database.Close()
+
+	// Start polling
+	pollingInterval, err := time.ParseDuration(config.PollingInterval)
+
+	if err != nil {
+		panic(err)
+	}
+
+	startTimer(pollingInterval)
+}
+
+func startTimer(pollingInterval time.Duration) {
+	run()
+
+	tick := time.Tick(pollingInterval)
+	for range tick {
+		run()
+	}
+}
+
+func run() {
+	track := getRecentTrack(database, config)
+	if track.ID == currentTrackID {
+		return
+	}
+
+	currentTrackID = track.ID
+
+	log.Printf("%+v\n", track)
+
+	if config.Output.AudioHijackStyleFile != "" {
+		writeAudioHijackFileOutput(track, config.Output.AudioHijackStyleFile)
+	}
+	if config.Output.JSONStyleFile != "" {
+		writeNowPlayingJSONOutput(track, config.Output.JSONStyleFile)
+	}
+
+	if config.Output.OBSStyleFileTemplate != "" {
+		writeOBSFilesOutput(track, config.Output.OBSStyleFileTemplate)
+	}
+}