Merge pull request #19 from chrusty/terminal_user_interface

Terminal user interface

Author: vishen

README.md

@@ -128,6 +128,45 @@ If you would like to see what a device is sending, you are able to `watch` the p
 $ go-chromecast watch
 ```
 
+## User Interface
+
+![User-interface example](go-chromecast-ui.png "User-interface example")
+
+A basic terminal user-interface is provided, that supports the following controls:
+* Quit: "q"
+* Play/Pause: SPACE
+* Volume: - / +
+* Mute/Unmute: "m"
+* Seek (15s): <- / ->
+* Previous/Next: PgUp / PgDn
+* Stop: "s"
+
+It can be run in the following ways:
+
+### Standalone
+
+If you just want to remote-control a chromecast that is already playing something:
+
+```
+$ go-chromecast ui
+```
+
+### Playlist
+
+Use the UI in combination with the `playlist` command (detailed above):
+
+```
+$ go-chromecast --with-ui playlist /path/to/directory
+```
+
+### Load
+
+Use the UI in combination with the `load` command (detailed above):
+
+```
+$ go-chromecast --with-ui load /path/to/file.flac
+```
+
 ## Installing
 
 ### Install binaries
@@ -161,6 +200,7 @@ Available Commands:
   seek        Seek by seconds into the currently playing media
   status      Current chromecast status
   stop        Stop casting
+  ui          Run the UI
   unpause     Unpause the currently playing media on the chromecast
   watch       Watch all events sent from a chromecaset device
 
@@ -171,6 +211,7 @@ Flags:
       --disable-cache        disable the cache
   -h, --help                 help for go-chromecast
   -u, --uuid string          chromecast device uuid
+      --with-ui              run with a UI
 
 Use "go-chromecast [command] --help" for more information about a command.
 ```

application/application.go

