summaryrefslogtreecommitdiffstats
path: root/libtoolame-dab
diff options
context:
space:
mode:
Diffstat (limited to 'libtoolame-dab')
-rw-r--r--libtoolame-dab/README.md9
-rw-r--r--libtoolame-dab/toolame.h23
2 files changed, 16 insertions, 16 deletions
diff --git a/libtoolame-dab/README.md b/libtoolame-dab/README.md
index 234cd01..f2e7d1a 100644
--- a/libtoolame-dab/README.md
+++ b/libtoolame-dab/README.md
@@ -25,18 +25,16 @@ License along with tooLAME; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
-*********************
INTRODUCTION
-*********************
+============
tooLAME is an optimized Mpeg Audio 1/2 Layer 2 encoder. It is based heavily on
- the ISO dist10 code
- improvement to algorithms as part of the LAME project (www.sulaco.org/mp3)
- work by Mike Cheng and other contributors (see CONTRIBUTORS)
-*********************
CONTRIBUTORS
-*********************
+============
Dist10 code writers
LAME specific contributions
@@ -82,9 +80,8 @@ Matthias P. Braendli <matthias@mpb.li>
PAD insertion for DLS and slides
Integration into FDK-AAC-DABplus
-*********************
REFERENCE PAPERS
-*********************
+================
(Specifically LayerII Papers)
Kumar, M & Zubair, M., A high performance software implementation of mpeg audio
diff --git a/libtoolame-dab/toolame.h b/libtoolame-dab/toolame.h
index 5450ca0..bb73b70 100644
--- a/libtoolame-dab/toolame.h
+++ b/libtoolame-dab/toolame.h
@@ -1,15 +1,18 @@
+/*! \section libtoolame API
+ */
#ifndef __TOOLAME_H_
#define __TOOLAME_H_
#include <stdlib.h>
-/* All exported functions shown here return zero
+/*! All exported functions shown here return zero
* on success */
-/* Initialise toolame encoding library. */
+/*! Initialise toolame encoding library. */
int toolame_init(void);
-/* Finish encoding the pending samples.
- * Returns number of bytes written to output_buffer
+/*! Finish encoding the pending samples.
+ *
+ * \return number of bytes written to output_buffer
*/
int toolame_finish(
unsigned char *output_buffer,
@@ -18,23 +21,23 @@ int toolame_finish(
int toolame_enable_downmix_stereo(void);
int toolame_enable_byteswap(void);
-/* Set channel mode. Allowed values:
- * s, d, j , and m
+/*! Set channel mode. Allowed values:
+ * s, d, j, and m
*/
int toolame_set_channel_mode(const char mode);
-/* Valid PSY models: 0 to 3 */
+/*! Valid PSY models: 0 to 3 */
int toolame_set_psy_model(int new_model);
int toolame_set_bitrate(int brate);
-/* Set sample rate in Hz */
+/*! Set sample rate in Hz */
int toolame_set_samplerate(long sample_rate);
-/* Enable PAD insertion from the specified file with length */
+/*! Enable PAD insertion from the specified file with length */
int toolame_set_pad(int pad_len);
-/* Encodes one frame. Returns number of bytes written to output_buffer
+/*! Encodes one frame. Returns number of bytes written to output_buffer
*/
int toolame_encode_frame(
short buffer[2][1152],