xref: /onnv-gate/usr/src/cmd/audio/include/AudioList.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_AUDIOLIST_H
28*0Sstevel@tonic-gate #define	_MULTIMEDIA_AUDIOLIST_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 
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 a list of extents of audio objects
39*0Sstevel@tonic-gate class AudioList : public Audio {
40*0Sstevel@tonic-gate 
41*0Sstevel@tonic-gate 	// Define a linked list nested class
42*0Sstevel@tonic-gate 	class AudioListEntry {
43*0Sstevel@tonic-gate 	private:
44*0Sstevel@tonic-gate 		void operator=(AudioListEntry);	// Assignment is illegal
45*0Sstevel@tonic-gate 	public:
46*0Sstevel@tonic-gate 		Audio*		aptr;		// pointer to audio object
47*0Sstevel@tonic-gate 		AudioListEntry*	next;		// pointer to next in list
48*0Sstevel@tonic-gate 		AudioListEntry*	prev;		// pointer to previous
49*0Sstevel@tonic-gate 
50*0Sstevel@tonic-gate 		// Constructor w/obj
51*0Sstevel@tonic-gate 		AudioListEntry(
52*0Sstevel@tonic-gate 		    Audio* obj);		// referenced audio object
53*0Sstevel@tonic-gate 		~AudioListEntry();		// Destructor
54*0Sstevel@tonic-gate 
55*0Sstevel@tonic-gate 		void newptr(Audio* newa);	// Reset extent
56*0Sstevel@tonic-gate 
57*0Sstevel@tonic-gate 		// Link in new extent
58*0Sstevel@tonic-gate 		void link(
59*0Sstevel@tonic-gate 		    AudioListEntry* after);	// link after this one
60*0Sstevel@tonic-gate 
61*0Sstevel@tonic-gate 		// Split an extent
62*0Sstevel@tonic-gate 		void split(
63*0Sstevel@tonic-gate 		    Double pos);		// split at offset
64*0Sstevel@tonic-gate 	};
65*0Sstevel@tonic-gate 
66*0Sstevel@tonic-gate private:
67*0Sstevel@tonic-gate 	AudioListEntry		head;		// list head
68*0Sstevel@tonic-gate 
69*0Sstevel@tonic-gate 	AudioListEntry* first() const;		// Return first extent
70*0Sstevel@tonic-gate 
71*0Sstevel@tonic-gate 	// Locate extent/offset
72*0Sstevel@tonic-gate 	virtual Boolean getposition(
73*0Sstevel@tonic-gate 	    Double& pos,			// target position (updated)
74*0Sstevel@tonic-gate 	    AudioListEntry*& ep) const;		// returned entry pointer
75*0Sstevel@tonic-gate 
76*0Sstevel@tonic-gate 	AudioList operator=(AudioList);		// Assignment is illegal
77*0Sstevel@tonic-gate 
78*0Sstevel@tonic-gate public:
79*0Sstevel@tonic-gate 	AudioList(const char *name = "[list]");	// Constructor
80*0Sstevel@tonic-gate 	virtual ~AudioList();			// Destructor
81*0Sstevel@tonic-gate 
82*0Sstevel@tonic-gate 	// class Audio methods specialized here
83*0Sstevel@tonic-gate 	virtual Double GetLength() const;	// Get length, in secs
84*0Sstevel@tonic-gate 	virtual char *GetName() const;		// Get name string
85*0Sstevel@tonic-gate 	virtual AudioHdr GetHeader();		// Get header
86*0Sstevel@tonic-gate 	virtual AudioHdr GetHeader(Double pos);	// Get header at pos
87*0Sstevel@tonic-gate 
88*0Sstevel@tonic-gate 	// Read from position
89*0Sstevel@tonic-gate 	virtual AudioError ReadData(
90*0Sstevel@tonic-gate 	    void* buf,				// buffer to fill
91*0Sstevel@tonic-gate 	    size_t& len,			// buffer length (updated)
92*0Sstevel@tonic-gate 	    Double& pos);			// start position (updated)
93*0Sstevel@tonic-gate 
94*0Sstevel@tonic-gate 	// Write is prohibited
95*0Sstevel@tonic-gate 	virtual AudioError WriteData(
96*0Sstevel@tonic-gate 	    void* buf,				// buffer to copy
97*0Sstevel@tonic-gate 	    size_t& len,			// buffer length (updated)
98*0Sstevel@tonic-gate 	    Double& pos);			// start position (updated)
99*0Sstevel@tonic-gate 
isList()100*0Sstevel@tonic-gate 	virtual Boolean isList() const { return (TRUE); }
101*0Sstevel@tonic-gate 
102*0Sstevel@tonic-gate 	// list manipulation methods
103*0Sstevel@tonic-gate 	// Insert an entry
104*0Sstevel@tonic-gate 	virtual AudioError Insert(
105*0Sstevel@tonic-gate 	    Audio* obj);			// object to insert
106*0Sstevel@tonic-gate 
107*0Sstevel@tonic-gate 	// Insert an entry
108*0Sstevel@tonic-gate 	virtual AudioError Insert(
109*0Sstevel@tonic-gate 	    Audio* obj,				// object to insert
110*0Sstevel@tonic-gate 	    Double pos);			// insertion offset, in seconds
111*0Sstevel@tonic-gate 
112*0Sstevel@tonic-gate 	// Append an entry
113*0Sstevel@tonic-gate 	virtual AudioError Append(
114*0Sstevel@tonic-gate 	    Audio* obj);			// object to append
115*0Sstevel@tonic-gate 
116*0Sstevel@tonic-gate 	// copy to another audio obj.
117*0Sstevel@tonic-gate 	virtual AudioError AsyncCopy(
118*0Sstevel@tonic-gate 	    Audio* ap,				// dest audio object
119*0Sstevel@tonic-gate 	    Double& frompos,
120*0Sstevel@tonic-gate 	    Double& topos,
121*0Sstevel@tonic-gate 	    Double& limit);
122*0Sstevel@tonic-gate };
123*0Sstevel@tonic-gate 
124*0Sstevel@tonic-gate #ifdef __cplusplus
125*0Sstevel@tonic-gate }
126*0Sstevel@tonic-gate #endif
127*0Sstevel@tonic-gate 
128*0Sstevel@tonic-gate #endif /* !_MULTIMEDIA_AUDIOLIST_H */
129