Line data Source code
1 : /*
2 : * If not stated otherwise in this file or this component's LICENSE file the
3 : * following copyright and licenses apply:
4 : *
5 : * Copyright 2023 Sky UK
6 : *
7 : * Licensed under the Apache License, Version 2.0 (the "License");
8 : * you may not use this file except in compliance with the License.
9 : * You may obtain a copy of the License at
10 : *
11 : * http://www.apache.org/licenses/LICENSE-2.0
12 : *
13 : * Unless required by applicable law or agreed to in writing, software
14 : * distributed under the License is distributed on an "AS IS" BASIS,
15 : * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 : * See the License for the specific language governing permissions and
17 : * limitations under the License.
18 : */
19 :
20 : #ifndef FIREBOLT_RIALTO_CLIENT_I_WEB_AUDIO_PLAYER_IPC_H_
21 : #define FIREBOLT_RIALTO_CLIENT_I_WEB_AUDIO_PLAYER_IPC_H_
22 :
23 : #include <stdint.h>
24 :
25 : #include <memory>
26 : #include <string>
27 :
28 : #include <IMediaPipeline.h>
29 : #include <MediaCommon.h>
30 :
31 : #include "IWebAudioPlayerIpcClient.h"
32 :
33 : namespace firebolt::rialto::client
34 : {
35 : class IWebAudioPlayerIpc;
36 : class IIpcClient;
37 :
38 : /**
39 : * @brief IWebAudioPlayerIpc factory class, returns a concrete implementation of IWebAudioPlayerIpc
40 : */
41 : class IWebAudioPlayerIpcFactory
42 : {
43 : public:
44 34 : IWebAudioPlayerIpcFactory() = default;
45 34 : virtual ~IWebAudioPlayerIpcFactory() = default;
46 :
47 : /**
48 : * @brief Gets the IWebAudioPlayerIpcFactory instance.
49 : *
50 : * @retval the factory instance or null on error.
51 : */
52 : static std::shared_ptr<IWebAudioPlayerIpcFactory> getFactory();
53 :
54 : /**
55 : * @brief Creates a IWebAudioPlayerIpc object.
56 : *
57 : * @param[in] client : The Rialto ipc web audio player client.
58 : *
59 : * @retval the new web audio player ipc instance or null on error.
60 : */
61 : virtual std::unique_ptr<IWebAudioPlayerIpc>
62 : createWebAudioPlayerIpc(IWebAudioPlayerIpcClient *client, const std::string &audioMimeType, const uint32_t priority,
63 : std::weak_ptr<const WebAudioConfig> config, std::weak_ptr<IIpcClient> ipcClient = {}) = 0;
64 : };
65 :
66 : /**
67 : * @brief The definition of the IWebAudioPlayerIpc interface.
68 : *
69 : * This interface defines the web audio player ipc APIs that are used to communicate with the Rialto server.
70 : */
71 : class IWebAudioPlayerIpc
72 : {
73 : public:
74 76 : IWebAudioPlayerIpc() = default;
75 76 : virtual ~IWebAudioPlayerIpc() = default;
76 :
77 : IWebAudioPlayerIpc(const IWebAudioPlayerIpc &) = delete;
78 : IWebAudioPlayerIpc &operator=(const IWebAudioPlayerIpc &) = delete;
79 : IWebAudioPlayerIpc(IWebAudioPlayerIpc &&) = delete;
80 : IWebAudioPlayerIpc &operator=(IWebAudioPlayerIpc &&) = delete;
81 :
82 : /**
83 : * @brief Play the web audio.
84 : *
85 : * @retval true on success.
86 : */
87 : virtual bool play() = 0;
88 :
89 : /**
90 : * @brief Pause the web audio.
91 : *
92 : * @retval true on success.
93 : */
94 : virtual bool pause() = 0;
95 :
96 : /**
97 : * @brief Notify EOS.
98 : *
99 : * @retval true on success.
100 : */
101 : virtual bool setEos() = 0;
102 :
103 : /**
104 : * @brief Get the available frames.
105 : *
106 : * @param[out] availableFrames : Number of frames available to be written.
107 : * @param[out] webAudioShmInfo : Location in shm to write the data.
108 : *
109 : * @retval true on success.
110 : */
111 : virtual bool getBufferAvailable(uint32_t &availableFrames,
112 : const std::shared_ptr<WebAudioShmInfo> &webAudioShmInfo) = 0;
113 :
114 : /**
115 : * @brief Get the delay frames.
116 : *
117 : * Gets the frame delay of the playback from Rialto. Frame delay is the number
118 : * of frames left to play by the server.
119 : *
120 : * @param[out] delayFrames : Number of frames to be played.
121 : *
122 : * @retval true on success.
123 : */
124 : virtual bool getBufferDelay(uint32_t &delayFrames) = 0;
125 :
126 : /**
127 : * @brief Write audio frames
128 : *
129 : * Sends a buffer of audio data for playback
130 : *
131 : * @param[in] numberOfFrames : Number of frames written to shared memory.
132 : *
133 : * @retval true on success.
134 : */
135 : virtual bool writeBuffer(const uint32_t numberOfFrames) = 0;
136 :
137 : /**
138 : * @brief Get device information.
139 : *
140 : * @param[out] preferredFrames : preferred number of frames to be commited.
141 : * @param[out] maximumFrames : Maximum number of frames that can be commited.
142 : * @param[out] supportDeferredPlay : Whether defered play is supported.
143 : *
144 : * @retval true on success.
145 : */
146 : virtual bool getDeviceInfo(uint32_t &preferredFrames, uint32_t &maximumFrames, bool &supportDeferredPlay) = 0;
147 :
148 : /**
149 : *
150 : * @brief Set level and transition of audio attenuation
151 : *
152 : * @param[in] volume : Target volume level (0.0 - 1.0)
153 : *
154 : * @retval true on success false otherwise
155 : */
156 : virtual bool setVolume(double volume) = 0;
157 :
158 : /**
159 : * @brief Get current audio level
160 : *
161 : * @param[out] volume : Current volume level (range 0.0 - 1.0)
162 : *
163 : * @retval true on success false otherwise
164 : */
165 : virtual bool getVolume(double &volume) = 0;
166 : };
167 :
168 : }; // namespace firebolt::rialto::client
169 :
170 : #endif // FIREBOLT_RIALTO_CLIENT_I_WEB_AUDIO_PLAYER_IPC_H_
|
