[FFmpeg-cvslog] [ffmpeg-radio] 05/14: avradio/sdr: snap2station() documentation

[Michael Niedermayer]

This is an automated email from the git hooks/post-receive script.

Git pushed a commit to branch master
in repository libavradio.

commit 4e424b214186df1526e72b44e27a46eabb058d64
Author:     Michael Niedermayer <michael at niedermayer.cc>
AuthorDate: Tue Jul 18 18:57:41 2023 +0200
Commit:     Michael Niedermayer <michael at niedermayer.cc>
CommitDate: Tue Jul 18 18:57:41 2023 +0200

    avradio/sdr: snap2station() documentation
    
    Signed-off-by: Michael Niedermayer <michael at niedermayer.cc>
---
 libavradio/sdrdemux.c | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/libavradio/sdrdemux.c b/libavradio/sdrdemux.c
index f189c85a0d..07b43dec1c 100644
--- a/libavradio/sdrdemux.c
+++ b/libavradio/sdrdemux.c
@@ -1287,6 +1287,16 @@ static int sdrfile_read_callback(SDRContext *sdr, FIFOElement *fifo_element, int
     return ret;
 }
 
+/**
+ * switch to the closest station in view and the provided seek_direction.
+ *
+ * This function is scanning friendly, it will not consider stations not in
+ * view and rather wait for a future invocation when they are in view
+ *
+ * when a station is found, this will move to it and stop scanning if needed
+ *
+ * @return 1 if a station is found, 0 if not, or a negative error code on error
+ */
 static int snap2station(SDRContext *sdr, int *seek_direction) {
     AVFormatContext *avfmt = sdr->avfmt;
     AVStream *st = avfmt->streams[sdr->single_ch_audio_st_index];