Received-SPF: pass (google.com: domain of linux-kernel+bounces-169531-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:45e3:2400::1 as permitted sender) client-ip=2604:1380:45e3:2400::1;
From: Ming Qian <ming.qian@nxp.com>
To: mchehab@kernel.org,
	hverkuil-cisco@xs4all.nl
Cc: nicolas@ndufresne.ca,
	shawnguo@kernel.org,
	robh+dt@kernel.org,
	s.hauer@pengutronix.de,
	kernel@pengutronix.de,
	festevam@gmail.com,
	linux-imx@nxp.com,
	xiahong.bao@nxp.com,
	eagle.zhou@nxp.com,
	tao.jiang_2@nxp.com,
	ming.qian@oss.nxp.com,
	imx@lists.linux.dev,
	linux-media@vger.kernel.org,
	linux-kernel@vger.kernel.org,
	linux-arm-kernel@lists.infradead.org
Subject: [PATCH v3 1/3] media: v4l2-ctrls: Add average qp control
Date: Mon,  6 May 2024 17:49:16 +0900
Message-ID: <20240506084918.799544-1-ming.qian@nxp.com>
Content-Transfer-Encoding: 8bit
Content-Type: text/plain
Precedence: bulk
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0:
	=?us-ascii?Q?9WB4GG3xHD3OiZ3K6z/Wa93+zt9wbv9cFlQkjpbkKPCTFzwLiSw8OeWp+4uM?=
 =?us-ascii?Q?uinAymL1h5osMosUvOb7FA2w/hir2Tui99aDbVixPvhzo+esouNDjuJ6WnOm?=
 =?us-ascii?Q?2/6z8fnLDvxwVQfM3Njc/kpXiRwEP3ys+jgPJ+qeGTEzZ8ZKoBVEzOlUO0BX?=
 =?us-ascii?Q?GVRHGIhGdhoCUZBZRgoHRKppubMaySghEdPpYB5/zyGjsxY5t2oRMc8aOXHm?=
 =?us-ascii?Q?nEIEhG+JwtgyxzrmL8T9TjZcLVcCBuIXxDONtdCGYJbBgyLpr2OXCcucqtM8?=
 =?us-ascii?Q?IirUMMPsmqMcTngwsvLGUP4LPt4N3dhqgAMDlTgSqnVh/VWkyzAs1tJPF4Vc?=
 =?us-ascii?Q?4nJHVYC+PfdEzPcoM5VmSCSn6bNquy7qa+WsybaZOYmg/2MHsYQFbh4XSRgO?=
 =?us-ascii?Q?pQDLLKatd75qjcn+7fkXxfoQ8ASUEEyWvgZSkMGH1FN9MbRtWjDz8WSVZRL7?=
 =?us-ascii?Q?Hu5e3QK38BhxF8Og9/94VaFtloHlrj2ST8Gz5FUObAFedHvbyiT1dKupbzCp?=
 =?us-ascii?Q?2RghNzBJqCS9Y7zgJgRFXhvx1Ce2QLgSqf1ljxnFLZDbytima/P6bi+Co7M3?=
 =?us-ascii?Q?u100hzKx9B1I6LcyUftdLQl9IOBq6JgNdMgllvXEoQ+rdtCqp9yjEOg688S3?=
 =?us-ascii?Q?xIX9eA96flUlKhGVuQ0y788WBOj0Qupg2xJ9nBXp9GhMngBzRYNhmDcsHZMo?=
 =?us-ascii?Q?tDuIBkdLNBUQAVP/hY0FFKwNaT1xES+VtlWyEQkRBDH+Sz5wYqRBCJvrIO6J?=
 =?us-ascii?Q?6rbz+A+7us4p4bTdBvVb8/E5+FGOvGzWFbJY/Cxcl+KW3uMY2BEboruku847?=
 =?us-ascii?Q?KBTyapFFka5n4JtF/2l1txcxEWKfJKBHHOFiLeq7gTjHxbvaVFQSI9jIyAhv?=
 =?us-ascii?Q?9OPUjMNh0oeQ1xErIQEKtToj6AC26Z+8xBA9FgmEh6kOQcHK2shAdcQvcpxj?=
 =?us-ascii?Q?xNmkQWLqE3d43FdtPiYGgOZF4tf38gobVHR1t73hOsGxT1lBoBRDYPmED6ca?=
 =?us-ascii?Q?R/KJ7oFvJl1eJvKt8GUS+oYHkKIKXksphnc7gfZqLCjXCuIhwWouDKq2MBZZ?=
 =?us-ascii?Q?Og1sdyRYIWT8whNR62MedcvMn7fS0F/HuFVyReNrOaBqQ/23Zgq2nY3bcyHq?=
 =?us-ascii?Q?JDI9xntixnOX6RBIJ9gQ3Bw6joZn0k2JZZv5jJ9nKhCkfG9QxgaZLxrK7Iaw?=
 =?us-ascii?Q?EUsLUTF8qiDWJH3gN6EpPtjP7xpmwA6APKDwfmd/WodZtVLDasbuqS+QfaU1?=
 =?us-ascii?Q?TMozPhaH0ZVBSDZbqkt0hd9IvTeqBLSagKT6v8xkpcSKyCLRNjC/Ag5Ov3MY?=
 =?us-ascii?Q?LjjHqninEnhGpHQ4A8cCuMz0006ec3s2a6bKkUrgmqggGvaJJyV6yF6e7/KA?=
 =?us-ascii?Q?FwgdVImp4wD9AVvz4w0DCBStKJWqAGTUaqnNiIQ0d7VdiuRzirZihFSVwmXc?=
 =?us-ascii?Q?c+RR8/QyzTAm2PsXNvPBFKkhU4CVLFxGax0jP9aOuEPh0kNbJBqNzTbzGDbn?=
 =?us-ascii?Q?+WNdZM6dSY67WKV+K6EPujYlZ57LNWbgvcaCaWunSRTj71G/nXfnv0ch0Ncf?=
 =?us-ascii?Q?ZN9p0YPUMOSo+a7KBZc97S5CMlThdPMrHhakdI50?=
