src/cdrom/macosx/AudioFilePlayer.h
author Sam Lantinga
Tue, 20 Oct 2009 03:45:06 +0000
branchSDL-1.2
changeset 4368 4c088d2b29eb
parent 4190 386181851388
child 4369 f14cf9d71233
permissions -rw-r--r--
Fixed bug #861

C.W. Betts 2009-10-19 19:16:41 PDT

In 64-bit libraries, the fork reference is a different size than in 32-bit.
Apple has tried to help this transition by making a typedef called FSIORefNum,
but it is only available in Mac OS X 10.5 headers or later. I first noticed
this bug in Mac OS X's CD player code, and the patch is set to fix it
accordingly. This might also be an issue in SDL_QuartzVideo.m
slouken@613
     1
/*
slouken@613
     2
    SDL - Simple DirectMedia Layer
slouken@4159
     3
    Copyright (C) 1997-2009 Sam Lantinga
slouken@613
     4
slouken@613
     5
    This library is free software; you can redistribute it and/or
slouken@613
     6
    modify it under the terms of the GNU Library General Public
slouken@613
     7
    License as published by the Free Software Foundation; either
slouken@613
     8
    version 2 of the License, or (at your option) any later version.
slouken@613
     9
slouken@613
    10
    This library is distributed in the hope that it will be useful,
slouken@613
    11
    but WITHOUT ANY WARRANTY; without even the implied warranty of
slouken@613
    12
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
slouken@613
    13
    Library General Public License for more details.
slouken@613
    14
slouken@613
    15
    You should have received a copy of the GNU Library General Public
slouken@613
    16
    License along with this library; if not, write to the Free
slouken@613
    17
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
slouken@613
    18
slouken@613
    19
    Sam Lantinga
slouken@613
    20
    slouken@libsdl.org
slouken@613
    21
slouken@613
    22
    This file based on Apple sample code. We haven't changed the file name, 
slouken@613
    23
    so if you want to see the original search for it on apple.com/developer
slouken@613
    24
*/
slouken@1402
    25
#include "SDL_config.h"
slouken@613
    26
slouken@1487
    27
/*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
slouken@1487
    28
    AudioFilePlayer.h
slouken@1487
    29
*/
slouken@613
    30
#ifndef __AudioFilePlayer_H__
slouken@613
    31
#define __AudioFilePlayer_H__
slouken@613
    32
slouken@613
    33
#include <CoreServices/CoreServices.h>
slouken@613
    34
slouken@613
    35
#include <AudioUnit/AudioUnit.h>
icculus@4190
    36
#if MAC_OS_X_VERSION_MAX_ALLOWED <= 1050
slouken@4103
    37
#include <AudioUnit/AUNTComponent.h>
slouken@4103
    38
#endif
slouken@613
    39
slouken@653
    40
#include "SDL_error.h"
slouken@613
    41
slouken@613
    42
const char* AudioFilePlayerErrorStr (OSStatus error);
slouken@613
    43
icculus@1143
    44
/*
slouken@613
    45
void ThrowResult (OSStatus result, const char *str);
slouken@613
    46
slouken@613
    47
#define THROW_RESULT(str)                                       \
slouken@613
    48
    if (result) {                                               \
slouken@613
    49
        ThrowResult (result, str);                              \
slouken@613
    50
    }
icculus@1143
    51
*/
slouken@613
    52
slouken@613
    53
typedef void (*AudioFilePlayNotifier)(void          *inRefCon,
slouken@613
    54
                                    OSStatus        inStatus);
slouken@613
    55
slouken@613
    56
enum {
slouken@613
    57
    kAudioFilePlayErr_FilePlayUnderrun = -10000,
slouken@613
    58
    kAudioFilePlay_FileIsFinished = -10001,
slouken@613
    59
    kAudioFilePlay_PlayerIsUninitialized = -10002
slouken@613
    60
};
slouken@613
    61
