From 78e3487de440eb6035b4cacc994e2d542daf86da Mon Sep 17 00:00:00 2001 From: "Alfred E. Heggestad" Date: Sat, 20 Jun 2015 12:23:53 +0200 Subject: module documentation --- modules/silk/silk.c | 8 ++++++-- modules/speex/speex.c | 7 +++++++ modules/speex_aec/speex_aec.c | 7 +++++++ modules/speex_pp/speex_pp.c | 7 +++++++ modules/vidbridge/vidbridge.c | 18 ++++++++++++++++++ 5 files changed, 45 insertions(+), 2 deletions(-) diff --git a/modules/silk/silk.c b/modules/silk/silk.c index 95f708c..8232188 100644 --- a/modules/silk/silk.c +++ b/modules/silk/silk.c @@ -1,14 +1,18 @@ /** * @file silk.c Skype SILK audio codec * - * Copyright (C) 2010 Creytiv.com + * Copyright (C) 2010 - 2015 Creytiv.com */ #include #include #include -/* +/** + * @defgroup silk silk + * + * The Skype SILK audio codec + * * References: https://developer.skype.com/silk */ diff --git a/modules/speex/speex.c b/modules/speex/speex.c index 055d3ad..0780e8c 100644 --- a/modules/speex/speex.c +++ b/modules/speex/speex.c @@ -11,6 +11,13 @@ #include +/** + * @defgroup speex speex + * + * The Speex audio codec + */ + + enum { MIN_FRAME_SIZE = 43, SPEEX_PTIME = 20, diff --git a/modules/speex_aec/speex_aec.c b/modules/speex_aec/speex_aec.c index 15ea552..2e45518 100644 --- a/modules/speex_aec/speex_aec.c +++ b/modules/speex_aec/speex_aec.c @@ -11,6 +11,13 @@ #include +/** + * @defgroup speex_aec speex_aec + * + * Acoustic Echo Cancellation (AEC) from libspeexdsp + */ + + struct speex_st { int16_t *out; SpeexEchoState *state; diff --git a/modules/speex_pp/speex_pp.c b/modules/speex_pp/speex_pp.c index 4c14f65..f364d9d 100644 --- a/modules/speex_pp/speex_pp.c +++ b/modules/speex_pp/speex_pp.c @@ -11,6 +11,13 @@ #include +/** + * @defgroup speex_pp speex_pp + * + * Audio pre-processor from libspeexdsp + */ + + struct preproc { struct aufilt_enc_st af; /* base class */ SpeexPreprocessState *state; diff --git a/modules/vidbridge/vidbridge.c b/modules/vidbridge/vidbridge.c index 69aa41f..495264e 100644 --- a/modules/vidbridge/vidbridge.c +++ b/modules/vidbridge/vidbridge.c @@ -9,6 +9,24 @@ #include "vidbridge.h" +/** + * @defgroup vidbridge vidbridge + * + * Video bridge module + * + * This module can be used to connect two video devices together, + * so that all output to VIDISP device is bridged as the input to + * a VIDSRC device. + * + * Sample config: + * + \verbatim + video_display vidbridge,pseudo0 + video_source vidbridge,pseudo0 + \endverbatim + */ + + static struct vidisp *vidisp; static struct vidsrc *vidsrc; -- cgit v1.2.3