Debian Codegraph @

BambooTracker/chip/blip_buf/readme.txt

raw
1 blip_buf 1.1.0: Band-Limited Audio Buffer
2 -----------------------------------------
3 Blip_buf is a small waveform synthesis library meant for use in classic
4 video game sound chip emulation. It greatly simplifies sound chip
5 emulation code by handling all the details of resampling. The emulator
6 merely sets the input clock rate and output sample rate, adds waveforms
7 by specifying the clock times where their amplitude changes, then reads
8 the resulting output samples. For a more full-features synthesis
9 library, get Blip_Buffer.
10
11 * Simple C interface and usage.
12 * Several code examples, including simple sound chip emulator.
13 * Uses fast, high-quality band-limited resampling algorithm (BLEP).
14 * Output is low-pass and high-pass filtered and clamped to 16-bit range.
15 * Supports mono, stereo, and multi-channel synthesis.
16
17 Author : Shay Green <[email protected]>
18 Website : http://www.slack.net/~ant/
19 License : GNU Lesser General Public License (LGPL)
20 Language: C
21
22
23 Getting Started
24 ---------------
25 Build the demos by typing "make" at the command-line. If that doesn't
26 work, manually build a program from demo.c, blip_buf.c, and
27 wave_writer.c. Run "demo", which should record a square wave sweep to
28 "out.wav". The others demo advanced topics, and their source code can be
29 used as a starting point for experimentation (after making any changes,
30 just type "make" to do any necessary recompilation).
31
32 To build the SDL demo, type "make demo_sdl" at the command-line, or
33 manually build a program from demo_sdl.c, blip_buf.c, and the SDL
34 multimedia library.
35
36 See blip_buf.h for reference and blip_buf.txt for documentation.
37
38
39 Files
40 -----
41 readme.txt Essential information
42 blip_buf.txt Library documentation
43 license.txt GNU Lesser General Public License
44
45 makefile Builds demos (type "make" at command-line)
46
47 demo.c Generates square wave sweep
48 demo_stereo.c Generates stereo sound using two blip buffers
49 demo_fixed.c Works in fixed-point time rather than clocks
50 demo_sdl.c Plays sound live using SDL multimedia library
51 demo_chip.c Emulates sound hardware and plays back log.txt
52 demo_log.txt Log of sound hardware writes for demo_chip.c
53 wave_writer.h Simple wave sound file writer used by demos
54 wave_writer.c
55
56 blip_buf.h Library header and reference (Doxygen-enabled)
57 blip_buf.c source code
58
59 tests/ Unit tests (build with "make test")
60
61 --
62 Shay Green <[email protected]>