sox_format_t Struct Reference

Client API: Data passed to/from the format handler. More...

#include <sox.h>

Public Attributes
char *	filename
	File name.
sox_signalinfo_t	signal
	Signal specifications for reader (decoder) or writer (encoder): sample rate, number of channels, precision, length, headroom multiplier. More...
sox_encodinginfo_t	encoding
	Encoding specifications for reader (decoder) or writer (encoder): encoding (sample format), bits per sample, compression rate, endianness. More...
char *	filetype
	Type of file, as determined by header inspection or libmagic.
sox_oob_t	oob
	comments, instrument info, loop info (out-of-band data)
sox_bool	seekable
	Can seek on this file.
char	mode
	Read or write mode ('r' or 'w')
sox_uint64_t	olength
	Samples * chans written to file.
sox_uint64_t	clips
	Incremented if clipping occurs.
int	sox_errno
	Failure error code.
char	sox_errstr [256]
	Failure error text.
void *	fp
	File stream pointer.
lsx_io_type	io_type
	Stores whether this is a file, pipe or URL.
sox_uint64_t	tell_off
	Current offset within file.
sox_uint64_t	data_start
	Offset at which headers end and sound data begins (set by lsx_check_read_params)
sox_format_handler_t	handler
	Format handler for this file.
void *	priv
	Format handler's private data area.

Detailed Description

Client API: Data passed to/from the format handler.

Member Data Documentation

encoding

sox_encodinginfo_t encoding

Encoding specifications for reader (decoder) or writer (encoder): encoding (sample format), bits per sample, compression rate, endianness.

Should be filled in by startread. Values specified should be used by startwrite when it is configuring the encoding parameters.

signal

sox_signalinfo_t signal

Signal specifications for reader (decoder) or writer (encoder): sample rate, number of channels, precision, length, headroom multiplier.

Any info specified by the user is here on entry to startread or startwrite. Info will be SOX_UNSPEC if the user provided no info. At exit from startread, should be completely filled in, using either data from the file's headers (if available) or whatever the format is guessing/assuming (if header data is not available). At exit from startwrite, should be completely filled in, using either the data that was specified, or values chosen by the format based on the format's defaults or capabilities.

---

The documentation for this struct was generated from the following file:

• src/sox.h