xref: /aosp_15_r20/external/mesa3d/src/amd/vpelib/src/chip/vpe10/inc/vpe10_plane_desc_writer.h (revision 6104692788411f58d303aa86923a9ff6ecaded22)
1 /* Copyright 2024 Advanced Micro Devices, Inc.
2  *
3  * Permission is hereby granted, free of charge, to any person obtaining a
4  * copy of this software and associated documentation files (the "Software"),
5  * to deal in the Software without restriction, including without limitation
6  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
7  * and/or sell copies of the Software, and to permit persons to whom the
8  * Software is furnished to do so, subject to the following conditions:
9  *
10  * The above copyright notice and this permission notice shall be included in
11  * all copies or substantial portions of the Software.
12  *
13  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
16  * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
17  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
18  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
19  * OTHER DEALINGS IN THE SOFTWARE.
20  *
21  * Authors: AMD
22  *
23  */
24 
25 #pragma once
26 
27 #include "vpe_types.h"
28 #include "plane_desc_writer.h"
29 
30 #ifdef __cplusplus
31 extern "C" {
32 #endif
33 
34 /** initialize the plane descriptor writer.
35  * Calls right before building any plane descriptor
36  *
37  * /param   writer               writer instance
38  * /param   buf                  points to the current buf,
39  * /param   plane_desc_header    header
40  */
41 
42 void vpe10_plane_desc_writer_init(
43     struct plane_desc_writer *writer, struct vpe_buf *buf, struct plane_desc_header *header);
44 
45 /** fill the value to the embedded buffer. */
46 void vpe10_plane_desc_writer_add_source(
47     struct plane_desc_writer *writer, struct plane_desc_src *source, bool is_plane0);
48 
49 /** fill the value to the embedded buffer. */
50 void vpe10_plane_desc_writer_add_destination(
51     struct plane_desc_writer *writer, struct plane_desc_dst *destination, bool is_plane0);
52 
53 void vpe10_construct_plane_desc_writer(struct plane_desc_writer *writer);
54 
55 #ifdef __cplusplus
56 }
57 #endif
58