File: MultiTrackSource.h

package info (click to toggle)
kwave 25.04.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 23,272 kB
  • sloc: cpp: 56,173; xml: 817; perl: 688; sh: 57; makefile: 11
file content (183 lines) | stat: -rw-r--r-- 6,123 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
/*************************************************************************
    MultiTrackSource.h  -  template for multi-track sources
                             -------------------
    begin                : Sat Oct 20 2007
    copyright            : (C) 2007 by Thomas Eschenbacher
    email                : Thomas.Eschenbacher@gmx.de
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   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.                                   *
 *                                                                         *
 ***************************************************************************/

#ifndef MULTI_TRACK_SOURCE_H
#define MULTI_TRACK_SOURCE_H

#include "config.h"
#include "libkwave_export.h"

#include <new>

#include <QFutureSynchronizer>
#include <QList>
#include <QObject>
#include <QtConcurrentRun>

#include "libkwave/SampleSource.h"

namespace Kwave
{

    /**
     * Template for easier handling of Kwave::SampleSource objects
     * that consist of multiple independent tracks.
     */
    template <class SOURCE, const bool INITIALIZE>
    class LIBKWAVE_EXPORT MultiTrackSource: public Kwave::SampleSource,
                                          private QList<SOURCE *>
    {
    public:
        /**
         * Default constructor, which does no initialization of the
         * objects themselves. If you want to use this, you should
         * derive from this class, create all objects manually and
         * "insert" them from the constructor.
         *
         * @param tracks number of tracks
         * @param parent a parent object, passed to QObject
         */
        MultiTrackSource(unsigned int tracks, QObject *parent)
            :Kwave::SampleSource(parent),
             QList<SOURCE *>()
        {
            Q_UNUSED(tracks)
            Q_ASSERT(INITIALIZE || (tracks == 0));
            Q_ASSERT(QList<SOURCE *>::size() == static_cast<int>(tracks));
        }

        /** Destructor */
        ~MultiTrackSource() override
        {
            clear();
        }

        /**
         * Calls goOn() for each track.
         * @see Kwave::SampleSource::goOn()
         */
        void goOn() override
        {
            if (isCanceled()) return;

            QFutureSynchronizer<void> synchronizer;
            foreach (SOURCE *src, static_cast< QList<SOURCE *> >(*this)) {
                if (!src) continue;
                synchronizer.addFuture(QtConcurrent::run(
                    &Kwave::MultiTrackSource<SOURCE, INITIALIZE>::runSource,
                    this,
                    src)
                );
            }
            synchronizer.waitForFinished();
        }

        /** Returns true when all sources are done */
        bool done() const override
        {
            foreach (SOURCE *src, static_cast< QList<SOURCE *> >(*this))
                if (src && !src->done()) return false;
            return true;
        }

        /**
         * Returns the number of tracks that the source provides
         * @return number of tracks
         */
        unsigned int tracks() const override
        {
            return static_cast<unsigned int>(QList<SOURCE *>::size());
        }

        /**
         * Returns the source that corresponds to one specific track
         * if the object has multiple tracks. For single-track objects
         * it returns "this" for the first index and 0 for all others
         */
        inline virtual SOURCE *at(unsigned int track) const {
            return QList<SOURCE *>::at(track);
        }

        /** @see the Kwave::MultiTrackSource.at()... */
        inline virtual SOURCE * operator [] (unsigned int track)
            override
        {
            return at(track);
        }

        /**
         * Insert a new track with a source.
         *
         * @param track index of the track [0...N-1]
         * @param source pointer to a Kwave::SampleSource
         * @return true if successful, false if failed
         */
        inline virtual bool insert(unsigned int track, SOURCE *source) {
            QList<SOURCE *>::insert(track, source);
            QObject::connect(this, SIGNAL(sigCancel()),
                             source, SLOT(cancel()), Qt::DirectConnection);
            return (at(track) == source);
        }

        /** Remove all tracks / sources */
        inline virtual void clear() {
            while (!QList<SOURCE *>::isEmpty())
                delete QList<SOURCE *>::takeLast();
        }

    private:

        /** little wrapper for calling goOn() of a source in a worker thread */
        void runSource(SOURCE *src) {
            src->goOn();
        }

    };

    /**
     * Specialized version that internally initializes all objects
     * by generating them through their default constructor.
     */
    template <class SOURCE>
    class LIBKWAVE_EXPORT MultiTrackSource<SOURCE, true>
        :public Kwave::MultiTrackSource<SOURCE, false>
    {
    public:
        /**
         * Constructor
         *
         * @param tracks number of tracks
         * @param parent a parent object, passed to QObject (optional)
         */
        MultiTrackSource(unsigned int tracks,
                         QObject *parent = nullptr)
            :Kwave::MultiTrackSource<SOURCE, false>(0, parent)
        {
            for (unsigned int i = 0; i < tracks; i++)
                this->insert(i, new(std::nothrow) SOURCE());
        }

        /** Destructor */
        virtual ~MultiTrackSource() override { }
    };

}

#endif /* MULTI_TRACK_SOURCE_H */

//***************************************************************************
//***************************************************************************