//=========================================================
//  MusE
//  Linux Music Editor
//  $Id: event.h,v 1.7.2.4 2009/12/20 05:00:35 terminator356 Exp $
//
//  (C) Copyright 1999-2004 Werner Schweer (ws@seh.de)
//
//  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; 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 __EVENT_H__
#define __EVENT_H__

#include <QString>

#include <map>
#include <set>
#include <sys/types.h>
#include <sndfile.h>

#include "type_defs.h"
#include "pos.h"
#include "mpevent.h"
#include "wave.h"
#include "config.h"

namespace MusECore {


// Forward declarations:
class EventBase;
class Part;
class Xml;
class Fifo;

//---------------------------------------------------------
//   Event
//---------------------------------------------------------

class Event {
      EventBase* ev;

   public:
      Event();
      Event(EventType t);
      Event(const Event& e); // Creates a true shared clone of the event. They share the same event base pointer.
      Event(EventBase* eb);  // Wraps an event base in an event and increases the event base's ref count.
      
      virtual ~Event();

      MidiPlayEvent asMidiPlayEvent(unsigned time, int port, int channel) const;
      
      bool empty() const;
      EventType type() const;
      // Shared and non-shared clone events have the same id. An empty event returns MUSE_INVALID_EVENT_ID.
      EventID_t id() const; 
      void shareId(const Event& e); // Makes id same as given event's. Effectively makes the events non-shared clones.

      void setType(EventType t);
      Event& operator=(const Event& e); // Makes the two events true shared clones. They share the same event base pointer.
      
      virtual void assign(const Event&); // Assigns to this event, excluding the id. Including its clones.
      
      bool operator==(const Event& e) const;
      bool isSimilarTo(const Event& other) const;
      bool isSimilarType(const Event&,
                              bool compareTime = false,
                              bool compareA = false, bool compareB = false, bool compareC = false,
                              bool compareWavePath = false, bool compareWavePos = false, bool compareWaveStartPos = false) const;
      
      int getRefCount() const;
      bool selected() const;
      void setSelected(bool val);
      void move(int offset);

      void read(Xml& xml);
      void write(int a, Xml& xml, const Pos& offset, bool ForceWavePaths = false) const;
      void dump(int n = 0) const;
      // Creates a non-shared clone of the event base, having the same 'group' id.
      // NOTE: Certain pointer members may still be SHARED. Such as the sysex MidiEventBase::edata.
      //       Be aware when iterating or modifying clones.
      Event clone() const; 
      
      // Restores id to original uniqueId, removing the event from any clone 'group'. 
      void deClone(); 
      // Creates a copy of the event base, excluding the 'group' _id. 
      Event duplicate() const; 

      Event mid(unsigned a, unsigned b) const;

      bool isNote() const;
      bool isNoteOff() const;
      bool isNoteOff(const Event& e) const;
      int dataA() const;
      int pitch() const;
      void setA(int val);
      void setPitch(int val);
      int dataB() const;
      int velo() const;
      void setB(int val);
      void setVelo(int val);
      int dataC() const;
      int veloOff() const;
      void setC(int val);
      void setVeloOff(int val);

      const unsigned char* data() const;
      int dataLen() const;
      void setData(const unsigned char* data, int len);
      const EvData eventData() const;

      const QString name() const;
      void setName(const QString& s);
      int spos() const;
      void setSpos(int s);
      MusECore::SndFileR sndFile() const;
      virtual void setSndFile(MusECore::SndFileR& sf);
      
      virtual void readAudio(unsigned offset, float** bpp, int channels, int nn, bool doSeek, bool overwrite);
      virtual void seekAudio(sf_count_t offset);
      virtual Fifo* audioPrefetchFifo();
      virtual void prefetchAudio(Part* part, sf_count_t frames);
      
      //--------------------------------------------------------
      // 'Agnostic' position methods - can be TICKS and FRAMES.
      //--------------------------------------------------------

      Pos pos() const;
      void setPos(const Pos& p);
      Pos end() const;
      PosLen posLen() const;
      
      unsigned posValue() const;
      unsigned posValue(Pos::TType time_type) const;
      void setPosValue(unsigned val);
      void setPosValue(unsigned val, Pos::TType time_type);
      
      unsigned lenValue() const;
      unsigned lenValue(Pos::TType time_type) const;
      void setLenValue(unsigned val);
      void setLenValue(unsigned val, Pos::TType time_type);     
      
      unsigned endPosValue() const;
      
      //--------------------------------------------------------
      // 'Resolving' position methods - must be TICKS or FRAMES.
      //--------------------------------------------------------

      unsigned tick() const;
      void setTick(unsigned val);
      unsigned frame() const;
      void setFrame(unsigned val);
      
