feat: added support for Event Time Codes Frame (ETCO)

Author: MrCSharp22

src/TagLib/Id3v2/EventTimeCode.cs

@@ -0,0 +1,61 @@
+using System;
+using TagLib.Id3v2;
+
+namespace TagLib.Id3v2
+{
+	public class EventTimeCode : ICloneable
+	{
+		#region Private Properties
+
+		private EventType typeOfEvent;
+
+		private int time;
+
+		#endregion
+
+		#region Public Properties
+
+		public EventType TypeOfEvent
+		{
+			get { return typeOfEvent; }
+			set { typeOfEvent = value; }
+		}
+
+		public int Time
+		{
+			get { return time; }
+			set { time = value; }
+		}
+
+		#endregion
+
+		#region Public Constructors
+
+		public EventTimeCode(EventType typeOfEvent, 
+			int time)
+		{
+			this.typeOfEvent = typeOfEvent;
+			this.time = time;
+		}
+
+		#endregion
+
+		#region Static Methods
+
+		public static EventTimeCode CreateEmpty()
+		{
+			return new EventTimeCode(EventType.Padding, 0);
+		}
+
+		#endregion
+
+		#region ICloneable
+
+		public object Clone()
+		{
+			return new EventTimeCode(typeOfEvent, time);
+		}
+
+		#endregion
+	}
+}

src/TagLib/Id3v2/EventType.cs

@@ -0,0 +1,55 @@
+namespace TagLib.Id3v2
+{
+	public enum EventType
+	{
+		Padding = 0x00,
+
+		EndOfInitialSilence = 0x01,
+
+		IntroStart = 0x02,
+
+		MainPartStart = 0x03,
+
+		OutroStart = 0x04,
+
+		OutroEnd = 0x05,
+
+		VerseStart = 0x06,
+
+		RefrainStart = 0x07,
+
+		InterludeStart = 0x08,
+
+		ThemeStart = 0x09,
+
+		VariationStart = 0x0A,
+
+		KeyChange = 0x0B,
+
+		TimeChange = 0x0C,
+
+		MomentaryUnwantedNoise = 0x0D,
+
+		SustainedNoise = 0x0E,
+
+		SustainedNoiseEnd = 0x0F,
+
+		IntroEnd = 0x10,
+
+		MainPartEnd = 0x11,
+
+		VerseEnd = 0x12,
+
+		RefrainEnd = 0x13,
+
+		ThemeEnd = 0x14,
+
+		Profanity = 0x15,
+
+		ProfanityEnd = 0x16,
+
+		AudioEnd = 0xFD,
+
+		AudioFileEnd = 0xFE,
+	}
+}

src/TagLib/Id3v2/FrameFactory.cs

@@ -295,6 +295,10 @@ public static Frame CreateFrame (ByteVector data, File file,
 				return new UrlLinkFrame(data, position,
 					header, version);
 
+			if (header.FrameId == FrameType.ETCO)
+				return new EventTimeCodesFrame(data, offset, header,
+					version);
+
 			return new UnknownFrame (data, position, header,
 				version);
 		}

src/TagLib/Id3v2/FrameTypes.cs

@@ -93,5 +93,6 @@ internal static class FrameType {
 		public static readonly ReadOnlyByteVector WPAY = "WPAY";
 		public static readonly ReadOnlyByteVector WPUB = "WPUB";
 		public static readonly ReadOnlyByteVector WXXX = "WXXX";
+		public static readonly ReadOnlyByteVector ETCO = "ETCO";
 	}
 }

src/TagLib/Id3v2/Frames/EventTimeCodesFrame.cs

