Line data    Source code

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