1 /*
2  * Copyright (C) 2017 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 #ifndef ANDROID_HARDWARE_BROADCASTRADIO_V1_1_VIRTUALRADIO_H
17 #define ANDROID_HARDWARE_BROADCASTRADIO_V1_1_VIRTUALRADIO_H
18 
19 #include "VirtualProgram.h"
20 
21 #include <mutex>
22 #include <vector>
23 
24 namespace android {
25 namespace hardware {
26 namespace broadcastradio {
27 namespace V1_1 {
28 namespace implementation {
29 
30 /**
31  * A radio frequency space mock.
32  *
33  * This represents all broadcast waves in the air for a given radio technology,
34  * not a captured station list in the radio tuner memory.
35  *
36  * It's meant to abstract out radio content from default tuner implementation.
37  */
38 class VirtualRadio {
39    public:
40     VirtualRadio(const std::vector<VirtualProgram> initialList);
41 
42     std::vector<VirtualProgram> getProgramList();
43     bool getProgram(const V1_1::ProgramSelector& selector, VirtualProgram& program);
44 
45    private:
46     std::mutex mMut;
47     std::vector<VirtualProgram> mPrograms;
48 };
49 
50 /**
51  * Get virtual radio space for a given radio class.
52  *
53  * As a space, each virtual radio always exists. For example, DAB frequencies
54  * exists in US, but contains no programs.
55  *
56  * The lifetime of the virtual radio space is virtually infinite, but for the
57  * needs of default implementation, it's bound with the lifetime of default
58  * implementation process.
59  *
60  * Internally, it's a static object, so trying to access the reference during
61  * default implementation library unloading may result in segmentation fault.
62  * It's unlikely for testing purposes.
63  *
64  * @param classId A class of radio technology.
65  * @return A reference to virtual radio space for a given technology.
66  */
67 VirtualRadio& getRadio(V1_0::Class classId);
68 
69 VirtualRadio& getAmRadio();
70 VirtualRadio& getFmRadio();
71 VirtualRadio& getSatRadio();
72 VirtualRadio& getDigitalRadio();
73 
74 }  // namespace implementation
75 }  // namespace V1_1
76 }  // namespace broadcastradio
77 }  // namespace hardware
78 }  // namespace android
79 
80 #endif  // ANDROID_HARDWARE_BROADCASTRADIO_V1_1_VIRTUALRADIO_H
81