1 /*
2  * Copyright (c) 2021 Rockchip Electronics Co., Ltd.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at
6  *
7  *     http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15 
16 #ifndef __MPP_PACKET_H__
17 #define __MPP_PACKET_H__
18 
19 #include "mpp_meta.h"
20 
21 #ifdef __cplusplus
22 extern "C" {
23 #endif
24 
25 /*
26  * MppPacket interface
27  *
28  * mpp_packet_init = mpp_packet_new + mpp_packet_set_data + mpp_packet_set_size
29  * mpp_packet_copy_init = mpp_packet_init + memcpy
30  */
31 MPP_RET mpp_packet_new(MppPacket *packet);
32 MPP_RET mpp_packet_init(MppPacket *packet, void *data, size_t size);
33 MPP_RET mpp_packet_init_with_buffer(MppPacket *packet, MppBuffer buffer);
34 MPP_RET mpp_packet_copy_init(MppPacket *packet, const MppPacket src);
35 MPP_RET mpp_packet_deinit(MppPacket *packet);
36 
37 /*
38  * data   : ( R/W ) start address of the whole packet memory
39  * size   : ( R/W ) total size of the whole packet memory
40  * pos    : ( R/W ) current access position of the whole packet memory, used for buffer read/write
41  * length : ( R/W ) the rest length from current position to end of buffer
42  *                  NOTE: normally length is updated only by set_pos,
43  *                        so set length must be used carefully for special usage
44  */
45 void    mpp_packet_set_data(MppPacket packet, void *data);
46 void    mpp_packet_set_size(MppPacket packet, size_t size);
47 void    mpp_packet_set_pos(MppPacket packet, void *pos);
48 void    mpp_packet_set_length(MppPacket packet, size_t size);
49 
50 void*   mpp_packet_get_data(const MppPacket packet);
51 void*   mpp_packet_get_pos(const MppPacket packet);
52 size_t  mpp_packet_get_size(const MppPacket packet);
53 size_t  mpp_packet_get_length(const MppPacket packet);
54 
55 
56 void    mpp_packet_set_pts(MppPacket packet, RK_S64 pts);
57 RK_S64  mpp_packet_get_pts(const MppPacket packet);
58 void    mpp_packet_set_dts(MppPacket packet, RK_S64 dts);
59 RK_S64  mpp_packet_get_dts(const MppPacket packet);
60 
61 void    mpp_packet_set_flag(MppPacket packet, RK_U32 flag);
62 RK_U32  mpp_packet_get_flag(const MppPacket packet);
63 
64 MPP_RET mpp_packet_set_eos(MppPacket packet);
65 MPP_RET mpp_packet_clr_eos(MppPacket packet);
66 RK_U32  mpp_packet_get_eos(MppPacket packet);
67 MPP_RET mpp_packet_set_extra_data(MppPacket packet);
68 
69 void        mpp_packet_set_buffer(MppPacket packet, MppBuffer buffer);
70 MppBuffer   mpp_packet_get_buffer(const MppPacket packet);
71 
72 /*
73  * data access interface
74  */
75 MPP_RET mpp_packet_read(MppPacket packet, size_t offset, void *data, size_t size);
76 MPP_RET mpp_packet_write(MppPacket packet, size_t offset, void *data, size_t size);
77 
78 /*
79  * meta data access interface
80  */
81 RK_S32  mpp_packet_has_meta(const MppPacket packet);
82 MppMeta mpp_packet_get_meta(const MppPacket packet);
83 
84 /*
85  * multi packet sequence interface for slice/split encoding/decoding
86  * partition - the packet is a part of a while image
87  * soi - Start Of Image
88  * eoi - End Of Image
89  */
90 RK_U32  mpp_packet_is_partition(const MppPacket packet);
91 RK_U32  mpp_packet_is_soi(const MppPacket packet);
92 RK_U32  mpp_packet_is_eoi(const MppPacket packet);
93 
94 #ifdef __cplusplus
95 }
96 #endif
97 
98 #endif /* __MPP_PACKET_H__ */
99