* Copyright (C) 2023 Huawei Device Co., Ltd.
* 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 MEDIA_AVCODEC_VIDEO_ENCODER_H
#define MEDIA_AVCODEC_VIDEO_ENCODER_H
#include "avcodec_common.h"
#include "avcodec_info.h"
#include "buffer/avsharedmemory.h"
#include "meta/format.h"
#include "surface.h"
namespace OHOS {
namespace MediaAVCodec {
class AVCodecVideoEncoder {
public:
virtual ~AVCodecVideoEncoder() = default;
* @brief Configure the encoder. This interface must be called before {@link Prepare} is called.
*
* @param format The format of the input data and the desired format of the output data.
* @return Returns {@link AVCS_ERR_OK} if success; returns an error code otherwise.
* @since 3.1
* @version 3.1
*/
virtual int32_t Configure(const Format &format) = 0;
* @brief Prepare for decoding.
*
* This function must be called after {@link Configure} and before {@link Start}
*
* @return Returns {@link AVCS_ERR_OK} if success; returns an error code otherwise.
* @since 3.1
* @version 3.1
*/
virtual int32_t Prepare() = 0;
* @brief Start decoding.
*
* @return Returns {@link AVCS_ERR_OK} if success; returns an error code otherwise.
* @since 3.1
* @version 3.1
*/
virtual int32_t Start() = 0;
* @brief Stop decoding.
*
* This function must be called during running
*
* @return Returns {@link AVCS_ERR_OK} if success; returns an error code otherwise.
* @since 3.1
* @version 3.1
*/
virtual int32_t Stop() = 0;
* @brief Flush both input and output buffers of the encoder.
*
* @return Returns {@link AVCS_ERR_OK} if success; returns an error code otherwise.
* @since 3.1
* @version 3.1
*/
virtual int32_t Flush() = 0;
* @brief Notify eos of the encoder. It is recommended to use this interface to notify
* the encoder of the end of the stream in surface mode.
*
* @return Returns {@link AVCS_ERR_OK} if success; returns an error code otherwise.
* @since 3.1
* @version 3.1
*/
virtual int32_t NotifyEos() = 0;
* @brief Restores the encoder to the initial state.
*
* @return Returns {@link AVCS_ERR_OK} if success; returns an error code otherwise.
* @since 3.1
* @version 3.1
*/
virtual int32_t Reset() = 0;
* @brief Releases encoder resources. All methods are unavailable after calling this.
*
* @return Returns {@link AVCS_ERR_OK} if success; returns an error code otherwise.
* @since 3.1
* @version 3.1
*/
virtual int32_t Release() = 0;
* @brief Obtains the surface from encoder.
*
* This function can only be called after {@link Configure} and before {@link Prepare}
*
* @return Returns the pointer to the surface.
* @since 3.1
* @version 3.1
*/
virtual sptr<Surface> CreateInputSurface() = 0;
* @brief Submits input buffer to encoder.
*
* This function must be called during running. The {@link AVCodecCallback} callback
* will report the available input buffer and the corresponding index value.
*
* @param index The index of the input buffer.
* @param info The info of the input buffer. For details, see {@link AVCodecBufferInfo}
* @param flag The flag of the input buffer. For details, see {@link AVCodecBufferFlag}
* @return Returns {@link AVCS_ERR_OK} if success; returns an error code otherwise.
* @since 3.1
* @version 3.1
*/
virtual int32_t QueueInputBuffer(uint32_t index, AVCodecBufferInfo info, AVCodecBufferFlag flag) = 0;
* @brief Submits input buffer to encoder.
*
* This function must be called during running. The {@link MediaCodecCallback} callback
* will report the available input buffer and the corresponding index value.
*
* @param index The index of the input buffer.
* @return Returns {@link AVCS_ERR_OK} if success; returns an error code otherwise.
* @since 4.1
*/
virtual int32_t QueueInputBuffer(uint32_t index) = 0;
* @brief Submits input parameter to encoder.
*
* This function must be called during running. The {@link MediaCodecParameterCallback} callback
* will report the available input buffer and the corresponding index value.
*
* @param index The index of the input parameter.
* @return Returns {@link AVCS_ERR_OK} if success; returns an error code otherwise.
* @since 5.0
*/
virtual int32_t QueueInputParameter(uint32_t index) = 0;
* @brief Gets the format of the output data.
*
* This function must be called after {@link Configure}
*
* @param format
* @return Returns {@link AVCS_ERR_OK} if success; returns an error code otherwise.
* @since 3.1
* @version 3.1
*/
virtual int32_t GetOutputFormat(Format &format) = 0;
* @brief Returns the output buffer to the encoder.
*
* This function must be called during running
*
* @param index The index of the output buffer.
* @return Returns {@link AVCS_ERR_OK} if success; returns an error code otherwise.
* @since 3.1
* @version 3.1
*/
virtual int32_t ReleaseOutputBuffer(uint32_t index) = 0;
* @brief Sets the parameters to the encoder.
*
* This interface can only be called after the encoder is started.
* At the same time, incorrect parameter settings may cause decoding failure.
*
* @param format The parameters.
* @return Returns {@link AVCS_ERR_OK} if success; returns an error code otherwise.
* @since 3.1
* @version 3.1
*/
virtual int32_t SetParameter(const Format &format) = 0;
* @brief Registers a encoder listener.
*
* This function must be called before {@link Configure}
*
* @param callback Indicates the encoder listener to register. For details, see {@link AVCodecCallback}.
* @return Returns {@link AVCS_ERR_OK} if success; returns an error code otherwise.
* @since 3.1
* @version 3.1
*/
virtual int32_t SetCallback(const std::shared_ptr<AVCodecCallback> &callback) = 0;
* @brief Registers a encoder listener.
*
* This function must be called before {@link Configure}
*
* @param callback Indicates the encoder listener to register. For details, see {@link MediaCodecCallback}.
* @return Returns {@link AVCS_ERR_OK} if success; returns an error code otherwise.
* @since 4.1
*/
virtual int32_t SetCallback(const std::shared_ptr<MediaCodecCallback> &callback) = 0;
* @brief Registers a encoder listener.
*
* This function must be called before {@link Configure}
*
* @param callback Indicates the encoder listener to register. For details, see {@link MediaCodecParameterCallback}.
* @return Returns {@link AVCS_ERR_OK} if success; returns an error code otherwise.
* @since 5.0
*/
virtual int32_t SetCallback(const std::shared_ptr<MediaCodecParameterCallback> &callback) = 0;
* @brief Registers a encoder listener.
*
* This function must be called before {@link Configure}
*
* @param callback Indicates the encoder listener to register. For details, see {@link
* MediaCodecParameterWithAttrCallback}.
* @return Returns {@link AVCS_ERR_OK} if success; returns an error code otherwise.
* @since 5.0
*/
virtual int32_t SetCallback(const std::shared_ptr<MediaCodecParameterWithAttrCallback> &callback) = 0;
* @brief Gets the format of the input data that accepted by the video encoder.
*
* This function must be called after {@link Configure}
*
* @param format
* @return Returns {@link AVCS_ERR_OK} if success; returns an error code otherwise.
* @since 4.0
* @version 4.0
*/
virtual int32_t GetInputFormat(Format &format) = 0;
* @brief Set custom buffer. If this interface is used, it must be invoked after {@link Configure}
* and before {@link Start}.
*
* @param buffer The buffer of the custom input image data, such as a watermark image.
* @return Returns {@link AVCS_ERR_OK} if success; returns an error code otherwise.
* @since 5.0
*/
virtual int32_t SetCustomBuffer(std::shared_ptr<AVBuffer> buffer) = 0;
* @brief Query available input buffer from encoder
*
* This function blocks until an input buffer becomes available or timeout occurs.
*
* @param index [out] Reference to store the index of available input buffer
* @param timeoutUs Timeout duration in microseconds (negative value means infinite wait)
* @return Returns {@link AVCS_ERR_OK} if buffer is available;
* returns error code if timeout or other failures occur.
* @since 6.0
* @version 6.0
*/
virtual int32_t QueryInputBuffer(uint32_t &index, int64_t timeoutUs)
{
(void)index;
(void)timeoutUs;
return 0;
}
* @brief Query available output buffer from encoder
*
* This function blocks until an output buffer with decoded data becomes available or timeout occurs.
*
* @param index [out] Reference to store the index of available output buffer
* @param timeoutUs Timeout duration in microseconds (negative value means infinite wait)
* @return Returns {@link AVCS_ERR_OK} if buffer is available;
* returns error code if timeout or other failures occur.
* @since 6.0
* @version 6.0
*/
virtual int32_t QueryOutputBuffer(uint32_t &index, int64_t timeoutUs)
{
(void)index;
(void)timeoutUs;
return 0;
}
* @brief Get input buffer object by index
*
* Caller should use {@link QueryInputBuffer} to get valid index before calling this function.
*
* @param index Index of the input buffer obtained from {@link QueryInputBuffer}
* @return Shared pointer to {@link AVBuffer} if index is valid;
* returns nullptr if index is invalid or buffer unavailable.
* @since 6.0
* @version 6.0
*/
virtual std::shared_ptr<AVBuffer> GetInputBuffer(uint32_t index)
{
(void)index;
return nullptr;
}
* @brief Get output buffer object by index
*
* Caller should use {@link QueryOutputBuffer} to get valid index before calling this function.
*
* @param index Index of the output buffer obtained from {@link QueryOutputBuffer}
* @return Shared pointer to {@link AVBuffer} containing decoded data if index is valid;
* returns nullptr if index is invalid or buffer unavailable.
* @since 6.0
* @version 6.0
*/
virtual std::shared_ptr<AVBuffer> GetOutputBuffer(uint32_t index)
{
(void)index;
return nullptr;
}
};
class __attribute__((visibility("default"))) VideoEncoderFactory {
public:
#ifdef UNSUPPORT_CODEC
static std::shared_ptr<AVCodecVideoEncoder> CreateByMime(const std::string &mime)
{
(void)mime;
return nullptr;
}
static std::shared_ptr<AVCodecVideoEncoder> CreateByName(const std::string &name)
{
(void)name;
return nullptr;
}
static int32_t CreateByMime(const std::string &mime, Format &format, std::shared_ptr<AVCodecVideoEncoder> &encodec)
{
(void)name;
(void)format;
codec = nullptr;
return codec;
}
static int32_t CreateByName(const std::string &name, Format &format, std::shared_ptr<AVCodecVideoEncoder> &encodec)
{
(void)name;
(void)format;
codec = nullptr;
return codec;
}
#else
* @brief Instantiate the preferred encoder of the given mime type.
*
* @param mime The mime type.
* @return Returns the preferred encoder.
* @since 3.1
* @version 3.1
*/
static std::shared_ptr<AVCodecVideoEncoder> CreateByMime(const std::string &mime);
* @brief Instantiates the designated encoder.
*
* @param name The encoder's name.
* @return Returns the designated encoder.
* @since 3.1
* @version 3.1
*/
static std::shared_ptr<AVCodecVideoEncoder> CreateByName(const std::string &name);
* @brief Instantiate the preferred encoder of the given mime type.
*
* @param mime The mime type.
* @param format Caller info
* @param codec The designated encoder.
* @return Returns {@link AVCS_ERR_OK} if success; returns an error code otherwise.
* @since 5.0
* @version 5.0
*/
static int32_t CreateByMime(const std::string &mime, Format &format, std::shared_ptr<AVCodecVideoEncoder> &encodec);
* @brief Instantiate the preferred encoder of the given mime type.
*
* @param mime The mime type.
* @param format Caller info
* @param codec The designated encoder.
* @return Returns {@link AVCS_ERR_OK} if success; returns an error code otherwise.
* @since 5.0
* @version 5.0
*/
static int32_t CreateByName(const std::string &name, Format &format, std::shared_ptr<AVCodecVideoEncoder> &encodec);
#endif
private:
VideoEncoderFactory() = default;
~VideoEncoderFactory() = default;
};
}
}
#endif
