Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 02de8929 authored by Glenn Kasten's avatar Glenn Kasten
Browse files

Cleanup comments for the new control block implementation 

There was some obsolete and incomplete text left over
after the new control block code was submitted.
This cleans up all those comments to be accurate again.

Change-Id: Ic52f5869cb723cde25d709514d6deea6aa6f20aa
parent f36dbfe3

include/media/AudioRecord.h

+1 −2
Original line number Diff line number Diff line
@@ -344,8 +344,7 @@ public: 
                                __attribute__((__deprecated__));



private:

    /* New internal API.

     * If nonContig is non-NULL, it is an output parameter that will be set to the number of

    /* If nonContig is non-NULL, it is an output parameter that will be set to the number of

     * additional non-contiguous frames that are available immediately.

     * FIXME We could pass an array of Buffers instead of only one Buffer to obtainBuffer(),

     * in case the requested amount of frames is in two or more non-contiguous regions.

include/media/AudioTrack.h

+3 −15
Original line number Diff line number Diff line
@@ -331,11 +331,6 @@ public: 
    /* Enables looping and sets the start and end points of looping.

     * Only supported for static buffer mode.

     *

     * FIXME The comments below are for the new planned interpretation which is not yet implemented.

     * Currently the legacy behavior is still implemented, where loopStart and loopEnd

     * are in wrapping (overflow) frame units like the return value of getPosition().

     * The plan is to fix all callers to use the new version at same time implementation changes.

     *

     * Parameters:

     *

     * loopStart:   loop start in frames relative to start of buffer.
@@ -393,11 +388,6 @@ public: 
    /* Sets playback head position.

     * Only supported for static buffer mode.

     *

     * FIXME The comments below are for the new planned interpretation which is not yet implemented.

     * Currently the legacy behavior is still implemented, where the new position

     * is in wrapping (overflow) frame units like the return value of getPosition().

     * The plan is to fix all callers to use the new version at same time implementation changes.

     *

     * Parameters:

     *

     * position:  New playback head position in frames relative to start of buffer.
@@ -427,7 +417,7 @@ public: 
            status_t    getPosition(uint32_t *position) const;



    /* For static buffer mode only, this returns the current playback position in frames

     * relative to start of buffer.  It is analogous to the new API for

     * relative to start of buffer.  It is analogous to the position units used by

     * setLoop() and setPosition().  After underrun, the position will be at end of buffer.

     */

            status_t    getBufferPosition(uint32_t *position);
@@ -517,8 +507,7 @@ public: 
                                __attribute__((__deprecated__));



private:

    /* New internal API

     * If nonContig is non-NULL, it is an output parameter that will be set to the number of

    /* If nonContig is non-NULL, it is an output parameter that will be set to the number of

     * additional non-contiguous frames that are available immediately.

     * FIXME We could pass an array of Buffers instead of only one Buffer to obtainBuffer(),

     * in case the requested amount of frames is in two or more non-contiguous regions.
@@ -546,12 +535,11 @@ public: 
     * This is implemented on top of obtainBuffer/releaseBuffer. For best

     * performance use callbacks. Returns actual number of bytes written >= 0,

     * or one of the following negative status codes:

     *      INVALID_OPERATION   AudioTrack is configured for shared buffer mode

     *      INVALID_OPERATION   AudioTrack is configured for static buffer or streaming mode

     *      BAD_VALUE           size is invalid

     *      WOULD_BLOCK         when obtainBuffer() returns same, or

     *                          AudioTrack was stopped during the write

     *      or any other error code returned by IAudioTrack::start() or restoreTrack_l().

     * Not supported for static buffer mode.

     */

            ssize_t     write(const void* buffer, size_t size);