BlockAudioEncoderInterface.h

Go to the documentation of this file.

/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 *
 *     http://aws.amazon.com/apache2.0/
 *
 * or in the "license" file accompanying this file. This file 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 ACSDK_AUDIOENCODERINTERFACES_BLOCKAUDIOENCODERINTERFACE_H_
#define ACSDK_AUDIOENCODERINTERFACES_BLOCKAUDIOENCODERINTERFACE_H_

#include <memory>
#include <vector>

#include <AVSCommon/Utils/AudioFormat.h>

namespace alexaClientSDK {
namespace audioEncoderInterfaces {

class BlockAudioEncoderInterface {
public:
    using Byte = unsigned char;

    using Bytes = std::vector<Byte>;

    virtual bool init(avsCommon::utils::AudioFormat inputFormat) = 0;

    virtual size_t getInputFrameSize() = 0;

    virtual size_t getOutputFrameSize() = 0;

    virtual bool requiresFullyRead() = 0;

    virtual avsCommon::utils::AudioFormat getAudioFormat() = 0;

    virtual std::string getAVSFormatName() = 0;

    virtual bool start(Bytes& preamble) = 0;

    virtual bool processSamples(Bytes::const_iterator begin, Bytes::const_iterator end, Bytes& buffer) = 0;

    virtual bool flush(Bytes& buffer) = 0;

    virtual void close() = 0;

    virtual ~BlockAudioEncoderInterface() = default;
};

}  // namespace audioEncoderInterfaces
}  // namespace alexaClientSDK

#endif  // ACSDK_AUDIOENCODERINTERFACES_BLOCKAUDIOENCODERINTERFACE_H_