Add field support for the media bus format
[media-ctl.git] / src / v4l2subdev.c
1 /*
2  * V4L2 subdev interface library
3  *
4  * Copyright (C) 2010-2011 Ideas on board SPRL
5  *
6  * Contact: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU Lesser General Public License as published
10  * by 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, see <http://www.gnu.org/licenses/>.
20  */
21
22 #include <sys/ioctl.h>
23 #include <sys/stat.h>
24 #include <sys/types.h>
25
26 #include <ctype.h>
27 #include <errno.h>
28 #include <fcntl.h>
29 #include <stdbool.h>
30 #include <stdio.h>
31 #include <stdlib.h>
32 #include <string.h>
33 #include <unistd.h>
34
35 #include <linux/v4l2-subdev.h>
36
37 #include "mediactl.h"
38 #include "mediactl-priv.h"
39 #include "tools.h"
40 #include "v4l2subdev.h"
41
42 int v4l2_subdev_open(struct media_entity *entity)
43 {
44         if (entity->fd != -1)
45                 return 0;
46
47         entity->fd = open(entity->devname, O_RDWR);
48         if (entity->fd == -1) {
49                 int ret = -errno;
50                 media_dbg(entity->media,
51                           "%s: Failed to open subdev device node %s\n", __func__,
52                           entity->devname);
53                 return ret;
54         }
55
56         return 0;
57 }
58
59 void v4l2_subdev_close(struct media_entity *entity)
60 {
61         close(entity->fd);
62         entity->fd = -1;
63 }
64
65 int v4l2_subdev_get_format(struct media_entity *entity,
66         struct v4l2_mbus_framefmt *format, unsigned int pad,
67         enum v4l2_subdev_format_whence which)
68 {
69         struct v4l2_subdev_format fmt;
70         int ret;
71
72         ret = v4l2_subdev_open(entity);
73         if (ret < 0)
74                 return ret;
75
76         memset(&fmt, 0, sizeof(fmt));
77         fmt.pad = pad;
78         fmt.which = which;
79
80         ret = ioctl(entity->fd, VIDIOC_SUBDEV_G_FMT, &fmt);
81         if (ret < 0)
82                 return -errno;
83
84         *format = fmt.format;
85         return 0;
86 }
87
88 int v4l2_subdev_set_format(struct media_entity *entity,
89         struct v4l2_mbus_framefmt *format, unsigned int pad,
90         enum v4l2_subdev_format_whence which)
91 {
92         struct v4l2_subdev_format fmt;
93         int ret;
94
95         ret = v4l2_subdev_open(entity);
96         if (ret < 0)
97                 return ret;
98
99         memset(&fmt, 0, sizeof(fmt));
100         fmt.pad = pad;
101         fmt.which = which;
102         fmt.format = *format;
103
104         ret = ioctl(entity->fd, VIDIOC_SUBDEV_S_FMT, &fmt);
105         if (ret < 0)
106                 return -errno;
107
108         *format = fmt.format;
109         return 0;
110 }
111
112 int v4l2_subdev_get_selection(struct media_entity *entity,
113         struct v4l2_rect *rect, unsigned int pad, unsigned int target,
114         enum v4l2_subdev_format_whence which)
115 {
116         union {
117                 struct v4l2_subdev_selection sel;
118                 struct v4l2_subdev_crop crop;
119         } u;
120         int ret;
121
122         ret = v4l2_subdev_open(entity);
123         if (ret < 0)
124                 return ret;
125
126         memset(&u.sel, 0, sizeof(u.sel));
127         u.sel.pad = pad;
128         u.sel.target = target;
129         u.sel.which = which;
130
131         ret = ioctl(entity->fd, VIDIOC_SUBDEV_G_SELECTION, &u.sel);
132         if (ret >= 0) {
133                 *rect = u.sel.r;
134                 return 0;
135         }
136         if (errno != ENOTTY || target != V4L2_SEL_TGT_CROP)
137                 return -errno;
138
139         memset(&u.crop, 0, sizeof(u.crop));
140         u.crop.pad = pad;
141         u.crop.which = which;
142
143         ret = ioctl(entity->fd, VIDIOC_SUBDEV_G_CROP, &u.crop);
144         if (ret < 0)
145                 return -errno;
146
147         *rect = u.crop.rect;
148         return 0;
149 }
150
151 int v4l2_subdev_set_selection(struct media_entity *entity,
152         struct v4l2_rect *rect, unsigned int pad, unsigned int target,
153         enum v4l2_subdev_format_whence which)
154 {
155         union {
156                 struct v4l2_subdev_selection sel;
157                 struct v4l2_subdev_crop crop;
158         } u;
159         int ret;
160
161         ret = v4l2_subdev_open(entity);
162         if (ret < 0)
163                 return ret;
164
165         memset(&u.sel, 0, sizeof(u.sel));
166         u.sel.pad = pad;
167         u.sel.target = target;
168         u.sel.which = which;
169         u.sel.r = *rect;
170
171         ret = ioctl(entity->fd, VIDIOC_SUBDEV_S_SELECTION, &u.sel);
172         if (ret >= 0) {
173                 *rect = u.sel.r;
174                 return 0;
175         }
176         if (errno != ENOTTY || target != V4L2_SEL_TGT_CROP)
177                 return -errno;
178
179         memset(&u.crop, 0, sizeof(u.crop));
180         u.crop.pad = pad;
181         u.crop.which = which;
182         u.crop.rect = *rect;
183
184         ret = ioctl(entity->fd, VIDIOC_SUBDEV_S_CROP, &u.crop);
185         if (ret < 0)
186                 return -errno;
187
188         *rect = u.crop.rect;
189         return 0;
190 }
191
192 int v4l2_subdev_get_frame_interval(struct media_entity *entity,
193                                    struct v4l2_fract *interval)
194 {
195         struct v4l2_subdev_frame_interval ival;
196         int ret;
197
198         ret = v4l2_subdev_open(entity);
199         if (ret < 0)
200                 return ret;
201
202         memset(&ival, 0, sizeof(ival));
203
204         ret = ioctl(entity->fd, VIDIOC_SUBDEV_G_FRAME_INTERVAL, &ival);
205         if (ret < 0)
206                 return -errno;
207
208         *interval = ival.interval;
209         return 0;
210 }
211
212 int v4l2_subdev_set_frame_interval(struct media_entity *entity,
213                                    struct v4l2_fract *interval)
214 {
215         struct v4l2_subdev_frame_interval ival;
216         int ret;
217
218         ret = v4l2_subdev_open(entity);
219         if (ret < 0)
220                 return ret;
221
222         memset(&ival, 0, sizeof(ival));
223         ival.interval = *interval;
224
225         ret = ioctl(entity->fd, VIDIOC_SUBDEV_S_FRAME_INTERVAL, &ival);
226         if (ret < 0)
227                 return -errno;
228
229         *interval = ival.interval;
230         return 0;
231 }
232
233 static int v4l2_subdev_parse_format(struct media_device *media,
234                                     struct v4l2_mbus_framefmt *format,
235                                     const char *p, char **endp)
236 {
237         enum v4l2_mbus_pixelcode code;
238         unsigned int width, height;
239         char *end;
240
241         /*
242          * Compatibility with the old syntax: consider space as valid
243          * separator between the media bus pixel code and the size.
244          */
245         for (; isspace(*p); ++p);
246         for (end = (char *)p;
247              *end != '/' && *end != ' ' && *end != '\0'; ++end);
248
249         code = v4l2_subdev_string_to_pixelcode(p, end - p);
250         if (code == (enum v4l2_mbus_pixelcode)-1) {
251                 media_dbg(media, "Invalid pixel code '%.*s'\n", end - p, p);
252                 return -EINVAL;
253         }
254
255         p = end + 1;
256         width = strtoul(p, &end, 10);
257         if (*end != 'x') {
258                 media_dbg(media, "Expected 'x'\n");
259                 return -EINVAL;
260         }
261
262         p = end + 1;
263         height = strtoul(p, &end, 10);
264         *endp = end;
265
266         memset(format, 0, sizeof(*format));
267         format->width = width;
268         format->height = height;
269         format->code = code;
270
271         return 0;
272 }
273
274 static int v4l2_subdev_parse_rectangle(struct media_device *media,
275                                        struct v4l2_rect *r, const char *p,
276                                        char **endp)
277 {
278         char *end;
279
280         if (*p++ != '(') {
281                 media_dbg(media, "Expected '('\n");
282                 *endp = (char *)p - 1;
283                 return -EINVAL;
284         }
285
286         r->left = strtoul(p, &end, 10);
287         if (*end != ',') {
288                 media_dbg(media, "Expected ','\n");
289                 *endp = end;
290                 return -EINVAL;
291         }
292
293         p = end + 1;
294         r->top = strtoul(p, &end, 10);
295         if (*end++ != ')') {
296                 media_dbg(media, "Expected ')'\n");
297                 *endp = end - 1;
298                 return -EINVAL;
299         }
300         if (*end != '/') {
301                 media_dbg(media, "Expected '/'\n");
302                 *endp = end;
303                 return -EINVAL;
304         }
305
306         p = end + 1;
307         r->width = strtoul(p, &end, 10);
308         if (*end != 'x') {
309                 media_dbg(media, "Expected 'x'\n");
310                 *endp = end;
311                 return -EINVAL;
312         }
313
314         p = end + 1;
315         r->height = strtoul(p, &end, 10);
316         *endp = end;
317
318         return 0;
319 }
320
321 static int v4l2_subdev_parse_frame_interval(struct media_device *media,
322                                             struct v4l2_fract *interval,
323                                             const char *p, char **endp)
324 {
325         char *end;
326
327         for (; isspace(*p); ++p);
328
329         interval->numerator = strtoul(p, &end, 10);
330
331         for (p = end; isspace(*p); ++p);
332         if (*p++ != '/') {
333                 media_dbg(media, "Expected '/'\n");
334                 *endp = (char *)p - 1;
335                 return -EINVAL;
336         }
337
338         for (; isspace(*p); ++p);
339         interval->denominator = strtoul(p, &end, 10);
340
341         *endp = end;
342         return 0;
343 }
344
345 /*
346  * The debate over whether this function should be named icanhasstr() instead
347  * has been strong and heated. If you feel like this would be an important
348  * change, patches are welcome (or not).
349  */
350 static bool strhazit(const char *str, const char **p)
351 {
352         int len = strlen(str);
353
354         if (strncmp(str, *p, len))
355                 return false;
356
357         for (*p += len; isspace(**p); ++*p);
358         return true;
359 }
360
361 static struct media_pad *v4l2_subdev_parse_pad_format(
362         struct media_device *media, struct v4l2_mbus_framefmt *format,
363         struct v4l2_rect *crop, struct v4l2_rect *compose,
364         struct v4l2_fract *interval, const char *p, char **endp)
365 {
366         struct media_pad *pad;
367         bool first;
368         char *end;
369         int ret;
370
371         for (; isspace(*p); ++p);
372
373         pad = media_parse_pad(media, p, &end);
374         if (pad == NULL) {
375                 *endp = end;
376                 return NULL;
377         }
378
379         for (p = end; isspace(*p); ++p);
380         if (*p++ != '[') {
381                 media_dbg(media, "Expected '['\n");
382                 *endp = (char *)p - 1;
383                 return NULL;
384         }
385
386         for (first = true; ; first = false) {
387                 for (; isspace(*p); p++);
388
389                 /*
390                  * Backward compatibility: if the first property starts with an
391                  * uppercase later, process it as a format description.
392                  */
393                 if (strhazit("fmt:", &p) || (first && isupper(*p))) {
394                         ret = v4l2_subdev_parse_format(media, format, p, &end);
395                         if (ret < 0) {
396                                 *endp = end;
397                                 return NULL;
398                         }
399
400                         p = end;
401                         continue;
402                 }
403
404                 if (strhazit("field:", &p)) {
405                         enum v4l2_field field;
406
407                         for (end = (char *)p; isalpha(*end) || *end == '-'; ++end);
408
409                         field = v4l2_subdev_string_to_field(p, end - p);
410                         if (field == (enum v4l2_field)-1) {
411                                 media_dbg(media, "Invalid field value '%*s'\n", end - p, p);
412                                 *endp = (char *)p;
413                                 return NULL;
414                         }
415
416                         format->field = field;
417
418                         p = end;
419                         continue;
420                 }
421
422                 /*
423                  * Backward compatibility: crop rectangles can be specified
424                  * implicitly without the 'crop:' property name.
425                  */
426                 if (strhazit("crop:", &p) || *p == '(') {
427                         ret = v4l2_subdev_parse_rectangle(media, crop, p, &end);
428                         if (ret < 0) {
429                                 *endp = end;
430                                 return NULL;
431                         }
432
433                         p = end;
434                         continue;
435                 }
436
437                 if (strhazit("compose:", &p)) {
438                         ret = v4l2_subdev_parse_rectangle(media, compose, p, &end);
439                         if (ret < 0) {
440                                 *endp = end;
441                                 return NULL;
442                         }
443
444                         for (p = end; isspace(*p); p++);
445                         continue;
446                 }
447
448                 if (*p == '@') {
449                         ret = v4l2_subdev_parse_frame_interval(media, interval, ++p, &end);
450                         if (ret < 0) {
451                                 *endp = end;
452                                 return NULL;
453                         }
454
455                         p = end;
456                         continue;
457                 }
458
459                 break;
460         }
461
462         if (*p != ']') {
463                 media_dbg(media, "Expected ']'\n");
464                 *endp = (char *)p;
465                 return NULL;
466         }
467
468         *endp = (char *)p + 1;
469         return pad;
470 }
471
472 static int set_format(struct media_pad *pad,
473                       struct v4l2_mbus_framefmt *format)
474 {
475         int ret;
476
477         if (format->width == 0 || format->height == 0)
478                 return 0;
479
480         media_dbg(pad->entity->media,
481                   "Setting up format %s %ux%u on pad %s/%u\n",
482                   v4l2_subdev_pixelcode_to_string(format->code),
483                   format->width, format->height,
484                   pad->entity->info.name, pad->index);
485
486         ret = v4l2_subdev_set_format(pad->entity, format, pad->index,
487                                      V4L2_SUBDEV_FORMAT_ACTIVE);
488         if (ret < 0) {
489                 media_dbg(pad->entity->media,
490                           "Unable to set format: %s (%d)\n",
491                           strerror(-ret), ret);
492                 return ret;
493         }
494
495         media_dbg(pad->entity->media,
496                   "Format set: %s %ux%u\n",
497                   v4l2_subdev_pixelcode_to_string(format->code),
498                   format->width, format->height);
499
500         return 0;
501 }
502
503 static int set_selection(struct media_pad *pad, unsigned int target,
504                          struct v4l2_rect *rect)
505 {
506         int ret;
507
508         if (rect->left == -1 || rect->top == -1)
509                 return 0;
510
511         media_dbg(pad->entity->media,
512                   "Setting up selection target %u rectangle (%u,%u)/%ux%u on pad %s/%u\n",
513                   target, rect->left, rect->top, rect->width, rect->height,
514                   pad->entity->info.name, pad->index);
515
516         ret = v4l2_subdev_set_selection(pad->entity, rect, pad->index,
517                                         target, V4L2_SUBDEV_FORMAT_ACTIVE);
518         if (ret < 0) {
519                 media_dbg(pad->entity->media,
520                           "Unable to set selection rectangle: %s (%d)\n",
521                           strerror(-ret), ret);
522                 return ret;
523         }
524
525         media_dbg(pad->entity->media,
526                   "Selection rectangle set: (%u,%u)/%ux%u\n",
527                   rect->left, rect->top, rect->width, rect->height);
528
529         return 0;
530 }
531
532 static int set_frame_interval(struct media_entity *entity,
533                               struct v4l2_fract *interval)
534 {
535         int ret;
536
537         if (interval->numerator == 0)
538                 return 0;
539
540         media_dbg(entity->media,
541                   "Setting up frame interval %u/%u on entity %s\n",
542                   interval->numerator, interval->denominator,
543                   entity->info.name);
544
545         ret = v4l2_subdev_set_frame_interval(entity, interval);
546         if (ret < 0) {
547                 media_dbg(entity->media,
548                           "Unable to set frame interval: %s (%d)",
549                           strerror(-ret), ret);
550                 return ret;
551         }
552
553         media_dbg(entity->media, "Frame interval set: %u/%u\n",
554                   interval->numerator, interval->denominator);
555
556         return 0;
557 }
558
559
560 static int v4l2_subdev_parse_setup_format(struct media_device *media,
561                                           const char *p, char **endp)
562 {
563         struct v4l2_mbus_framefmt format = { 0, 0, 0 };
564         struct media_pad *pad;
565         struct v4l2_rect crop = { -1, -1, -1, -1 };
566         struct v4l2_rect compose = crop;
567         struct v4l2_fract interval = { 0, 0 };
568         unsigned int i;
569         char *end;
570         int ret;
571
572         pad = v4l2_subdev_parse_pad_format(media, &format, &crop, &compose,
573                                            &interval, p, &end);
574         if (pad == NULL) {
575                 media_print_streampos(media, p, end);
576                 media_dbg(media, "Unable to parse format\n");
577                 return -EINVAL;
578         }
579
580         if (pad->flags & MEDIA_PAD_FL_SINK) {
581                 ret = set_format(pad, &format);
582                 if (ret < 0)
583                         return ret;
584         }
585
586         ret = set_selection(pad, V4L2_SEL_TGT_CROP, &crop);
587         if (ret < 0)
588                 return ret;
589
590         ret = set_selection(pad, V4L2_SEL_TGT_COMPOSE, &compose);
591         if (ret < 0)
592                 return ret;
593
594         if (pad->flags & MEDIA_PAD_FL_SOURCE) {
595                 ret = set_format(pad, &format);
596                 if (ret < 0)
597                         return ret;
598         }
599
600         ret = set_frame_interval(pad->entity, &interval);
601         if (ret < 0)
602                 return ret;
603
604
605         /* If the pad is an output pad, automatically set the same format on
606          * the remote subdev input pads, if any.
607          */
608         if (pad->flags & MEDIA_PAD_FL_SOURCE) {
609                 for (i = 0; i < pad->entity->num_links; ++i) {
610                         struct media_link *link = &pad->entity->links[i];
611                         struct v4l2_mbus_framefmt remote_format;
612
613                         if (!(link->flags & MEDIA_LNK_FL_ENABLED))
614                                 continue;
615
616                         if (link->source == pad &&
617                             link->sink->entity->info.type == MEDIA_ENT_T_V4L2_SUBDEV) {
618                                 remote_format = format;
619                                 set_format(link->sink, &remote_format);
620                         }
621                 }
622         }
623
624         *endp = end;
625         return 0;
626 }
627
628 int v4l2_subdev_parse_setup_formats(struct media_device *media, const char *p)
629 {
630         char *end;
631         int ret;
632
633         do {
634                 ret = v4l2_subdev_parse_setup_format(media, p, &end);
635                 if (ret < 0)
636                         return ret;
637
638                 p = end + 1;
639         } while (*end == ',');
640
641         return *end ? -EINVAL : 0;
642 }
643
644 static struct {
645         const char *name;
646         enum v4l2_mbus_pixelcode code;
647 } mbus_formats[] = {
648         { "Y8", V4L2_MBUS_FMT_Y8_1X8},
649         { "Y10", V4L2_MBUS_FMT_Y10_1X10 },
650         { "Y12", V4L2_MBUS_FMT_Y12_1X12 },
651         { "YUYV", V4L2_MBUS_FMT_YUYV8_1X16 },
652         { "YUYV1_5X8", V4L2_MBUS_FMT_YUYV8_1_5X8 },
653         { "YUYV2X8", V4L2_MBUS_FMT_YUYV8_2X8 },
654         { "UYVY", V4L2_MBUS_FMT_UYVY8_1X16 },
655         { "UYVY1_5X8", V4L2_MBUS_FMT_UYVY8_1_5X8 },
656         { "UYVY2X8", V4L2_MBUS_FMT_UYVY8_2X8 },
657         { "SBGGR8", V4L2_MBUS_FMT_SBGGR8_1X8 },
658         { "SGBRG8", V4L2_MBUS_FMT_SGBRG8_1X8 },
659         { "SGRBG8", V4L2_MBUS_FMT_SGRBG8_1X8 },
660         { "SRGGB8", V4L2_MBUS_FMT_SRGGB8_1X8 },
661         { "SBGGR10", V4L2_MBUS_FMT_SBGGR10_1X10 },
662         { "SGBRG10", V4L2_MBUS_FMT_SGBRG10_1X10 },
663         { "SGRBG10", V4L2_MBUS_FMT_SGRBG10_1X10 },
664         { "SRGGB10", V4L2_MBUS_FMT_SRGGB10_1X10 },
665         { "SBGGR10_DPCM8", V4L2_MBUS_FMT_SBGGR10_DPCM8_1X8 },
666         { "SGBRG10_DPCM8", V4L2_MBUS_FMT_SGBRG10_DPCM8_1X8 },
667         { "SGRBG10_DPCM8", V4L2_MBUS_FMT_SGRBG10_DPCM8_1X8 },
668         { "SRGGB10_DPCM8", V4L2_MBUS_FMT_SRGGB10_DPCM8_1X8 },
669         { "SBGGR12", V4L2_MBUS_FMT_SBGGR12_1X12 },
670         { "SGBRG12", V4L2_MBUS_FMT_SGBRG12_1X12 },
671         { "SGRBG12", V4L2_MBUS_FMT_SGRBG12_1X12 },
672         { "SRGGB12", V4L2_MBUS_FMT_SRGGB12_1X12 },
673         { "AYUV32", V4L2_MBUS_FMT_AYUV8_1X32 },
674         { "ARGB32", V4L2_MBUS_FMT_ARGB8888_1X32 },
675 };
676
677 const char *v4l2_subdev_pixelcode_to_string(enum v4l2_mbus_pixelcode code)
678 {
679         unsigned int i;
680
681         for (i = 0; i < ARRAY_SIZE(mbus_formats); ++i) {
682                 if (mbus_formats[i].code == code)
683                         return mbus_formats[i].name;
684         }
685
686         return "unknown";
687 }
688
689 enum v4l2_mbus_pixelcode v4l2_subdev_string_to_pixelcode(const char *string,
690                                                          unsigned int length)
691 {
692         unsigned int i;
693
694         for (i = 0; i < ARRAY_SIZE(mbus_formats); ++i) {
695                 if (strncmp(mbus_formats[i].name, string, length) == 0)
696                         break;
697         }
698
699         if (i == ARRAY_SIZE(mbus_formats))
700                 return (enum v4l2_mbus_pixelcode)-1;
701
702         return mbus_formats[i].code;
703 }
704
705 static struct {
706         const char *name;
707         enum v4l2_field field;
708 } fields[] = {
709         { "any", V4L2_FIELD_ANY },
710         { "none", V4L2_FIELD_NONE },
711         { "top", V4L2_FIELD_TOP },
712         { "bottom", V4L2_FIELD_BOTTOM },
713         { "interlaced", V4L2_FIELD_INTERLACED },
714         { "seq-tb", V4L2_FIELD_SEQ_TB },
715         { "seq-bt", V4L2_FIELD_SEQ_BT },
716         { "alternate", V4L2_FIELD_ALTERNATE },
717         { "interlaced-tb", V4L2_FIELD_INTERLACED_TB },
718         { "interlaced-bt", V4L2_FIELD_INTERLACED_BT },
719 };
720
721 const char *v4l2_subdev_field_to_string(enum v4l2_field field)
722 {
723         unsigned int i;
724
725         for (i = 0; i < ARRAY_SIZE(fields); ++i) {
726                 if (fields[i].field == field)
727                         return fields[i].name;
728         }
729
730         return "unknown";
731 }
732
733 enum v4l2_field v4l2_subdev_string_to_field(const char *string,
734                                             unsigned int length)
735 {
736         unsigned int i;
737
738         for (i = 0; i < ARRAY_SIZE(fields); ++i) {
739                 if (strncmp(fields[i].name, string, length) == 0)
740                         break;
741         }
742
743         if (i == ARRAY_SIZE(fields))
744                 return (enum v4l2_field)-1;
745
746         return fields[i].field;
747 }