// --------------------------------------------------------------------------------------------------------------------
//
// This file is part of the HandBrake source code - It may be used under the terms of the GNU General Public License.
//
//
// The Subtitles View Model
//
// --------------------------------------------------------------------------------------------------------------------
namespace HandBrakeWPF.ViewModels
{
using System.Collections.Generic;
using System.ComponentModel;
using System.IO;
using System.Linq;
using HandBrake.ApplicationServices.Services.Encode.Model;
using HandBrake.ApplicationServices.Services.Encode.Model.Models;
using HandBrake.ApplicationServices.Services.Scan.Model;
using HandBrake.ApplicationServices.Utilities;
using HandBrakeWPF.Model.Subtitles;
using HandBrakeWPF.Services.Presets.Model;
using HandBrakeWPF.ViewModels.Interfaces;
using Microsoft.Win32;
///
/// The Subtitles View Model
///
public class SubtitlesViewModel : ViewModelBase, ISubtitlesViewModel
{
#region Constants and Fields
///
/// The Foreign Audio Search Track
///
private readonly Subtitle ForeignAudioSearchTrack;
///
/// Backing field for the source subtitle tracks.
///
private IList sourceTracks;
///
/// The show defaults panel.
///
private bool showDefaultsPanel;
///
/// The audio behaviours.
///
private SubtitleBehaviours subtitleBehaviours;
///
/// The available languages.
///
private BindingList availableLanguages;
#endregion
#region Constructors and Destructors
///
/// Initializes a new instance of the class.
///
public SubtitlesViewModel()
{
this.Task = new EncodeTask();
this.Langauges = LanguageUtilities.MapLanguages().Keys;
this.CharacterCodes = CharCodesUtilities.GetCharacterCodes();
this.ForeignAudioSearchTrack = new Subtitle { SubtitleType = SubtitleType.ForeignAudioSearch, Language = "Foreign Audio Search (Bitmap)" };
this.SourceTracks = new List { this.ForeignAudioSearchTrack };
this.SubtitleBehaviours = new SubtitleBehaviours();
this.SelectedAvailableToMove = new BindingList();
this.SelectedLangaugesToMove = new BindingList();
this.availableLanguages = new BindingList();
this.SetupLanguages(null);
}
#endregion
#region Properties
///
/// Gets or sets CharacterCodes.
///
public IEnumerable CharacterCodes { get; set; }
///
/// Gets or sets Langauges.
///
public IEnumerable Langauges { get; set; }
///
/// Gets or sets SourceTracks.
///
public IList SourceTracks
{
get
{
return this.sourceTracks;
}
set
{
this.sourceTracks = value;
this.NotifyOfPropertyChange(() => this.SourceTracks);
}
}
///
/// Gets or sets Task.
///
public EncodeTask Task { get; set; }
///
/// Gets or sets a value indicating whether show defaults panel.
///
public bool ShowDefaultsPanel
{
get
{
return this.showDefaultsPanel;
}
set
{
if (value.Equals(this.showDefaultsPanel))
{
return;
}
this.showDefaultsPanel = value;
this.NotifyOfPropertyChange(() => this.ShowDefaultsPanel);
this.NotifyOfPropertyChange(() => this.PanelTitle);
this.NotifyOfPropertyChange(() => this.SwitchDisplayTitle);
}
}
///
/// Gets the panel title.
///
public string PanelTitle
{
get
{
return this.ShowDefaultsPanel ? "Subtitle Defaults" : "Subtitle Tracks";
}
}
///
/// Gets the switch display title.
///
public string SwitchDisplayTitle
{
get
{
return this.ShowDefaultsPanel ? "Switch Back To Tracks" : "Configure Defaults";
}
}
///
/// Gets or sets the subtitle behaviours.
///
public SubtitleBehaviours SubtitleBehaviours
{
get
{
return this.subtitleBehaviours;
}
set
{
if (Equals(value, this.subtitleBehaviours))
{
return;
}
this.subtitleBehaviours = value;
this.NotifyOfPropertyChange(() => this.SubtitleBehaviours);
}
}
///
/// Gets the sbutitle behaviour modes.
///
public BindingList SubtitleBehaviourModeList
{
get
{
return new BindingList(EnumHelper.GetEnumList().ToList());
}
}
///
/// Gets or sets AvailableLanguages.
///
public BindingList AvailableLanguages
{
get
{
return this.availableLanguages;
}
set
{
this.availableLanguages = value;
this.NotifyOfPropertyChange("AvailableLanguages");
}
}
///
/// Gets or sets SelectedLangauges.
///
public BindingList SelectedAvailableToMove { get; set; }
///
/// Gets or sets SelectedLangauges.
///
public BindingList SelectedLangaugesToMove { get; set; }
#endregion
#region Public Methods
///
/// Add a new Track
///
public void Add()
{
this.Add(null);
}
///
/// Add all closed captions not already on the list.
///
public void AddAllClosedCaptions()
{
foreach (Subtitle subtitle in this.SourceTitlesSubset(null).Where(s => s.SubtitleType == SubtitleType.CC))
{
this.Add(subtitle);
}
}
///
/// Add all the remaining subtitle tracks.
///
public void AddAllRemaining()
{
foreach (Subtitle subtitle in this.SourceTitlesSubset(null))
{
this.Add(subtitle);
}
}
///
/// Add all remaining tracks for the users preferred and selected languages
///
public void AddAllRemainingForSelectedLanguages()
{
// Translate to Iso Codes
List iso6392Codes = this.SubtitleBehaviours.SelectedLangauges.Contains(Constants.Any)
? LanguageUtilities.GetIsoCodes()
: LanguageUtilities.GetLanguageCodes(
this.SubtitleBehaviours.SelectedLangauges.ToArray());
List availableTracks =
this.SourceTracks.Where(subtitle => iso6392Codes.Contains(subtitle.LanguageCodeClean)).ToList();
foreach (Subtitle subtitle in this.SourceTitlesSubset(availableTracks))
{
this.Add(subtitle);
}
}
///
/// The add first for selected languages.
///
private void AddFirstForSelectedLanguages()
{
foreach (Subtitle sourceTrack in this.GetSelectedLanguagesTracks())
{
// Step 2: Check if the track list already contrains this track
bool found = this.Task.SubtitleTracks.Any(track => Equals(track.SourceTrack, sourceTrack));
if (!found)
{
// Check if we are already using this language
bool foundLanguage = false;
Subtitle track = sourceTrack;
foreach (var item in this.Task.SubtitleTracks)
{
if (item.SourceTrack != null && item.SourceTrack.LanguageCode != null && track.LanguageCode.Contains(item.SourceTrack.LanguageCode))
{
foundLanguage = true;
}
}
if (foundLanguage)
{
continue;
}
// If it doesn't, add it.
this.Add(sourceTrack);
}
}
}
///
/// Import an SRT File.
///
public void Import()
{
OpenFileDialog dialog = new OpenFileDialog
{
Filter = "SRT files (*.srt)|*.srt",
CheckFileExists = true,
Multiselect = true
};
dialog.ShowDialog();
foreach (var srtFile in dialog.FileNames)
{
SubtitleTrack track = new SubtitleTrack
{
SrtFileName = Path.GetFileNameWithoutExtension(srtFile),
SrtOffset = 0,
SrtCharCode = "UTF-8",
SrtLang = "English",
SubtitleType = SubtitleType.SRT,
SrtPath = srtFile
};
this.Task.SubtitleTracks.Add(track);
}
}
///
/// Remove a Track
///
///
/// The track.
///
public void Remove(SubtitleTrack track)
{
this.Task.SubtitleTracks.Remove(track);
}
///
/// Clear all Tracks
///
public void Clear()
{
this.Task.SubtitleTracks.Clear();
}
///
/// Select the default subtitle track.
///
///
/// The subtitle.
///
public void SelectDefaultTrack(SubtitleTrack subtitle)
{
foreach (SubtitleTrack track in this.Task.SubtitleTracks)
{
if (track == subtitle)
{
continue; // Skip the track the user selected.
}
track.Default = false;
}
this.NotifyOfPropertyChange(() => this.Task);
}
///
/// Select the burned in track.
///
///
/// The subtitle.
///
public void SetBurnedToFalseForAllExcept(SubtitleTrack subtitle)
{
foreach (SubtitleTrack track in this.Task.SubtitleTracks)
{
if (track == subtitle)
{
continue; // Skip the track the user selected.
}
track.Burned = false;
}
this.NotifyOfPropertyChange(() => this.Task);
}
///
/// Automatic Subtitle Selection based on user preferences.
///
public void AutomaticSubtitleSelection()
{
this.Task.SubtitleTracks.Clear();
// Add Foreign Audio Scan
if (this.SubtitleBehaviours.AddForeignAudioScanTrack)
{
this.Add(ForeignAudioSearchTrack);
}
// Add Track Behaviours
switch (this.SubtitleBehaviours.SelectedBehaviour)
{
case SubtitleBehaviourModes.FirstMatch: // Adding all remaining tracks
this.AddFirstForSelectedLanguages();
break;
case SubtitleBehaviourModes.AllMatching: // Add Langauges tracks for the additional languages selected, in-order.
this.AddAllRemainingForSelectedLanguages();
break;
}
// Add all closed captions if enabled.
if (this.SubtitleBehaviours.AddClosedCaptions)
{
this.AddAllClosedCaptions();
}
}
///
/// Open the options screen to the Audio and Subtitles tab.
///
public void SetDefaultBehaviour()
{
this.ShowDefaultsPanel = true;
}
///
/// The show audio defaults.
///
public void ShowSubtitleDefaultsPanel()
{
this.ShowDefaultsPanel = !this.ShowDefaultsPanel;
}
///
/// Audio List Move Left
///
public void LanguageMoveRight()
{
if (this.SelectedAvailableToMove.Count > 0)
{
List copiedList = SelectedAvailableToMove.ToList();
foreach (string item in copiedList)
{
this.AvailableLanguages.Remove(item);
this.SubtitleBehaviours.SelectedLangauges.Add(item);
}
this.AvailableLanguages = new BindingList(this.AvailableLanguages.OrderBy(o => o).ToList());
}
}
///
/// Audio List Move Right
///
public void LanguageMoveLeft()
{
if (this.SelectedLangaugesToMove.Count > 0)
{
List copiedList = SelectedLangaugesToMove.ToList();
foreach (string item in copiedList)
{
this.SubtitleBehaviours.SelectedLangauges.Remove(item);
this.AvailableLanguages.Add(item);
}
}
this.AvailableLanguages = new BindingList(this.AvailableLanguages.OrderBy(o => o).ToList());
}
///
/// Language List Clear all selected languages
///
public void LanguageClearAll()
{
foreach (string item in this.SubtitleBehaviours.SelectedLangauges)
{
this.AvailableLanguages.Add(item);
}
this.AvailableLanguages = new BindingList(this.AvailableLanguages.OrderBy(o => o).ToList());
this.SubtitleBehaviours.SelectedLangauges.Clear();
}
#endregion
#region Implemented Interfaces
///
/// Setup this tab for the specified preset.
///
///
/// The preset.
///
///
/// The task.
///
public void SetPreset(Preset preset, EncodeTask task)
{
// Note, We don't support Subtitles in presets yet.
this.Task = task;
this.NotifyOfPropertyChange(() => this.Task);
this.SetupLanguages(preset);
this.AutomaticSubtitleSelection();
}
///
/// Update all the UI controls based on the encode task passed in.
///
///
/// The task.
///
public void UpdateTask(EncodeTask task)
{
this.Task = task;
this.NotifyOfPropertyChange(() => this.Task.SubtitleTracks);
this.NotifyOfPropertyChange(() => this.Task);
}
///
/// Setup this window for a new source
///
///
/// The source.
///
///
/// The title.
///
///
/// The preset.
///
///
/// The task.
///
public void SetSource(Source source, Title title, Preset preset, EncodeTask task)
{
this.SourceTracks.Clear();
this.SourceTracks.Add(ForeignAudioSearchTrack);
foreach (Subtitle subtitle in title.Subtitles)
{
this.SourceTracks.Add(subtitle);
}
this.Task = task;
this.NotifyOfPropertyChange(() => this.Task);
this.AutomaticSubtitleSelection();
}
#endregion
#region Methods
///
/// Add a subtitle track.
/// The Source track is set based on the following order. If null, it will skip to the next option.
/// 1. Passed in Subitle param
/// 2. First preferred Subtitle from source
/// 3. First subtitle from source.
/// Will not add a subtitle if the source has none.
///
///
/// The subtitle. Use null to add preferred, or first from source (based on user preference)
///
private void Add(Subtitle subtitle)
{
Subtitle source = subtitle
?? ((this.SourceTracks != null)
? (this.SourceTracks.FirstOrDefault(l => l.Language == this.GetPreferredSubtitleTrackLanguage())
?? this.SourceTracks.FirstOrDefault(
s => s.SubtitleType != SubtitleType.ForeignAudioSearch))
: null);
if (source == null)
{
source = ForeignAudioSearchTrack;
}
SubtitleTrack track = new SubtitleTrack
{
SubtitleType = SubtitleType.VobSub,
SourceTrack = source,
};
if ((source.SubtitleType == SubtitleType.PGS || source.SubtitleType == SubtitleType.ForeignAudioSearch)
&& this.Task != null
&& this.Task.OutputFormat == OutputFormat.Mp4)
{
if (track.CanBeBurned)
{
track.Burned = true;
this.SetBurnedToFalseForAllExcept(track);
}
}
var encodeTask = this.Task;
if (encodeTask != null)
{
encodeTask.SubtitleTracks.Add(track);
}
}
///
/// Gets a list of source tracks for the users selected languages.
///
///
/// A list of source subtitle tracks.
///
private IEnumerable GetSelectedLanguagesTracks()
{
List trackList = new List();
List isoCodes = this.SubtitleBehaviours.SelectedLangauges.Contains(Constants.Any)
? LanguageUtilities.GetIsoCodes()
: LanguageUtilities.GetLanguageCodes(
this.SubtitleBehaviours.SelectedLangauges.ToArray());
foreach (string code in isoCodes)
{
trackList.AddRange(this.SourceTracks.Where(source => source.LanguageCode == code));
}
return trackList;
}
///
/// The get preferred subtitle track, or the first if none available.
///
///
/// The users preferred language, or the first if none available.
///
private string GetPreferredSubtitleTrackLanguage()
{
return this.SubtitleBehaviours.SelectedLangauges.FirstOrDefault(w => w != Constants.Any);
}
///
/// Gets a list of Source subtitle tracks that are not currently used.
///
///
/// The subtitles. (Optional). If null, works on the full source subtitle collection
///
///
/// An IEnumerable collection of subtitles
///
private IEnumerable SourceTitlesSubset(IEnumerable subtitles)
{
return subtitles != null
? subtitles.Where(subtitle => !this.Task.SubtitleTracks.Any(track => Equals(track.SourceTrack, subtitle))).ToList()
: this.SourceTracks.Where(subtitle => !this.Task.SubtitleTracks.Any(track => Equals(track.SourceTrack, subtitle))).ToList();
}
///
/// The setup languages.
///
///
/// The preset.
///
private void SetupLanguages(Preset preset)
{
// Step 1, Set the behaviour mode
this.SubtitleBehaviours.SelectedBehaviour = SubtitleBehaviourModes.None;
this.SubtitleBehaviours.AddClosedCaptions = false;
this.SubtitleBehaviours.AddForeignAudioScanTrack = false;
this.SubtitleBehaviours.SelectedLangauges.Clear();
// Step 2, Get all the languages
IDictionary langList = LanguageUtilities.MapLanguages();
langList = (from entry in langList orderby entry.Key ascending select entry).ToDictionary(pair => pair.Key, pair => pair.Value);
// Step 3, Setup Available Languages
this.AvailableLanguages.Clear();
foreach (string item in langList.Keys)
{
this.AvailableLanguages.Add(item);
}
// Step 4, Set the Selected Languages
if (preset != null && preset.SubtitleTrackBehaviours != null)
{
this.SubtitleBehaviours.SelectedBehaviour = preset.SubtitleTrackBehaviours.SelectedBehaviour;
this.SubtitleBehaviours.AddClosedCaptions = preset.SubtitleTrackBehaviours.AddClosedCaptions;
this.SubtitleBehaviours.AddForeignAudioScanTrack = preset.SubtitleTrackBehaviours.AddForeignAudioScanTrack;
foreach (string selectedItem in preset.SubtitleTrackBehaviours.SelectedLangauges)
{
this.AvailableLanguages.Remove(selectedItem);
this.SubtitleBehaviours.SelectedLangauges.Add(selectedItem);
}
}
}
#endregion
}
}