summaryrefslogtreecommitdiffstats
path: root/win/CS/HandBrake.Interop/HandBrakeInterop/Model/Scan/Subtitle.cs
blob: 03caf765fb39ee49c6a08ea74d7c4c7d744a7753 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
// --------------------------------------------------------------------------------------------------------------------
// <copyright file="Subtitle.cs" company="HandBrake Project (http://handbrake.fr)">
//   This file is part of the HandBrake source code - It may be used under the terms of the GNU General Public License.
// </copyright>
// <summary>
//   An object that represents a subtitle associated with a Title, in a DVD
// </summary>
// --------------------------------------------------------------------------------------------------------------------

namespace HandBrake.Interop.Model.Scan
{
    using HandBrake.Interop.HbLib;

    /// <summary>
	/// An object that represents a subtitle associated with a Title, in a DVD
	/// </summary>
	public class Subtitle
	{
		/// <summary>
		/// Gets or sets the track number of this Subtitle
		/// </summary>
		public int TrackNumber { get; set; }

		/// <summary>
		/// Gets or sets the language (if detected) of this Subtitle
		/// </summary>
		public string Language { get; set; }

		/// <summary>
		/// Gets or sets the Langauage Code.
		/// </summary>
		public string LanguageCode { get; set; }

		/// <summary>
		/// Gets or sets the subtitle source.
		/// </summary>
		public SubtitleSource SubtitleSource { get; set; }

		/// <summary>
		/// Gets or sets the subtitle source raw integer.
		/// </summary>
		public int SubtitleSourceInt { get; set; }

		/// <summary>
		/// Gets a value indicating whether the "forced only" flag can be set on this subtitle.
		/// </summary>
		public bool CanSetForcedOnly
		{
			get
			{
				return HBFunctions.hb_subtitle_can_force(this.SubtitleSourceInt) > 0;
			}
		}

		/// <summary>
		/// Gets a value indicating whether this subtitle can be burned into the picture.
		/// </summary>
		public bool CanBurn
		{
			get
			{
				return HBFunctions.hb_subtitle_can_burn(this.SubtitleSourceInt) > 0;
			}
		}

		/// <summary>
		/// Returns true if the subtitle can be passed through using the given muxer.
		/// </summary>
		/// <param name="muxer">The muxer ID.</param>
		/// <returns>True if the subtitle can be passed through.</returns>
		public bool CanPass(int muxer)
		{
			return HBFunctions.hb_subtitle_can_pass(this.SubtitleSourceInt, muxer) > 0;
		}

		/// <summary>
		/// Override of the ToString method to make this object easier to use in the UI
		/// </summary>
		/// <returns>A string formatted as: {track #} {language}</returns>
		public override string ToString()
		{
			return string.Format("{0} {1} ({2})", this.TrackNumber, this.Language, this.SubtitleSource);
		}

		/// <summary>
		/// Gets the display.
		/// </summary>
		public string Display
		{
			get
			{
				return this.ToString();
			}
		}
	}
}