session_event.h

Go to the documentation of this file.

/*
    Copyright (C) 2012 Paul Davis 

    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., 675 Mass Ave, Cambridge, MA 02139, USA.

*/

#ifndef __ardour_session_event_h__
#define __ardour_session_event_h__

#include <list>
#include <boost/function.hpp>
#include <boost/shared_ptr.hpp>

#include "pbd/pool.h"
#include "pbd/ringbuffer.h"
#include "pbd/event_loop.h"

#include "ardour/libardour_visibility.h"
#include "ardour/types.h"

namespace ARDOUR {

class Slave;
class Region;

class LIBARDOUR_API SessionEvent {
public:
        enum Type {
                SetTransportSpeed,
                SetTrackSpeed,
                Locate,
                LocateRoll,
                LocateRollLocate,
                SetLoop,
                PunchIn,
                PunchOut,
                RangeStop,
                RangeLocate,
                Overwrite,
                SetSyncSource,
                Audition,
                InputConfigurationChange,
                SetPlayAudioRange,
                CancelPlayAudioRange,
                RealTimeOperation,
                AdjustPlaybackBuffering,
                AdjustCaptureBuffering,
                SetTimecodeTransmission,
                Skip,

                /* only one of each of these events can be queued at any one time */

                StopOnce,
                AutoLoop,
                AutoLoopDeclick,
        };

        enum Action {
                Add,
                Remove,
                Replace,
                Clear
        };

        Type       type;
        Action     action;
        framepos_t action_frame;
        framepos_t target_frame;
        double     speed;

        union {
                void*        ptr;
                bool         yes_or_no;
                framepos_t  target2_frame;
                Slave*       slave;
                Route*       route;
        };

        union {
                bool second_yes_or_no;
        };

        union {
                bool third_yes_or_no;
        };

        /* 4 members to handle a multi-group event handled in RT context */

        typedef boost::function<void (SessionEvent*)> RTeventCallback;

        boost::shared_ptr<RouteList> routes;    /* apply to */
        boost::function<void (void)> rt_slot;   /* what to call in RT context */
        RTeventCallback              rt_return; /* called after rt_slot, with this event as an argument */
        PBD::EventLoop*              event_loop;

        std::list<AudioRange> audio_range;
        std::list<MusicRange> music_range;

        boost::shared_ptr<Region> region;

        SessionEvent (Type t, Action a, framepos_t when, framepos_t where, double spd, bool yn = false, bool yn2 = false, bool yn3 = false);

        void set_ptr (void* p) {
                ptr = p;
        }

        bool before (const SessionEvent& other) const {
                return action_frame < other.action_frame;
        }

        bool after (const SessionEvent& other) const {
                return action_frame > other.action_frame;
        }

        static bool compare (const SessionEvent *e1, const SessionEvent *e2) {
                return e1->before (*e2);
        }

        void* operator new (size_t);
        void  operator delete (void *ptr, size_t /*size*/);

        static const framepos_t Immediate = -1;

        static void create_per_thread_pool (const std::string& n, uint32_t nitems);
        static void init_event_pool ();

        CrossThreadPool* event_pool() const { return own_pool; }
        
private:
        static PerThreadPool* pool;
        CrossThreadPool* own_pool;

        friend class Butler;
};

class SessionEventManager {
public:
        SessionEventManager () : pending_events (2048),
                                 auto_loop_event(0), punch_out_event(0), punch_in_event(0) {}
        virtual ~SessionEventManager() {}

        virtual void queue_event (SessionEvent *ev) = 0;
        void clear_events (SessionEvent::Type type);
        void clear_events (SessionEvent::Type type, boost::function<void (void)> after);

protected:
        RingBuffer<SessionEvent*> pending_events;
        typedef std::list<SessionEvent *> Events;
        Events           events;
        Events           immediate_events;
        Events::iterator next_event;

        /* there can only ever be one of each of these */

        SessionEvent *auto_loop_event;
        SessionEvent *punch_out_event;
        SessionEvent *punch_in_event;

        void dump_events () const;
        void merge_event (SessionEvent*);
        void replace_event (SessionEvent::Type, framepos_t action_frame, framepos_t target = 0);
        bool _replace_event (SessionEvent*);
        bool _remove_event (SessionEvent *);
        void _clear_event_type (SessionEvent::Type);

        void add_event (framepos_t action_frame, SessionEvent::Type type, framepos_t target_frame = 0);
        void remove_event (framepos_t frame, SessionEvent::Type type);

        virtual void process_event(SessionEvent*) = 0;
        virtual void set_next_event () = 0;
};

} /* namespace */

#endif /* __ardour_session_event_h__ */