trunk/src/stream.h

/***************************************************************************
 *                                                                         *
 *   LinuxSampler - modular, streaming capable sampler                     *
 *                                                                         *
 *   Copyright (C) 2003 by Benno Senoner                                   *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the Free Software           *
 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston,                 *
 *   MA  02111-1307  USA                                                   *
 ***************************************************************************/

#ifndef __STREAM_H__
#define __STREAM_H__

#include "global.h"
#include "ringbuffer.h"
#include "gig.h"

class Stream {
    public:
        // Member Types
        typedef uint32_t OrderID_t;
        typedef uint32_t Handle; ///< unique identifier of a relationship between one stream and a consumer (Voice)
        enum state_t {           ///< streams go through severe cyclic state transition (unused->active->end->unused->...)
            state_unused,        ///< stream is not in use, thus can still be launched
            state_active,        ///< stream provides data in it's buffer to be read and hasn't reached the end yet (this is the usual case)
            state_end            ///< stream end reached but still providing data in it's buffer to be read (after the client read all remaining data from the stream buffer, state will change automatically to state_unused)
        };
        struct reference_t {     ///< Defines the current relationship between the stream and a client (voice).
            OrderID_t OrderID;   ///< Unique identifier that identifies the creation order of a stream requested by a voice.
            Handle    hStream;   ///< Unique identifier of the relationship between stream and client.
            state_t   State;     ///< Current state of the stream that will be pretended to the client (the actual state of the stream might differ though, because the stream might already be in use by another client).
            Stream*   pStream;   ///< Points to the assigned and activated stream or is NULL if the disk thread hasn't launched a stream yet.
        };

        // Methods
        Stream(uint BufferSize, uint BufferWrapElements);
       ~Stream();
        int  ReadAhead(unsigned long SampleCount);
        void WriteSilence(unsigned long SilenceSampleWords);

        inline int GetReadSpace() {
            return (pRingBuffer && State == state_active) ? pRingBuffer->read_space()  : 0;
        }

        inline int GetWriteSpace() {
            return (pRingBuffer && State == state_active) ? pRingBuffer->write_space() : 0;
        }

        inline int GetWriteSpaceToEnd() {
            return (pRingBuffer && State == state_active) ? pRingBuffer->write_space_to_end_with_wrap() : 0;
        }

        // adjusts the write space to avoid buffer boundaries which would lead to the wrap space
        // within the buffer (needed for interpolation) getting filled only partially
        // for more infos see the docs in ringbuffer.h at adjust_write_space_to_avoid_boundary()
        inline int AdjustWriteSpaceToAvoidBoundary(int cnt, int capped_cnt) {
          return pRingBuffer->adjust_write_space_to_avoid_boundary(cnt, capped_cnt);
        }

        inline sample_t* GetReadPointer() {
            return pRingBuffer->get_read_ptr();
        }

        // gets the current read_ptr within the ringbuffer
        inline sample_t* GetReadPtr(void) {
            return pRingBuffer->get_read_ptr();
        }

        inline void IncrementReadPos(uint Count)  {
            uint leftspace = pRingBuffer->read_space();
            pRingBuffer->increment_read_ptr(Min(Count, leftspace));
            if (State == state_end && Count >= leftspace) {
                Reset(); // quit relation between consumer (voice) and stream and reset stream right after
            }
        }

        // Static Method
        inline static uint       GetUnusedStreams() { return UnusedStreams; }
    protected:
        // Methods
        void                     Launch(Stream::Handle hStream, reference_t* pExportReference, gig::Sample* pSample, unsigned long SampleOffset, bool DoLoop);
        inline void              Kill()      { pExportReference = NULL; Reset(); } ///< Will be called by disk thread after a 'deletion' command from the audio thread (within the voice class)
        inline Stream::Handle    GetHandle() { return hThis; }
        inline Stream::state_t   GetState()  { return State; }
        friend class DiskThread; // only the disk thread should be able to launch and most important kill a disk stream to avoid race conditions
    private:
        // Attributes
        reference_t*             pExportReference;
        state_t                  State;
        Stream::Handle           hThis;
        unsigned long            SampleOffset;
        gig::Sample*             pSample;
        gig::playback_state_t    PlaybackState;
        RingBuffer<sample_t>*    pRingBuffer;
        bool                     DoLoop;

        // Static Attributes
        static uint              UnusedStreams; //< Reflects how many stream objects of all stream instances are currently not in use.

        // Methods
        inline void Reset() {
            SampleOffset                   = 0;
            pSample                        = NULL;
            PlaybackState.position         = 0;
            PlaybackState.reverse          = false;
            hThis                          = 0;
            pRingBuffer->init(); // reset ringbuffer
            if (State != state_unused) {
                // we can't do 'SetPos(state_unused)' here, due to possible race conditions)
                if (pExportReference) {
                    pExportReference->State = state_unused;
                    pExportReference        = NULL;
                }
                State = state_unused;
                UnusedStreams++;
            }
        }
        inline void SetState(state_t State) {
            if (pExportReference) pExportReference->State = State;
            this->State = State;
        }
        inline long Min(long a, long b) { return (a < b) ? a : b; }
};

