summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlfred E. Heggestad <aeh@db.org>2015-11-29 21:56:07 +0100
committerAlfred E. Heggestad <aeh@db.org>2015-11-29 21:56:07 +0100
commitd94d4acbc9c5c5cb77700a873a0208540ea8e8e8 (patch)
treeb4a3989c7f06691ce9ce9440a58fe25e9a2e52a0
parent82dd23761e6b2631987bf10e167bb37552fd60cb (diff)
modules: add documentation blocks
-rw-r--r--modules/plc/plc.c8
-rw-r--r--modules/rst/rst.c16
-rw-r--r--modules/sdl/sdl.c7
-rw-r--r--modules/sdl2/sdl.c7
-rw-r--r--modules/selfview/selfview.c18
-rw-r--r--modules/snapshot/snapshot.c14
-rw-r--r--modules/sndfile/sndfile.c7
7 files changed, 74 insertions, 3 deletions
diff --git a/modules/plc/plc.c b/modules/plc/plc.c
index 5409258..9f703c1 100644
--- a/modules/plc/plc.c
+++ b/modules/plc/plc.c
@@ -8,6 +8,14 @@
#include <baresip.h>
+/**
+ * @defgroup plc plc
+ *
+ * Packet Loss Concealment (PLC) audio-filter using spandsp
+ *
+ */
+
+
struct plc_st {
struct aufilt_dec_st af; /* base class */
plc_state_t plc;
diff --git a/modules/rst/rst.c b/modules/rst/rst.c
index cd614f4..8f2fea3 100644
--- a/modules/rst/rst.c
+++ b/modules/rst/rst.c
@@ -11,6 +11,22 @@
#include "rst.h"
+/**
+ * @defgroup rst rst
+ *
+ * Audio and video source module using mpg123 as input
+ *
+ * The module 'rst' is using the mpg123 to play streaming
+ * media (MP3) and provide this as an internal audio/video source.
+ *
+ * Example config:
+ \verbatim
+ audio_source rst,http://relay.slayradio.org:8000/
+ video_source rst,http://relay.slayradio.org:8000/
+ \endverbatim
+ */
+
+
enum {
RETRY_WAIT = 10000,
};
diff --git a/modules/sdl/sdl.c b/modules/sdl/sdl.c
index 914a63a..dec95bc 100644
--- a/modules/sdl/sdl.c
+++ b/modules/sdl/sdl.c
@@ -11,6 +11,13 @@
#include "sdl.h"
+/**
+ * @defgroup sdl sdl
+ *
+ * Video display using Simple DirectMedia Layer (SDL)
+ */
+
+
/** Local constants */
enum {
KEY_RELEASE_VAL = 250 /**< Key release value in [ms] */
diff --git a/modules/sdl2/sdl.c b/modules/sdl2/sdl.c
index c79392d..4487e43 100644
--- a/modules/sdl2/sdl.c
+++ b/modules/sdl2/sdl.c
@@ -10,6 +10,13 @@
#include <baresip.h>
+/**
+ * @defgroup sdl2 sdl2
+ *
+ * Video display using Simple DirectMedia Layer version 2 (SDL2)
+ */
+
+
struct vidisp_st {
const struct vidisp *vd; /**< Inheritance (1st) */
SDL_Window *window; /**< SDL Window */
diff --git a/modules/selfview/selfview.c b/modules/selfview/selfview.c
index cf5cdc3..77f0b81 100644
--- a/modules/selfview/selfview.c
+++ b/modules/selfview/selfview.c
@@ -9,6 +9,19 @@
#include <baresip.h>
+/**
+ * @defgroup selfview selfview
+ *
+ * Show a selfview of the captured video stream
+ *
+ * Example config:
+ \verbatim
+ video_selfview pip # {window,pip}
+ selfview_size 64x64
+ \endverbatim
+ */
+
+
/* shared state */
struct selfview {
struct lock *lock; /**< Protect frame */
@@ -235,10 +248,9 @@ static struct vidfilt selfview_pip = {
static int module_init(void)
{
- struct pl pl;
+ struct pl pl = PL("pip");
- if (conf_get(conf_cur(), "video_selfview", &pl))
- return 0;
+ (void)conf_get(conf_cur(), "video_selfview", &pl);
if (0 == pl_strcasecmp(&pl, "window"))
vidfilt_register(&selfview_win);
diff --git a/modules/snapshot/snapshot.c b/modules/snapshot/snapshot.c
index d22806e..b71edbd 100644
--- a/modules/snapshot/snapshot.c
+++ b/modules/snapshot/snapshot.c
@@ -10,6 +10,20 @@
#include "png_vf.h"
+/**
+ * @defgroup snapshot snapshot
+ *
+ * Take snapshot of the video stream and save it as PNG-files
+ *
+ *
+ * Commands:
+ *
+ \verbatim
+ O Take video snapshot
+ \endverbatim
+ */
+
+
static bool flag_enc, flag_dec;
diff --git a/modules/sndfile/sndfile.c b/modules/sndfile/sndfile.c
index e8fe9c9..667c0b1 100644
--- a/modules/sndfile/sndfile.c
+++ b/modules/sndfile/sndfile.c
@@ -9,6 +9,13 @@
#include <baresip.h>
+/**
+ * @defgroup sndfile sndfile
+ *
+ * Audio filter that writes audio samples to WAV-file
+ */
+
+
struct sndfile_enc {
struct aufilt_enc_st af; /* base class */
SNDFILE *enc;