      unsigned lenTick() const;
      void setLenTick(unsigned val);
      unsigned lenFrame() const;
      void setLenFrame(unsigned val);
      
      unsigned endTick() const;
      unsigned endFrame() const;
      };

typedef std::pair<int /*ctl num*/, PosLen /*range*/> FindMidiCtlsPair_t;
typedef std::map<int /*ctl num*/, PosLen /*range*/, std::less<int> > FindMidiCtlsList_t;
typedef FindMidiCtlsList_t::iterator iFindMidiCtlsList;
typedef FindMidiCtlsList_t::const_iterator ciFindMidiCtlsList;
typedef std::pair <iFindMidiCtlsList, bool> FindMidiCtlsListInsResPair_t;

#ifdef ALLOW_LEFT_HIDDEN_EVENTS
// NOTE: Signed integer comparison (at least) to support sorting negative event times.
//       Really need to change the whole thing to signed.
typedef std::multimap <unsigned, Event, std::less<int> > EL;
#else
typedef std::multimap <unsigned, Event, std::less<unsigned> > EL;
#endif

typedef EL::iterator iEvent;
typedef EL::const_iterator ciEvent;
typedef std::pair <ciEvent, ciEvent> cEventRange;
typedef std::pair <iEvent, iEvent> EventRange;

//---------------------------------------------------------
//   EventList
//    tick sorted list of events
//---------------------------------------------------------

class EventList : public EL {

   public:
      // Looks for specific event (EventBase pointer).
      ciEvent find(const Event&) const;
      iEvent find(const Event&);
      
      // Looks for events with identical values, but not necessarily EventBase pointers.
      ciEvent findSimilar(const Event&) const;
      iEvent findSimilar(const Event&);
      
      // Looks for events with identical type, and identical note or controller number, or
      //  sysex or meta length and identical data, or wave path and start position and event position.
      // Adds found items to the given list. Does not clear the list first. Returns the number of items added.
      int findSimilarType(const Event&, EventList&,
                              bool compareTime = false,
                              bool compareA = false, bool compareB = false, bool compareC = false,
                              bool compareWavePath = false, bool compareWavePos = false, bool compareWaveStartPos = false) const;
      
      ciEvent findId(const Event&) const;             // Fast, index t is known.
      iEvent findId(const Event&);                    // Fast, index t is known.
      ciEvent findId(unsigned t, EventID_t id) const; // Fast, index t is known.
      iEvent findId(unsigned t, EventID_t id);        // Fast, index t is known.
      ciEvent findId(EventID_t id) const;             // Slow, index t is not known
      iEvent findId(EventID_t id);                    // Slow, index t is not known
      ciEvent findWithId(const Event&) const; // Finds event base or event id. Fast, index t is known.
      iEvent findWithId(const Event&);        // Finds event base or event id. Fast, index t is known.

      // Returns an iterator that points to the inserted event.
      // Returns end() if an error occurred.
      // REMOVE Tim. Ctrl. Added comment.
      // NOTE: It is FORBIDDEN to have multiple controller events at the same time with the same controller number.
      // To preserve speed, we RELY on catching that at higher levels like the add event dialog or during song loading.
      // See detailed comments in add().
      iEvent add(Event event);
      void move(Event& event, unsigned tick);
      void dump() const;
      void read(Xml& xml, const char* name, bool midi);
      
      // Returns the exents of the contents of the list, as a PosLen.
      // If wave is true it only looks at wave events, otherwise it
      //  only looks at midi events. It also looks only for relevant.
      // If ctrlNum is not -1, it looks only for that controller number.
      // The returned PosLen is in units of frames or ticks respective of wave.
      // numEvents indicates the number of events found and whether PosLen is valid.
      PosLen evrange(bool wave, RelevantSelectedEvents_t relevant, int* numEvents, int ctrlNum = -1) const;
      // Fills set with the different controller numbers found in the event list.
      // Looks for midi controller events, or wave controller events if wave is true (does nothing ATM).
      // If findCtl is given it finds that specific controller.
      // Otherwise if findCtl -1 it finds all controllers.
      void findControllers(bool wave, FindMidiCtlsList_t* outList, int findCtl = -1) const;
      // REMOVE Tim. ctrl. Added.
      // If event is a controller, returns an iterator to the event if found, otherwise returns end.
      // Note: It is FORBIDDEN to have multiple controller events at the same time with the same controller number.
      ciEvent findControllerAt(const Event& event) const;
      iEvent findControllerAt(const Event& event);
      // REMOVE Tim. ctrl. Added.
      // Returns true if the event is a controller event and its controller number
      //  already exists at the given time, regardless of value.
      bool controllerValueExists(const Event& event) const;
      };

} // namespace MusECore

#endif

