tick.h

Go to the documentation of this file.

/*
 *   NiCMidi - A C++ Class Library for MIDI
 *
 *   Copyright (C) 2004  J.D. Koftinoff Software, Ltd.
 *   www.jdkoftinoff.com jeffk@jdkoftinoff.com
 *   Copyright (C) 2021, 2022  Nicola Cassetta
 *   https://github.com/ncassetta/NiCMidi
 *
 *   This file is part of NiCMidi.
 *
 *   NiCMidi is free software: you can redistribute it and/or modify
 *   it under the terms of the GNU Lesser General Public License as
 *   published by the Free Software Foundation, either version 3 of
 *   the License, or (at your option) any later version.
 *
 *   NiCMidi 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 Lesser General Public License for more details.
 *
 *   You should have received a copy of the GNU Lesser General Public
 *   License along with NiCMidi. If not, see <http://www.gnu.org/licenses/>.
 */
 
 
 
 
#ifndef _NICMIDI_TICK_H
#define _NICMIDI_TICK_H
 
#include <atomic>
#include <mutex>
#include "timer.h"
 
 
typedef enum {
    PR_FIRST,           
    PR_PRE_SEQ,         
    PR_SEQ,             
    PR_POST_SEQ,        
    PR_LAST             
} tPriority;
 
 
class MIDITickComponent {
    public:
                                    MIDITickComponent(tPriority pr, MIDITick func);
 
        virtual                    ~MIDITickComponent();
 
 
        virtual void                Reset() = 0;
 
        MIDITick*                   GetFunc() const                 { return tick_proc; }
        tPriority                   GetPriority() const             { return priority; }
        tMsecs                      GetDevOffset() const            { return dev_time_offset; }
        bool                        IsPlaying() const               { return running.load(); }
        void                        SetDevOffset(tMsecs dev_offs);
        virtual void                Start();
        virtual void                Stop();
 
 
    protected:
        static void                 StaticTickProc(tMsecs sys_time, void* pt)   {}
        virtual void                TickProc(tMsecs sys_time) = 0;
 
        const MIDITick*             tick_proc;
 
        tMsecs                      dev_time_offset;
        tMsecs                      sys_time_offset;
        std::recursive_mutex        proc_lock;
 
    private:
        const tPriority             priority;
        std::atomic<bool>           running;
};
 
#endif // TICK_H_INCLUDED