udev: handle "change" action properly, fix disc ejection/insertion
[vlc.git] / modules / services_discovery / udev.c
index 9e07d61..93e0857 100644 (file)
 #include <vlc_common.h>
 #include <vlc_services_discovery.h>
 #include <vlc_plugin.h>
+#include <search.h>
 #include <poll.h>
 #include <errno.h>
 
-static int  Open (vlc_object_t *);
+static int OpenV4L (vlc_object_t *);
+static int OpenDisc (vlc_object_t *);
 static void Close (vlc_object_t *);
 
 /*
@@ -43,32 +45,148 @@ vlc_module_begin ()
     set_category (CAT_PLAYLIST)
     set_subcategory (SUBCAT_PLAYLIST_SD)
     set_capability ("services_discovery", 0)
-    set_callbacks (Open, Close)
+    set_callbacks (OpenV4L, Close)
+    add_shortcut ("v4l")
+
+    add_submodule ()
+    set_shortname (N_("Discs"))
+    set_description (N_("Discs"))
+    set_category (CAT_PLAYLIST)
+    set_subcategory (SUBCAT_PLAYLIST_SD)
+    set_capability ("services_discovery", 0)
+    set_callbacks (OpenDisc, Close)
+    add_shortcut ("disc")
 
-    add_shortcut ("udev")
 vlc_module_end ()
 
+struct device
+{
+    dev_t devnum; /* must be first */
+    input_item_t *item;
+};
+
+struct subsys
+{
+    const char *name;
+    char * (*get_mrl) (struct udev_device *dev);
+    char * (*get_name) (struct udev_device *dev);
+    char * (*get_cat) (struct udev_device *dev);
+    int item_type;
+};
+
 struct services_discovery_sys_t
 {
+    const struct subsys *subsys;
     struct udev_monitor *monitor;
     vlc_thread_t         thread;
+    void                *root;
 };
 
+/**
+ * Compares two devices (to support binary search).
+ */
+static int cmpdev (const void *a, const void *b)
+{
+    const dev_t *da = a, *db = b;
+    dev_t delta = *da - *db;
+
+    if (sizeof (delta) > sizeof (int))
+        return delta ? ((delta > 0) ? 1 : -1) : 0;
+    return (signed)delta;
+}
+
+static void DestroyDevice (void *data)
+{
+    struct device *d = data;
+
+    vlc_gc_decref (d->item);
+    free (d);
+}
+
+static char *decode_property (struct udev_device *, const char *);
+
+/**
+ * Adds a udev device.
+ */
+static int AddDevice (services_discovery_t *sd, struct udev_device *dev)
+{
+    services_discovery_sys_t *p_sys = sd->p_sys;
+
+    char *mrl = p_sys->subsys->get_mrl (dev);
+    if (mrl == NULL)
+        return 0; /* don't know if it was an error... */
+    char *name = p_sys->subsys->get_name (dev);
+    input_item_t *item = input_item_NewWithType (VLC_OBJECT (sd), mrl,
+                                                 name ? name : mrl,
+                                                 0, NULL, 0, -1,
+                                                 p_sys->subsys->item_type);
+    msg_Dbg (sd, "adding %s (%s)", mrl, name);
+    free (name);
+    free (mrl);
+    if (item == NULL)
+        return -1;
+
+    struct device *d = malloc (sizeof (*d));
+    if (d == NULL)
+    {
+        vlc_gc_decref (item);
+        return -1;
+    }
+    d->item = item;
+    d->devnum = udev_device_get_devnum (dev);
+
+    struct device **dp = tsearch (d, &p_sys->root, cmpdev);
+    if (dp == NULL) /* Out-of-memory */
+    {
+        DestroyDevice (d);
+        return -1;
+    }
+    if (*dp != d) /* Overwrite existing device */
+    {
+        services_discovery_RemoveItem (sd, (*dp)->item);
+        DestroyDevice (*dp);
+        *dp = d;
+    }
+
+    name = p_sys->subsys->get_cat (dev);
+    services_discovery_AddItem (sd, item, name ? name : "Generic");
+    free (name);
+    return 0;
+}
+
+/**
+ * Removes a udev device (if present).
+ */
+static void RemoveDevice (services_discovery_t *sd, struct udev_device *dev)
+{
+    services_discovery_sys_t *p_sys = sd->p_sys;
+
+    dev_t num = udev_device_get_devnum (dev);
+    struct device **dp = tfind (&(dev_t){ num }, &p_sys->root, cmpdev);
+    if (dp == NULL)
+        return;
+
+    struct device *d = *dp;
+    services_discovery_RemoveItem (sd, d->item);
+    tdelete (d, &p_sys->root, cmpdev);
+    DestroyDevice (d);
+}
+
 static void *Run (void *);
-static void HandleDevice (services_discovery_t *, struct udev_device *, bool);
 
 /**
  * Probes and initializes.
  */
