1 /*
2  * Copyright © 2019 Intel Corporation
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a
5  * copy of this software and associated documentation files (the "Software"),
6  * to deal in the Software without restriction, including without limitation
7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8  * and/or sell copies of the Software, and to permit persons to whom the
9  * Software is furnished to do so, subject to the following conditions:
10  *
11  * The above copyright notice and this permission notice (including the next
12  * paragraph) shall be included in all copies or substantial portions of the
13  * Software.
14  *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
18  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
21  * IN THE SOFTWARE.
22  *
23  * Authors: Simon Ser <simon.ser@intel.com>
24  */
25 
26 #ifndef IGT_CHAMELIUM_STREAM_H
27 #define IGT_CHAMELIUM_STREAM_H
28 
29 #include "config.h"
30 
31 enum chamelium_stream_realtime_mode {
32 	CHAMELIUM_STREAM_REALTIME_NONE = 0,
33 	/* stop dumping when overflow */
34 	CHAMELIUM_STREAM_REALTIME_STOP_WHEN_OVERFLOW = 1,
35 	/* drop data on overflow */
36 	CHAMELIUM_STREAM_REALTIME_BEST_EFFORT = 2,
37 };
38 
39 struct chamelium_stream;
40 
41 struct chamelium_stream *chamelium_stream_init(void);
42 void chamelium_stream_deinit(struct chamelium_stream *client);
43 bool chamelium_stream_dump_realtime_audio(struct chamelium_stream *client,
44 					  enum chamelium_stream_realtime_mode mode);
45 bool chamelium_stream_receive_realtime_audio(struct chamelium_stream *client,
46 					     size_t *page_count,
47 					     int32_t **buf, size_t *buf_len);
48 bool chamelium_stream_stop_realtime_audio(struct chamelium_stream *client);
49 
50 #endif
51