File: al_init_acodec_addon.3

package info (click to toggle)
allegro5 2%3A5.2.2-1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 23,032 kB
  • sloc: ansic: 120,340; cpp: 15,707; objc: 4,805; python: 2,915; java: 2,195; sh: 887; xml: 86; makefile: 49; perl: 37; pascal: 24
file content (40 lines) | stat: -rw-r--r-- 1,170 bytes parent folder | download
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
.TH "al_init_acodec_addon" "3" "" "Allegro reference manual" ""
.SH NAME
.PP
al_init_acodec_addon \- Allegro 5 API
.SH SYNOPSIS
.IP
.nf
\f[C]
#include\ <allegro5/allegro_acodec.h>

bool\ al_init_acodec_addon(void)
\f[]
.fi
.SH DESCRIPTION
.PP
This function registers all the known audio file type handlers for
al_load_sample(3), al_save_sample(3), al_load_audio_stream(3), etc.
.PP
Depending on what libraries are available, the full set of recognised
extensions is: .wav, .flac, .ogg, .opus, .it, .mod, .s3m, .xm, .voc.
.PP
\f[I]Limitations:\f[]
.IP \[bu] 2
Saving is only supported for wav files.
.IP \[bu] 2
The wav file loader currently only supports 8/16 bit little endian PCM
files.
16 bits are used when saving wav files.
Use flac files if more precision is required.
.IP \[bu] 2
Module files (.it, .mod, .s3m, .xm) are often composed with streaming in
mind, and sometimes cannot be easily rendered into a finite length
sample.
Therefore they cannot be loaded with
al_load_sample(3)/al_load_sample_f(3) and must be streamed with
al_load_audio_stream(3) or al_load_audio_stream_f(3).
.IP \[bu] 2
\&.voc file streaming is unimplemented.
.PP
Return true on success.