ref: 15e26a81a420c709767daebc0373ca0137f6fcd5
dir: /src/skel.c/
/*
* Sound Tools skeleton file format driver.
*
* Copyright 1999 Chris Bagwell And Sundry Contributors
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library. If not, write to the Free Software
* Foundation, Fifth Floor, 51 Franklin Street, Boston, MA 02111-1301,
* USA. */
#include "st_i.h"
/* Private data for SKEL file */
typedef struct skel
{
st_size_t samples_remaining;
} *skel_t;
/* Note that if any of your methods doesn't need to do anything, you
can instead use the relevant st_*_nothing* method */
/*
* Do anything required before you start reading samples.
* Read file header.
* Find out sampling rate,
* size and encoding of samples,
* mono/stereo/quad.
*/
static int skel_startread(ft_t ft)
{
skel_t sk = (skel_t)ft->priv;
/* If you need to seek around the input file. */
if (!ft->seekable) {
st_fail_errno(ft,ST_EVALUE,"SKEL input file must be a file, not a pipe");
return (ST_EOF);
}
/*
* If your format is headerless and has fixed values for
* the following items, you can hard code them here (see cdr.c).
* If your format contains a header with format information
* then you should set it here.
*/
ft->signal.rate = 44100L;
ft->signal.size = ST_SIZE_BYTE or WORD ...;
ft->signal.encoding = ST_ENCODING_UNSIGNED or SIGN2 ...;
ft->signal.channels = 1 or 2 or 4;
ft->comment = xmalloc(size_of_comment);
strcpy(ft->comment, "any comment in file header.");
/* If your format doesn't have a header then samples_in_file
* can be determined by the file size.
*/
samples_in_file = st_filelength(ft)/ft->signal.size;
/* If you can detect the length of your file, record it here. */
ft->length = samples_in_file;
sk->remaining_samples = samples_in_file;
return (ST_SUCCESS);
}
/*
* Read up to len samples from file.
* Convert to st_sample_t.
* Place in buf[].
* Return number of samples read.
*/
static st_size_t skel_read(ft_t ft, st_sample_t *buf, st_size_t len)
{
skel_t sk = (skel_t)ft->priv;
st_size_t done;
st_sample_t l;
/* Always return a full frame of audio data */
if (len % ft->signal.size)
len -= (len % ft->signal.size);
for (done = 0; done < len; done++) {
if no more samples
break
get a sample
switch (ft->signal.size) {
case ST_SIZE_BYTE:
switch (ft->signal.encoding) {
case ST_ENCODING_UNSIGNED;
*buf++ = ST_UNSIGNED_BYTE_TO_SAMPLE(sample);
break;
}
break;
}
}
return done;
}
/*
* Do anything required when you stop reading samples.
* Don't close input file!
*/
static int skel_stopread(ft_t ft)
{
return ST_SUCCESS;
}
static int skel_startwrite(ft_t ft)
{
skel_t sk = (skel_t)ft->priv;
/* If you have to seek around the output file. */
/* If header contains a length value then seeking will be
* required. Instead of failing, it's sometimes nice to
* just set the length to max value and not fail.
*/
if (!ft->seekable) {
st_fail_errno(ft, ST_EVALUE, "Output .skel file must be a file, not a pipe");
return ST_EOF;
}
if (ft->signal.rate != 44100L)
st_fail_errno(ft, ST_EVALUE, "Output .skel file must have a sample rate of 44100");
if (ft->signal.size == -1) {
st_fail_errno(ft, ST_EVALUE, "Did not specify a size for .skel output file");
return ST_EOF;
}
error check ft->signal.encoding;
error check ft->signal.channels;
/* Write file header, if any */
/* Write comment field, if any */
return ST_SUCCESS;
}
static st_size_t skel_write(ft_t ft, const st_sample_t *buf, st_size_t len)
{
skel_t sk = (skel_t)ft->priv;
st_size_t len = 0;
switch (ft->signal.size) {
case ST_SIZE_BYTE:
switch (ft->signal.encoding) {
case ST_ENCODING_UNSIGNED:
while (len--) {
len = st_writeb(ft, ST_SAMPLE_TO_UNSIGNED_BYTE(*buff++, ft->clippedCount));
if (len == ST_EOF)
break;
}
break;
}
break;
}
return len;
}
static int skel_stopwrite(ft_t ft)
{
/* All samples are already written out. */
/* If file header needs fixing up, for example it needs the */
/* the number of samples in a field, seek back and write them here. */
return ST_SUCCESS;
}
/* Format file suffixes */
static const char *skel_names[] = {
"skel",
NULL
};
static st_format_t st_skel_format = {
skel_names,
NULL,
ST_FILE_STEREO | ST_FILE_SEEK,
skel_startread,
skel_read,
skel_stopread,
skel_startwrite,
skel_write,
skel_stopwrite,
skel_seek
};
const st_format_t *st_skel_format_fn()
{
return &st_skel_format;
}