slouken@613
    62
icculus@1143
    63
struct S_AudioFileManager;
slouken@613
    64
slouken@613
    65
#pragma mark __________ AudioFilePlayer
icculus@1143
    66
typedef struct S_AudioFilePlayer
slouken@613
    67
{
slouken@1487
    68
/*public:*/
icculus@1143
    69
    int             (*SetDestination)(struct S_AudioFilePlayer *afp, AudioUnit *inDestUnit);
icculus@1143
    70
    void            (*SetNotifier)(struct S_AudioFilePlayer *afp, AudioFilePlayNotifier inNotifier, void *inRefCon);
slouken@1487
    71
    void            (*SetStartFrame)(struct S_AudioFilePlayer *afp, int frame); /* seek in the file */
slouken@1487
    72
    int             (*GetCurrentFrame)(struct S_AudioFilePlayer *afp); /* get the current frame position */
slouken@1487
    73
    void            (*SetStopFrame)(struct S_AudioFilePlayer *afp, int frame);   /* set limit in the file */
icculus@1143
    74
    int             (*Connect)(struct S_AudioFilePlayer *afp);
icculus@1143
    75
    void            (*Disconnect)(struct S_AudioFilePlayer *afp);
icculus@1143
    76
    void            (*DoNotification)(struct S_AudioFilePlayer *afp, OSStatus inError);
icculus@1143
    77
    int             (*IsConnected)(struct S_AudioFilePlayer *afp);
icculus@1143
    78
    AudioUnit       (*GetDestUnit)(struct S_AudioFilePlayer *afp);
icculus@1143
    79
    void            (*Print)(struct S_AudioFilePlayer *afp);
slouken@613
    80
slouken@1487
    81
/*private:*/
slouken@613
    82
    AudioUnit                       mPlayUnit;
slouken@4368
    83
#if MAC_OS_X_VERSION_MAX_ALLOWED >= 1050
slouken@4368
    84
    FSIORefNum                      mForkRefNum;
slouken@4368
    85
#else
slouken@4368
    86
    int                             mForkRefNum;
slouken@4368
    87
#endif
slouken@4368
    88
icculus@4190
    89
    AURenderCallbackStruct          mInputCallback;
slouken@613
    90
slouken@613
    91
    AudioStreamBasicDescription     mFileDescription;
slouken@613
    92
    
icculus@1143
    93
    int                             mConnected;
slouken@613
    94
    
icculus@1143
    95
    struct S_AudioFileManager*      mAudioFileManager;
slouken@613
    96
    
slouken@613
    97
    AudioFilePlayNotifier           mNotifier;
slouken@613
    98
    void*                           mRefCon;
slouken@613
    99
    
slouken@613
   100
    int                             mStartFrame;
slouken@613
   101
    
slouken@613
   102
#pragma mark __________ Private_Methods
slouken@613
   103
    
icculus@1143
   104
    int          (*OpenFile)(struct S_AudioFilePlayer *afp, const FSRef *inRef, SInt64 *outFileSize);
icculus@1143
   105
} AudioFilePlayer;
icculus@1143
   106
icculus@1143
   107
icculus@1143
   108
AudioFilePlayer *new_AudioFilePlayer(const FSRef    *inFileRef);
icculus@1143
   109
void delete_AudioFilePlayer(AudioFilePlayer *afp);
icculus@1143
   110
icculus@1143
   111
slouken@613
   112
slouken@613
   113
#pragma mark __________ AudioFileManager
icculus@1143
   114
