engines/gig/DiskThread.h

/***************************************************************************
 *                                                                         *
 *   LinuxSampler - modular, streaming capable sampler                     *
 *                                                                         *
 *   Copyright (C) 2003, 2004 by Benno Senoner and Christian Schoenebeck   *
 *   Copyright (C) 2005 - 2007 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 "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(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)
            int ActiveStreamCount;
            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[CONFIG_MAX_STREAMS];            ///< Contains all disk streams (whether used or unused)
            Stream*                        pCreatedStreams[CONFIG_MAX_STREAMS + 1]; ///< 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();
    };

}} // namespace LinuxSampler::gig

#endif // __LS_GIG_DISKTHREAD_H__
1	/***************************************************************************
2	* *
3	* LinuxSampler - modular, streaming capable sampler *
4	* *
5	* Copyright (C) 2003, 2004 by Benno Senoner and Christian Schoenebeck *
6	* Copyright (C) 2005 - 2007 Christian Schoenebeck *
7	* *
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	#include "../../common/global_private.h"
28
29	#include <gig.h>
30
31	#include "../../common/Thread.h"
32	#include "../../common/RingBuffer.h"
33	#include "Stream.h"
34	#include "Voice.h"
35
36	namespace LinuxSampler { namespace gig {
37
38	int CompareStreamWriteSpace(const void* a, const void* b);
39
40	/** @brief Disk Reader Thread
41	*
42	* The disk reader thread is responsible for periodically refilling
43	* disk streams in parallel to the audio thread's rendering process.
44	*
45	* There is also a function for releasing parts of instruments not
46	* in use anymore (as this is not real time safe, the audio thread
47	* cannot do it directly).
48	*/
49	class DiskThread : public Thread {
50	public:
51	// Methods
52	DiskThread(uint BufferWrapElements, InstrumentResourceManager* pInstruments);
53	virtual ~DiskThread();
54	void Reset();
55	String GetBufferFillBytes();
56	String GetBufferFillPercentage();
57	int OrderNewStream(Stream::reference_t* pStreamRef, ::gig::DimensionRegion* pDimRgn, unsigned long SampleOffset, bool DoLoop);
58	int OrderDeletionOfStream(Stream::reference_t* pStreamRef, bool bRequestNotification = false);
59	int OrderDeletionOfDimreg(::gig::DimensionRegion* dimreg);
60	Stream* AskForCreatedStream(Stream::OrderID_t StreamOrderID);
61	Stream::Handle AskForDeletedStream();
62
63	// the number of streams currently in usage
64	// printed on the console the main thread (along with the active voice count)
65	int ActiveStreamCount;
66	int ActiveStreamCountMax;
67
68	protected:
69	::gig::buffer_t DecompressionBuffer; ///< Used for thread safe streaming.
70
71	int Main(); ///< Implementation of virtual method from class Thread
72
73	friend class Stream;
74	private:
75	// Private Types
76	struct create_command_t {
77	Stream::OrderID_t OrderID;
78	Stream::Handle hStream;
79	Stream::reference_t* pStreamRef;
80	::gig::DimensionRegion* pDimRgn;
81	unsigned long SampleOffset;
82	bool DoLoop;
83	};
84	struct delete_command_t {
85	Stream* pStream;
86	Stream::Handle hStream;
87	Stream::OrderID_t OrderID;
88	bool bNotify;
89	};
90
91	// Attributes
92	bool IsIdle;
93	uint Streams;
94	RingBuffer<create_command_t,false>* CreationQueue; ///< Contains commands to create streams
95	RingBuffer<delete_command_t,false>* DeletionQueue; ///< Contains commands to delete streams
96	RingBuffer<delete_command_t,false>* GhostQueue; ///< Contains handles to streams that are not used anymore and weren't deletable immediately
97	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.
98	RingBuffer< ::gig::DimensionRegion,false> DeleteDimregQueue; ///< Contains dimension regions that are not used anymore and should be handed back to the instrument resource manager
99	unsigned int RefillStreamsPerRun; ///< How many streams should be refilled in each loop run
100	Stream* pStreams[CONFIG_MAX_STREAMS]; ///< Contains all disk streams (whether used or unused)
101	Stream* pCreatedStreams[CONFIG_MAX_STREAMS + 1]; ///< This is where the voice (audio thread) picks up it's meanwhile hopefully created disk stream.
102	static Stream* SLOT_RESERVED; ///< This value is used to mark an entry in pCreatedStreams[] as reserved.
103	InstrumentResourceManager* pInstruments; ///< The instrument resource manager of the engine that is using this disk thread. Used by the dimension region deletion feature.
104
105	// Methods
106	void CreateStream(create_command_t& Command);
107	void DeleteStream(delete_command_t& Command);
108	void RefillStreams();
109	Stream::Handle CreateHandle();
110	Stream::OrderID_t CreateOrderID();
111	};
112
113	}} // namespace LinuxSampler::gig
114
115	#endif // __LS_GIG_DISKTHREAD_H__