1 /* SPDX-License-Identifier: GPL-2.0-only */
3 * v4l2-tpg.h - Test Pattern Generator
5 * Copyright 2014 Cisco Systems, Inc. and/or its affiliates. All rights reserved.
11 #include <linux/types.h>
12 #include <linux/errno.h>
13 #include <linux/random.h>
14 #include <linux/slab.h>
15 #include <linux/vmalloc.h>
16 #include <linux/videodev2.h>
18 struct tpg_rbg_color8
{
19 unsigned char r
, g
, b
;
22 struct tpg_rbg_color16
{
31 TPG_COLOR_CSC_MAGENTA
,
45 TPG_COLOR_100_MAGENTA
,
53 TPG_COLOR_MAX
= TPG_COLOR_RAMP
+ 256
56 extern const struct tpg_rbg_color8 tpg_colors
[TPG_COLOR_MAX
];
57 extern const unsigned short tpg_rec709_to_linear
[255 * 16 + 1];
58 extern const unsigned short tpg_linear_to_rec709
[255 * 16 + 1];
59 extern const struct tpg_rbg_color16 tpg_csc_colors
[V4L2_COLORSPACE_DCI_P3
+ 1]
60 [V4L2_XFER_FUNC_SMPTE2084
+ 1]
61 [TPG_COLOR_CSC_BLACK
+ 1];
66 TPG_PAT_100_HCOLORBAR
,
67 TPG_PAT_100_COLORSQUARES
,
73 TPG_PAT_CHECKERS_16X16
,
76 TPG_PAT_COLOR_CHECKERS_2X2
,
77 TPG_PAT_COLOR_CHECKERS_1X1
,
78 TPG_PAT_ALTERNATING_HLINES
,
79 TPG_PAT_ALTERNATING_VLINES
,
80 TPG_PAT_CROSS_1_PIXEL
,
81 TPG_PAT_CROSS_2_PIXELS
,
82 TPG_PAT_CROSS_10_PIXELS
,
85 /* Must be the last pattern */
89 extern const char * const tpg_pattern_strings
[];
97 enum tpg_video_aspect
{
98 TPG_VIDEO_ASPECT_IMAGE
,
100 TPG_VIDEO_ASPECT_14X9_CENTRE
,
101 TPG_VIDEO_ASPECT_16X9_CENTRE
,
102 TPG_VIDEO_ASPECT_16X9_ANAMORPHIC
,
105 enum tpg_pixel_aspect
{
106 TPG_PIXEL_ASPECT_SQUARE
,
107 TPG_PIXEL_ASPECT_NTSC
,
108 TPG_PIXEL_ASPECT_PAL
,
128 extern const char * const tpg_aspect_strings
[];
130 #define TPG_MAX_PLANES 3
131 #define TPG_MAX_PAT_LINES 8
134 /* Source frame size */
135 unsigned src_width
, src_height
;
138 /* Scaled output frame size */
139 unsigned scaled_width
;
141 bool field_alternate
;
142 /* crop coordinates are frame-based */
143 struct v4l2_rect crop
;
144 /* compose coordinates are format-based */
145 struct v4l2_rect compose
;
146 /* border and square coordinates are frame-based */
147 struct v4l2_rect border
;
148 struct v4l2_rect square
;
150 /* Color-related fields */
151 enum tpg_quality qual
;
152 unsigned qual_offset
;
160 enum tgp_color_enc color_enc
;
166 * Stores the actual transfer function, i.e. will never be
167 * V4L2_XFER_FUNC_DEFAULT.
171 * Stores the actual Y'CbCr encoding, i.e. will never be
172 * V4L2_YCBCR_ENC_DEFAULT.
178 * Stores the actual quantization, i.e. will never be
179 * V4L2_QUANTIZATION_DEFAULT.
181 u32 real_quantization
;
182 enum tpg_video_aspect vid_aspect
;
183 enum tpg_pixel_aspect pix_aspect
;
185 unsigned real_rgb_range
;
189 u8 vdownsampling
[TPG_MAX_PLANES
];
190 u8 hdownsampling
[TPG_MAX_PLANES
];
192 * horizontal positions must be ANDed with this value to enforce
193 * correct boundaries for packed YUYV values.
195 unsigned hmask
[TPG_MAX_PLANES
];
196 /* Used to store the colors in native format, either RGB or YUV */
197 u8 colors
[TPG_COLOR_MAX
][3];
198 u8 textfg
[TPG_MAX_PLANES
][8], textbg
[TPG_MAX_PLANES
][8];
199 /* size in bytes for two pixels in each plane */
200 unsigned twopixelsize
[TPG_MAX_PLANES
];
201 unsigned bytesperline
[TPG_MAX_PLANES
];
204 enum tpg_pattern pattern
;
208 bool perc_fill_blank
;
213 bool insert_hdmi_video_guard_band
;
215 /* Test pattern movement */
216 enum tpg_move_mode mv_hor_mode
;
219 enum tpg_move_mode mv_vert_mode
;
225 bool recalc_square_border
;
227 /* Used to store TPG_MAX_PAT_LINES lines, each with up to two planes */
228 unsigned max_line_width
;
229 u8
*lines
[TPG_MAX_PAT_LINES
][TPG_MAX_PLANES
];
230 u8
*downsampled_lines
[TPG_MAX_PAT_LINES
][TPG_MAX_PLANES
];
231 u8
*random_line
[TPG_MAX_PLANES
];
232 u8
*contrast_line
[TPG_MAX_PLANES
];
233 u8
*black_line
[TPG_MAX_PLANES
];
236 void tpg_init(struct tpg_data
*tpg
, unsigned w
, unsigned h
);
237 int tpg_alloc(struct tpg_data
*tpg
, unsigned max_w
);
238 void tpg_free(struct tpg_data
*tpg
);
239 void tpg_reset_source(struct tpg_data
*tpg
, unsigned width
, unsigned height
,
241 void tpg_log_status(struct tpg_data
*tpg
);
243 void tpg_set_font(const u8
*f
);
244 void tpg_gen_text(const struct tpg_data
*tpg
,
245 u8
*basep
[TPG_MAX_PLANES
][2], int y
, int x
, const char *text
);
246 void tpg_calc_text_basep(struct tpg_data
*tpg
,
247 u8
*basep
[TPG_MAX_PLANES
][2], unsigned p
, u8
*vbuf
);
248 unsigned tpg_g_interleaved_plane(const struct tpg_data
*tpg
, unsigned buf_line
);
249 void tpg_fill_plane_buffer(struct tpg_data
*tpg
, v4l2_std_id std
,
250 unsigned p
, u8
*vbuf
);
251 void tpg_fillbuffer(struct tpg_data
*tpg
, v4l2_std_id std
,
252 unsigned p
, u8
*vbuf
);
253 bool tpg_s_fourcc(struct tpg_data
*tpg
, u32 fourcc
);
254 void tpg_s_crop_compose(struct tpg_data
*tpg
, const struct v4l2_rect
*crop
,
255 const struct v4l2_rect
*compose
);
256 const char *tpg_g_color_order(const struct tpg_data
*tpg
);
258 static inline void tpg_s_pattern(struct tpg_data
*tpg
, enum tpg_pattern pattern
)
260 if (tpg
->pattern
== pattern
)
262 tpg
->pattern
= pattern
;
263 tpg
->recalc_colors
= true;
266 static inline void tpg_s_quality(struct tpg_data
*tpg
,
267 enum tpg_quality qual
, unsigned qual_offset
)
269 if (tpg
->qual
== qual
&& tpg
->qual_offset
== qual_offset
)
272 tpg
->qual_offset
= qual_offset
;
273 tpg
->recalc_colors
= true;
276 static inline enum tpg_quality
tpg_g_quality(const struct tpg_data
*tpg
)
281 static inline void tpg_s_alpha_component(struct tpg_data
*tpg
,
284 if (tpg
->alpha_component
== alpha_component
)
286 tpg
->alpha_component
= alpha_component
;
287 tpg
->recalc_colors
= true;
290 static inline void tpg_s_alpha_mode(struct tpg_data
*tpg
,
293 if (tpg
->alpha_red_only
== red_only
)
295 tpg
->alpha_red_only
= red_only
;
296 tpg
->recalc_colors
= true;
299 static inline void tpg_s_brightness(struct tpg_data
*tpg
,
302 if (tpg
->brightness
== brightness
)
304 tpg
->brightness
= brightness
;
305 tpg
->recalc_colors
= true;
308 static inline void tpg_s_contrast(struct tpg_data
*tpg
,
311 if (tpg
->contrast
== contrast
)
313 tpg
->contrast
= contrast
;
314 tpg
->recalc_colors
= true;
317 static inline void tpg_s_saturation(struct tpg_data
*tpg
,
320 if (tpg
->saturation
== saturation
)
322 tpg
->saturation
= saturation
;
323 tpg
->recalc_colors
= true;
326 static inline void tpg_s_hue(struct tpg_data
*tpg
,
329 hue
= clamp_t(s16
, hue
, -128, 128);
333 tpg
->recalc_colors
= true;
336 static inline void tpg_s_rgb_range(struct tpg_data
*tpg
,
339 if (tpg
->rgb_range
== rgb_range
)
341 tpg
->rgb_range
= rgb_range
;
342 tpg
->recalc_colors
= true;
345 static inline void tpg_s_real_rgb_range(struct tpg_data
*tpg
,
348 if (tpg
->real_rgb_range
== rgb_range
)
350 tpg
->real_rgb_range
= rgb_range
;
351 tpg
->recalc_colors
= true;
354 static inline void tpg_s_colorspace(struct tpg_data
*tpg
, u32 colorspace
)
356 if (tpg
->colorspace
== colorspace
)
358 tpg
->colorspace
= colorspace
;
359 tpg
->recalc_colors
= true;
362 static inline u32
tpg_g_colorspace(const struct tpg_data
*tpg
)
364 return tpg
->colorspace
;
367 static inline void tpg_s_ycbcr_enc(struct tpg_data
*tpg
, u32 ycbcr_enc
)
369 if (tpg
->ycbcr_enc
== ycbcr_enc
)
371 tpg
->ycbcr_enc
= ycbcr_enc
;
372 tpg
->recalc_colors
= true;
375 static inline u32
tpg_g_ycbcr_enc(const struct tpg_data
*tpg
)
377 return tpg
->ycbcr_enc
;
380 static inline void tpg_s_hsv_enc(struct tpg_data
*tpg
, u32 hsv_enc
)
382 if (tpg
->hsv_enc
== hsv_enc
)
384 tpg
->hsv_enc
= hsv_enc
;
385 tpg
->recalc_colors
= true;
388 static inline u32
tpg_g_hsv_enc(const struct tpg_data
*tpg
)
393 static inline void tpg_s_xfer_func(struct tpg_data
*tpg
, u32 xfer_func
)
395 if (tpg
->xfer_func
== xfer_func
)
397 tpg
->xfer_func
= xfer_func
;
398 tpg
->recalc_colors
= true;
401 static inline u32
tpg_g_xfer_func(const struct tpg_data
*tpg
)
403 return tpg
->xfer_func
;
406 static inline void tpg_s_quantization(struct tpg_data
*tpg
, u32 quantization
)
408 if (tpg
->quantization
== quantization
)
410 tpg
->quantization
= quantization
;
411 tpg
->recalc_colors
= true;
414 static inline u32
tpg_g_quantization(const struct tpg_data
*tpg
)
416 return tpg
->quantization
;
419 static inline unsigned tpg_g_buffers(const struct tpg_data
*tpg
)
424 static inline unsigned tpg_g_planes(const struct tpg_data
*tpg
)
426 return tpg
->interleaved
? 1 : tpg
->planes
;
429 static inline bool tpg_g_interleaved(const struct tpg_data
*tpg
)
431 return tpg
->interleaved
;
434 static inline unsigned tpg_g_twopixelsize(const struct tpg_data
*tpg
, unsigned plane
)
436 return tpg
->twopixelsize
[plane
];
439 static inline unsigned tpg_hdiv(const struct tpg_data
*tpg
,
440 unsigned plane
, unsigned x
)
442 return ((x
/ tpg
->hdownsampling
[plane
]) & tpg
->hmask
[plane
]) *
443 tpg
->twopixelsize
[plane
] / 2;
446 static inline unsigned tpg_hscale(const struct tpg_data
*tpg
, unsigned x
)
448 return (x
* tpg
->scaled_width
) / tpg
->src_width
;
451 static inline unsigned tpg_hscale_div(const struct tpg_data
*tpg
,
452 unsigned plane
, unsigned x
)
454 return tpg_hdiv(tpg
, plane
, tpg_hscale(tpg
, x
));
457 static inline unsigned tpg_g_bytesperline(const struct tpg_data
*tpg
, unsigned plane
)
459 return tpg
->bytesperline
[plane
];
462 static inline void tpg_s_bytesperline(struct tpg_data
*tpg
, unsigned plane
, unsigned bpl
)
466 if (tpg
->buffers
> 1) {
467 tpg
->bytesperline
[plane
] = bpl
;
471 for (p
= 0; p
< tpg_g_planes(tpg
); p
++) {
472 unsigned plane_w
= bpl
* tpg
->twopixelsize
[p
] / tpg
->twopixelsize
[0];
474 tpg
->bytesperline
[p
] = plane_w
/ tpg
->hdownsampling
[p
];
476 if (tpg_g_interleaved(tpg
))
477 tpg
->bytesperline
[1] = tpg
->bytesperline
[0];
481 static inline unsigned tpg_g_line_width(const struct tpg_data
*tpg
, unsigned plane
)
486 if (tpg
->buffers
> 1)
487 return tpg_g_bytesperline(tpg
, plane
);
488 for (p
= 0; p
< tpg_g_planes(tpg
); p
++) {
489 unsigned plane_w
= tpg_g_bytesperline(tpg
, p
);
491 w
+= plane_w
/ tpg
->vdownsampling
[p
];
496 static inline unsigned tpg_calc_line_width(const struct tpg_data
*tpg
,
497 unsigned plane
, unsigned bpl
)
502 if (tpg
->buffers
> 1)
504 for (p
= 0; p
< tpg_g_planes(tpg
); p
++) {
505 unsigned plane_w
= bpl
* tpg
->twopixelsize
[p
] / tpg
->twopixelsize
[0];
507 plane_w
/= tpg
->hdownsampling
[p
];
508 w
+= plane_w
/ tpg
->vdownsampling
[p
];
513 static inline unsigned tpg_calc_plane_size(const struct tpg_data
*tpg
, unsigned plane
)
515 if (plane
>= tpg_g_planes(tpg
))
518 return tpg_g_bytesperline(tpg
, plane
) * tpg
->buf_height
/
519 tpg
->vdownsampling
[plane
];
522 static inline void tpg_s_buf_height(struct tpg_data
*tpg
, unsigned h
)
527 static inline void tpg_s_field(struct tpg_data
*tpg
, unsigned field
, bool alternate
)
530 tpg
->field_alternate
= alternate
;
533 static inline void tpg_s_perc_fill(struct tpg_data
*tpg
,
536 tpg
->perc_fill
= perc_fill
;
539 static inline unsigned tpg_g_perc_fill(const struct tpg_data
*tpg
)
541 return tpg
->perc_fill
;
544 static inline void tpg_s_perc_fill_blank(struct tpg_data
*tpg
,
545 bool perc_fill_blank
)
547 tpg
->perc_fill_blank
= perc_fill_blank
;
550 static inline void tpg_s_video_aspect(struct tpg_data
*tpg
,
551 enum tpg_video_aspect vid_aspect
)
553 if (tpg
->vid_aspect
== vid_aspect
)
555 tpg
->vid_aspect
= vid_aspect
;
556 tpg
->recalc_square_border
= true;
559 static inline enum tpg_video_aspect
tpg_g_video_aspect(const struct tpg_data
*tpg
)
561 return tpg
->vid_aspect
;
564 static inline void tpg_s_pixel_aspect(struct tpg_data
*tpg
,
565 enum tpg_pixel_aspect pix_aspect
)
567 if (tpg
->pix_aspect
== pix_aspect
)
569 tpg
->pix_aspect
= pix_aspect
;
570 tpg
->recalc_square_border
= true;
573 static inline void tpg_s_show_border(struct tpg_data
*tpg
,
576 tpg
->show_border
= show_border
;
579 static inline void tpg_s_show_square(struct tpg_data
*tpg
,
582 tpg
->show_square
= show_square
;
585 static inline void tpg_s_insert_sav(struct tpg_data
*tpg
, bool insert_sav
)
587 tpg
->insert_sav
= insert_sav
;
590 static inline void tpg_s_insert_eav(struct tpg_data
*tpg
, bool insert_eav
)
592 tpg
->insert_eav
= insert_eav
;
596 * This inserts 4 pixels of the RGB color 0xab55ab at the left hand side of the
597 * image. This is only done for 3 or 4 byte RGB pixel formats. This pixel value
598 * equals the Video Guard Band value as defined by HDMI (see section 5.2.2.1
599 * in the HDMI 1.3 Specification) that preceeds the first actual pixel. If the
600 * HDMI receiver doesn't handle this correctly, then it might keep skipping
601 * these Video Guard Band patterns and end up with a shorter video line. So this
602 * is a nice pattern to test with.
604 static inline void tpg_s_insert_hdmi_video_guard_band(struct tpg_data
*tpg
,
605 bool insert_hdmi_video_guard_band
)
607 tpg
->insert_hdmi_video_guard_band
= insert_hdmi_video_guard_band
;
610 void tpg_update_mv_step(struct tpg_data
*tpg
);
612 static inline void tpg_s_mv_hor_mode(struct tpg_data
*tpg
,
613 enum tpg_move_mode mv_hor_mode
)
615 tpg
->mv_hor_mode
= mv_hor_mode
;
616 tpg_update_mv_step(tpg
);
619 static inline void tpg_s_mv_vert_mode(struct tpg_data
*tpg
,
620 enum tpg_move_mode mv_vert_mode
)
622 tpg
->mv_vert_mode
= mv_vert_mode
;
623 tpg_update_mv_step(tpg
);
626 static inline void tpg_init_mv_count(struct tpg_data
*tpg
)
628 tpg
->mv_hor_count
= tpg
->mv_vert_count
= 0;
631 static inline void tpg_update_mv_count(struct tpg_data
*tpg
, bool frame_is_field
)
633 tpg
->mv_hor_count
+= tpg
->mv_hor_step
* (frame_is_field
? 1 : 2);
634 tpg
->mv_vert_count
+= tpg
->mv_vert_step
* (frame_is_field
? 1 : 2);
637 static inline void tpg_s_hflip(struct tpg_data
*tpg
, bool hflip
)
639 if (tpg
->hflip
== hflip
)
642 tpg_update_mv_step(tpg
);
643 tpg
->recalc_lines
= true;
646 static inline bool tpg_g_hflip(const struct tpg_data
*tpg
)
651 static inline void tpg_s_vflip(struct tpg_data
*tpg
, bool vflip
)
656 static inline bool tpg_g_vflip(const struct tpg_data
*tpg
)
661 static inline bool tpg_pattern_is_static(const struct tpg_data
*tpg
)
663 return tpg
->pattern
!= TPG_PAT_NOISE
&&
664 tpg
->mv_hor_mode
== TPG_MOVE_NONE
&&
665 tpg
->mv_vert_mode
== TPG_MOVE_NONE
;