From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S933502AbdDFGLv (ORCPT ); Thu, 6 Apr 2017 02:11:51 -0400 Received: from mailout1.samsung.com ([203.254.224.24]:13212 "EHLO epoutp01.samsung.com" rhost-flags-OK-OK-OK-FAIL) by vger.kernel.org with ESMTP id S932819AbdDFGKb (ORCPT ); Thu, 6 Apr 2017 02:10:31 -0400 X-AuditID: b6c32a58-f79586d000001c40-6a-58e5dbd3c301 From: Smitha T Murthy To: linux-arm-kernel@lists.infradead.org, linux-media@vger.kernel.org, linux-kernel@vger.kernel.org Cc: kyungmin.park@samsung.com, kamil@wypas.org, jtp.park@samsung.com, a.hajda@samsung.com, mchehab@kernel.org, pankaj.dubey@samsung.com, krzk@kernel.org, m.szyprowski@samsung.com, s.nawrocki@samsung.com, Smitha T Murthy Subject: [Patch v4 12/12] Documention: v4l: Documentation for HEVC CIDs Date: Thu, 06 Apr 2017 11:41:45 +0530 Message-id: <1491459105-16641-13-git-send-email-smitha.t@samsung.com> X-Mailer: git-send-email 1.7.2.3 In-reply-to: <1491459105-16641-1-git-send-email-smitha.t@samsung.com> X-Brightmail-Tracker: H4sIAAAAAAAAA+NgFnrFIsWRmVeSWpSXmKPExsWy7bCmhu7l208jDDZcNLG4te4cq8WRtVeZ LGaeaGe1OH9+A7vF2aY37BabHl9jtbi8aw6bRc+GrawWa4/cZbdYtukPk8WirV/YLQ6/ASq+ u2cbowOvx6ZVnWwem5fUe/RtWcXo8XmTnMeVI43sAaxRXDYpqTmZZalF+nYJXBm/L69nL5iY XdH+tpO9gbExrIuRk0NCwESi6+BaZghbTOLCvfVsXYxcHEICSxklft78ywThtDNJTDt6jRWm Y+2tvywQieWMEvN+tbNDOP8ZJa583wtWxSagI/Ht/Wk2EFtEIFXi1bq1rCBFzAI/GCVufbvB ApIQFnCX2N21D8xmEVCVePT+P5jNK+Aq0fDiEgvEOgWJVzfWsoPYnEDxlbuPgQ2SEJjOLnHl 2A2gAzmAHFmJTQegnnCRuD15JiOELSzx6vgWdghbWuLv0luMEL3NjBJztzVDLZjAKLGytRTC tpc4cGUOWJxZgE+i9/cTqPm8Eh1tQhAlHhIP7l2EBoWjxOwrf1ghvp/BKHF+ZjPTBEaZBYwM qxjFUguKc9NTi00LTPSKE3OLS/PS9ZLzczcxglOAVsQOxn8zgg4xCnAwKvHw/qh9GiHEmlhW XJl7iFGCg1lJhDd9NlCINyWxsiq1KD++qDQntfgQozQHi5I4r/rKaxFCAumJJanZqakFqUUw WSYOTqkGRqmMA36eR3st5GplEwv+yDeKM3wy2Xd26ir+xt02flwNpXYGhrsPsTSayi0PsjK9 X6S+Li5va4+pmuSd9ZwLUyumJihxPGH5fdM0VPx6d9yhAIbjfBrRczf8bg9ZJ7329/klla+U N4TNfZ2Xcyv07h6pV0F2QXclvpw6Kf8/icG9+tM0/S1vlFiKMxINtZiLihMBsoM55f0CAAA= X-Brightmail-Tracker: H4sIAAAAAAAAA+NgFupikeLIzCtJLcpLzFFi42I5/e+xgO7l208jDP69V7K4te4cq8WRtVeZ LGaeaGe1OH9+A7vF2aY37BabHl9jtbi8aw6bRc+GrawWa4/cZbdYtukPk8WirV/YLQ6/ASq+ u2cbowOvx6ZVnWwem5fUe/RtWcXo8XmTnMeVI43sAaxRbjYZqYkpqUUKqXnJ+SmZeem2SqEh broWSgp5ibmptkoRur4hQUoKZYk5pUCekQEacHAOcA9W0rdLcMv4fXk9e8HE7Ir2t53sDYyN YV2MnBwSAiYSa2/9ZYGwxSQu3FvP1sXIxSEksJRRYm0ziMMJ5DQySfy4Jg9iswnoSHx7fxos LiKQKrF263lWkAZmgR+MEk0HXrKDJIQF3CV2d+0Dm8oioCrx6P1/MJtXwFWi4cUlqG0KEq9u rAWr5wSKr9x9jBVimYvEjfNLmCYw8i5gZFjFKJFakFxQnJSea5SXWq5XnJhbXJqXrpecn7uJ ERwPz6R3MB7e5X6IUYCDUYmH1+Pxkwgh1sSy4srcQ4wSHMxKIrzps59GCPGmJFZWpRblxxeV 5qQWH2I0BTpsIrOUaHI+MFbzSuINTcxNzI0NLMwtLU2MlMR5G2c/CxcSSE8sSc1OTS1ILYLp Y+LglGpgVJe8e/bhgzebL4n/kAhfmydXWhHyuazj78lGX3PPv4b9tzcpG3+9dHLHoTN2TZuv rL61IkNtfvv2g+HTzSS4A9OzUk/Y1hy+ZLXkyWYvPoc6x1vFhY1fWfXKurck+W4TcbzMG3F1 /vJjxnV1tv8Vy9+/j2Hwtvz7892l8x3GU9ZOyG9/o6mXqsRSnJFoqMVcVJwIAHS7r0ydAgAA X-MTR: 20000000000000000@CPGS X-CMS-MailID: 20170406061027epcas5p2628e0a8e0fd76e2e267fad3ea1209f65 X-Msg-Generator: CA X-Sender-IP: 203.254.230.27 X-Local-Sender: =?UTF-8?B?U21pdGhhIFQgTXVydGh5G1NTSVItVHVybiBLZXkgU29sdXRp?= =?UTF-8?B?b25zG+yCvOyEseyghOyekBtMZWFkIEVuZ2luZWVy?= X-Global-Sender: =?UTF-8?B?U21pdGhhIFQgTXVydGh5G1NTSVItVHVybiBLZXkgU29sdXRp?= =?UTF-8?B?b25zG1NhbXN1bmcgRWxlY3Ryb25pY3MbTGVhZCBFbmdpbmVlcg==?= X-Sender-Code: =?UTF-8?B?QzEwG1NXQUhRG0MxMElEMDdJRDAxMDk5Nw==?= CMS-TYPE: 105P X-CMS-RootMailID: 20170406061027epcas5p2628e0a8e0fd76e2e267fad3ea1209f65 X-RootMTR: 20170406061027epcas5p2628e0a8e0fd76e2e267fad3ea1209f65 References: <1491459105-16641-1-git-send-email-smitha.t@samsung.com> Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Added V4l2 controls for HEVC encoder Signed-off-by: Smitha T Murthy --- Documentation/media/uapi/v4l/extended-controls.rst | 391 +++++++++++++++++++++ 1 file changed, 391 insertions(+) diff --git a/Documentation/media/uapi/v4l/extended-controls.rst b/Documentation/media/uapi/v4l/extended-controls.rst index abb1057..85a668d 100644 --- a/Documentation/media/uapi/v4l/extended-controls.rst +++ b/Documentation/media/uapi/v4l/extended-controls.rst @@ -1960,6 +1960,397 @@ enum v4l2_vp8_golden_frame_sel - 1, 2 and 3 corresponding to encoder profiles 0, 1, 2 and 3. +HEVC Control Reference +--------------------- + +The HEVC controls include controls for encoding parameters of HEVC video +codec. + + +.. _hevc-control-id: + +HEVC Control IDs +^^^^^^^^^^^^^^^ + +``V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP`` + Minimum quantization parameter for HEVC. + +``V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP`` + Maximum quantization parameter for HEVC. + +``V4L2_CID_MPEG_VIDEO_HEVC_I_FRAME_QP`` + Quantization parameter for an I frame for HEVC. + +``V4L2_CID_MPEG_VIDEO_HEVC_P_FRAME_QP`` + Quantization parameter for a P frame for HEVC. + +``V4L2_CID_MPEG_VIDEO_HEVC_B_FRAME_QP`` + Quantization parameter for a B frame for HEVC. + +``V4L2_CID_MPEG_VIDEO_HEVC_HIERARCHICAL_QP`` + HIERARCHICAL_QP allows host to specify the quantization parameter values + for each temporal layer through HIERARCHICAL_QP_LAYER. This is valid only + if HIERARCHICAL_CODING_LAYER is greater than 1. + +.. _v4l2-hevc-hierarchical-coding-type: + +``V4L2_CID_MPEG_VIDEO_HEVC_HIERARCHICAL_CODING_TYPE`` + (enum) + +enum v4l2_mpeg_video_hevc_hier_coding_type - + Selects the hierarchical coding type for encoding. Possible values are: + +.. raw:: latex + + \begin{adjustbox}{width=\columnwidth} + +.. tabularcolumns:: |p{11.0cm}|p{10.0cm}| + +.. flat-table:: + :header-rows: 0 + :stub-columns: 0 + + * - ``V4L2_MPEG_VIDEO_HEVC_HIERARCHICAL_CODING_B`` + - Use the B frame for hierarchical coding. + * - ``V4L2_MPEG_VIDEO_HEVC_HIERARCHICAL_CODING_P`` + - Use the P frame for hierarchical coding. + +.. raw:: latex + + \end{adjustbox} + + +``V4L2_CID_MPEG_VIDEO_HEVC_HIERARCHICAL_CODING_LAYER`` + Selects the hierarchical coding layer. In normal encoding + (non-hierarchial coding), it should be zero. Possible values are 0 ~ 6. + 0 indicates HIERARCHICAL CODING LAYER 0, 1 indicates HIERARCHICAL CODING + LAYER 1 and so on. + +``V4L2_CID_MPEG_VIDEO_HEVC_HIERARCHICAL_CODING_LAYER_QP`` + Indicates the hierarchical coding layer quantization parameter. + For HEVC it can have a value of 0-51. Hence in the control value passed + the LSB 16 bits will indicate the quantization parameter. The MSB 16 bit + will pass the layer(0-6) it is meant for. + +.. _v4l2-hevc-profile: + +``V4L2_CID_MPEG_VIDEO_HEVC_PROFILE`` + (enum) + +enum v4l2_mpeg_video_hevc_profile - + Select the desired profile for HEVC encoder. + +.. raw:: latex + + \begin{adjustbox}{width=\columnwidth} + +.. tabularcolumns:: |p{11.0cm}|p{10.0cm}| + +.. flat-table:: + :header-rows: 0 + :stub-columns: 0 + + * - ``V4L2_MPEG_VIDEO_HEVC_PROFILE_MAIN`` + - Main profile. + * - ``V4L2_MPEG_VIDEO_HEVC_PROFILE_MAIN_STILL_PICTURE`` + - Main still picture profile. + +.. raw:: latex + + \end{adjustbox} + + +.. _v4l2-hevc-level: + +``V4L2_CID_MPEG_VIDEO_HEVC_LEVEL`` + (enum) + +enum v4l2_mpeg_video_hevc_level - + Select the desired level for HEVC encoder. + +.. raw:: latex + + \begin{adjustbox}{width=\columnwidth} + +.. tabularcolumns:: |p{11.0cm}|p{10.0cm}| + +.. flat-table:: + :header-rows: 0 + :stub-columns: 0 + + * - ``V4L2_MPEG_VIDEO_HEVC_LEVEL_1`` + - Level 1.0 + * - ``V4L2_MPEG_VIDEO_HEVC_LEVEL_2`` + - Level 2.0 + * - ``V4L2_MPEG_VIDEO_HEVC_LEVEL_2_1`` + - Level 2.1 + * - ``V4L2_MPEG_VIDEO_HEVC_LEVEL_3`` + - Level 3.0 + * - ``V4L2_MPEG_VIDEO_HEVC_LEVEL_3_1`` + - Level 3.1 + * - ``V4L2_MPEG_VIDEO_HEVC_LEVEL_4`` + - Level 4.0 + * - ``V4L2_MPEG_VIDEO_HEVC_LEVEL_4_1`` + - Level 4.1 + * - ``V4L2_MPEG_VIDEO_HEVC_LEVEL_5`` + - Level 5.0 + * - ``V4L2_MPEG_VIDEO_HEVC_LEVEL_5_1`` + - Level 5.1 + * - ``V4L2_MPEG_VIDEO_HEVC_LEVEL_5_2`` + - Level 5.2 + * - ``V4L2_MPEG_VIDEO_HEVC_LEVEL_6`` + - Level 6.0 + * - ``V4L2_MPEG_VIDEO_HEVC_LEVEL_6_1`` + - Level 6.1 + * - ``V4L2_MPEG_VIDEO_HEVC_LEVEL_6_2`` + - Level 6.2 + +.. raw:: latex + + \end{adjustbox} + + +``V4L2_CID_MPEG_VIDEO_HEVC_FRAME_RATE_RESOLUTION`` + Indicates the number of evenly spaced subintervals, called ticks, within + one modulo time. One modulo time represents the fixed interval of one + second. This is a 16bit unsigned integer and has a maximum value upto + 0xffff. + +.. _v4l2-hevc-profile: + +``V4L2_CID_MPEG_VIDEO_HEVC_TIER_FLAG`` + (enum) + +enum v4l2_mpeg_video_hevc_tier_flag - + TIER_FLAG specifies tier information of the HEVC encoded picture. Tier were + made to deal with applications that differ in terms of maximum bit rate. + Setting the flag to 0 selects HEVC tier_flag as Main tier and setting this + flag to 1 indicates High tier. High tier is for very demanding applications + +.. raw:: latex + + \begin{adjustbox}{width=\columnwidth} + +.. tabularcolumns:: |p{11.0cm}|p{10.0cm}| + +.. flat-table:: + :header-rows: 0 + :stub-columns: 0 + + * - ``V4L2_MPEG_VIDEO_HEVC_TIER_MAIN`` + - Main tier. + * - ``V4L2_MPEG_VIDEO_HEVC_TIER_HIGH`` + - High tier. + +.. raw:: latex + + \end{adjustbox} + + +``V4L2_CID_MPEG_VIDEO_HEVC_MAX_PARTITION_DEPTH`` + Selects HEVC maximum coding unit depth. + +``V4L2_CID_MPEG_VIDEO_HEVC_LF`` + Indicates loop filtering. Control ID 0 indicates loop filtering + is enabled and when set to 1 indicates no filter. + +``V4L2_CID_MPEG_VIDEO_HEVC_LF_SLICE_BOUNDARY`` + Selects whether to apply the loop filter across the slice boundary or not. + If the value is 0, loop filter will not be applied across the slice boundary. + If the value is 1, loop filter will be applied across the slice boundary. + +``V4L2_CID_MPEG_VIDEO_HEVC_LF_BETA_OFFSET_DIV2`` + Selects HEVC loop filter beta offset. The valid range is [-6, +6]. + This could be a negative value in the 2's complement expression. + +``V4L2_CID_MPEG_VIDEO_HEVC_LF_TC_OFFSET_DIV2`` + Selects HEVC loop filter tc offset. The valid range is [-6, +6]. + This could be a negative value in the 2's complement expression. + +.. _v4l2-hevc-refresh-type: + +``V4L2_CID_MPEG_VIDEO_HEVC_REFRESH_TYPE`` + (enum) + +enum v4l2_mpeg_video_hevc_hier_refresh_type - + Selects refresh type for HEVC encoder. + Host has to specify the period into + HEVC_REFRESH_PERIOD. + +.. raw:: latex + + \begin{adjustbox}{width=\columnwidth} + +.. tabularcolumns:: |p{11.0cm}|p{10.0cm}| + +.. flat-table:: + :header-rows: 0 + :stub-columns: 0 + + * - ``V4L2_MPEG_VIDEO_HEVC_REFRESH_NONE`` + - Use the B frame for hierarchical coding. + * - ``V4L2_MPEG_VIDEO_HEVC_REFRESH_CRA`` + - Use CRA(Clean Random Access Unit) picture encoding. + * - ``V4L2_MPEG_VIDEO_HEVC_REFRESH_IDR`` + - Use IDR picture encoding. + +.. raw:: latex + + \end{adjustbox} + + +``V4L2_CID_MPEG_VIDEO_HEVC_REFRESH_PERIOD`` + Selects the refresh period for HEVC encoder. + This specifies the number of I picture between two CRA/IDR pictures. + This is valid only if REFRESH_TYPE is not 0. + +``V4L2_CID_MPEG_VIDEO_HEVC_LOSSLESS_CU`` + Indicates HEVC lossless encoding. Setting it to 0 disables lossless + encoding. Setting it to 1 enables lossless encoding. + +``V4L2_CID_MPEG_VIDEO_HEVC_CONST_INTRA_PRED`` + Indicates constant intra prediction for HEVC encoder. Specifies the + constrained intra prediction in which intra largest coding unit(LCU) + prediction is performed by using residual data and decoded samples of + neighboring intra LCU only. Setting it to 1 enables this control ID and + setting it to 0 disables the control ID. + +``V4L2_CID_MPEG_VIDEO_HEVC_WAVEFRONT`` + Indicates wavefront parallel processing for HEVC encoder. Setting it to 0 + disables the control ID and setting it to 1 enables the wavefront parallel + processing. + +``V4L2_CID_MPEG_VIDEO_HEVC_SIGN_DATA_HIDING`` + Setting it to 1 indicates sign data hiding for HEVC encoder. Setting it to + 0 disables the control ID. + +``V4L2_CID_MPEG_VIDEO_HEVC_GENERAL_PB`` + Setting the control ID to 1 enables general picture buffers for HEVC + encoder. + +``V4L2_CID_MPEG_VIDEO_HEVC_TEMPORAL_ID`` + Indicates temporal identifier specified as temporal_id in + nal_unit_header_svc_extension() for HEVC encoder which is enabled by + setting the control ID to 1. + +``V4L2_CID_MPEG_VIDEO_HEVC_STRONG_SMOOTHING`` + Indicates bi-linear interpolation is conditionally used in the intra + prediction filtering process in the CVS when set to 1. Indicates bi-linear + interpolation is not used in the CVS when set to 0. + +``V4L2_CID_MPEG_VIDEO_HEVC_MAX_NUM_MERGE_MV_MINUS1`` + Indicates max number of merge candidate motion vectors. + Values are from zero to four. + +``V4L2_CID_MPEG_VIDEO_HEVC_INTRA_PU_SPLIT`` + Indicates intra prediction unit split for HEVC Encoder. Setting it to 1 + disables the feature. Setting it to 1 enables the feature. + +``V4L2_CID_MPEG_VIDEO_HEVC_TMV_PREDICTION`` + Indicates temporal motion vector prediction for HEVC encoder. Setting it to + 0 enables the prediction. Setting it to 1 disables the prediction. + +``V4L2_CID_MPEG_VIDEO_HEVC_WITHOUT_STARTCODE`` + Specifies if HEVC generates a stream with a size of length field instead of + start code pattern. The size of the length field is configurable among 1,2 + or 4 thorugh the SIZE_OF_LENGTH_FIELD. It is not applied at SEQ_START. + Setting it to 0 disables the control ID. Setting it to 1 will enables + the control ID. + +``V4L2_CID_MPEG_VIDEO_HEVC_QP_INDEX_CR`` + Indicates the quantization parameter CR index. + +``V4L2_CID_MPEG_VIDEO_HEVC_QP_INDEX_CB`` + Indicates the quantization parameter CB index. + +.. _v4l2-hevc-size-of-length-field: + +``V4L2_CID_MPEG_VIDEO_HEVC_SIZE_OF_LENGTH_FIELD`` +(enum) + +enum v4l2_mpeg_video_hevc_size_of_length_field - + Indicates the size of length field. + This is valid when encoding WITHOUT_STARTCODE_ENABLE is enabled. + +.. raw:: latex + + \begin{adjustbox}{width=\columnwidth} + +.. tabularcolumns:: |p{11.0cm}|p{10.0cm}| + +.. flat-table:: + :header-rows: 0 + :stub-columns: 0 + + * - ``V4L2_MPEG_VIDEO_HEVC_SIZE_0`` + - Generate start code pattern (Normal). + * - ``V4L2_MPEG_VIDEO_HEVC_SIZE_1`` + - Generate size of length field instead of start code pattern and length is 1. + * - ``V4L2_MPEG_VIDEO_HEVC_SIZE_2`` + - Generate size of length field instead of start code pattern and length is 2. + * - ``V4L2_MPEG_VIDEO_HEVC_SIZE_4`` + - Generate size of length field instead of start code pattern and length is 4. + +.. raw:: latex + + \end{adjustbox} + +``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_LAYER0_BITRATE`` + Indicates bit rate for hierarchical coding layer 0 for HEVC encoder. + +``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_LAYER1_BITRATE`` + Indicates bit rate for hierarchical coding layer 1 for HEVC encoder. + +``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_LAYER2_BITRATE`` + Indicates bit rate for hierarchical coding layer 2 for HEVC encoder. + +``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_LAYER3_BITRATE`` + Indicates bit rate for hierarchical coding layer 3 for HEVC encoder. + +``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_LAYER4_BITRATE`` + Indicates bit rate for hierarchical coding layer 4 for HEVC encoder. + +``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_LAYER5_BITRATE`` + Indicates bit rate for hierarchical coding layer 5 for HEVC encoder. + +``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_LAYER6_BITRATE`` + Indicates bit rate for hierarchical coding layer 6 for HEVC encoder. + + +MFC 10.10 MPEG Controls +----------------------- + +The following MPEG class controls deal with MPEG decoding and encoding +settings that are specific to the Multi Format Codec 10.10 device present +in the S5P family of SoCs by Samsung. + + +.. _mfc1010-control-id: + +MFC 10.10 Control IDs +^^^^^^^^^^^^^^^^^^^^^ + +``V4L2_CID_MPEG_MFC1010_VIDEO_HEVC_REF_NUMBER_FOR_PFRAMES`` + Selects number of P reference picture required for HEVC encoder. + P-Frame can use 1 or 2 frames for reference. + +``V4L2_CID_MPEG_MFC1010_VIDEO_HEVC_ADAPTIVE_RC_DARK`` + Indicates HEVC dark region adaptive rate control. + +``V4L2_CID_MPEG_MFC1010_VIDEO_HEVC_ADAPTIVE_RC_SMOOTH`` + Indicates HEVC smooth region adaptive rate control. + +``V4L2_CID_MPEG_MFC1010_VIDEO_HEVC_ADAPTIVE_RC_STATIC`` + Indicates HEVC static region adaptive rate control. + +``V4L2_CID_MPEG_MFC1010_VIDEO_HEVC_ADAPTIVE_RC_ACTIVITY`` + Indicates HEVC activity region adaptive rate control. + +``V4L2_CID_MPEG_MFC1010_VIDEO_HEVC_PREPEND_SPSPPS_TO_IDR`` + Indicates whether to generate SPS and PPS at every IDR. Setting it to 0 + disables it and setting it to one enables the feature. + + .. _camera-controls: Camera Control Reference -- 2.7.4