/*
* Copyright (c) 2013 Jan Vesely
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* - Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* - Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* - The name of the author may not be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
/** @addtogroup audio
* @brief HelenOS sound server
* @{
*/
/** @file
*/
#ifndef AUDIO_DATA_H_
#define AUDIO_DATA_H_
#include <adt/list.h>
#include <refcount.h>
#include <errno.h>
#include <fibril_synch.h>
#include <pcm/format.h>
/** Reference counted audio buffer */
typedef struct {
/** Audio data */
void *data;
/** Size of the buffer pointer to by data */
size_t size;
/** Format of the audio data */
pcm_format_t format;
/** Reference counter */
atomic_refcount_t refcount;
} audio_data_t;
/** Audio data pipe structure */
typedef struct {
/** List of audio data buffers */
list_t list;
/** Total size of all buffers */
size_t bytes;
/** Total frames stored in all buffers */
size_t frames;
/** List access synchronization */
fibril_mutex_t guard;
} audio_pipe_t;
audio_data_t *audio_data_create(void *data, size_t size,
pcm_format_t format);
void audio_data_addref(audio_data_t *adata);
void audio_data_unref(audio_data_t *adata);
void audio_pipe_init(audio_pipe_t *pipe);
void audio_pipe_fini(audio_pipe_t *pipe);
errno_t audio_pipe_push(audio_pipe_t *pipe, audio_data_t *data);
audio_data_t *audio_pipe_pop(audio_pipe_t *pipe);
size_t audio_pipe_mix_data(audio_pipe_t *pipe, void *buffer, size_t size,
const pcm_format_t *f);
/**
* Total bytes getter.
* @param pipe The audio pipe.
* @return Total size of buffer stored in the pipe.
*/
static inline size_t audio_pipe_bytes(audio_pipe_t *pipe)
{
assert(pipe);
return pipe->bytes;
}
/**
* Total bytes getter.
* @param pipe The audio pipe.
* @return Total number of frames stored in the pipe.
*/
static inline size_t audio_pipe_frames(audio_pipe_t *pipe)
{
assert(pipe);
return pipe->frames;
}
/**
* Push data form buffer directly to pipe.
* @param pipe The target pipe.
* @param data audio buffer.
* @param size size of the @p data buffer
* @param f format of the audio data.
* @return Error code.
*
* Reference counted buffer is created automatically.
*/
static inline errno_t audio_pipe_push_data(audio_pipe_t *pipe,
void *data, size_t size, pcm_format_t f)
{
audio_data_t *adata = audio_data_create(data, size, f);
if (adata) {
const errno_t ret = audio_pipe_push(pipe, adata);
audio_data_unref(adata);
return ret;
}
return ENOMEM;
}
#endif
/**
* @}
*/