Oolite 1.91.0.7645-241119-222d325
Loading...
Searching...
No Matches
OOALSoundDecoder.h
Go to the documentation of this file.
1/*
2
3OOALSoundDecoder.h
4
5Class responsible for converting a sound to a PCM buffer for playback. This
6class is an implementation detail. Do not use it directly; use OOSound to
7load sounds.
8
9
10OOALSound - OpenAL sound implementation for Oolite.
11Copyright (C) 2005-2013 Jens Ayton
12
13Permission is hereby granted, free of charge, to any person obtaining a copy
14of this software and associated documentation files (the "Software"), to deal
15in the Software without restriction, including without limitation the rights
16to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
17copies of the Software, and to permit persons to whom the Software is
18furnished to do so, subject to the following conditions:
19
20The above copyright notice and this permission notice shall be included in all
21copies or substantial portions of the Software.
22
23THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
24IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
25FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
26AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
27LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
28OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
29SOFTWARE.
30
31*/
32
33#import <Foundation/Foundation.h>
34
35#define OOAL_STREAM_CHUNK_SIZE (sizeof(char) * 409600)
36
37@interface OOALSoundDecoder: NSObject
38
39- (id)initWithPath:(NSString *)inPath;
40+ (OOALSoundDecoder *)codecWithPath:(NSString *)inPath;
41
42// Full-buffer reading.
43- (BOOL)readCreatingBuffer:(char **)outBuffer withFrameCount:(size_t *)outSize;
44
45// Stream reading.
46- (size_t)streamToBuffer:(char *)buffer;
47
48// Returns the size of the data -readMonoCreatingBuffer:withFrameCount: will create.
49- (size_t)sizeAsBuffer;
50
51- (BOOL)isStereo;
52
54
55// For streaming
56- (void) reset;
57
58- (NSString *)name;
59
60@end
typedef long(ZCALLBACK *tell_file_func) OF((voidpf opaque