OOALSoundVorbisCodec Class Reference

Inheritance diagram for OOALSoundVorbisCodec:

Collaboration diagram for OOALSoundVorbisCodec:

Instance Methods
(NSDictionary *)	- comments
(id)	- initWithPath: [implementation]
(void)	- dealloc [implementation]
(BOOL)	- readCreatingBuffer:withFrameCount: [implementation]
(size_t)	- streamToBuffer: [implementation]
(size_t)	- sizeAsBuffer [implementation]
(BOOL)	- isStereo [implementation]
(NSString *)	- description [implementation]
(long)	- sampleRate [implementation]
(void)	- reset [implementation]
(NSString *)	- name [implementation]

Public Attributes
unzFile	uf

Protected Attributes
OggVorbis_File	_vf
NSString *	_name
BOOL	_readStarted
BOOL	_seekableStream

Additional Inherited Members
Class Methods inherited from OOALSoundDecoder
(OOALSoundDecoder *)	+ codecWithPath:

Detailed Description

Definition at line 46 of file OOALSoundDecoder.m.

Method Documentation

comments

- (NSDictionary *) comments

Definition at line 291 of file OOALSoundDecoder.m.

{
    vorbis_comment          *comments;
    unsigned                i, count;
    NSMutableDictionary     *result = nil;
    NSString                *comment, *key, *value;
    NSRange                 range;
    
    comments = ov_comment(&_vf, -1);
    if (NULL != comments)
    {
        count = comments->comments;
        if (0 != count)
        {
            result = [NSMutableDictionary dictionaryWithCapacity:count];
            for (i = 0; i != count; ++i)
            {
                comment = [[NSString alloc] initWithBytesNoCopy:comments->user_comments[i] length:comments->comment_lengths[i] encoding:NSUTF8StringEncoding freeWhenDone:NO];
                range = [comment rangeOfString:@"="];
                if (0 != range.length)
                {
                    key = [comment substringToIndex:range.location];
                    value = [comment substringFromIndex:range.location + 1];
                }
                else
                {
                    key = comment;
                    value = @"";
                }
                [result setObject:value forKey:key];
                
                [comment release];
            }
        }
    }
    
    return result;
}

References _vf, comments, count, and nil.

Referenced by comments, and description.

Here is the call graph for this function:

Here is the caller graph for this function:

dealloc

- (void) dealloc

implementation

Definition at line 274 of file OOALSoundDecoder.m.

{
#ifdef OOLITE_DEBUG_SOUND_FILE_OPENING
    if (self != nil)
    {
        OOLog(@"sound.release",@"%@",_name);
    }
#endif
 
    [_name release];
    ov_clear(&_vf);
    unzClose(uf);
    
    [super dealloc];
}

References _name, _vf, dealloc, nil, OOLog, uf, and unzClose().

Referenced by dealloc.

Here is the call graph for this function:

Here is the caller graph for this function:

description

- (NSString *) description

implementation

Definition at line 453 of file OOALSoundDecoder.m.

{
    return [NSString stringWithFormat:@"<%@ %p>{\"%@\", comments=%@}", [self className], self, _name, [self comments]];
}

References comments, and description.

Referenced by description.

Here is the call graph for this function:

Here is the caller graph for this function:

initWithPath:

- (id) initWithPath: (NSString *) path

implementation

Reimplemented from OOALSoundDecoder.