@@ -249,7 +249,7 @@ func (a *Application) Status() (*cast.Application, *cast.Media, *cast.Volume) {
 
 func (a *Application) Pause() error {
 	if a.media == nil {
-		return errors.New("media not yet initialised, there is nothing to pause")
+		return ErrNoMediaPause
 	}
 	return a.sendMediaRecv(&cast.MediaHeader{
 		PayloadHeader:  cast.PauseHeader,
@@ -259,7 +259,7 @@ func (a *Application) Pause() error {
 
 func (a *Application) Unpause() error {
 	if a.media == nil {
-		return errors.New("media not yet initialised, there is nothing to unpause")
+		return ErrNoMediaUnpause
 	}
 	return a.sendMediaRecv(&cast.MediaHeader{
 		PayloadHeader:  cast.PlayHeader,
@@ -269,7 +269,7 @@ func (a *Application) Unpause() error {
 
 func (a *Application) StopMedia() error {
 	if a.media == nil {
-		return errors.New("media not yet initialised, there is nothing to stop")
+		return ErrNoMediaStop
 	}
 	return a.sendMediaRecv(&cast.MediaHeader{
 		PayloadHeader:  cast.StopHeader,
@@ -283,7 +283,7 @@ func (a *Application) Stop() error {
 
 func (a *Application) Next() error {
 	if a.media == nil {
-		return errors.New("media not yet initialised, there is nothing to go to next")
+		return ErrNoMediaNext
 	}
 
 	// TODO(vishen): Get the number of queue items, if none, possibly just skip to the end?
@@ -296,7 +296,7 @@ func (a *Application) Next() error {
 
 func (a *Application) Previous() error {
 	if a.media == nil {
-		return errors.New("media not yet initialised, there is nothing previous")
+		return ErrNoMediaPrevious
 	}
 
 	// TODO(vishen): Get the number of queue items, if none, possibly just jump to beginning?
@@ -310,7 +310,7 @@ func (a *Application) Previous() error {
 func (a *Application) Skip() error {
 
 	if a.media == nil {
-		return errors.New("media not yet initialised, there is nothing to skip")
+		return ErrNoMediaSkip
 	}
 
 	// Get the latest media status
@@ -329,7 +329,7 @@ func (a *Application) Skip() error {
 
 func (a *Application) Seek(value int) error {
 	if a.media == nil {
-		return errors.New("media not yet initialised")
+		return ErrMediaNotYetInitialised
 	}
 
 	return a.sendMediaRecv(&cast.MediaHeader{
@@ -342,7 +342,7 @@ func (a *Application) Seek(value int) error {
 
 func (a *Application) SeekFromStart(value int) error {
 	if a.media == nil {
-		return errors.New("media not yet initialised")
+		return ErrMediaNotYetInitialised
 	}
 
 	// Get the latest media status
@@ -362,6 +362,28 @@ func (a *Application) SeekFromStart(value int) error {
 	})
 }
 
+func (a *Application) SetVolume(value float32) error {
+	if value > 1 || value < 0 {
+		return ErrVolumeOutOfRange
+	}
+
+	return a.sendDefaultRecv(&cast.SetVolume{
+		PayloadHeader: cast.VolumeHeader,
+		Volume: cast.Volume{
+			Level: value,
+		},
+	})
+}
+
+func (a *Application) SetMuted(value bool) error {
+	return a.sendDefaultRecv(&cast.SetVolume{
+		PayloadHeader: cast.VolumeHeader,
+		Volume: cast.Volume{
+			Muted: value,
+		},
+	})
+}
+
 func (a *Application) getMediaStatus() (*cast.MediaStatusResponse, error) {
 	apiMessage, err := a.sendAndWaitMediaRecv(&cast.GetStatusHeader)
 	if err != nil {
@@ -695,7 +717,7 @@ func (a *Application) startStreamingServer() error {
 	go func() {
 		a.log("media server listening on %d", a.serverPort)
 		if err := a.httpServer.Serve(listener); err != nil && err != http.ErrServerClosed {
-			log.Fatal(err)
+			log.WithField("package", "application").WithError(err).Fatal("error serving HTTP")
 		}
 	}()
 
@@ -719,14 +741,14 @@ func (a *Application) serveLiveStreaming(w http.ResponseWriter, r *http.Request,
 	w.Header().Set("Transfer-Encoding", "chunked")
 
 	if err := cmd.Run(); err != nil {
-		log.Printf("error transcoding %q: %v", filename, err)
+		log.WithField("package", "application").WithField("filename", filename).WithError(err).Error("error transcoding")
 	}
 
 }
 
 func (a *Application) log(message string, args ...interface{}) {
 	if a.debug {
-		log.Infof("[application] %s", fmt.Sprintf(message, args...))
+		log.WithField("package", "application").Infof(message, args...)
 	}
 }
 
@@ -778,15 +800,15 @@ func (a *Application) sendDefaultRecv(payload cast.Payload) error {
 
 func (a *Application) sendMediaConn(payload cast.Payload) error {
 	if a.application == nil {
-		return errors.New("application isn't set")
+		return ErrApplicationNotSet
 	}
 	_, err := a.send(payload, defaultSender, a.application.TransportId, namespaceConn)
 	return err
 }
 
 func (a *Application) sendMediaRecv(payload cast.Payload) error {
 	if a.application == nil {
-		return errors.New("application isn't set")
+		return ErrApplicationNotSet
 	}
 	_, err := a.send(payload, defaultSender, a.application.TransportId, namespaceMedia)
 	return err
@@ -802,14 +824,14 @@ func (a *Application) sendAndWaitDefaultRecv(payload cast.Payload) (*pb.CastMess
 
 func (a *Application) sendAndWaitMediaConn(payload cast.Payload) (*pb.CastMessage, error) {
 	if a.application == nil {
-		return nil, errors.New("application isn't set")
+		return nil, ErrApplicationNotSet
 	}
 	return a.sendAndWait(payload, defaultSender, a.application.TransportId, namespaceConn)
 }
 
 func (a *Application) sendAndWaitMediaRecv(payload cast.Payload) (*pb.CastMessage, error) {
 	if a.application == nil {
-		return nil, errors.New("application isn't set")
+		return nil, ErrApplicationNotSet
 	}
 	return a.sendAndWait(payload, defaultSender, a.application.TransportId, namespaceMedia)
 }

application/errors.go

@@ -0,0 +1,15 @@
+package application
+
+import "github.com/pkg/errors"
+
+var (
+	ErrApplicationNotSet      = errors.New("application isn't set")
+	ErrMediaNotYetInitialised = errors.New("media not yet initialised")
+	ErrNoMediaNext            = errors.New("media not yet initialised, there is nothing to go to next")
+	ErrNoMediaPause           = errors.New("media not yet initialised, there is nothing to pause")
+	ErrNoMediaPrevious        = errors.New("media not yet initialised, there is nothing previous")
+	ErrNoMediaSkip            = errors.New("media not yet initialised, there is nothing to skip")
+	ErrNoMediaStop            = errors.New("media not yet initialised, there is nothing to stop")
+	ErrNoMediaUnpause         = errors.New("media not yet initialised, there is nothing to unpause")
+	ErrVolumeOutOfRange       = errors.New("specified volume is out of range (0 - 1)")
+)

cast/connection.go

@@ -53,7 +53,7 @@ func (c *Connection) SetDebug(debug bool) { c.debug = debug }
 
 func (c *Connection) log(message string, args ...interface{}) {
 	if c.debug {
-		log.Printf("[connection] %s", fmt.Sprintf(message, args...))
+		log.WithField("package", "cast").Debugf(message, args...)
 	}
 }
 

cast/payload.go

@@ -60,7 +60,7 @@ type MediaHeader struct {
 }
 
 type Volume struct {
-	Level float32 `json:"level"`
+	Level float32 `json:"level,omitempty"`
 	Muted bool    `json:"muted"`
 }
 
@@ -107,16 +107,26 @@ type QueueData struct {
 }
 
 type MediaItem struct {
-	ContentId   string  `json:"contentId"`
-	ContentType string  `json:"contentType"`
-	StreamType  string  `json:"streamType"`
-	Duration    float32 `json:"duration"`
-	Metadata    struct {
-		MetadataType int    `json:"metadataType`
-		Title        string `json:"title"`
-		SongName     string `json:"songName"`
-		Artist       string `json:"artist"`
-	} `json:"metadata"`
+	ContentId   string        `json:"contentId"`
+	ContentType string        `json:"contentType"`
+	StreamType  string        `json:"streamType"`
+	Duration    float32       `json:"duration"`
+	Metadata    MediaMetadata `json:"metadata"`
+}
+
+type MediaMetadata struct {
+	MetadataType int     `json:"metadataType`
+	Artist       string  `json:"artist"`
+	Title        string  `json:"title"`
+	Subtitle     string  `json:"subtitle"`
+	Images       []Image `json:"images"`
+	ReleaseDate  string  `json:"releaseDate"`
+}
+
+type Image struct {
+	URL    string `json:"url"`
+	Height int    `json:"height"`
+	Width  int    `json:"width"`
 }
 
 type Media struct {
@@ -135,3 +145,8 @@ type MediaStatusResponse struct {
 	PayloadHeader
 	Status []Media `json:"status"`
 }
+
+type SetVolume struct {
+	PayloadHeader
+	Volume Volume `json:"volume"`
+}

cmd/load.go

@@ -17,6 +17,9 @@ package cmd
 import (
 	"fmt"
 
+	"github.com/vishen/go-chromecast/ui"
+
+	"github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
 )
 
@@ -40,8 +43,27 @@ that ffmpeg is installed.`,
 			fmt.Printf("unable to get cast application: %v\n", err)
 			return nil
 		}
+
 		contentType, _ := cmd.Flags().GetString("content-type")
 		transcode, _ := cmd.Flags().GetBool("transcode")
+
+		// Optionally run a UI when playing this media:
+		runWithUI, _ := cmd.Flags().GetBool("with-ui")
+		if runWithUI {
+			go func() {
+				if err := app.Load(args[0], contentType, transcode); err != nil {
+					logrus.WithError(err).Fatal("unable to load media")
+				}
+			}()
+
+			ccui, err := ui.NewUserInterface(app)
+			if err != nil {
+				logrus.WithError(err).Fatal("unable to prepare a new user-interface")
+			}
+			return ccui.Run()
+		}
+
+		// Otherwise just run in CLI mode:
 		if err := app.Load(args[0], contentType, transcode); err != nil {
 			fmt.Printf("unable to load media: %v\n", err)
 			return nil

cmd/playlist.go

@@ -25,7 +25,9 @@ import (
 	"strings"
 	"time"
 
+	"github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
+	"github.com/vishen/go-chromecast/ui"
 )
 
 type mediaFile struct {
@@ -60,6 +62,7 @@ that ffmpeg is installed.`,
 			fmt.Printf("unable to get cast application: %v\n", err)
 			return nil
 		}
+
 		contentType, _ := cmd.Flags().GetString("content-type")
 		transcode, _ := cmd.Flags().GetBool("transcode")
 		forcePlay, _ := cmd.Flags().GetBool("force-play")
@@ -197,6 +200,22 @@ that ffmpeg is installed.`,
 			fmt.Printf("- %s\n", f)
 		}
 
+		// Optionally run a UI when playing this media:
+		runWithUI, _ := cmd.Flags().GetBool("with-ui")
+		if runWithUI {
+			go func() {
+				if err := app.QueueLoad(filenames[indexToPlayFrom:], contentType, transcode); err != nil {
+					logrus.WithError(err).Fatal("unable to play playlist on cast application")
+				}
+			}()
+
+			ccui, err := ui.NewUserInterface(app)
+			if err != nil {
+				logrus.WithError(err).Fatal("unable to prepare a new user-interface")
+			}
+			return ccui.Run()
+		}
+
 		if err := app.QueueLoad(filenames[indexToPlayFrom:], contentType, transcode); err != nil {
 			fmt.Printf("unable to play playlist on cast application: %v\n", err)
 			return nil

cmd/root.go

@@ -41,6 +41,7 @@ func Execute() {
 func init() {
 	rootCmd.PersistentFlags().Bool("debug", false, "debug logging")
 	rootCmd.PersistentFlags().Bool("disable-cache", false, "disable the cache")
+	rootCmd.PersistentFlags().Bool("with-ui", false, "run with a UI")
 	rootCmd.PersistentFlags().StringP("device", "d", "", "chromecast device, ie: 'Chromecast' or 'Google Home Mini'")
 	rootCmd.PersistentFlags().StringP("device-name", "n", "", "chromecast device name")
 	rootCmd.PersistentFlags().StringP("uuid", "u", "", "chromecast device uuid")