1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
|
.TH "AudioCodec" 3 "23 Jul 2003" "ccAudio" \" -*- nroff -*-
.ad l
.nh
.SH NAME
AudioCodec \- The codec class is a virtual used for transcoding audio samples between linear frames (or other known format) and an encoded 'sample' buffer. process codec interface.
.SH SYNOPSIS
.br
.PP
\fC#include <audio.h>\fP
.PP
Inherits \fBAudio\fP.
.PP
.SS "Public Methods"
.in +1c
.ti -1c
.RI "virtual unsigned \fBencode\fP (Linear buffer, void *dest, unsigned lsamples)=0"
.br
.RI "\fIEncode a linear sample frame into the codec sample buffer.\fP"
.ti -1c
.RI "virtual unsigned \fBdecode\fP (Linear buffer, void *source, unsigned lsamples)=0"
.br
.RI "\fIDecode the sample frame into linear samples.\fP"
.in -1c
.SH "DETAILED DESCRIPTION"
.PP
The codec class is a virtual used for transcoding audio samples between linear frames (or other known format) and an encoded 'sample' buffer. process codec interface.
.PP
This class is only abstract and describes the core interface for loadable codec modules. This class is normally merged with \fBAudioSample\fP. A derived AudioCodecXXX will typically include a AudioRegisterXXX static class to automatically initialize and register the codec with the codec registry.
.PP
\fBAuthor: \fP
.in +1c
David Sugar <dyfet@ostel.com>
.PP
.SH "MEMBER FUNCTION DOCUMENTATION"
.PP
.SS "virtual unsigned AudioCodec::decode (Linear buffer, void * source, unsigned lsamples)\fC [pure virtual]\fP"
.PP
Decode the sample frame into linear samples.
.PP
\fBReturns: \fP
.in +1c
number of bytes scanned.
.PP
\fBParameters: \fP
.in +1c
.TP
\fB\fIbuffer\fP\fP
sample buffer to save linear samples into.
.TP
\fB\fIsource\fP\fP
for encoded data.
.TP
\fB\fInumber\fP\fP
of samples to extract.
.SS "virtual unsigned AudioCodec::encode (Linear buffer, void * dest, unsigned lsamples)\fC [pure virtual]\fP"
.PP
Encode a linear sample frame into the codec sample buffer.
.PP
\fBParameters: \fP
.in +1c
.TP
\fB\fInumber\fP\fP
of bytes written.
.TP
\fB\fIbuffer\fP\fP
linear sample buffer to use.
.TP
\fB\fIdest\fP\fP
buffer to store encoded results.
.TP
\fB\fIlsamples\fP\fP
The number of linear samples.
.SH "AUTHOR"
.PP
Generated automatically by Doxygen for ccAudio from the source code.
|
