| Message ID | 20210425131846.47597-1-shubhanshu.e01@gmail.com |
|---|---|
| State | New |
| Headers | show |
| Series | [FFmpeg-devel] libavfilter: Add Documentation to SafeQueue | expand |
| Context | Check | Description |
|---|---|---|
| andriy/x86_make | success | Make finished |
| andriy/x86_make_fate | success | Make fate finished |
| andriy/PPC64_make | success | Make finished |
| andriy/PPC64_make_fate | success | Make fate finished |
> -----Original Message----- > From: ffmpeg-devel <ffmpeg-devel-bounces@ffmpeg.org> On Behalf Of > Shubhanshu Saxena > Sent: 2021年4月25日 21:19 > To: ffmpeg-devel@ffmpeg.org > Cc: shubhanshu02 <shubhanshu.e01@gmail.com> > Subject: [FFmpeg-devel] [PATCH] libavfilter: Add Documentation to > SafeQueue > > From: shubhanshu02 <shubhanshu.e01@gmail.com> > > Adds documentation to queue.h in libavfilter/dnn > > Signed-off-by: shubhanshu02 <shubhanshu.e01@gmail.com> > --- > libavfilter/dnn/safe_queue.h | 60 > ++++++++++++++++++++++++++++++++++++ > 1 file changed, 60 insertions(+) > > diff --git a/libavfilter/dnn/safe_queue.h b/libavfilter/dnn/safe_queue.h > index 36d6daabaf..577a02e24d 100644 > --- a/libavfilter/dnn/safe_queue.h > +++ b/libavfilter/dnn/safe_queue.h please change the commit title as below and send out v2 patch. lavfi/dnn/safe_queue.h: Add Documentation to SafeQueue and the same change for the other patch for queue.h
Okay, I have sent the v2 patches for both. On Mon, Apr 26, 2021 at 7:52 AM Guo, Yejun <yejun.guo@intel.com> wrote: > > > > -----Original Message----- > > From: ffmpeg-devel <ffmpeg-devel-bounces@ffmpeg.org> On Behalf Of > > Shubhanshu Saxena > > Sent: 2021年4月25日 21:19 > > To: ffmpeg-devel@ffmpeg.org > > Cc: shubhanshu02 <shubhanshu.e01@gmail.com> > > Subject: [FFmpeg-devel] [PATCH] libavfilter: Add Documentation to > > SafeQueue > > > > From: shubhanshu02 <shubhanshu.e01@gmail.com> > > > > Adds documentation to queue.h in libavfilter/dnn > > > > Signed-off-by: shubhanshu02 <shubhanshu.e01@gmail.com> > > --- > > libavfilter/dnn/safe_queue.h | 60 > > ++++++++++++++++++++++++++++++++++++ > > 1 file changed, 60 insertions(+) > > > > diff --git a/libavfilter/dnn/safe_queue.h b/libavfilter/dnn/safe_queue.h > > index 36d6daabaf..577a02e24d 100644 > > --- a/libavfilter/dnn/safe_queue.h > > +++ b/libavfilter/dnn/safe_queue.h > > please change the commit title as below and send out v2 patch. > lavfi/dnn/safe_queue.h: Add Documentation to SafeQueue > > and the same change for the other patch for queue.h > _______________________________________________ > ffmpeg-devel mailing list > ffmpeg-devel@ffmpeg.org > https://ffmpeg.org/mailman/listinfo/ffmpeg-devel > > To unsubscribe, visit link above, or email > ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe". >
> -----Original Message----- > From: ffmpeg-devel <ffmpeg-devel-bounces@ffmpeg.org> On Behalf Of > Shubhanshu Saxena > Sent: 2021年4月26日 15:55 > To: FFmpeg development discussions and patches > <ffmpeg-devel@ffmpeg.org> > Subject: Re: [FFmpeg-devel] [PATCH] libavfilter: Add Documentation to > SafeQueue > > Okay, I have sent the v2 patches for both. thanks, and please avoid top-posting in mail, see more at https://ffmpeg.org/mailing-list-faq.html#What-is-top_002dposting_003f-1 > > On Mon, Apr 26, 2021 at 7:52 AM Guo, Yejun <yejun.guo@intel.com> > wrote: > > > > > > > > -----Original Message----- > > > From: ffmpeg-devel <ffmpeg-devel-bounces@ffmpeg.org> On Behalf Of > > > Shubhanshu Saxena > > > Sent: 2021年4月25日 21:19 > > > To: ffmpeg-devel@ffmpeg.org > > > Cc: shubhanshu02 <shubhanshu.e01@gmail.com> > > > Subject: [FFmpeg-devel] [PATCH] libavfilter: Add Documentation to > > > SafeQueue > > > > > > From: shubhanshu02 <shubhanshu.e01@gmail.com> > > > > > > Adds documentation to queue.h in libavfilter/dnn > > > > > > Signed-off-by: shubhanshu02 <shubhanshu.e01@gmail.com> > > > --- > > > libavfilter/dnn/safe_queue.h | 60 > > > ++++++++++++++++++++++++++++++++++++ > > > 1 file changed, 60 insertions(+) > > > > > > diff --git a/libavfilter/dnn/safe_queue.h b/libavfilter/dnn/safe_queue.h > > > index 36d6daabaf..577a02e24d 100644 > > > --- a/libavfilter/dnn/safe_queue.h > > > +++ b/libavfilter/dnn/safe_queue.h > > > > please change the commit title as below and send out v2 patch. > > lavfi/dnn/safe_queue.h: Add Documentation to SafeQueue > > > > and the same change for the other patch for queue.h > > _______________________________________________ > > ffmpeg-devel mailing list > > ffmpeg-devel@ffmpeg.org > > https://ffmpeg.org/mailman/listinfo/ffmpeg-devel > > > > To unsubscribe, visit link above, or email > > ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe". > > > _______________________________________________ > ffmpeg-devel mailing list > ffmpeg-devel@ffmpeg.org > https://ffmpeg.org/mailman/listinfo/ffmpeg-devel > > To unsubscribe, visit link above, or email > ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".
diff --git a/libavfilter/dnn/safe_queue.h b/libavfilter/dnn/safe_queue.h index 36d6daabaf..577a02e24d 100644 --- a/libavfilter/dnn/safe_queue.h +++ b/libavfilter/dnn/safe_queue.h @@ -21,16 +21,76 @@ #ifndef AVFILTER_DNN_SAFE_QUEUE_H #define AVFILTER_DNN_SAFE_QUEUE_H +/** + * Double-ended queue with mutex locks ensuring + * data consistency while multithreading. + */ typedef struct SafeQueue SafeQueue; +/** + * @brief Create and initialize a SafeQueue instance. + * + * @return Pointer to the SafeQueue + * @retval NULL if initialization fails + */ SafeQueue *ff_safe_queue_create(void); + +/** + * @brief Destroy the SafeQueue instance. + * It also frees all elements of the queue, + * destroys the mutex and condition variable. + */ void ff_safe_queue_destroy(SafeQueue *sq); +/** + * @brief Return the length of the SafeQueue + */ size_t ff_safe_queue_size(SafeQueue *sq); +/** + * @brief Add data to the head of queue in the + * SafeQueue after locking mutex. After adding + * the data, it signals the condition variable + * and unlocks the mutex. It increases the length + * of queue in the SafeQueue by one. + * + * @param sq pointer to the SafeQueue + * @param v data to be added + * @return The length of the queue + * @retval 0 if the queue is not initialized + * @retval -1 if new entry cannot be created + */ int ff_safe_queue_push_front(SafeQueue *sq, void *v); + +/** + * @brief Add data to the tail of queue in the + * SafeQueue after locking mutex. After adding + * the data, it signals the condition variable + * and unlocks the mutex. It increases the length + * of queue in the SafeQueue by one. + * + * @param sq pointer to the SafeQueue + * @param v data to be added + * @return The length of the queue + * @retval 0 if the queue is not initialized + * @retval -1 if new entry cannot be created + */ int ff_safe_queue_push_back(SafeQueue *sq, void *v); +/** + * @brief Remove and free first element from + * the queue in SafeQueue. Before removing, it + * waits for the condition variable to signal and + * acquires the mutex. Finally, it signals the + * condition and unlocks the mutex. + * It shrinks the length of queue in the SafeQueue + * by one. + * + * @param sq pointer to the SafeQueue. + * @return The value of first element as void. + * If a null pointer or empty queue is passed, + * it returns NULL + */ void *ff_safe_queue_pop_front(SafeQueue *sq); #endif