xref: /onnv-gate/usr/src/cmd/audio/include/AudioStream.h (revision 0:68f95e015346)
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) 1990-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_AUDIOSTREAM_H
28*0Sstevel@tonic-gate #define	_MULTIMEDIA_AUDIOSTREAM_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 <Audio.h>
33*0Sstevel@tonic-gate #include <AudioHdr.h>
34*0Sstevel@tonic-gate #include <stdlib.h>
35*0Sstevel@tonic-gate #include <AudioDebug.h>
36*0Sstevel@tonic-gate 
37*0Sstevel@tonic-gate #ifdef __cplusplus
38*0Sstevel@tonic-gate extern "C" {
39*0Sstevel@tonic-gate #endif
40*0Sstevel@tonic-gate 
41*0Sstevel@tonic-gate // This is the abstract base class for all audio data sources/sinks.
42*0Sstevel@tonic-gate // It is invalid to create an object of type AudioStream.
43*0Sstevel@tonic-gate 
44*0Sstevel@tonic-gate class AudioStream : public Audio {
45*0Sstevel@tonic-gate private:
46*0Sstevel@tonic-gate 	AudioHdr	hdr;			// data encoding info
47*0Sstevel@tonic-gate 	Double		length;			// length of data, in secs
48*0Sstevel@tonic-gate 
49*0Sstevel@tonic-gate protected:
50*0Sstevel@tonic-gate 
51*0Sstevel@tonic-gate 	Boolean hdrset() const;			// TRUE if header valid
52*0Sstevel@tonic-gate 
53*0Sstevel@tonic-gate 	// Set header (always)
54*0Sstevel@tonic-gate 	AudioError updateheader(
55*0Sstevel@tonic-gate 	    const AudioHdr& h);			// header to copy
56*0Sstevel@tonic-gate 
57*0Sstevel@tonic-gate 	// Set data length
58*0Sstevel@tonic-gate 	void setlength(
59*0Sstevel@tonic-gate 	    Double len);			// new length, in secs
60*0Sstevel@tonic-gate 
61*0Sstevel@tonic-gate 	virtual Boolean opened() const = 0;	// TRUE if stream 'open'
62*0Sstevel@tonic-gate 
63*0Sstevel@tonic-gate public:
64*0Sstevel@tonic-gate 	AudioStream(const char *path = "");	// Constructor
65*0Sstevel@tonic-gate 
66*0Sstevel@tonic-gate 	// Set header
67*0Sstevel@tonic-gate 	virtual AudioError SetHeader(
68*0Sstevel@tonic-gate 	    const AudioHdr& h);			// header to copy
69*0Sstevel@tonic-gate 
70*0Sstevel@tonic-gate 	// Set data length
71*0Sstevel@tonic-gate 	virtual void SetLength(
72*0Sstevel@tonic-gate 	    Double len);			// new length, in secs
73*0Sstevel@tonic-gate 
74*0Sstevel@tonic-gate 	// XXX - is this needed?  do we need time->sample frames?
75*0Sstevel@tonic-gate 	virtual size_t GetByteCount() const;		// Get length, in bytes
76*0Sstevel@tonic-gate 
77*0Sstevel@tonic-gate 	// class Audio methods specialized here
78*0Sstevel@tonic-gate 	virtual AudioHdr GetHeader();			// Get header
79*0Sstevel@tonic-gate 
80*0Sstevel@tonic-gate 	virtual Double GetLength() const;		// Get length, in secs
81*0Sstevel@tonic-gate 
82*0Sstevel@tonic-gate 	// Make sure endian of the data matches the current processor.
83*0Sstevel@tonic-gate 	AudioError coerceEndian(unsigned char *buf, size_t len,
84*0Sstevel@tonic-gate 	    AudioEndian en);
85*0Sstevel@tonic-gate 
86*0Sstevel@tonic-gate 	virtual Boolean isEndianSensitive() const;
localByteOrder()87*0Sstevel@tonic-gate 	AudioEndian localByteOrder() const
88*0Sstevel@tonic-gate 	{
89*0Sstevel@tonic-gate 		return (hdr.localByteOrder());
90*0Sstevel@tonic-gate 	}
91*0Sstevel@tonic-gate };
92*0Sstevel@tonic-gate 
93*0Sstevel@tonic-gate #include <AudioStream_inline.h>
94*0Sstevel@tonic-gate 
95*0Sstevel@tonic-gate #ifdef __cplusplus
96*0Sstevel@tonic-gate }
97*0Sstevel@tonic-gate #endif
98*0Sstevel@tonic-gate 
99*0Sstevel@tonic-gate #endif /* !_MULTIMEDIA_AUDIOSTREAM_H */
100