Chore/bubbletea refactor (#69)

* Major refactor. Use bubbletea instead of promoptui. Change license to AGPL

* Clean up possible memory issues

---------

Co-authored-by: Jared.K <3268576+jaredkotoff@users.noreply.github.com>

Author: jaredcat

.gitignore

@@ -1,9 +1,32 @@
-node_modules
-bin
-test*
+# Binaries and executables
+node_modules/
+bin/
+test*/
 obs-random-video*
 *.7z
 *.exe
 *-linux
 *-macos
-.DS_Store
+*.html
+
+# OS specific files
+.DS_Store
+Thumbs.db
+desktop.ini
+
+# IDE and editor files
+.idea/
+*.swp
+*.swo
+*~
+
+# Build and distribution files
+dist/
+build/
+
+# Logs
+*.log
+
+# Generated files
+web/js/*.min.js
+web/css/*.min.css

.goreleaser.yml

@@ -5,6 +5,7 @@ builds:
       - linux
     goarch:
       - amd64
+      - arm64
 archives:
   - id: default
     name_template: >-
@@ -13,6 +14,7 @@ archives:
       {{- if eq .Os "darwin" }}macos_
       {{- else }}{{ .Os }}_{{ end }}
       {{- if eq .Arch "amd64" }}64-bit
+      {{- else if eq .Arch "arm64" }}arm64
       {{- else if eq .Arch "386" }}i386
       {{- else if eq .Arch "darwin" }}apple
       {{- else }}{{ .Arch }}{{ end }}
@@ -23,6 +25,5 @@ archives:
     files:
       - NOTICE*
       - LICENSE*
-      - LICENCE*
       - README*
       - CHANGELOG*

.vscode/settings.json

@@ -1,15 +1,18 @@
 {
   "cSpell.words": [
+    "bubbletea",
+    "charmbracelet",
     "deepcode",
     "goarch",
     "gohtml",
     "goreleaser",
     "hasher",
     "jacobtomlinson",
+    "keypress",
     "ldflags",
+    "lipgloss",
     "manifoldco",
     "obsstudio",
-    "promptui",
     "sparkdemcisin",
     "webp"
   ],
@@ -19,4 +22,4 @@
       "file:///Users/jared/personal/github/obs-random-videos/.github/workflows/stale.yml"
     ]
   }
-}
+}

LICENSE

@@ -36,13 +36,42 @@ Notice: the VLC Source now supports "Shuffle playlist" option.
 - m4v
 - webm
 - mpeg4
+- mov
 
 #### Audio
 
 - mp3
 - ogg
 - aac
 
+## Project Structure
+
+The project is organized into the following directories:
+
+- `internal/` - Internal packages not meant for external use
+  - `media/` - Media file handling functions (file detection, path handling)
+  - `ui/` - User interface and template functions (prompts, HTML generation)
+- `web/` - Web assets
+  - `js/` - JavaScript files for the HTML player
+    - `main.js` - Contains the VideoPlayerManager and PlaylistManager classes
+    - `body.js` - Initializes the player
+  - `templates/` - HTML templates
+
+### JavaScript Architecture
+
+The JavaScript code uses an object-oriented approach with two main classes:
+
+1. **VideoPlayerManager**: Handles the dual-player system for seamless video playback
+   - Manages the two video players
+   - Handles transitions between videos
+   - Provides error handling
+   - Implements preloading for better performance
+
+2. **PlaylistManager**: Manages the playlist state and operations
+   - Handles shuffling of videos
+   - Manages localStorage for persistence
+   - Provides methods for getting the next video
+
 ## Notes
 
 - VLC Source now supports "Shuffle playlist"
@@ -54,24 +83,33 @@ Notice: the VLC Source now supports "Shuffle playlist" option.
   - To test in your browser you must hit the Play button first
 - Pro tip: webm videos support transparency (convert mov to webm to save on file size)
 
-## Stuck? Or nothing happening?
+## Troubleshooting
+
+If you're experiencing issues with the player:
 
-  1. Try hitting `Refresh cache of current page` in OBS
-  2. **In OBS go to `Scene Collection` then `New`**
-     1. **Add only your random video browser source and see if this works**
-     2. **If it works, then theres an external issue.** I have no idea what is causing this so, if you have any info on this us know in the [discussions](https://github.com/UpDownLeftDie/obs-random-videos/discussions)
-  3. [Enable remote debugging](https://github.com/crowbartools/Firebot/wiki/Troubleshooting-Firebot-Overlay-issues-in-OBS-Studio) and open the page for the browser source
-     1. Open Chrome Dev tools
-     2. `Application` tab
-     3. Make sure `Local and session storage` box is CHECKED
-     4. Click `Clear site data`
-  4. If issues persist: use [GitHub Discussions](https://github.com/UpDownLeftDie/obs-random-videos/discussions/categories/q-a) or join the [Discord server](https://discord.gg/zxYsjpxaxN)
+1. Try hitting `Refresh cache of current page` in OBS
+2. **In OBS go to `Scene Collection` then `New`**
+   1. **Add only your random video browser source and see if this works**
+   2. **If it works, then theres an external issue.** I have no idea what is causing this so, if you have any info on this us know in the [discussions](https://github.com/UpDownLeftDie/obs-random-videos/discussions)
+3. [Enable remote debugging](https://github.com/crowbartools/Firebot/wiki/Troubleshooting-Firebot-Overlay-issues-in-OBS-Studio) and open the page for the browser source
+   1. Open Chrome Dev tools
+   2. `Application` tab
+   3. Make sure `Local and session storage` box is CHECKED
+   4. Click `Clear site data`
+4. Check if your video files are in a supported format and can be played in a browser
+5. Ensure your video files don't have special characters in their filenames
+6. If issues persist: use [GitHub Discussions](https://github.com/UpDownLeftDie/obs-random-videos/discussions/categories/q-a) or join the [Discord server](https://discord.gg/zxYsjpxaxN)
 
 ## TODO
 
-- Audio-only or video-only modes
-- Option for cross-fading between videos
-- Option to HTML background color
+- [x] Support for multiple video formats
+- [x] Support for audio files
+- [x] Switch to [Bubble Tea](https://github.com/charmbracelet/bubbletea)
+- [ ] Audio-only or video-only modes
+- [ ] Option for cross-fading between videos
+- [ ] Option to set HTML background color
   - Good for videos with weird aspect ratio
   - Good for audio files
-- Switch to [Bubble Tea](https://github.com/charmbracelet/bubbletea) instead of `promptui`
+- [ ] Switch to [Wails](https://wails.io/) UI for a graphical interface
+- [ ] Add support for image files (with configurable display duration)
+- [ ] Improve error handling and user feedback

README.md

@@ -1,10 +1,32 @@
 module github.com/UpDownLeftDie/obs-random-videos/v2
 
-go 1.21.2
+go 1.24.1
 
-require github.com/1lann/promptui v0.8.1-0.20220708222609-81fad96dd5e1
+require (
+	github.com/charmbracelet/bubbles v0.21.0
+	github.com/charmbracelet/bubbletea v1.3.5
+	github.com/charmbracelet/lipgloss v1.1.0
+)
 
 require (
-	github.com/chzyer/readline v1.5.1 // indirect
-	golang.org/x/sys v0.13.0 // indirect
+	github.com/atotto/clipboard v0.1.4 // indirect
+	github.com/aymanbagabas/go-osc52/v2 v2.0.1 // indirect
+	github.com/charmbracelet/colorprofile v0.3.1 // indirect
+	github.com/charmbracelet/x/ansi v0.9.2 // indirect
+	github.com/charmbracelet/x/cellbuf v0.0.13 // indirect
+	github.com/charmbracelet/x/term v0.2.1 // indirect
+	github.com/erikgeiser/coninput v0.0.0-20211004153227-1c3628e74d0f // indirect
+	github.com/lucasb-eyer/go-colorful v1.2.0 // indirect
+	github.com/mattn/go-isatty v0.0.20 // indirect
+	github.com/mattn/go-localereader v0.0.1 // indirect
+	github.com/mattn/go-runewidth v0.0.16 // indirect
+	github.com/muesli/ansi v0.0.0-20230316100256-276c6243b2f6 // indirect
+	github.com/muesli/cancelreader v0.2.2 // indirect
+	github.com/muesli/termenv v0.16.0 // indirect
+	github.com/rivo/uniseg v0.4.7 // indirect
+	github.com/sahilm/fuzzy v0.1.1 // indirect
+	github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e // indirect
+	golang.org/x/sync v0.15.0 // indirect
+	golang.org/x/sys v0.33.0 // indirect
+	golang.org/x/text v0.26.0 // indirect
 )

go.mod

@@ -1,15 +1,57 @@
-github.com/1lann/promptui v0.8.1-0.20220708222609-81fad96dd5e1 h1:LejjvYg4tCW5HO7q/1nzPrprh47oUD9OUySQ29pDp5c=
-github.com/1lann/promptui v0.8.1-0.20220708222609-81fad96dd5e1/go.mod h1:cnC/60IoLiDM0GhdKYJ6oO7AwpZe1IQfPnSKlAURgHw=
-github.com/chzyer/logex v1.1.10/go.mod h1:+Ywpsq7O8HXn0nuIou7OrIPyXbp3wmkHB+jjWRnGsAI=
-github.com/chzyer/logex v1.2.1 h1:XHDu3E6q+gdHgsdTPH6ImJMIp436vR6MPtH8gP05QzM=
-github.com/chzyer/logex v1.2.1/go.mod h1:JLbx6lG2kDbNRFnfkgvh4eRJRPX1QCoOIWomwysCBrQ=
-github.com/chzyer/readline v0.0.0-20180603132655-2972be24d48e/go.mod h1:nSuG5e5PlCu98SY8svDHJxuZscDgtXS6KTTbou5AhLI=
-github.com/chzyer/readline v1.5.1 h1:upd/6fQk4src78LMRzh5vItIt361/o4uq553V8B5sGI=
-github.com/chzyer/readline v1.5.1/go.mod h1:Eh+b79XXUwfKfcPLepksvw2tcLE/Ct21YObkaSkeBlk=
-github.com/chzyer/test v0.0.0-20180213035817-a1ea475d72b1/go.mod h1:Q3SI9o4m/ZMnBNeIyt5eFwwo7qiLfzFZmjNmxjkiQlU=
-github.com/chzyer/test v1.0.0 h1:p3BQDXSxOhOG0P9z6/hGnII4LGiEPOYBhs8asl/fC04=
-github.com/chzyer/test v1.0.0/go.mod h1:2JlltgoNkt4TW/z9V/IzDdFaMTM2JPIi26O1pF38GC8=
-golang.org/x/sys v0.0.0-20181122145206-62eef0e2fa9b/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
-golang.org/x/sys v0.0.0-20220310020820-b874c991c1a5/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.13.0 h1:Af8nKPmuFypiUBjVoU9V20FiaFXOcuZI21p0ycVYYGE=
-golang.org/x/sys v0.13.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+github.com/atotto/clipboard v0.1.4 h1:EH0zSVneZPSuFR11BlR9YppQTVDbh5+16AmcJi4g1z4=
+github.com/atotto/clipboard v0.1.4/go.mod h1:ZY9tmq7sm5xIbd9bOK4onWV4S6X0u6GY7Vn0Yu86PYI=
+github.com/aymanbagabas/go-osc52/v2 v2.0.1 h1:HwpRHbFMcZLEVr42D4p7XBqjyuxQH5SMiErDT4WkJ2k=
+github.com/aymanbagabas/go-osc52/v2 v2.0.1/go.mod h1:uYgXzlJ7ZpABp8OJ+exZzJJhRNQ2ASbcXHWsFqH8hp8=
+github.com/aymanbagabas/go-udiff v0.2.0 h1:TK0fH4MteXUDspT88n8CKzvK0X9O2xu9yQjWpi6yML8=
+github.com/aymanbagabas/go-udiff v0.2.0/go.mod h1:RE4Ex0qsGkTAJoQdQQCA0uG+nAzJO/pI/QwceO5fgrA=
+github.com/charmbracelet/bubbles v0.21.0 h1:9TdC97SdRVg/1aaXNVWfFH3nnLAwOXr8Fn6u6mfQdFs=
+github.com/charmbracelet/bubbles v0.21.0/go.mod h1:HF+v6QUR4HkEpz62dx7ym2xc71/KBHg+zKwJtMw+qtg=
+github.com/charmbracelet/bubbletea v1.3.5 h1:JAMNLTbqMOhSwoELIr0qyP4VidFq72/6E9j7HHmRKQc=
+github.com/charmbracelet/bubbletea v1.3.5/go.mod h1:TkCnmH+aBd4LrXhXcqrKiYwRs7qyQx5rBgH5fVY3v54=
+github.com/charmbracelet/colorprofile v0.3.1 h1:k8dTHMd7fgw4bnFd7jXTLZrSU/CQrKnL3m+AxCzDz40=
+github.com/charmbracelet/colorprofile v0.3.1/go.mod h1:/GkGusxNs8VB/RSOh3fu0TJmQ4ICMMPApIIVn0KszZ0=
+github.com/charmbracelet/lipgloss v1.1.0 h1:vYXsiLHVkK7fp74RkV7b2kq9+zDLoEU4MZoFqR/noCY=
+github.com/charmbracelet/lipgloss v1.1.0/go.mod h1:/6Q8FR2o+kj8rz4Dq0zQc3vYf7X+B0binUUBwA0aL30=
+github.com/charmbracelet/x/ansi v0.9.2 h1:92AGsQmNTRMzuzHEYfCdjQeUzTrgE1vfO5/7fEVoXdY=
+github.com/charmbracelet/x/ansi v0.9.2/go.mod h1:3RQDQ6lDnROptfpWuUVIUG64bD2g2BgntdxH0Ya5TeE=
+github.com/charmbracelet/x/cellbuf v0.0.13 h1:/KBBKHuVRbq1lYx5BzEHBAFBP8VcQzJejZ/IA3iR28k=
+github.com/charmbracelet/x/cellbuf v0.0.13/go.mod h1:xe0nKWGd3eJgtqZRaN9RjMtK7xUYchjzPr7q6kcvCCs=
+github.com/charmbracelet/x/exp/golden v0.0.0-20241011142426-46044092ad91 h1:payRxjMjKgx2PaCWLZ4p3ro9y97+TVLZNaRZgJwSVDQ=
+github.com/charmbracelet/x/exp/golden v0.0.0-20241011142426-46044092ad91/go.mod h1:wDlXFlCrmJ8J+swcL/MnGUuYnqgQdW9rhSD61oNMb6U=
+github.com/charmbracelet/x/term v0.2.1 h1:AQeHeLZ1OqSXhrAWpYUtZyX1T3zVxfpZuEQMIQaGIAQ=
+github.com/charmbracelet/x/term v0.2.1/go.mod h1:oQ4enTYFV7QN4m0i9mzHrViD7TQKvNEEkHUMCmsxdUg=
+github.com/erikgeiser/coninput v0.0.0-20211004153227-1c3628e74d0f h1:Y/CXytFA4m6baUTXGLOoWe4PQhGxaX0KpnayAqC48p4=
+github.com/erikgeiser/coninput v0.0.0-20211004153227-1c3628e74d0f/go.mod h1:vw97MGsxSvLiUE2X8qFplwetxpGLQrlU1Q9AUEIzCaM=
+github.com/kylelemons/godebug v1.1.0 h1:RPNrshWIDI6G2gRW9EHilWtl7Z6Sb1BR0xunSBf0SNc=
+github.com/kylelemons/godebug v1.1.0/go.mod h1:9/0rRGxNHcop5bhtWyNeEfOS8JIWk580+fNqagV/RAw=
+github.com/lucasb-eyer/go-colorful v1.2.0 h1:1nnpGOrhyZZuNyfu1QjKiUICQ74+3FNCN69Aj6K7nkY=
+github.com/lucasb-eyer/go-colorful v1.2.0/go.mod h1:R4dSotOR9KMtayYi1e77YzuveK+i7ruzyGqttikkLy0=
+github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY=
+github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y=
+github.com/mattn/go-localereader v0.0.1 h1:ygSAOl7ZXTx4RdPYinUpg6W99U8jWvWi9Ye2JC/oIi4=
+github.com/mattn/go-localereader v0.0.1/go.mod h1:8fBrzywKY7BI3czFoHkuzRoWE9C+EiG4R1k4Cjx5p88=
+github.com/mattn/go-runewidth v0.0.16 h1:E5ScNMtiwvlvB5paMFdw9p4kSQzbXFikJ5SQO6TULQc=
+github.com/mattn/go-runewidth v0.0.16/go.mod h1:Jdepj2loyihRzMpdS35Xk/zdY8IAYHsh153qUoGf23w=
+github.com/muesli/ansi v0.0.0-20230316100256-276c6243b2f6 h1:ZK8zHtRHOkbHy6Mmr5D264iyp3TiX5OmNcI5cIARiQI=
+github.com/muesli/ansi v0.0.0-20230316100256-276c6243b2f6/go.mod h1:CJlz5H+gyd6CUWT45Oy4q24RdLyn7Md9Vj2/ldJBSIo=
+github.com/muesli/cancelreader v0.2.2 h1:3I4Kt4BQjOR54NavqnDogx/MIoWBFa0StPA8ELUXHmA=
+github.com/muesli/cancelreader v0.2.2/go.mod h1:3XuTXfFS2VjM+HTLZY9Ak0l6eUKfijIfMUZ4EgX0QYo=
+github.com/muesli/termenv v0.16.0 h1:S5AlUN9dENB57rsbnkPyfdGuWIlkmzJjbFf0Tf5FWUc=
+github.com/muesli/termenv v0.16.0/go.mod h1:ZRfOIKPFDYQoDFF4Olj7/QJbW60Ol/kL1pU3VfY/Cnk=
+github.com/rivo/uniseg v0.2.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc=
+github.com/rivo/uniseg v0.4.7 h1:WUdvkW8uEhrYfLC4ZzdpI2ztxP1I582+49Oc5Mq64VQ=
+github.com/rivo/uniseg v0.4.7/go.mod h1:FN3SvrM+Zdj16jyLfmOkMNblXMcoc8DfTHruCPUcx88=
+github.com/sahilm/fuzzy v0.1.1 h1:ceu5RHF8DGgoi+/dR5PsECjCDH1BE3Fnmpo7aVXOdRA=
+github.com/sahilm/fuzzy v0.1.1/go.mod h1:VFvziUEIMCrT6A6tw2RFIXPXXmzXbOsSHF0DOI8ZK9Y=
+github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e h1:JVG44RsyaB9T2KIHavMF/ppJZNG9ZpyihvCd0w101no=
+github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e/go.mod h1:RbqR21r5mrJuqunuUZ/Dhy/avygyECGrLceyNeo4LiM=
+golang.org/x/exp v0.0.0-20220909182711-5c715a9e8561 h1:MDc5xs78ZrZr3HMQugiXOAkSZtfTpbJLDr/lwfgO53E=
+golang.org/x/exp v0.0.0-20220909182711-5c715a9e8561/go.mod h1:cyybsKvd6eL0RnXn6p/Grxp8F5bW7iYuBgsNCOHpMYE=
+golang.org/x/sync v0.15.0 h1:KWH3jNZsfyT6xfAfKiz6MRNmd46ByHDYaZ7KSkCtdW8=
+golang.org/x/sync v0.15.0/go.mod h1:1dzgHSNfp02xaA81J2MS99Qcpr2w7fw1gpm99rleRqA=
+golang.org/x/sys v0.0.0-20210809222454-d867a43fc93e/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.33.0 h1:q3i8TbbEz+JRD9ywIRlyRAQbM0qF7hu24q3teo2hbuw=
+golang.org/x/sys v0.33.0/go.mod h1:BJP2sWEmIv4KK5OTEluFJCKSidICx8ciO85XgH3Ak8k=
+golang.org/x/text v0.26.0 h1:P42AVeLghgTYr4+xUnTRKDMqpar+PtX7KWuNQL21L8M=
+golang.org/x/text v0.26.0/go.mod h1:QK15LZJUUQVJxhz7wXgxSy/CJaTFjd0G+YLonydOVQA=

go.sum

@@ -0,0 +1,100 @@
+package media
+
+import (
+	"fmt"
+	"io/fs"
+	"os"
+	"path/filepath"
+	"strings"
+)
+
+// FileTypes contains the supported file extensions
+type FileTypes struct {
+	Audio []string
+	Video []string
+}
+
+// DefaultFileTypes returns the default supported file types
+func DefaultFileTypes() FileTypes {
+	return FileTypes{
+		Audio: []string{".mp3", ".ogg", ".aac"},
+		Video: []string{".mp4", ".webm", ".mpeg4", ".m4v", ".mov"},
+	}
+}
+
+// GetMediaFiles returns a list of media files in the given directory
+func GetMediaFiles(currentDir string, fileTypes FileTypes) []string {
+	mediaFiles := []string{}
+	problematicFiles := []string{}
+	allTypes := append(fileTypes.Audio, fileTypes.Video...)
+
+	filepath.WalkDir(currentDir, func(path string, file fs.DirEntry, err error) error {
+		if err != nil {
+			return err
+		}
+		if !file.IsDir() && IsValidFileType(file, allTypes) {
+			fixedFilePath := FixFilePath(path)
+			
+			// Check for problematic characters that cause issues with file:// URLs
+			if HasProblematicChars(file.Name()) {
+				problematicFiles = append(problematicFiles, file.Name())
+			}
+			
+			mediaFiles = append(mediaFiles, fixedFilePath)
+		}
+		return nil
+	})
+	
+	// Warn about problematic files
+	if len(problematicFiles) > 0 {
+		fmt.Printf("\n⚠️  WARNING: Found files with characters that may cause playback issues:\n")
+		for _, fileName := range problematicFiles {
+			fmt.Printf("   • %s\n", fileName)
+		}
+		fmt.Printf("\nProblematic characters: # ; ? : @ & = + $ ,\n")
+		fmt.Printf("Consider renaming these files to avoid potential issues.\n\n")
+	}
+	
+	return mediaFiles
+}
+
+// IsValidFileType checks if a file has a supported extension
+func IsValidFileType(file fs.DirEntry, fileExts []string) bool {
+	for _, ext := range fileExts {
+		if strings.HasSuffix(file.Name(), ext) {
+			return true
+		}
+	}
+	return false
+}
+
+// FixFilePath converts file path separators to forward slashes for HTML
+func FixFilePath(filePath string) string {
+	// Only do replacement if needed (Windows paths)
+	if os.PathSeparator != '/' {
+		return strings.ReplaceAll(filePath, string(os.PathSeparator), "/")
+	}
+	return filePath
+}
+
+// HasProblematicChars checks if a filename contains characters that cause issues with file:// URLs
+func HasProblematicChars(fileName string) bool {
+	problematicChars := []string{"#", ";", "?", ":", "@", "&", "=", "+", "$", ","}
+	for _, char := range problematicChars {
+		if strings.Contains(fileName, char) {
+			return true
+		}
+	}
+	return false
+}
+
+// RemoveTransitionVideo removes the transition video from the list of media files
+func RemoveTransitionVideo(transitionVideo string, mediaFiles []string) []string {
+	var result []string
+	for _, file := range mediaFiles {
+		if file != transitionVideo {
+			result = append(result, file)
+		}
+	}
+	return result
+}