doc: Remove superfluous comment already described in footnotes.
[mpd-mk.git] / src / pcm_byteswap.h
blobe1196d9b2d2a00f263c94f752596dd0d838c9688
1 /*
2 * Copyright (C) 2003-2009 The Music Player Daemon Project
3 * http://www.musicpd.org
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
20 #ifndef MPD_PCM_BYTESWAP_H
21 #define MPD_PCM_BYTESWAP_H
23 #include <stdint.h>
24 #include <stddef.h>
26 struct pcm_buffer;
28 /**
29 * Changes the endianness of 16 bit PCM data.
31 * @param buffer the destination pcm_buffer object
32 * @param src the source PCM buffer
33 * @param src_size the number of bytes in #src
34 * @return the destination buffer
36 const int16_t *pcm_byteswap_16(struct pcm_buffer *buffer,
37 const int16_t *src, size_t len);
39 /**
40 * Changes the endianness of 32-bit (or 24-bit) PCM data.
42 * @param buffer the destination pcm_buffer object
43 * @param src the source PCM buffer
44 * @param src_size the number of bytes in #src
45 * @return the destination buffer
47 const int32_t *pcm_byteswap_32(struct pcm_buffer *buffer,
48 const int32_t *src, size_t len);
50 #endif