udev: remove item when the device is removed
[vlc.git] / modules / services_discovery / udev.c
1 /**
2  * @file udev.c
3  * @brief List of multimedia devices for VLC media player
4  */
5 /*****************************************************************************
6  * Copyright © 2009 Rémi Denis-Courmont
7  *
8  * This library is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Lesser General Public License
10  * as published by the Free Software Foundation; either version 2.1
11  * of the License, or (at your option) any later version.
12  *
13  * This library is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public
19  * License along with this library; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
21  ****************************************************************************/
22
23 #ifdef HAVE_CONFIG_H
24 # include <config.h>
25 #endif
26
27 #include <libudev.h>
28 #include <vlc_common.h>
29 #include <vlc_services_discovery.h>
30 #include <vlc_plugin.h>
31 #include <poll.h>
32 #include <errno.h>
33
34 static int  Open (vlc_object_t *);
35 static void Close (vlc_object_t *);
36
37 /*
38  * Module descriptor
39  */
40 vlc_module_begin ()
41     set_shortname (N_("Devices"))
42     set_description (N_("Capture devices"))
43     set_category (CAT_PLAYLIST)
44     set_subcategory (SUBCAT_PLAYLIST_SD)
45     set_capability ("services_discovery", 0)
46     set_callbacks (Open, Close)
47
48     add_shortcut ("udev")
49 vlc_module_end ()
50
51 struct services_discovery_sys_t
52 {
53     struct udev_monitor *monitor;
54     vlc_thread_t         thread;
55     input_item_t       **itemv;
56     size_t               itemc;
57 };
58
59 static void *Run (void *);
60 static void HandleDevice (services_discovery_t *, struct udev_device *, bool);
61
62 /**
63  * Probes and initializes.
64  */
65 static int Open (vlc_object_t *obj)
66 {
67     const char subsys[] = "video4linux";
68     services_discovery_t *sd = (services_discovery_t *)obj;
69     services_discovery_sys_t *p_sys = malloc (sizeof (*p_sys));
70
71     if (p_sys == NULL)
72         return VLC_ENOMEM;
73     sd->p_sys = p_sys;
74     p_sys->itemv = NULL;
75     p_sys->itemc = 0;
76
77     struct udev_monitor *mon = NULL;
78     struct udev *udev = udev_new ();
79     if (udev == NULL)
80         goto error;
81
82     mon = udev_monitor_new_from_netlink (udev, "udev");
83     if (mon == NULL
84      || udev_monitor_filter_add_match_subsystem_devtype (mon, subsys, NULL))
85         goto error;
86     p_sys->monitor = mon;
87
88     /* Enumerate existing devices */
89     struct udev_enumerate *devenum = udev_enumerate_new (udev);
90     if (devenum == NULL)
91         goto error;
92     if (udev_enumerate_add_match_subsystem (devenum, subsys))
93     {
94         udev_enumerate_unref (devenum);
95         goto error;
96     }
97
98     udev_monitor_enable_receiving (mon);
99     /* Note that we enumerate _after_ monitoring is enabled so that we do not
100      * loose device events occuring while we are enumerating. We could still
101      * loose events if the Netlink socket receive buffer overflows. */
102     udev_enumerate_scan_devices (devenum);
103     struct udev_list_entry *devlist = udev_enumerate_get_list_entry (devenum);
104     struct udev_list_entry *deventry;
105     udev_list_entry_foreach (deventry, devlist)
106     {
107         const char *path = udev_list_entry_get_name (deventry);
108         struct udev_device *dev = udev_device_new_from_syspath (udev, path);
109         HandleDevice (sd, dev, true);
110         udev_device_unref (dev);
111     }
112     udev_enumerate_unref (devenum);
113
114     if (vlc_clone (&p_sys->thread, Run, sd, VLC_THREAD_PRIORITY_LOW))
115     {   /* Fallback without thread */
116         udev_monitor_unref (mon);
117         udev_unref (udev);
118         p_sys->monitor = NULL;
119     }
120     return VLC_SUCCESS;
121
122 error:
123     if (mon != NULL)
124         udev_monitor_unref (mon);
125     if (udev != NULL)
126         udev_unref (udev);
127     free (p_sys);
128     return VLC_EGENERIC;
129 }
130
131
132 /**
133  * Releases resources
134  */
135 static void Close (vlc_object_t *obj)
136 {
137     services_discovery_t *sd = (services_discovery_t *)obj;
138     services_discovery_sys_t *p_sys = sd->p_sys;
139
140     if (p_sys->monitor != NULL)
141     {
142         struct udev *udev = udev_monitor_get_udev (p_sys->monitor);
143
144         vlc_cancel (p_sys->thread);
145         vlc_join (p_sys->thread, NULL);
146         udev_monitor_unref (p_sys->monitor);
147         udev_unref (udev);
148     }
149
150     for (size_t i = 0; i < p_sys->itemc; i++)
151         vlc_gc_decref (p_sys->itemv[i]);
152     free (p_sys->itemv);
153     free (p_sys);
154 }
155
156
157 static void *Run (void *data)
158 {
159     services_discovery_t *sd = data;
160     services_discovery_sys_t *p_sys = sd->p_sys;
161     struct udev_monitor *mon = p_sys->monitor;
162
163     int fd = udev_monitor_get_fd (mon);
164     struct pollfd ufd = { .fd = fd, .events = POLLIN, };
165
166     for (;;)
167     {
168         while (poll (&ufd, 1, -1) == -1)
169             if (errno != EINTR)
170                 break;
171
172         struct udev_device *dev = udev_monitor_receive_device (mon);
173         if (dev == NULL)
174             continue;
175
176         /* FIXME: handle change, offline, online */
177         if (!strcmp (udev_device_get_action (dev), "add"))
178             HandleDevice (sd, dev, true);
179         else if (!strcmp (udev_device_get_action (dev), "remove"))
180             HandleDevice (sd, dev, false);
181
182         udev_device_unref (dev);
183     }
184     return NULL;
185 }
186
187 static int hex (char c)
188 {
189     if (c >= '0' && c <= '9')
190         return c - '0';
191     if (c >= 'A' && c <= 'F')
192         return c + 10 - 'A';
193     if (c >= 'a' && c <= 'f')
194         return c + 10 - 'a';
195     return -1;
196 }
197
198 static char *decode (const char *enc)
199 {
200     char *ret = enc ? strdup (enc) : NULL;
201     if (ret == NULL)
202         return NULL;
203
204     char *out = ret;
205     for (const char *in = ret; *in; out++)
206     {
207         int h1, h2;
208
209         if ((in[0] == '\\') && (in[1] == 'x')
210          && ((h1 = hex (in[2])) != -1)
211          && ((h2 = hex (in[3])) != -1))
212         {
213             *out = (h1 << 4) | h2;
214             in += 4;
215         }
216         else
217         {
218             *out = *in;
219             in++;
220         }
221     }
222     *out = 0;
223     return ret;
224 }
225
226 static char *decode_property (struct udev_device *dev, const char *name)
227 {
228     return decode (udev_device_get_property_value (dev, name));
229 }
230
231 static bool is_v4l_legacy (struct udev_device *dev)
232 {
233     const char *version;
234
235     version = udev_device_get_property_value (dev, "ID_V4L_VERSION");
236     return version && !strcmp (version, "1");
237 }
238
239 static void HandleDevice (services_discovery_t *sd, struct udev_device *dev,
240                           bool add)
241 {
242     services_discovery_sys_t *p_sys = sd->p_sys;
243
244     /* Determine media location */
245     const char *scheme = "v4l2";
246     if (is_v4l_legacy (dev))
247         scheme = "v4l";
248     const char *node = udev_device_get_devnode (dev);
249     char *mrl;
250     if (asprintf (&mrl, "%s://%s", scheme, node) == -1)
251         return;
252
253     /* Find item in list */
254     input_item_t *item = NULL;
255     size_t i;
256
257     for (i = 0; i < p_sys->itemc; i++)
258     {
259         input_item_t *oitem = p_sys->itemv[i];
260         char *omrl = input_item_GetURI (oitem);
261
262         if (!strcmp (omrl, mrl))
263         {
264             item = oitem;
265             break;
266         }
267     }
268
269     /* Add/Remove old item */
270     if (add && (item == NULL))
271     {
272         char *vnd = decode_property (dev, "ID_VENDOR_ENC");
273         const char *name = udev_device_get_property_value (dev,
274                                                            "ID_V4L_PRODUCT");
275         item = input_item_NewWithType (VLC_OBJECT (sd), mrl,
276                                        name ? name : "Unnamed",
277                                        0, NULL, 0, -1, ITEM_TYPE_CARD);
278         msg_Dbg (sd, "adding %s", mrl);
279         if (item != NULL)
280         {
281             services_discovery_AddItem (sd, item, vnd ? vnd : "Generic");
282             TAB_APPEND (p_sys->itemc, p_sys->itemv, item);
283         }
284         free (vnd);
285     }
286     else if (!add && (item != NULL))
287     {
288         msg_Dbg (sd, "removing %s", mrl);
289         services_discovery_RemoveItem (sd, item);
290         vlc_gc_decref (item);
291         TAB_REMOVE (p_sys->itemc, p_sys->itemv, i);
292     }
293     free (mrl);
294 }