Usando soquetes Unix em um protoloco IPC baseado em JSON para controlar "remotamente" o mpv

14 de abril de 2020

#mpv

#controle

#lua

#shell

popular recurso de execução de mídia, o MPV, fornece uma infinidade de recursos pouco conhecidos e explorados tanto nas inúmeras possibilidades de parametrização do funcionamento, como no recurso de extensividade através de scripts escritos em Lua (linguagem de programação criada no Brasil).

Aqui apresentamos um recurso ligeiramente esotérico que objetiva dar um pouco mais de poder aos amantes dos atalhos de teclado, barras baseadas em shell script e relacionados, a possibilidade de usar comandos do shell para enviar comandos ao MPV.

A versão do mpv utilizada para elaboração deste artigo é 0.32.0-3, distribuição Arch Linux.

Introdução

O mpv fornece uma parâmetro em sua linha de comando que permite disponibilizar um soquete Unix por instância em execução do mpv, o --input-ipc-server. Naturalmanete será necessário usar de uma ferramenta que consiga usar o soquete, e para este artigo será utilizado o socat.

Este canal não fornece recursos de segurança, permite execução arbitrária de código, sendo interessante somente para controlar localmente as instâncias do mpv. Um executor de música simples que fornece recursos mais interessantes para controle remoto é o mpd, que é um outro projeto, matéria mais interessante de se tratar em outros (porque o mpd fornece bastantes recursos) artigos.

Todo o conteúdo da comunicação através do soquete usa o formato JSON, tanto nas entradas como nas saídas.

Uso básico, adaptado da documentação oficial

O mpv pode ser invocado da seguinte maneira:

$ mpv video.mp4 --input-ipc-server=/tmp/mpvsocket

Será aberto o programa, e será disponibilizado um soquete em /tmp/mpvsocket.

Para usar o soquete:

$ socat - /tmp/mpvsocket <<< '{ "command": ["get_property", "playback-time"] }'
{"data":190.482000,"error":"success"}

Para melhores informações, vide documentação.

Aplicação com shell script

Tomaremos o cenário do bloqueio de tela. Antes de usar um recurso qualquer para bloquear a tela (i3lock, slock, light-locker etc), deseja-se que qualquer execução de mídia seja parada, de modo que não continue enquanto o operador da máquina vai fazer uma refeição ou fala com alguém, e depois possa ser retomada de onde parou.

A criação de soquetes

Prevendo que podem haver várias instâncias do mpv abertas, por qualquer motivo, é necessário que o caminho de cada soquete criado seja único. Havendo um soquete para cada instância, sendo cada um um arquivo, é necessário lidar com isso também.

A criação de soquetes para cada instãnicia do mpv pode ser feita manualmente, facilitada através de um alias do shell.

Uma outra forma de lidar com a criação dos soquetes por instância é usar a extensibilidade do mpv através de um script em Lua.

Os scripts para a extensibilidade do mpv em Lua, como o que será apresentado na sequência, devem ser depositados em ~/.config/mpv/scripts/. Estes scripts serão executados toda vez que o mpv for executado, e não precisam de permissão de execução.

-- mpv-socket, one socket per instance, removes socket on exit

local utils = require 'mp.utils'

-- Recuperar o diretório que contém os soquetes
tempDir = os.getenv("XDG_RUNTIME_DIR")

-- Função para concatenação de caminho usando a biblioteca fornecida pelo mpv
function join_paths(...)
    local arg={...}
    path = ""
    for i,v in ipairs(arg) do
        path = utils.join_path(path, tostring(v))
    end
    return path
end

-- Recuperar o PID da instância do mpv
ppid = utils.getpid()
-- Criar um diretório para os soquetes, se não existir, com permissões mais restritivas
os.execute("mkdir -pm 700 " .. join_paths(tempDir, "mpv-socket") .. " &>/dev/null")
-- Parametrizar a criação de um soquete com o PID da instância do mpv como nome
mp.set_property("options/input-ipc-server", join_paths(tempDir, "mpv-socket", ppid))

-- Função para remoção do soquete no encerramento da instânicia do mpv
function shutdown_handler()
    os.remove(join_paths(tempDir, "mpv-socket", ppid))
end
mp.register_event("shutdown", shutdown_handler)

Usando os soquetes

Para interromper a execução em todas as instâncias do mpv abertas, e que disponibilizem um soquete em /run/user/$(id -u)/mpv-socket, ou $XDG_RUNTIME_DIR/mpv-socket, pode-se usar o shell script abaixo:

#!/usr/bin/env bash
# Pause all mpv instances though the sockets

# Run through all files in directory
for i in $XDG_RUNTIME_DIR/mpv-socket/* ; do
    # Assert current file is a socket
    [[ ! -S "$i" ]] || {
        socat - $i <<< '{ "command": ["set_property", "pause", true] }' ;
    }
done

Este shell script pode ser acionado em um atalho de teclado qualquer, na sequência para bloquear a tela, ou dentro de um outro shell script que lide com a operação de bloqueio de tela.

Finalização

Os recursos apresentados tem uma dependência: a variável de ambiente XDG_RUNTIME_DIR. Esta variável é disponibilizada sem intervenção em um arquivo profile em sistemas com o SystemD. Mas nada impede de alterar o script Lua e o shell script para que use um outro diretório caso exista uma situação onde usar esse diretório não seja interessante ou possível (em sistemas que usem um outro init).

Leitura complementar

Instrução sobre a linguagem Lua

Instrução sobre Bash e não só

Curso básico de programação em Bash