Definition at line 136 of file OOALSoundDecoder.m.

                  :(NSString *)path
{
    if ((self = [super init]))
    {
        BOOL                OK = NO;
 
        _name = [[path lastPathComponent] retain];
 
        NSUInteger i, cl;
        NSArray *components = [path pathComponents];
        cl = [components count];
        for (i = 0 ; i < cl ; i++)
        {
            NSString *component = [components objectAtIndex:i];
            if ([[[component pathExtension] lowercaseString] isEqualToString:@"oxz"])
            {
                break;
            }
        }
        // if i == cl then the path is entirely uncompressed
        if (i == cl)
        {
            /* Get vorbis data from a standard file stream */
            int                 err;
            FILE                *file;
    
            _seekableStream = YES;
        
            if (nil != path)
            {
                file = fopen([path UTF8String], "rb");
                if (NULL != file) 
                {
                    err = ov_open_callbacks(file, &_vf, NULL, 0, OV_CALLBACKS_DEFAULT);
                    if (0 == err)
                    {
                        OK = YES;
                    }
                }
            }
        
            if (!OK)
            {
                [self release];
                self = nil;
            }
        
        }
        else
        {
            _seekableStream = NO;
 
            NSRange range;
            range.location = 0; range.length = i+1;
            NSString *zipFile = [NSString pathWithComponents:[components subarrayWithRange:range]];
            range.location = i+1; range.length = cl-(i+1);
            NSString *containedFile = [NSString pathWithComponents:[components subarrayWithRange:range]];
 
    
            const char* zipname = [zipFile UTF8String];
            if (zipname != NULL)
            {
                uf = unzOpen64(zipname);
            }
            if (uf == NULL)
            {
                OOLog(kOOLogFileNotFound, @"Could not unzip OXZ at %@", zipFile);
                [self release];
                self = nil;
            }
            else 
            {
                const char* filename = [containedFile UTF8String];
                // unzLocateFile(*, *, 1) = case-sensitive extract
                if (unzLocateFile(uf, filename, 1) != UNZ_OK)
                {
                    unzClose(uf);
                    [self release];
                    self = nil;
                }
                else
                {
                    int err = UNZ_OK;
                    unz_file_info64 file_info = {0};
                    err = unzGetCurrentFileInfo64(uf, &file_info, NULL, 0, NULL, 0, NULL, 0);
                    if (err != UNZ_OK)
                    {
                        unzClose(uf);
                        OOLog(kOOLogFileNotFound, @"Could not get properties of %@ within OXZ at %@", containedFile, zipFile);
                        [self release];
                        self = nil;
                    }
                    else
                    {
                        err = unzOpenCurrentFile(uf);
                        if (err != UNZ_OK)
                        {
                            unzClose(uf);
                            OOLog(kOOLogFileNotFound, @"Could not read %@ within OXZ at %@", containedFile, zipFile);
                            [self release];
                            self = nil;
                        }
                        else
                        {
                            ov_callbacks _callbacks = {
                                OOReadOXZVorbis, // read sequentially
                                NULL, // no seek
                                OOCloseOXZVorbis, // close file
                                NULL, // no tell
                            };
                            err = ov_open_callbacks(self, &_vf, NULL, 0, _callbacks);
                            if (0 == err)
                            {
                                OK = YES;
                                _readStarted = NO;
                            }
                            if (!OK)
                            {
                                unzClose(uf);
                                [self release];
                                self = nil;
                            }
                        }
                    }
                }
            }
        }
    }
#ifdef OOLITE_DEBUG_SOUND_FILE_OPENING
    if (self != nil)
    {
        OOLog(@"sound.retain",@"%@",_name);
    }
#endif
    return self;
}

References _name, _readStarted, _seekableStream, _vf, kOOLogFileNotFound, nil, OOCloseOXZVorbis(), OOLog, OOReadOXZVorbis(), uf, UNZ_OK, unzClose(), unzGetCurrentFileInfo64(), unzLocateFile(), unzOpen64(), and unzOpenCurrentFile().

Here is the call graph for this function:

isStereo

- (BOOL) isStereo

implementation

Reimplemented from OOALSoundDecoder.

Definition at line 447 of file OOALSoundDecoder.m.

{
    return 1 < ov_info(&_vf, -1)->channels;
}

References _vf, and isStereo.

Referenced by isStereo, readCreatingBuffer:withFrameCount:, and sizeAsBuffer.

Here is the call graph for this function:

Here is the caller graph for this function:

name

- (NSString *) name

implementation

Reimplemented from OOALSoundDecoder.

Definition at line 492 of file OOALSoundDecoder.m.

{
    return [[_name retain] autorelease];
}

References name.

Referenced by name.

Here is the call graph for this function:

Here is the caller graph for this function:

readCreatingBuffer:withFrameCount:

- (BOOL) readCreatingBuffer: (char **) outBuffer withFrameCount: (size_t *) outSize

implementation

Reimplemented from OOALSoundDecoder.

Definition at line 331 of file OOALSoundDecoder.m.

                          :(char **)outBuffer withFrameCount:(size_t *)outSize
{
    char                    *buffer = NULL, *dst;
    size_t                  sizeInFrames = 0;
    int                     remaining;
    long                    framesRead;
    // 16-bit samples, either two or one track
    int                     frameSize = [self isStereo] ? 4 : 2;
    ogg_int64_t             totalSizeInFrames;
    BOOL                    OK = YES;
    
    if (NULL != outBuffer) *outBuffer = NULL;
    if (NULL != outSize) *outSize = 0;
    if (NULL == outBuffer || NULL == outSize) OK = NO;
    
    if (OK)
    {
        totalSizeInFrames = ov_pcm_total(&_vf, -1);
        assert ((uint64_t)totalSizeInFrames < (uint64_t)SIZE_MAX);  // Should have been checked by caller
        sizeInFrames = (size_t)totalSizeInFrames;
    }
    
    if (OK)
    {
        buffer = malloc(sizeof (char) * frameSize * sizeInFrames);
        if (!buffer) OK = NO;
    }
    
    if (OK && sizeInFrames)
    {
        remaining = (int)MIN(frameSize * sizeInFrames, (size_t)INT_MAX);
        dst = buffer;
        
        char pcmout[4096];
 
        do
        {
            int toRead = sizeof(pcmout);
            if (remaining < toRead)
            {
                toRead = remaining;
            }
            framesRead = ov_read(&_vf, pcmout, toRead, 0, 2, 1, NULL);
            if (framesRead <= 0)
            {
                if (OV_HOLE == framesRead) continue;
                //else:
                break;
            }
            
            memcpy(dst, &pcmout, sizeof (char) * framesRead);
            
            remaining -= framesRead;
            dst += framesRead;
        } while (0 < remaining);
        
        sizeInFrames -= remaining;  // In case we stopped at an error
    }
    
    if (OK)
    {
        *outBuffer = buffer;
        *outSize = sizeInFrames*frameSize;
    }
    else
    {
        if (buffer) free(buffer);
    }
    return OK;
}

