xref: /third_party/libsnd/src/ircam.c (revision b815c7f3)
1/*
2** Copyright (C) 2001-2017 Erik de Castro Lopo <erikd@mega-nerd.com>
3**
4** This program is free software; you can redistribute it and/or modify
5** it under the terms of the GNU Lesser General Public License as published by
6** the Free Software Foundation; either version 2.1 of the License, or
7** (at your option) any later version.
8**
9** This program is distributed in the hope that it will be useful,
10** but WITHOUT ANY WARRANTY; without even the implied warranty of
11** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12** GNU Lesser General Public License for more details.
13**
14** You should have received a copy of the GNU Lesser General Public License
15** along with this program; if not, write to the Free Software
16** Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
17*/
18
19#include	"sfconfig.h"
20
21#include	<stdio.h>
22#include	<fcntl.h>
23#include	<string.h>
24#include	<ctype.h>
25
26#include	"sndfile.h"
27#include	"sfendian.h"
28#include	"common.h"
29
30/*------------------------------------------------------------------------------
31** Macros to handle big/little endian issues.
32*/
33
34/* The IRCAM magic number is weird in that one byte in the number can have
35** values of 0x1, 0x2, 0x03 or 0x04. Hence the need for a marker and a mask.
36*/
37
38#define IRCAM_BE_MASK		(MAKE_MARKER (0xFF, 0xFF, 0x00, 0xFF))
39#define IRCAM_BE_MARKER		(MAKE_MARKER (0x64, 0xA3, 0x00, 0x00))
40
41#define IRCAM_LE_MASK		(MAKE_MARKER (0xFF, 0x00, 0xFF, 0xFF))
42#define IRCAM_LE_MARKER		(MAKE_MARKER (0x00, 0x00, 0xA3, 0x64))
43
44#define IRCAM_02B_MARKER	(MAKE_MARKER (0x64, 0xA3, 0x02, 0x00))
45#define IRCAM_03L_MARKER	(MAKE_MARKER (0x64, 0xA3, 0x03, 0x00))
46
47#define IRCAM_DATA_OFFSET	(1024)
48
49/*------------------------------------------------------------------------------
50** Typedefs.
51*/
52
53enum
54{	IRCAM_PCM_16	= 0x00002,
55	IRCAM_FLOAT		= 0x00004,
56	IRCAM_ALAW		= 0x10001,
57	IRCAM_ULAW		= 0x20001,
58	IRCAM_PCM_32	= 0x40004
59} ;
60
61
62/*------------------------------------------------------------------------------
63** Private static functions.
64*/
65
66static	int		ircam_close			(SF_PRIVATE *psf) ;
67static	int		ircam_write_header	(SF_PRIVATE *psf, int calc_length) ;
68static	int		ircam_read_header	(SF_PRIVATE *psf) ;
69
70static	int		get_encoding (int subformat) ;
71
72static	const char*	get_encoding_str (int encoding) ;
73
74/*------------------------------------------------------------------------------
75** Public function.
76*/
77
78int
79ircam_open	(SF_PRIVATE *psf)
80{	int		subformat ;
81	int		error = SFE_NO_ERROR ;
82
83	if (psf->file.mode == SFM_READ || (psf->file.mode == SFM_RDWR && psf->filelength > 0))
84	{	if ((error = ircam_read_header (psf)))
85			return error ;
86		} ;
87
88	subformat = SF_CODEC (psf->sf.format) ;
89
90	if (psf->file.mode == SFM_WRITE || psf->file.mode == SFM_RDWR)
91	{	if ((SF_CONTAINER (psf->sf.format)) != SF_FORMAT_IRCAM)
92			return	SFE_BAD_OPEN_FORMAT ;
93
94		psf->endian = SF_ENDIAN (psf->sf.format) ;
95		if (psf->endian == 0 || psf->endian == SF_ENDIAN_CPU)
96			psf->endian = (CPU_IS_BIG_ENDIAN) ? SF_ENDIAN_BIG : SF_ENDIAN_LITTLE ;
97
98		psf->dataoffset = IRCAM_DATA_OFFSET ;
99
100		if ((error = ircam_write_header (psf, SF_FALSE)))
101			return error ;
102
103		psf->write_header = ircam_write_header ;
104		} ;
105
106	psf->container_close = ircam_close ;
107
108	switch (subformat)
109	{	case SF_FORMAT_ULAW :		/* 8-bit Ulaw encoding. */
110				error = ulaw_init (psf) ;
111				break ;
112
113		case SF_FORMAT_ALAW :		/* 8-bit Alaw encoding. */
114				error = alaw_init (psf) ;
115				break ;
116
117		case SF_FORMAT_PCM_16 :	/* 16-bit linear PCM. */
118		case SF_FORMAT_PCM_32 :	/* 32-bit linear PCM. */
119				error = pcm_init (psf) ;
120				break ;
121
122		case SF_FORMAT_FLOAT :	/* 32-bit linear PCM. */
123				error = float32_init (psf) ;
124				break ;
125
126		default : break ;
127		} ;
128
129	return error ;
130} /* ircam_open */
131
132/*------------------------------------------------------------------------------
133*/
134
135static int
136ircam_read_header	(SF_PRIVATE *psf)
137{	unsigned int	marker, encoding ;
138	float			samplerate ;
139	int				error = SFE_NO_ERROR ;
140
141	psf_binheader_readf (psf, "epmf44", 0, &marker, &samplerate, &(psf->sf.channels), &encoding) ;
142
143	if (((marker & IRCAM_BE_MASK) != IRCAM_BE_MARKER) && ((marker & IRCAM_LE_MASK) != IRCAM_LE_MARKER))
144	{	psf_log_printf (psf, "marker: 0x%X\n", marker) ;
145		return SFE_IRCAM_NO_MARKER ;
146		} ;
147
148	psf->endian = SF_ENDIAN_LITTLE ;
149
150	if (psf->sf.channels > SF_MAX_CHANNELS)
151	{	psf_binheader_readf (psf, "Epmf44", 0, &marker, &samplerate, &(psf->sf.channels), &encoding) ;
152
153		/* Sanity checking for endian-ness detection. */
154		if (psf->sf.channels > SF_MAX_CHANNELS)
155		{	psf_log_printf (psf, "marker: 0x%X\n", marker) ;
156			return SFE_IRCAM_BAD_CHANNELS ;
157			} ;
158
159		psf->endian = SF_ENDIAN_BIG ;
160		} ;
161
162	psf_log_printf (psf, "marker: 0x%X\n", marker) ;
163
164	psf->sf.samplerate = (int) samplerate ;
165
166	psf_log_printf (psf,	"  Sample Rate : %d\n"
167							"  Channels    : %d\n"
168							"  Encoding    : %X => %s\n",
169						psf->sf.samplerate, psf->sf.channels, encoding, get_encoding_str (encoding)) ;
170
171	switch (encoding)
172	{	case IRCAM_PCM_16 :
173				psf->bytewidth = 2 ;
174				psf->blockwidth = psf->sf.channels * psf->bytewidth ;
175
176				psf->sf.format = SF_FORMAT_IRCAM | SF_FORMAT_PCM_16 ;
177				break ;
178
179		case IRCAM_PCM_32 :
180				psf->bytewidth = 4 ;
181				psf->blockwidth = psf->sf.channels * psf->bytewidth ;
182
183				psf->sf.format = SF_FORMAT_IRCAM | SF_FORMAT_PCM_32 ;
184				break ;
185
186		case IRCAM_FLOAT :
187				psf->bytewidth = 4 ;
188				psf->blockwidth = psf->sf.channels * psf->bytewidth ;
189
190				psf->sf.format = SF_FORMAT_IRCAM | SF_FORMAT_FLOAT ;
191				break ;
192
193		case IRCAM_ALAW :
194				psf->bytewidth = 1 ;
195				psf->blockwidth = psf->sf.channels * psf->bytewidth ;
196
197				psf->sf.format = SF_FORMAT_IRCAM | SF_FORMAT_ALAW ;
198				break ;
199
200		case IRCAM_ULAW :
201				psf->bytewidth = 1 ;
202				psf->blockwidth = psf->sf.channels * psf->bytewidth ;
203
204				psf->sf.format = SF_FORMAT_IRCAM | SF_FORMAT_ULAW ;
205				break ;
206
207		default :
208				error = SFE_IRCAM_UNKNOWN_FORMAT ;
209				break ;
210		} ;
211
212	if (psf->endian == SF_ENDIAN_BIG)
213		psf->sf.format |= SF_ENDIAN_BIG ;
214	else
215		psf->sf.format |= SF_ENDIAN_LITTLE ;
216
217	if (error)
218		return error ;
219
220	psf->dataoffset = IRCAM_DATA_OFFSET ;
221	psf->datalength = psf->filelength - psf->dataoffset ;
222
223	if (psf->sf.frames == 0 && psf->blockwidth)
224		psf->sf.frames = psf->datalength / psf->blockwidth ;
225
226	psf_log_printf (psf, "  Samples     : %d\n", psf->sf.frames) ;
227
228	psf_binheader_readf (psf, "p", IRCAM_DATA_OFFSET) ;
229
230	return 0 ;
231} /* ircam_read_header */
232
233static int
234ircam_close	(SF_PRIVATE *psf)
235{
236	psf_log_printf (psf, "close\n") ;
237
238	return 0 ;
239} /* ircam_close */
240
241static int
242ircam_write_header (SF_PRIVATE *psf, int UNUSED (calc_length))
243{	int			encoding ;
244	float		samplerate ;
245	sf_count_t	current ;
246
247	if (psf->pipeoffset > 0)
248		return 0 ;
249
250	current = psf_ftell (psf) ;
251
252	/* This also sets psf->endian. */
253	encoding = get_encoding (SF_CODEC (psf->sf.format)) ;
254
255	if (encoding == 0)
256		return SFE_BAD_OPEN_FORMAT ;
257
258	/* Reset the current header length to zero. */
259	psf->header.ptr [0] = 0 ;
260	psf->header.indx = 0 ;
261
262	if (psf->is_pipe == SF_FALSE)
263		psf_fseek (psf, 0, SEEK_SET) ;
264
265	samplerate = psf->sf.samplerate ;
266
267	switch (psf->endian)
268	{	case SF_ENDIAN_BIG :
269			psf_binheader_writef (psf, "Emf", BHWm (IRCAM_02B_MARKER), BHWf (samplerate)) ;
270			psf_binheader_writef (psf, "E44", BHW4 (psf->sf.channels), BHW4 (encoding)) ;
271			break ;
272
273		case SF_ENDIAN_LITTLE :
274			psf_binheader_writef (psf, "emf", BHWm (IRCAM_03L_MARKER), BHWf (samplerate)) ;
275			psf_binheader_writef (psf, "e44", BHW4 (psf->sf.channels), BHW4 (encoding)) ;
276			break ;
277
278		default : return SFE_BAD_OPEN_FORMAT ;
279		} ;
280
281	psf_binheader_writef (psf, "z", BHWz ((size_t) (IRCAM_DATA_OFFSET - psf->header.indx))) ;
282
283	/* Header construction complete so write it out. */
284	psf_fwrite (psf->header.ptr, psf->header.indx, 1, psf) ;
285
286	if (psf->error)
287		return psf->error ;
288
289	if (current > 0)
290		psf_fseek (psf, current, SEEK_SET) ;
291
292	return psf->error ;
293} /* ircam_write_header */
294
295static int
296get_encoding (int subformat)
297{	switch (subformat)
298	{	case SF_FORMAT_PCM_16 :	return IRCAM_PCM_16 ;
299		case SF_FORMAT_PCM_32 :	return IRCAM_PCM_32 ;
300
301		case SF_FORMAT_FLOAT :	return IRCAM_FLOAT ;
302
303		case SF_FORMAT_ULAW :	return IRCAM_ULAW ;
304		case SF_FORMAT_ALAW :	return IRCAM_ALAW ;
305
306		default : break ;
307		} ;
308
309	return 0 ;
310} /* get_encoding */
311
312static const char*
313get_encoding_str (int encoding)
314{	switch (encoding)
315	{	case IRCAM_PCM_16	: return "16 bit PCM" ;
316		case IRCAM_FLOAT	: return "32 bit float" ;
317		case IRCAM_ALAW		: return "A law" ;
318		case IRCAM_ULAW		: return "u law" ;
319		case IRCAM_PCM_32	: return "32 bit PCM" ;
320		} ;
321	return "Unknown encoding" ;
322} /* get_encoding_str */
323
324