Add vlc_GetActionId().
[vlc.git] / share / lua / intf / modules / common.lua
1 --[[ This code is public domain (since it really isn't very interesting) ]]--
2
3 module("common",package.seeall)
4
5 -- Iterate over a table in the keys' alphabetical order
6 function pairs_sorted(t)
7     local s = {}
8     for k,_ in pairs(t) do table.insert(s,k) end
9     table.sort(s)
10     local i = 0
11     return function () i = i + 1; return s[i], t[s[i]] end
12 end
13
14 -- Return a function such as skip(foo)(a,b,c) = foo(b,c)
15 function skip(foo)
16     return function(discard,...) return foo(...) end
17 end
18
19 -- Return a function such as setarg(foo,a)(b,c) = foo(a,b,c)
20 function setarg(foo,a)
21     return function(...) return foo(a,...) end
22 end
23
24 -- Trigger a hotkey
25 function hotkey(arg)
26     local id = vlc.misc.action_id( arg )
27     if id ~= nil then
28         vlc.var.set( vlc.object.libvlc(), "key-action", id )
29         return true
30     else
31         return false
32     end
33 end
34
35 -- Take a video snapshot
36 function snapshot()
37     local vout = vlc.object.find(nil,"vout","anywhere")
38     if not vout then return end
39     vlc.var.set(vout,"video-snapshot",nil)
40 end
41
42 -- Naive (non recursive) table copy
43 function table_copy(t)
44     c = {}
45     for i,v in pairs(t) do c[i]=v end
46     return c
47 end
48
49 -- strip leading and trailing spaces
50 function strip(str)
51     return string.gsub(str, "^%s*(.-)%s*$", "%1")
52 end
53
54 -- print a table (recursively)
55 function table_print(t,prefix)
56     local prefix = prefix or ""
57     for a,b in pairs_sorted(t) do
58         print(prefix..tostring(a),b)
59         if type(b)==type({}) then
60             table_print(b,prefix.."\t")
61         end
62     end
63 end
64
65 -- print the list of callbacks registered in lua
66 -- usefull for debug purposes
67 function print_callbacks()
68     print "callbacks:"
69     table_print(vlc.callbacks)
70 end 
71
72 -- convert a duration (in seconds) to a string
73 function durationtostring(duration)
74     return string.format("%02d:%02d:%02d",
75                          math.floor(duration/3600),
76                          math.floor(duration/60)%60,
77                          math.floor(duration%60))
78 end
79
80 -- realpath
81 function realpath(path)
82     return string.gsub(string.gsub(string.gsub(string.gsub(path,"/%.%./[^/]+","/"),"/[^/]+/%.%./","/"),"/%./","/"),"//","/")
83 end
84
85 -- seek
86 function seek(value)
87     local input = vlc.object.input()
88     if string.sub(value,#value)=="%" then
89         vlc.var.set(input,"position",tonumber(string.sub(value,1,#value-1))/100.)
90     else
91         vlc.var.set(input,"time",tonumber(value))
92     end
93 end
94
95 function volume(value)
96     if type(value)=="string" and string.sub(value,1,1) == "+" or string.sub(value,1,1) == "-" then
97         vlc.volume.set(vlc.volume.get()+tonumber(value))
98     else
99         vlc.volume.set(tostring(value))
100     end
101 end