References _vf, int(), isStereo, and MIN.

Here is the call graph for this function:

reset

- (void) reset

implementation

Reimplemented from OOALSoundDecoder.

Definition at line 466 of file OOALSoundDecoder.m.

{
    if (!_readStarted)
    {
        return; // don't need to do anything
    }
    if (_seekableStream)
    {
        ov_pcm_seek(&_vf, 0);
        return;
    }
    // reset current file pointer in OXZ
    unzOpenCurrentFile(uf);
    // reopen OGG streamer
    ov_clear(&_vf);
    ov_callbacks _callbacks = {
        OOReadOXZVorbis, // read sequentially
        NULL, // no seek
        OOCloseOXZVorbis, // close file
        NULL, // no tell
    };
    ov_open_callbacks(self, &_vf, NULL, 0, _callbacks);
    _readStarted = NO;
}

References _readStarted, _seekableStream, _vf, OOCloseOXZVorbis(), OOReadOXZVorbis(), reset, uf, and unzOpenCurrentFile().

Referenced by reset.

Here is the call graph for this function:

Here is the caller graph for this function:

sampleRate

- (long) sampleRate

implementation

Reimplemented from OOALSoundDecoder.

Definition at line 459 of file OOALSoundDecoder.m.

{
    return ov_info(&_vf, -1)->rate;
}

References _vf, long(), and sampleRate.

Referenced by sampleRate.

Here is the call graph for this function:

Here is the caller graph for this function:

sizeAsBuffer

- (size_t) sizeAsBuffer

implementation

Reimplemented from OOALSoundDecoder.

Definition at line 437 of file OOALSoundDecoder.m.

{
    ogg_int64_t             size;
    size = ov_pcm_total(&_vf, -1);
    size *= sizeof(char) * ([self isStereo] ? 4 : 2);
    if ((uint64_t)SIZE_MAX < (uint64_t)size) size = (ogg_int64_t)SIZE_MAX;
    return (size_t)size;
}

References _vf, isStereo, and sizeAsBuffer.

Referenced by sizeAsBuffer.

Here is the call graph for this function:

Here is the caller graph for this function:

streamToBuffer:

- (size_t) streamToBuffer: (char *) buffer

implementation

Reimplemented from OOALSoundDecoder.

Definition at line 403 of file OOALSoundDecoder.m.

                        :(char *)buffer
{
    
    int remaining = OOAL_STREAM_CHUNK_SIZE;
    size_t streamed = 0;
    long framesRead;
 
    char *dst = buffer;
    char pcmout[4096];
    _readStarted = YES;
    do
    {
        int toRead = sizeof(pcmout);
        if (remaining < toRead)
        {
            toRead = remaining;
        }
        framesRead = ov_read(&_vf, pcmout, toRead, 0, 2, 1, NULL);
        if (framesRead <= 0)
        {
            if (OV_HOLE == framesRead) continue;
            //else:
            break;
        }
        memcpy(dst, &pcmout, sizeof (char) * framesRead);
        remaining -= sizeof(char) * framesRead;
        dst += sizeof(char) * framesRead;
        streamed += sizeof(char) * framesRead;
    } while (0 < remaining);
 
    return streamed;
}

References _readStarted, _vf, and OOAL_STREAM_CHUNK_SIZE.

Member Data Documentation

_name

- (NSString*) _name

protected

Definition at line 49 of file OOALSoundDecoder.m.

Referenced by dealloc, and initWithPath:.

_readStarted

- (BOOL) _readStarted

protected

Definition at line 50 of file OOALSoundDecoder.m.

Referenced by initWithPath:, reset, and streamToBuffer:.

_seekableStream

- (BOOL) _seekableStream

protected

Definition at line 51 of file OOALSoundDecoder.m.

Referenced by initWithPath:, and reset.

_vf

- (OggVorbis_File) _vf

protected

Definition at line 48 of file OOALSoundDecoder.m.

Referenced by comments, dealloc, initWithPath:, isStereo, readCreatingBuffer:withFrameCount:, reset, sampleRate, sizeAsBuffer, and streamToBuffer:.

uf

- (unzFile) uf

Definition at line 53 of file OOALSoundDecoder.m.

Referenced by dealloc, initWithPath:, OOReadOXZVorbis(), and reset.

---

The documentation for this class was generated from the following file:

• src/Core/OOALSoundDecoder.m