X-OriginatorOrg: nxp.com
X-MS-Exchange-CrossTenant-Network-Message-Id: b8f87b94-73a4-4318-f5bc-08dc6da97c3e
X-MS-Exchange-CrossTenant-AuthSource: PAXPR04MB8254.eurprd04.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 06 May 2024 08:49:48.3436
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 686ea1d3-bc2b-4c6f-a92c-d99c5c301635
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: XluSTc9C9ye0fSGyDHZ/3nsLYTFcH0lOLltJ06VUkwPQW5vIxpJdilnaTFwZT5tdY37CLc9Pzyijk3gWMtukpg==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: AM8PR04MB7812

Add a control V4L2_CID_MPEG_VIDEO_AVERAGE_QP to report the average qp
value of current encoded frame. the value applies to the last dequeued
capture buffer.

Signed-off-by: Ming Qian <ming.qian@nxp.com>
---
v3
- document the valid range of the new ctrl

v2
 - improve document description according Hans's comments
 - drop volatile flag

 .../userspace-api/media/v4l/ext-ctrls-codec.rst    | 14 ++++++++++++++
 drivers/media/v4l2-core/v4l2-ctrls-defs.c          |  5 +++++
 include/uapi/linux/v4l2-controls.h                 |  2 ++
 3 files changed, 21 insertions(+)

diff --git a/Documentation/userspace-api/media/v4l/ext-ctrls-codec.rst b/Documentation/userspace-api/media/v4l/ext-ctrls-codec.rst
index 2a165ae063fb..4a379bd9e3fb 100644
--- a/Documentation/userspace-api/media/v4l/ext-ctrls-codec.rst
+++ b/Documentation/userspace-api/media/v4l/ext-ctrls-codec.rst
@@ -1653,6 +1653,20 @@ enum v4l2_mpeg_video_h264_hierarchical_coding_type -
     Quantization parameter for a P frame for FWHT. Valid range: from 1
     to 31.
 
