IWebAudioPlayer.h

Go to the documentation of this file.

/*
 * If not stated otherwise in this file or this component's LICENSE file the
 * following copyright and licenses apply:
 *
 * Copyright 2022 Sky UK
 *
 * 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 FIREBOLT_RIALTO_I_WEB_AUDIO_PLAYER_H_
#define FIREBOLT_RIALTO_I_WEB_AUDIO_PLAYER_H_
 
#include <memory>
#include <stdint.h>
#include <string>
 
#include "IWebAudioPlayerClient.h"
#include "MediaCommon.h"
 
namespace firebolt::rialto
{
class IWebAudioPlayer;
 
class IWebAudioPlayerFactory
{
public:
    IWebAudioPlayerFactory() = default;
    virtual ~IWebAudioPlayerFactory() = default;
 
    static std::shared_ptr<IWebAudioPlayerFactory> createFactory();
 
    virtual std::unique_ptr<IWebAudioPlayer> createWebAudioPlayer(std::weak_ptr<IWebAudioPlayerClient> client,
                                                                  const std::string &audioMimeType,
                                                                  const uint32_t priority,
                                                                  std::weak_ptr<const WebAudioConfig> config) const = 0;
};
 
class IWebAudioPlayer
{
public:
    IWebAudioPlayer() = default;
    virtual ~IWebAudioPlayer() = default;
 
    IWebAudioPlayer(const IWebAudioPlayer &) = delete;
    IWebAudioPlayer &operator=(const IWebAudioPlayer &) = delete;
    IWebAudioPlayer(IWebAudioPlayer &&) = delete;
    IWebAudioPlayer &operator=(IWebAudioPlayer &&) = delete;
 
    virtual bool play() = 0;
 
    virtual bool pause() = 0;
 
    virtual bool setEos() = 0;
 
    virtual bool getBufferAvailable(uint32_t &availableFrames, std::shared_ptr<WebAudioShmInfo> &webAudioShmInfo) = 0;
 
    virtual bool getBufferDelay(uint32_t &delayFrames) = 0;
 
    virtual bool writeBuffer(const uint32_t numberOfFrames, void *data) = 0;
 
    virtual bool getDeviceInfo(uint32_t &preferredFrames, uint32_t &maximumFrames, bool &supportDeferredPlay) = 0;
 
    virtual bool setVolume(double volume) = 0;
 
    virtual bool getVolume(double &volume) = 0;
 
    virtual std::weak_ptr<IWebAudioPlayerClient> getClient() = 0;
};
 
}; // namespace firebolt::rialto
 
#endif // FIREBOLT_RIALTO_I_WEB_AUDIO_PLAYER_H_