stream/inc/StreamCommon.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.
 */

#ifndef STREAMCOMMON_H_
#define STREAMCOMMON_H_

#include "Stream.h"

#define GET_DIR_STR(X) (X == PAL_AUDIO_OUTPUT)? "RX": (X == PAL_AUDIO_INPUT)? "TX": "TX_RX"

class ResourceManager;
class Device;
class Session;

/*
 * use this common class to pass parameters to Stream,
 * which avoids duplicating codes between StreamContextProxy,
 * StreamUltraSound, and StreamSensorPCMData.
 */
class StreamCommon : public Stream
{
public:
    StreamCommon(const struct pal_stream_attributes *sattr, struct pal_device *dattr,
                 const uint32_t no_of_devices, const struct modifier_kv *modifiers,
                 const uint32_t no_of_modifiers, const std::shared_ptr<ResourceManager> rm);
    ~StreamCommon();
    uint64_t cookie_;
    pal_stream_callback callback_= 0;
    int32_t open() override;
    int32_t close() override;
    int32_t start() override;
    int32_t stop() override;
    int32_t prepare() override {return 0;}
    int32_t setStreamAttributes( struct pal_stream_attributes *sattr __unused) override {return 0;}
    int32_t setVolume( struct pal_volume_data *volume) override;
    int32_t mute(bool state __unused) override {return 0;}
    int32_t mute_l(bool state __unused) override {return 0;}
    int32_t pause() override {return 0;}
    int32_t pause_l() override {return 0;}
    int32_t resume() override {return 0;}
    int32_t resume_l() override {return 0;}
    int32_t flush() {return 0;}
    int32_t addRemoveEffect(pal_audio_effect_t effect __unused, bool enable __unused) override {return 0;}
    int32_t read(struct pal_buffer *buf __unused) override {return 0;}
    int32_t write(struct pal_buffer *buf __unused) override {return 0;}
    int32_t registerCallBack(pal_stream_callback cb, uint64_t cookie) override;
    int32_t getCallBack(pal_stream_callback *cb __unused) override {return 0;}
    int32_t getParameters(uint32_t param_id __unused, void **payload __unused) override {return 0;}
    int32_t setParameters(uint32_t param_id __unused, void *payload __unused) override {return 0;}
    int32_t setECRef(std::shared_ptr<Device> dev __unused, bool is_enable __unused) override {return 0;}
    int32_t setECRef_l(std::shared_ptr<Device> dev __unused, bool is_enable __unused) override {return 0;}
    int32_t ssrDownHandler() override;
    int32_t ssrUpHandler() override;
    int32_t createMmapBuffer(int32_t min_size_frames __unused,
                             struct pal_mmap_buffer *info __unused) override {return 0;}
    int32_t GetMmapPosition(struct pal_mmap_position *position __unused) override {return 0;}
    int32_t start_device();
    int32_t startSession();
    int32_t getTagsWithModuleInfo(size_t *size, uint8_t *payload);
    static int32_t isSampleRateSupported(uint32_t sampleRate __unused) {return 0;}
    static int32_t isChannelSupported(uint32_t numChannels __unused) {return 0;}
    static int32_t isBitWidthSupported(uint32_t bitWidth __unused) {return 0;}
};

#endif//STREAMCOMMON_H_