diff options
author | Alfred E. Heggestad <aeh@db.org> | 2015-11-29 09:48:26 +0100 |
---|---|---|
committer | Alfred E. Heggestad <aeh@db.org> | 2015-11-29 09:48:26 +0100 |
commit | 3e04c639549873f752dc077d8a0e5cf58fa12c7b (patch) | |
tree | ce203c05017199b19ed63454dbad16a934efaeac /modules | |
parent | 8497126045f34963b04e79cd900f82049a857f37 (diff) |
modules: update documentation header
Diffstat (limited to 'modules')
-rw-r--r-- | modules/vidinfo/vidinfo.c | 10 | ||||
-rw-r--r-- | modules/vidloop/vidloop.c | 20 | ||||
-rw-r--r-- | modules/vpx/vpx.c | 13 | ||||
-rw-r--r-- | modules/vumeter/vumeter.c | 11 |
4 files changed, 51 insertions, 3 deletions
diff --git a/modules/vidinfo/vidinfo.c b/modules/vidinfo/vidinfo.c index 9063a3f..601d387 100644 --- a/modules/vidinfo/vidinfo.c +++ b/modules/vidinfo/vidinfo.c @@ -9,6 +9,16 @@ #include "vidinfo.h" +/** + * @defgroup vidinfo vidinfo + * + * Display video-info overlay on the encode/decode streams + * + * Displays info like framerate and packet timing, this is mainly + * for development and debugging. + */ + + struct vidinfo_enc { struct vidfilt_enc_st vf; /* base member (inheritance) */ diff --git a/modules/vidloop/vidloop.c b/modules/vidloop/vidloop.c index 381e97c..ff38281 100644 --- a/modules/vidloop/vidloop.c +++ b/modules/vidloop/vidloop.c @@ -11,6 +11,26 @@ #include <baresip.h> +/** + * @defgroup vidloop vidloop + * + * A video-loop module for testing + * + * Simple test module that loops back the video frames from a + * video-source to a video-display, optionally via a video codec. + * + * Example usage without codec: + \verbatim + baresip -ev + \endverbatim + * + * Example usage with codec: + \verbatim + baresip -evv + \endverbatim + */ + + /** Internal pixel-format */ #ifndef VIDLOOP_INTERNAL_FMT #define VIDLOOP_INTERNAL_FMT (VID_FMT_YUV420P) diff --git a/modules/vpx/vpx.c b/modules/vpx/vpx.c index 4b492cf..d300641 100644 --- a/modules/vpx/vpx.c +++ b/modules/vpx/vpx.c @@ -16,12 +16,19 @@ #include "vp8.h" -/* - * Experimental support for WebM VP8 video codec: +/** + * @defgroup vpx vpx + * + * The VP8 video codec + * + * This module implements the VP8 video codec that is compatible + * with the WebRTC standard. + * + * References: * * http://www.webmproject.org/ * - * http://tools.ietf.org/html/draft-ietf-payload-vp8-08 + * http://tools.ietf.org/html/draft-ietf-payload-vp8-17 */ diff --git a/modules/vumeter/vumeter.c b/modules/vumeter/vumeter.c index 827bde2..efefa23 100644 --- a/modules/vumeter/vumeter.c +++ b/modules/vumeter/vumeter.c @@ -9,6 +9,17 @@ #include <baresip.h> +/** + * @defgroup vumeter vumeter + * + * Simple ASCII VU-meter for the audio-signal. + * + * The Volume unit (VU) meter module takes the audio-signal as input + * and prints a simple ASCII-art bar for the recording and playback levels. + * It is using the aufilt API to get the audio samples. + */ + + struct vumeter_enc { struct aufilt_enc_st af; /* inheritance */ struct tmr tmr; |