xref: /onnv-gate/usr/src/cmd/audio/include/AudioPipe.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_AUDIOPIPE_H
28*0Sstevel@tonic-gate #define	_MULTIMEDIA_AUDIOPIPE_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 <AudioUnixfile.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 'base' class for pipes (such as stdin) containing audio data
39*0Sstevel@tonic-gate class AudioPipe : public AudioUnixfile {
40*0Sstevel@tonic-gate private:
41*0Sstevel@tonic-gate 	AudioPipe();					// Constructor w/no args
42*0Sstevel@tonic-gate 	AudioPipe operator=(AudioPipe);			// Assignment is illegal
43*0Sstevel@tonic-gate 
44*0Sstevel@tonic-gate public:
45*0Sstevel@tonic-gate 	// Constructor with path
46*0Sstevel@tonic-gate 	AudioPipe(
47*0Sstevel@tonic-gate 	    const int		desc,		// file descriptor
48*0Sstevel@tonic-gate 	    const FileAccess	acc,		// access mode
49*0Sstevel@tonic-gate 	    const char		*name = "(pipe)");	// name
50*0Sstevel@tonic-gate 
51*0Sstevel@tonic-gate 	// class AudioUnixfile methods specialized here
52*0Sstevel@tonic-gate 	virtual AudioError Create();			// Create file
53*0Sstevel@tonic-gate 	virtual AudioError Open();			// Open file
54*0Sstevel@tonic-gate 
55*0Sstevel@tonic-gate 	// Read from position
56*0Sstevel@tonic-gate 	virtual AudioError ReadData(
57*0Sstevel@tonic-gate 	    void* buf,				// buffer to fill
58*0Sstevel@tonic-gate 	    size_t& len,			// buffer length (updated)
59*0Sstevel@tonic-gate 	    Double& pos);			// start position (updated)
60*0Sstevel@tonic-gate 
61*0Sstevel@tonic-gate 	// Write at position
62*0Sstevel@tonic-gate 	virtual AudioError WriteData(
63*0Sstevel@tonic-gate 	    void* buf,				// buffer to copy
64*0Sstevel@tonic-gate 	    size_t& len,			// buffer length (updated)
65*0Sstevel@tonic-gate 	    Double& pos);			// start position (updated)
66*0Sstevel@tonic-gate 
67*0Sstevel@tonic-gate 	// class Audio methods specialized here
isPipe()68*0Sstevel@tonic-gate 	virtual Boolean isPipe() const { return (TRUE); }
69*0Sstevel@tonic-gate };
70*0Sstevel@tonic-gate 
71*0Sstevel@tonic-gate #ifdef __cplusplus
72*0Sstevel@tonic-gate }
73*0Sstevel@tonic-gate #endif
74*0Sstevel@tonic-gate 
75*0Sstevel@tonic-gate #endif /* !_MULTIMEDIA_AUDIOPIPE_H */
76