device/inc/Device.h

/*
 * Copyright (c) 2019-2021, The Linux Foundation. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above
 *       copyright notice, this list of conditions and the following
 *       disclaimer in the documentation and/or other materials provided
 *       with the distribution.
 *     * Neither the name of The Linux Foundation nor the names of its
 *       contributors may be used to endorse or promote products derived
 *       from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
 * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
 * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * Changes from Qualcomm Innovation Center are provided under the following license:
 *
 * Copyright (c) 2022 Qualcomm Innovation Center, Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted (subject to the limitations in the
 * disclaimer below) provided that the following conditions are met:
 *
 *   * Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *
 *   * Redistributions in binary form must reproduce the above
 *     copyright notice, this list of conditions and the following
 *     disclaimer in the documentation and/or other materials provided
 *     with the distribution.
 *
 *   * Neither the name of Qualcomm Innovation Center, Inc. nor the names of its
 *     contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 *
 * NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE
 * GRANTED BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT
 * HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
 * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
 * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
 * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef DEVICE_H
#define DEVICE_H
#include <iostream>
#include <map>
#include <mutex>
#include <memory>
#include "PalApi.h"
#include "PalDefs.h"
#include <string.h>
#include "PalCommon.h"
#include "Device.h"
#include "PalAudioRoute.h"

#define DEVICE_NAME_MAX_SIZE 128
#define DUMP_DEV_ATTR 0

class Stream;
class ResourceManager;

class Device
{
protected:
    std::shared_ptr<Device> devObj;
    std::mutex mDeviceMutex;
    std::string mPALDeviceName;
    struct pal_device deviceAttr;
    std::shared_ptr<ResourceManager> rm;
    int deviceCount = 0;
    int deviceStartStopCount = 0;
    struct audio_route *audioRoute = NULL;   //getAudioRoute() from RM and store
    struct audio_mixer *audioMixer = NULL;   //getVirtualAudioMixer() from RM and store
    char mSndDeviceName[DEVICE_NAME_MAX_SIZE] = {0};
    void *customPayload;
    size_t customPayloadSize;
    std::string UpdatedSndName;
    uint32_t mCurrentPriority;
    //device atrributues per stream are stored by priority in a map
    std::multimap<uint32_t, std::pair<Stream *, struct pal_device *>> mStreamDevAttr;
    uint32_t mSampleRate = 0;

    Device(struct pal_device *device, std::shared_ptr<ResourceManager> Rm);
    Device();
    int32_t configureDeviceClockSrc(char const *mixerStrClockSrc, const uint32_t clockSrc);
public:
    virtual int init(pal_param_device_connection_t device_conn);
    virtual int deinit(pal_param_device_connection_t device_conn);
    virtual int getDefaultConfig(pal_param_device_capability_t capability);
    int open();
    virtual int close();
    virtual int start();
    int start_l();
    virtual int stop();
    int stop_l();
    int prepare();
    static std::shared_ptr<Device> getInstance(struct pal_device *device,
                                               std::shared_ptr<ResourceManager> Rm);
    int getSndDeviceId();
    int getDeviceCount() { return deviceCount; }
    std::string getPALDeviceName();
    int setDeviceAttributes(struct pal_device dattr);
    virtual int getDeviceAttributes(struct pal_device *dattr,
                                    Stream* streamHandle = NULL);
    virtual int getCodecConfig(struct pal_media_config *config);
    static std::shared_ptr<Device> getObject(pal_device_id_t dev_id);
    int updateCustomPayload(void *payload, size_t size);
    void* getCustomPayload();
    size_t getCustomPayloadSize();
    virtual int32_t setDeviceParameter(uint32_t param_id, void *param);
    virtual int32_t setParameter(uint32_t param_id, void *param);
    virtual int32_t getDeviceParameter(uint32_t param_id, void **param);
    virtual int32_t getParameter(uint32_t param_id, void **param);
    virtual bool isDeviceReady() { return true;}
    void setSndName (std::string snd_name) { UpdatedSndName = snd_name;}
    void clearSndName () { UpdatedSndName.clear();}
    virtual ~Device();
    void getCurrentSndDevName(char *name);
    void setSampleRate(uint32_t sr){mSampleRate = sr;};
    void lockDeviceMutex() { mDeviceMutex.lock(); };
    void unlockDeviceMutex() { mDeviceMutex.unlock(); };
    bool compareStreamDevAttr(const struct pal_device *inDevAttr,
                        const struct pal_device_info *inDevInfo,
                        struct pal_device *curDevAttr,
                        const struct pal_device_info *curDevInfo);
    int insertStreamDeviceAttr(struct pal_device *deviceAttr,
                                Stream* streamHandle);
    void removeStreamDeviceAttr(Stream* streamHandle);
    int getTopPriorityDeviceAttr(struct pal_device *deviceAttr, uint32_t *streamPrio);
};


#endif //DEVICE_H