osx_write.c: Rename 'output' to 'audio_unit', add documentation
authorAndre Noll <maan@congo.fml.local>
Mon, 9 Oct 2006 12:19:36 +0000 (14:19 +0200)
committerAndre Noll <maan@congo.fml.local>
Mon, 9 Oct 2006 12:19:36 +0000 (14:19 +0200)
Add missing docu of struct private_osx_write_data.

osx_write.c

index 45d6802..153ae3d 100644 (file)
@@ -53,11 +53,17 @@ struct osx_buffer {
 };
 
 struct private_osx_write_data {
 };
 
 struct private_osx_write_data {
-       AudioUnit output;
+       /** the main control structure for audio data manipulation */
+       AudioUnit audio_unit;
+       /** non-zero if playback has started */
        char play;
        char play;
-       struct osx_buffer *from; /* Current buffers */
+       /** callback reads audio data from this buffer */
+       struct osx_buffer *from;
+       /* the post_select writes audio data here */
        struct osx_buffer *to;
        struct osx_buffer *to;
+       /** sample rate of the current audio stream */
        unsigned samplerate;
        unsigned samplerate;
+       /** number of channels of the current audio stream */
        unsigned channels;
 };
 
        unsigned channels;
 };
 
@@ -185,10 +191,10 @@ static int osx_write_open(struct writer_node *wn)
        if (!comp)
                goto e0;
        ret = -E_OPEN_COMP;
        if (!comp)
                goto e0;
        ret = -E_OPEN_COMP;
-       if (OpenAComponent(comp, &powd->output))
+       if (OpenAComponent(comp, &powd->audio_unit))
                goto e0;
        ret = -E_UNIT_INIT;
                goto e0;
        ret = -E_UNIT_INIT;
-       if (AudioUnitInitialize(powd->output))
+       if (AudioUnitInitialize(powd->audio_unit))
                goto e1;
        powd->play = 0;
        /* Hmmm, let's choose PCM format */
                goto e1;
        powd->play = 0;
        /* Hmmm, let's choose PCM format */
@@ -219,13 +225,13 @@ static int osx_write_open(struct writer_node *wn)
        /* one of the most constant constants of the whole computer history */
        format.mBitsPerChannel = sizeof(float) * 8;
        ret = -E_STREAM_FORMAT;
        /* one of the most constant constants of the whole computer history */
        format.mBitsPerChannel = sizeof(float) * 8;
        ret = -E_STREAM_FORMAT;
-       if (AudioUnitSetProperty(powd->output, kAudioUnitProperty_StreamFormat,
+       if (AudioUnitSetProperty(powd->audio_unit, kAudioUnitProperty_StreamFormat,
                        kAudioUnitScope_Input, 0, &format,
                        sizeof(AudioStreamBasicDescription)))
                goto e2;
        init_buffers(wn);
        ret = -E_ADD_CALLBACK;
                        kAudioUnitScope_Input, 0, &format,
                        sizeof(AudioStreamBasicDescription)))
                goto e2;
        init_buffers(wn);
        ret = -E_ADD_CALLBACK;
-       if (AudioUnitSetProperty(powd->output, kAudioUnitProperty_SetRenderCallback,
+       if (AudioUnitSetProperty(powd->audio_unit, kAudioUnitProperty_SetRenderCallback,
                        kAudioUnitScope_Input, 0, &inputCallback,
                        sizeof(inputCallback)) < 0)
                goto e3;
                        kAudioUnitScope_Input, 0, &inputCallback,
                        sizeof(inputCallback)) < 0)
                goto e3;
@@ -233,9 +239,9 @@ static int osx_write_open(struct writer_node *wn)
 e3:
        destroy_buffers(powd);
 e2:
 e3:
        destroy_buffers(powd);
 e2:
-       AudioUnitUninitialize(powd->output);
+       AudioUnitUninitialize(powd->audio_unit);
 e1:
 e1:
-       CloseComponent(powd->output);
+       CloseComponent(powd->audio_unit);
 e0:
        return ret;
 }
 e0:
        return ret;
 }
@@ -260,9 +266,9 @@ static void osx_write_close(struct writer_node *wn)
        struct private_osx_write_data *powd = wn->private_data;
 
        PARA_INFO_LOG("closing writer node %p\n", wn);
        struct private_osx_write_data *powd = wn->private_data;
 
        PARA_INFO_LOG("closing writer node %p\n", wn);
-       AudioOutputUnitStop(powd->output);
-       AudioUnitUninitialize(powd->output);
-       CloseComponent(powd->output);
+       AudioOutputUnitStop(powd->audio_unit);
+       AudioUnitUninitialize(powd->audio_unit);
+       CloseComponent(powd->audio_unit);
        destroy_buffers(powd);
        free(powd);
 }
        destroy_buffers(powd);
        free(powd);
 }
@@ -292,7 +298,7 @@ static int osx_write_post_select(__a_unused struct sched *s,
        powd->to = powd->to->next;
        wn->written = *wng->loaded;
        if (!powd->play) {
        powd->to = powd->to->next;
        wn->written = *wng->loaded;
        if (!powd->play) {
-               if (AudioOutputUnitStart(powd->output))
+               if (AudioOutputUnitStart(powd->audio_unit))
                        return -E_UNIT_START;
                powd->play = 1;
        }
                        return -E_UNIT_START;
                powd->play = 1;
        }
@@ -326,6 +332,7 @@ min_delay:
        return 1;
 }
 
        return 1;
 }
 
+/** the init function of the osx writer */
 void osx_write_init(struct writer *w)
 {
        w->open = osx_write_open;
 void osx_write_init(struct writer *w)
 {
        w->open = osx_write_open;