-static int Open (vlc_object_t *obj)
+static int Open (vlc_object_t *obj, const struct subsys *subsys)
 {
-    const char subsys[] = "video4linux";
     services_discovery_t *sd = (services_discovery_t *)obj;
     services_discovery_sys_t *p_sys = malloc (sizeof (*p_sys));
 
     if (p_sys == NULL)
         return VLC_ENOMEM;
     sd->p_sys = p_sys;
+    p_sys->subsys = subsys;
+    p_sys->root = NULL;
 
     struct udev_monitor *mon = NULL;
     struct udev *udev = udev_new ();
@@ -77,7 +195,8 @@ static int Open (vlc_object_t *obj)
 
     mon = udev_monitor_new_from_netlink (udev, "udev");
     if (mon == NULL
-     || udev_monitor_filter_add_match_subsystem_devtype (mon, subsys, NULL))
+     || udev_monitor_filter_add_match_subsystem_devtype (mon, subsys->name,
+                                                         NULL))
         goto error;
     p_sys->monitor = mon;
 
@@ -85,7 +204,7 @@ static int Open (vlc_object_t *obj)
     struct udev_enumerate *devenum = udev_enumerate_new (udev);
     if (devenum == NULL)
         goto error;
-    if (udev_enumerate_add_match_subsystem (devenum, subsys))
+    if (udev_enumerate_add_match_subsystem (devenum, subsys->name))
     {
         udev_enumerate_unref (devenum);
         goto error;
@@ -102,13 +221,17 @@ static int Open (vlc_object_t *obj)
     {
         const char *path = udev_list_entry_get_name (deventry);
         struct udev_device *dev = udev_device_new_from_syspath (udev, path);
-        HandleDevice (sd, dev, true);
+        AddDevice (sd, dev);
         udev_device_unref (dev);
     }
     udev_enumerate_unref (devenum);
 
     if (vlc_clone (&p_sys->thread, Run, sd, VLC_THREAD_PRIORITY_LOW))
-        goto error;
+    {   /* Fallback without thread */
+        udev_monitor_unref (mon);
+        udev_unref (udev);
+        p_sys->monitor = NULL;
+    }
     return VLC_SUCCESS;
 
 error:
@@ -120,7 +243,6 @@ error:
     return VLC_EGENERIC;
 }
 
-
 /**
  * Releases resources
  */
@@ -128,16 +250,21 @@ static void Close (vlc_object_t *obj)
 {
     services_discovery_t *sd = (services_discovery_t *)obj;
     services_discovery_sys_t *p_sys = sd->p_sys;
-    struct udev *udev = udev_monitor_get_udev (p_sys->monitor);
 
-    vlc_cancel (p_sys->thread);
-    vlc_join (p_sys->thread, NULL);
-    udev_monitor_unref (p_sys->monitor);
-    udev_unref (udev);
+    if (p_sys->monitor != NULL)
+    {
+        struct udev *udev = udev_monitor_get_udev (p_sys->monitor);
+
+        vlc_cancel (p_sys->thread);
+        vlc_join (p_sys->thread, NULL);
+        udev_monitor_unref (p_sys->monitor);
+        udev_unref (udev);
+    }
+
+    tdestroy (p_sys->root, DestroyDevice);
     free (p_sys);
 }
 
-
 static void *Run (void *data)
 {
     services_discovery_t *sd = data;
@@ -157,17 +284,24 @@ static void *Run (void *data)
         if (dev == NULL)
             continue;
 
-        /* FIXME: handle change, offline, online */
-        if (!strcmp (udev_device_get_action (dev), "add"))
-            HandleDevice (sd, dev, true);
-        else if (!strcmp (udev_device_get_action (dev), "remove"))
-            HandleDevice (sd, dev, false);
-
+        const char *action = udev_device_get_action (dev);
+        if (!strcmp (action, "add"))
+            AddDevice (sd, dev);
+        else if (!strcmp (action, "remove"))
+            RemoveDevice (sd, dev);
+        else if (!strcmp (action, "change"))
+        {
+            RemoveDevice (sd, dev);
+            AddDevice (sd, dev);
+        }
         udev_device_unref (dev);
     }
     return NULL;
 }
 
+/**
+ * Converts an hexadecimal digit to an integer.
+ */
 static int hex (char c)
 {
     if (c >= '0' && c <= '9')
@@ -179,6 +313,9 @@ static int hex (char c)
     return -1;
 }
 
+/**
+ * Decodes a udev hexadecimal-encoded property.
+ */
 static char *decode (const char *enc)
 {
     char *ret = enc ? strdup (enc) : NULL;
@@ -212,6 +349,7 @@ static char *decode_property (struct udev_device *dev, const char *name)
     return decode (udev_device_get_property_value (dev, name));
 }
 
+/*** Video4Linux support ***/
 static bool is_v4l_legacy (struct udev_device *dev)
 {
     const char *version;
@@ -220,40 +358,111 @@ static bool is_v4l_legacy (struct udev_device *dev)
     return version && !strcmp (version, "1");
 }
 
