xref: /aosp_15_r20/hardware/interfaces/broadcastradio/2.0/default/VirtualRadio.h (revision 4d7e907c777eeecc4c5bd7cf640a754fac206ff7)

/*
 * Copyright (C) 2017 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
#ifndef ANDROID_HARDWARE_BROADCASTRADIO_V2_0_VIRTUALRADIO_H
#define ANDROID_HARDWARE_BROADCASTRADIO_V2_0_VIRTUALRADIO_H

#include "VirtualProgram.h"

#include <mutex>
#include <vector>

namespace android {
namespace hardware {
namespace broadcastradio {
namespace V2_0 {
namespace implementation {

/**
 * A radio frequency space mock.
 *
 * This represents all broadcast waves in the air for a given radio technology,
 * not a captured station list in the radio tuner memory.
 *
 * It's meant to abstract out radio content from default tuner implementation.
 */
class VirtualRadio {
   public:
    VirtualRadio(const std::string& name, const std::vector<VirtualProgram>& initialList);

    std::string getName() const;
    std::vector<VirtualProgram> getProgramList() const;
    bool getProgram(const ProgramSelector& selector, VirtualProgram& program) const;

   private:
    mutable std::mutex mMut;
    std::string mName;
    std::vector<VirtualProgram> mPrograms;
};

/** AM/FM virtual radio space. */
extern VirtualRadio gAmFmRadio;

/** DAB virtual radio space. */
extern VirtualRadio gDabRadio;

}  // namespace implementation
}  // namespace V2_0
}  // namespace broadcastradio
}  // namespace hardware
}  // namespace android

#endif  // ANDROID_HARDWARE_BROADCASTRADIO_V2_0_VIRTUALRADIO_H