source: roaraudio/libroarpulse/sample.c @ 3414:4c5cb34458dd

Last change on this file since 3414:4c5cb34458dd was 3414:4c5cb34458dd, checked in by phi, 10 years ago

a lot prototypes

File size: 3.2 KB
Line 
1//sample.c:
2
3/*
4 *      Copyright (C) Philipp 'ph3-der-loewe' Schafft - 2010
5 *  The code (may) include prototypes and comments (and maybe
6 *  other code fragements) from libpulse*. They are mostly copyrighted by:
7 *  Lennart Poettering <poettering@users.sourceforge.net> and
8 *  Pierre Ossman <drzeus@drzeus.cx>
9 *
10 *  This file is part of libroarpulse a part of RoarAudio,
11 *  a cross-platform sound system for both, home and professional use.
12 *  See README for details.
13 *
14 *  This file is free software; you can redistribute it and/or modify
15 *  it under the terms of the GNU General Public License version 3
16 *  as published by the Free Software Foundation.
17 *
18 *  RoarAudio is distributed in the hope that it will be useful,
19 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
20 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21 *  GNU General Public License for more details.
22 *
23 *  You should have received a copy of the GNU General Public License
24 *  along with this software; see the file COPYING.  If not, write to
25 *  the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
26 *
27 *  NOTE for everyone want's to change something and send patches:
28 *  read README and HACKING! There a addition information on
29 *  the license of this document you need to read before you send
30 *  any patches.
31 *
32 *  NOTE for uses of non-GPL (LGPL,...) software using libesd, libartsc
33 *  or libpulse*:
34 *  The libs libroaresd, libroararts and libroarpulse link this libroar
35 *  and are therefore GPL. Because of this it may be illigal to use
36 *  them with any software that uses libesd, libartsc or libpulse*.
37 */
38
39#include <libroarpulse/libroarpulse.h>
40
41/** Return the amount of bytes playback of a second of audio with the specified sample type takes */
42size_t pa_bytes_per_second(const pa_sample_spec *spec);
43
44/** Return the size of a frame with the specific sample type */
45size_t pa_frame_size(const pa_sample_spec *spec);
46
47/** Return the size of a sample with the specific sample type */
48size_t pa_sample_size(const pa_sample_spec *spec);
49
50/** Calculate the time the specified bytes take to play with the specified sample type */
51pa_usec_t pa_bytes_to_usec(uint64_t length, const pa_sample_spec *spec);
52
53/** Calculates the number of bytes that are required for the specified time. \since 0.9 */
54size_t pa_usec_to_bytes(pa_usec_t t, const pa_sample_spec *spec);
55
56/** Return non-zero when the sample type specification is valid */
57int pa_sample_spec_valid(const pa_sample_spec *spec);
58
59/** Return non-zero when the two sample type specifications match */
60int pa_sample_spec_equal(const pa_sample_spec*a, const pa_sample_spec*b);
61
62/** Return a descriptive string for the specified sample format. \since 0.8 */
63const char *pa_sample_format_to_string(pa_sample_format_t f);
64
65/** Parse a sample format text. Inverse of pa_sample_format_to_string() */
66pa_sample_format_t pa_parse_sample_format(const char *format);
67
68/** Maximum required string length for pa_sample_spec_snprint() */
69#define PA_SAMPLE_SPEC_SNPRINT_MAX 32
70
71/** Pretty print a sample type specification to a string */
72char* pa_sample_spec_snprint(char *s, size_t l, const pa_sample_spec *spec);
73
74/** Pretty print a byte size value. (i.e. "2.5 MiB") */
75char* pa_bytes_snprint(char *s, size_t l, unsigned v);
76
77//ll
Note: See TracBrowser for help on using the repository browser.