17c478bdstevel@tonic-gate/*
27c478bdstevel@tonic-gate * CDDL HEADER START
37c478bdstevel@tonic-gate *
47c478bdstevel@tonic-gate * The contents of this file are subject to the terms of the
57c478bdstevel@tonic-gate * Common Development and Distribution License, Version 1.0 only
67c478bdstevel@tonic-gate * (the "License").  You may not use this file except in compliance
77c478bdstevel@tonic-gate * with the License.
87c478bdstevel@tonic-gate *
97c478bdstevel@tonic-gate * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
107c478bdstevel@tonic-gate * or http://www.opensolaris.org/os/licensing.
117c478bdstevel@tonic-gate * See the License for the specific language governing permissions
127c478bdstevel@tonic-gate * and limitations under the License.
137c478bdstevel@tonic-gate *
147c478bdstevel@tonic-gate * When distributing Covered Code, include this CDDL HEADER in each
157c478bdstevel@tonic-gate * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
167c478bdstevel@tonic-gate * If applicable, add the following below this CDDL HEADER, with the
177c478bdstevel@tonic-gate * fields enclosed by brackets "[]" replaced with your own identifying
187c478bdstevel@tonic-gate * information: Portions Copyright [yyyy] [name of copyright owner]
197c478bdstevel@tonic-gate *
207c478bdstevel@tonic-gate * CDDL HEADER END
217c478bdstevel@tonic-gate */
227c478bdstevel@tonic-gate/*
237c478bdstevel@tonic-gate * Copyright (c) 1990-2001 by Sun Microsystems, Inc.
247c478bdstevel@tonic-gate * All rights reserved.
257c478bdstevel@tonic-gate */
267c478bdstevel@tonic-gate
277c478bdstevel@tonic-gate#ifndef _MULTIMEDIA_AUDIOSTREAM_H
287c478bdstevel@tonic-gate#define	_MULTIMEDIA_AUDIOSTREAM_H
297c478bdstevel@tonic-gate
307c478bdstevel@tonic-gate#pragma ident	"%Z%%M%	%I%	%E% SMI"
317c478bdstevel@tonic-gate
327c478bdstevel@tonic-gate#include <Audio.h>
337c478bdstevel@tonic-gate#include <AudioHdr.h>
347c478bdstevel@tonic-gate#include <stdlib.h>
357c478bdstevel@tonic-gate#include <AudioDebug.h>
367c478bdstevel@tonic-gate
377c478bdstevel@tonic-gate#ifdef __cplusplus
387c478bdstevel@tonic-gateextern "C" {
397c478bdstevel@tonic-gate#endif
407c478bdstevel@tonic-gate
417c478bdstevel@tonic-gate// This is the abstract base class for all audio data sources/sinks.
427c478bdstevel@tonic-gate// It is invalid to create an object of type AudioStream.
437c478bdstevel@tonic-gate
447c478bdstevel@tonic-gateclass AudioStream : public Audio {
457c478bdstevel@tonic-gateprivate:
467c478bdstevel@tonic-gate	AudioHdr	hdr;			// data encoding info
477c478bdstevel@tonic-gate	Double		length;			// length of data, in secs
487c478bdstevel@tonic-gate
497c478bdstevel@tonic-gateprotected:
507c478bdstevel@tonic-gate
517c478bdstevel@tonic-gate	Boolean hdrset() const;			// TRUE if header valid
527c478bdstevel@tonic-gate
537c478bdstevel@tonic-gate	// Set header (always)
547c478bdstevel@tonic-gate	AudioError updateheader(
557c478bdstevel@tonic-gate	    const AudioHdr& h);			// header to copy
567c478bdstevel@tonic-gate
577c478bdstevel@tonic-gate	// Set data length
587c478bdstevel@tonic-gate	void setlength(
597c478bdstevel@tonic-gate	    Double len);			// new length, in secs
607c478bdstevel@tonic-gate
617c478bdstevel@tonic-gate	virtual Boolean opened() const = 0;	// TRUE if stream 'open'
627c478bdstevel@tonic-gate
637c478bdstevel@tonic-gatepublic:
647c478bdstevel@tonic-gate	AudioStream(const char *path = "");	// Constructor
657c478bdstevel@tonic-gate
667c478bdstevel@tonic-gate	// Set header
677c478bdstevel@tonic-gate	virtual AudioError SetHeader(
687c478bdstevel@tonic-gate	    const AudioHdr& h);			// header to copy
697c478bdstevel@tonic-gate
707c478bdstevel@tonic-gate	// Set data length
717c478bdstevel@tonic-gate	virtual void SetLength(
727c478bdstevel@tonic-gate	    Double len);			// new length, in secs
737c478bdstevel@tonic-gate
747c478bdstevel@tonic-gate	// XXX - is this needed?  do we need time->sample frames?
757c478bdstevel@tonic-gate	virtual size_t GetByteCount() const;		// Get length, in bytes
767c478bdstevel@tonic-gate
777c478bdstevel@tonic-gate	// class Audio methods specialized here
787c478bdstevel@tonic-gate	virtual AudioHdr GetHeader();			// Get header
797c478bdstevel@tonic-gate
807c478bdstevel@tonic-gate	virtual Double GetLength() const;		// Get length, in secs
817c478bdstevel@tonic-gate
827c478bdstevel@tonic-gate	// Make sure endian of the data matches the current processor.
837c478bdstevel@tonic-gate	AudioError coerceEndian(unsigned char *buf, size_t len,
847c478bdstevel@tonic-gate	    AudioEndian en);
857c478bdstevel@tonic-gate
867c478bdstevel@tonic-gate	virtual Boolean isEndianSensitive() const;
877c478bdstevel@tonic-gate	AudioEndian localByteOrder() const
887c478bdstevel@tonic-gate	{
897c478bdstevel@tonic-gate		return (hdr.localByteOrder());
907c478bdstevel@tonic-gate	}
917c478bdstevel@tonic-gate};
927c478bdstevel@tonic-gate
937c478bdstevel@tonic-gate#include <AudioStream_inline.h>
947c478bdstevel@tonic-gate
957c478bdstevel@tonic-gate#ifdef __cplusplus
967c478bdstevel@tonic-gate}
977c478bdstevel@tonic-gate#endif
987c478bdstevel@tonic-gate
997c478bdstevel@tonic-gate#endif /* !_MULTIMEDIA_AUDIOSTREAM_H */
100