1*0Sstevel@tonic-gate /*
2*0Sstevel@tonic-gate  * CDDL HEADER START
3*0Sstevel@tonic-gate  *
4*0Sstevel@tonic-gate  * The contents of this file are subject to the terms of the
5*0Sstevel@tonic-gate  * Common Development and Distribution License, Version 1.0 only
6*0Sstevel@tonic-gate  * (the "License").  You may not use this file except in compliance
7*0Sstevel@tonic-gate  * with the License.
8*0Sstevel@tonic-gate  *
9*0Sstevel@tonic-gate  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10*0Sstevel@tonic-gate  * or http://www.opensolaris.org/os/licensing.
11*0Sstevel@tonic-gate  * See the License for the specific language governing permissions
12*0Sstevel@tonic-gate  * and limitations under the License.
13*0Sstevel@tonic-gate  *
14*0Sstevel@tonic-gate  * When distributing Covered Code, include this CDDL HEADER in each
15*0Sstevel@tonic-gate  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16*0Sstevel@tonic-gate  * If applicable, add the following below this CDDL HEADER, with the
17*0Sstevel@tonic-gate  * fields enclosed by brackets "[]" replaced with your own identifying
18*0Sstevel@tonic-gate  * information: Portions Copyright [yyyy] [name of copyright owner]
19*0Sstevel@tonic-gate  *
20*0Sstevel@tonic-gate  * CDDL HEADER END
21*0Sstevel@tonic-gate  */
22*0Sstevel@tonic-gate /*
23*0Sstevel@tonic-gate  * Copyright (c) 1992-2001 by Sun Microsystems, Inc.
24*0Sstevel@tonic-gate  * All rights reserved.
25*0Sstevel@tonic-gate  */
26*0Sstevel@tonic-gate 
27*0Sstevel@tonic-gate #ifndef _MULTIMEDIA_AUDIOUNIXFILE_H
28*0Sstevel@tonic-gate #define	_MULTIMEDIA_AUDIOUNIXFILE_H
29*0Sstevel@tonic-gate 
30*0Sstevel@tonic-gate #pragma ident	"%Z%%M%	%I%	%E% SMI"
31*0Sstevel@tonic-gate 
32*0Sstevel@tonic-gate #include <AudioStream.h>
33*0Sstevel@tonic-gate 
34*0Sstevel@tonic-gate #ifdef __cplusplus
35*0Sstevel@tonic-gate extern "C" {
36*0Sstevel@tonic-gate #endif
37*0Sstevel@tonic-gate 
38*0Sstevel@tonic-gate // This is the abstract base class for all file descriptor based audio i/o.
39*0Sstevel@tonic-gate // It is invalid to create an object of type AudioUnixfile.
40*0Sstevel@tonic-gate 
41*0Sstevel@tonic-gate class AudioUnixfile : public AudioStream {
42*0Sstevel@tonic-gate private:
43*0Sstevel@tonic-gate 	FileAccess	mode;			// access mode
44*0Sstevel@tonic-gate 	Boolean		block;			// FALSE if fd set non-blocking
45*0Sstevel@tonic-gate 	Boolean		filehdrset;		// TRUE if file hdr read/written
46*0Sstevel@tonic-gate 	int		fd;			// file descriptor
47*0Sstevel@tonic-gate 	char		*infostring;		// Info string from header
48*0Sstevel@tonic-gate 	unsigned int	infolength;		// Info string length
49*0Sstevel@tonic-gate 
50*0Sstevel@tonic-gate 	AudioUnixfile() {}			// Constructor w/no args
51*0Sstevel@tonic-gate 
52*0Sstevel@tonic-gate protected:
53*0Sstevel@tonic-gate 	// Constructor
54*0Sstevel@tonic-gate 	AudioUnixfile(
55*0Sstevel@tonic-gate 	    const char *path,		// pathname
56*0Sstevel@tonic-gate 	    const FileAccess acc);	// access mode
57*0Sstevel@tonic-gate 
58*0Sstevel@tonic-gate 	int getfd() const;			// Return descriptor
59*0Sstevel@tonic-gate 	void setfd(int d);			// Set descriptor
60*0Sstevel@tonic-gate 
61*0Sstevel@tonic-gate 	virtual AudioError decode_filehdr();	// Get header from file
62*0Sstevel@tonic-gate 	virtual AudioError encode_filehdr();	// Write file header
63*0Sstevel@tonic-gate 
64*0Sstevel@tonic-gate 	// Seek in input stream
65*0Sstevel@tonic-gate 	virtual AudioError seekread(
66*0Sstevel@tonic-gate 	    Double pos,				// position to seek to
67*0Sstevel@tonic-gate 	    off_t& offset);			// returned byte offset
68*0Sstevel@tonic-gate 
69*0Sstevel@tonic-gate 	// Seek in output stream
70*0Sstevel@tonic-gate 	virtual AudioError seekwrite(
71*0Sstevel@tonic-gate 	    Double pos,				// position to seek to
72*0Sstevel@tonic-gate 	    off_t& offset);			// returned byte offset
73*0Sstevel@tonic-gate 
74*0Sstevel@tonic-gate 	virtual Boolean isfdset() const;		// TRUE if fd is valid
75*0Sstevel@tonic-gate 	virtual Boolean isfilehdrset() const;		// TRUE if file hdr r/w
76*0Sstevel@tonic-gate 
77*0Sstevel@tonic-gate 	// class AudioStream methods specialized here
78*0Sstevel@tonic-gate 	virtual Boolean opened() const;			// TRUE, if open
79*0Sstevel@tonic-gate 
80*0Sstevel@tonic-gate public:
81*0Sstevel@tonic-gate 	virtual ~AudioUnixfile();			// Destructor
82*0Sstevel@tonic-gate 
83*0Sstevel@tonic-gate 	virtual FileAccess GetAccess() const;		// Get mode
84*0Sstevel@tonic-gate 	virtual Boolean GetBlocking() const;		// TRUE, if blocking i/o
85*0Sstevel@tonic-gate 	virtual void SetBlocking(Boolean b);		// Set block/non-block
86*0Sstevel@tonic-gate 
87*0Sstevel@tonic-gate 	virtual AudioError Create() = 0;		// Create file
88*0Sstevel@tonic-gate 	virtual AudioError Open() = 0;			// Open file
89*0Sstevel@tonic-gate 
90*0Sstevel@tonic-gate 	// ... with search path
91*0Sstevel@tonic-gate 	virtual AudioError OpenPath(
92*0Sstevel@tonic-gate 	    const char *path = 0);
93*0Sstevel@tonic-gate 	virtual AudioError Close();			// Close file
94*0Sstevel@tonic-gate 
95*0Sstevel@tonic-gate 	// Methods specific to the audio file format
96*0Sstevel@tonic-gate 	// Get info string
97*0Sstevel@tonic-gate 	virtual char *const GetInfostring(
98*0Sstevel@tonic-gate 	    int& len) const;			// return length
99*0Sstevel@tonic-gate 
100*0Sstevel@tonic-gate 	// Set info string
101*0Sstevel@tonic-gate 	virtual void SetInfostring(
102*0Sstevel@tonic-gate 	    const char	*str,			// ptr to info data
103*0Sstevel@tonic-gate 	    int		len = -1);		// optional length
104*0Sstevel@tonic-gate 
105*0Sstevel@tonic-gate 	// class Audio methods specialized here
106*0Sstevel@tonic-gate 	// Read from position
107*0Sstevel@tonic-gate 	virtual AudioError ReadData(
108*0Sstevel@tonic-gate 	    void* buf,				// buffer to fill
109*0Sstevel@tonic-gate 	    size_t& len,			// buffer length (updated)
110*0Sstevel@tonic-gate 	    Double& pos);			// start position (updated)
111*0Sstevel@tonic-gate 
112*0Sstevel@tonic-gate 	// Write at position
113*0Sstevel@tonic-gate 	virtual AudioError WriteData(
114*0Sstevel@tonic-gate 	    void* buf,				// buffer to copy
115*0Sstevel@tonic-gate 	    size_t& len,			// buffer length (updated)
116*0Sstevel@tonic-gate 	    Double& pos);			// start position (updated)
117*0Sstevel@tonic-gate };
118*0Sstevel@tonic-gate 
119*0Sstevel@tonic-gate #include <AudioUnixfile_inline.h>
120*0Sstevel@tonic-gate 
121*0Sstevel@tonic-gate #ifdef __cplusplus
122*0Sstevel@tonic-gate }
123*0Sstevel@tonic-gate #endif
124*0Sstevel@tonic-gate 
125*0Sstevel@tonic-gate #endif /* !_MULTIMEDIA_AUDIOUNIXFILE_H */
126