File: SampleSource.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 (70 lines) | stat: -rw-r--r-- 2,493 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
/*************************************************************************
    SampleSource.h  -  base class with a generic sample source
                             -------------------
    begin                : Sun Oct 07 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 SAMPLE_SOURCE_H
#define SAMPLE_SOURCE_H

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

#include <QtGlobal>
#include <QObject>

#include "libkwave/SampleArray.h"
#include "libkwave/modules/StreamObject.h"

namespace Kwave
{
    class LIBKWAVE_EXPORT SampleSource: public Kwave::StreamObject
    {
        Q_OBJECT
    public:

        /**
         * Constructor
         *
         * @param parent a parent object, passed to QObject (optional)
         */
        explicit SampleSource(QObject *parent = nullptr);

        /** Destructor */
        ~SampleSource() override;

        /**
         * Each KwaveSampleSource has to derive this method for producing
         * sample data. It then should emit a signal like this:
         * "output(SampleArray data)"
         */
        virtual void goOn() = 0;

        /**
         * Returns true if the end of the source has been reached,
         * e.g. at EOF of an input stream. The default implementation
         * always returns false, which means that the source is always
         * able to produce data (useful for signal generators).
         *
         * @return true if it can produce more sample data, otherwise false
         */
        virtual bool done() const { return false; }

    };
}

#endif /* SAMPLE_SOURCE_H */

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