1 --[==========================================================================[
2 rc.lua: remote control module for VLC
3 --[==========================================================================[
4 Copyright (C) 2007-2009 the VideoLAN team
7 Authors: Antoine Cellerier <dionoea at videolan dot org>
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 2 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program; if not, write to the Free Software
21 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 --]==========================================================================]
25 [============================================================================[
26 Remote control interface for VLC
28 This is a modules/control/rc.c look alike (with a bunch of new features)
32 Use on tcp connection:
33 vlc -I rc --lua-config "rc={host='localhost:4212'}"
34 Use on multiple hosts (term + 2 tcp ports):
35 vlc -I rc --lua-config "rc={hosts={'*console','localhost:4212','localhost:5678'}}"
38 -I rc and -I luarc are aliases for -I lua --lua-intf rc
40 Configuration options setable throught the --lua-config option are:
41 * hosts: A list of hosts to listen on.
42 * host: A host to listen on. (won't be used if `hosts' is set)
43 * eval: Add eval command to evaluate lua expressions. Set to any value to
45 The following can be set using the --lua-config option or in the interface
46 itself using the `set' command:
48 * welcome: The welcome message.
49 * width: The default terminal width (used to format text).
50 * autocompletion: When issuing an unknown command, print a list of
51 possible commands to autocomplete with. (0 to disable,
53 * autoalias: If autocompletion returns only one possibility, use it
54 (0 to disable, 1 to enable).
55 * flatplaylist: 0 to disable, 1 to enable.
56 ]============================================================================]
60 skip2 = function(foo) return skip(skip(foo)) end
61 setarg = common.setarg
64 --[[ Setup default environement ]]
65 env = { prompt = "> ";
69 welcome = "Remote control interface initialized. Type `help' for help.";
73 --[[ Import custom environement variables from the command line config (if possible) ]]
74 for k,v in pairs(env) do
76 if type(env[k]) == type(config[k]) then
78 vlc.msg.dbg("set environement variable `"..k.."' to "..tostring(env[k]))
80 vlc.msg.err("environement variable `"..k.."' should be of type "..type(env[k])..". config value will be discarded.")
85 --[[ Command functions ]]
86 function set_env(name,client,value)
88 local var,val = split_input(value)
90 s = string.gsub(val,"\"(.*)\"","%1")
91 if type(client.env[var])==type(1) then
92 client.env[var] = tonumber(s)
97 client:append( tostring(client.env[var]) )
100 for e,v in common.pairs_sorted(client.env) do
101 client:append(e.."="..v)
106 function save_env(name,client,value)
107 env = common.table_copy(client.env)
110 function alias(client,value)
112 local var,val = split_input(value)
113 if commands[var] and type(commands[var]) ~= type("") then
114 client:append("Error: cannot use a primary command as an alias name")
116 if commands[val] then
119 client:append("Error: unknown primary command `"..val.."'.")
123 for c,v in common.pairs_sorted(commands) do
124 if type(v)==type("") then
125 client:append(c.."="..v)
131 function fixme(name,client)
132 client:append( "FIXME: unimplemented command `"..name.."'." )
135 function logout(name,client)
136 if client.type == host.client_type.net then
137 client:send("Bye-bye!")
140 client:append("Error: Can't logout of stdin/stdout. Use quit or shutdown to close VLC.")
144 function shutdown(name,client)
145 client:append("Bye-bye!")
146 h:broadcast("Shutting down.")
147 vlc.msg.info("Requested shutdown.")
151 function quit(name,client)
152 if client.type == host.client_type.net then
155 shutdown(name,client)
159 function add(name,client,arg)
160 -- TODO: par single and double quotes properly
162 if name == "enqueue" then
163 f = vlc.playlist.enqueue
168 for o in string.gmatch(arg," +:([^ ]*)") do
169 table.insert(options,o)
171 arg = string.gsub(arg," +:.*$","")
172 f({{path=arg,options=options}})
175 function playlist_is_tree( client )
176 if client.env.flatplaylist == 0 then
183 function playlist(name,client,arg)
184 function playlist0(item,prefix)
185 local prefix = prefix or ""
186 if not item.flags.disabled then
187 local str = "| "..prefix..tostring(item.id).." - "..item.name
188 if item.duration > 0 then
189 str = str.." ("..common.durationtostring(item.duration)..")"
191 if item.nb_played > 0 then
192 str = str.." [played "..tostring(item.nb_played).." time"
193 if item.nb_played > 1 then
200 if item.children then
201 for _, c in ipairs(item.children) do
202 playlist0(c,prefix.." ")
207 local tree = playlist_is_tree(client)
208 if name == "search" then
209 playlist = vlc.playlist.search(arg or "", tree)
211 if tonumber(arg) then
212 playlist = vlc.playlist.get(tonumber(arg), tree)
214 playlist = vlc.playlist.get(arg, tree)
216 playlist = vlc.playlist.get(nil, tree)
219 if name == "search" then
220 client:append("+----[ Search - "..(arg or "`reset'").." ]")
222 client:append("+----[ Playlist - "..playlist.name.." ]")
224 if playlist.children then
225 for _, item in ipairs(playlist.children) do
231 if name == "search" then
232 client:append("+----[ End of search - Use `search' to reset ]")
234 client:append("+----[ End of playlist ]")
238 function playlist_sort(name,client,arg)
240 client:append("Valid sort keys are: id, title, artist, genre, random, duration, album.")
242 local tree = playlist_is_tree(client)
243 vlc.playlist.sort(arg,false,tree)
247 function services_discovery(name,client,arg)
249 if vlc.sd.is_loaded(arg) then
251 client:append(arg.." disabled.")
254 client:append(arg.." enabled.")
257 local sd = vlc.sd.get_services_names()
258 client:append("+----[ Services discovery ]")
259 for n,ln in pairs(sd) do
261 if vlc.sd.is_loaded(n) then
266 client:append("| "..n..": " .. ln .. " (" .. status .. ")")
268 client:append("+----[ End of services discovery ]")
272 function print_text(label,text)
273 return function(name,client)
274 client:append("+----[ "..label.." ]")
276 for line in string.gmatch(text,".-\r?\n") do
277 client:append("| "..string.gsub(line,"\r?\n",""))
280 client:append("+----[ End of "..string.lower(label).." ]")
284 function help(name,client,arg)
285 local width = client.env.width
286 local long = (name == "longhelp")
288 if arg then extra = "matching `" .. arg .. "' " end
289 client:append("+----[ Remote control commands "..extra.."]")
290 for i, cmd in ipairs(commands_ordered) do
291 if (cmd == "" or not commands[cmd].adv or long)
292 and (not arg or string.match(cmd,arg)) then
293 local str = "| " .. cmd
295 local val = commands[cmd]
297 for _,a in ipairs(val.aliases) do
298 str = str .. ", " .. a
301 if val.args then str = str .. " " .. val.args end
302 if #str%2 == 1 then str = str .. " " end
303 str = str .. string.rep(" .",(width-(#str+#val.help)-1)/2)
304 str = str .. string.rep(" ",width-#str-#val.help) .. val.help
309 client:append("+----[ end of help ]")
312 function input_info(name,client)
313 local categories = vlc.input.info()
314 for cat, infos in pairs(categories) do
315 client:append("+----[ "..cat.." ]")
317 for name, value in pairs(infos) do
318 client:append("| "..name..": "..value)
322 client:append("+----[ end of stream info ]")
325 function stats(name,client)
326 local stats_tab = vlc.input.stats()
328 client:append("+----[ begin of statistical info")
329 client:append("+-[Incoming]")
330 client:append("| input bytes read : "..string.format("%8.0f kB",stats_tab["read_bytes"]/1000))
331 client:append("| input bitrate : "..string.format("%6.0f bB/s",stats_tab["input_bitrate"]*8000))
332 client:append("| demux bytes read : "..string.format("%8.0f kB",stats_tab["demux_read_bytes"]/1000))
333 client:append("| demux bitrate : "..string.format("%6.0f kB/s",stats_tab["demux_bitrate"]*8000))
334 client:append("| demux corrupted : "..string.format("%5i",stats_tab["demux_corrupted"]))
335 client:append("| discontinuities : "..string.format("%5i",stats_tab["demux_discontinuity"]))
337 client:append("+-[Video Decoding]")
338 client:append("| video decoded : "..string.format("%5i",stats_tab["decoded_video"]))
339 client:append("| frames displayed : "..string.format("%5i",stats_tab["displayed_pictures"]))
340 client:append("| frames lost : "..string.format("%5i",stats_tab["lost_pictures"]))
342 client:append("+-[Audio Decoding]")
343 client:append("| audio decoded : "..string.format("%5i",stats_tab["decoded_audio"]))
344 client:append("| buffers played : "..string.format("%5i",stats_tab["played_abuffers"]))
345 client:append("| buffers lost : "..string.format("%5i",stats_tab["lost_abuffers"]))
347 client:append("+-[Streaming]")
348 client:append("| packets sent : "..string.format("%5i",stats_tab["sent_packets"]))
349 client:append("| bytes sent : "..string.format("%8.0f kB",stats_tab["sent_bytes"]/1000))
350 client:append("| sending bitrate : "..string.format("%6.0f kb/s",stats_tab["send_bitrate"]*8000))
351 client:append("+----[ end of statistical info ]")
354 function playlist_status(name,client)
355 client:append( "( new input: " .. "FIXME" .. " )" )
356 client:append( "( audio volume: " .. tostring(vlc.volume.get()) .. " )")
357 client:append( "( state " .. vlc.playlist.status() .. " )")
360 function is_playing(name,client)
361 if vlc.input.is_playing() then client:append "1" else client:append "0" end
364 function ret_print(foo,start,stop)
365 local start = start or ""
366 local stop = stop or ""
367 return function(discard,client,...) client:append(start..tostring(foo(...))..stop) end
370 function get_time(var)
371 return function(name,client)
372 local input = vlc.object.input()
373 client:append(math.floor(vlc.var.get( input, var )))
377 function titlechap(name,client,value)
378 local input = vlc.object.input()
379 local var = string.gsub( name, "_.*$", "" )
381 vlc.var.set( input, var, value )
383 local item = vlc.var.get( input, var )
384 -- Todo: add item name conversion
388 function titlechap_offset(client,offset)
389 return function(name,value)
390 local input = vlc.object.input()
391 local var = string.gsub( name, "_.*$", "" )
392 vlc.var.set( input, var, vlc.var.get( input, var )+offset )
396 function seek(name,client,value)
400 function volume(name,client,value)
404 client:append(tostring(vlc.volume.get()))
408 function rate(name,client)
409 local input = vlc.object.input()
410 if name == "normal" then
411 vlc.var.set(input,"rate",1)
413 vlc.var.set(input,"rate-"..name,nil)
417 function frame(name,client)
418 vlc.var.trigger_callback(vlc.object.input(),"frame-next");
421 function listvalue(obj,var)
422 return function(client,value)
423 local o = vlc.object.find(nil,obj,"anywhere")
424 if not o then return end
426 vlc.var.set( o, var, value )
428 local c = vlc.var.get( o, var )
429 local v, l = vlc.var.get_list( o, var )
430 client:append("+----[ "..var.." ]")
431 for i,val in ipairs(v) do
432 local mark = (val==c)and " *" or ""
433 client:append("| "..tostring(val).." - "..tostring(l[i])..mark)
435 client:append("+----[ end of "..var.." ]")
440 function menu(name,client,value)
441 local map = { on='show', off='hide', up='up', down='down', left='prev', right='next', ['select']='activate' }
442 if map[value] and vlc.osd.menu[map[value]] then
443 vlc.osd.menu[map[value]]()
445 client:append("Unknown menu command '"..tostring(value).."'")
449 function eval(client,val)
450 client:append(loadstring("return "..val)())
453 --[[ Declare commands, register their callback functions and provide
456 "<command name>"; { func = <function>; [ args = "<str>"; ] help = "<str>"; [ adv = <bool>; ] [ aliases = { ["<str>";]* }; ] }
459 { "add"; { func = add; args = "XYZ"; help = "add XYZ to playlist" } };
460 { "enqueue"; { func = add; args = "XYZ"; help = "queue XYZ to playlist" } };
461 { "playlist"; { func = playlist; help = "show items currently in playlist" } };
462 { "search"; { func = playlist; args = "[string]"; help = "search for items in playlist (or reset search)" } };
463 { "sort"; { func = playlist_sort; args = "key"; help = "sort the playlist" } };
464 { "sd"; { func = services_discovery; args = "[sd]"; help = "show services discovery or toggle" } };
465 { "play"; { func = skip2(vlc.playlist.play); help = "play stream" } };
466 { "stop"; { func = skip2(vlc.playlist.stop); help = "stop stream" } };
467 { "next"; { func = skip2(vlc.playlist.next); help = "next playlist item" } };
468 { "prev"; { func = skip2(vlc.playlist.prev); help = "previous playlist item" } };
469 { "goto"; { func = skip2(vlc.playlist.goto); help = "goto item at index" } };
470 { "repeat"; { func = skip2(vlc.playlist.repeat_); args = "[on|off]"; help = "toggle playlist repeat" } };
471 { "loop"; { func = skip2(vlc.playlist.loop); args = "[on|off]"; help = "toggle playlist loop" } };
472 { "random"; { func = skip2(vlc.playlist.random); args = "[on|off]"; help = "toggle playlist random" } };
473 { "clear"; { func = skip2(vlc.playlist.clear); help = "clear the playlist" } };
474 { "status"; { func = playlist_status; help = "current playlist status" } };
475 { "title"; { func = titlechap; args = "[X]"; help = "set/get title in current item" } };
476 { "title_n"; { func = titlechap_offset(1); help = "next title in current item" } };
477 { "title_p"; { func = titlechap_offset(-1); help = "previous title in current item" } };
478 { "chapter"; { func = titlechap; args = "[X]"; help = "set/get chapter in current item" } };
479 { "chapter_n"; { func = titlechap_offset(1); help = "next chapter in current item" } };
480 { "chapter_p"; { func = titlechap_offset(-1); help = "previous chapter in current item" } };
482 { "seek"; { func = seek; args = "X"; help = "seek in seconds, for instance `seek 12'" } };
483 { "pause"; { func = setarg(common.hotkey,"key-play-pause"); help = "toggle pause" } };
484 { "fastforward"; { func = setarg(common.hotkey,"key-jump+extrashort"); help = "set to maximum rate" } };
485 { "rewind"; { func = setarg(common.hotkey,"key-jump-extrashort"); help = "set to minimum rate" } };
486 { "faster"; { func = rate; help = "faster playing of stream" } };
487 { "slower"; { func = rate; help = "slower playing of stream" } };
488 { "normal"; { func = rate; help = "normal playing of stream" } };
489 { "frame"; { func = frame; help = "play frame by frame" } };
490 { "fullscreen"; { func = skip2(vlc.video.fullscreen); args = "[on|off]"; help = "toggle fullscreen"; aliases = { "f", "F" } } };
491 { "info"; { func = input_info; help = "information about the current stream" } };
492 { "stats"; { func = stats; help = "show statistical information" } };
493 { "get_time"; { func = get_time("time"); help = "seconds elapsed since stream's beginning" } };
494 { "is_playing"; { func = is_playing; help = "1 if a stream plays, 0 otherwise" } };
495 { "get_title"; { func = ret_print(vlc.input.get_title); help = "the title of the current stream" } };
496 { "get_length"; { func = get_time("length"); help = "the length of the current stream" } };
498 { "volume"; { func = volume; args = "[X]"; help = "set/get audio volume" } };
499 { "volup"; { func = ret_print(vlc.volume.up,"( audio volume: "," )"); args = "[X]"; help = "raise audio volume X steps" } };
500 { "voldown"; { func = ret_print(vlc.volume.down,"( audio volume: "," )"); args = "[X]"; help = "lower audio volume X steps" } };
501 { "adev"; { func = skip(listvalue("aout","audio-device")); args = "[X]"; help = "set/get audio device" } };
502 { "achan"; { func = skip(listvalue("aout","audio-channels")); args = "[X]"; help = "set/get audio channels" } };
503 { "atrack"; { func = skip(listvalue("input","audio-es")); args = "[X]"; help = "set/get audio track" } };
504 { "vtrack"; { func = skip(listvalue("input","video-es")); args = "[X]"; help = "set/get video track" } };
505 { "vratio"; { func = skip(listvalue("vout","aspect-ratio")); args = "[X]"; help = "set/get video aspect ratio" } };
506 { "vcrop"; { func = skip(listvalue("vout","crop")); args = "[X]"; help = "set/get video crop"; aliases = { "crop" } } };
507 { "vzoom"; { func = skip(listvalue("vout","zoom")); args = "[X]"; help = "set/get video zoom"; aliases = { "zoom" } } };
508 { "snapshot"; { func = common.snapshot; help = "take video snapshot" } };
509 { "strack"; { func = skip(listvalue("input","spu-es")); args = "[X]"; help = "set/get subtitles track" } };
510 { "hotkey"; { func = skip(common.hotkey); args = "[hotkey name]"; help = "simulate hotkey press"; adv = true; aliases = { "key" } } };
511 { "menu"; { func = menu; args = "[on|off|up|down|left|right|select]"; help = "use menu"; adv = true } };
513 { "set"; { func = set_env; args = "[var [value]]"; help = "set/get env var"; adv = true } };
514 { "save_env"; { func = save_env; help = "save env vars (for future clients)"; adv = true } };
515 { "alias"; { func = skip(alias); args = "[cmd]"; help = "set/get command aliases"; adv = true } };
516 { "description"; { func = print_text("Description",description); help = "describe this module" } };
517 { "license"; { func = print_text("License message",vlc.misc.license()); help = "print VLC's license message"; adv = true } };
518 { "help"; { func = help; args = "[pattern]"; help = "a help message"; aliases = { "?" } } };
519 { "longhelp"; { func = help; args = "[pattern]"; help = "a longer help message" } };
520 { "logout"; { func = logout; help = "exit (if in a socket connection)" } };
521 { "quit"; { func = quit; help = "quit VLC (or logout if in a socket connection)" } };
522 { "shutdown"; { func = shutdown; help = "shutdown VLC" } };
526 commands_ordered[#commands_ordered] = { "eval"; { func = skip(eval); help = "eval some lua (*debug*)"; adv =true } }
530 for i, cmd in ipairs( commands_ordered ) do
532 commands[cmd[1]]=cmd[2]
533 if cmd[2].aliases then
534 for _,a in ipairs(cmd[2].aliases) do
539 commands_ordered[i]=cmd[1]
541 --[[ From now on commands_ordered is a list of the different command names
542 and commands is a associative array indexed by the command name. ]]
544 -- Compute the column width used when printing a the autocompletion list
546 for c,_ in pairs(commands) do
547 if #c > env.colwidth then env.colwidth = #c end
549 env.coldwidth = env.colwidth + 1
551 -- Count unimplemented functions
555 for c,v in pairs(commands) do
556 if v.func == fixme then
565 if count ~= 0 and env.welcome and env.welcome ~= "" then
566 env.welcome = env.welcome .. "\r\nWarning: "..count.." functions are still unimplemented "..list.."."
571 function split_input(input)
572 local input = strip(input)
573 local s = string.find(input," ")
575 return string.sub(input,0,s-1), strip(string.sub(input,s))
581 function call_command(cmd,client,arg)
582 if type(commands[cmd]) == type("") then
587 ok, msg = pcall( commands[cmd].func, cmd, client, arg )
589 ok, msg = pcall( commands[cmd].func, cmd, client )
593 if a ~= "" then a = " " .. a end
594 client:append("Error in `"..cmd..a.."' ".. msg)
598 function call_libvlc_command(cmd,client,arg)
599 local ok, vlcerr, vlcmsg = pcall( vlc.var.libvlc_command, cmd, arg )
602 if a ~= "" then a = " " .. a end
603 client:append("Error in `"..cmd..a.."' ".. vlcerr) -- when pcall fails, the 2nd arg is the error message.
608 function call_object_command(cmd,client,arg)
609 local var, val = split_input(arg)
610 local ok, vlcmsg, vlcerr, vlcerrmsg = pcall( vlc.var.command, cmd, var, val )
612 client:append("Error in `"..cmd.." "..var.." "..val.."' ".. vlcmsg) -- when pcall fails the 2nd arg is the error message
615 client:append(vlcmsg)
624 h.status_callbacks[host.status.password] = function(client)
625 client.env = common.table_copy( env )
626 if client.env.welcome ~= "" then
627 client:send( client.env.welcome .. "\r\n")
629 client:switch_status(host.status.read)
631 -- Print prompt when switching a client's status to `read'
632 h.status_callbacks[host.status.read] = function(client)
633 client:send( client.env.prompt )
636 h:listen( config.hosts or config.host or "*console" )
638 --[[ The main loop ]]
639 while not vlc.misc.should_die() do
641 local write, read = h:select(0.1)
643 for _, client in pairs(write) do
644 local len = client:send()
645 client.buffer = string.sub(client.buffer,len+1)
646 if client.buffer == "" then client:switch_status(host.status.read) end
649 for _, client in pairs(read) do
650 local input = client:recv(1000)
652 if string.match(input,"\n$") then
653 client.buffer = string.gsub(client.buffer..input,"\r?\n$","")
655 elseif client.buffer == ""
656 and ((client.type == host.client_type.stdio and input == "")
657 or (client.type == host.client_type.net and input == "\004")) then
659 client.buffer = "quit"
662 client.buffer = client.buffer .. input
665 local cmd,arg = split_input(client.buffer)
667 client:switch_status(host.status.write)
668 if commands[cmd] then
669 call_command(cmd,client,arg)
670 elseif string.sub(cmd,0,1)=='@'
671 and call_object_command(string.sub(cmd,2,#cmd),client,arg) == 0 then
673 elseif client.type == host.client_type.stdio
674 and call_libvlc_command(cmd,client,arg) == 0 then
678 if client.env.autocompletion ~= 0 then
679 for v,_ in common.pairs_sorted(commands) do
680 if string.sub(v,0,#cmd)==cmd then
681 table.insert(choices, v)
685 if #choices == 1 and client.env.autoalias ~= 0 then
686 -- client:append("Aliasing to \""..choices[1].."\".")
688 call_command(cmd,client,arg)
690 client:append("Unknown command `"..cmd.."'. Type `help' for help.")
691 if #choices ~= 0 then
692 client:append("Possible choices are:")
693 local cols = math.floor(client.env.width/(client.env.colwidth+1))
694 local fmt = "%-"..client.env.colwidth.."s"
695 for i = 1, #choices do
696 choices[i] = string.format(fmt,choices[i])
698 for i = 1, #choices, cols do
699 local j = i + cols - 1
700 if j > #choices then j = #choices end
701 client:append(" "..table.concat(choices," ",i,j))