Debian Codegraph @

src/scripts/default-nodes/state-default-nodes.lua

raw
1 -- WirePlumber
2 --
3 -- Copyright © 2022 Collabora Ltd.
4 --
5 -- SPDX-License-Identifier: MIT
6
7 -- the script states the default nodes from the user preferences, it has hooks
8 -- which stores the user preferences(it stores not just the current preference
9 -- but all the previous preferences) in to the state file, retrieves them from
10 -- state file during the bootup, finally it has a hook which finds a default
11 -- node out of the user preferences
12
13 log = Log.open_topic ("s-default-nodes")
14
15 nutils = require ("node-utils")
16
17 -- the state storage
18 state = nil
19 state_table = nil
20
21 find_stored_default_node_hook = SimpleEventHook {
22 name = "default-nodes/find-stored-default-node",
23 interests = {
24 EventInterest {
25 Constraint { "event.type", "=", "select-default-node" },
26 },
27 },
28 execute = function (event)
29 local props = event:get_properties ()
30 local available_nodes = event:get_data ("available-nodes")
31 local selected_prio = event:get_data ("selected-node-priority") or 0
32 local selected_node = event:get_data ("selected-node")
33
34 available_nodes = available_nodes and available_nodes:parse ()
35 if not available_nodes then
36 return
37 end
38
39 local stored = collectStored (props ["default-node.type"])
40
41 -- Check if any of the available nodes matches any of the configured
42 for _, node_props in ipairs (available_nodes) do
43 local name = node_props ["node.name"]
44
45 for i, v in ipairs (stored) do
46 if name == v then
47 local priority = nutils.get_session_priority (node_props)
48 priority = priority + 20001 - i
49
50 if priority > selected_prio then
51 selected_prio = priority
52 selected_node = name
53 end
54
55 break
56 end
57 end
58 end
59
60 if selected_node then
61 event:set_data ("selected-node-priority", selected_prio)
62 event:set_data ("selected-node", selected_node)
63 end
64 end
65 }
66
67 store_configured_default_nodes_hook = SimpleEventHook {
68 name = "default-nodes/store-configured-default-nodes",
69 interests = {
70 EventInterest {
71 Constraint { "event.type", "=", "metadata-changed" },
72 Constraint { "metadata.name", "=", "default" },
73 Constraint { "event.subject.key", "c", "default.configured.audio.sink",
74 "default.configured.audio.source", "default.configured.video.source"
75 },
76 },
77 },
78 execute = function (event)
79 local props = event:get_properties ()
80 -- get the part after "default.configured." (= 19 chars)
81 local def_node_type = props ["event.subject.key"]:sub (20)
82 local new_value = props ["event.subject.value"]
83 local new_stored = {}
84
85 if new_value then
86 new_value = Json.Raw (new_value):parse () ["name"]
87 end
88
89 if new_value then
90 local stored = collectStored (def_node_type)
91 local pos = #stored + 1
92
93 -- find if the current configured value is already in the stack
94 for i, v in ipairs (stored) do
95 if v == new_value then
96 pos = i
97 break
98 end
99 end
100
101 -- insert at the top and shift the remaining to fill the gap
102 new_stored [1] = new_value
103 if pos > 1 then
104 table.move (stored, 1, pos-1, 2, new_stored)
105 end
106 if pos < #stored then
107 table.move (stored, pos+1, #stored, pos+1, new_stored)
108 end
109 end
110
111 updateStored (def_node_type, new_stored)
112 end
113 }
114
115 -- set initial values
116 metadata_added_hook = SimpleEventHook {
117 name = "default-nodes/metadata-added",
118 interests = {
119 EventInterest {
120 Constraint { "event.type", "=", "metadata-added" },
121 Constraint { "metadata.name", "=", "default" },
122 },
123 },
124 execute = function (event)
125 local types = { "audio.sink", "audio.source", "video.source" }
126 local source = event:get_source ()
127 local om = source:call ("get-object-manager", "metadata")
128 local metadata = om:lookup { Constraint { "metadata.name", "=", "default" } }
129
130 for _, t in ipairs (types) do
131 local v = state_table ["default.configured." .. t]
132 if v then
133 metadata:set (0, "default.configured." .. t, "Spa:String:JSON",
134 Json.Object { ["name"] = v }:to_string ())
135 end
136 end
137 end
138 }
139
140 -- Collect all the previously configured node names from the state file
141 function collectStored (def_node_type)
142 local stored = {}
143 local key_base = "default.configured." .. def_node_type
144 local key = key_base
145
146 local index = 0
147 repeat
148 local v = state_table [key]
149 table.insert (stored, v)
150 key = key_base .. "." .. tostring (index)
151 index = index + 1
152 until v == nil
153
154 return stored
155 end
156
157 -- Store the given node names in the state file
158 function updateStored (def_node_type, stored)
159 local key_base = "default.configured." .. def_node_type
160 local key = key_base
161
162 local index = 0
163 for _, v in ipairs (stored) do
164 state_table [key] = v
165 key = key_base .. "." .. tostring (index)
166 index = index + 1
167 end
168
169 -- erase the rest, if any
170 repeat
171 local v = state_table [key]
172 state_table [key] = nil
173 key = key_base .. "." .. tostring (index)
174 index = index + 1
175 until v == nil
176
177 state:save_after_timeout (state_table)
178 end
179
180 function toggleState (enable)
181 if enable and not state then
182 state = State ("default-nodes")
183 state_table = state:load ()
184 find_stored_default_node_hook:register ()
185 store_configured_default_nodes_hook:register ()
186 metadata_added_hook:register ()
187 elseif not enable and state then
188 state = nil
189 state_table = nil
190 find_stored_default_node_hook:remove ()
191 store_configured_default_nodes_hook:remove ()
192 metadata_added_hook:remove ()
193 end
194 end
195
196 Settings.subscribe ("node.restore-default-targets", function ()
197 toggleState (Settings.get_boolean ("node.restore-default-targets"))
198 end)
199 toggleState (Settings.get_boolean ("node.restore-default-targets"))