/*
 * 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_AAUDIO_BINDING_AAUDIO_SERVICE_INTERFACE_H
#define ANDROID_AAUDIO_BINDING_AAUDIO_SERVICE_INTERFACE_H

#include <audio_utils/TimerQueue.h>
#include <media/AudioClient.h>
#include <media/AudioResamplerPublic.h>
#include <utils/StrongPointer.h>

#include "aaudio/IAAudioClient.h"
#include "binding/AAudioServiceDefinitions.h"
#include "binding/AAudioStreamRequest.h"
#include "binding/AAudioStreamConfiguration.h"
#include "binding/AudioEndpointParcelable.h"

/**
 * This has the same methods as IAAudioService but without the Binder features.
 *
 * It allows us to abstract the Binder interface and use an AudioStreamInternal
 * both in the client and in the service.
 */
namespace aaudio {

class AAudioServiceInterface {
public:

    AAudioServiceInterface() = default;
    virtual ~AAudioServiceInterface() = default;

    virtual void registerClient(const android::sp<IAAudioClient>& client) = 0;

    /**
     * @param request info needed to create the stream
     * @param configuration contains information about the created stream
     * @return an object for aaudio handle information, which includes the connected
     *         aaudio service lifetime id to recognize the connected aaudio service
     *         and aaudio handle to recognize the stream. If an error occurs, the
     *         aaudio handle will be set as the negative error.
     */
    virtual AAudioHandleInfo openStream(const AAudioStreamRequest &request,
                                        AAudioStreamConfiguration &configuration) = 0;

    virtual aaudio_result_t closeStream(const AAudioHandleInfo& streamHandleInfo) = 0;

    /* Get an immutable description of the in-memory queues
    * used to communicate with the underlying HAL or Service.
    */
    virtual aaudio_result_t getStreamDescription(const AAudioHandleInfo& streamHandleInfo,
                                                 AudioEndpointParcelable &parcelable) = 0;

    /**
     * Start the flow of data.
     */
    virtual aaudio_result_t startStream(const AAudioHandleInfo& streamHandleInfo) = 0;

    /**
     * Stop the flow of data such that start() can resume without loss of data.
     */
    virtual aaudio_result_t pauseStream(const AAudioHandleInfo& streamHandleInfo) = 0;

    /**
     * Stop the flow of data after data currently in the buffer has played.
     */
    virtual aaudio_result_t stopStream(const AAudioHandleInfo& streamHandleInfo) = 0;

    /**
     *  Discard any data held by the underlying HAL or Service.
     */
    virtual aaudio_result_t flushStream(const AAudioHandleInfo& streamHandleInfo) = 0;

    /**
     * Manage the specified thread as a low latency audio thread.
     */
    virtual aaudio_result_t registerAudioThread(const AAudioHandleInfo& streamHandleInfo,
                                                pid_t clientThreadId,
                                                int64_t periodNanoseconds) = 0;

    virtual aaudio_result_t unregisterAudioThread(const AAudioHandleInfo& streamHandleInfo,
                                                  pid_t clientThreadId) = 0;

    virtual aaudio_result_t startClient(const AAudioHandleInfo& streamHandleInfo,
                                        const android::AudioClient& client,
                                        const audio_attributes_t *attr,
                                        audio_port_handle_t *clientHandle) = 0;

    virtual aaudio_result_t stopClient(const AAudioHandleInfo& streamHandleInfo,
                                       audio_port_handle_t clientHandle) = 0;

    /**
     * Exit the standby mode.
     *
     * @param streamHandle the stream handle
     * @param parcelable contains new data queue information
     * @return the result of the execution
     */
    virtual aaudio_result_t exitStandby(const AAudioHandleInfo& streamHandleInfo,
                                        AudioEndpointParcelable &parcelable) = 0;

    /**
     * AAudio service will send timestamp periodically. Client call this method to trigger
     * a timestamp update immediately.
     *
     * @param streamHandleInfo the stream handle
     * @return
     */
    virtual aaudio_result_t updateTimestamp(const AAudioHandleInfo& streamHandleInfo) = 0;

    /**
     * This is currently only used for offload playback.
     *
     * Notify service to drain all data. Client won't write any more data before it is closed
     * to render all data. When draining, the device may be suspended. If the device is suspended,
     * it can only be woken up from the service side or by user's input. In that case, a wake up
     * time is sent to service side to wake up the client at the requested time.
     *
     * @param streamHandleInfo stream handle to identify the stream.
     * @param wakeUpNanos the timestamp in boottime nanoseconds that the client must be waken up.
     * @param allowSoftWakeUp allow the service side to wake up the client even if it is not the
     *                        requested time. This allows service side to smartly select wake up
     *                        time instead of waiting for the exact wake up time.
     * @param handle the handle to identify the task in TimerQueue at service side. Use this handle
     *               to remove the wake up task if the wake up task is no longer needed.
     * @return AAUDIO_OK if the service side successfully receives the drain command.
     */
    virtual aaudio_result_t drainStream(const AAudioHandleInfo& streamHandleInfo,
                                        int64_t wakeUpNanos,
                                        bool allowSoftWakeUp,
                                        android::audio_utils::TimerQueue::handle_t* handle) = 0;

    /**
     * This is currently only used for offload playback.
     *
     * This method is used to when the client is no longer suspended for draining.
     *
     * @param streamHandleInfo stream handle to identify the stream.
     * @param handle the handle to identify the wake up task in TimerQueue at service side.
     *               It is used by service side to remove wake up task.
     * @return
     */
    virtual aaudio_result_t activateStream(const AAudioHandleInfo& streamHandleInfo,
                                           android::audio_utils::TimerQueue::handle_t handle) = 0;

    /**
     * Set playback parameters for the stream.
     *
     * @param streamHandleInfo
     * @param rate
     * @return
     */
    virtual aaudio_result_t setPlaybackParameters(const AAudioHandleInfo& streamHandleInfo,
                                                  const android::AudioPlaybackRate& rate) = 0;

    /**
     * Get playback parameters for the stream.
     *
     * @param streamHandleInfo
     * @param rate
     * @return
     */
    virtual aaudio_result_t getPlaybackParameters(const AAudioHandleInfo& streamHandleInfo,
                                                  android::AudioPlaybackRate* rate) = 0;
};

} /* namespace aaudio */

#endif //ANDROID_AAUDIO_BINDING_AAUDIO_SERVICE_INTERFACE_H