udev: fix warning
[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 program is free software; you can redistribute it and/or modify it
9  * under the terms of the GNU Lesser General Public License as published by
10  * the Free Software Foundation; either version 2.1 of the License, or
11  * (at your option) any later version.
12  *
13  * This program 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 Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public License
19  * along with this program; if not, write to the Free Software Foundation,
20  * Inc., 51 Franklin Street, 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 <vlc_url.h>
32 #ifdef HAVE_SEARCH_H
33 # include <search.h>
34 #endif
35 #include <poll.h>
36 #include <errno.h>
37
38 static int OpenV4L (vlc_object_t *);
39 #ifdef HAVE_ALSA
40 static int OpenALSA (vlc_object_t *);
41 #endif
42 static int OpenDisc (vlc_object_t *);
43 static void Close (vlc_object_t *);
44 static int vlc_sd_probe_Open (vlc_object_t *);
45
46 /*
47  * Module descriptor
48  */
49 vlc_module_begin ()
50     set_shortname (N_("Video capture"))
51     set_description (N_("Video capture (Video4Linux)"))
52     set_category (CAT_PLAYLIST)
53     set_subcategory (SUBCAT_PLAYLIST_SD)
54     set_capability ("services_discovery", 0)
55     set_callbacks (OpenV4L, Close)
56     add_shortcut ("v4l", "video")
57 #ifdef HAVE_ALSA
58     add_submodule ()
59     set_shortname (N_("Audio capture"))
60     set_description (N_("Audio capture (ALSA)"))
61     set_category (CAT_PLAYLIST)
62     set_subcategory (SUBCAT_PLAYLIST_SD)
63     set_capability ("services_discovery", 0)
64     set_callbacks (OpenALSA, Close)
65     add_shortcut ("alsa", "audio")
66 #endif
67     add_submodule ()
68     set_shortname (N_("Discs"))
69     set_description (N_("Discs"))
70     set_category (CAT_PLAYLIST)
71     set_subcategory (SUBCAT_PLAYLIST_SD)
72     set_capability ("services_discovery", 0)
73     set_callbacks (OpenDisc, Close)
74     add_shortcut ("disc")
75
76     VLC_SD_PROBE_SUBMODULE
77
78 vlc_module_end ()
79
80 static int vlc_sd_probe_Open (vlc_object_t *obj)
81 {
82     vlc_probe_t *probe = (vlc_probe_t *)obj;
83
84     struct udev *udev = udev_new ();
85     if (udev == NULL)
86         return VLC_PROBE_CONTINUE;
87
88     struct udev_monitor *mon = udev_monitor_new_from_netlink (udev, "udev");
89     if (mon != NULL)
90     {
91         vlc_sd_probe_Add (probe, "v4l{longname=\"Video capture\"}",
92                           N_("Video capture"), SD_CAT_DEVICES);
93 #ifdef HAVE_ALSA
94         vlc_sd_probe_Add (probe, "alsa{longname=\"Audio capture\"}",
95                           N_("Audio capture"), SD_CAT_DEVICES);
96 #endif
97         vlc_sd_probe_Add (probe, "disc{longname=\"Discs\"}", N_("Discs"),
98                           SD_CAT_DEVICES);
99         udev_monitor_unref (mon);
100     }
101     udev_unref (udev);
102     return VLC_PROBE_CONTINUE;
103 }
104
105 struct device
106 {
107     dev_t devnum; /* must be first */
108     input_item_t *item;
109     services_discovery_t *sd;
110 };
111
112 struct subsys
113 {
114     const char *name;
115     char * (*get_mrl) (struct udev_device *dev);
116     char * (*get_name) (struct udev_device *dev);
117     int item_type;
118 };
119
120 struct services_discovery_sys_t
121 {
122     const struct subsys *subsys;
123     struct udev_monitor *monitor;
124     vlc_thread_t         thread;
125     void                *root;
126 };
127
128 /**
129  * Compares two devices (to support binary search).
130  */
131 static int cmpdev (const void *a, const void *b)
132 {
133     const dev_t *da = a, *db = b;
134     dev_t delta = *da - *db;
135
136     if (sizeof (delta) > sizeof (int))
137         return delta ? ((delta > 0) ? 1 : -1) : 0;
138     return (signed)delta;
139 }
140
141 static void DestroyDevice (void *data)
142 {
143     struct device *d = data;
144
145     if (d->sd)
146         services_discovery_RemoveItem (d->sd, d->item);
147     vlc_gc_decref (d->item);
148     free (d);
149 }
150
151 static char *decode_property (struct udev_device *, const char *);
152
153 /**
154  * Adds a udev device.
155  */
156 static int AddDevice (services_discovery_t *sd, struct udev_device *dev)
157 {
158     services_discovery_sys_t *p_sys = sd->p_sys;
159
160     char *mrl = p_sys->subsys->get_mrl (dev);
161     if (mrl == NULL)
162         return 0; /* don't know if it was an error... */
163     char *name = p_sys->subsys->get_name (dev);
164     input_item_t *item = input_item_NewWithType (mrl, name ? name : mrl,
165                                                  0, NULL, 0, -1,
166                                                  p_sys->subsys->item_type);
167     msg_Dbg (sd, "adding %s (%s)", mrl, name);
168     free (name);
169     free (mrl);
170     if (item == NULL)
171         return -1;
172
173     struct device *d = malloc (sizeof (*d));
174     if (d == NULL)
175     {
176         vlc_gc_decref (item);
177         return -1;
178     }
179     d->devnum = udev_device_get_devnum (dev);
180     d->item = item;
181     d->sd = NULL;
182
183     struct device **dp = tsearch (d, &p_sys->root, cmpdev);
184     if (dp == NULL) /* Out-of-memory */
185     {
186         DestroyDevice (d);
187         return -1;
188     }
189     if (*dp != d) /* Overwrite existing device */
190     {
191         DestroyDevice (*dp);
192         *dp = d;
193     }
194
195     services_discovery_AddItem (sd, item, NULL);
196     d->sd = sd;
197     return 0;
198 }
199
200 /**
201  * Removes a udev device (if present).
202  */
203 static void RemoveDevice (services_discovery_t *sd, struct udev_device *dev)
204 {
205     services_discovery_sys_t *p_sys = sd->p_sys;
206
207     dev_t num = udev_device_get_devnum (dev);
208     struct device **dp = tfind (&(dev_t){ num }, &p_sys->root, cmpdev);
209     if (dp == NULL)
210         return;
211
212     struct device *d = *dp;
213     tdelete (d, &p_sys->root, cmpdev);
214     DestroyDevice (d);
215 }
216
217 static void *Run (void *);
218
219 /**
220  * Probes and initializes.
221  */
222 static int Open (vlc_object_t *obj, const struct subsys *subsys)
223 {
224     services_discovery_t *sd = (services_discovery_t *)obj;
225     services_discovery_sys_t *p_sys = malloc (sizeof (*p_sys));
226
227     if (p_sys == NULL)
228         return VLC_ENOMEM;
229     sd->p_sys = p_sys;
230     p_sys->subsys = subsys;
231     p_sys->root = NULL;
232
233     struct udev_monitor *mon = NULL;
234     struct udev *udev = udev_new ();
235     if (udev == NULL)
236         goto error;
237
238     mon = udev_monitor_new_from_netlink (udev, "udev");
239     if (mon == NULL
240      || udev_monitor_filter_add_match_subsystem_devtype (mon, subsys->name,
241                                                          NULL))
242         goto error;
243     p_sys->monitor = mon;
244
245     /* Enumerate existing devices */
246     struct udev_enumerate *devenum = udev_enumerate_new (udev);
247     if (devenum == NULL)
248         goto error;
249     if (udev_enumerate_add_match_subsystem (devenum, subsys->name))
250     {
251         udev_enumerate_unref (devenum);
252         goto error;
253     }
254
255     udev_monitor_enable_receiving (mon);
256     /* Note that we enumerate _after_ monitoring is enabled so that we do not
257      * loose device events occuring while we are enumerating. We could still
258      * loose events if the Netlink socket receive buffer overflows. */
259     udev_enumerate_scan_devices (devenum);
260     struct udev_list_entry *devlist = udev_enumerate_get_list_entry (devenum);
261     struct udev_list_entry *deventry;
262     udev_list_entry_foreach (deventry, devlist)
263     {
264         const char *path = udev_list_entry_get_name (deventry);
265         struct udev_device *dev = udev_device_new_from_syspath (udev, path);
266         AddDevice (sd, dev);
267         udev_device_unref (dev);
268     }
269     udev_enumerate_unref (devenum);
270
271     if (vlc_clone (&p_sys->thread, Run, sd, VLC_THREAD_PRIORITY_LOW))
272     {   /* Fallback without thread */
273         udev_monitor_unref (mon);
274         udev_unref (udev);
275         p_sys->monitor = NULL;
276     }
277     return VLC_SUCCESS;
278
279 error:
280     if (mon != NULL)
281         udev_monitor_unref (mon);
282     if (udev != NULL)
283         udev_unref (udev);
284     free (p_sys);
285     return VLC_EGENERIC;
286 }
287
288 /**
289  * Releases resources
290  */
291 static void Close (vlc_object_t *obj)
292 {
293     services_discovery_t *sd = (services_discovery_t *)obj;
294     services_discovery_sys_t *p_sys = sd->p_sys;
295
296     if (p_sys->monitor != NULL)
297     {
298         struct udev *udev = udev_monitor_get_udev (p_sys->monitor);
299
300         vlc_cancel (p_sys->thread);
301         vlc_join (p_sys->thread, NULL);
302         udev_monitor_unref (p_sys->monitor);
303         udev_unref (udev);
304     }
305
306     tdestroy (p_sys->root, DestroyDevice);
307     free (p_sys);
308 }
309
310 static void *Run (void *data)
311 {
312     services_discovery_t *sd = data;
313     services_discovery_sys_t *p_sys = sd->p_sys;
314     struct udev_monitor *mon = p_sys->monitor;
315
316     int fd = udev_monitor_get_fd (mon);
317     struct pollfd ufd = { .fd = fd, .events = POLLIN, };
318
319     for (;;)
320     {
321         while (poll (&ufd, 1, -1) == -1)
322             if (errno != EINTR)
323                 break;
324
325         int canc = vlc_savecancel ();
326         struct udev_device *dev = udev_monitor_receive_device (mon);
327         if (dev == NULL)
328             continue;
329
330         const char *action = udev_device_get_action (dev);
331         if (!strcmp (action, "add"))
332             AddDevice (sd, dev);
333         else if (!strcmp (action, "remove"))
334             RemoveDevice (sd, dev);
335         else if (!strcmp (action, "change"))
336         {
337             RemoveDevice (sd, dev);
338             AddDevice (sd, dev);
339         }
340         udev_device_unref (dev);
341         vlc_restorecancel (canc);
342     }
343     return NULL;
344 }
345
346 /**
347  * Converts an hexadecimal digit to an integer.
348  */
349 static int hex (char c)
350 {
351     if (c >= '0' && c <= '9')
352         return c - '0';
353     if (c >= 'A' && c <= 'F')
354         return c + 10 - 'A';
355     if (c >= 'a' && c <= 'f')
356         return c + 10 - 'a';
357     return -1;
358 }
359
360 /**
361  * Decodes a udev hexadecimal-encoded property.
362  */
363 static char *decode (const char *enc)
364 {
365     char *ret = enc ? strdup (enc) : NULL;
366     if (ret == NULL)
367         return NULL;
368
369     char *out = ret;
370     for (const char *in = ret; *in; out++)
371     {
372         int h1, h2;
373
374         if ((in[0] == '\\') && (in[1] == 'x')
375          && ((h1 = hex (in[2])) != -1)
376          && ((h2 = hex (in[3])) != -1))
377         {
378             *out = (h1 << 4) | h2;
379             in += 4;
380         }
381         else
382         {
383             *out = *in;
384             in++;
385         }
386     }
387     *out = 0;
388     return ret;
389 }
390
391 static char *decode_property (struct udev_device *dev, const char *name)
392 {
393     return decode (udev_device_get_property_value (dev, name));
394 }
395
396
397 /*** Video4Linux support ***/
398 static bool v4l_is_legacy (struct udev_device *dev)
399 {
400     const char *version;
401
402     version = udev_device_get_property_value (dev, "ID_V4L_VERSION");
403     return (version != NULL) && !strcmp (version, "1");
404 }
405
406 static bool v4l_can_capture (struct udev_device *dev)
407 {
408     const char *caps;
409
410     caps = udev_device_get_property_value (dev, "ID_V4L_CAPABILITIES");
411     return (caps != NULL) && (strstr (caps, ":capture:") != NULL);
412 }
413
414 static char *v4l_get_mrl (struct udev_device *dev)
415 {
416     /* Determine media location */
417     if (v4l_is_legacy (dev) || !v4l_can_capture (dev))
418         return NULL;
419
420     const char *node = udev_device_get_devnode (dev);
421     char *mrl;
422
423     if (asprintf (&mrl, "v4l2://%s", node) == -1)
424         mrl = NULL;
425     return mrl;
426 }
427
428 static char *v4l_get_name (struct udev_device *dev)
429 {
430     const char *prd = udev_device_get_property_value (dev, "ID_V4L_PRODUCT");
431     return prd ? strdup (prd) : NULL;
432 }
433
434 int OpenV4L (vlc_object_t *obj)
435 {
436     static const struct subsys subsys = {
437         "video4linux", v4l_get_mrl, v4l_get_name, ITEM_TYPE_CARD,
438     };
439
440     return Open (obj, &subsys);
441 }
442
443
444 #ifdef HAVE_ALSA
445 /*** Advanced Linux Sound Architecture support ***/
446 #include <alsa/asoundlib.h>
447
448 static int alsa_get_device (struct udev_device *dev, unsigned *restrict pcard,
449                             unsigned *restrict pdevice)
450 {
451     const char *node = udev_device_get_devpath (dev);
452     char type;
453
454     node = strrchr (node, '/');
455     if (node == NULL)
456         return -1;
457     if (sscanf (node, "/pcmC%uD%u%c", pcard, pdevice, &type) < 3)
458         return -1;
459     if (type != 'c')
460         return -1;
461     return 0;
462 }
463
464
465 static char *alsa_get_mrl (struct udev_device *dev)
466 {
467     /* Determine media location */
468     char *mrl;
469     unsigned card, device;
470
471     if (alsa_get_device (dev, &card, &device))
472         return NULL;
473
474     if (asprintf (&mrl, "alsa://plughw:%u,%u", card, device) == -1)
475         mrl = NULL;
476     return mrl;
477 }
478
479 static char *alsa_get_name (struct udev_device *dev)
480 {
481     char *name = NULL;
482     unsigned card, device;
483
484     if (alsa_get_device (dev, &card, &device))
485         return NULL;
486
487     char card_name[4 + 3 * sizeof (int)];
488     snprintf (card_name, sizeof (card_name), "hw:%u", card);
489
490     snd_ctl_t *ctl;
491     if (snd_ctl_open (&ctl, card_name, 0))
492         return NULL;
493
494     snd_pcm_info_t *pcm_info;
495     snd_pcm_info_alloca (&pcm_info);
496     snd_pcm_info_set_device (pcm_info, device);
497     snd_pcm_info_set_subdevice (pcm_info, 0);
498     snd_pcm_info_set_stream (pcm_info, SND_PCM_STREAM_CAPTURE);
499     if (snd_ctl_pcm_info (ctl, pcm_info))
500         goto out;
501
502     name = strdup (snd_pcm_info_get_name (pcm_info));
503 out:
504     snd_ctl_close (ctl);
505     return name;
506 }
507
508 int OpenALSA (vlc_object_t *obj)
509 {
510     static const struct subsys subsys = {
511         "sound", alsa_get_mrl, alsa_get_name, ITEM_TYPE_CARD,
512     };
513
514     return Open (obj, &subsys);
515 }
516 #endif /* HAVE_ALSA */
517
518
519 /*** Discs support ***/
520 static char *disc_get_mrl (struct udev_device *dev)
521 {
522     const char *val;
523
524     val = udev_device_get_property_value (dev, "ID_CDROM");
525     if (val == NULL)
526         return NULL; /* Ignore non-optical block devices */
527
528     val = udev_device_get_property_value (dev, "ID_CDROM_MEDIA_STATE");
529     if (val && !strcmp (val, "blank"))
530         return NULL; /* ignore empty drives and virgin recordable discs */
531
532     const char *scheme = NULL;
533     val = udev_device_get_property_value (dev,
534                                           "ID_CDROM_MEDIA_TRACK_COUNT_AUDIO");
535     if (val && atoi (val))
536         scheme = "cdda"; /* Audio CD rather than file system */
537     val = udev_device_get_property_value (dev, "ID_CDROM_MEDIA_DVD");
538     if (val && atoi (val))
539         scheme = "dvd";
540
541     val = udev_device_get_property_value (dev, "ID_CDROM_MEDIA_BD");
542     if (val && atoi (val))
543         scheme = "bluray";
544 #ifdef LOL
545     val = udev_device_get_property_value (dev, "ID_CDROM_MEDIA_HDDVD");
546     if (val && atoi (val))
547         scheme = "hddvd";
548 #endif
549
550     /* We didn't get any property that could tell we have optical disc
551        that we can play */
552     if (scheme == NULL)
553         return NULL;
554
555     val = udev_device_get_devnode (dev);
556     return make_URI (val, scheme);
557 }
558
559 static char *disc_get_name (struct udev_device *dev)
560 {
561     char *name = NULL;
562     struct udev_list_entry *list, *entry;
563
564     list = udev_device_get_properties_list_entry (dev);
565     if (unlikely(list == NULL))
566         return NULL;
567
568     const char *cat = NULL;
569     udev_list_entry_foreach (entry, list)
570     {
571         const char *name = udev_list_entry_get_name (entry);
572
573         if (strncmp (name, "ID_CDROM_MEDIA_", 15))
574             continue;
575         if (!atoi (udev_list_entry_get_value (entry)))
576             continue;
577         name += 15;
578
579         if (!strncmp (name, "CD", 2))
580             cat = N_("CD");
581         else if (!strncmp (name, "DVD", 3))
582             cat = N_("DVD");
583         else if (!strncmp (name, "BD", 2))
584             cat = N_("Blu-Ray");
585         else if (!strncmp (name, "HDDVD", 5))
586             cat = N_("HD DVD");
587
588         if (cat != NULL)
589             break;
590     }
591
592     if (cat == NULL)
593         cat = N_("Unknown type");
594
595     char *label = decode_property (dev, "ID_FS_LABEL_ENC");
596
597     if (label)
598         if (asprintf(&name, "%s (%s)", label, vlc_gettext(cat)) < 0)
599             name = NULL;
600     free(label);
601
602     return name;
603 }
604
605 int OpenDisc (vlc_object_t *obj)
606 {
607     static const struct subsys subsys = {
608         "block", disc_get_mrl, disc_get_name, ITEM_TYPE_DISC,
609     };
610
611     return Open (obj, &subsys);
612 }