source: mainline/uspace/srv/audio/hound/audio_source.h@ eed4139

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since eed4139 was 33b8d024, checked in by Jiří Zárevúcky <zarevucky.jiri@…>, 8 years ago

Remove const qualifier from the argument of free() and realloc(),
as well as in numerous other variables that hold ownership of memory.

By convention, a pointer that holds ownership is _never_ qualified by const.
This is reflected in the standard type signature of free() and realloc().
Allowing const pointers to hold ownership may seem superficially convenient,
but is actually quite confusing to experienced C programmers.

  • Property mode set to 100644
File size: 2.9 KB
Line 
1/*
2 * Copyright (c) 2012 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 AUDIO_SOURCE_H_
37#define AUDIO_SOURCE_H_
38
39#include <adt/list.h>
40#include <pcm/format.h>
41
42typedef struct audio_source audio_source_t;
43
44/** Audio data source abstraction structure */
45struct audio_source {
46 /** Link in hound's sources list */
47 link_t link;
48 /** List of connections */
49 list_t connections;
50 /** String identifier */
51 char *name;
52 /** audio data format */
53 pcm_format_t format;
54 /** backend data */
55 void *private_data;
56 /** Callback for connection and disconnection */
57 errno_t (*connection_change)(audio_source_t *source, bool added);
58 /** Ask backend for more data */
59 errno_t (*update_available_data)(audio_source_t *source, size_t size);
60};
61
62/**
63 * List instance helper.
64 * @param l link
65 * @return pointer to a source structure, NULL on failure.
66 */
67static inline audio_source_t * audio_source_list_instance(link_t *l)
68{
69 return l ? list_get_instance(l, audio_source_t, link) : NULL;
70}
71
72errno_t audio_source_init(audio_source_t *source, const char *name, void *data,
73 errno_t (*connection_change)(audio_source_t *, bool),
74 errno_t (*update_available_data)(audio_source_t *, size_t),
75 const pcm_format_t *f);
76void audio_source_fini(audio_source_t *source);
77errno_t audio_source_push_data(audio_source_t *source, void *data,
78 size_t size);
79static inline const pcm_format_t *audio_source_format(const audio_source_t *s)
80{
81 assert(s);
82 return &s->format;
83}
84#endif
85
86/**
87 * @}
88 */
Note: See TracBrowser for help on using the repository browser.