-static void HandleDevice (services_discovery_t *sd, struct udev_device *dev,
-                          bool add)
+static char *v4l_get_mrl (struct udev_device *dev)
 {
-    //services_discovery_sys_t *p_sys = sd->p_sys;
-    if (!add)
-    {
-        msg_Err (sd, "FIXME: removing device not implemented!");
-        return;
-    }
-
+    /* Determine media location */
     const char *scheme = "v4l2";
     if (is_v4l_legacy (dev))
         scheme = "v4l";
     const char *node = udev_device_get_devnode (dev);
-    char *vnd = decode_property (dev, "ID_VENDOR_ENC");
-    const char *name = udev_device_get_property_value (dev, "ID_V4L_PRODUCT");
-
     char *mrl;
+
     if (asprintf (&mrl, "%s://%s", scheme, node) == -1)
-        return;
+        mrl = NULL;
+    return mrl;
+}
 
-    /* FIXME: check for duplicates (race between monitor starting to receive
-     * and initial enumeration). */
-    input_item_t *item;
-    item = input_item_NewWithType (VLC_OBJECT (sd), mrl,
-                                   name ? name : "Unnamed",
-                                   0, NULL, 0, -1, ITEM_TYPE_CARD);
-    msg_Dbg (sd, "adding %s", mrl);
-    free (mrl);
+static char *v4l_get_name (struct udev_device *dev)
+{
+    const char *prd = udev_device_get_property_value (dev, "ID_V4L_PRODUCT");
+    return prd ? strdup (prd) : NULL;
+}
 
-    if (item != NULL)
-    {
-        services_discovery_AddItem (sd, item, vnd ? vnd : "Generic");
-        vlc_gc_decref (item);
-    }
-    free (vnd);
+static char *v4l_get_cat (struct udev_device *dev)
+{
+    return decode_property (dev, "ID_VENDOR_ENC");
+}
+
+int OpenV4L (vlc_object_t *obj)
+{
+    static const struct subsys subsys = {
+        "video4linux", v4l_get_mrl, v4l_get_name, v4l_get_cat, ITEM_TYPE_CARD,
+    };
+
+    return Open (obj, &subsys);
+}
+
+/*** Discs support ***/
+static char *disc_get_mrl (struct udev_device *dev)
+{
+    const char *val;
+
+    val = udev_device_get_property_value (dev, "ID_CDROM");
+    if (val == NULL)
+        return NULL; /* Ignore non-optical block devices */
+
+    val = udev_device_get_property_value (dev, "ID_CDROM_MEDIA_STATE");
+    if ((val == NULL) || !strcmp (val, "blank"))
+        return NULL; /* ignore empty drives and virgin recordable discs */
+
+    const char *scheme = "file";
+    val = udev_device_get_property_value (dev,
+                                          "ID_CDROM_MEDIA_TRACK_COUNT_AUDIO");
+    if (val && atoi (val))
+        scheme = "cdda"; /* Audio CD rather than file system */
+#if 0 /* we can use file:// for DVDs */
+    val = udev_device_get_property_value (dev, "ID_CDROM_MEDIA_DVD");
+    if (val && atoi (val))
+        scheme = "dvd";
+#endif
+    val = udev_device_get_property_value (dev, "ID_CDROM_MEDIA_BD");
+    if (val && atoi (val))
+        scheme = "bd";
+#ifdef LOL
+    val = udev_device_get_property_value (dev, "ID_CDROM_MEDIA_HDDVD");
+    if (val && atoi (val))
+        scheme = "hddvd";
+#endif
+
+    val = udev_device_get_devnode (dev);
+    char *mrl;
+
+    if (asprintf (&mrl, "%s://%s", scheme, val) == -1)
+        mrl = NULL;
+    return mrl;
+}
+
+static char *disc_get_name (struct udev_device *dev)
+{
+    return decode_property (dev, "ID_FS_LABEL_ENC");
+}
+
+static char *disc_get_cat (struct udev_device *dev)
+{
+    const char *val;
+    const char *cat = "Unknown";
+
+    val = udev_device_get_property_value (dev, "ID_CDROM_MEDIA_CD");
+    if (val && atoi (val))
+        cat = "CD";
+    val = udev_device_get_property_value (dev, "ID_CDROM_MEDIA_DVD");
+    if (val && atoi (val))
+        cat = "DVD";
+    val = udev_device_get_property_value (dev, "ID_CDROM_MEDIA_BD");
+    if (val && atoi (val))
+        cat = "Blue-ray disc";
+    val = udev_device_get_property_value (dev, "ID_CDROM_MEDIA_HDDVD");
+    if (val && atoi (val))
+        cat = "HD DVD";
+
+    return strdup (cat);
+}
+
+int OpenDisc (vlc_object_t *obj)
+{
+    static const struct subsys subsys = {
+        "block", disc_get_mrl, disc_get_name, disc_get_cat, ITEM_TYPE_DISC,
+    };
+
+    return Open (obj, &subsys);
 }