engines/gig/DiskThread.h

/***************************************************************************
 *                                                                         *
 *   LinuxSampler - modular, streaming capable sampler                     *
 *                                                                         *
 *   Copyright (C) 2003, 2004 by Benno Senoner and Christian Schoenebeck   *
 *   Copyright (C) 2005 - 2009 Christian Schoenebeck                       *
 *                                                                         *
 *   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 __LS_GIG_DISKTHREAD_H__
#define __LS_GIG_DISKTHREAD_H__

#include "../../common/global_private.h"

#include <gig.h>

#include "../../common/Thread.h"
#include "../../common/RingBuffer.h"
#include "../../common/atomic.h"
#include "Stream.h"
#include "Voice.h"

namespace LinuxSampler { namespace gig {

    int CompareStreamWriteSpace(const void* a, const void* b);

    /** @brief Disk Reader Thread
     *
     * The disk reader thread is responsible for periodically refilling
     * disk streams in parallel to the audio thread's rendering process.
     *
     * There is also a function for releasing parts of instruments not
     * in use anymore (as this is not real time safe, the audio thread
     * cannot do it directly).
     */
    class DiskThread : public Thread {
        public:
            // Methods
            DiskThread(int MaxStreams, uint BufferWrapElements, InstrumentResourceManager* pInstruments);
            virtual ~DiskThread();
            void    Reset();
            String  GetBufferFillBytes();
            String  GetBufferFillPercentage();
            int     OrderNewStream(Stream::reference_t* pStreamRef, ::gig::DimensionRegion* pDimRgn, unsigned long SampleOffset, bool DoLoop);
            int     OrderDeletionOfStream(Stream::reference_t* pStreamRef, bool bRequestNotification = false);
            int     OrderDeletionOfDimreg(::gig::DimensionRegion* dimreg);
            Stream* AskForCreatedStream(Stream::OrderID_t StreamOrderID);
            Stream::Handle AskForDeletedStream();

            // the number of streams currently in usage
            // printed on the console the main thread (along with the active voice count)
            uint GetActiveStreamCount() { return atomic_read(&ActiveStreamCount); }
            void SetActiveStreamCount(uint Streams) { atomic_set(&ActiveStreamCount, Streams); }
            int ActiveStreamCountMax;

        protected:
            ::gig::buffer_t DecompressionBuffer; ///< Used for thread safe streaming.

            int Main(); ///< Implementation of virtual method from class Thread

            friend class Stream;
        private:
            // Private Types
            struct create_command_t {
                Stream::OrderID_t    OrderID;
                Stream::Handle       hStream;
                Stream::reference_t* pStreamRef;
                ::gig::DimensionRegion* pDimRgn;
                unsigned long        SampleOffset;
                bool                 DoLoop;
            };
            struct delete_command_t {
                Stream*           pStream;
                Stream::Handle    hStream;
                Stream::OrderID_t OrderID;
                bool              bNotify;
            };

            // Attributes
            bool                           IsIdle;
            uint                           Streams;
            RingBuffer<create_command_t,false>* CreationQueue;                      ///< Contains commands to create streams
            RingBuffer<delete_command_t,false>* DeletionQueue;                      ///< Contains commands to delete streams
            RingBuffer<delete_command_t,false>* GhostQueue;                         ///< Contains handles to streams that are not used anymore and weren't deletable immediately
            RingBuffer<Stream::Handle,false>    DeletionNotificationQueue;          ///< In case the original sender requested a notification for its stream deletion order, this queue will receive the handle of the respective stream once actually be deleted by the disk thread.
            RingBuffer< ::gig::DimensionRegion*,false>* DeleteDimregQueue;          ///< Contains dimension regions that are not used anymore and should be handed back to the instrument resource manager
            unsigned int                   RefillStreamsPerRun;                    ///< How many streams should be refilled in each loop run
            Stream**                       pStreams; ///< Contains all disk streams (whether used or unused)
            Stream**                       pCreatedStreams; ///< This is where the voice (audio thread) picks up it's meanwhile hopefully created disk stream.
            static Stream*                 SLOT_RESERVED;                          ///< This value is used to mark an entry in pCreatedStreams[] as reserved.
            InstrumentResourceManager*     pInstruments;                           ///< The instrument resource manager of the engine that is using this disk thread. Used by the dimension region deletion feature.

            // Methods
            void                           CreateStream(create_command_t& Command);
            void                           DeleteStream(delete_command_t& Command);
            void                           RefillStreams();
            Stream::Handle                 CreateHandle();
            Stream::OrderID_t              CreateOrderID();

            atomic_t ActiveStreamCount;
    };

}} // namespace LinuxSampler::gig

