xref: /aosp_15_r20/external/libhevc/encoder/ihevce_buffer_que_interface.h (revision c83a76b084498d55f252f48b2e3786804cdf24b7)
1*c83a76b0SSuyog Pawar /******************************************************************************
2*c83a76b0SSuyog Pawar  *
3*c83a76b0SSuyog Pawar  * Copyright (C) 2018 The Android Open Source Project
4*c83a76b0SSuyog Pawar  *
5*c83a76b0SSuyog Pawar  * Licensed under the Apache License, Version 2.0 (the "License");
6*c83a76b0SSuyog Pawar  * you may not use this file except in compliance with the License.
7*c83a76b0SSuyog Pawar  * You may obtain a copy of the License at:
8*c83a76b0SSuyog Pawar  *
9*c83a76b0SSuyog Pawar  * http://www.apache.org/licenses/LICENSE-2.0
10*c83a76b0SSuyog Pawar  *
11*c83a76b0SSuyog Pawar  * Unless required by applicable law or agreed to in writing, software
12*c83a76b0SSuyog Pawar  * distributed under the License is distributed on an "AS IS" BASIS,
13*c83a76b0SSuyog Pawar  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14*c83a76b0SSuyog Pawar  * See the License for the specific language governing permissions and
15*c83a76b0SSuyog Pawar  * limitations under the License.
16*c83a76b0SSuyog Pawar  *
17*c83a76b0SSuyog Pawar  *****************************************************************************
18*c83a76b0SSuyog Pawar  * Originally developed and contributed by Ittiam Systems Pvt. Ltd, Bangalore
19*c83a76b0SSuyog Pawar */
20*c83a76b0SSuyog Pawar /*!
21*c83a76b0SSuyog Pawar ******************************************************************************
22*c83a76b0SSuyog Pawar * \file ihevce_buffer_que_interface.h
23*c83a76b0SSuyog Pawar *
24*c83a76b0SSuyog Pawar * \brief
25*c83a76b0SSuyog Pawar *    This file contains interface prototypes of Buffer Queue manager functions
26*c83a76b0SSuyog Pawar *
27*c83a76b0SSuyog Pawar * \date
28*c83a76b0SSuyog Pawar *    18/09/2012
29*c83a76b0SSuyog Pawar *
30*c83a76b0SSuyog Pawar * \author
31*c83a76b0SSuyog Pawar *    Ittiam
32*c83a76b0SSuyog Pawar *
33*c83a76b0SSuyog Pawar ******************************************************************************
34*c83a76b0SSuyog Pawar */
35*c83a76b0SSuyog Pawar 
36*c83a76b0SSuyog Pawar #ifndef _IHEVCE_BUFFER_QUE_INTERFACE_H_
37*c83a76b0SSuyog Pawar #define _IHEVCE_BUFFER_QUE_INTERFACE_H_
38*c83a76b0SSuyog Pawar 
39*c83a76b0SSuyog Pawar /*****************************************************************************/
40*c83a76b0SSuyog Pawar /* Extern Function Declarations                                              */
41*c83a76b0SSuyog Pawar /*****************************************************************************/
42*c83a76b0SSuyog Pawar 
43*c83a76b0SSuyog Pawar /* Create APIs */
44*c83a76b0SSuyog Pawar WORD32 ihevce_buff_que_get_num_mem_recs(void);
45*c83a76b0SSuyog Pawar 
46*c83a76b0SSuyog Pawar WORD32 ihevce_buff_que_get_mem_recs(
47*c83a76b0SSuyog Pawar     iv_mem_rec_t *ps_mem_tab, WORD32 max_num_bufs_in_que, WORD32 i4_mem_space);
48*c83a76b0SSuyog Pawar 
49*c83a76b0SSuyog Pawar void *ihevce_buff_que_init(iv_mem_rec_t *ps_mem_tab, WORD32 num_bufs_in_que, void **ppv_buff_ptrs);
50*c83a76b0SSuyog Pawar 
51*c83a76b0SSuyog Pawar /* Process APIs */
52*c83a76b0SSuyog Pawar void *ihevce_buff_que_get_free_buf(void *pv_buf_que, WORD32 *pi4_id);
53*c83a76b0SSuyog Pawar 
54*c83a76b0SSuyog Pawar void *ihevce_buff_que_get_next_buf(void *pv_buf_que, WORD32 *pi4_id);
55*c83a76b0SSuyog Pawar 
56*c83a76b0SSuyog Pawar void *ihevce_buff_que_get_next_reorder_buf(void *pv_buf_que, WORD32 *pi4_id);
57*c83a76b0SSuyog Pawar 
58*c83a76b0SSuyog Pawar WORD32 ihevce_buff_que_set_buf_prod(void *pv_buf_que, WORD32 buf_id, WORD32 num_users);
59*c83a76b0SSuyog Pawar /*!< Note :The manager assumes that once a buffer is requested from Q atleast
60*c83a76b0SSuyog Pawar  * one consumer will consume it. so num_uers should be 0 when buffer has only
61*c83a76b0SSuyog Pawar  * one consumer, In general num_users should be passed as MAX num
62*c83a76b0SSuyog Pawar  * consumers - 1 */
63*c83a76b0SSuyog Pawar 
64*c83a76b0SSuyog Pawar WORD32 ihevce_buff_que_rel_buf(void *pv_buf_que, WORD32 buf_id);
65*c83a76b0SSuyog Pawar 
66*c83a76b0SSuyog Pawar WORD32 ihevce_buff_que_get_active_bufs(void *pv_buf_que);
67*c83a76b0SSuyog Pawar 
68*c83a76b0SSuyog Pawar WORD32 ihevce_buff_que_set_reorder_buf(void *pv_buf_que, WORD32 buf_id);
69*c83a76b0SSuyog Pawar 
70*c83a76b0SSuyog Pawar void *ihevce_buff_que_get_buf(void *pv_buf_que, WORD32 i4_id);
71*c83a76b0SSuyog Pawar 
72*c83a76b0SSuyog Pawar #endif /* _IHEVCE_BUFFER_QUE_INTERFACE_H_ */
73