xref: /titanic_50/usr/src/cmd/audio/include/AudioTypeConvert.h (revision 7c478bd95313f5f23a4c958a745db2134aa03244)
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_AUDIOTYPECONVERT_H
28 #define	_MULTIMEDIA_AUDIOTYPECONVERT_H
29 
30 #pragma ident	"%Z%%M%	%I%	%E% SMI"
31 
32 #include <AudioBuffer.h>
33 
34 #ifdef __cplusplus
35 extern "C" {
36 #endif
37 
38 // This is the abstract base class for an audio type conversion module
39 
40 class AudioTypeConvert {
41 protected:
42 	AudioHdr	hdr;		// contains type information
43 
44 public:
AudioTypeConvert()45 	AudioTypeConvert() {};				// Constructor
~AudioTypeConvert()46 	virtual ~AudioTypeConvert() {};			// Destructor
DataType()47 	virtual AudioHdr DataType() const		// Return type
48 	    { return (hdr); }
49 
50 	// class methods specialized by subclasses
51 
52 	// TRUE if conversion ok
53 	virtual Boolean CanConvert(
54 	    AudioHdr h) const = 0;		// type to check against
55 
56 	// Convert buffer to the specified type
57 	// Either the input or output type must be handled by this class
58 
59 	// Convert to new type
60 	virtual AudioError Convert(
61 	    AudioBuffer*& inbuf,		// data buffer to process
62 	    AudioHdr outhdr) = 0;		// target header
63 
64 	virtual AudioError Flush(AudioBuffer*& buf) = 0; // flush any remaining
65 							// data that may exist
66 };
67 
68 #ifdef __cplusplus
69 }
70 #endif
71 
72 #endif /* !_MULTIMEDIA_AUDIOTYPECONVERT_H */
73