Split media_device creation and opening
[media-ctl.git] / src / mediactl.c
index 7c3adbe..2b054e9 100644 (file)
@@ -1,20 +1,22 @@
 /*
- * Media controller test application
+ * Media controller interface library
  *
- * Copyright (C) 2010 Ideas on board SPRL <laurent.pinchart@ideasonboard.com>
+ * Copyright (C) 2010-2011 Ideas on board SPRL
+ *
+ * Contact: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
  *
  * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
+ * it under the terms of the GNU Lesser General Public License as published
+ * by the Free Software Foundation; either version 2.1 of the License, or
  * (at your option) any later version.
  *
  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
+ * GNU Lesser General Public License for more details.
  *
- * You should have received a copy of the GNU General Public License along
- * with this program; if not, write to the Free Software Foundation, Inc.,
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
 
 #include "config.h"
 #include <sys/stat.h>
 #include <sys/types.h>
 
-#include <unistd.h>
+#include <ctype.h>
+#include <errno.h>
+#include <fcntl.h>
+#include <stdbool.h>
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
-#include <fcntl.h>
-#include <errno.h>
+#include <unistd.h>
 
-#include <linux/videodev2.h>
 #include <linux/media.h>
+#include <linux/videodev2.h>
 
 #include "mediactl.h"
 #include "tools.h"
 
-#ifdef DEBUG
-#define dprintf(...) printf(__VA_ARGS__)
-#else
-#define dprintf(...)
-#endif
-
 struct media_pad *media_entity_remote_source(struct media_pad *pad)
 {
        unsigned int i;
@@ -67,10 +65,17 @@ struct media_entity *media_get_entity_by_name(struct media_device *media,
 {
        unsigned int i;
 
+       /* A match is impossible if the entity name is longer than the maximum
+        * size we can get from the kernel.
+        */
+       if (length >= FIELD_SIZEOF(struct media_entity_desc, name))
+               return NULL;
+
        for (i = 0; i < media->entities_count; ++i) {
                struct media_entity *entity = &media->entities[i];
 
-               if (strncmp(entity->info.name, name, length) == 0)
+               if (strncmp(entity->info.name, name, length) == 0 &&
+                   entity->info.name[length] == '\0')
                        return entity;
        }
 
