audio_processor_file/
lib.rs

1// Augmented Audio: Audio libraries and applications
2// Copyright (c) 2022 Pedro Tacla Yamada
3//
4// The MIT License (MIT)
5//
6// Permission is hereby granted, free of charge, to any person obtaining a copy
7// of this software and associated documentation files (the "Software"), to deal
8// in the Software without restriction, including without limitation the rights
9// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10// copies of the Software, and to permit persons to whom the Software is
11// furnished to do so, subject to the following conditions:
12//
13// The above copyright notice and this permission notice shall be included in
14// all copies or substantial portions of the Software.
15//
16// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22// THE SOFTWARE.
23
24//! [`audio_processor_traits::AudioProcessor`] implementations for audio file playback & writing.
25//!
26//! Currently two processors are provided:
27//!
28//! * [`AudioFileProcessor`] is an input file processor, its `prepare` method will *load the whole
29//!   file onto memory*. Both `wav` and `mp3` are supported via [`symphonia`]
30//!   - If streaming is a requirement this won't work
31//! * [`OutputAudioFileProcessor`] writes `wav` files
32
33pub use audio_file_processor::{
34    file_io, AudioFileProcessor, AudioFileProcessorHandle, InMemoryAudioFile,
35};
36pub use output_file_processor::{OutputAudioFileProcessor, OutputFileSettings};
37
38mod audio_file_processor;
39mod output_file_processor;