xref: /aosp_15_r20/external/libmpeg2/common/impeg2_job_queue.h (revision a97c2a1f0a796dc32bed80d3353c69c5fc07c750)
1*a97c2a1fSXin Li /******************************************************************************
2*a97c2a1fSXin Li  *
3*a97c2a1fSXin Li  * Copyright (C) 2015 The Android Open Source Project
4*a97c2a1fSXin Li  *
5*a97c2a1fSXin Li  * Licensed under the Apache License, Version 2.0 (the "License");
6*a97c2a1fSXin Li  * you may not use this file except in compliance with the License.
7*a97c2a1fSXin Li  * You may obtain a copy of the License at:
8*a97c2a1fSXin Li  *
9*a97c2a1fSXin Li  * http://www.apache.org/licenses/LICENSE-2.0
10*a97c2a1fSXin Li  *
11*a97c2a1fSXin Li  * Unless required by applicable law or agreed to in writing, software
12*a97c2a1fSXin Li  * distributed under the License is distributed on an "AS IS" BASIS,
13*a97c2a1fSXin Li  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14*a97c2a1fSXin Li  * See the License for the specific language governing permissions and
15*a97c2a1fSXin Li  * limitations under the License.
16*a97c2a1fSXin Li  *
17*a97c2a1fSXin Li  *****************************************************************************
18*a97c2a1fSXin Li  * Originally developed and contributed by Ittiam Systems Pvt. Ltd, Bangalore
19*a97c2a1fSXin Li */
20*a97c2a1fSXin Li /**
21*a97c2a1fSXin Li *******************************************************************************
22*a97c2a1fSXin Li * @file
23*a97c2a1fSXin Li *  impeg2_job_queue.h
24*a97c2a1fSXin Li *
25*a97c2a1fSXin Li * @brief
26*a97c2a1fSXin Li *  Contains functions for job queue
27*a97c2a1fSXin Li *
28*a97c2a1fSXin Li * @author
29*a97c2a1fSXin Li *  Harish
30*a97c2a1fSXin Li *
31*a97c2a1fSXin Li * @par List of Functions:
32*a97c2a1fSXin Li *
33*a97c2a1fSXin Li * @remarks
34*a97c2a1fSXin Li *  None
35*a97c2a1fSXin Li *
36*a97c2a1fSXin Li *******************************************************************************
37*a97c2a1fSXin Li */
38*a97c2a1fSXin Li 
39*a97c2a1fSXin Li #ifndef _IMPEG2_JOB_QUEUE_H_
40*a97c2a1fSXin Li #define _IMPEG2_JOB_QUEUE_H_
41*a97c2a1fSXin Li 
42*a97c2a1fSXin Li typedef struct
43*a97c2a1fSXin Li {
44*a97c2a1fSXin Li     /** Pointer to buffer base which contains the jobs */
45*a97c2a1fSXin Li     void *pv_buf_base;
46*a97c2a1fSXin Li 
47*a97c2a1fSXin Li     /** Pointer to current address where new job can be added */
48*a97c2a1fSXin Li     void *pv_buf_wr;
49*a97c2a1fSXin Li 
50*a97c2a1fSXin Li     /** Pointer to current address from where next job can be obtained */
51*a97c2a1fSXin Li     void *pv_buf_rd;
52*a97c2a1fSXin Li 
53*a97c2a1fSXin Li     /** Pointer to end of job buffer */
54*a97c2a1fSXin Li     void *pv_buf_end;
55*a97c2a1fSXin Li 
56*a97c2a1fSXin Li     /** Mutex used to keep the functions thread-safe */
57*a97c2a1fSXin Li     void *pv_mutex;
58*a97c2a1fSXin Li 
59*a97c2a1fSXin Li     /** Flag to indicate jobq has to be terminated */
60*a97c2a1fSXin Li     WORD32 i4_terminate;
61*a97c2a1fSXin Li }jobq_t;
62*a97c2a1fSXin Li 
63*a97c2a1fSXin Li WORD32 impeg2_jobq_ctxt_size(void);
64*a97c2a1fSXin Li void* impeg2_jobq_init(void *pv_buf, WORD32 buf_size);
65*a97c2a1fSXin Li IV_API_CALL_STATUS_T impeg2_jobq_free(jobq_t *ps_jobq);
66*a97c2a1fSXin Li IV_API_CALL_STATUS_T impeg2_jobq_reset(jobq_t *ps_jobq);
67*a97c2a1fSXin Li IV_API_CALL_STATUS_T impeg2_jobq_deinit(jobq_t *ps_jobq);
68*a97c2a1fSXin Li IV_API_CALL_STATUS_T impeg2_jobq_terminate(jobq_t *ps_jobq);
69*a97c2a1fSXin Li IV_API_CALL_STATUS_T impeg2_jobq_queue(jobq_t *ps_jobq, void *pv_job, WORD32 job_size, WORD32 blocking, WORD32 lock);
70*a97c2a1fSXin Li IV_API_CALL_STATUS_T impeg2_jobq_dequeue(jobq_t *ps_jobq, void *pv_job, WORD32 job_size, WORD32 blocking, WORD32 lock);
71*a97c2a1fSXin Li 
72*a97c2a1fSXin Li #endif /* _IMPEG2_JOB_QUEUE_H_ */
73