xref: /onnv-gate/usr/src/cmd/audio/include/AudioExtent.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_AUDIOEXTENT_H
28*0Sstevel@tonic-gate #define	_MULTIMEDIA_AUDIOEXTENT_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 <values.h>
33*0Sstevel@tonic-gate #include <Audio.h>
34*0Sstevel@tonic-gate 
35*0Sstevel@tonic-gate #ifdef __cplusplus
36*0Sstevel@tonic-gate extern "C" {
37*0Sstevel@tonic-gate #endif
38*0Sstevel@tonic-gate 
39*0Sstevel@tonic-gate // This class defines an extent of a referenced audio class
40*0Sstevel@tonic-gate class AudioExtent : public Audio {
41*0Sstevel@tonic-gate private:
42*0Sstevel@tonic-gate 	Audio*			ref;		// reference to audio object
43*0Sstevel@tonic-gate 	Double			start;		// start time
44*0Sstevel@tonic-gate 	Double			end;		// end time
45*0Sstevel@tonic-gate 
46*0Sstevel@tonic-gate 	AudioExtent operator=(AudioExtent);	// Assignment is illegal
47*0Sstevel@tonic-gate 
48*0Sstevel@tonic-gate public:
49*0Sstevel@tonic-gate 	// Constructor
50*0Sstevel@tonic-gate 	AudioExtent(
51*0Sstevel@tonic-gate 	    Audio* obj,				// audio object
52*0Sstevel@tonic-gate 	    double s = 0.,			// start time
53*0Sstevel@tonic-gate 	    double e = AUDIO_UNKNOWN_TIME);	// end time
54*0Sstevel@tonic-gate 	virtual ~AudioExtent();				// Destructor
55*0Sstevel@tonic-gate 
56*0Sstevel@tonic-gate 	Audio* GetRef() const;				// Get audio obj
57*0Sstevel@tonic-gate 	void SetRef(Audio* r);				// Set audio obj
58*0Sstevel@tonic-gate 	Double GetStart() const;			// Get start time
59*0Sstevel@tonic-gate 	void SetStart(Double s);			// Set start time
60*0Sstevel@tonic-gate 	Double GetEnd() const;				// Get end time
61*0Sstevel@tonic-gate 	void SetEnd(Double e);				// Set end time
62*0Sstevel@tonic-gate 
63*0Sstevel@tonic-gate 	// class Audio methods specialized here
64*0Sstevel@tonic-gate 	virtual Double GetLength() const;		// Get length, in secs
65*0Sstevel@tonic-gate 	virtual char *GetName() const;			// Get name string
66*0Sstevel@tonic-gate 	virtual AudioHdr GetHeader();			// Get header
67*0Sstevel@tonic-gate 	virtual AudioHdr GetHeader(Double pos);		// Get header at pos
68*0Sstevel@tonic-gate 
69*0Sstevel@tonic-gate 	// Read from position
70*0Sstevel@tonic-gate 	virtual AudioError ReadData(
71*0Sstevel@tonic-gate 	    void* buf,				// buffer to fill
72*0Sstevel@tonic-gate 	    size_t& len,			// buffer length (updated)
73*0Sstevel@tonic-gate 	    Double& pos);			// start position (updated)
74*0Sstevel@tonic-gate 
75*0Sstevel@tonic-gate 	// Write is prohibited
76*0Sstevel@tonic-gate 	virtual AudioError WriteData(
77*0Sstevel@tonic-gate 	    void* buf,				// buffer to copy
78*0Sstevel@tonic-gate 	    size_t& len,			// buffer length (updated)
79*0Sstevel@tonic-gate 	    Double& pos);			// start position (updated)
80*0Sstevel@tonic-gate 
isExtent()81*0Sstevel@tonic-gate 	virtual Boolean isExtent() const { return (TRUE); }
82*0Sstevel@tonic-gate };
83*0Sstevel@tonic-gate 
84*0Sstevel@tonic-gate #ifdef __cplusplus
85*0Sstevel@tonic-gate }
86*0Sstevel@tonic-gate #endif
87*0Sstevel@tonic-gate 
88*0Sstevel@tonic-gate #endif /* !_MULTIMEDIA_AUDIOEXTENT_H */
89