source: mainline/uspace/srv/audio/hound/hound_ctx.h@ ff03f79

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since ff03f79 was c799138, checked in by Jan Vesely <jano.vesely@…>, 12 years ago

hound: doxygen and cleanup

  • Property mode set to 100644
File size: 3.1 KB
RevLine 
[3b6c1d4]1/*
2 * Copyright (c) 2013 Jan Vesely
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * - Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * - Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * - The name of the author may not be used to endorse or promote products
15 * derived from this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29/** @addtogroup audio
30 * @brief HelenOS sound server
31 * @{
32 */
33/** @file
34 */
35
36#ifndef HOUND_CTX_H_
37#define HOUND_CTX_H_
38
39#include <adt/list.h>
40#include <hound/protocol.h>
[599034e]41#include <fibril_synch.h>
42
[aab8e3d3]43#include "audio_source.h"
44#include "audio_sink.h"
[3b6c1d4]45
[c799138]46/** Application context structure */
[3b6c1d4]47typedef struct {
[c799138]48 /** Hound's contexts link */
[3b6c1d4]49 link_t link;
[c799138]50 /** List of streams */
[aab8e3d3]51 list_t streams;
[c799138]52 /** Provided audio source abstraction */
[aab8e3d3]53 audio_source_t *source;
[c799138]54 /** Provided audio sink abstraction */
[aab8e3d3]55 audio_sink_t *sink;
[c799138]56 /** List access synchronization */
[599034e]57 fibril_mutex_t guard;
[3b6c1d4]58} hound_ctx_t;
59
[c799138]60/**
61 * List instance helper.
62 * @param l link
63 * @return pointer to a hound context structure, NULL on failure.
64 */
[3b6c1d4]65static inline hound_ctx_t *hound_ctx_from_link(link_t *l)
66{
[aab8e3d3]67 return l ? list_get_instance(l, hound_ctx_t, link) : NULL;
[3b6c1d4]68}
69
[23878dc]70typedef struct hound_ctx_stream hound_ctx_stream_t;
[b266f9e]71
72
[3b6c1d4]73hound_ctx_t *hound_record_ctx_get(const char *name);
74hound_ctx_t *hound_playback_ctx_get(const char *name);
75void hound_ctx_destroy(hound_ctx_t *context);
76
77hound_context_id_t hound_ctx_get_id(hound_ctx_t *ctx);
78bool hound_ctx_is_record(hound_ctx_t *ctx);
79
[b266f9e]80hound_ctx_stream_t *hound_ctx_create_stream(hound_ctx_t *ctx, int flags,
81 pcm_format_t format, size_t buffer_size);
82void hound_ctx_destroy_stream(hound_ctx_stream_t *stream);
83
[bf13c9a4]84int hound_ctx_stream_write(hound_ctx_stream_t *stream, const void *buffer,
85 size_t size);
86int hound_ctx_stream_read(hound_ctx_stream_t *stream, void *buffer, size_t size);
[599034e]87ssize_t hound_ctx_stream_add_self(hound_ctx_stream_t *stream, void *data,
[5029c788]88 size_t size, const pcm_format_t *f);
[76ea1b7]89void hound_ctx_stream_drain(hound_ctx_stream_t *stream);
[bf13c9a4]90
[3b6c1d4]91#endif
92
93/**
94 * @}
95 */
Note: See TracBrowser for help on using the repository browser.