This file is indexed.

/usr/include/sidplayfp/SidTuneInfo.h is in libsidplayfp-dev 1.8.7-1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  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
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
/*
 * This file is part of libsidplayfp, a SID player engine.
 *
 *  Copyright 2011-2015 Leandro Nini
 *  Copyright 2007-2010 Antti Lankila
 *  Copyright 2000 Simon White
 *
 *  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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */

#ifndef SIDTUNEINFO_H
#define SIDTUNEINFO_H

#include <stdint.h>

#include "sidplayfp/siddefs.h"

/**
 * This interface is used to get values from SidTune objects.
 *
 * You must read (i.e. activate) sub-song specific information
 * via:
 *        const SidTuneInfo* tuneInfo = SidTune.getInfo();
 *        const SidTuneInfo* tuneInfo = SidTune.getInfo(songNumber);
 */
class SidTuneInfo
{
public:
    typedef enum {
        CLOCK_UNKNOWN,
        CLOCK_PAL,
        CLOCK_NTSC,
        CLOCK_ANY
    } clock_t;

    typedef enum {
        SIDMODEL_UNKNOWN,
        SIDMODEL_6581,
        SIDMODEL_8580,
        SIDMODEL_ANY
    } model_t;

    typedef enum {
        COMPATIBILITY_C64,   ///< File is C64 compatible
        COMPATIBILITY_PSID,  ///< File is PSID specific
        COMPATIBILITY_R64,   ///< File is Real C64 only
        COMPATIBILITY_BASIC  ///< File requires C64 Basic
    } compatibility_t;

public:
    /// Vertical-Blanking-Interrupt
    static const int SPEED_VBI = 0;

    /// CIA 1 Timer A
    static const int SPEED_CIA_1A = 60;

public:
    /**
     * Load Address.
     */
    virtual uint_least16_t loadAddr() const =0;

    /**
     * Init Address.
     */
    virtual uint_least16_t initAddr() const =0;

    /**
     * Play Address.
     */
    virtual uint_least16_t playAddr() const =0;

    /**
     * The number of songs.
     */
    virtual unsigned int songs() const =0;

    /**
     * The default starting song.
     */
    virtual unsigned int startSong() const =0;

    /**
     * The tune that has been initialized.
     */
    virtual unsigned int currentSong() const =0;

    /**
     * @name Base addresses
     * The SID chip base address(es) used by the sidtune.
     */
    //@{
    virtual SID_DEPRECATED uint_least16_t sidChipBase1() const =0;    ///< 0xD400 (normal, 1st SID) \deprecated use #sidChipBase() with i=0
    virtual SID_DEPRECATED uint_least16_t sidChipBase2() const =0;    ///< 0xD??0 (2nd SID) or 0 (no 2nd SID) \deprecated use #sidChipBase() with i=1
    virtual uint_least16_t sidChipBase(unsigned int i) const =0;   ///< \since 1.8
    //@}

    /**
     * Whether sidtune uses two SID chips.
     * \deprecated use #sidChips()
     */
    virtual SID_DEPRECATED bool isStereo() const=0;

    /**
     * Get the number of SID chips required by the tune.
     */
    virtual int sidChips() const =0;

    /**
     * Intended speed.
     */
    virtual int songSpeed() const =0;

    /**
     * First available page for relocation.
     */
    virtual uint_least8_t relocStartPage() const =0;

    /**
     * Number of pages available for relocation.
     */
    virtual uint_least8_t relocPages() const =0;

    /**
     * @name SID model
     * The SID chip model(s) requested by the sidtune.
     */
    //@{
    virtual SID_DEPRECATED model_t sidModel1() const =0;    ///< first SID \deprecated use #sidModel() with i=0
    virtual SID_DEPRECATED model_t sidModel2() const =0;    ///< second SID \deprecated use #sidModel() with i=1
    virtual model_t sidModel(unsigned int i) const =0;   ///< \since 1.8
    //@}

    /**
     * Compatibility requirements.
     */
    virtual compatibility_t compatibility() const =0;

    /**
     * @name Tune infos
     * Song title, credits, ...
     * - 0 = Title
     * - 1 = Author
     * - 2 = Released
     */
    //@{
    virtual unsigned int numberOfInfoStrings() const =0;     ///< the number of available text info lines
    virtual const char* infoString(unsigned int i) const =0; ///< text info from the format headers etc.
    //@}

    /**
     * @name Tune comments
     * MUS comments.
     */
    //@{
    virtual unsigned int numberOfCommentStrings() const =0;     ///< Number of comments
    virtual const char* commentString(unsigned int i) const =0; ///<  Used to stash the MUS comment somewhere.
    //@}

    /**
     * Length of single-file sidtune file.
     */
    virtual uint_least32_t dataFileLen() const =0;

    /**
     * Length of raw C64 data without load address.
     */
    virtual uint_least32_t c64dataLen() const =0;

    /**
     * The tune clock speed.
     */
    virtual clock_t clockSpeed() const =0;

    /**
     * The name of the identified file format.
     */
    virtual const char* formatString() const =0;

    /**
     * Whether load address might be duplicate.
     */
    virtual bool fixLoad() const =0;

    /**
     * Path to sidtune files.
     */
    virtual const char* path() const =0;

    /**
     * A first file: e.g. "foo.sid" or "foo.mus".
     */
    virtual const char* dataFileName() const =0;

    /**
     * A second file: e.g. "foo.str".
     * Returns 0 if none.
     */
    virtual const char* infoFileName() const =0;

protected:
    ~SidTuneInfo() {}
};

#endif  /* SIDTUNEINFO_H */