fix doxygen comment of the init functions of all audio format handlers.

[paraslash.git] / osx_write.c

diff --git a/osx_write.c b/osx_write.c
index 4d0bfbdf4f4f9aa300364aa3d53dcee40bb8ba14..107746c78e83f8f875d640a27114ee0d57eb01fa 100644 (file)
--- a/osx_write.c
+++ b/osx_write.c
@@ -1,5 +1,5 @@
 /*
 /*

- * Copyright (C) 2006 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2006-2007 Andre Noll <maan@systemlinux.org>

  *
  *     This program is free software; you can redistribute it and/or modify
  *     it under the terms of the GNU General Public License as published by
  *
  *     This program is free software; you can redistribute it and/or modify
  *     it under the terms of the GNU General Public License as published by


@@ -44,7 +44,7 @@ struct osx_buffer {
        float *buffer;
        /** the size of this buffer */
        long size;
        float *buffer;
        /** the size of this buffer */
        long size;

-       /* current position in the buffer */
+       /** current position in the buffer */

        float *ptr;
        /** number of floats not yet consuned */
        long remaining;
        float *ptr;
        /** number of floats not yet consuned */
        long remaining;


@@ -52,13 +52,19 @@ struct osx_buffer {
        struct osx_buffer *next;
 };
 
        struct osx_buffer *next;
 };
 

+/** data specific to the osx writer */

 struct private_osx_write_data {
 struct private_osx_write_data {

-       long size;
-       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;
 };
 


@@ -137,10 +143,7 @@ static OSStatus osx_callback(void * inClientData,
                while (m > 0) {
                        if ((n = powd->from->remaining) <= 0) {
                                PARA_INFO_LOG("%s", "buffer underrun\n");
                while (m > 0) {
                        if ((n = powd->from->remaining) <= 0) {
                                PARA_INFO_LOG("%s", "buffer underrun\n");

-                               /* no more bytes in the current read buffer! */
-                               while ((n = powd->from->remaining) <= 0)
-                                       /* wait for the results */
-                                       usleep(2000);
+                               return 0;

                        }
 //                     PARA_INFO_LOG("buf %p: n = %ld, m= %ld\n", powd->from->buffer, n, m);
                        /*
                        }
 //                     PARA_INFO_LOG("buf %p: n = %ld, m= %ld\n", powd->from->buffer, n, m);
                        /*


@@ -186,12 +189,11 @@ 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;
                goto e1;

-       powd->size = 0;

        powd->play = 0;
        /* Hmmm, let's choose PCM format */
        /* We tell the Output Unit what format we're going to supply data to it.
        powd->play = 0;
        /* Hmmm, let's choose PCM format */
        /* We tell the Output Unit what format we're going to supply data to it.


@@ -221,13 +223,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;


@@ -235,14 +237,14 @@ 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;
 }
 

-__malloc void *osx_write_parse_config(char *options)
+__malloc static void *osx_write_parse_config(const char *options)

 {
        struct osx_write_args_info *conf
                = para_calloc(sizeof(struct osx_write_args_info));
 {
        struct osx_write_args_info *conf
                = para_calloc(sizeof(struct osx_write_args_info));


@@ -262,9 +264,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);
 }


@@ -294,7 +296,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;
        }


@@ -328,6 +330,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;