xref: /illumos-gate/usr/src/cmd/audio/include/AudioPipe.h (revision 08855964b9970604433f7b19dcd71cf5af5e5f14)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License, Version 1.0 only
6  * (the "License").  You may not use this file except in compliance
7  * with the License.
8  *
9  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10  * or http://www.opensolaris.org/os/licensing.
11  * See the License for the specific language governing permissions
12  * and limitations under the License.
13  *
14  * When distributing Covered Code, include this CDDL HEADER in each
15  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16  * If applicable, add the following below this CDDL HEADER, with the
17  * fields enclosed by brackets "[]" replaced with your own identifying
18  * information: Portions Copyright [yyyy] [name of copyright owner]
19  *
20  * CDDL HEADER END
21  */
22 /*
23  * Copyright (c) 1990-2001 by Sun Microsystems, Inc.
24  * All rights reserved.
25  */
26 
27 #ifndef _MULTIMEDIA_AUDIOPIPE_H
28 #define	_MULTIMEDIA_AUDIOPIPE_H
29 
30 #include <AudioUnixfile.h>
31 
32 #ifdef __cplusplus
33 extern "C" {
34 #endif
35 
36 // This is the 'base' class for pipes (such as stdin) containing audio data
37 class AudioPipe : public AudioUnixfile {
38 private:
39 	AudioPipe();					// Constructor w/no args
40 	AudioPipe operator=(AudioPipe);			// Assignment is illegal
41 
42 public:
43 	// Constructor with path
44 	AudioPipe(
45 	    const int		desc,		// file descriptor
46 	    const FileAccess	acc,		// access mode
47 	    const char		*name = "(pipe)");	// name
48 
49 	// class AudioUnixfile methods specialized here
50 	virtual AudioError Create();			// Create file
51 	virtual AudioError Open();			// Open file
52 
53 	// Read from position
54 	virtual AudioError ReadData(
55 	    void* buf,				// buffer to fill
56 	    size_t& len,			// buffer length (updated)
57 	    Double& pos);			// start position (updated)
58 
59 	// Write at position
60 	virtual AudioError WriteData(
61 	    void* buf,				// buffer to copy
62 	    size_t& len,			// buffer length (updated)
63 	    Double& pos);			// start position (updated)
64 
65 	// class Audio methods specialized here
66 	virtual Boolean isPipe() const { return (TRUE); }
67 };
68 
69 #ifdef __cplusplus
70 }
71 #endif
72 
73 #endif /* !_MULTIMEDIA_AUDIOPIPE_H */
74