mirror of
https://github.com/fhem/fhem-mirror.git
synced 2025-02-01 19:30:31 +00:00
1597 lines
51 KiB
Perl
1597 lines
51 KiB
Perl
##############################################
|
|
#
|
|
# A module to control XBMC and receive events from XBMC.
|
|
# Requires XBMC "Frodo" 12.0.
|
|
# To use this module you will have to enable JSON-RPC. See http://wiki.xbmc.org/index.php?title=JSON-RPC_API#Enabling_JSON-RPC
|
|
# Also the Perl module JSON is required.
|
|
#
|
|
# written 2013 by Dennis Bokermann <dbn at gmx.de>
|
|
#
|
|
##############################################
|
|
|
|
|
|
package main;
|
|
|
|
use strict;
|
|
use warnings;
|
|
use POSIX;
|
|
use JSON;
|
|
use Data::Dumper;
|
|
use DevIo;
|
|
use IO::Socket::INET;
|
|
use MIME::Base64;
|
|
|
|
sub XBMC_Initialize($$)
|
|
{
|
|
my ($hash) = @_;
|
|
$hash->{DefFn} = "XBMC_Define";
|
|
$hash->{SetFn} = "XBMC_Set";
|
|
$hash->{ReadFn} = "XBMC_Read";
|
|
$hash->{ReadyFn} = "XBMC_Ready";
|
|
$hash->{UndefFn} = "XBMC_Undefine";
|
|
$hash->{AttrList} = "fork:enable,disable compatibilityMode:xbmc,plex offMode:quit,hibernate,shutdown,standby updateInterval " . $readingFnAttributes;
|
|
|
|
$data{RC_makenotify}{XBMC} = "XBMC_RCmakenotify";
|
|
$data{RC_layout}{XBMC_RClayout} = "XBMC_RClayout";
|
|
}
|
|
|
|
sub XBMC_Define($$)
|
|
{
|
|
my ($hash, $def) = @_;
|
|
DevIo_CloseDev($hash);
|
|
my @args = split("[ \t]+", $def);
|
|
if (int(@args) < 3) {
|
|
return "Invalid number of arguments: define <name> XBMC <ip[:port]> <http|tcp> [<username>] [<password>]";
|
|
}
|
|
my ($name, $type, $addr, $protocol, $username, $password) = @args;
|
|
$hash->{Protocol} = $protocol;
|
|
$addr =~ /^(.*?)(:([0-9]+))?$/;
|
|
$hash->{Host} = $1;
|
|
if(defined($3)) {
|
|
$hash->{Port} = $3;
|
|
}
|
|
elsif($protocol eq 'tcp') {
|
|
$hash->{Port} = 9090; #Default TCP Port
|
|
}
|
|
else {
|
|
$hash->{Port} = 80;
|
|
}
|
|
$hash->{STATE} = 'Initialized';
|
|
if($protocol eq 'tcp') {
|
|
$hash->{DeviceName} = $hash->{Host} . ":" . $hash->{Port};
|
|
my $dev = $hash->{DeviceName};
|
|
$readyfnlist{"$name.$dev"} = $hash;
|
|
}
|
|
elsif(defined($username) && defined($password)) {
|
|
$hash->{Username} = $username;
|
|
$hash->{Password} = $password;
|
|
}
|
|
else {
|
|
return "Username and/or password missing.";
|
|
}
|
|
|
|
$attr{$hash->{NAME}}{"updateInterval"} = 60;
|
|
|
|
return undef;
|
|
}
|
|
|
|
# Force a connection attempt to XBMC as soon as possible
|
|
# (e.g. you know you just started it and want to connect immediately without waiting up to 60 s)
|
|
sub XBMC_Connect($)
|
|
{
|
|
my ($hash) = @_;
|
|
my $name = $hash->{NAME};
|
|
|
|
if($hash->{Protocol} ne 'tcp') {
|
|
# we dont have a persistent connection anyway
|
|
return undef;
|
|
}
|
|
|
|
if(AttrVal($hash->{NAME},'fork','disable') eq 'enable') {
|
|
return undef unless $hash->{CHILDPID}; # nothing to do
|
|
# well, the fork process does not respond to SIGTERM
|
|
# so lets use SIGKILL to make things clear to it
|
|
if ((kill SIGKILL, $hash->{CHILDPID}) != 1) {
|
|
Log3 3, $name, "XBMC_Connect: ERROR: Unable to kill fork process!";
|
|
return undef;
|
|
}
|
|
$hash->{CHILDPID} = undef; # undefg childpid so the Ready-func will fork again
|
|
} else {
|
|
$hash->{NEXT_OPEN} = 0; # force NEXT_OPEN used in DevIO
|
|
}
|
|
|
|
return undef;
|
|
}
|
|
|
|
sub XBMC_Ready($)
|
|
{
|
|
my ($hash) = @_;
|
|
if($hash->{Protocol} eq 'tcp') {
|
|
if(AttrVal($hash->{NAME},'fork','disable') eq 'enable') {
|
|
if($hash->{CHILDPID} && !(kill 0, $hash->{CHILDPID})) {
|
|
$hash->{CHILDPID} = undef;
|
|
return DevIo_OpenDev($hash, 1, "XBMC_Init");
|
|
}
|
|
elsif(!$hash->{CHILDPID}) {
|
|
return if($hash->{CHILDPID} = fork);
|
|
my $ppid = getppid();
|
|
|
|
### Copied from Blocking.pm
|
|
foreach my $d (sort keys %defs) { # Close all kind of FD
|
|
my $h = $defs{$d};
|
|
#the following line was added by vbs to not close parent's DbLog DB handle
|
|
$h->{DBH}->{InactiveDestroy} = 1 if ($h->{TYPE} eq 'DbLog');
|
|
TcpServer_Close($h) if($h->{SERVERSOCKET});
|
|
if($h->{DeviceName}) {
|
|
require "$attr{global}{modpath}/FHEM/DevIo.pm";
|
|
DevIo_CloseDev($h,1);
|
|
}
|
|
}
|
|
### End of copied from Blocking.pm
|
|
|
|
while(kill 0, $ppid) {
|
|
DevIo_OpenDev($hash, 1, "XBMC_ChildExit");
|
|
sleep(5);
|
|
}
|
|
exit(0);
|
|
}
|
|
} else {
|
|
return DevIo_OpenDev($hash, 1, "XBMC_Init");
|
|
}
|
|
}
|
|
return undef;
|
|
}
|
|
|
|
sub XBMC_ChildExit($)
|
|
{
|
|
exit(0);
|
|
}
|
|
|
|
sub XBMC_Undefine($$)
|
|
{
|
|
my ($hash,$arg) = @_;
|
|
|
|
RemoveInternalTimer($hash);
|
|
|
|
if($hash->{Protocol} eq 'tcp') {
|
|
DevIo_CloseDev($hash);
|
|
}
|
|
return undef;
|
|
}
|
|
|
|
sub XBMC_Init($)
|
|
{
|
|
my ($hash) = @_;
|
|
|
|
XBMC_ResetPlayerReadings($hash);
|
|
|
|
#since we just successfully connected to XBMC I guess its safe to assume the device is awake
|
|
readingsSingleUpdate($hash,"system","wake",1);
|
|
$hash->{LAST_RECV} = time();
|
|
|
|
XBMC_Update($hash);
|
|
|
|
XBMC_QueueIntervalUpdate($hash);
|
|
|
|
return undef;
|
|
}
|
|
|
|
sub XBMC_QueueIntervalUpdate($;$) {
|
|
my ($hash, $time) = @_;
|
|
# AFAIK when using http this module is not using a persistent TCP connection
|
|
|
|
return if(($hash->{Protocol} eq 'http') || ($hash->{STATE} eq "disconnected"));
|
|
|
|
if (!defined($time)) {
|
|
$time = AttrVal($hash->{NAME},'updateInterval',60);
|
|
}
|
|
InternalTimer(time() + $time, "XBMC_Check", $hash, 0);
|
|
}
|
|
|
|
sub XBMC_Check($) {
|
|
my ($hash) = @_;
|
|
my $name = $hash->{NAME};
|
|
|
|
Log3 $name, 4, "XBMC_Check";
|
|
|
|
return if(!XBMC_CheckConnection($hash));
|
|
|
|
XBMC_Update($hash);
|
|
|
|
#xbmc seems alive if we get here. so keep bugging it
|
|
XBMC_QueueIntervalUpdate($hash);
|
|
}
|
|
|
|
sub XBMC_UpdatePlayerItem($) {
|
|
my ($hash) = @_;
|
|
my $name = $hash->{NAME};
|
|
|
|
Log3 $name, 4, "XBMC_UpdatePlayerItem";
|
|
if (($hash->{STATE} eq 'disconnected') or (ReadingsVal($name, "playStatus","") ne 'playing')) {
|
|
Log3 $name, 4, "XBMC_UpdatePlayerItem - cancelled (disconnected or not playing)";
|
|
return;
|
|
}
|
|
|
|
XBMC_PlayerGetItem($hash, -1);
|
|
}
|
|
|
|
sub XBMC_CheckConnection($) {
|
|
my ($hash) = @_;
|
|
my $name = $hash->{NAME};
|
|
|
|
if ($hash->{STATE} eq "disconnected") {
|
|
# we are already disconnected
|
|
return 0;
|
|
}
|
|
|
|
my $lastRecvDiff = (time() - $hash->{LAST_RECV});
|
|
my $updateInt = AttrVal($hash->{NAME},'updateInterval',60);
|
|
|
|
# give it 50% tolerance. sticking hard to updateInt might fail if the fhem timer gets delayed for some seconds
|
|
if ($lastRecvDiff > ($updateInt * 1.5)) {
|
|
Log3 $name, 3, "XBMC_CheckConnection: Connection lost! Last data from Kodi received $lastRecvDiff s ago";
|
|
DevIo_Disconnected($hash);
|
|
return 0;
|
|
}
|
|
Log3 $name, 4, "XBMC_CheckConnection: Connection still alive. Last data from Kodi received $lastRecvDiff s ago";
|
|
|
|
return 1;
|
|
}
|
|
|
|
sub XBMC_Update($)
|
|
{
|
|
my ($hash) = @_;
|
|
my $obj;
|
|
$obj = {
|
|
"method" => "Application.GetProperties",
|
|
"params" => {
|
|
"properties" => ["volume","muted","name","version"]
|
|
}
|
|
};
|
|
XBMC_Call($hash,$obj,1);
|
|
|
|
$obj = {
|
|
"method" => "GUI.GetProperties",
|
|
"params" => {
|
|
"properties" => ["skin","fullscreen"]
|
|
}
|
|
};
|
|
XBMC_Call($hash,$obj,1);
|
|
|
|
#-1 -> update all existing players
|
|
XBMC_PlayerUpdate($hash,-1);
|
|
|
|
XBMC_UpdatePlayerItem($hash);
|
|
}
|
|
|
|
sub XBMC_PlayerUpdate($$)
|
|
{
|
|
my $hash = shift;
|
|
my $playerid = shift;
|
|
my $obj = {
|
|
"method" => "Player.GetProperties",
|
|
"params" => {
|
|
"properties" => ["time","totaltime", "repeat", "shuffled", "speed" ]
|
|
#"canseek", "canchangespeed", "canmove", "canzoom", "canrotate", "canshuffle", "canrepeat"
|
|
}
|
|
};
|
|
push(@{$obj->{params}->{properties}}, 'partymode') if(AttrVal($hash->{NAME},'compatibilityMode','xbmc') eq 'xbmc');
|
|
if($playerid >= 0) {
|
|
$obj->{params}->{playerid} = $playerid;
|
|
XBMC_Call($hash,$obj,1);
|
|
}
|
|
else {
|
|
XBMC_PlayerCommand($hash,$obj,0);
|
|
}
|
|
}
|
|
|
|
sub XBMC_PlayerGetItem($$)
|
|
{
|
|
my $hash = shift;
|
|
my $playerid = shift;
|
|
my $obj = {
|
|
"method" => "Player.GetItem",
|
|
"params" => {
|
|
"properties" => ["artist", "album", "thumbnail", "file", "title",
|
|
"track", "year", "streamdetails"]
|
|
}
|
|
};
|
|
if($playerid >= 0) {
|
|
$obj->{params}->{playerid} = $playerid;
|
|
XBMC_Call($hash,$obj,1);
|
|
}
|
|
else {
|
|
XBMC_PlayerCommand($hash,$obj,0);
|
|
}
|
|
}
|
|
|
|
sub XBMC_Read($)
|
|
{
|
|
my ($hash) = @_;
|
|
my $buffer = DevIo_SimpleRead($hash);
|
|
return if (not defined($buffer));
|
|
return XBMC_ProcessRead($hash, $buffer);
|
|
}
|
|
|
|
sub XBMC_ProcessRead($$)
|
|
{
|
|
my ($hash, $data) = @_;
|
|
my $name = $hash->{NAME};
|
|
my $buffer = '';
|
|
Log3($name, 5, "XBMC_ProcessRead");
|
|
|
|
#include previous partial message
|
|
if(defined($hash->{PARTIAL}) && $hash->{PARTIAL}) {
|
|
Log3($name, 5, "XBMC_Read: PARTIAL: " . $hash->{PARTIAL});
|
|
$buffer = $hash->{PARTIAL};
|
|
}
|
|
else {
|
|
Log3($name, 5, "No PARTIAL buffer");
|
|
}
|
|
|
|
Log3($name, 5, "XBMC_Read: Incoming data: " . $data);
|
|
|
|
$buffer = $buffer . $data;
|
|
Log3($name, 5, "XBMC_Read: Current processing buffer (PARTIAL + incoming data): " . $buffer);
|
|
|
|
my ($msg,$tail) = XBMC_ParseMsg($hash, $buffer);
|
|
#processes all complete messages
|
|
while($msg) {
|
|
$hash->{LAST_RECV} = time();
|
|
Log3($name, 4, "XBMC_Read: Decoding JSON message. Length: " . length($msg) . " Content: " . $msg);
|
|
my $obj = JSON->new->utf8(0)->decode($msg);
|
|
#it is a notification if a method name is present
|
|
if(defined($obj->{method})) {
|
|
XBMC_ProcessNotification($hash,$obj);
|
|
}
|
|
elsif(defined($obj->{error})) {
|
|
Log3($name, 3, "XBMC_Read: Received error message: " . $msg);
|
|
}
|
|
#otherwise it is a answer of a request
|
|
else {
|
|
XBMC_ProcessResponse($hash,$obj);
|
|
}
|
|
($msg,$tail) = XBMC_ParseMsg($hash, $tail);
|
|
}
|
|
$hash->{PARTIAL} = $tail;
|
|
Log3($name, 5, "XBMC_Read: Tail: " . $tail);
|
|
Log3($name, 5, "XBMC_Read: PARTIAL: " . $hash->{PARTIAL});
|
|
return;
|
|
}
|
|
|
|
sub XBMC_ResetMediaReadings($)
|
|
{
|
|
my ($hash) = @_;
|
|
readingsBeginUpdate($hash);
|
|
readingsBulkUpdate($hash, "currentMedia", "" );
|
|
readingsBulkUpdate($hash, "currentOriginaltitle", "" );
|
|
readingsBulkUpdate($hash, "currentShowtitle", "" );
|
|
readingsBulkUpdate($hash, "currentTitle", "" );
|
|
readingsBulkUpdate($hash, "episode", "" );
|
|
readingsBulkUpdate($hash, "episodeid", "" );
|
|
readingsBulkUpdate($hash, "season", "" );
|
|
readingsBulkUpdate($hash, "label", "" );
|
|
readingsBulkUpdate($hash, "movieid", "" );
|
|
readingsBulkUpdate($hash, "playlist", "" );
|
|
readingsBulkUpdate($hash, "type", "" );
|
|
readingsBulkUpdate($hash, "year", "" );
|
|
readingsBulkUpdate($hash, "3dfile", "" );
|
|
|
|
readingsBulkUpdate($hash, "currentAlbum", "" );
|
|
readingsBulkUpdate($hash, "currentArtist", "" );
|
|
readingsBulkUpdate($hash, "songid", "" );
|
|
readingsBulkUpdate($hash, "currentTrack", "" );
|
|
|
|
readingsEndUpdate($hash, 1);
|
|
|
|
# delete streamdetails readings
|
|
# NOTE: we actually delete the readings (unlike the other readings)
|
|
# because they are stream count dependent
|
|
fhem("deletereading $hash->{NAME} sd_.*");
|
|
}
|
|
|
|
sub XBMC_ResetPlayerReadings($)
|
|
{
|
|
my ($hash) = @_;
|
|
readingsBeginUpdate($hash);
|
|
readingsBulkUpdate($hash, "time", "" );
|
|
readingsBulkUpdate($hash, "totaltime", "" );
|
|
readingsBulkUpdate($hash, "shuffle", "" );
|
|
readingsBulkUpdate($hash, "repeat", "" );
|
|
readingsBulkUpdate($hash, "speed", "" );
|
|
readingsBulkUpdate($hash, "partymode", "" );
|
|
|
|
readingsBulkUpdate($hash, "playStatus", "stopped" );
|
|
readingsEndUpdate($hash, 1);
|
|
}
|
|
|
|
sub XBMC_PlayerOnPlay($$)
|
|
{
|
|
my ($hash,$obj) = @_;
|
|
my $name = $hash->{NAME};
|
|
my $id = XBMC_CreateId();
|
|
my $type = $obj->{params}->{data}->{item}->{type};
|
|
if(AttrVal($hash->{NAME},'compatibilityMode','xbmc') eq 'plex' || !defined($obj->{params}->{data}->{item}->{id}) || $type eq "picture" || $type eq "unknown") {
|
|
# we either got unknown or picture OR an item not in the library (id not existing)
|
|
readingsBeginUpdate($hash);
|
|
readingsBulkUpdate($hash,'playStatus','playing');
|
|
readingsBulkUpdate($hash,'type',$type);
|
|
if(defined($obj->{params}->{data}->{item})) {
|
|
foreach my $key (keys %{$obj->{params}->{data}->{item}}) {
|
|
my $value = $obj->{params}->{data}->{item}->{$key};
|
|
XBMC_CreateReading($hash,$key,$value);
|
|
}
|
|
}
|
|
readingsEndUpdate($hash, 1);
|
|
|
|
XBMC_PlayerGetItem($hash, -1);
|
|
}
|
|
elsif($type eq "song") {
|
|
#
|
|
my $req = {
|
|
"method" => "AudioLibrary.GetSongDetails",
|
|
"params" => {
|
|
"songid" => $obj->{params}->{data}->{item}->{id},
|
|
"properties" => ["artist","album","title","track","file"]
|
|
},
|
|
"id" => $id
|
|
};
|
|
my $event = {
|
|
"name" => $obj->{method},
|
|
"type" => "song",
|
|
"event" => 'Player.OnPlay'
|
|
};
|
|
$hash->{PendingEvents}{$id} = $event;
|
|
XBMC_Call($hash, $req,1);
|
|
}
|
|
elsif($type eq "episode") {
|
|
my $req = {
|
|
"method" => "VideoLibrary.GetEpisodeDetails",
|
|
"params" => {
|
|
"episodeid" => $obj->{params}->{data}->{item}->{id},
|
|
#http://wiki.xbmc.org/index.php?title=JSON-RPC_API/v6#Video.Fields.Episode
|
|
"properties" => ["season","episode","title","showtitle","file"]
|
|
},
|
|
"id" => $id
|
|
};
|
|
my $event = {
|
|
"name" => $obj->{method},
|
|
"type" => "episode",
|
|
"event" => 'Player.OnPlay'
|
|
};
|
|
$hash->{PendingEvents}{$id} = $event;
|
|
XBMC_Call($hash, $req,1);
|
|
}
|
|
elsif($type eq "movie") {
|
|
my $req = {
|
|
"method" => "VideoLibrary.GetMovieDetails",
|
|
"params" => {
|
|
"movieid" => $obj->{params}->{data}->{item}->{id},
|
|
#http://wiki.xbmc.org/index.php?title=JSON-RPC_API/v6#Video.Fields.Movie
|
|
"properties" => ["title","file","year","originaltitle","streamdetails"]
|
|
},
|
|
"id" => $id
|
|
};
|
|
my $event = {
|
|
"name" => $obj->{method},
|
|
"type" => "movie",
|
|
"event" => 'Player.OnPlay'
|
|
};
|
|
$hash->{PendingEvents}{$id} = $event;
|
|
XBMC_Call($hash, $req,1);
|
|
}
|
|
elsif($type eq "musicvideo") {
|
|
my $req = {
|
|
"method" => "VideoLibrary.GetMusicVideoDetails",
|
|
"params" => {
|
|
"musicvideoid" => $obj->{params}->{data}->{item}->{id},
|
|
#http://wiki.xbmc.org/index.php?title=JSON-RPC_API/v6#Video.Fields.MusicVideo
|
|
"properties" => ["title","artist","album","file"]
|
|
},
|
|
"id" => $id
|
|
};
|
|
my $event = {
|
|
"name" => $obj->{method},
|
|
"type" => "musicvideo",
|
|
"event" => 'Player.OnPlay'
|
|
};
|
|
$hash->{PendingEvents}{$id} = $event;
|
|
XBMC_Call($hash, $req,1);
|
|
}
|
|
|
|
# the playerId in the message is not reliable
|
|
# xbmc is not able to assign the correct player so the playerid might be wrong
|
|
# http://forum.kodi.tv/showthread.php?tid=174872
|
|
# so we ask for the acutally running players by passing -1
|
|
XBMC_PlayerUpdate($hash, -1);
|
|
}
|
|
|
|
sub XBMC_ProcessNotification($$)
|
|
{
|
|
my ($hash,$obj) = @_;
|
|
my $name = $hash->{NAME};
|
|
#React on volume change - http://wiki.xbmc.org/index.php?title=JSON-RPC_API/v6#Application.OnVolumeChanged
|
|
if($obj->{method} eq "Application.OnVolumeChanged") {
|
|
readingsBeginUpdate($hash);
|
|
readingsBulkUpdate($hash,'volume',sprintf("%.2f", $obj->{params}->{data}->{volume}));
|
|
readingsBulkUpdate($hash,'mute',($obj->{params}->{data}->{muted} ? 'on' : 'off'));
|
|
readingsEndUpdate($hash, 1);
|
|
}
|
|
#React on play, pause and stop
|
|
#http://wiki.xbmc.org/index.php?title=JSON-RPC_API/v6#Player.OnPlay
|
|
#http://wiki.xbmc.org/index.php?title=JSON-RPC_API/v6#Player.OnPause
|
|
#http://wiki.xbmc.org/index.php?title=JSON-RPC_API/v6#Player.OnStop
|
|
elsif($obj->{method} eq "Player.OnPropertyChanged") {
|
|
XBMC_PlayerUpdate($hash,$obj->{params}->{data}->{player}->{playerid});
|
|
}
|
|
elsif($obj->{method} =~ /(Player\.OnSeek|Player\.OnSpeedChanged|Player\.OnPropertyChanged)/) {
|
|
my $base = $obj->{params}->{data}->{player};
|
|
readingsBeginUpdate($hash);
|
|
foreach my $key (keys %$base) {
|
|
my $item = $base->{$key};
|
|
XBMC_CreateReading($hash,$key,$item);
|
|
}
|
|
readingsEndUpdate($hash, 1);
|
|
}
|
|
elsif($obj->{method} eq "Player.OnStop") {
|
|
readingsSingleUpdate($hash,"playStatus",'stopped',1);
|
|
}
|
|
elsif($obj->{method} eq "Player.OnPause") {
|
|
readingsSingleUpdate($hash,"playStatus",'paused',1);
|
|
}
|
|
elsif($obj->{method} eq "Player.OnPlay") {
|
|
XBMC_ResetMediaReadings($hash);
|
|
XBMC_PlayerOnPlay($hash, $obj);
|
|
}
|
|
elsif($obj->{method} =~ /(Playlist|AudioLibrary|VideoLibrary|System).On(.*)/) {
|
|
readingsSingleUpdate($hash,lc($1),lc($2),1);
|
|
|
|
if (lc($1) eq "system") {
|
|
if ((lc($2) eq "quit") or (lc($2) eq "restart") or (lc($2) eq "sleep")) {
|
|
readingsSingleUpdate($hash, "playStatus", "stopped", 1);
|
|
}
|
|
|
|
if (lc($2) eq "sleep") {
|
|
Log3($name, 3, "XBMC notified that it is going to sleep");
|
|
#if we immediatlely close our DevIO then fhem will instantly try to reconnect which might
|
|
#succeed because XBMC needs a moment to actually shutdown.
|
|
#So cancel the current timer, fake that the last data has arrived ages ago
|
|
#and force a connection check in some seconds when we think XBMC actually has shut down
|
|
$hash->{LAST_RECV} = 0;
|
|
RemoveInternalTimer($hash);
|
|
XBMC_QueueIntervalUpdate($hash, 5);
|
|
}
|
|
}
|
|
}
|
|
return undef;
|
|
}
|
|
|
|
sub XBMC_ProcessResponse($$)
|
|
{
|
|
my ($hash,$obj) = @_;
|
|
my $id = $obj->{id};
|
|
#check if the id of the answer matches the id of a pending event
|
|
if(defined($hash->{PendingEvents}{$id})) {
|
|
my $event = $hash->{PendingEvents}{$id};
|
|
my $name = $event->{name};
|
|
my $type = $event->{type};
|
|
my $value = '';
|
|
my $base = '';
|
|
$base = $obj->{result}->{songdetails} if($type eq 'song');
|
|
$base = $obj->{result}->{episodedetails} if($type eq 'episode');
|
|
$base = $obj->{result}->{moviedetails} if($type eq 'movie');
|
|
$base = $obj->{result}->{musicvideodetails} if($type eq 'musicvideo');
|
|
if($base) {
|
|
readingsBeginUpdate($hash);
|
|
readingsBulkUpdate($hash,'playStatus','playing') if($event->{event} eq 'Player.OnPlay');
|
|
readingsBulkUpdate($hash,'type',$type);
|
|
foreach my $key (keys %$base) {
|
|
my $item = $base->{$key};
|
|
XBMC_CreateReading($hash,$key,$item);
|
|
}
|
|
readingsEndUpdate($hash, 1);
|
|
}
|
|
$hash->{PendingEvents}{$id} = undef;
|
|
}
|
|
elsif(defined($hash->{PendingPlayerCMDs}{$id})) {
|
|
my $cmd = $hash->{PendingPlayerCMDs}{$id};
|
|
my $players = $obj->{result};
|
|
foreach my $player (@$players) {
|
|
$cmd->{id} = XBMC_CreateId();
|
|
$cmd->{params}->{playerid} = $player->{playerid};
|
|
XBMC_Call($hash,$cmd,1);
|
|
}
|
|
$hash->{PendingPlayerCMDs}{$id} = undef;
|
|
}
|
|
else {
|
|
my $result = $obj->{result};
|
|
if($result && $result ne 'OK') {
|
|
readingsBeginUpdate($hash);
|
|
foreach my $key (keys %$result) {
|
|
if ($key eq 'item') {
|
|
my $item = $obj->{result}->{item};
|
|
foreach my $ikey (keys %$item) {
|
|
my $value = $item->{$ikey};
|
|
XBMC_CreateReading($hash,$ikey,$value);
|
|
}
|
|
}
|
|
else {
|
|
my $value = $result->{$key};
|
|
XBMC_CreateReading($hash,$key,$value);
|
|
}
|
|
}
|
|
readingsEndUpdate($hash, 1);
|
|
}
|
|
}
|
|
return undef;
|
|
}
|
|
|
|
sub XBMC_Is3DFile($$) {
|
|
my ($hash, $filename) = @_;
|
|
|
|
return ($filename =~ /([-. _]3d[-. _]|.*3dbd.*)/i);
|
|
}
|
|
|
|
sub XBMC_CreateReading($$$);
|
|
sub XBMC_CreateReading($$$) {
|
|
my $hash = shift;
|
|
my $name = $hash->{NAME};
|
|
my $key = shift;
|
|
my $value = shift;
|
|
|
|
return if ($key =~ /(playerid)/);
|
|
|
|
if($key eq 'version') {
|
|
my $version = '';
|
|
$version = $value->{major};
|
|
$version .= '.' . $value->{minor} if(defined($value->{minor}));
|
|
$version .= '-' . $value->{revision} if(defined($value->{revision}));
|
|
$version .= ' ' . $value->{tag} if(defined($value->{tag}));
|
|
$value = $version;
|
|
}
|
|
elsif($key eq 'skin') {
|
|
$value = $value->{name} . '(' . $value->{id} . ')';
|
|
}
|
|
elsif($key =~ /(totaltime|time|seekoffset)/) {
|
|
$value = sprintf('%02d:%02d:%02d.%03d',$value->{hours},$value->{minutes},$value->{seconds},$value->{milliseconds});
|
|
}
|
|
elsif($key eq 'shuffled') {
|
|
$key = 'shuffle';
|
|
$value = ($value ? 'on' : 'off');
|
|
}
|
|
elsif($key eq 'muted') {
|
|
$key = 'mute';
|
|
$value = ($value ? 'on' : 'off');
|
|
}
|
|
elsif($key eq 'speed') {
|
|
readingsBulkUpdate($hash,'playStatus','playing') if $value != 0;
|
|
readingsBulkUpdate($hash,'playStatus','paused') if $value == 0;
|
|
}
|
|
elsif($key =~ /(fullscreen|partymode)/) {
|
|
$value = ($value ? 'on' : 'off');
|
|
}
|
|
elsif($key eq 'file') {
|
|
$key = 'currentMedia';
|
|
|
|
readingsBulkUpdate($hash,'3dfile', XBMC_Is3DFile($hash, $value) ? "on" : "off");
|
|
}
|
|
elsif($key =~ /(album|artist|track|title)/) {
|
|
$value = "" if $value eq -1;
|
|
$key = 'current' . ucfirst($key);
|
|
}
|
|
elsif($key eq 'streamdetails') {
|
|
foreach my $mediakey (keys %{$value}) {
|
|
my $arrRef = $value->{$mediakey};
|
|
for (my $i = 0; $i <= $#$arrRef; $i++) {
|
|
my $propRef = $arrRef->[$i];
|
|
foreach my $propkey (keys %{$propRef}) {
|
|
readingsBulkUpdate($hash, "sd_" . $mediakey . $i . $propkey, $propRef->{$propkey});
|
|
}
|
|
}
|
|
}
|
|
|
|
# we dont want to create a "streamdetails" reading
|
|
$key = undef;
|
|
}
|
|
if(ref($value) eq 'ARRAY') {
|
|
$value = join(',',@$value);
|
|
}
|
|
|
|
if (defined $key) {
|
|
if ($key =~ /(seekoffset)/) {
|
|
# for these readings we do only events - no readings
|
|
DoTrigger($name, "$key: $value");
|
|
}
|
|
else {
|
|
readingsBulkUpdate($hash,$key,$value) ;
|
|
}
|
|
}
|
|
}
|
|
|
|
#Parses a given string and returns ($msg,$tail). If the string contains a complete message
|
|
#(equal number of curly brackets) the return value $msg will contain this message. The
|
|
#remaining string is return in form of the $tail variable.
|
|
sub XBMC_ParseMsg($$)
|
|
{
|
|
my ($hash, $buffer) = @_;
|
|
my $name = $hash->{NAME};
|
|
my $open = 0;
|
|
my $close = 0;
|
|
my $msg = '';
|
|
my $tail = '';
|
|
if($buffer) {
|
|
foreach my $c (split //, $buffer) {
|
|
if($open == $close && $open > 0) {
|
|
$tail .= $c;
|
|
}
|
|
elsif(($open == $close) && ($c ne '{')) {
|
|
Log3($name, 3, "XBMC_ParseMsg: Garbage character before message: " . $c);
|
|
}
|
|
else {
|
|
if($c eq '{') {
|
|
$open++;
|
|
}
|
|
elsif($c eq '}') {
|
|
$close++;
|
|
}
|
|
$msg .= $c;
|
|
}
|
|
}
|
|
if($open != $close) {
|
|
$tail = $msg;
|
|
$msg = '';
|
|
}
|
|
}
|
|
return ($msg,$tail);
|
|
}
|
|
|
|
sub XBMC_Set($@)
|
|
{
|
|
my ($hash, $name, $cmd, @args) = @_;
|
|
if($cmd eq "off") {
|
|
$cmd = AttrVal($hash->{NAME},'offMode','quit');
|
|
}
|
|
if($cmd eq 'statusRequest') {
|
|
return XBMC_Update($hash);
|
|
}
|
|
#RPC referring to the Player - http://wiki.xbmc.org/index.php?title=JSON-RPC_API/v6#Player
|
|
elsif($cmd eq 'playpause') {
|
|
return XBMC_Set_PlayPause($hash,@args);
|
|
}
|
|
elsif($cmd eq 'play') {
|
|
return XBMC_Set_PlayPause($hash,1, @args);
|
|
}
|
|
elsif($cmd eq 'pause') {
|
|
return XBMC_Set_PlayPause($hash,0, @args);
|
|
}
|
|
elsif($cmd eq 'prev') {
|
|
return XBMC_Set_Goto($hash,'previous', @args);
|
|
}
|
|
elsif($cmd eq 'next') {
|
|
return XBMC_Set_Goto($hash,'next', @args);
|
|
}
|
|
elsif($cmd eq 'goto') {
|
|
return XBMC_Set_Goto($hash, $args[0] - 1, $args[1]);
|
|
}
|
|
elsif($cmd eq 'stop') {
|
|
return XBMC_Set_Stop($hash, @args);
|
|
}
|
|
elsif($cmd eq 'opendir') {
|
|
return XBMC_Set_Open($hash, 'dir', @args);
|
|
}
|
|
elsif($cmd eq 'open') {
|
|
return XBMC_Set_Open($hash, 'file', @args);
|
|
}
|
|
elsif($cmd eq 'openmovieid') {
|
|
return XBMC_Set_Open($hash, 'movie', @args);
|
|
}
|
|
elsif($cmd eq 'openepisodeid') {
|
|
return XBMC_Set_Open($hash, 'episode', @args);
|
|
}
|
|
elsif($cmd eq 'addon') {
|
|
return XBMC_Set_Addon($hash, @args);
|
|
}
|
|
elsif($cmd eq 'shuffle') {
|
|
return XBMC_Set_Shuffle($hash, @args);
|
|
}
|
|
elsif($cmd eq 'repeat') {
|
|
return XBMC_Set_Repeat($hash, @args);
|
|
}
|
|
|
|
#RPC referring to the Input http://wiki.xbmc.org/index.php?title=JSON-RPC_API/v6#Input
|
|
elsif($cmd eq 'back') {
|
|
return XBMC_Simple_Call($hash,'Input.Back');
|
|
}
|
|
elsif($cmd eq 'contextmenu') {
|
|
return XBMC_Simple_Call($hash,'Input.ContextMenu');
|
|
}
|
|
elsif($cmd eq 'down') {
|
|
return XBMC_Simple_Call($hash,'Input.Down');
|
|
}
|
|
elsif($cmd eq 'home') {
|
|
return XBMC_Simple_Call($hash,'Input.Home');
|
|
}
|
|
elsif($cmd eq 'info') {
|
|
return XBMC_Simple_Call($hash,'Input.Info');
|
|
}
|
|
elsif($cmd eq 'left') {
|
|
return XBMC_Simple_Call($hash,'Input.Left');
|
|
}
|
|
elsif($cmd eq 'right') {
|
|
return XBMC_Simple_Call($hash,'Input.Right');
|
|
}
|
|
elsif($cmd eq 'select') {
|
|
return XBMC_Simple_Call($hash,'Input.Select');
|
|
}
|
|
elsif($cmd eq 'send') {
|
|
my $text = join(' ', @args);
|
|
return XBMC_Call($hash,{'method' => 'Input.SendText', 'params' => { 'text' => $text}},0);
|
|
}
|
|
elsif($cmd eq 'exec') {
|
|
my $action = $args[0]; #http://wiki.xbmc.org/index.php?title=JSON-RPC_API/v6#Input.Action
|
|
return XBMC_Call($hash,{'method' => 'Input.ExecuteAction', 'params' => { 'action' => $action}},0);
|
|
}
|
|
elsif($cmd eq 'jsonraw') {
|
|
my $action = join("",@args);
|
|
return XBMC_Call_raw($hash,$action,0);
|
|
}
|
|
elsif($cmd eq 'showcodec') {
|
|
return XBMC_Simple_Call($hash,'Input.ShowCodec');
|
|
}
|
|
elsif($cmd eq 'showosd') {
|
|
return XBMC_Simple_Call($hash,'Input.ShowOSD');
|
|
}
|
|
elsif($cmd eq 'up') {
|
|
return XBMC_Simple_Call($hash,'Input.Up');
|
|
}
|
|
|
|
#RPC referring to the GUI - http://wiki.xbmc.org/index.php?title=JSON-RPC_API/v6#GUI
|
|
elsif($cmd eq 'msg') {
|
|
return XBMC_Set_Message($hash,@args);
|
|
}
|
|
|
|
#RPC referring to the Application - http://wiki.xbmc.org/index.php?title=JSON-RPC_API/v6#Application
|
|
elsif($cmd eq 'mute') {
|
|
return XBMC_Set_Mute($hash,@args);
|
|
}
|
|
elsif($cmd eq 'volume') {
|
|
return XBMC_Call($hash,{'method' => 'Application.SetVolume', 'params' => { 'volume' => int($args[0])}},0);
|
|
}
|
|
elsif($cmd eq 'volumeUp') {
|
|
return XBMC_Call($hash,{'method' => 'Input.ExecuteAction', 'params' => { 'action' => 'volumeup'}},0);
|
|
}
|
|
elsif($cmd eq 'volumeDown') {
|
|
return XBMC_Call($hash,{'method' => 'Input.ExecuteAction', 'params' => { 'action' => 'volumedown'}},0);
|
|
}
|
|
elsif($cmd eq 'quit') {
|
|
return XBMC_Simple_Call($hash,'Application.Quit');
|
|
}
|
|
|
|
#RPC referring to the System - http://wiki.xbmc.org/index.php?title=JSON-RPC_API/v6#System
|
|
elsif($cmd eq 'eject') {
|
|
return XBMC_Simple_Call($hash,'System.EjectOpticalDrive');
|
|
}
|
|
elsif($cmd eq 'hibernate') {
|
|
return XBMC_Simple_Call($hash,'System.Hibernate');
|
|
}
|
|
elsif($cmd eq 'reboot') {
|
|
return XBMC_Simple_Call($hash,'System.Reboot');
|
|
}
|
|
elsif($cmd eq 'shutdown') {
|
|
return XBMC_Simple_Call($hash,'System.Shutdown');
|
|
}
|
|
elsif($cmd eq 'suspend') {
|
|
return XBMC_Simple_Call($hash,'System.Suspend');
|
|
}
|
|
|
|
#RPC referring to the VideoLibary - http://wiki.xbmc.org/index.php?title=JSON-RPC_API/v6#VideoLibrary
|
|
elsif($cmd eq 'videolibrary') {
|
|
my $opt = $args[0];
|
|
if($opt eq 'clean') {
|
|
return XBMC_Simple_Call($hash,'VideoLibrary.Clean');
|
|
}
|
|
elsif($opt eq 'scan') {
|
|
return XBMC_Simple_Call($hash,'VideoLibrary.Scan');
|
|
}
|
|
}
|
|
|
|
#RPC referring to the AudioLibary - http://wiki.xbmc.org/index.php?title=JSON-RPC_API/v6#AudioLibrary
|
|
elsif($cmd eq 'audiolibrary') {
|
|
my $opt = $args[0];
|
|
if($opt eq 'clean') {
|
|
return XBMC_Simple_Call($hash,'AudioLibrary.Clean');
|
|
}
|
|
elsif($opt eq 'scan') {
|
|
return XBMC_Simple_Call($hash,'AudioLibrary.Scan');
|
|
}
|
|
}
|
|
elsif($cmd eq 'connect') {
|
|
return XBMC_Connect($hash);
|
|
}
|
|
my $res = "Unknown argument " . $cmd . ", choose one of " .
|
|
"off play:all,audio,video,picture playpause:all,audio,video,picture pause:all,audio,video,picture " .
|
|
"prev:all,audio,video,picture next:all,audio,video,picture goto stop:all,audio,video,picture " .
|
|
"open opendir openmovieid openepisodeid addon shuffle:toggle,on,off repeat:one,all,off volumeUp:noArg volumeDown:noArg " .
|
|
"back:noArg contextmenu:noArg down:noArg home:noArg info:noArg left:noArg " .
|
|
"right:noArg select:noArg send exec:left,right," .
|
|
"up,down,pageup,pagedown,select,highlight,parentdir,parentfolder,back," .
|
|
"previousmenu,info,pause,stop,skipnext,skipprevious,fullscreen,aspectratio," .
|
|
"stepforward,stepback,bigstepforward,bigstepback,osd,showsubtitles," .
|
|
"nextsubtitle,codecinfo,nextpicture,previouspicture,zoomout,zoomin," .
|
|
"playlist,queue,zoomnormal,zoomlevel1,zoomlevel2,zoomlevel3,zoomlevel4," .
|
|
"zoomlevel5,zoomlevel6,zoomlevel7,zoomlevel8,zoomlevel9,nextcalibration," .
|
|
"resetcalibration,analogmove,rotate,rotateccw,close,subtitledelayminus," .
|
|
"subtitledelay,subtitledelayplus,audiodelayminus,audiodelay,audiodelayplus," .
|
|
"subtitleshiftup,subtitleshiftdown,subtitlealign,audionextlanguage," .
|
|
"verticalshiftup,verticalshiftdown,nextresolution,audiotoggledigital," .
|
|
"number0,number1,number2,number3,number4,number5,number6,number7," .
|
|
"number8,number9,osdleft,osdright,osdup,osddown,osdselect,osdvalueplus," .
|
|
"osdvalueminus,smallstepback,fastforward,rewind,play,playpause,delete," .
|
|
"copy,move,mplayerosd,hidesubmenu,screenshot,rename,togglewatched,scanitem," .
|
|
"reloadkeymaps,volumeup,volumedown,mute,backspace,scrollup,scrolldown," .
|
|
"analogfastforward,analogrewind,moveitemup,moveitemdown,contextmenu,shift," .
|
|
"symbols,cursorleft,cursorright,showtime,analogseekforward,analogseekback," .
|
|
"showpreset,presetlist,nextpreset,previouspreset,lockpreset,randompreset," .
|
|
"increasevisrating,decreasevisrating,showvideomenu,enter,increaserating," .
|
|
"decreaserating,togglefullscreen,nextscene,previousscene,nextletter,prevletter," .
|
|
"jumpsms2,jumpsms3,jumpsms4,jumpsms5,jumpsms6,jumpsms7,jumpsms8,jumpsms9,filter," .
|
|
"filterclear,filtersms2,filtersms3,filtersms4,filtersms5,filtersms6,filtersms7," .
|
|
"filtersms8,filtersms9,firstpage,lastpage,guiprofile,red,green,yellow,blue," .
|
|
"increasepar,decreasepar,volampup,volampdown,channelup,channeldown," .
|
|
"previouschannelgroup,nextchannelgroup,leftclick,rightclick,middleclick," .
|
|
"doubleclick,wheelup,wheeldown,mousedrag,mousemove,noop showcodec:noArg showosd:noArg up:noArg " .
|
|
"msg " .
|
|
"mute:toggle,on,off volume:slider,0,1,100 quit:noArg " .
|
|
"eject:noArg hibernate:noArg reboot:noArg shutdown:noArg suspend:noArg " .
|
|
"videolibrary:scan,clean audiolibrary:scan,clean statusRequest jsonraw " .
|
|
"connect:noArg";
|
|
return $res ;
|
|
|
|
}
|
|
|
|
sub XBMC_Simple_Call($$) {
|
|
my ($hash,$method) = @_;
|
|
return XBMC_Call($hash,{'method' => $method},0);
|
|
}
|
|
|
|
sub XBMC_Set_Open($@)
|
|
{
|
|
my $hash = shift;
|
|
my $opt = shift;
|
|
my $params;
|
|
my $path = join(' ', @_);
|
|
$path = $1 if ($path =~ /^['"](.*)['"]$/);
|
|
$path =~ s/\\/\\\\/g;
|
|
if($opt eq 'file') {
|
|
$params = {
|
|
'item' => {
|
|
'file' => $path
|
|
}
|
|
};
|
|
} elsif($opt eq 'dir') {
|
|
$params = {
|
|
'item' => {
|
|
'directory' => $path
|
|
}
|
|
};
|
|
} elsif($opt eq 'movie') {
|
|
$params = {
|
|
'item' => {
|
|
'movieid' => $path +0
|
|
},
|
|
'options' => {
|
|
'resume' => JSON::true
|
|
}
|
|
};
|
|
} elsif($opt eq 'episode') {
|
|
$params = {
|
|
'item' => {
|
|
'episodeid' => $path +0
|
|
},
|
|
'options' => {
|
|
'resume' => JSON::true
|
|
}
|
|
};
|
|
}
|
|
my $obj = {
|
|
'method' => 'Player.Open',
|
|
'params' => $params
|
|
};
|
|
return XBMC_Call($hash,$obj,0);
|
|
}
|
|
|
|
sub XBMC_Set_Addon($@)
|
|
{
|
|
my $hash = shift;
|
|
my $params;
|
|
my $attr = join(" ", @_);
|
|
$attr =~ /(".*?"|'.*?'|[^ ]+)[ \t]+(".*?"|'.*?'|[^ ]+)[ \t]+(".*?"|'.*?'|[^ ]+)$/;
|
|
my $addonid = $1;
|
|
my $paramname = $2;
|
|
my $paramvalue = $3;
|
|
# printf "$1 $2 $3";
|
|
$params = {
|
|
'addonid' => $addonid,
|
|
'params' => {
|
|
$paramname => $paramvalue
|
|
}
|
|
};
|
|
my $obj = {
|
|
'method' => 'Addons.ExecuteAddon',
|
|
'params' => $params
|
|
};
|
|
return XBMC_Call($hash,$obj,0);
|
|
}
|
|
|
|
sub XBMC_Set_Message($@)
|
|
{
|
|
my $hash = shift;
|
|
my $attr = join(" ", @_);
|
|
$attr =~ /(".*?"|'.*?'|[^ ]+)[ \t]+(".*?"|'.*?'|[^ ]+)([ \t]+([0-9]+))?([ \t]+([^ ]*))?$/;
|
|
my $title = $1;
|
|
my $message = $2;
|
|
my $duration = $4;
|
|
my $image = $6;
|
|
if($title =~ /^['"](.*)['"]$/) {
|
|
$title = $1;
|
|
}
|
|
if($message =~ /^['"](.*)['"]$/) {
|
|
$message = $1;
|
|
}
|
|
|
|
my $obj = {
|
|
'method' => 'GUI.ShowNotification',
|
|
'params' => {
|
|
'title' => $title,
|
|
'message' => $message
|
|
}
|
|
};
|
|
if($duration && $duration =~ /[0-9]+/ && int($duration) >= 1500) {
|
|
$obj->{params}->{displaytime} = int($duration);
|
|
}
|
|
if($image) {
|
|
$obj->{params}->{image} = $image;
|
|
}
|
|
return XBMC_Call($hash, $obj,0);
|
|
}
|
|
|
|
sub XBMC_Set_Stop($@)
|
|
{
|
|
my ($hash,$player) = @_;
|
|
my $obj = {
|
|
'method' => 'Player.Stop',
|
|
'params' => {
|
|
'playerid' => 0 #will be replaced with the active player
|
|
}
|
|
};
|
|
return XBMC_PlayerCommand($hash,$obj,$player);
|
|
}
|
|
|
|
sub XBMC_Set_Goto($$$)
|
|
{
|
|
my ($hash,$direction,$player) = @_;
|
|
my $obj = {
|
|
'method' => 'Player.GoTo',
|
|
'params' => {
|
|
'to' => $direction,
|
|
'playerid' => -1 #will be replaced with the active player
|
|
}
|
|
};
|
|
return XBMC_PlayerCommand($hash,$obj,$player);
|
|
}
|
|
|
|
sub XBMC_Set_Shuffle($@)
|
|
{
|
|
my ($hash,@args) = @_;
|
|
my $toggle = 'toggle';
|
|
my $player = '';
|
|
if(int(@args) >= 2) {
|
|
$toggle = $args[0];
|
|
$player = $args[1];
|
|
}
|
|
elsif(int(@args) == 1) {
|
|
if($args[0] =~ /(all|audio|video|picture)/) {
|
|
$player = $args[0];
|
|
}
|
|
else {
|
|
$toggle = $args[0];
|
|
}
|
|
}
|
|
my $type = XBMC_Toggle($toggle);
|
|
|
|
my $obj = {
|
|
'method' => 'Player.SetShuffle',
|
|
'params' => {
|
|
'shuffle' => $type,
|
|
'playerid' => -1 #will be replaced with the active player
|
|
}
|
|
};
|
|
return XBMC_PlayerCommand($hash,$obj,$player);
|
|
}
|
|
|
|
sub XBMC_Set_Repeat($@)
|
|
{
|
|
my ($hash,$opt,@args) = @_;
|
|
$opt = 'off' if($opt !~ /(one|all|off)/);
|
|
my $player = '';
|
|
if(int(@args) == 1 && $args[0] =~ /(all|audio|video|picture)/) {
|
|
$player = $args[0];
|
|
}
|
|
|
|
my $obj = {
|
|
'method' => 'Player.SetRepeat',
|
|
'params' => {
|
|
'repeat' => $opt,
|
|
'playerid' => -1 #will be replaced with the active player
|
|
}
|
|
};
|
|
return XBMC_PlayerCommand($hash,$obj,$player);
|
|
}
|
|
|
|
sub XBMC_Set_PlayPause($@)
|
|
{
|
|
my ($hash,@args) = @_;
|
|
my $toggle = 'toggle';
|
|
my $player = '';
|
|
if(int(@args) >= 2) {
|
|
$toggle = $args[0];
|
|
$player = $args[1];
|
|
}
|
|
elsif(int(@args) == 1) {
|
|
if($args[0] =~ /(all|audio|video|picture)/) {
|
|
$player = $args[0];
|
|
}
|
|
else {
|
|
$toggle = $args[0];
|
|
}
|
|
}
|
|
my $type = XBMC_Toggle($toggle);
|
|
|
|
my $obj = {
|
|
'method' => 'Player.PlayPause',
|
|
'params' => {
|
|
'play' => $type,
|
|
'playerid' => -1 #will be replaced with the active player
|
|
}
|
|
};
|
|
return XBMC_PlayerCommand($hash,$obj,$player);
|
|
}
|
|
|
|
sub XBMC_PlayerCommand($$$)
|
|
{
|
|
my ($hash,$obj,$player) = @_;
|
|
if($player) {
|
|
my $id = -1;
|
|
$id = 0 if($player eq "audio");
|
|
$id = 1 if($player eq "video");
|
|
$id = 2 if($player eq "picture");
|
|
if($id > 0 && $id < 3) {
|
|
$obj->{params}->{playerid} = $id;
|
|
return XBMC_Call($hash, $obj,0);
|
|
}
|
|
}
|
|
|
|
#we need to find out the correct player first
|
|
my $id = XBMC_CreateId();
|
|
$hash->{PendingPlayerCMDs}->{$id} = $obj;
|
|
my $req = {
|
|
'method' => 'Player.GetActivePlayers',
|
|
'id' => $id
|
|
};
|
|
return XBMC_Call($hash,$req,1);
|
|
}
|
|
|
|
#returns 'toggle' if the argument is undef
|
|
#returns JSON::true if the argument is true and not equals "off" otherwise it returns JSON::false
|
|
sub XBMC_Toggle($)
|
|
{
|
|
my ($toggle) = @_;
|
|
if(defined($toggle) && $toggle ne "toggle") {
|
|
if($toggle && $toggle ne "off") {
|
|
return JSON::true;
|
|
}
|
|
else {
|
|
return JSON::false;
|
|
}
|
|
}
|
|
return 'toggle';
|
|
}
|
|
|
|
sub XBMC_Set_Mute($@)
|
|
{
|
|
my ($hash,$toggle) = @_;
|
|
my $type = XBMC_Toggle($toggle);
|
|
my $obj = {
|
|
'method' => 'Application.SetMute',
|
|
'params' => { 'mute' => $type}
|
|
};
|
|
return XBMC_Call($hash, $obj,0);
|
|
}
|
|
|
|
#Executes a JSON RPC
|
|
sub XBMC_Call($$$)
|
|
{
|
|
my ($hash,$obj,$id) = @_;
|
|
my $name = $hash->{NAME};
|
|
#add an ID otherwise XBMC will not respond
|
|
if($id &&!defined($obj->{id})) {
|
|
$obj->{id} = XBMC_CreateId();
|
|
}
|
|
$obj->{jsonrpc} = "2.0"; #JSON RPC version has to be passed
|
|
my $json = JSON->new->utf8(0)->encode($obj);
|
|
Log3($name, 4, "XBMC_Call: Sending: " . $json);
|
|
if($hash->{Protocol} eq 'http') {
|
|
return XBMC_HTTP_Call($hash,$json,$id);
|
|
}
|
|
else {
|
|
return XBMC_TCP_Call($hash,$json);
|
|
}
|
|
}
|
|
|
|
sub XBMC_Call_raw($$$)
|
|
{
|
|
my ($hash,$obj,$id) = @_;
|
|
my $name = $hash->{NAME};
|
|
Log3($name, 5, "XBMC_Call: Sending: " . $obj);
|
|
if($hash->{Protocol} eq 'http') {
|
|
return XBMC_HTTP_Call($hash,$obj,$id);
|
|
}
|
|
else {
|
|
return XBMC_TCP_Call($hash,$obj);
|
|
}
|
|
}
|
|
|
|
sub XBMC_CreateId()
|
|
{
|
|
return int(rand(1000000));
|
|
}
|
|
|
|
sub XBMC_RCmakenotify($$) {
|
|
my ($nam, $ndev) = @_;
|
|
my $nname="notify_$nam";
|
|
|
|
fhem("define $nname notify $nam set $ndev ".'$EVENT',1);
|
|
return "Notify created by XBMC: $nname";
|
|
}
|
|
|
|
sub XBMC_RClayout() {
|
|
my @row;
|
|
my $i = 0;
|
|
$row[$i++] = "showosd:MENU,up:UP,home:HOMEsym,exec volumeup:VOLUP";
|
|
$row[$i++] = "left:LEFT,select:OK,right:RIGHT,mute:MUTE";
|
|
$row[$i++] = "info:INFO,down:DOWN,back:RETURN,exec volumedown:VOLDOWN";
|
|
$row[$i++] = "exec stepback:REWIND,playpause:PLAY,stop:STOP,exec stepforward:FF";
|
|
|
|
$row[$i++] = "attr rc_iconpath icons/remotecontrol";
|
|
$row[$i++] = "attr rc_iconprefix black_btn_";
|
|
return @row;
|
|
}
|
|
|
|
|
|
#JSON RPC over TCP
|
|
sub XBMC_TCP_Call($$)
|
|
{
|
|
my ($hash,$obj) = @_;
|
|
return DevIo_SimpleWrite($hash,$obj,'');
|
|
}
|
|
|
|
#JSON RPC over HTTP
|
|
sub XBMC_HTTP_Call($$$)
|
|
{
|
|
my ($hash,$obj,$id) = @_;
|
|
my $uri = "http://" . $hash->{Host} . ":" . $hash->{Port} . "/jsonrpc";
|
|
my $ret = XBMC_HTTP_Request(0,$uri,undef,$obj,undef,$hash->{Username},$hash->{Password});
|
|
return undef if(!$ret);
|
|
if($ret =~ /^error:(\d{3})$/) {
|
|
return "HTTP Error Code " . $1;
|
|
}
|
|
return XBMC_ProcessResponse($hash,JSON->new->utf8(0)->decode($ret)) if($id);
|
|
return undef;
|
|
}
|
|
|
|
#adapted version of the CustomGetFileFromURL subroutine from HttpUtils.pm
|
|
sub XBMC_HTTP_Request($$@)
|
|
{
|
|
my ($quiet, $url, $timeout, $data, $noshutdown,$username,$password) = @_;
|
|
$timeout = 4.0 if(!defined($timeout));
|
|
|
|
my $displayurl= $quiet ? "<hidden>" : $url;
|
|
if($url !~ /^(http|https):\/\/([^:\/]+)(:\d+)?(\/.*)$/) {
|
|
Log(1, "XBMC_HTTP_Request $displayurl: malformed or unsupported URL");
|
|
return undef;
|
|
}
|
|
|
|
my ($protocol,$host,$port,$path)= ($1,$2,$3,$4);
|
|
|
|
if(defined($port)) {
|
|
$port =~ s/^://;
|
|
} else {
|
|
$port = ($protocol eq "https" ? 443: 80);
|
|
}
|
|
$path= '/' unless defined($path);
|
|
|
|
|
|
my $conn;
|
|
if($protocol eq "https") {
|
|
eval "use IO::Socket::SSL";
|
|
if($@) {
|
|
Log(1, $@);
|
|
} else {
|
|
$conn = IO::Socket::SSL->new(PeerAddr=>"$host:$port", Timeout=>$timeout);
|
|
}
|
|
} else {
|
|
$conn = IO::Socket::INET->new(PeerAddr=>"$host:$port", Timeout=>$timeout);
|
|
}
|
|
if(!$conn) {
|
|
Log(1, "XBMC_HTTP_Request $displayurl: Can't connect to $protocol://$host:$port\n");
|
|
undef $conn;
|
|
return undef;
|
|
}
|
|
|
|
$host =~ s/:.*//;
|
|
my $hdr = ($data ? "POST" : "GET")." $path HTTP/1.0\r\nHost: $host\r\n";
|
|
if($username) {
|
|
$hdr .= "Authorization: Basic ";
|
|
if($password) {
|
|
$hdr .= encode_base64($username . ":" . $password,"\r\n");
|
|
}
|
|
else {
|
|
$hdr .= encode_base64($username,"\r\n");
|
|
}
|
|
}
|
|
if(defined($data)) {
|
|
$hdr .= "Content-Length: ".length($data)."\r\n";
|
|
$hdr .= "Content-Type: application/json";
|
|
}
|
|
$hdr .= "\r\n\r\n";
|
|
syswrite $conn, $hdr;
|
|
syswrite $conn, $data if(defined($data));
|
|
shutdown $conn, 1 if(!$noshutdown);
|
|
|
|
my ($buf, $ret) = ("", "");
|
|
$conn->timeout($timeout);
|
|
for(;;) {
|
|
my ($rout, $rin) = ('', '');
|
|
vec($rin, $conn->fileno(), 1) = 1;
|
|
my $nfound = select($rout=$rin, undef, undef, $timeout);
|
|
if($nfound <= 0) {
|
|
Log(1, "XBMC_HTTP_Request $displayurl: Select timeout/error: $!");
|
|
undef $conn;
|
|
return undef;
|
|
}
|
|
|
|
my $len = sysread($conn,$buf,65536);
|
|
last if(!defined($len) || $len <= 0);
|
|
$ret .= $buf;
|
|
}
|
|
|
|
$ret=~ s/(.*?)\r\n\r\n//s; # Not greedy: switch off the header.
|
|
my @header= split("\r\n", $1);
|
|
my $hostpath= $quiet ? "<hidden>" : $host . $path;
|
|
Log(4, "XBMC_HTTP_Request $displayurl: Got data, length: ".length($ret));
|
|
if(!length($ret)) {
|
|
Log(4, "XBMC_HTTP_Request $displayurl: Zero length data, header follows...");
|
|
for (@header) {
|
|
Log(4, "XBMC_HTTP_Request $displayurl: $_");
|
|
}
|
|
}
|
|
undef $conn;
|
|
if($header[0] =~ /^[^ ]+ ([\d]{3})/ && $1 != 200) {
|
|
return "error:" . $1;
|
|
}
|
|
return $ret;
|
|
}
|
|
|
|
1;
|
|
|
|
=pod
|
|
=begin html
|
|
|
|
<a name="XBMC"></a>
|
|
<h3>XBMC</h3>
|
|
<ul>
|
|
<a name="XBMCdefine"></a>
|
|
<b>Define</b>
|
|
<ul>
|
|
<code>define <name> XBMC <ip[:port]> <http|tcp> [<username>] [<password>]</code>
|
|
<br><br>
|
|
|
|
This module allows you to control XBMC and receive events from XBMC. It can also be used to control Plex (see attribute <i>compatibilityMode</i>).<br><br>
|
|
|
|
<b>Prerequisites</b>
|
|
<ul>
|
|
<li>Requires XBMC "Frodo" 12.0.</li>
|
|
<li>To use this module you will have to enable JSON-RPC. See <a href="http://wiki.xbmc.org/index.php?title=JSON-RPC_API#Enabling_JSON-RPC">here</a>.</li>
|
|
<li>The Perl module JSON is required. <br>
|
|
On Debian/Raspbian: <code>apt-get install libjson-perl </code><br>
|
|
Via CPAN: <code>cpan install JSON</code>
|
|
To get it working on a Fritzbox the JSON module has to be installed manually.</li>
|
|
</ul>
|
|
|
|
To receive events it is necessary to use TCP. The default TCP port is 9090. Username and password are optional for TCP. Be sure to enable JSON-RPC
|
|
for TCP. See <a href="http://wiki.xbmc.org/index.php?title=JSON-RPC_API#Enabling_JSON-RPC>here</a>.<br><br>
|
|
|
|
If you just want to control XBMC you can use the HTTP instead of tcp. The username and password are required for HTTP. Be sure to enable JSON-RPC for HTTP.
|
|
See <a href="http://wiki.xbmc.org/index.php?title=JSON-RPC_API#Enabling_JSON-RPC">here</a>.<br><br>
|
|
|
|
Example:<br><br>
|
|
<ul>
|
|
<code>
|
|
define htpc XBMC 192.168.0.10 tcp
|
|
<br><br>
|
|
define htpc XBMC 192.168.0.10:9000 tcp # With custom port
|
|
<br><br>
|
|
define htpc XBMC 192.168.0.10 http # Use HTTP instead of TCP - Note: to receive events use TCP!
|
|
<br><br>
|
|
define htpc XBMC 192.168.0.10 http xbmc passwd # Use HTTP with credentials - Note: to receive events use TCP!
|
|
</code>
|
|
</ul><br><br>
|
|
|
|
Remote control:<br>
|
|
There is an simple remote control layout for XBMC which contains the most basic buttons. To add the remote control to the webinterface execute the
|
|
following commands:<br><br>
|
|
<ul>
|
|
<code>
|
|
define <rc_name> remotecontrol #adds the remote control
|
|
<br><br>
|
|
set <rc_name> layout XBMC_RClayout #sets the layout for the remote control
|
|
<br><br>
|
|
set <rc_name> makenotify <XBMC_device> #links the buttons to the actions
|
|
</code>
|
|
</ul><br><br>
|
|
|
|
Known issues:<br>
|
|
XBMC sometimes creates events twices. For example the Player.OnPlay event is created twice if play a song. Unfortunately this
|
|
is a issue of XBMC. The fix of this bug is included in future version of XBMC (> 12.2).
|
|
|
|
</ul>
|
|
|
|
<a name="XBMCset"></a>
|
|
<b>Set</b>
|
|
<ul>
|
|
<code>set <name> <command> [<parameter>]</code>
|
|
<br><br>
|
|
This module supports the following commands:<br>
|
|
|
|
Player related commands:<br>
|
|
<ul>
|
|
<li><b>play [<all|audio|video|picture>]</b> - starts the playback (might only work if previously paused). The second argument defines which player should be started. By default the active players will be started</li>
|
|
<li><b>pause [<all|audio|video|picture>]</b> - pauses the playback</li>
|
|
<li><b>playpause [<all|audio|video|picture>]</b> - toggles between play and pause for the given player</li>
|
|
<li><b>stop [<all|audio|video|picture>]</b> - stop the playback</li>
|
|
<li><b>next [<all|audio|video|picture>]</b> - jump to the next track</li>
|
|
<li><b>prev [<all|audio|video|picture>]</b> - jump to the previous track or the beginning of the current track.</li>
|
|
<li><b>goto <position> [<audio|video|picture>]</b> - Goes to the <position> in the playlist. <position> has to be a number.</li>
|
|
<li><b>shuffle [<toggle|on|off>] [<audio|video|picture>]</b> - Enables/Disables shuffle mode. Without furhter parameters the shuffle mode is toggled.</li>
|
|
<li><b>repeat <one|all|off> [<audio|video|picture>]</b> - Sets the repeat mode.</li>
|
|
<li><b>open <URI></b> - Plays the resource located at the URI (can be a url or a file)</li>
|
|
<li><b>opendir <path></b> - Plays the content of the directory</li>
|
|
<li><b>openmovieid <path></b> - Plays the movie of the id</li>
|
|
<li><b>openepisodeid <path></b> - Plays the episode of the id</li>
|
|
<li><b>addon <addonid> <parametername> <parametervalue></b> - Executes addon with one Parameter, for example set xbmc addon script.json-cec command activate</li>
|
|
</ul>
|
|
<br>Input related commands:<br>
|
|
<ul>
|
|
<li><b>back</b> - Back-button</li>
|
|
<li><b>down</b> - Down-button</li>
|
|
<li><b>up</b> - Up-button</li>
|
|
<li><b>left</b> - Left-button</li>
|
|
<li><b>right</b> - Right-button</li>
|
|
<li><b>home</b> - Home-button</li>
|
|
<li><b>select</b> - Select-button</li>
|
|
<li><b>info</b> - Info-button</li>
|
|
<li><b>showosd</b> - Opens the OSD (On Screen Display)</li>
|
|
<li><b>showcodec</b> - Shows Codec information</li>
|
|
<li><b>exec <action></b> - Execute an input action. All available actions are listed <a href="http://wiki.xbmc.org/index.php?title=JSON-RPC_API/v6#Input.Action">here</a></li>
|
|
<li><b>send <text></b> - Sends <text> as input to XBMC</li>
|
|
<li><b>jsonraw</b> - Sends raw JSON data to XBMC</li>
|
|
</ul>
|
|
<br>Libary related commands:<br>
|
|
<ul>
|
|
<li><b>videolibrary clean</b> - Removes non-existing files from the video libary</li>
|
|
<li><b>videolibrary scan</b> - Scan for new video files</li>
|
|
<li><b>audiolibrary clean</b> - Removes non-existing files from the audio libary</li>
|
|
<li><b>audiolibrary scan</b> - Scan for new audio files</li>
|
|
</ul>
|
|
<br>Application related commands:<br>
|
|
<ul>
|
|
<li><b>mute [<0|1>]</b> - 1 for mute; 0 for unmute; by default the mute status will be toggled</li>
|
|
<li><b>volume <n></b> - sets the volume to <n>. <n> must be a number between 0 and 100</li>
|
|
<li><b>volumeDown <n></b> - volume down</li>
|
|
<li><b>volumeUp <n></b> - volume up</li>
|
|
<li><b>quit</b> - closes XBMC</li>
|
|
<li><b>off</b> - depending on the value of the attribute "offMode" XBMC will be closed (see quit) or the system will be shut down, put into hibernation or stand by. Default is quit.</li>
|
|
</ul>
|
|
<br>System related commands:<br>
|
|
<ul>
|
|
<li><b>eject</b> - will eject the optical drive</li>
|
|
<li><b>shutdown</b> - the XBMC host will be shut down</li>
|
|
<li><b>suspend</b> - the XBMC host will be put into stand by</li>
|
|
<li><b>hibernate</b> - the XBMC host will be put into hibernation</li>
|
|
<li><b>reboot</b> - the XBMC host will be rebooted</li>
|
|
<li><b>connect</b> - try to connect to the XBMC host immediately</li>
|
|
</ul>
|
|
</ul>
|
|
<br><br>
|
|
|
|
<u>Messaging</u>
|
|
<ul>
|
|
To show messages on XBMC (little message PopUp at the bottom right egde of the screen) you can use the following commands:<br>
|
|
<code>set <XBMC_device> msg <title> <msg> [<duration>] [<icon>]</code><br>
|
|
The default duration of a message is 5000 (5 seconds). The minimum duration is 1500 (1.5 seconds). By default no icon is shown. XBMC provides three
|
|
different icon: error, info and warning. You can also use an uri to define an icon. Please enclose title and/or message into quotes (" or ') if it consists
|
|
of multiple words.
|
|
</ul>
|
|
|
|
<br>
|
|
<b>Generated Readings/Events:</b><br>
|
|
<ul>
|
|
<li><b>audiolibrary</b> - Possible values: cleanfinished, cleanstarted, remove, scanfinished, scanstarted, update</li>
|
|
<li><b>currentAlbum</b> - album of the current song/musicvideo</li>
|
|
<li><b>currentArtist</b> - artist of the current song/musicvideo</li>
|
|
<li><b>currentMedia</b> - file/URL of the media item being played</li>
|
|
<li><b>currentTitle</b> - title of the current media item</li>
|
|
<li><b>currentTrack</b> - track of the current song/musicvideo</li>
|
|
<li><b>episode</b> - episode number</li>
|
|
<li><b>episodeid</b> - id of the episode in the video library</li>
|
|
<li><b>fullscreen</b> - indicates if XBMC runs in fullscreen mode (on/off)</li>
|
|
<li><b>label</b> - label of the current media item</li>
|
|
<li><b>movieid</b> - id of the movie in the video library</li>
|
|
<li><b>musicvideoid</b> - id of the musicvideo in the video library</li>
|
|
<li><b>mute</b> - indicates if XBMC is muted (on/off)</li>
|
|
<li><b>name</b> - software name (e.g. XBMC)</li>
|
|
<li><b>originaltitle</b> - original title of the movie being played</li>
|
|
<li><b>partymode</b> - indicates if XBMC runs in party mode (on/off) (not available for Plex)</li>
|
|
<li><b>playlist</b> - Possible values: add, clear, remove</li>
|
|
<li><b>playStatus</b> - Indicates the player status: playing, paused, stopped</li>
|
|
<li><b>repeat</b> - current repeat mode (one/all/off)</li>
|
|
<li><b>season</b> - season of the current episode</li>
|
|
<li><b>showtitle</b> - title of the show being played</li>
|
|
<li><b>shuffle</b> - indicates if the playback is shuffled (on/off)</li>
|
|
<li><b>skin</b> - current skin of XBMC</li>
|
|
<li><b>songid</b> - id of the song in the music library</li>
|
|
<li><b>system</b> - Possible values: lowbattery, quit, restart, sleep, wake</li>
|
|
<li><b>time</b> - current position in the playing media item (only updated on play/pause)</li>
|
|
<li><b>totaltime</b> - total run time of the current media item</li>
|
|
<li><b>type</b> - type of the media item. Possible values: episode, movie, song, musicvideo, picture, unknown</li>
|
|
<li><b>version</b> - version of XBMC</li>
|
|
<li><b>videolibrary</b> - Possible values: cleanfinished, cleanstarted, remove, scanfinished, scanstarted, update</li>
|
|
<li><b>volume</b> - value between 0 and 100 stating the current volume setting</li>
|
|
<li><b>year</b> - year of the movie being played</li>
|
|
<li><b>3dfile</b> - is a 3D movie according to filename</li>
|
|
<li><b>sd_<type><n>_<reading></b> - stream details of the current medium. type can be video, audio or subtitle, n is the stream index (a stream can have multiple audio/video streams)</li>
|
|
</ul>
|
|
<br><br>
|
|
<u>Remarks on the events</u><br><br>
|
|
<ul>
|
|
The event <b>playStatus = playing</b> indicates a playback of a media item. Depending on the event <b>type</b> different events are generated:
|
|
<ul>
|
|
<li><b>type = song</b> generated events are: <b>album, artist, file, title</b> and <b>track</b></li>
|
|
<li><b>type = musicvideo</b> generated events are: <b>album, artist, file</b> and <b>title</b></li>
|
|
<li><b>type = episode</b> generated events are: <b>episode, file, season, showtitle,</b> and <b>title</b></li>
|
|
<li><b>type = movie</b> generated events are: <b>originaltitle, file, title,</b> and <b>year</b></li>
|
|
<li><b>type = picture</b> generated events are: <b>file</b></li>
|
|
<li><b>type = unknown</b> generated events are: <b>file</b></li>
|
|
</ul>
|
|
</ul>
|
|
<br><br>
|
|
<a name="XBMCattr"></a>
|
|
<b>Attributes</b>
|
|
<ul>
|
|
<li>compatibilityMode<br>
|
|
This module can also be used to control Plex, since the JSON Api is mostly the same, but there are some differences.
|
|
If you want to control Plex set the attribute <i>compatibilityMode</i> to <i>plex</i>.</li>
|
|
<li>offMode<br>
|
|
Declares what should be down if the off command is executed. Possible values are <i>quit</i> (closes XBMC), <i>hibernate</i> (puts system into hibernation),
|
|
<i>suspend</i> (puts system into stand by), and <i>shutdown</i> (shuts down the system). Default value is <i>quit</i></li>
|
|
<li>fork<br>
|
|
If XBMC does not run all the time it used to be the case that FHEM blocks because it cannot reach XBMC (only happened
|
|
if TCP was used). If you encounter problems like FHEM not responding for a few seconds then you should set <code>attr <XBMC_device> fork enable</code>
|
|
which will move the search for XBMC into a separate process.</li>
|
|
<li>updateInterval<br>
|
|
The interval which is used to check if Kodi is still alive (by sending a JSON ping) and also it is used to update current player item.</li>
|
|
</ul>
|
|
</ul>
|
|
|
|
=end html
|
|
=cut |