Merge pull request #18 from b0bbywan/scheduler

add mpd scheduler

Author: b0bbywan

README.md

@@ -146,6 +146,7 @@ PulseServer: ""
 MountConfig: "mpd"
 MPDCueSubfolder: ".disc-cuer"
 MPDUSBSubfolder: ".udisks"
+Schedule: {}
 
 ```
 
@@ -159,13 +160,7 @@ The type of connection to use. Supported values:
 
 - **Address**:
 	- For Type: `"unix"`, this is the path to the MPD socket file (e.g., `/var/run/mpd/socket` ) *(recommended)*.
-	- For Type: `"tcp"`, this is the <hostname>:<port> of the MPD server (e.g., `127.0.0.1:6600`) *(default)*. *(Even though remote MPD server are supported, they won't work without additional setup not covered in this documentation)*
-
-
-#### Notifications Options
-- **AudioBackend**: `"pulse"` *(default)*, `"alsa"` or `"none` (disable notifications).
-- **PulseServer**: Check [Pulseaudio Server String doc](https://www.freedesktop.org/wiki/Software/PulseAudio/Documentation/User/ServerStrings/)
-- **SoundsLocation**: `"/usr/local/share/mpd-discplayer"` *(default)*. No default sounds are provided at the moment. Notifications expect `in.mp3`, `out.mp3` and `error.mp3` to be present in the specified folder or notifications will be disabled.
+	- For Type: `"tcp"`, this is the <hostname>:<port> of the MPD server (e.g., `127.0.0.1:6600`) *(default)*.
 
 #### Mouting Options
 For USB stick support, the content of the stick must be made available in MPD database. MPD-Discplayer supports the native mpd mouting feature, or symlinks for MPD servers that do not support this feature.
@@ -175,6 +170,36 @@ For USB stick support, the content of the stick must be made available in MPD da
 - **MPDLibraryFolder**: path to MPD music_directory *(self discovered when using MPD unix socket)*
 - **MPDUSBSubfolder**: path inside `MPDLibraryFolder` to store symlinks to usb original mountpoints. Only with `MountConfig: "symlink"`, not used with `MountConfig: "mpd"`
 
+#### Schedule Option
+The Schedule option allows you to automate playback of MPD-compatible URIs based on a cron schedule. It currently supports the following:
+	- **Webradio** URIs (e.g., HTTP streams).
+	- **Audio CDs** (using cdda:// protocol).
+	- **USB devices** (using mount points or symlinks).
+	- **MPD Database** (use `mpc listall` to list MPD Database)
+
+Incompatible cron will be discarded and logged on startup. A notification will be trigerred before starting the scheduled playback and if an error happens while loading the uri.
+
+Example configuration:
+
+```yaml
+Schedule:
+  # Play a reggae radio stream on weekdays at 6:30 AM
+  "30 6 * * 1-5": "//hd.lagrosseradio.info/lagrosseradio-reggae-192.mp3"
+  # Play an audio CD on Saturdays at 9:00 AM
+  "0 9 * * 6": "cdda://"
+  # Play from a USB device (symlink mount) on Sundays at 9:00 PM
+  "0 21 * * 7": ".udisks/{usb_label}"
+  # Play from an MPD-mounted USB device on Sundays at 9:00 PM
+  "0 21 * * 7": "{usb_label}"
+
+```
+Note: Ensure that the `usb_label` matches the label of the USB device. For audio CDs, only `cdda://` protocol is supported for now.
+
+#### Notifications Options
+- **AudioBackend**: `"pulse"` *(default)*, `"alsa"` or `"none` (disable notifications).
+- **PulseServer**: Check [Pulseaudio Server String doc](https://www.freedesktop.org/wiki/Software/PulseAudio/Documentation/User/ServerStrings/)
+- **SoundsLocation**: `"/usr/local/share/mpd-discplayer"` *(default)*. No default sounds are provided at the moment. Notifications expect `in.mp3`, `out.mp3` and `error.mp3` to be present in the specified folder or notifications will be disabled.
+
 ### Environment Variables
 
 If a configuration file is not provided, you can use environment variables to set the same options. Below is the list of supported variables and their defaults (if applicable):
@@ -192,7 +217,8 @@ If a configuration file is not provided, you can use environment variables to se
 | `MPD_DISCPLAYER_AUDIOBACKEND` | `AudioBackend` | `pulse` |
 | `MPD_DISCPLAYER_PULSESERVER` | `PulseServer` | *(Default to `""`, e.g. local pulseaudio unix socket)* | `MPD_DISCPLAYER_MOUNTCONFIG` | `MountConfig` | `mpd`
 | `MPD_DISCPLAYER_MPDCUESUBFOLDER` | `MPDCueSubfolder` | `.disc-cuer` |
-| `MPD_DISCPLAYER_MPDUSBSUBFOLDER` | `MPDUSBSubfolder` | `.udisks`
+| `MPD_DISCPLAYER_MPDUSBSUBFOLDER` | `MPDUSBSubfolder` | `.udisks` |
+| *(Unsupported)* | `Schedule` | *{}  (empty, disables scheduling)* |
 
 #### Priority of Configuration
 The configuration is loaded in the following order of priority:

cmd/player.go

@@ -22,7 +22,7 @@ import (
 
 const (
 	AppName          = "mpd-discplayer"
-	AppVersion       = "0.5"
+	AppVersion       = "0.6"
 	defaultMpdFolder = "/var/lib/mpd/music"
 )
 
@@ -35,6 +35,7 @@ type Player struct {
 	Notifier  *notifications.Notifier
 	Mounter   *mounts.MountManager
 	handlers  []*hwcontrol.EventHandler
+	scheduler *scheduler
 }
 
 func NewPlayer() (*Player, error) {
@@ -49,6 +50,7 @@ func NewPlayer() (*Player, error) {
 	viper.SetDefault("AudioBackend", "pulse")
 	viper.SetDefault("PulseServer", "")
 	viper.SetDefault("MountConfig", "mpd")
+	viper.SetDefault("Schedule", make(map[string]string))
 
 	// Load from configuration file, environment variables, and CLI flags
 	viper.SetConfigName("config")                       // name of config file (without extension)
@@ -112,6 +114,9 @@ func NewPlayer() (*Player, error) {
 	)
 	notifier := notifications.NewNotifier(notificationConfig)
 
+	schedules := newSchedulerUris(mpdClient, notifier, viper.GetStringMapString("Schedule"))
+	scheduler := newScheduler(schedules)
+
 	return &Player{
 		ctx:       ctx,
 		cancel:    cancel,
@@ -120,10 +125,13 @@ func NewPlayer() (*Player, error) {
 		Client:    mpdClient,
 		Notifier:  notifier,
 		Mounter:   mounter,
+		scheduler: scheduler,
 	}, nil
 }
 
 func (p *Player) Start() {
+	p.StartScheduler()
+
 	// Create event handlers (subscribers) passing the context
 	p.newDiscHandlers()
 	p.newUSBHandlers()
@@ -179,6 +187,9 @@ func (p *Player) Close() {
 	if p.Notifier != nil {
 		p.Notifier.Close()
 	}
+	if p.scheduler != nil {
+		p.scheduler.Close()
+	}
 	p.wg.Wait()
 }
 

cmd/scheduler.go

@@ -0,0 +1,98 @@
+package cmd
+
+import (
+	"log"
+
+	"github.com/robfig/cron/v3"
+
+	"github.com/b0bbywan/go-mpd-discplayer/mpdplayer"
+	"github.com/b0bbywan/go-mpd-discplayer/notifications"
+)
+
+type scheduler struct {
+	c        *cron.Cron
+	schedule []*ScheduleUri
+}
+
+type ScheduleUri struct {
+	schedule string
+	uri      string
+	callback func()
+	jobId    cron.EntryID
+}
+
+func newScheduler(schedulers []*ScheduleUri) *scheduler {
+	if len(schedulers) == 0 {
+		return nil
+	}
+
+	c := cron.New()
+	for _, v := range schedulers {
+		jobId, err := c.AddFunc(v.schedule, v.callback)
+		if err != nil {
+			log.Printf("Failed to add %s cron, check syntax: %v", v.schedule, err)
+		}
+		v.jobId = jobId
+		log.Printf("Added schedule: cron='%s' uri='%s'", v.schedule, v.uri)
+	}
+	s := &scheduler{
+		c:        c,
+		schedule: schedulers,
+	}
+	return s
+}
+
+func (s *scheduler) Close() {
+	if s != nil {
+		s.c.Stop()
+		s.c = nil
+		s.schedule = nil
+	}
+}
+
+func (p *Player) StopScheduler() {
+	if p.scheduler != nil {
+		p.scheduler.c.Stop()
+	}
+}
+
+func (p *Player) StartScheduler() {
+	if p.scheduler != nil {
+		p.scheduler.c.Start()
+	}
+}
+
+func newSchedulerUris(
+	mpdClient *mpdplayer.ReconnectingMPDClient,
+	notifier *notifications.Notifier,
+	schedules map[string]string,
+) []*ScheduleUri {
+	var schedulers []*ScheduleUri
+	for k, v := range schedules {
+		schedulers = append(schedulers, newSchedulerUri(mpdClient, notifier, k, v))
+	}
+	return schedulers
+}
+
+func newSchedulerUri(
+	mpdClient *mpdplayer.ReconnectingMPDClient,
+	notifier *notifications.Notifier,
+	schedule, uri string,
+) *ScheduleUri {
+	callback := func() {
+		if notifier != nil {
+			notifier.PlayEvent(notifications.EventAdd)
+		}
+		if err := mpdClient.StartPlayback(uri); err != nil {
+			if notifier != nil {
+				notifier.PlayError()
+			}
+			log.Printf("Failed to play %s: %v", uri, err)
+		}
+	}
+	return &ScheduleUri{
+		schedule: schedule,
+		uri:      uri,
+		callback: callback,
+	}
+}

go.mod

@@ -9,6 +9,7 @@ require (
 	github.com/hajimehoshi/oto/v2 v2.4.2
 	github.com/jfreymuth/pulse v0.1.1
 	github.com/jochenvg/go-udev v0.0.0-20240801134859-b65ed646224b
+	github.com/robfig/cron/v3 v3.0.0
 	github.com/spf13/viper v1.19.0
 	golang.org/x/sys v0.27.0
 )

go.sum

@@ -34,6 +34,8 @@ github.com/pelletier/go-toml/v2 v2.2.2 h1:aYUidT7k73Pcl9nb2gScu7NSrKCSHIDE89b3+6
 github.com/pelletier/go-toml/v2 v2.2.2/go.mod h1:1t835xjRzz80PqgE6HHgN2JOsmgYu/h4qDAS4n929Rs=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 h1:Jamvg5psRIccs7FGNTlIRMkT8wgtp5eCXdBlqhYGL6U=
+github.com/robfig/cron/v3 v3.0.0 h1:kQ6Cb7aHOHTSzNVNEhmp8EcWKLb4CbiMW9h9VyIhO4E=
+github.com/robfig/cron/v3 v3.0.0/go.mod h1:eQICP3HwyT7UooqI/z+Ov+PtYAWygg1TEWWzGIFLtro=
 github.com/rogpeppe/go-internal v1.9.0 h1:73kH8U+JUqXU8lRuOHeVHaa/SZPifC7BkcraZVejAe8=
 github.com/sagikazarmark/locafero v0.4.0 h1:HApY1R9zGo4DBgr7dqsTH/JJxLTTsOt7u6keLGt6kNQ=
 github.com/sagikazarmark/locafero v0.4.0/go.mod h1:Pe1W6UlPYUk/+wc/6KFhbORCfqzgYEpgQ3O5fPuL3H4=

mpdplayer/operations.go

@@ -24,6 +24,10 @@ func (rc *ReconnectingMPDClient) StartUSBPlayback(device string) error {
 	return rc.startPlayback(addUSBToQueue, device)
 }
 
+func (rc *ReconnectingMPDClient) StartPlayback(uri string) error {
+	return rc.startPlayback(addUri, uri)
+}
+
 // StartDiscPlayback now accepts a custom playback function
 func (rc *ReconnectingMPDClient) startPlayback(playbackFunc PlaybackAction, device string) error {
 	return rc.execute(func(client *mpd.Client) error {
@@ -158,7 +162,7 @@ func loadCue(client *mpd.Client, cuerConfig *config.Config, device string) error
 // addTracks adds individual CDDA tracks to the MPD playlist based on the specified track count.
 func addTracks(client *mpd.Client, trackCount int) error {
 	for track := 1; track <= trackCount; track++ {
-		if err := client.Add(fmt.Sprintf("%s/%d", CDDAPathPrefix, track)); err != nil {
+		if err := addUri(client, fmt.Sprintf("%s/%d", CDDAPathPrefix, track)); err != nil {
 			return fmt.Errorf("failed to add track %d: %w", track, err)
 		}
 	}
@@ -193,8 +197,12 @@ func addUSBToQueue(client *mpd.Client, label string) error {
 		return fmt.Errorf("Database update failed: %w", err)
 	}
 	log.Printf("Adding %s files to queue...", label)
-	if err := client.Add(label); err != nil {
-		return fmt.Errorf("failed to add files from %s: %w", label, err)
+	return addUri(client, label)
+}
+
+func addUri(client *mpd.Client, uri string) error {
+	if err := client.Add(uri); err != nil {
+		return fmt.Errorf("failed to add uri %s: %w", uri, err)
 	}
 	return nil
 }