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
22extern "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 */
31MPP_RET mpp_packet_new(MppPacket *packet);
32MPP_RET mpp_packet_init(MppPacket *packet, void *data, size_t size);
33MPP_RET mpp_packet_init_with_buffer(MppPacket *packet, MppBuffer buffer);
34MPP_RET mpp_packet_copy_init(MppPacket *packet, const MppPacket src);
35MPP_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 */
45void mpp_packet_set_data(MppPacket packet, void *data);
46void mpp_packet_set_size(MppPacket packet, size_t size);
47void mpp_packet_set_pos(MppPacket packet, void *pos);
48void mpp_packet_set_length(MppPacket packet, size_t size);
49
50void *mpp_packet_get_data(const MppPacket packet);
51void *mpp_packet_get_pos(const MppPacket packet);
52size_t mpp_packet_get_size(const MppPacket packet);
53size_t mpp_packet_get_length(const MppPacket packet);
54
55void mpp_packet_set_pts(MppPacket packet, RK_S64 pts);
56RK_S64 mpp_packet_get_pts(const MppPacket packet);
57void mpp_packet_set_dts(MppPacket packet, RK_S64 dts);
58RK_S64 mpp_packet_get_dts(const MppPacket packet);
59
60void mpp_packet_set_flag(MppPacket packet, unsigned int flag);
61unsigned int mpp_packet_get_flag(const MppPacket packet);
62
63MPP_RET mpp_packet_set_eos(MppPacket packet);
64MPP_RET mpp_packet_clr_eos(MppPacket packet);
65unsigned int mpp_packet_get_eos(MppPacket packet);
66MPP_RET mpp_packet_set_extra_data(MppPacket packet);
67
68void mpp_packet_set_buffer(MppPacket packet, MppBuffer buffer);
69MppBuffer mpp_packet_get_buffer(const MppPacket packet);
70
71/*
72 * data access interface
73 */
74MPP_RET mpp_packet_read(MppPacket packet, size_t offset, void *data, size_t size);
75MPP_RET mpp_packet_write(MppPacket packet, size_t offset, void *data, size_t size);
76
77/*
78 * meta data access interface
79 */
80signed int mpp_packet_has_meta(const MppPacket packet);
81MppMeta mpp_packet_get_meta(const MppPacket packet);
82
83/*
84 * multi packet sequence interface for slice/split encoding/decoding
85 * partition - the packet is a part of a while image
86 * soi - Start Of Image
87 * eoi - End Of Image
88 */
89unsigned int mpp_packet_is_partition(const MppPacket packet);
90unsigned int mpp_packet_is_soi(const MppPacket packet);
91unsigned int mpp_packet_is_eoi(const MppPacket packet);
92
93#ifdef __cplusplus
94}
95#endif
96
97#endif /* __MPP_PACKET_H__ */
98