libsidplayfp  2.15.0
sidplayfp.h
1 /*
2  * This file is part of libsidplayfp, a SID player engine.
3  *
4  * Copyright 2011-2025 Leandro Nini <drfiemost@users.sourceforge.net>
5  * Copyright 2007-2010 Antti Lankila
6  * Copyright 2000 Simon White
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21  */
22 
23 #ifndef SIDPLAYFP_H
24 #define SIDPLAYFP_H
25 
26 #include <stdint.h>
27 #include <stdio.h>
28 
29 #include "sidplayfp/siddefs.h"
30 #include "sidplayfp/sidversion.h"
31 
32 class SidConfig;
33 class SidTune;
34 class SidInfo;
35 class EventContext;
36 
37 // Private Sidplayer
38 namespace libsidplayfp
39 {
40  class Player;
41 }
42 
46 class SID_EXTERN sidplayfp
47 {
48 private:
49  libsidplayfp::Player &sidplayer;
50 
51 public:
52  sidplayfp();
53  ~sidplayfp();
54 
60  const SidConfig &config() const;
61 
67  const SidInfo &info() const;
68 
76  bool config(const SidConfig &cfg);
77 
83  const char *error() const;
84 
91  SID_DEPRECATED
92  bool fastForward(unsigned int percent);
93 
101  bool load(SidTune *tune);
102 
114  SID_DEPRECATED
115  uint_least32_t play(short *buffer, uint_least32_t count);
116 
123  void buffers(short** buffers) const;
124 
136  int play(unsigned int cycles);
137 
145  bool reset();
146 
153  unsigned int installedSIDs() const;
154 
161  void initMixer(bool stereo);
162 
171  unsigned int mix(short *buffer, unsigned int samples);
172 
179  SID_DEPRECATED
180  bool isPlaying() const;
181 
186  SID_DEPRECATED
187  void stop();
188 
197  void debug(bool enable, FILE *out);
198 
206  void mute(unsigned int sidNum, unsigned int voice, bool enable);
207 
216  void filter(unsigned int sidNum, bool enable);
217 
223  uint_least32_t time() const;
224 
231  uint_least32_t timeMs() const;
232 
240  void setRoms(const uint8_t* kernal, const uint8_t* basic=0, const uint8_t* character=0);
241 
249  void setKernal(const uint8_t* rom);
250  void setBasic(const uint8_t* rom);
251  void setChargen(const uint8_t* rom);
253 
257  uint_least16_t getCia1TimerA() const;
258 
267  bool getSidStatus(unsigned int sidNum, uint8_t regs[32]);
268 };
269 
270 #endif // SIDPLAYFP_H
Definition: SidConfig.h:40
Definition: SidInfo.h:34
Definition: SidTune.h:43
Definition: player.h:57
Definition: sidplayfp.h:47