RepoMirrors
/
ffmpeg
mirror of https://git.ffmpeg.org/ffmpeg.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

lavfi/dnn/queue.h: Add Documentation to Queue 

Documentation for Queue

Signed-off-by: Shubhanshu Saxena <shubhanshu.e01@gmail.com>
This commit is contained in:
Shubhanshu Saxena 2021-04-26 13:24:09 +05:30 committed by Guo, Yejun
parent 5b8e828dee
commit 4b79416dc4
1 changed files with 75 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

75
libavfilter/dnn/queue.h
View File

@ -22,20 +22,95 @@
#ifndef AVFILTER_DNN_QUEUE_H
#define AVFILTER_DNN_QUEUE_H
/**
* Linear double-ended data structure
*/
typedef struct Queue Queue;
/**
* @brief Create a Queue instance.
* It initializes the length of the Queue as 0.
*
* @return Pointer to the Queue
* @retval NULL if allocation fails
*/
Queue *ff_queue_create(void);
/**
* @brief Destroy the Queue instance.
* It also frees all elements of the Queue.
*/
void ff_queue_destroy(Queue *q);
/**
* @brief Return the length of the Queue
*/
size_t ff_queue_size(Queue *q);
/**
* @brief Return a pointer to the data
* at the head of the queue.
*
* @retval NULL if null pointer was passed
* or queue is empty
*/
void *ff_queue_peek_front(Queue *q);
/**
* @brief Return a pointer to the data at
* the tail of the queue.
*
* @retval NULL if null pointer was passed
* or queue is empty
*/
void *ff_queue_peek_back(Queue *q);
/**
* @brief Add data to the head of the queue.
* It increases the length of Queue by one.
*
* @param q pointer to the Queue.
* @param v data to be added
* @return The length of the Queue
* @retval 0 if the pointer to queue is NULL
* @retval -1 if new entry cannot be created
*/
int ff_queue_push_front(Queue *q, void *v);
/**
* @brief Add data to the tail of the queue.
* It increases the length of Queue by one.
*
* @param q pointer to the Queue
* @param v data to be added
* @return The length of the Queue
* @retval 0 if the pointer to queue is NULL
* @retval -1 if new entry cannot be created
*/
int ff_queue_push_back(Queue *q, void *v);
/**
* @brief Remove and free first element from
* the Queue. It shrinks the length of Queue
* by one.
*
* @param q pointer to the Queue.
* @return The value of first element as void.
* If a null pointer or empty queue is passed,
* it returns NULL
*/
void *ff_queue_pop_front(Queue *q);
/**
* @brief Remove and free last element from
* the Queue. It shrinks the length of Queue
* by one.
*
* @param q pointer to the Queue.
* @return The value of last element as void.
* If a null pointer or empty queue is passed,
* it returns NULL
*/
void *ff_queue_pop_back(Queue *q);
#endif