#endif // __LS_GIG_DISKTHREAD_H__
1	schoenebeck	53	/***************************************************************************
2			* *
3			* LinuxSampler - modular, streaming capable sampler *
4			* *
5	schoenebeck	56	* Copyright (C) 2003, 2004 by Benno Senoner and Christian Schoenebeck *
6	schoenebeck	1879	* Copyright (C) 2005 - 2009 Christian Schoenebeck *
7	schoenebeck	53	* *
8			* This program is free software; you can redistribute it and/or modify *
9			* it under the terms of the GNU General Public License as published by *
10			* the Free Software Foundation; either version 2 of the License, or *
11			* (at your option) any later version. *
12			* *
13			* This program is distributed in the hope that it will be useful, *
14			* but WITHOUT ANY WARRANTY; without even the implied warranty of *
15			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
16			* GNU General Public License for more details. *
17			* *
18			* You should have received a copy of the GNU General Public License *
19			* along with this program; if not, write to the Free Software *
20			* Foundation, Inc., 59 Temple Place, Suite 330, Boston, *
21			* MA 02111-1307 USA *
22			***************************************************************************/
23
24			#ifndef __LS_GIG_DISKTHREAD_H__
25			#define __LS_GIG_DISKTHREAD_H__
26
27	schoenebeck	1424	#include "../../common/global_private.h"
28	schoenebeck	53
29	schoenebeck	505	#include <gig.h>
30
31	schoenebeck	53	#include "../../common/Thread.h"
32			#include "../../common/RingBuffer.h"
33	schoenebeck	1879	#include "../../common/atomic.h"
34	schoenebeck	53	#include "Stream.h"
35			#include "Voice.h"
36
37			namespace LinuxSampler { namespace gig {
38
39			int CompareStreamWriteSpace(const void* a, const void* b);
40
41	schoenebeck	563	/** @brief Disk Reader Thread
42			*
43			* The disk reader thread is responsible for periodically refilling
44			* disk streams in parallel to the audio thread's rendering process.
45	persson	1038	*
46			* There is also a function for releasing parts of instruments not
47			* in use anymore (as this is not real time safe, the audio thread
48			* cannot do it directly).
49	schoenebeck	563	*/
50	schoenebeck	53	class DiskThread : public Thread {
51			public:
52			// Methods
53	schoenebeck	1800	DiskThread(int MaxStreams, uint BufferWrapElements, InstrumentResourceManager* pInstruments);
54	letz	502	virtual ~DiskThread();
55	schoenebeck	53	void Reset();
56			String GetBufferFillBytes();
57			String GetBufferFillPercentage();
58	persson	865	int OrderNewStream(Stream::reference_t* pStreamRef, ::gig::DimensionRegion* pDimRgn, unsigned long SampleOffset, bool DoLoop);
59	schoenebeck	1321	int OrderDeletionOfStream(Stream::reference_t* pStreamRef, bool bRequestNotification = false);
60	persson	1038	int OrderDeletionOfDimreg(::gig::DimensionRegion* dimreg);
61	schoenebeck	53	Stream* AskForCreatedStream(Stream::OrderID_t StreamOrderID);
62	schoenebeck	1321	Stream::Handle AskForDeletedStream();
63	schoenebeck	53
64			// the number of streams currently in usage
65			// printed on the console the main thread (along with the active voice count)
66	iliev	1789	uint GetActiveStreamCount() { return atomic_read(&ActiveStreamCount); }
67			void SetActiveStreamCount(uint Streams) { atomic_set(&ActiveStreamCount, Streams); }
68	schoenebeck	53	int ActiveStreamCountMax;
69
70			protected:
71	schoenebeck	385	::gig::buffer_t DecompressionBuffer; ///< Used for thread safe streaming.
72
73	schoenebeck	53	int Main(); ///< Implementation of virtual method from class Thread
74	schoenebeck	385
75			friend class Stream;
76	schoenebeck	53	private:
77			// Private Types
78			struct create_command_t {
79			Stream::OrderID_t OrderID;
80			Stream::Handle hStream;
81			Stream::reference_t* pStreamRef;
82	persson	865	::gig::DimensionRegion* pDimRgn;
83	schoenebeck	53	unsigned long SampleOffset;
84			bool DoLoop;
85			};
86			struct delete_command_t {
87			Stream* pStream;
88			Stream::Handle hStream;
89			Stream::OrderID_t OrderID;
90	schoenebeck	1321	bool bNotify;
91	schoenebeck	53	};
92
93			// Attributes
94			bool IsIdle;
95			uint Streams;
96	schoenebeck	970	RingBuffer<create_command_t,false>* CreationQueue; ///< Contains commands to create streams
97			RingBuffer<delete_command_t,false>* DeletionQueue; ///< Contains commands to delete streams
98	schoenebeck	1321	RingBuffer<delete_command_t,false>* GhostQueue; ///< Contains handles to streams that are not used anymore and weren't deletable immediately
99			RingBuffer<Stream::Handle,false> DeletionNotificationQueue; ///< In case the original sender requested a notification for its stream deletion order, this queue will receive the handle of the respective stream once actually be deleted by the disk thread.
100	persson	1038	RingBuffer< ::gig::DimensionRegion,false> DeleteDimregQueue; ///< Contains dimension regions that are not used anymore and should be handed back to the instrument resource manager
101	schoenebeck	53	unsigned int RefillStreamsPerRun; ///< How many streams should be refilled in each loop run
102	schoenebeck	1800	Stream** pStreams; ///< Contains all disk streams (whether used or unused)
103			Stream** pCreatedStreams; ///< This is where the voice (audio thread) picks up it's meanwhile hopefully created disk stream.
104	schoenebeck	53	static Stream* SLOT_RESERVED; ///< This value is used to mark an entry in pCreatedStreams[] as reserved.
105	persson	1038	InstrumentResourceManager* pInstruments; ///< The instrument resource manager of the engine that is using this disk thread. Used by the dimension region deletion feature.
106	schoenebeck	53
107			// Methods
108			void CreateStream(create_command_t& Command);
109			void DeleteStream(delete_command_t& Command);
110			void RefillStreams();
111			Stream::Handle CreateHandle();
112			Stream::OrderID_t CreateOrderID();
113	iliev	1789
114			atomic_t ActiveStreamCount;
115	schoenebeck	53	};
116
117			}} // namespace LinuxSampler::gig
118
119			#endif // __LS_GIG_DISKTHREAD_H__