Return to AudioStream.h CVS log

Up to [Apple Darwin 0.x] / driverkit / libDriver / Kernel

Darwin 0.2 Driver Kit

/*
 * Copyright (c) 1999 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 * 
 * Portions Copyright (c) 1999 Apple Computer, Inc.  All Rights
 * Reserved.  This file contains Original Code and/or Modifications of
 * Original Code as defined in and that are subject to the Apple Public
 * Source License Version 1.1 (the "License").  You may not use this file
 * except in compliance with the License.  Please obtain a copy of the
 * License at http://www.apple.com/publicsource and read it before using
 * this file.
 * 
 * The Original Code and all software distributed under the License are
 * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE OR NON- INFRINGEMENT.  Please see the
 * License for the specific language governing rights and limitations
 * under the License.
 * 
 * @APPLE_LICENSE_HEADER_END@
 */
/*
 * AudioStream.h
 *
 * Copyright (c) 1991, NeXT Computer, Inc.  All rights reserved.
 *
 *      Audio driver stream object.
 *
 * HISTORY
 *      07/14/92/mtm    Original coding.
 */

#import <kern/lock.h>
#import <objc/Object.h>
#import <mach/mach_types.h>
#import <bsd/sys/types.h>
#import <kernserv/queue.h>
#import <machkit/NXLock.h>
#import <sys/time.h>
#import <driverkit/NXSoundParameterTags.h>
#import "audio_types.h"
#import "AudioChannel.h"

/*
 * For user message sends.
 */
#define STREAM_SEND_OPTIONS	(SEND_TIMEOUT|SEND_SWITCH)
#define STREAM_SEND_TIMEOUT	1000

/*
 * Timed control thread messages.
 */
#define AC_CONTROL_THREAD_MSG	0
typedef struct control_msg {
    msg_header_t	header;
    msg_type_t		args_type;
    id			obj;
    ACStreamControl	action;
    struct timeval	*when;
} control_msg_t;
    
/*
 * Playback or record memory region queue structure.
 */
typedef struct region_flags {
    u_int	started;
    u_int	ended;
    u_int	split;
    u_int	aborted;
    u_int	excluded;
} region_flags_t;

typedef struct region {
    vm_address_t	data;
    vm_address_t	end;
    vm_address_t	enq_ptr;
    vm_address_t	record_ptr;
    u_int		count;
    int			tag;
    u_int      		messages;
    port_t		reply_port;
    dma_desc_t		*start_ddp;
    dma_desc_t		*end_ddp;
    region_flags_t	flags;
#if 0
    boolean_t		marks_bumped;	/* touched water marks */
    vm_address_t	wire_head;	/* wire pointer */
    vm_address_t	wire_tail;	/* unwire pointer */
    boolean_t		active;		/* doing dma */
    boolean_t		underrun;	/* overflow/underrun occured */
    boolean_t		low_reached;	/* reached low water first time */
#endif
    queue_chain_t	link;
} region_t;

@interface AudioStream: Object
{
    id			channel;
    id			device;
    port_t		userPort;
    port_t		kernUserPort;
    port_t		ownerPort;
    int			tag;
    ASType		type;
    u_int		bytesProcessed;
    BOOL		isPaused;
    id			regionQueueLock;
    queue_head_t	regionQueue;
    msg_header_t	*sndReplyMsg;
    port_t		pausePort;
    port_t		resumePort;
    port_t		abortPort;
    struct timeval	pauseTime;
    struct timeval	resumeTime;
    struct timeval	abortTime;
    port_t		userReplyPort;
    ASMsgRequest	userReplyMessages;
    u_int		samplingRate;
    IOAudioDataFormat	dataFormat;
    u_int		channelCount;
    char		*mixBuffer1;
    char		*mixBuffer2;
}

- initChannel:chan tag:(int)aTag user:(port_t *)user
        owner:(port_t)owner type:(u_int)aType;
- (port_t)userPort;
- (port_t)ownerPort;
- channel;
- (ASType)type;
- dmaCompleteDescriptor:(dma_desc_t *)tag transfered:(u_int)count;
- (BOOL)canConvertRegion:(region_t *)region rate:(u_int)srate
    format:(IOAudioDataFormat)format channelCount:(u_int)chans;
- clearForMix:(char *)buf size:(u_int)count format:(IOAudioDataFormat)format;
- (u_int)mixBuffer:(vm_address_t)data maxCount:(u_int)max
              rate:(u_int *)srate format:(IOAudioDataFormat *)format
      channelCount:(u_int *)chans descriptor:(dma_desc_t *)ddp
            virgin:(BOOL)isVirgin streamCount:(u_int)streams;
	    
- (u_int)mixRegion:(region_t *)region descriptor:(dma_desc_t *)ddp
            buffer:(vm_address_t)data maxCount:(u_int)max
            virgin:(BOOL)isVirgin rate:(u_int)srate format:(IOAudioDataFormat)format
	    channelCount:(u_int)chans;

- freeRegion:(region_t *)region;
- (region_t *)newRegion;
- free;
- control:(ACStreamControl)action atTime:(struct timeval)when;
- control:(ACStreamControl)action;
- returnRecordedData;
- setOwner:(port_t)newOwner;
- (BOOL)bytesProcessed:(u_int *)num atTime:(unsigned int *)ts;

- (NXSoundParameterTag)dataEncoding;
- (void)setDataEncoding:(NXSoundParameterTag)encoding;
- (u_int)samplingRate;
- (void)setSamplingRate:(u_int)rate;
- (u_int)channelCount;
- (void)setChannelCount:(u_int)count;
- (u_int)lowWaterMark;
- (void)setLowWaterMark:(u_int)count;
- (u_int)highWaterMark;
- (void)setHighWaterMark:(u_int)count;

@end

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.