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