1 --[==========================================================================[
2 host.lua: VLC Lua interface command line host module
3 --[==========================================================================[
4 Copyright (C) 2007 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 --]==========================================================================]
24 --[==========================================================================[
30 -- Bypass any authentication
31 function on_password( client )
32 client:switch_status( host.status.read )
34 h.status_callbacks[host.status.password] = on_password
36 h:listen( "localhost:4212" )
37 h:listen( "*console" )
38 --or h:listen( { "localhost:4212", "*console" } )
41 while not vlc.misc.should_die() do
42 -- accept new connections and select active clients
43 local write, read = h:accept_and_select()
45 -- handle clients in write mode
46 for _, client in pairs(write) do
49 client:switch_status( host.status.read )
52 -- handle clients in read mode
53 for _, client in pairs(read) do
54 local str = client:recv(1000)
55 str = string.gsub(str,"\r?\n$","")
56 client.buffer = "Got `"..str.."'.\r\n"
57 client:switch_status( host.status.write )
61 For complete examples see existing VLC Lua interface modules (ie telnet.lua)
62 --]==========================================================================]
64 module("host",package.seeall)
66 status = { init = 0, read = 1, write = 2, password = 3 }
67 client_type = { net = 1, stdio = 2, fifo = 3 }
73 local status_callbacks = {}
76 local function fd_client( client )
77 if client.status == status.read then
84 local function send( client, data, len )
86 return vlc.net.send( client.wfd, data, len )
88 return vlc.net.send( client.wfd, data or client.buffer )
92 local function recv( client, len )
94 return vlc.net.recv( client.rfd, len )
96 return vlc.net.recv( client.rfd )
100 local function write( client, data )
101 return vlc.net.write( client.wfd, data or client.buffer )
104 local function read( client, len )
106 return vlc.net.read( client.rfd, len )
108 return vlc.net.read( client.rfd )
112 local function del_client( client )
113 if client.type == client_type.stdio then
114 client:send( "Cannot delete stdin/stdout client.\n" )
117 for i, c in pairs(clients) do
119 if client.type == client_type.net then
120 if client.wfd ~= client.rfd then
121 vlc.net.close( client.rfd )
123 vlc.net.close( client.wfd )
129 vlc.msg.err("couldn't find client to remove.")
132 local function switch_status( client, s )
133 if client.status == s then return end
135 if status_callbacks[s] then
136 status_callbacks[s]( client )
140 -- append a line to a client's (output) buffer
141 local function append( client, string )
142 client.buffer = client.buffer .. string .. "\r\n"
145 local function new_client( h, fd, wfd, t )
146 if fd < 0 then return end
148 if t == client_type.net then
151 else if t == client_type.stdio or t == client_type.fifo then
155 error("Unknown client type", t )
157 local client = { -- data
160 status = status.init,
169 switch_status = switch_status,
172 client:send( "VLC media player "..vlc.misc.version().."\n" )
173 table.insert(clients, client)
174 client:switch_status(status.password)
178 local function _listen_tcp( h, host, port )
179 if listeners.tcp and listeners.tcp[host]
180 and listeners.tcp[host][port] then
181 error("Already listening on tcp host `"..host..":"..tostring(port).."'")
183 if not listeners.tcp then
186 if not listeners.tcp[host] then
187 listeners.tcp[host] = {}
189 local listener = vlc.net.listen_tcp( host, port )
190 listeners.tcp[host][port] = listener
191 if not listeners.tcp.list then
192 -- FIXME: if host == "list" we'll have a problem
193 listeners.tcp.list = {}
194 local m = { __mode = "v" } -- week values
195 setmetatable( listeners.tcp.list, m )
197 table.insert( listeners.tcp.list, listener )
200 local function _listen_stdio( h )
202 if listeners.stdio then
203 error("Already listening on stdio")
205 new_client( h, 0, 1, client_type.stdio )
206 listeners.stdio = true
209 local function _listen( h, url )
210 if type(url)==type({}) then
211 for _,u in pairs(url) do
215 vlc.msg.info( "Listening on host \""..url.."\"." )
216 if url == "*console" then
219 u = vlc.net.url_parse( url )
220 h:listen_tcp( u.host, u.port )
225 local function _accept_and_select( h, timeout )
226 local function filter_client( fds, status, event )
227 for _, client in pairs(clients) do
228 if client.status == status then
229 fds[client:fd()] = event
235 filter_client( pollfds, status.read, vlc.net.POLLIN )
236 filter_client( pollfds, status.password, vlc.net.POLLIN )
237 filter_client( pollfds, status.write, vlc.net.POLLOUT )
238 if listeners.tcp then
239 for _, listener in pairs(listeners.tcp.list) do
240 for _, fd in pairs({listener:fds()}) do
241 pollfds[fd] = vlc.net.POLLIN
246 local ret = vlc.net.poll( pollfds, timeout or -1 )
250 for _, client in pairs(clients) do
251 if pollfds[client:fd()] == vlc.net.POLLOUT then
252 table.insert(wclients,client)
254 if pollfds[client:fd()] == vlc.net.POLLIN then
255 table.insert(rclients,client)
258 if listeners.tcp then
259 for _, listener in pairs(listeners.tcp.list) do
260 for _, fd in pairs({listener:fds()}) do
261 if pollfds[fd] == vlc.net.POLLIN then
262 local afd = listener:accept()
263 new_client( h, afd, afd, client_type.net )
271 return wclients, rclients
274 local function destructor( h )
276 for _,client in pairs(clients) do
277 client:send("Shutting down.")
278 if client.type == client_type.tcp then
279 if client.wfd ~= client.rfd then
280 vlc.net.close(client.rfd)
282 vlc.net.close(client.wfd)
287 local function _broadcast( h, msg )
288 for _,client in pairs(clients) do
295 status_callbacks = status_callbacks,
298 listen_tcp = _listen_tcp,
299 listen_stdio = _listen_stdio,
300 accept_and_select = _accept_and_select,
301 broadcast = _broadcast,
306 __metatable = "Nothing to see here. Move along.",