xref: /illumos-gate/usr/src/cmd/audio/include/AudioUnixfile.h (revision d8048045f75b60d97deaf376b39d437b027becd1)
17c478bd9Sstevel@tonic-gate /*
27c478bd9Sstevel@tonic-gate  * CDDL HEADER START
37c478bd9Sstevel@tonic-gate  *
47c478bd9Sstevel@tonic-gate  * The contents of this file are subject to the terms of the
57c478bd9Sstevel@tonic-gate  * Common Development and Distribution License, Version 1.0 only
67c478bd9Sstevel@tonic-gate  * (the "License").  You may not use this file except in compliance
77c478bd9Sstevel@tonic-gate  * with the License.
87c478bd9Sstevel@tonic-gate  *
97c478bd9Sstevel@tonic-gate  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
107c478bd9Sstevel@tonic-gate  * or http://www.opensolaris.org/os/licensing.
117c478bd9Sstevel@tonic-gate  * See the License for the specific language governing permissions
127c478bd9Sstevel@tonic-gate  * and limitations under the License.
137c478bd9Sstevel@tonic-gate  *
147c478bd9Sstevel@tonic-gate  * When distributing Covered Code, include this CDDL HEADER in each
157c478bd9Sstevel@tonic-gate  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
167c478bd9Sstevel@tonic-gate  * If applicable, add the following below this CDDL HEADER, with the
177c478bd9Sstevel@tonic-gate  * fields enclosed by brackets "[]" replaced with your own identifying
187c478bd9Sstevel@tonic-gate  * information: Portions Copyright [yyyy] [name of copyright owner]
197c478bd9Sstevel@tonic-gate  *
207c478bd9Sstevel@tonic-gate  * CDDL HEADER END
217c478bd9Sstevel@tonic-gate  */
227c478bd9Sstevel@tonic-gate /*
237c478bd9Sstevel@tonic-gate  * Copyright (c) 1992-2001 by Sun Microsystems, Inc.
247c478bd9Sstevel@tonic-gate  * All rights reserved.
257c478bd9Sstevel@tonic-gate  */
267c478bd9Sstevel@tonic-gate 
277c478bd9Sstevel@tonic-gate #ifndef _MULTIMEDIA_AUDIOUNIXFILE_H
287c478bd9Sstevel@tonic-gate #define	_MULTIMEDIA_AUDIOUNIXFILE_H
297c478bd9Sstevel@tonic-gate 
307c478bd9Sstevel@tonic-gate #include <AudioStream.h>
317c478bd9Sstevel@tonic-gate 
327c478bd9Sstevel@tonic-gate #ifdef __cplusplus
337c478bd9Sstevel@tonic-gate extern "C" {
347c478bd9Sstevel@tonic-gate #endif
357c478bd9Sstevel@tonic-gate 
367c478bd9Sstevel@tonic-gate // This is the abstract base class for all file descriptor based audio i/o.
377c478bd9Sstevel@tonic-gate // It is invalid to create an object of type AudioUnixfile.
387c478bd9Sstevel@tonic-gate 
397c478bd9Sstevel@tonic-gate class AudioUnixfile : public AudioStream {
407c478bd9Sstevel@tonic-gate private:
417c478bd9Sstevel@tonic-gate 	FileAccess	mode;			// access mode
427c478bd9Sstevel@tonic-gate 	Boolean		block;			// FALSE if fd set non-blocking
437c478bd9Sstevel@tonic-gate 	Boolean		filehdrset;		// TRUE if file hdr read/written
447c478bd9Sstevel@tonic-gate 	int		fd;			// file descriptor
457c478bd9Sstevel@tonic-gate 	char		*infostring;		// Info string from header
467c478bd9Sstevel@tonic-gate 	unsigned int	infolength;		// Info string length
477c478bd9Sstevel@tonic-gate 
AudioUnixfile()487c478bd9Sstevel@tonic-gate 	AudioUnixfile() {}			// Constructor w/no args
497c478bd9Sstevel@tonic-gate 
507c478bd9Sstevel@tonic-gate protected:
517c478bd9Sstevel@tonic-gate 	// Constructor
527c478bd9Sstevel@tonic-gate 	AudioUnixfile(
537c478bd9Sstevel@tonic-gate 	    const char *path,		// pathname
547c478bd9Sstevel@tonic-gate 	    const FileAccess acc);	// access mode
557c478bd9Sstevel@tonic-gate 
567c478bd9Sstevel@tonic-gate 	int getfd() const;			// Return descriptor
577c478bd9Sstevel@tonic-gate 	void setfd(int d);			// Set descriptor
587c478bd9Sstevel@tonic-gate 
597c478bd9Sstevel@tonic-gate 	virtual AudioError decode_filehdr();	// Get header from file
607c478bd9Sstevel@tonic-gate 	virtual AudioError encode_filehdr();	// Write file header
617c478bd9Sstevel@tonic-gate 
627c478bd9Sstevel@tonic-gate 	// Seek in input stream
637c478bd9Sstevel@tonic-gate 	virtual AudioError seekread(
647c478bd9Sstevel@tonic-gate 	    Double pos,				// position to seek to
657c478bd9Sstevel@tonic-gate 	    off_t& offset);			// returned byte offset
667c478bd9Sstevel@tonic-gate 
677c478bd9Sstevel@tonic-gate 	// Seek in output stream
687c478bd9Sstevel@tonic-gate 	virtual AudioError seekwrite(
697c478bd9Sstevel@tonic-gate 	    Double pos,				// position to seek to
707c478bd9Sstevel@tonic-gate 	    off_t& offset);			// returned byte offset
717c478bd9Sstevel@tonic-gate 
727c478bd9Sstevel@tonic-gate 	virtual Boolean isfdset() const;		// TRUE if fd is valid
737c478bd9Sstevel@tonic-gate 	virtual Boolean isfilehdrset() const;		// TRUE if file hdr r/w
747c478bd9Sstevel@tonic-gate 
757c478bd9Sstevel@tonic-gate 	// class AudioStream methods specialized here
767c478bd9Sstevel@tonic-gate 	virtual Boolean opened() const;			// TRUE, if open
777c478bd9Sstevel@tonic-gate 
787c478bd9Sstevel@tonic-gate public:
797c478bd9Sstevel@tonic-gate 	virtual ~AudioUnixfile();			// Destructor
807c478bd9Sstevel@tonic-gate 
817c478bd9Sstevel@tonic-gate 	virtual FileAccess GetAccess() const;		// Get mode
827c478bd9Sstevel@tonic-gate 	virtual Boolean GetBlocking() const;		// TRUE, if blocking i/o
837c478bd9Sstevel@tonic-gate 	virtual void SetBlocking(Boolean b);		// Set block/non-block
847c478bd9Sstevel@tonic-gate 
857c478bd9Sstevel@tonic-gate 	virtual AudioError Create() = 0;		// Create file
867c478bd9Sstevel@tonic-gate 	virtual AudioError Open() = 0;			// Open file
877c478bd9Sstevel@tonic-gate 
887c478bd9Sstevel@tonic-gate 	// ... with search path
897c478bd9Sstevel@tonic-gate 	virtual AudioError OpenPath(
907c478bd9Sstevel@tonic-gate 	    const char *path = 0);
917c478bd9Sstevel@tonic-gate 	virtual AudioError Close();			// Close file
927c478bd9Sstevel@tonic-gate 
937c478bd9Sstevel@tonic-gate 	// Methods specific to the audio file format
947c478bd9Sstevel@tonic-gate 	// Get info string
95*d8048045SRichard Lowe 	virtual char *GetInfostring(
967c478bd9Sstevel@tonic-gate 	    int& len) const;			// return length
977c478bd9Sstevel@tonic-gate 
987c478bd9Sstevel@tonic-gate 	// Set info string
997c478bd9Sstevel@tonic-gate 	virtual void SetInfostring(
1007c478bd9Sstevel@tonic-gate 	    const char	*str,			// ptr to info data
1017c478bd9Sstevel@tonic-gate 	    int		len = -1);		// optional length
1027c478bd9Sstevel@tonic-gate 
1037c478bd9Sstevel@tonic-gate 	// class Audio methods specialized here
1047c478bd9Sstevel@tonic-gate 	// Read from position
1057c478bd9Sstevel@tonic-gate 	virtual AudioError ReadData(
1067c478bd9Sstevel@tonic-gate 	    void* buf,				// buffer to fill
1077c478bd9Sstevel@tonic-gate 	    size_t& len,			// buffer length (updated)
1087c478bd9Sstevel@tonic-gate 	    Double& pos);			// start position (updated)
1097c478bd9Sstevel@tonic-gate 
1107c478bd9Sstevel@tonic-gate 	// Write at position
1117c478bd9Sstevel@tonic-gate 	virtual AudioError WriteData(
1127c478bd9Sstevel@tonic-gate 	    void* buf,				// buffer to copy
1137c478bd9Sstevel@tonic-gate 	    size_t& len,			// buffer length (updated)
1147c478bd9Sstevel@tonic-gate 	    Double& pos);			// start position (updated)
1157c478bd9Sstevel@tonic-gate };
1167c478bd9Sstevel@tonic-gate 
1177c478bd9Sstevel@tonic-gate #include <AudioUnixfile_inline.h>
1187c478bd9Sstevel@tonic-gate 
1197c478bd9Sstevel@tonic-gate #ifdef __cplusplus
1207c478bd9Sstevel@tonic-gate }
1217c478bd9Sstevel@tonic-gate #endif
1227c478bd9Sstevel@tonic-gate 
1237c478bd9Sstevel@tonic-gate #endif /* !_MULTIMEDIA_AUDIOUNIXFILE_H */
124