@@ -80,18 +85,58 @@ struct media_entity *media_get_entity_by_name(struct media_device *media,
 struct media_entity *media_get_entity_by_id(struct media_device *media,
                                            __u32 id)
 {
+       bool next = id & MEDIA_ENT_ID_FLAG_NEXT;
        unsigned int i;
 
+       id &= ~MEDIA_ENT_ID_FLAG_NEXT;
+
        for (i = 0; i < media->entities_count; ++i) {
                struct media_entity *entity = &media->entities[i];
 
-               if (entity->info.id == id)
+               if ((entity->info.id == id && !next) ||
+                   (entity->info.id > id && next))
                        return entity;
        }
 
        return NULL;
 }
 
+/* -----------------------------------------------------------------------------
+ * Open/close
+ */
+
+static int media_device_open(struct media_device *media)
+{
+       int ret;
+
+       if (media->fd != -1)
+               return 0;
+
+       media_dbg(media, "Opening media device %s\n", media->devnode);
+
+       media->fd = open(media->devnode, O_RDWR);
+       if (media->fd < 0) {
+               ret = -errno;
+               media_dbg(media, "%s: Can't open media device %s\n",
+                         __func__, media->devnode);
+               return ret;
+       }
+
+       return 0;
+}
+
+static void media_device_close(struct media_device *media)
+{
+       if (media->fd != -1) {
+               close(media->fd);
+               media->fd = -1;
+       }
+}
+
+/* -----------------------------------------------------------------------------
+ * Link setup
+ */
+
 int media_setup_link(struct media_device *media,
                     struct media_pad *source,
                     struct media_pad *sink,
@@ -102,6 +147,10 @@ int media_setup_link(struct media_device *media,
        unsigned int i;
        int ret;
 
+       ret = media_device_open(media);
+       if (ret < 0)
+               goto done;
+
        for (i = 0; i < source->entity->num_links; i++) {
                link = &source->entity->links[i];
 
@@ -113,8 +162,9 @@ int media_setup_link(struct media_device *media,
        }
 
        if (i == source->entity->num_links) {
-               dprintf("%s: Link not found\n", __func__);
-               return -ENOENT;
+               media_dbg(media, "%s: Link not found\n", __func__);
+               ret = -ENOENT;
+               goto done;
        }
 
        /* source pad */
@@ -131,14 +181,20 @@ int media_setup_link(struct media_device *media,
 
        ret = ioctl(media->fd, MEDIA_IOC_SETUP_LINK, &ulink);
        if (ret == -1) {
-               dprintf("%s: Unable to setup link (%s)\n", __func__,
-                       strerror(errno));
-               return -errno;
+               ret = -errno;
+               media_dbg(media, "%s: Unable to setup link (%s)\n",
+                         __func__, strerror(errno));
+               goto done;
        }
 
        link->flags = ulink.flags;
        link->twin->flags = ulink.flags;
-       return 0;
+
+       ret = 0;
+
+done:
+       media_device_close(media);
+       return ret;
 }
 
 int media_reset_links(struct media_device *media)
@@ -198,15 +254,17 @@ static int media_enum_links(struct media_device *media)
                unsigned int i;
 
                links.entity = entity->info.id;
-               links.pads = malloc(entity->info.pads * sizeof(struct media_pad_desc));
-               links.links = malloc(entity->info.links * sizeof(struct media_link_desc));
+               links.pads = calloc(entity->info.pads, sizeof(struct media_pad_desc));
+               links.links = calloc(entity->info.links, sizeof(struct media_link_desc));
 
                if (ioctl(media->fd, MEDIA_IOC_ENUM_LINKS, &links) < 0) {
-                       dprintf("%s: Unable to enumerate pads and links (%s).\n",
-                               __func__, strerror(errno));
+                       ret = -errno;
+                       media_dbg(media,
+                                 "%s: Unable to enumerate pads and links (%s).\n",
+                                 __func__, strerror(errno));
                        free(links.pads);
                        free(links.links);
-                       return -errno;
+                       return ret;
                }
 
                for (i = 0; i < entity->info.pads; ++i) {
@@ -226,9 +284,12 @@ static int media_enum_links(struct media_device *media)
                        sink = media_get_entity_by_id(media, link->sink.entity);
 
                        if (source == NULL || sink == NULL) {
-                               dprintf("WARNING entity %u link %u from %u/%u to %u/%u is invalid!\n",
-                                       id, i, link->source.entity, link->source.index,
-                                       link->sink.entity, link->sink.index);
+                               media_dbg(media,
+                                         "WARNING entity %u link %u from %u/%u to %u/%u is invalid!\n",
+                                         id, i, link->source.entity,
+                                         link->source.index,
+                                         link->sink.entity,
+                                         link->sink.index);
                                ret = -EINVAL;
                        } else {
                                fwdlink = media_entity_add_link(source);
@@ -272,7 +333,7 @@ static inline void media_udev_close(struct udev *udev)
 }
 
 static int media_get_devname_udev(struct udev *udev,
-               struct media_entity *entity, int verbose)
+               struct media_entity *entity)
 {
        struct udev_device *device;
        dev_t devnum;
@@ -283,8 +344,8 @@ static int media_get_devname_udev(struct udev *udev,
                return -EINVAL;
 
        devnum = makedev(entity->info.v4l.major, entity->info.v4l.minor);
-       if (verbose)
-               printf("looking up device: %u:%u\n", major(devnum), minor(devnum));
+       media_dbg(entity->media, "looking up device: %u:%u\n",
+                 major(devnum), minor(devnum));
        device = udev_device_new_from_devnum(udev, 'c', devnum);
        if (device) {
                p = udev_device_get_devnode(device);
@@ -309,7 +370,7 @@ static inline int media_udev_open(struct udev **udev) { return 0; }
 static inline void media_udev_close(struct udev *udev) { }
 
 static inline int media_get_devname_udev(struct udev *udev,
-               struct media_entity *entity, int verbose)
+               struct media_entity *entity)
 {
        return -ENOTSUP;
 }
@@ -352,7 +413,7 @@ static int media_get_devname_sysfs(struct media_entity *entity)
        return 0;
 }
 
-static int media_enum_entities(struct media_device *media, int verbose)
+static int media_enum_entities(struct media_device *media)
 {
        struct media_entity *entity;
        struct udev *udev;
@@ -362,7 +423,7 @@ static int media_enum_entities(struct media_device *media, int verbose)
 
        ret = media_udev_open(&udev);
        if (ret < 0)
-               printf("%s: Can't get udev context\n", __func__);
+               media_dbg(media, "Can't get udev context\n");
 
        for (id = 0, ret = 0; ; id = entity->info.id) {
                size = (media->entities_count + 1) * sizeof(*media->entities);
@@ -372,6 +433,7 @@ static int media_enum_entities(struct media_device *media, int verbose)
                memset(entity, 0, sizeof(*entity));
                entity->fd = -1;
                entity->info.id = id | MEDIA_ENT_ID_FLAG_NEXT;
+               entity->media = media;
 
                ret = ioctl(media->fd, MEDIA_IOC_ENUM_ENTITIES, &entity->info);
                if (ret < 0) {
@@ -400,7 +462,7 @@ static int media_enum_entities(struct media_device *media, int verbose)
                        continue;
 
                /* Try to get the device name via udev */
-               if (!media_get_devname_udev(udev, entity, verbose))
+               if (!media_get_devname_udev(udev, entity))
                        continue;
 
                /* Fall back to get the device name via sysfs */
@@ -411,61 +473,111 @@ static int media_enum_entities(struct media_device *media, int verbose)
        return ret;
 }
 
-struct media_device *media_open(const char *name, int verbose)
+int media_device_enumerate(struct media_device *media)
 {
-       struct media_device *media;
        int ret;
 
-       media = calloc(1, sizeof(*media));
-       if (media == NULL) {
-               dprintf("%s: unable to allocate memory\n", __func__);
-               return NULL;
-       }
+       if (media->entities)
+               return 0;
 
-       if (verbose)
-               dprintf("Opening media device %s\n", name);
+       ret = media_device_open(media);
+       if (ret < 0)
+               return ret;
 
-       media->fd = open(name, O_RDWR);
-       if (media->fd < 0) {
-               media_close(media);
-               dprintf("%s: Can't open media device %s\n", __func__, name);
-               return NULL;
+       ret = ioctl(media->fd, MEDIA_IOC_DEVICE_INFO, &media->info);
+       if (ret < 0) {
+               ret = -errno;
+               media_dbg(media, "%s: Unable to retrieve media device "
+                         "information for device %s (%s)\n", __func__,
+                         media->devnode, strerror(errno));
+               goto done;
        }
 
-       if (verbose)
-               dprintf("Enumerating entities\n");
-
-       ret = media_enum_entities(media, verbose);
+       media_dbg(media, "Enumerating entities\n");
 
+       ret = media_enum_entities(media);
        if (ret < 0) {
-               dprintf("%s: Unable to enumerate entities for device %s (%s)\n",
-                       __func__, name, strerror(-ret));
-               media_close(media);
-               return NULL;
+               media_dbg(media,
+                         "%s: Unable to enumerate entities for device %s (%s)\n",
+                         __func__, media->devnode, strerror(-ret));
+               goto done;
        }
 
-       if (verbose) {
-               dprintf("Found %u entities\n", media->entities_count);
-               dprintf("Enumerating pads and links\n");
-       }
+       media_dbg(media, "Found %u entities\n", media->entities_count);
+       media_dbg(media, "Enumerating pads and links\n");
 
        ret = media_enum_links(media);
        if (ret < 0) {
-               dprintf("%s: Unable to enumerate pads and linksfor device %s\n",
-                       __func__, name);
-               media_close(media);
+               media_dbg(media,
+                         "%s: Unable to enumerate pads and linksfor device %s\n",
+                         __func__, media->devnode);
+               goto done;
+       }
+
+       ret = 0;
+
+done:
+       media_device_close(media);
+       return ret;
+}
+
+/* -----------------------------------------------------------------------------
+ * Create/destroy
+ */
+
+static void media_debug_default(void *ptr, ...)
+{
+}
+
+void media_debug_set_handler(struct media_device *media,
+                            void (*debug_handler)(void *, ...),
+                            void *debug_priv)
+{
+       if (debug_handler) {
+               media->debug_handler = debug_handler;
+               media->debug_priv = debug_priv;
+       } else {
+               media->debug_handler = media_debug_default;
+               media->debug_priv = NULL;
+       }
+}
+
+struct media_device *media_device_new(const char *devnode)
+{
+       struct media_device *media;
+       int ret;
+
+       media = calloc(1, sizeof(*media));
+       if (media == NULL)
+               return NULL;
+
+       media->fd = -1;
+       media->refcount = 1;
+
+       media_debug_set_handler(media, NULL, NULL);
+
+       media->devnode = strdup(devnode);
+       if (media->devnode == NULL) {
+               media_device_unref(media);
                return NULL;
        }
 
        return media;
 }
 
-void media_close(struct media_device *media)
+struct media_device *media_device_ref(struct media_device *media)
+{
+       media->refcount++;
+       return media;
+}
+
+void media_device_unref(struct media_device *media)
 {
        unsigned int i;
 
-       if (media->fd != -1)
-               close(media->fd);
+       media->refcount--;
+       if (media->refcount > 0)
+               return;
 
        for (i = 0; i < media->entities_count; ++i) {
                struct media_entity *entity = &media->entities[i];
@@ -477,9 +589,14 @@ void media_close(struct media_device *media)
        }
 
        free(media->entities);
+       free(media->devnode);
        free(media);
 }
 
+/* -----------------------------------------------------------------------------
+ * Parsing
+ */
+
 struct media_pad *media_parse_pad(struct media_device *media,
                                  const char *p, char **endp)
 {
@@ -487,39 +604,60 @@ struct media_pad *media_parse_pad(struct media_device *media,
        struct media_entity *entity;
        char *end;
 
+       /* endp can be NULL. To avoid spreading NULL checks across the function,
+        * set endp to &end in that case.
+        */
+       if (endp == NULL)
+               endp = &end;
+
        for (; isspace(*p); ++p);
 
-       if (*p == '"') {
-               for (end = (char *)p + 1; *end && *end != '"'; ++end);
-               if (*end != '"')
+       if (*p == '"' || *p == '\'') {
+               for (end = (char *)p + 1; *end && *end != '"' && *end != '\''; ++end);
+               if (*end != '"' && *end != '\'') {
+                       media_dbg(media, "missing matching '\"'\n");
+                       *endp = end;
                        return NULL;
+               }
 
                entity = media_get_entity_by_name(media, p + 1, end - p - 1);
-               if (entity == NULL)
+               if (entity == NULL) {
+                       media_dbg(media, "no such entity \"%.*s\"\n", end - p - 1, p + 1);
+                       *endp = (char *)p + 1;
                        return NULL;
+               }
 
                ++end;
        } else {
                entity_id = strtoul(p, &end, 10);
                entity = media_get_entity_by_id(media, entity_id);
-               if (entity == NULL)
+               if (entity == NULL) {
+                       media_dbg(media, "no such entity %d\n", entity_id);
+                       *endp = (char *)p;
                        return NULL;
+               }
        }
        for (; isspace(*end); ++end);
 
-       if (*end != ':')
+       if (*end != ':') {
+               media_dbg(media, "Expected ':'\n", *end);
+               *endp = end;
                return NULL;
+       }
+
        for (p = end + 1; isspace(*p); ++p);
 
        pad = strtoul(p, &end, 10);
-       for (p = end; isspace(*p); ++p);
 
-       if (pad >= entity->info.pads)
+       if (pad >= entity->info.pads) {
+               media_dbg(media, "No pad '%d' on entity \"%s\". Maximum pad number is %d\n",
+                               pad, entity->info.name, entity->info.pads - 1);
+               *endp = (char *)p;
                return NULL;
+       }
 
        for (p = end; isspace(*p); ++p);
-       if (endp)
-               *endp = (char *)p;
+       *endp = (char *)p;
 
        return &entity->pads[pad];
 }
@@ -534,16 +672,24 @@ struct media_link *media_parse_link(struct media_device *media,
        char *end;
 
        source = media_parse_pad(media, p, &end);
-       if (source == NULL)
+       if (source == NULL) {
+               *endp = end;
                return NULL;
+       }
 
-       if (end[0] != '-' || end[1] != '>')
+       if (end[0] != '-' || end[1] != '>') {
+               *endp = end;
+               media_dbg(media, "Expected '->'\n");
                return NULL;
+       }
+
        p = end + 2;
 
        sink = media_parse_pad(media, p, &end);
-       if (sink == NULL)
+       if (sink == NULL) {
+               *endp = end;
                return NULL;
+       }
 
        *endp = end;
 
@@ -554,6 +700,9 @@ struct media_link *media_parse_link(struct media_device *media,
                        return link;
        }
 
+       media_dbg(media, "No link between \"%s\":%d and \"%s\":%d\n",
+                       source->entity->info.name, source->index,
+                       sink->entity->info.name, sink->index);
        return NULL;
 }
 
@@ -566,34 +715,56 @@ int media_parse_setup_link(struct media_device *media,
 
        link = media_parse_link(media, p, &end);
        if (link == NULL) {
-               dprintf("Unable to parse link\n");
+               media_dbg(media,
+                         "%s: Unable to parse link\n", __func__);
+               *endp = end;
                return -EINVAL;
        }
 
        p = end;
        if (*p++ != '[') {
-               dprintf("Unable to parse link flags\n");
+               media_dbg(media, "Unable to parse link flags: expected '['.\n");
+               *endp = (char *)p - 1;
                return -EINVAL;
        }
 
        flags = strtoul(p, &end, 10);
        for (p = end; isspace(*p); p++);
        if (*p++ != ']') {
-               dprintf("Unable to parse link flags\n");
+               media_dbg(media, "Unable to parse link flags: expected ']'.\n");
+               *endp = (char *)p - 1;
                return -EINVAL;
        }
 
        for (; isspace(*p); p++);
        *endp = (char *)p;
 
-       dprintf("Setting up link %u:%u -> %u:%u [%u]\n",
-               link->source->entity->info.id, link->source->index,
-               link->sink->entity->info.id, link->sink->index,
-               flags);
+       media_dbg(media,
+                 "Setting up link %u:%u -> %u:%u [%u]\n",
+                 link->source->entity->info.id, link->source->index,
+                 link->sink->entity->info.id, link->sink->index,
+                 flags);
 
        return media_setup_link(media, link->source, link->sink, flags);
 }
 
+void media_print_streampos(struct media_device *media, const char *p,
+                          const char *end)
+{
+       int pos;
+
+       pos = end - p + 1;
+
+       if (pos < 0)
+               pos = 0;
+       if (pos > strlen(p))
+               pos = strlen(p);
+
+       media_dbg(media, "\n");
+       media_dbg(media, " %s\n", p);
+       media_dbg(media, " %*s\n", pos, "^");
+}
+
 int media_parse_setup_links(struct media_device *media, const char *p)
 {
        char *end;
@@ -601,8 +772,10 @@ int media_parse_setup_links(struct media_device *media, const char *p)
 
        do {
                ret = media_parse_setup_link(media, p, &end);
-               if (ret < 0)
+               if (ret < 0) {
+                       media_print_streampos(media, p, end);
                        return ret;
+               }
 
                p = end + 1;
        } while (*end == ',');