typedef struct S_AudioFileManager
slouken@613
   115
{
slouken@1487
   116
/*public:*/
slouken@1487
   117
        /* this method should NOT be called by an object of this class
slouken@1487
   118
           as it is called by the parent's Disconnect() method */
icculus@1143
   119
    void                (*Disconnect)(struct S_AudioFileManager *afm);
icculus@1143
   120
    int                 (*DoConnect)(struct S_AudioFileManager *afm);
icculus@4190
   121
    OSStatus            (*Read)(struct S_AudioFileManager *afm, char *buffer, ByteCount *len);
icculus@1143
   122
    const char*         (*GetFileBuffer)(struct S_AudioFileManager *afm);
icculus@1143
   123
    const AudioFilePlayer *(*GetParent)(struct S_AudioFileManager *afm);
slouken@1487
   124
    void                (*SetPosition)(struct S_AudioFileManager *afm, SInt64 pos);  /* seek/rewind in the file */
slouken@1487
   125
    int                 (*GetByteCounter)(struct S_AudioFileManager *afm);  /* return actual bytes streamed to audio hardware */
slouken@1487
   126
    void                (*SetEndOfFile)(struct S_AudioFileManager *afm, SInt64 pos);  /* set the "EOF" (will behave just like it reached eof) */
slouken@613
   127
   
slouken@1487
   128
/*protected:*/
icculus@1143
   129
    AudioFilePlayer*    mParent;
slouken@768
   130
    SInt16              mForkRefNum;
slouken@768
   131
    SInt64              mAudioDataOffset;
slouken@613
   132
    
slouken@768
   133
    char*               mFileBuffer;
slouken@768
   134
slouken@768
   135
    int                 mByteCounter;
slouken@613
   136
icculus@1143
   137
    int                mReadFromFirstBuffer;
icculus@1143
   138
    int                mLockUnsuccessful;
icculus@1143
   139
    int                mIsEngaged;
slouken@768
   140
    
slouken@768
   141
    int                 mNumTimesAskedSinceFinished;
slouken@613
   142
slouken@935
   143
slouken@935
   144
	void*               mTmpBuffer;
slouken@935
   145
	UInt32              mBufferSize;
slouken@935
   146
	UInt32              mBufferOffset;
slouken@1487
   147
/*public:*/
icculus@1143
   148
    UInt32              mChunkSize;
slouken@768
   149
    SInt64              mFileLength;
slouken@768
   150
    SInt64              mReadFilePosition;
icculus@1143
   151
    int                 mWriteToFirstBuffer;
icculus@1143
   152
    int                 mFinishedReadingData;
icculus@1143
   153
slouken@1487
   154
/*protected:*/
icculus@4190
   155
    OSStatus            (*Render)(struct S_AudioFileManager *afm, AudioBufferList *ioData);
icculus@1143
   156
    OSStatus            (*GetFileData)(struct S_AudioFileManager *afm, void** inOutData, UInt32 *inOutDataSize);
icculus@1143
   157
    void                (*AfterRender)(struct S_AudioFileManager *afm);
slouken@768
   158
slouken@1487
   159
/*public:*/
slouken@1487
   160
    /*static*/
icculus@4190
   161
    OSStatus            (*FileInputProc)(void                            *inRefCon,
icculus@4190
   162
                                         AudioUnitRenderActionFlags      *ioActionFlags,
icculus@1143
   163
                                         const AudioTimeStamp            *inTimeStamp,
icculus@1143
   164
                                         UInt32                          inBusNumber,
icculus@4190
   165
                                         UInt32                          inNumberFrames,
icculus@4190
   166
                                         AudioBufferList                 *ioData);
icculus@1143
   167
} AudioFileManager;
slouken@613
   168
slouken@613
   169
icculus@1143
   170
AudioFileManager *new_AudioFileManager (AudioFilePlayer *inParent,
icculus@1143
   171
                      SInt16          inForkRefNum, 
icculus@1143
   172
                      SInt64          inFileLength,
icculus@1143
   173
                      UInt32          inChunkSize);
icculus@1143
   174
    
icculus@1143
   175
void delete_AudioFileManager(AudioFileManager *afm);
icculus@1143
   176
slouken@613
   177
#endif
icculus@1143
   178