ffmpeg/libavfilter/dnn/dnn_backend_native_layer_avgpool.h
Shubhanshu Saxena 0bdd677c5f lavfi/dnn_backend_native_layer_avgpool.h: Documentation
Add documentation for Average Pool Layer

Signed-off-by: Shubhanshu Saxena <shubhanshu.e01@gmail.com>
2021-05-14 10:21:15 +08:00

69 lines
2.5 KiB
C

/*
* Copyright (c) 2020
*
* This file is part of FFmpeg.
*
* FFmpeg is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* FFmpeg is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with FFmpeg; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
/**
* @file
* DNN inference functions interface for native backend.
*/
#ifndef AVFILTER_DNN_DNN_BACKEND_NATIVE_LAYER_AVGPOOL_H
#define AVFILTER_DNN_DNN_BACKEND_NATIVE_LAYER_AVGPOOL_H
#include "dnn_backend_native.h"
typedef struct AvgPoolParams{
int32_t strides, kernel_size;
DNNPaddingParam padding_method;
} AvgPoolParams;
/**
* @brief Load Average Pooling Layer.
*
* It assigns the Average Pooling layer with AvgPoolParams
* after parsing from the model file context.
*
* @param layer pointer to the DNN layer instance
* @param model_file_context pointer to model file context
* @param file_size model file size to check if data is read
* correctly from the model file
* @param operands_num operand count of the whole model to
* check if data is read correctly from the model file
* @return number of bytes read from the model file
* @retval 0 if out of memory or an error occurs
*/
int ff_dnn_load_layer_avg_pool(Layer *layer, AVIOContext *model_file_context, int file_size, int operands_num);
/**
* @brief Execute the Average Pooling Layer.
* Padding in channel dimensions is currently not supported.
*
* @param operands all operands for the model
* @param input_operand_indexes input operand indexes for this layer
* @param output_operand_index output operand index for this layer
* @param parameters average pooling parameters
* @param ctx pointer to Native model context for logging
* @retval 0 if the execution succeeds
* @retval DNN_ERROR if the execution fails
*/
int ff_dnn_execute_layer_avg_pool(DnnOperand *operands, const int32_t *input_operand_indexes,
int32_t output_operand_index, const void *parameters, NativeContext *ctx);
#endif