// --------------------------------------------------------------------------------------------------------------------
//
// This file is part of the HandBrake source code - It may be used under the terms of the GNU General Public License.
//
//
// The Audio View Model
//
// --------------------------------------------------------------------------------------------------------------------
namespace HandBrakeWPF.ViewModels
{
using System;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Collections.Specialized;
using System.Linq;
using Caliburn.Micro;
using HandBrake.ApplicationServices.Model;
using HandBrake.ApplicationServices.Model.Encoding;
using HandBrake.ApplicationServices.Parsing;
using HandBrake.ApplicationServices.Services.Interfaces;
using HandBrake.ApplicationServices.Utilities;
using HandBrake.Interop.Model.Encoding;
using HandBrakeWPF.Commands;
using HandBrakeWPF.Model;
using HandBrakeWPF.ViewModels.Interfaces;
///
/// The Audio View Model
///
public class AudioViewModel : ViewModelBase, IAudioViewModel
{
///
/// Backing field for the source tracks list.
///
private IEnumerable sourceTracks;
private Preset currentPreset;
#region Constructors and Destructors
///
/// Initializes a new instance of the class.
///
///
/// The window manager.
///
///
/// The user Setting Service.
///
public AudioViewModel(IWindowManager windowManager, IUserSettingService userSettingService)
{
this.Task = new EncodeTask();
this.SampleRates = new ObservableCollection { "Auto", "48", "44.1", "32", "24", "22.05", "16", "12", "11.025", "8" };
this.AudioEncoders = EnumHelper.GetEnumList();
this.AudioMixdowns = EnumHelper.GetEnumList();
this.SourceTracks = new List();
}
#endregion
#region Properties
///
/// Gets or sets AudioBitrates.
///
public IEnumerable AudioBitrates { get; set; }
///
/// Gets or sets AudioEncoders.
///
public IEnumerable AudioEncoders { get; set; }
///
/// Gets or sets AudioMixdowns.
///
public IEnumerable AudioMixdowns { get; set; }
///
/// Gets or sets SampleRates.
///
public IEnumerable SampleRates { get; set; }
///
/// Gets or sets SourceTracks.
///
public IEnumerable SourceTracks
{
get
{
return this.sourceTracks;
}
set
{
this.sourceTracks = value;
this.NotifyOfPropertyChange(() => this.SourceTracks);
}
}
///
/// Gets or sets the EncodeTask.
///
public EncodeTask Task { get; set; }
///
/// Gets a value indicating whether ShowPassthruOptions.
///
public bool ShowPassthruOptions
{
get
{
return this.UserSettingService.GetUserSetting(UserSettingConstants.ShowAdvancedAudioPassthruOpts);
}
}
#endregion
#region Public Methods
///
/// Add an Audio Track
///
public void Add()
{
// Add the first track if available.
this.Add(null);
}
///
/// The add all remaining.
///
public void AddAllRemaining()
{
this.AddAllRemainingTracks();
}
///
/// Remove the Selected Track
///
///
/// The track.
///
public void Remove(AudioTrack track)
{
this.Task.AudioTracks.Remove(track);
}
///
/// Clear out the Audio Tracks
///
public void Clear()
{
this.Task.AudioTracks.Clear();
}
///
/// Trigger a Notify Property Changed on the Task to force various UI elements to update.
///
public void RefreshTask()
{
this.NotifyOfPropertyChange(() => this.Task);
if (Task.OutputFormat == OutputFormat.Mp4)
{
foreach (AudioTrack track in this.Task.AudioTracks.Where(track => track.Encoder == AudioEncoder.ffflac || track.Encoder == AudioEncoder.Vorbis))
{
track.Encoder = AudioEncoder.ffaac;
}
}
}
///
/// Open the options screen to the Audio and Subtitles tab.
///
public void SetDefaultBehaviour()
{
OpenOptionsScreenCommand command = new OpenOptionsScreenCommand();
command.Execute(OptionsTab.AudioAndSubtitles);
}
#endregion
#region Implemented Interfaces
#region ITabInterface
///
/// Setup this tab for the specified preset.
///
///
/// The preset.
///
///
/// The task.
///
public void SetPreset(Preset preset, EncodeTask task)
{
this.Task = task;
this.currentPreset = preset;
if (preset != null && preset.Task != null)
{
this.AddTracksFromPreset(preset);
this.Task.AllowedPassthruOptions = new AllowedPassthru(preset.Task.AllowedPassthruOptions);
}
this.NotifyOfPropertyChange(() => this.Task);
}
///
/// Update all the UI controls based on the encode task passed in.
///
///
/// The task.
///
public void UpdateTask(EncodeTask task)
{
this.Task = task;
this.NotifyOfPropertyChange(() => Task.AudioTracks);
this.NotifyOfPropertyChange(() => this.Task);
}
///
/// Set the Source Title
///
///
/// The title.
///
///
/// The preset.
///
///
/// The task.
///
public void SetSource(Title title, Preset preset, EncodeTask task)
{
this.SourceTracks = title.AudioTracks;
// Only reset the audio tracks if we have none, or if the task is null.
if (this.Task == null || this.Task.AudioTracks.Count == 0)
{
this.SetPreset(preset, task);
}
// If there are no source tracks, clear the list, otherwise try to Auto-Select the correct tracks
if (this.SourceTracks == null || !this.SourceTracks.Any())
{
this.Task.AudioTracks.Clear();
}
else
{
this.AutomaticTrackSelection();
}
// Force UI Updates
this.NotifyOfPropertyChange(() => this.Task);
}
#endregion
#endregion
#region Methods
///
/// Add the specified source track, or the first track in the SourceTracks collection if available.
///
///
/// The source track.
///
private void Add(Audio sourceTrack)
{
if (this.SourceTracks != null)
{
Audio track = sourceTrack ?? this.GetPreferredAudioTrack();
if (track != null)
{
this.Task.AudioTracks.Add(new AudioTrack { ScannedTrack = track });
}
}
}
///
/// Add all source tracks that don't currently exist on the list.
///
private void AddAllRemainingTracks()
{
// For all the source audio tracks
foreach (Audio sourceTrack in this.SourceTracks)
{
// Step 1: If "Add only One per language" is turned on, check to see if this language is already added.
if (this.CanSkipSourceTrack(sourceTrack))
{
continue;
}
// Step 2: Check if the track list already contrains this track
bool found = this.Task.AudioTracks.Any(audioTrack => Equals(audioTrack.ScannedTrack, sourceTrack));
if (!found)
{
// If it doesn't, add it.
this.Add(sourceTrack);
}
}
}
///
/// Add all remaining for selected languages.
///
public void AddAllRemainingForSelectedLanguages()
{
// Add them if they are not already added.
foreach (Audio sourceTrack in this.GetSelectedLanguagesTracks())
{
// Step 1: If "Add only One per language" is turned on, check to see if this language is already added.
if (this.CanSkipSourceTrack(sourceTrack))
{
continue;
}
// Step 2: Check if the track list already contrains this track
bool found = this.Task.AudioTracks.Any(audioTrack => Equals(audioTrack.ScannedTrack, sourceTrack));
if (!found)
{
// If it doesn't, add it.
this.Add(sourceTrack);
}
}
}
///
/// Add the required tracks for the current preset
///
///
/// The preset.
///
private void AddTracksFromPreset(Preset preset)
{
// Clear out the old tracks
this.Task.AudioTracks.Clear();
// Add the preset audio tracks with the preferred language
foreach (AudioTrack track in preset.Task.AudioTracks)
{
this.Task.AudioTracks.Add(new AudioTrack(track) { ScannedTrack = this.GetPreferredAudioTrack() });
}
}
///
/// Attempt to automatically select the correct audio tracks based on the users settings.
///
private void AutomaticTrackSelection()
{
if (!this.SourceTracks.Any())
{
// Clear out the old tracks
this.Task.AudioTracks.Clear();
return;
}
// We've changed source, so lets try reset the language, description and formats as close as possible to the previous track.
foreach (AudioTrack track in this.Task.AudioTracks)
{
track.ScannedTrack = this.GetPreferredAudioTrack();
}
// Handle the default selection behaviour.
int mode = this.UserSettingService.GetUserSetting(UserSettingConstants.DubModeAudio);
if (mode == 1 || mode == 2)
{
// First, we'll clear out all current tracks and go back to what the current preset has.
// This will alteast provide a consistent behavior when switching tracks.
this.Task.AudioTracks.Clear();
this.AddTracksFromPreset(this.currentPreset);
}
switch (mode)
{
case 1: // Adding all remaining audio tracks
this.AddAllRemaining();
break;
case 2: // Add Langauges tracks for the additional languages selected, in-order.
this.AddAllRemainingForSelectedLanguages();
break;
}
}
///
/// The get preferred audio track, or the first if none available.
///
///
/// The users preferred language, or the first if none available.
///
private Audio GetPreferredAudioTrack()
{
// Get the preferred Language
IEnumerable preferredAudioTracks =
this.SourceTracks.Where(
item =>
item.Language.Contains(
this.UserSettingService.GetUserSetting(UserSettingConstants.NativeLanguage)));
return preferredAudioTracks.FirstOrDefault() ?? this.SourceTracks.FirstOrDefault();
}
///
/// Gets a list of source tracks for the users selected languages.
///
///
/// A list of source audio tracks.
///
private IEnumerable GetSelectedLanguagesTracks()
{
List trackList = new List();
foreach (string language in this.UserSettingService.GetUserSetting(UserSettingConstants.SelectedLanguages))
{
trackList.AddRange(this.SourceTracks.Where(source => source.Language.Trim() == language));
}
return trackList;
}
///
/// Checks to see if we can skip over the given source audio track.
/// True when the user has set "Add only one per language" feature AND the language is contained in the track list.
///
///
/// The source track.
///
///
/// True when the user has set "Add only one per language" feature AND the language is contained in the track list
///
private bool CanSkipSourceTrack(Audio sourceTrack)
{
bool addOnlyOnePerLanguage = this.UserSettingService.GetUserSetting(UserSettingConstants.AddOnlyOneAudioPerLanguage);
bool sourceTrackLanguageFound = this.Task.AudioTracks.Any(audioTrack => audioTrack.ScannedTrack != null && sourceTrack.Language == audioTrack.ScannedTrack.Language);
if (addOnlyOnePerLanguage && sourceTrackLanguageFound)
{
return true; // This track can be skipped.
}
return false;
}
#endregion
}
}