musix 0.3.5

Music player library for esoteric audio formats (music from C64,Amiga etc)
Documentation 
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

#pragma once

#include <algorithm>
#include <functional>
#include <memory>
#include <string>
#include <vector>

namespace utils {
template <typename T> class Fifo;
} // namespace utils

#include "chipplayer.h"

extern void register_plugins();

namespace musix {

class ChipPlugin
{
public:
    virtual ~ChipPlugin() = default;

    // Must be implemented
    virtual std::string name() const = 0;
    virtual bool canHandle(const std::string& name) = 0;
    virtual ChipPlayer* fromFile(const std::string& fileName) = 0;

    virtual ChipPlayer*
    fromStream(std::shared_ptr<utils::Fifo<uint8_t>> /*unused*/)
    {
        return nullptr;
    }
    virtual int priority() { return 0; }

    // Normally a player stops playing when music is silent, but can be
    // overriden by plugin
    virtual bool checkSilence() const { return true; }

    // Return other files required for playing the provided file. The returned
    // files should normally not contain a path if it assumed they recide in
    // the same directory.
    virtual std::vector<std::string>
    getSecondaryFiles(const std::string& /*file*/)
    {
        return {};
    }

    // Plugin registration stuff

    using PluginConstructor =
        std::function<std::shared_ptr<ChipPlugin>(const std::string&)>;

    static inline bool was_registered = false;
    static inline void createPlugins(const std::string& configDir)
    {
        if (was_registered) { return; }
        was_registered = true;
        register_plugins();
        auto& plugins = getPlugins();
        for (const auto& f : constructors) {
            plugins.push_back(f(configDir));
        }

        if (plugins.empty()) {
            fprintf(stderr, "No plugins registered!\n");
        }

        std::sort(plugins.begin(), plugins.end(),
                  [](auto const& a, auto const& b) {
                      return a->priority() > b->priority();
                  });
        constructors.clear();
    }

    static inline void addPlugin(const std::shared_ptr<ChipPlugin>& plugin, bool first)
    {
        if (first) {
            getPlugins().insert(getPlugins().begin(), plugin);
        } else {
            getPlugins().push_back(plugin);
        }
    }

    template <typename PLUGIN>
    static inline void addPlugin() {
        addPlugin(std::make_shared<PLUGIN>());
    }

    static inline std::shared_ptr<ChipPlugin> getPlugin(const std::string& name)
    {
        for (auto& p : getPlugins()) {
            if (p->name() == name) { return p; }
        }
        return nullptr;
    }

    static inline void addPluginConstructor(PluginConstructor const& pc)
    {
        constructors.push_back(pc);
    }

    // Static instances of this struct is used for automatic registration of
    // linked plugins
    struct RegisterMe
    {
        explicit RegisterMe(PluginConstructor const& f)
        {
            fprintf(stderr, "DEPRECATED!\n");
            //ChipPlugin::addPluginConstructor(f);
        };
    };

    static inline std::vector<std::shared_ptr<ChipPlugin>>& getPlugins()
    {
        static std::vector<std::shared_ptr<ChipPlugin>> plugins;
        return plugins;
    }

private:
    static inline std::vector<PluginConstructor> constructors;
};

} // namespace musix