+``V4L2_CID_MPEG_VIDEO_AVERAGE_QP (integer)``
+    This read-only control returns the average QP value of the currently
+    encoded frame. The value applies to the last dequeued capture buffer
+    (VIDIOC_DQBUF). Its valid range depends on the encoding format and parameters.
+    For H264, its valid range is from 0 to 51.
+    For HEVC, its valid range is from 0 to 51 for 8 bit and
+    from 0 to 63 for 10 bit.
+    For H263 and MPEG4, its valid range is from 1 to 31.
+    For VP8, its valid range is from 0 to 127.
+    For VP9, its valid range is from 0 to 255.
+    If the codec's MIN_QP and MAX_QP are set, then the QP will meet both requirements.
+    Codecs need to always use the specified range, rather then a HW custom range.
+    Applicable to encoders
+
 .. raw:: latex
 
     \normalsize
diff --git a/drivers/media/v4l2-core/v4l2-ctrls-defs.c b/drivers/media/v4l2-core/v4l2-ctrls-defs.c
index 8696eb1cdd61..1ea52011247a 100644
--- a/drivers/media/v4l2-core/v4l2-ctrls-defs.c
+++ b/drivers/media/v4l2-core/v4l2-ctrls-defs.c
@@ -970,6 +970,7 @@ const char *v4l2_ctrl_get_name(u32 id)
 	case V4L2_CID_MPEG_VIDEO_LTR_COUNT:			return "LTR Count";
 	case V4L2_CID_MPEG_VIDEO_FRAME_LTR_INDEX:		return "Frame LTR Index";
 	case V4L2_CID_MPEG_VIDEO_USE_LTR_FRAMES:		return "Use LTR Frames";
+	case V4L2_CID_MPEG_VIDEO_AVERAGE_QP:			return "Average QP Value";
 	case V4L2_CID_FWHT_I_FRAME_QP:				return "FWHT I-Frame QP Value";
 	case V4L2_CID_FWHT_P_FRAME_QP:				return "FWHT P-Frame QP Value";
 
@@ -1507,6 +1508,10 @@ void v4l2_ctrl_fill(u32 id, const char **name, enum v4l2_ctrl_type *type,
 		*max = 0xffffffffffffLL;
 		*step = 1;
 		break;
+	case V4L2_CID_MPEG_VIDEO_AVERAGE_QP:
+		*type = V4L2_CTRL_TYPE_INTEGER;
+		*flags |= V4L2_CTRL_FLAG_READ_ONLY;
+		break;
 	case V4L2_CID_PIXEL_RATE:
 		*type = V4L2_CTRL_TYPE_INTEGER64;
 		*flags |= V4L2_CTRL_FLAG_READ_ONLY;
diff --git a/include/uapi/linux/v4l2-controls.h b/include/uapi/linux/v4l2-controls.h
index 99c3f5e99da7..974fd254e573 100644
--- a/include/uapi/linux/v4l2-controls.h
+++ b/include/uapi/linux/v4l2-controls.h
@@ -898,6 +898,8 @@ enum v4l2_mpeg_video_av1_level {
 	V4L2_MPEG_VIDEO_AV1_LEVEL_7_3 = 23
 };
 
+#define V4L2_CID_MPEG_VIDEO_AVERAGE_QP  (V4L2_CID_CODEC_BASE + 657)
+
 /*  MPEG-class control IDs specific to the CX2341x driver as defined by V4L2 */
 #define V4L2_CID_CODEC_CX2341X_BASE				(V4L2_CTRL_CLASS_CODEC | 0x1000)
 #define V4L2_CID_MPEG_CX2341X_VIDEO_SPATIAL_FILTER_MODE		(V4L2_CID_CODEC_CX2341X_BASE+0)
-- 
2.43.0-rc1