@@ -0,0 +1,168 @@
+using System.Collections.Generic;
+
+namespace TagLib.Id3v2
+{
+	public class EventTimeCodesFrame : Frame
+	{
+		#region Private Properties
+
+		private TimestampFormat timestampFormat;
+
+		private List<EventTimeCode> events;
+
+		#endregion
+
+		#region Constructors
+
+		public EventTimeCodesFrame() : base (FrameType.ETCO, 4)
+		{
+			Flags = FrameFlags.FileAlterPreservation;
+		}
+
+		public EventTimeCodesFrame(TimestampFormat timestampFormat) : base(FrameType.ETCO, 4)
+		{
+			this.timestampFormat = timestampFormat;
+			Flags = FrameFlags.FileAlterPreservation;
+		}
+
+		public EventTimeCodesFrame(ByteVector data, 
+			byte version) : base (data, version)
+		{
+			SetData(data, 0, version, true);
+		}
+
+		public EventTimeCodesFrame(FrameHeader frameHeader) : base (frameHeader)
+		{
+
+		}
+
+		public EventTimeCodesFrame(ByteVector data,
+								int offset,
+								FrameHeader header,
+								byte version) : base (header)
+		{
+			SetData(data, offset, version, false);
+		}
+
+		#endregion
+
+		#region Public Properties
+
+		public TimestampFormat TimestampFormat
+		{
+			get { return timestampFormat; }
+			set { timestampFormat = value; }
+		}
+
+		public List<EventTimeCode> Events
+		{
+			get { return events; }
+			set { events = value; }
+		}
+
+		#endregion
+
+		#region Public Static Methods
+
+		/// <summary>
+		///    Gets a play count frame from a specified tag, optionally
+		///    creating it if it does not exist.
+		/// </summary>
+		/// <param name="tag">
+		///    A <see cref="Tag" /> object to search in.
+		/// </param>
+		/// <param name="create">
+		///    A <see cref="bool" /> specifying whether or not to create
+		///    and add a new frame to the tag if a match is not found.
+		/// </param>
+		/// <returns>
+		///    A <see cref="EventTimeCodesFrame" /> object containing the
+		///    matching frame, or <see langword="null" /> if a match
+		///    wasn't found and <paramref name="create" /> is <see
+		///    langword="false" />.
+		/// </returns>
+		public static EventTimeCodesFrame Get(Tag tag, bool create)
+		{
+			EventTimeCodesFrame etco;
+			foreach (Frame frame in tag)
+			{
+				etco = frame as EventTimeCodesFrame;
+
+				if (etco != null)
+					return etco;
+			}
+
+			if (!create)
+				return null;
+
+			etco = new EventTimeCodesFrame();
+			tag.AddFrame(etco);
+			return etco;
+		}
+
+		#endregion
+
+		#region Protected Methods
+
+		protected override void ParseFields(ByteVector data, byte version)
+		{
+			events = new List<EventTimeCode>();
+			timestampFormat = (TimestampFormat)data.Data[0];
+
+			var incomingEventsData = data.Mid(1);
+			for (var i = 0; i < incomingEventsData.Count; i++)
+			{
+				var eventType = (EventType)incomingEventsData.Data[1];
+				i++;
+
+				var timestampData = new ByteVector(incomingEventsData.Data[i], 
+					incomingEventsData.Data[i+1],
+					incomingEventsData.Data[i+2],
+					incomingEventsData.Data[i+3]);
+
+				i += 3;
+
+				var timestamp = timestampData.ToInt();
+
+				events.Add(new EventTimeCode(eventType, timestamp));
+			}
+		}
+
+		protected override ByteVector RenderFields(byte version)
+		{
+			var data = new List<byte>();
+			data.Add((byte)timestampFormat);
+
+			foreach (var @event in events)
+			{
+				data.Add((byte)@event.TypeOfEvent);
+
+				var timeData = ByteVector.FromInt(@event.Time);
+				data.AddRange(timeData.Data);
+			}
+
+			return new ByteVector(data.ToArray());
+		}
+
+		#endregion
+
+		#region ICloneable
+
+		/// <summary>
+		///    Creates a deep copy of the current instance.
+		/// </summary>
+		/// <returns>
+		///    A new <see cref="Frame" /> object identical to the
+		///    current instance.
+		/// </returns>
+		public override Frame Clone()
+		{
+			var frame = new EventTimeCodesFrame(header);
+			frame.timestampFormat = timestampFormat;
+			frame.events = events.ConvertAll(item => (EventTimeCode)item.Clone());
+			return frame;
+		}
+
+		#endregion
+	}
+}

src/TagLib/Id3v2/Frames/SynchronizedLyricsFrame.cs

@@ -27,29 +27,6 @@
 
 namespace TagLib.Id3v2
 {
-	/// <summary>
-	///    Specifies the timestamp format used by a <see
-	///    cref="SynchronisedLyricsFrame" />.
-	/// </summary>
-	public enum TimestampFormat
-	{
-		/// <summary>
-		///    The timestamp is of unknown format.
-		/// </summary>
-		Unknown              = 0x00,
-		
-		/// <summary>
-		///    The timestamp represents the number of MPEG frames since
-		///    the beginning of the audio stream.
-		/// </summary>
-		AbsoluteMpegFrames   = 0x01,
-		
-		/// <summary>
-		///    The timestamp represents the number of milliseconds since
-		///    the beginning of the audio stream.
-		/// </summary>
-		AbsoluteMilliseconds = 0x02
-	}
 
 	/// <summary>
 	///    Specifies the type of text contained in a <see

src/TagLib/Id3v2/TimestampFormat.cs

@@ -0,0 +1,53 @@
+//
+// SynchronizedLyricsFrame.cs:
+//
+// Author:
+//   Brian Nickel ([email protected])
+//
+// Copyright (C) 2007 Brian Nickel
+//
+// This library is free software; you can redistribute it and/or modify
+// it  under the terms of the GNU Lesser General Public License version
+// 2.1 as published by the Free Software Foundation.
+//
+// This library 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 this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307
+// USA
+//
+
+using System;
+using System.Collections.Generic;
+using System.Text;
+
+namespace TagLib.Id3v2
+{
+	/// <summary>
+	///    Specifies the timestamp format used by a <see
+	///    cref="SynchronisedLyricsFrame" />.
+	/// </summary>
+	public enum TimestampFormat
+	{
+		/// <summary>
+		///    The timestamp is of unknown format.
+		/// </summary>
+		Unknown              = 0x00,
+		
+		/// <summary>
+		///    The timestamp represents the number of MPEG frames since
+		///    the beginning of the audio stream.
+		/// </summary>
+		AbsoluteMpegFrames   = 0x01,
+		
+		/// <summary>
+		///    The timestamp represents the number of milliseconds since
+		///    the beginning of the audio stream.
+		/// </summary>
+		AbsoluteMilliseconds = 0x02
+	}
+}