fix comment.
[vlc.git] / share / lua / intf / rc.lua
1 --[==========================================================================[
2  rc.lua: remote control module for VLC
3 --[==========================================================================[
4  Copyright (C) 2007-2009 the VideoLAN team
5  $Id$
6
7  Authors: Antoine Cellerier <dionoea at videolan dot org>
8
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.
13
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.
18
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 --]==========================================================================]
23
24 description=
25 [============================================================================[
26  Remote control interface for VLC
27
28  This is a modules/control/rc.c look alike (with a bunch of new features)
29
30  Use on local term:
31     vlc -I rc
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'}}"
36
37  Note:
38     -I rc and -I luarc are aliases for -I lua --lua-intf rc
39
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
44             enable.
45  The following can be set using the --lua-config option or in the interface
46  itself using the `set' command:
47     * prompt: The prompt.
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,
52                       1 to enable).
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 ]============================================================================]
57
58 require("common")
59 skip = common.skip
60 skip2 = function(foo) return skip(skip(foo)) end
61 setarg = common.setarg
62 strip = common.strip
63
64 _ = vlc.gettext._
65 N_ = vlc.gettext.N_
66
67 --[[ Setup default environement ]]
68 env = { prompt = "> ";
69         width = 70;
70         autocompletion = 1;
71         autoalias = 1;
72         welcome = _("Remote control interface initialized. Type `help' for help.");
73         flatplaylist = 0;
74       }
75
76 --[[ Import custom environement variables from the command line config (if possible) ]]
77 for k,v in pairs(env) do
78     if config[k] then
79         if type(env[k]) == type(config[k]) then
80             env[k] = config[k]
81             vlc.msg.dbg("set environement variable `"..k.."' to "..tostring(env[k]))
82         else
83             vlc.msg.err("environement variable `"..k.."' should be of type "..type(env[k])..". config value will be discarded.")
84         end
85     end
86 end
87
88 --[[ Command functions ]]
89 function set_env(name,client,value)
90     if value then
91         local var,val = split_input(value)
92         if val then
93             local s = string.gsub(val,"\"(.*)\"","%1")
94             if type(client.env[var])==type(1) then
95                 client.env[var] = tonumber(s)
96             else
97                 client.env[var] = s
98             end
99         else
100             client:append( tostring(client.env[var]) )
101         end
102     else
103         for e,v in common.pairs_sorted(client.env) do
104             client:append(e.."="..v)
105         end
106     end
107 end
108
109 function save_env(name,client,value)
110     env = common.table_copy(client.env)
111 end
112
113 function alias(client,value)
114     if value then
115         local var,val = split_input(value)
116         if commands[var] and type(commands[var]) ~= type("") then
117             client:append("Error: cannot use a primary command as an alias name")
118         else
119             if commands[val] then
120                 commands[var]=val
121             else
122                 client:append("Error: unknown primary command `"..val.."'.")
123             end
124         end
125     else
126         for c,v in common.pairs_sorted(commands) do
127             if type(v)==type("") then
128                 client:append(c.."="..v)
129             end
130         end
131     end
132 end
133
134 function fixme(name,client)
135     client:append( "FIXME: unimplemented command `"..name.."'." )
136 end
137
138 function logout(name,client)
139     if client.type == host.client_type.net then
140         client:send("Bye-bye!")
141         client:del()
142     else
143         client:append("Error: Can't logout of stdin/stdout. Use quit or shutdown to close VLC.")
144     end
145 end
146
147 function shutdown(name,client)
148     client:append("Bye-bye!")
149     h:broadcast("Shutting down.")
150     vlc.msg.info("Requested shutdown.")
151     vlc.misc.quit()
152 end
153
154 function quit(name,client)
155     if client.type == host.client_type.net then
156         logout(name,client)
157     else
158         shutdown(name,client)
159     end
160 end
161
162 function add(name,client,arg)
163     -- TODO: parse single and double quotes properly
164     local f
165     if name == "enqueue" then
166         f = vlc.playlist.enqueue
167     else
168         f = vlc.playlist.add
169     end
170     local options = {}
171     for o in string.gmatch(arg," +:([^ ]*)") do
172         table.insert(options,o)
173     end
174     arg = string.gsub(arg," +:.*$","")
175     f({{path=arg,options=options}})
176 end
177
178 function playlist_is_tree( client )
179     if client.env.flatplaylist == 0 then
180         return true
181     else
182         return false
183     end
184 end
185
186 function playlist(name,client,arg)
187     function playlist0(item,prefix)
188         local prefix = prefix or ""
189         if not item.flags.disabled then
190             local str = "| "..prefix..tostring(item.id).." - "..item.name
191             if item.duration > 0 then
192                 str = str.." ("..common.durationtostring(item.duration)..")"
193             end
194             if item.nb_played > 0 then
195                 str = str.." [played "..tostring(item.nb_played).." time"
196                 if item.nb_played > 1 then
197                     str = str .. "s"
198                 end
199                 str = str .. "]"
200             end
201             client:append(str)
202         end
203         if item.children then
204             for _, c in ipairs(item.children) do
205                 playlist0(c,prefix.."  ")
206             end
207         end
208     end
209     local playlist
210     local tree = playlist_is_tree(client)
211     if name == "search" then
212         playlist = vlc.playlist.search(arg or "", tree)
213     else
214         if tonumber(arg) then
215             playlist = vlc.playlist.get(tonumber(arg), tree)
216         elseif arg then
217             playlist = vlc.playlist.get(arg, tree)
218         else
219             playlist = vlc.playlist.get(nil, tree)
220         end
221     end
222     if name == "search" then
223         client:append("+----[ Search - "..(arg or "`reset'").." ]")
224     else
225         client:append("+----[ Playlist - "..playlist.name.." ]")
226     end
227     if playlist.children then
228         for _, item in ipairs(playlist.children) do
229             playlist0(item)
230         end
231     else
232         playlist0(playlist)
233     end
234     if name == "search" then
235         client:append("+----[ End of search - Use `search' to reset ]")
236     else
237         client:append("+----[ End of playlist ]")
238     end
239 end
240
241 function playlist_sort(name,client,arg)
242     if not arg then
243         client:append("Valid sort keys are: id, title, artist, genre, random, duration, album.")
244     else
245         local tree = playlist_is_tree(client)
246         vlc.playlist.sort(arg,false,tree)
247     end
248 end
249
250 function services_discovery(name,client,arg)
251     if arg then
252         if vlc.sd.is_loaded(arg) then
253             vlc.sd.remove(arg)
254             client:append(arg.." disabled.")
255         else
256             vlc.sd.add(arg)
257             client:append(arg.." enabled.")
258         end
259     else
260         local sd = vlc.sd.get_services_names()
261         client:append("+----[ Services discovery ]")
262         for n,ln in pairs(sd) do
263             local status
264             if vlc.sd.is_loaded(n) then
265                 status = "enabled"
266             else
267                 status = "disabled"
268             end
269             client:append("| "..n..": " .. ln .. " (" .. status .. ")")
270         end
271         client:append("+----[ End of services discovery ]")
272     end
273 end
274
275 function print_text(label,text)
276     return function(name,client)
277         client:append("+----[ "..label.." ]")
278         client:append "|"
279         for line in string.gmatch(text,".-\r?\n") do
280             client:append("| "..string.gsub(line,"\r?\n",""))
281         end
282         client:append "|"
283         client:append("+----[ End of "..string.lower(label).." ]")
284     end
285 end
286
287 function help(name,client,arg)
288     local width = client.env.width
289     local long = (name == "longhelp")
290     local extra = ""
291     if arg then extra = "matching `" .. arg .. "' " end
292     client:append("+----[ Remote control commands "..extra.."]")
293     for i, cmd in ipairs(commands_ordered) do
294         if (cmd == "" or not commands[cmd].adv or long)
295         and (not arg or string.match(cmd,arg)) then
296             local str = "| " .. cmd
297             if cmd ~= "" then
298                 local val = commands[cmd]
299                 if val.aliases then
300                     for _,a in ipairs(val.aliases) do
301                         str = str .. ", " .. a
302                     end
303                 end
304                 if val.args then str = str .. " " .. val.args end
305                 if #str%2 == 1 then str = str .. " " end
306                 str = str .. string.rep(" .",(width-(#str+#val.help)-1)/2)
307                 str = str .. string.rep(" ",width-#str-#val.help) .. val.help
308             end
309             client:append(str)
310         end
311     end
312     client:append("+----[ end of help ]")
313 end
314
315 function input_info(name,client)
316     local categories = vlc.input.info()
317     for cat, infos in pairs(categories) do
318         client:append("+----[ "..cat.." ]")
319         client:append("|")
320         for name, value in pairs(infos) do
321             client:append("| "..name..": "..value)
322         end
323         client:append("|")
324     end
325     client:append("+----[ end of stream info ]")
326 end
327
328 function stats(name,client)
329     local stats_tab = vlc.input.stats()
330
331     client:append("+----[ begin of statistical info")
332     client:append("+-[Incoming]")
333     client:append("| input bytes read : "..string.format("%8.0f kB",stats_tab["read_bytes"]/1000))
334     client:append("| input bitrate    :   "..string.format("%6.0f bB/s",stats_tab["input_bitrate"]*8000))
335     client:append("| demux bytes read : "..string.format("%8.0f kB",stats_tab["demux_read_bytes"]/1000))
336     client:append("| demux bitrate    :   "..string.format("%6.0f kB/s",stats_tab["demux_bitrate"]*8000))
337     client:append("| demux corrupted  :    "..string.format("%5i",stats_tab["demux_corrupted"]))
338     client:append("| discontinuities  :    "..string.format("%5i",stats_tab["demux_discontinuity"]))
339     client:append("|")
340     client:append("+-[Video Decoding]")
341     client:append("| video decoded    :    "..string.format("%5i",stats_tab["decoded_video"]))
342     client:append("| frames displayed :    "..string.format("%5i",stats_tab["displayed_pictures"]))
343     client:append("| frames lost      :    "..string.format("%5i",stats_tab["lost_pictures"]))
344     client:append("|")
345     client:append("+-[Audio Decoding]")
346     client:append("| audio decoded    :    "..string.format("%5i",stats_tab["decoded_audio"]))
347     client:append("| buffers played   :    "..string.format("%5i",stats_tab["played_abuffers"]))
348     client:append("| buffers lost     :    "..string.format("%5i",stats_tab["lost_abuffers"]))
349     client:append("|")
350     client:append("+-[Streaming]")
351     client:append("| packets sent     :    "..string.format("%5i",stats_tab["sent_packets"]))
352     client:append("| bytes sent       : "..string.format("%8.0f kB",stats_tab["sent_bytes"]/1000))
353     client:append("| sending bitrate  :   "..string.format("%6.0f kb/s",stats_tab["send_bitrate"]*8000))
354     client:append("+----[ end of statistical info ]")
355 end
356
357 function playlist_status(name,client)
358     client:append( "( new input: " .. "FIXME" .. " )" )
359     client:append( "( audio volume: " .. tostring(vlc.volume.get()) .. " )")
360     client:append( "( state " .. vlc.playlist.status() .. " )")
361 end
362
363 function is_playing(name,client)
364     if vlc.input.is_playing() then client:append "1" else client:append "0" end
365 end
366
367 function ret_print(foo,start,stop)
368     local start = start or ""
369     local stop = stop or ""
370     return function(discard,client,...) client:append(start..tostring(foo(...))..stop) end
371 end
372
373 function get_time(var)
374     return function(name,client)
375         local input = vlc.object.input()
376         client:append(math.floor(vlc.var.get( input, var )))
377     end
378 end
379
380 function titlechap(name,client,value)
381     local input = vlc.object.input()
382     local var = string.gsub( name, "_.*$", "" )
383     if value then
384         vlc.var.set( input, var, value )
385     else
386         local item = vlc.var.get( input, var )
387         -- Todo: add item name conversion
388         client:append(item)
389     end
390 end
391 function titlechap_offset(client,offset)
392     return function(name,value)
393         local input = vlc.object.input()
394         local var = string.gsub( name, "_.*$", "" )
395         vlc.var.set( input, var, vlc.var.get( input, var )+offset )
396     end
397 end
398
399 function seek(name,client,value)
400     common.seek(value)
401 end
402
403 function volume(name,client,value)
404     if value then
405         common.volume(value)
406     else
407         client:append(tostring(vlc.volume.get()))
408     end
409 end
410
411 function rate(name,client,value)
412     local input = vlc.object.input()
413     if name == "rate" then
414         vlc.var.set(input, "rate", tonumber(value))
415     elseif name == "normal" then
416         vlc.var.set(input,"rate",1)
417     else
418         vlc.var.set(input,"rate-"..name,nil)
419     end
420 end
421
422 function frame(name,client)
423     vlc.var.trigger_callback(vlc.object.input(),"frame-next");
424 end
425
426 function listvalue(obj,var)
427     return function(client,value)
428         local o = vlc.object.find(nil,obj,"anywhere")
429         if not o then return end
430         if value then
431             vlc.var.set( o, var, value )
432         else
433             local c = vlc.var.get( o, var )
434             local v, l = vlc.var.get_list( o, var )
435             client:append("+----[ "..var.." ]")
436             for i,val in ipairs(v) do
437                 local mark = (val==c)and " *" or ""
438                 client:append("| "..tostring(val).." - "..tostring(l[i])..mark)
439             end
440             client:append("+----[ end of "..var.." ]")
441         end
442     end
443 end
444
445 function menu(name,client,value)
446     local map = { on='show', off='hide', up='up', down='down', left='prev', right='next', ['select']='activate' }
447     if map[value] and vlc.osd.menu[map[value]] then
448         vlc.osd.menu[map[value]]()
449     else
450         client:append("Unknown menu command '"..tostring(value).."'")
451     end
452 end
453
454 function hotkey(name, client, value)
455     if not value then
456         client:append("Please specify a hotkey (ie key-quit or quit)")
457     elseif not common.hotkey(value) and not common.hotkey("key-"..value) then
458         client:append("Unknown hotkey '"..value.."'")
459     end
460 end
461
462 function eval(client,val)
463     client:append(tostring(loadstring("return "..val)()))
464 end
465
466 --[[ Declare commands, register their callback functions and provide
467      help strings here.
468      Syntax is:
469      "<command name>"; { func = <function>; [ args = "<str>"; ] help = "<str>"; [ adv = <bool>; ] [ aliases = { ["<str>";]* }; ] }
470      ]]
471 commands_ordered = {
472     { "add"; { func = add; args = "XYZ"; help = "add XYZ to playlist" } };
473     { "enqueue"; { func = add; args = "XYZ"; help = "queue XYZ to playlist" } };
474     { "playlist"; { func = playlist; help = "show items currently in playlist" } };
475     { "search"; { func = playlist; args = "[string]"; help = "search for items in playlist (or reset search)" } };
476     { "sort"; { func = playlist_sort; args = "key"; help = "sort the playlist" } };
477     { "sd"; { func = services_discovery; args = "[sd]"; help = "show services discovery or toggle" } };
478     { "play"; { func = skip2(vlc.playlist.play); help = "play stream" } };
479     { "stop"; { func = skip2(vlc.playlist.stop); help = "stop stream" } };
480     { "next"; { func = skip2(vlc.playlist.next); help = "next playlist item" } };
481     { "prev"; { func = skip2(vlc.playlist.prev); help = "previous playlist item" } };
482     { "goto"; { func = skip2(vlc.playlist.goto); help = "goto item at index" } };
483     { "repeat"; { func = skip2(vlc.playlist.repeat_); args = "[on|off]"; help = "toggle playlist repeat" } };
484     { "loop"; { func = skip2(vlc.playlist.loop); args = "[on|off]"; help = "toggle playlist loop" } };
485     { "random"; { func = skip2(vlc.playlist.random); args = "[on|off]"; help = "toggle playlist random" } };
486     { "clear"; { func = skip2(vlc.playlist.clear); help = "clear the playlist" } };
487     { "status"; { func = playlist_status; help = "current playlist status" } };
488     { "title"; { func = titlechap; args = "[X]"; help = "set/get title in current item" } };
489     { "title_n"; { func = titlechap_offset(1); help = "next title in current item" } };
490     { "title_p"; { func = titlechap_offset(-1); help = "previous title in current item" } };
491     { "chapter"; { func = titlechap; args = "[X]"; help = "set/get chapter in current item" } };
492     { "chapter_n"; { func = titlechap_offset(1); help = "next chapter in current item" } };
493     { "chapter_p"; { func = titlechap_offset(-1); help = "previous chapter in current item" } };
494     { "" };
495     { "seek"; { func = seek; args = "X"; help = "seek in seconds, for instance `seek 12'" } };
496     { "pause"; { func = setarg(common.hotkey,"key-play-pause"); help = "toggle pause" } };
497     { "fastforward"; { func = setarg(common.hotkey,"key-jump+extrashort"); help = "set to maximum rate" } };
498     { "rewind"; { func = setarg(common.hotkey,"key-jump-extrashort"); help = "set to minimum rate" } };
499     { "faster"; { func = rate; help = "faster playing of stream" } };
500     { "slower"; { func = rate; help = "slower playing of stream" } };
501     { "normal"; { func = rate; help = "normal playing of stream" } };
502     { "rate"; { func = rate; args = "[playback rate]"; help = "set playback rate to value" } };
503     { "frame"; { func = frame; help = "play frame by frame" } };
504     { "fullscreen"; { func = skip2(vlc.video.fullscreen); args = "[on|off]"; help = "toggle fullscreen"; aliases = { "f", "F" } } };
505     { "info"; { func = input_info; help = "information about the current stream" } };
506     { "stats"; { func = stats; help = "show statistical information" } };
507     { "get_time"; { func = get_time("time"); help = "seconds elapsed since stream's beginning" } };
508     { "is_playing"; { func = is_playing; help = "1 if a stream plays, 0 otherwise" } };
509     { "get_title"; { func = ret_print(vlc.input.get_title); help = "the title of the current stream" } };
510     { "get_length"; { func = get_time("length"); help = "the length of the current stream" } };
511     { "" };
512     { "volume"; { func = volume; args = "[X]"; help = "set/get audio volume" } };
513     { "volup"; { func = ret_print(vlc.volume.up,"( audio volume: "," )"); args = "[X]"; help = "raise audio volume X steps" } };
514     { "voldown"; { func = ret_print(vlc.volume.down,"( audio volume: "," )"); args = "[X]"; help = "lower audio volume X steps" } };
515     { "adev"; { func = skip(listvalue("aout","audio-device")); args = "[X]"; help = "set/get audio device" } };
516     { "achan"; { func = skip(listvalue("aout","audio-channels")); args = "[X]"; help = "set/get audio channels" } };
517     { "atrack"; { func = skip(listvalue("input","audio-es")); args = "[X]"; help = "set/get audio track" } };
518     { "vtrack"; { func = skip(listvalue("input","video-es")); args = "[X]"; help = "set/get video track" } };
519     { "vratio"; { func = skip(listvalue("vout","aspect-ratio")); args = "[X]"; help = "set/get video aspect ratio" } };
520     { "vcrop"; { func = skip(listvalue("vout","crop")); args = "[X]"; help = "set/get video crop"; aliases = { "crop" } } };
521     { "vzoom"; { func = skip(listvalue("vout","zoom")); args = "[X]"; help = "set/get video zoom"; aliases = { "zoom" } } };
522     { "snapshot"; { func = common.snapshot; help = "take video snapshot" } };
523     { "strack"; { func = skip(listvalue("input","spu-es")); args = "[X]"; help = "set/get subtitles track" } };
524     { "hotkey"; { func = hotkey; args = "[hotkey name]"; help = "simulate hotkey press"; adv = true; aliases = { "key" } } };
525     { "menu"; { func = menu; args = "[on|off|up|down|left|right|select]"; help = "use menu"; adv = true } };
526     { "" };
527     { "set"; { func = set_env; args = "[var [value]]"; help = "set/get env var"; adv = true } };
528     { "save_env"; { func = save_env; help = "save env vars (for future clients)"; adv = true } };
529     { "alias"; { func = skip(alias); args = "[cmd]"; help = "set/get command aliases"; adv = true } };
530     { "description"; { func = print_text("Description",description); help = "describe this module" } };
531     { "license"; { func = print_text("License message",vlc.misc.license()); help = "print VLC's license message"; adv = true } };
532     { "help"; { func = help; args = "[pattern]"; help = "a help message"; aliases = { "?" } } };
533     { "longhelp"; { func = help; args = "[pattern]"; help = "a longer help message" } };
534     { "logout"; { func = logout; help = "exit (if in a socket connection)" } };
535     { "quit"; { func = quit; help = "quit VLC (or logout if in a socket connection)" } };
536     { "shutdown"; { func = shutdown; help = "shutdown VLC" } };
537     }
538
539 if config.eval then
540     commands_ordered[#commands_ordered] = { "eval"; { func = skip(eval); help = "eval some lua (*debug*)"; adv =true } }
541 end
542
543 commands = {}
544 for i, cmd in ipairs( commands_ordered ) do
545     if #cmd == 2 then
546         commands[cmd[1]]=cmd[2]
547         if cmd[2].aliases then
548             for _,a in ipairs(cmd[2].aliases) do
549                 commands[a]=cmd[1]
550             end
551         end
552     end
553     commands_ordered[i]=cmd[1]
554 end
555 --[[ From now on commands_ordered is a list of the different command names
556      and commands is a associative array indexed by the command name. ]]
557
558 -- Compute the column width used when printing a the autocompletion list
559 env.colwidth = 0
560 for c,_ in pairs(commands) do
561     if #c > env.colwidth then env.colwidth = #c end
562 end
563 env.coldwidth = env.colwidth + 1
564
565 -- Count unimplemented functions
566 do
567     local count = 0
568     local list = "("
569     for c,v in pairs(commands) do
570         if v.func == fixme then
571             count = count + 1
572             if count ~= 1 then
573                 list = list..","
574             end
575             list = list..c
576         end
577     end
578     list = list..")"
579     if count ~= 0 and env.welcome and env.welcome ~= "" then
580         env.welcome = env.welcome .. "\r\nWarning: "..count.." functions are still unimplemented "..list.."."
581     end
582 end
583
584 --[[ Utils ]]
585 function split_input(input)
586     local input = strip(input)
587     local s = string.find(input," ")
588     if s then
589         return string.sub(input,0,s-1), strip(string.sub(input,s))
590     else
591         return input
592     end
593 end
594
595 function call_command(cmd,client,arg)
596     if type(commands[cmd]) == type("") then
597         cmd = commands[cmd]
598     end
599     local ok, msg
600     if arg ~= nil then
601         ok, msg = pcall( commands[cmd].func, cmd, client, arg )
602     else
603         ok, msg = pcall( commands[cmd].func, cmd, client )
604     end
605     if not ok then
606         local a = arg or ""
607         if a ~= "" then a = " " .. a end
608         client:append("Error in `"..cmd..a.."' ".. msg)
609     end
610 end
611
612 function call_libvlc_command(cmd,client,arg)
613     local ok, vlcerr, vlcmsg = pcall( vlc.var.libvlc_command, cmd, arg )
614     if not ok then
615         local a = arg or ""
616         if a ~= "" then a = " " .. a end
617         client:append("Error in `"..cmd..a.."' ".. vlcerr) -- when pcall fails, the 2nd arg is the error message.
618     end
619     return vlcerr
620 end
621
622 function call_object_command(cmd,client,arg)
623     local var, val = split_input(arg)
624     local ok, vlcmsg, vlcerr, vlcerrmsg = pcall( vlc.var.command, cmd, var, val )
625     if not ok then
626         client:append("Error in `"..cmd.." "..var.." "..val.."' ".. vlcmsg) -- when pcall fails the 2nd arg is the error message
627     end
628     if vlcmsg ~= "" then
629         client:append(vlcmsg)
630     end
631     return vlcerr
632 end
633
634 --[[ Setup host ]]
635 require("host")
636 h = host.host()
637 -- No auth
638 h.status_callbacks[host.status.password] = function(client)
639     client.env = common.table_copy( env )
640     if client.env.welcome ~= "" then
641         client:send( client.env.welcome .. "\r\n")
642     end
643     client:switch_status(host.status.read)
644 end
645 -- Print prompt when switching a client's status to `read'
646 h.status_callbacks[host.status.read] = function(client)
647     client:send( client.env.prompt )
648 end
649
650 h:listen( config.hosts or config.host or "*console" )
651
652 --[[ The main loop ]]
653 while not vlc.misc.should_die() do
654     h:accept()
655     local write, read = h:select(0.1)
656
657     for _, client in pairs(write) do
658         local len = client:send()
659         client.buffer = string.sub(client.buffer,len+1)
660         if client.buffer == "" then client:switch_status(host.status.read) end
661     end
662
663     for _, client in pairs(read) do
664         local input = client:recv(1000)
665         local done = false
666         if string.match(input,"\n$") then
667             client.buffer = string.gsub(client.buffer..input,"\r?\n$","")
668             done = true
669         elseif client.buffer == ""
670            and ((client.type == host.client_type.stdio and input == "")
671            or  (client.type == host.client_type.net and input == "\004")) then
672             -- Caught a ^D
673             client.buffer = "quit"
674             done = true
675         else
676             client.buffer = client.buffer .. input
677         end
678         if done then
679             local cmd,arg = split_input(client.buffer)
680             client.buffer = ""
681             client:switch_status(host.status.write)
682             if commands[cmd] then
683                 call_command(cmd,client,arg)
684             elseif string.sub(cmd,0,1)=='@'
685             and call_object_command(string.sub(cmd,2,#cmd),client,arg) == 0 then
686                 --
687             elseif client.type == host.client_type.stdio
688             and call_libvlc_command(cmd,client,arg) == 0 then
689                 --
690             else
691                 local choices = {}
692                 if client.env.autocompletion ~= 0 then
693                     for v,_ in common.pairs_sorted(commands) do
694                         if string.sub(v,0,#cmd)==cmd then
695                             table.insert(choices, v)
696                         end
697                     end
698                 end
699                 if #choices == 1 and client.env.autoalias ~= 0 then
700                     -- client:append("Aliasing to \""..choices[1].."\".")
701                     cmd = choices[1]
702                     call_command(cmd,client,arg)
703                 else
704                     client:append("Unknown command `"..cmd.."'. Type `help' for help.")
705                     if #choices ~= 0 then
706                         client:append("Possible choices are:")
707                         local cols = math.floor(client.env.width/(client.env.colwidth+1))
708                         local fmt = "%-"..client.env.colwidth.."s"
709                         for i = 1, #choices do
710                             choices[i] = string.format(fmt,choices[i])
711                         end
712                         for i = 1, #choices, cols do
713                             local j = i + cols - 1
714                             if j > #choices then j = #choices end
715                             client:append("  "..table.concat(choices," ",i,j))
716                         end
717                     end
718                 end
719             end
720         end
721     end
722 end