LabelTrack.h

Go to the documentation of this file.

/**********************************************************************
 
  Audacity: A Digital Audio Editor
 
  LabelTrack.h
 
  Dominic Mazzoni
  James Crook
  Jun Wan
 
**********************************************************************/
 
#ifndef _LABELTRACK_
#define _LABELTRACK_
 
#include "SelectedRegion.h"
#include "Track.h"
#include "FileNames.h"
 
class wxTextFile;
 
class AudacityProject;
class TimeWarper;
 
class LabelTrack;
struct LabelTrackHit;
struct TrackPanelDrawingContext;
 
enum class LabelFormat
{
   TEXT,
   SUBRIP,
   WEBVTT,
};
 
class AUDACITY_DLL_API LabelStruct
{
public:
   LabelStruct() = default;
   // Copies region
   LabelStruct(const SelectedRegion& region, const wxString &aTitle);
   // Copies region but then overwrites other times
   LabelStruct(const SelectedRegion& region, double t0, double t1,
               const wxString &aTitle);
   const SelectedRegion &getSelectedRegion() const { return selectedRegion; }
   double getDuration() const { return selectedRegion.duration(); }
   double getT0() const { return selectedRegion.t0(); }
   double getT1() const { return selectedRegion.t1(); }
   // Returns true iff the label got inverted:
   bool AdjustEdge( int iEdge, double fNewTime);
   void MoveLabel( int iEdge, double fNewTime);
 
   struct BadFormatException {};
   static LabelStruct Import(wxTextFile &file, int &index, LabelFormat format);
 
   void Export(wxTextFile &file, LabelFormat format, int index) const;
 
   enum TimeRelations
   {
       BEFORE_LABEL,
       AFTER_LABEL,
       SURROUNDS_LABEL,
       WITHIN_LABEL,
       BEGINS_IN_LABEL,
       ENDS_IN_LABEL
   };
 
   TimeRelations RegionRelation(double reg_t0, double reg_t1,
                                const LabelTrack *parent = NULL) const;
 
public:
   SelectedRegion selectedRegion;
   wxString title; 
   mutable int width{}; 
 
// Working storage for on-screen layout.
   mutable int x{};     
   mutable int x1{};    
   mutable int xText{}; 
   mutable int y{};     
 
   bool updated{};                  
};
 
using LabelArray = std::vector<LabelStruct>;
 
class AUDACITY_DLL_API LabelTrack final
   : public UniqueChannelTrack<>
   , public Observer::Publisher<struct LabelTrackEvent>
{
 public:
   static wxString GetDefaultName();
 
   // Construct and also build all attachments
   static LabelTrack *New(AudacityProject &project);
 
   static LabelTrack* Create(TrackList& trackList, const wxString& name);
 
   static LabelTrack* Create(TrackList& trackList);
 
   LabelTrack();
   LabelTrack(const LabelTrack &orig, ProtectedCreationArg&&);
 
   virtual ~ LabelTrack();
 
   void SetLabel( size_t iLabel, const LabelStruct &newLabel );
 
   void MoveTo(double dOffset) override;
 
   void SetSelected(bool s) override;
 
   using Holder = std::shared_ptr<LabelTrack>;
 
   static const FileNames::FileType SubripFiles;
   static const FileNames::FileType WebVTTFiles;
 
private:
   Track::Holder Clone(bool backup) const override;
 
public:
   bool HandleXMLTag(const std::string_view& tag, const AttributesList& attrs) override;
   XMLTagHandler *HandleXMLChild(const std::string_view& tag) override;
   void WriteXML(XMLWriter &xmlFile) const override;
 
   Track::Holder Cut(double t0, double t1) override;
   Track::Holder Copy(double t0, double t1, bool forClipboard = true)
      const override;
   void Clear(double t0, double t1) override;
   void Paste(double t, const Track &src) override;
   bool Repeat(double t0, double t1, int n);
   void SyncLockAdjust(double oldT1, double newT1) override;
 
   void
   Silence(double t0, double t1, ProgressReporter reportProgress = {}) override;
   void InsertSilence(double t, double len) override;
 
   static LabelFormat FormatForFileName(const wxString & fileName);
   void Import(wxTextFile & f, LabelFormat format);
   void Export(wxTextFile & f, LabelFormat format) const;
 
   int GetNumLabels() const;
   const LabelStruct *GetLabel(int index) const;
   const LabelArray &GetLabels() const { return mLabels; }
 
   void OnLabelAdded( const wxString &title, int pos );
   //This returns the index of the label we just added.
   int AddLabel(const SelectedRegion &region, const wxString &title);
 
   //This deletes the label at given index.
   void DeleteLabel(int index);
 
   // This pastes labels without shifting existing ones
   bool PasteOver(double t, const Track &src);
 
   // PRL:  These functions were not used because they were not overrides!  Was that right?
   //Track::Holder SplitCut(double b, double e) /* not override */;
   //bool SplitDelete(double b, double e) /* not override */;
 
   void ShiftLabelsOnInsert(double length, double pt);
   void ChangeLabelsOnReverse(double b, double e);
   void ScaleLabels(double b, double e, double change);
   double AdjustTimeStampOnScale(double t, double b, double e, double change);
   void WarpLabels(const TimeWarper &warper);
 
   // Returns tab-separated text of all labels completely within given region
   wxString GetTextOfLabels(double t0, double t1) const;
 
   int FindNextLabel(const SelectedRegion& currentSelection);
   int FindPrevLabel(const SelectedRegion& currentSelection);
 
   const TypeInfo &GetTypeInfo() const override;
   static const TypeInfo &ClassTypeInfo();
 
   Track::Holder PasteInto(AudacityProject &project, TrackList &list)
      const override;
 
   struct Interval final : WideChannelGroupInterval {
      Interval(const LabelTrack &track, size_t index
      )  : mpTrack{ track.SharedPointer<const LabelTrack>() }
         , index{ index }
      {}
 
      ~Interval() override;
      double Start() const override;
      double End() const override;
      size_t NChannels() const override;
      std::shared_ptr<ChannelInterval> DoGetChannel(size_t iChannel) override;
 
      size_t index;
   private:
      const std::shared_ptr<const LabelTrack> mpTrack;
   };
   std::shared_ptr<Interval> MakeInterval(size_t index);
 
public:
   void SortLabels();
 
   size_t NIntervals() const override;
 
private:
   std::shared_ptr<WideChannelGroupInterval> DoGetInterval(size_t iInterval)
      override;
 
   LabelArray mLabels;
 
   // Set in copied label tracks
   double mClipLen;
 
   int miLastLabel;                 // used by FindNextLabel and FindPrevLabel
};
 
ENUMERATE_TRACK_TYPE(LabelTrack);
 
struct LabelTrackEvent
{
   enum Type {
      Addition,
      Deletion,
      Permutation,
      Selection,
   } type;
 
   const std::weak_ptr<Track> mpTrack;
 
   // invalid for selection events
   wxString mTitle;
 
   // invalid for addition and selection events
   int mFormerPosition;
 
   // invalid for deletion and selection events
   int mPresentPosition;
 
   LabelTrackEvent( Type type, const std::shared_ptr<LabelTrack> &pTrack,
      const wxString &title,
      int formerPosition,
      int presentPosition)
   : type{ type }
   , mpTrack{ pTrack }
   , mTitle{ title }
   , mFormerPosition{ formerPosition }
   , mPresentPosition{ presentPosition }
   {}
};
 
#endif