1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362
|
// Package mpvipc provides an interface for communicating with the mpv media
// player via it's JSON IPC interface
package mpvipc
import (
"bufio"
"fmt"
"net"
"reflect"
"sync"
"github.com/ugorji/go/codec"
)
// Connection represents a connection to a mpv IPC socket
type Connection struct {
client net.Conn
socketName string
lastRequest int64
waitingRequests map[int64]chan *commandResult
eventHub *Hub
lastCloseWaiter uint
closeWaiters map[uint]chan struct{}
lock *sync.Mutex
}
type Parser struct {
decoder *codec.Decoder
encoder *codec.Encoder
enc sync.Mutex
}
// Event represents an event received from mpv. For a list of all possible
// events, see https://mpv.io/manual/master/#list-of-events
type Event struct {
// Name is the only obligatory field: the name of the event
Name string `json:"event"`
// Reason is the reason for the event: currently used for the "end-file"
// event. When Name is "end-file", possible values of Reason are:
// "eof", "stop", "quit", "error", "redirect", "unknown"
Reason string `json:"reason"`
// Prefix is the log-message prefix (only if Name is "log-message")
Prefix string `json:"prefix"`
// Level is the loglevel for a log-message (only if Name is "log-message")
Level string `json:"level"`
// Text is the text of a log-message (only if Name is "log-message")
Text string `json:"text"`
// ID is the user-set property ID (on events triggered by observed properties)
ID int64 `json:"id"`
// Data is the property value (on events triggered by observed properties)
Data interface{} `json:"data"`
// ExtraData contains extra attributes of the event payload (on spontaneous events)
ExtraData map[string]interface{} `json:"-"`
}
type EventListener struct {
send chan<- *Event
}
var eventFieldNames = []string{}
var parser *Parser
func init() {
// collect all named fields into a global
val := reflect.ValueOf(Event{})
for i := 0; i < val.Type().NumField(); i++ {
field := val.Type().Field(i).Tag.Get("json")
if field != "-" {
eventFieldNames = append(eventFieldNames, field)
}
}
}
func (e *Event) UnmarshalJSON(data []byte) error {
type Proxy Event
// unmarshal named fields
if err := parser.Decode(data, (*Proxy)(e)); err != nil {
return err
}
// unmarshal unnamed fields into our container
if err := parser.Decode(data, &e.ExtraData); err != nil {
return err
}
// drop all named fields from ExtraData
for _, field := range eventFieldNames {
delete(e.ExtraData, field)
}
return nil
}
func (e *Event) MarshalJSON() ([]byte, error) {
return parser.Encode(&e)
}
func (p *Parser) Encode(value interface{}) ([]byte, error) {
parser.enc.Lock()
defer parser.enc.Unlock()
var data []byte
parser.encoder.ResetBytes(&data)
return data, parser.encoder.Encode(value)
}
func (p *Parser) Decode(data []byte, value interface{}) error {
parser.decoder.ResetBytes(data)
return parser.decoder.Decode(value)
}
// NewConnection returns a Connection associated with the given unix socket
func NewConnection(socketName string) *Connection {
parser = &Parser{
decoder: codec.NewDecoderBytes(nil, &codec.JsonHandle{}),
encoder: codec.NewEncoderBytes(nil, &codec.JsonHandle{}),
}
return &Connection{
socketName: socketName,
lock: &sync.Mutex{},
waitingRequests: make(map[int64]chan *commandResult),
closeWaiters: make(map[uint]chan struct{}),
}
}
// Open connects to the socket. Returns an error if already connected.
// It also starts listening to events, so ListenForEvents() can be called
// afterwards.
func (c *Connection) Open() error {
c.lock.Lock()
defer c.lock.Unlock()
if c.client != nil {
return fmt.Errorf("already open")
}
client, err := dial(c.socketName)
if err != nil {
return fmt.Errorf("can't connect to mpv's socket: %s", err)
}
c.client = client
c.eventHub = newHub()
go c.eventHub.run()
go c.listen()
return nil
}
// ListenForEvents blocks until something is received on the stop channel (or
// it's closed).
// In the mean time, events received on the socket will be sent on the events
// channel. They may not appear in the same order they happened in.
//
// The events channel is closed automatically just before this method returns.
func (c *Connection) ListenForEvents(events chan<- *Event, stop <-chan struct{}) {
listener := &EventListener{send: events}
c.eventHub.register <- listener
<-stop
c.eventHub.unregister <- listener
}
// NewEventListener is a convenience wrapper around ListenForEvents(). It
// creates and returns the event channel and the stop channel. After calling
// NewEventListener, read events from the events channel and send an empty
// struct to the stop channel to close it.
func (c *Connection) NewEventListener() (chan *Event, chan struct{}) {
events := make(chan *Event, 256)
stop := make(chan struct{})
go c.ListenForEvents(events, stop)
return events, stop
}
// Call calls an arbitrary command and returns its result. For a list of
// possible functions, see https://mpv.io/manual/master/#commands and
// https://mpv.io/manual/master/#list-of-input-commands
func (c *Connection) Call(arguments ...interface{}) (interface{}, error) {
c.lock.Lock()
c.lastRequest++
id := c.lastRequest
resultChannel := make(chan *commandResult)
c.waitingRequests[id] = resultChannel
c.lock.Unlock()
defer func() {
c.lock.Lock()
close(c.waitingRequests[id])
delete(c.waitingRequests, id)
c.lock.Unlock()
}()
err := c.sendCommand(id, arguments...)
if err != nil {
return nil, err
}
result := <-resultChannel
if result.Status == "success" {
return result.Data, nil
}
return nil, fmt.Errorf("mpv error: %s", result.Status)
}
// Set is a shortcut to Call("set_property", property, value)
func (c *Connection) Set(property string, value interface{}) error {
_, err := c.Call("set_property", property, value)
return err
}
// Get is a shortcut to Call("get_property", property)
func (c *Connection) Get(property string) (interface{}, error) {
value, err := c.Call("get_property", property)
return value, err
}
// Close closes the socket, disconnecting from mpv. It is safe to call Close()
// on an already closed connection.
func (c *Connection) Close() error {
c.lock.Lock()
defer c.lock.Unlock()
if c.client != nil {
err := c.client.Close()
for waiterID := range c.closeWaiters {
close(c.closeWaiters[waiterID])
}
c.client = nil
return err
}
return nil
}
// IsClosed returns true if the connection is closed. There are several cases
// in which a connection is closed:
//
// 1. Close() has been called
//
// 2. The connection has been initialised but Open() hasn't been called yet
//
// 3. The connection terminated because of an error, mpv exiting or crashing
//
// It's ok to use IsClosed() to check if you need to reopen the connection
// before calling a command.
func (c *Connection) IsClosed() bool {
return c.client == nil
}
// WaitUntilClosed blocks until the connection becomes closed. See IsClosed()
// for an explanation of the closed state.
func (c *Connection) WaitUntilClosed() {
c.lock.Lock()
if c.IsClosed() {
c.lock.Unlock()
return
}
closed := make(chan struct{})
c.lastCloseWaiter++
waiterID := c.lastCloseWaiter
c.closeWaiters[waiterID] = closed
c.lock.Unlock()
<-closed
c.lock.Lock()
delete(c.closeWaiters, waiterID)
c.lock.Unlock()
}
func (c *Connection) sendCommand(id int64, arguments ...interface{}) error {
if c.client == nil {
return fmt.Errorf("trying to send command on closed mpv client")
}
message := &commandRequest{
Arguments: arguments,
ID: id,
}
data, err := parser.Encode(&message)
if err != nil {
return fmt.Errorf("can't encode command: %s", err)
}
_, err = c.client.Write(data)
if err != nil {
return fmt.Errorf("can't write command: %s", err)
}
_, err = c.client.Write([]byte("\n"))
if err != nil {
return fmt.Errorf("can't terminate command: %s", err)
}
return err
}
type commandRequest struct {
Arguments []interface{} `json:"command"`
ID int64 `json:"request_id"`
}
type commandResult struct {
Status string `json:"error"`
Data interface{} `json:"data"`
ID int64 `json:"request_id"`
}
func (c *Connection) checkResult(data []byte) {
result := &commandResult{}
err := parser.Decode(data, &result)
if err != nil {
return // skip malformed data
}
if result.Status == "" {
return // not a result
}
c.lock.Lock()
request, ok := c.waitingRequests[result.ID]
c.lock.Unlock()
if ok {
request <- result
}
}
func (c *Connection) checkEvent(data []byte) {
event := &Event{}
err := parser.Decode(data, &event)
if err != nil {
return // skip malformed data
}
if event.Name == "" {
return // not an event
}
c.eventHub.broadcast <- event
}
func (c *Connection) listen() {
defer c.Close()
reader := bufio.NewReader(c.client)
for {
data, err := reader.ReadBytes('\n')
if err != nil {
return
}
c.checkEvent(data)
c.checkResult(data)
}
}
|