File: RecoverySource.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 (71 lines) | stat: -rw-r--r-- 2,534 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
/*************************************************************************
       RecoverySource.h  - base class for recovered audio file data
                             -------------------
    begin                : Sun May 12 2002
    copyright            : (C) 2002 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 RECOVERY_SOURCE_H
#define RECOVERY_SOURCE_H

#include "config.h"

#include <qglobal.h>

namespace Kwave
{
    class RecoverySource
    {
    public:
        /**
        * Constructor
        * @param offset position within the recovered file
        * @param length number of bytes of the recovered area
        */
        RecoverySource(quint64 offset, quint64 length);

        /** Destructor */
        virtual ~RecoverySource() {}

        /** Returns the start offset in the recovered file */
        virtual quint64 offset() const;

        /** Returns the number of bytes of the recovered range */
        virtual quint64 length() const;

        /** Returns the end offset in the recovered file */
        virtual quint64 end() const;

        /**
        * Reads bytes from the recovered file into a buffer
        * @param offset position within the recovered file
        * @param data pointer to the buffer to be filled
        * @param bytes number of bytes to read
        * @return number of successfully read bytes
        */
        virtual qint64 read(quint64 offset, char *data,
                            unsigned int bytes) = 0;

    private:
        /** offset in the file */
        quint64 m_offset;

        /** length in bytes */
        quint64 m_length;
    };
}

#endif /* RECOVERY_SOURCE_H */

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