#endif // __STREAM_H__
1	/***************************************************************************
2	* *
3	* LinuxSampler - modular, streaming capable sampler *
4	* *
5	* Copyright (C) 2003 by Benno Senoner *
6	* *
7	* This program is free software; you can redistribute it and/or modify *
8	* it under the terms of the GNU General Public License as published by *
9	* the Free Software Foundation; either version 2 of the License, or *
10	* (at your option) any later version. *
11	* *
12	* This program is distributed in the hope that it will be useful, *
13	* but WITHOUT ANY WARRANTY; without even the implied warranty of *
14	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
15	* GNU General Public License for more details. *
16	* *
17	* You should have received a copy of the GNU General Public License *
18	* along with this program; if not, write to the Free Software *
19	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, *
20	* MA 02111-1307 USA *
21	***************************************************************************/
22
23	#ifndef __STREAM_H__
24	#define __STREAM_H__
25
26	#include "global.h"
27	#include "ringbuffer.h"
28	#include "gig.h"
29
30	class Stream {
31	public:
32	// Member Types
33	typedef uint32_t OrderID_t;
34	typedef uint32_t Handle; ///< unique identifier of a relationship between one stream and a consumer (Voice)
35	enum state_t { ///< streams go through severe cyclic state transition (unused->active->end->unused->...)
36	state_unused, ///< stream is not in use, thus can still be launched
37	state_active, ///< stream provides data in it's buffer to be read and hasn't reached the end yet (this is the usual case)
38	state_end ///< stream end reached but still providing data in it's buffer to be read (after the client read all remaining data from the stream buffer, state will change automatically to state_unused)
39	};
40	struct reference_t { ///< Defines the current relationship between the stream and a client (voice).
41	OrderID_t OrderID; ///< Unique identifier that identifies the creation order of a stream requested by a voice.
42	Handle hStream; ///< Unique identifier of the relationship between stream and client.
43	state_t State; ///< Current state of the stream that will be pretended to the client (the actual state of the stream might differ though, because the stream might already be in use by another client).
44	Stream* pStream; ///< Points to the assigned and activated stream or is NULL if the disk thread hasn't launched a stream yet.
45	};
46
47	// Methods
48	Stream(uint BufferSize, uint BufferWrapElements);
49	~Stream();
50	int ReadAhead(unsigned long SampleCount);
51	void WriteSilence(unsigned long SilenceSampleWords);
52
53	inline int GetReadSpace() {
54	return (pRingBuffer && State == state_active) ? pRingBuffer->read_space() : 0;
55	}
56
57	inline int GetWriteSpace() {
58	return (pRingBuffer && State == state_active) ? pRingBuffer->write_space() : 0;
59	}
60
61	inline int GetWriteSpaceToEnd() {
62	return (pRingBuffer && State == state_active) ? pRingBuffer->write_space_to_end_with_wrap() : 0;
63	}
64
65	// adjusts the write space to avoid buffer boundaries which would lead to the wrap space
66	// within the buffer (needed for interpolation) getting filled only partially
67	// for more infos see the docs in ringbuffer.h at adjust_write_space_to_avoid_boundary()
68	inline int AdjustWriteSpaceToAvoidBoundary(int cnt, int capped_cnt) {
69	return pRingBuffer->adjust_write_space_to_avoid_boundary(cnt, capped_cnt);
70	}
71
72	inline sample_t* GetReadPointer() {
73	return pRingBuffer->get_read_ptr();
74	}
75
76	// gets the current read_ptr within the ringbuffer
77	inline sample_t* GetReadPtr(void) {
78	return pRingBuffer->get_read_ptr();
79	}
80
81	inline void IncrementReadPos(uint Count) {
82	uint leftspace = pRingBuffer->read_space();
83	pRingBuffer->increment_read_ptr(Min(Count, leftspace));
84	if (State == state_end && Count >= leftspace) {
85	Reset(); // quit relation between consumer (voice) and stream and reset stream right after
86	}
87	}
88
89	// Static Method
90	inline static uint GetUnusedStreams() { return UnusedStreams; }
91	protected:
92	// Methods
93	void Launch(Stream::Handle hStream, reference_t* pExportReference, gig::Sample* pSample, unsigned long SampleOffset, bool DoLoop);
94	inline void Kill() { pExportReference = NULL; Reset(); } ///< Will be called by disk thread after a 'deletion' command from the audio thread (within the voice class)
95	inline Stream::Handle GetHandle() { return hThis; }
96	inline Stream::state_t GetState() { return State; }
97	friend class DiskThread; // only the disk thread should be able to launch and most important kill a disk stream to avoid race conditions
98	private:
99	// Attributes
100	reference_t* pExportReference;
101	state_t State;
102	Stream::Handle hThis;
103	unsigned long SampleOffset;
104	gig::Sample* pSample;
105	gig::playback_state_t PlaybackState;
106	RingBuffer<sample_t>* pRingBuffer;
107	bool DoLoop;
108
109	// Static Attributes
110	static uint UnusedStreams; //< Reflects how many stream objects of all stream instances are currently not in use.
111
112	// Methods
113	inline void Reset() {
114	SampleOffset = 0;
115	pSample = NULL;
116	PlaybackState.position = 0;
117	PlaybackState.reverse = false;
118	hThis = 0;
119	pRingBuffer->init(); // reset ringbuffer
120	if (State != state_unused) {
121	// we can't do 'SetPos(state_unused)' here, due to possible race conditions)
122	if (pExportReference) {
123	pExportReference->State = state_unused;
124	pExportReference = NULL;
125	}
126	State = state_unused;
127	UnusedStreams++;
128	}
129	}
130	inline void SetState(state_t State) {
131	if (pExportReference) pExportReference->State = State;
132	this->State = State;
133	}
134	inline long Min(long a, long b) { return (a < b) ? a : b; }
135	};
136
137	#endif // __STREAM_H__