//

// Copyright (C) 2014-2015 Stéphane Lenclud.

//

// This file is part of SharpDisplayManager.

//

// SharpDisplayManager is free software: you can redistribute it and/or modify

// it under the terms of the GNU General Public License as published by

// the Free Software Foundation, either version 3 of the License, or

// (at your option) any later version.

//

// SharpDisplayManager 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 General Public License for more details.

//

// You should have received a copy of the GNU General Public License

// along with SharpDisplayManager.  If not, see <http://www.gnu.org/licenses/>.

//

using System;

using System.Collections.Generic;

using System.ComponentModel;

using System.Data;

using System.Drawing;

using System.Linq;

using System.Text;

using System.Threading.Tasks;

using System.Windows.Forms;

using System.IO;

using CodeProject.Dialog;

using System.Drawing.Imaging;

using System.ServiceModel;

using System.Threading;

using System.Diagnostics;

using System.Deployment.Application;

using System.Reflection;

using System.Runtime.InteropServices;

using System.Security;

//CSCore

using CSCore;

using CSCore.Win32;

using CSCore.DSP;

using CSCore.Streams;

using CSCore.CoreAudioAPI;

using CSCore.SoundIn;

// Visualization

using Visualization;

// CEC

using CecSharp;

//Network

using NETWORKLIST;

//

using SharpDisplayClient;

using SharpDisplay;

using MiniDisplayInterop;

using SharpLib.Display;

using Ear = SharpLib.Ear;

namespace SharpDisplayManager

{

    //Types declarations

    public delegate uint ColorProcessingDelegate(int aX, int aY, uint aPixel);

    public delegate int CoordinateTranslationDelegate(System.Drawing.Bitmap aBmp, int aInt);

    //Delegates are used for our thread safe method

    public delegate void AddClientDelegate(string aSessionId, ICallback aCallback);

    public delegate void RemoveClientDelegate(string aSessionId);

    public delegate void WndProcDelegate(ref Message aMessage);

    /// <summary>

    /// Our Display manager main form

    /// </summary>

    [System.ComponentModel.DesignerCategory("Form")]

    public partial class FormMain : FormMainHid

    {

        //public Manager iManager = new Manager();        

        DateTime LastTickTime;

        Display iDisplay;

        System.Drawing.Bitmap iBmp;

        //TODO: Align that with what we did from Audio Visualizers bitmaps?

        bool iCreateBitmap; //Workaround render to bitmap issues when minimized

        ServiceHost iServiceHost;

        // Our collection of clients sorted by session id.

        public Dictionary<string, ClientData> iClients;

        // The name of the client which informations are currently displayed.

        public string iCurrentClientSessionId;

        ClientData iCurrentClientData;

        /// <summary>

        /// Define our display view including layout and fields.

        /// Display view should include one ClientField that will show on client View.

        /// </summary>

        SharpLib.Display.View iDisplayView;

        bool iHasNewDisplayLayout;

        //

        public bool iClosing;

        //

        public bool iSkipFrameRendering;

        //Function pointer for pixel color filtering

        ColorProcessingDelegate iColorFx;

        //Function pointer for pixel X coordinate intercept

        CoordinateTranslationDelegate iScreenX;

        //Function pointer for pixel Y coordinate intercept

        CoordinateTranslationDelegate iScreenY;

        //Audio

        private AudioManager iAudioManager;

        //Network

        private NetworkManager iNetworkManager;

        /// <summary>

        /// CEC - Consumer Electronic Control.

        /// Notably used to turn TV on and off as Windows broadcast monitor on and off notifications.

        /// </summary>

        private ConsumerElectronicControl iCecManager;

        /// <summary>

        /// Manage run when Windows startup option

        /// </summary>

        private StartupManager iStartupManager;

        /// <summary>

        /// System notification icon used to hide our application from the task bar.

        /// </summary>

        private SharpLib.Notification.Control iNotifyIcon;

        /// <summary>

        /// System recording notification icon.

        /// </summary>

        private SharpLib.Notification.Control iRecordingNotification;

        /// <summary>

        /// 

        /// </summary>

        RichTextBoxTraceListener iWriter;

        /// <summary>

        /// Allow user to receive window messages;

        /// </summary>

        public event WndProcDelegate OnWndProc;

        public FormMain()

        {

            if (Properties.Settings.Default.EarManager == null)

            {

                //No actions in our settings yet

                Properties.Settings.Default.EarManager = new EarManager();

            }

            else

            {

                // We loaded events and actions from our settings

                // Internalizer apparently skips constructor so we need to initialize it here

                // Though I reckon that should only be needed when loading an empty EAR manager I guess.

                Properties.Settings.Default.EarManager.Construct();

            }

            iSkipFrameRendering = false;

            iClosing = false;

            iCurrentClientSessionId = "";

            iCurrentClientData = null;

            LastTickTime = DateTime.Now;

            //Instantiate our display and register for events notifications

            iDisplay = new Display();

            iDisplay.OnOpened += OnDisplayOpened;

            iDisplay.OnClosed += OnDisplayClosed;

            //

            iClients = new Dictionary<string, ClientData>();

            iStartupManager = new StartupManager();

            iNotifyIcon = new SharpLib.Notification.Control();

            iRecordingNotification = new SharpLib.Notification.Control();

            iDisplayView = new SharpLib.Display.View();

            // Default to a single field showing our client

            iDisplayView.Layout = new TableLayout(1, 1);

            iDisplayView.Fields.Add(new ClientField());

            //Have our designer initialize its controls

            InitializeComponent();

            //Redirect console output

            iWriter = new RichTextBoxTraceListener(richTextBoxLogs);

            Trace.Listeners.Add(iWriter);

            //Populate device types

            PopulateDeviceTypes();

            //Initial status update 

            UpdateStatus();

            //We have a bug when drawing minimized and reusing our bitmap

            //Though I could not reproduce it on Windows 10

            iBmp = new System.Drawing.Bitmap(iTableLayoutPanelDisplay.Width, iTableLayoutPanelDisplay.Height,

                PixelFormat.Format32bppArgb);

            iCreateBitmap = false;

            //Minimize our window if desired

            if (Properties.Settings.Default.StartMinimized)

            {

                WindowState = FormWindowState.Minimized;

            }

        }

        /// <summary>

        ///

        /// </summary>

        /// <param name="sender"></param>

        /// <param name="e"></param>

        private void MainForm_Load(object sender, EventArgs e)

        {

            //Check if we are running a Click Once deployed application

            if (ApplicationDeployment.IsNetworkDeployed)

            {

                //This is a proper Click Once installation, fetch and show our version number

                this.Text += " - v" + ApplicationDeployment.CurrentDeployment.CurrentVersion;

            }

            else

            {

                //Not a proper Click Once installation, assuming development build then

                this.Text += " - development";

            }

            //CSCore

            CreateAudioManager();

            //Network

            iNetworkManager = new NetworkManager();

            iNetworkManager.OnConnectivityChanged += OnConnectivityChanged;

            UpdateNetworkStatus();

            //CEC

            iCecManager = new ConsumerElectronicControl();

            OnWndProc += iCecManager.OnWndProc;

            ResetCec();

            //Harmony

            ResetHarmonyAsync();

            //Setup Events

            PopulateTreeViewEvents();

            //Setup notification icon

            SetupTrayIcon();

            //Setup recording notification

            SetupRecordingNotification();

            // To make sure start up with minimize to tray works

            if (WindowState == FormWindowState.Minimized && Properties.Settings.Default.MinimizeToTray)

            {

                Visible = false;

            }

#if !DEBUG

            // When not debugging we want the screen to be empty until a client takes over

			ClearLayout(iTableLayoutPanelCurrentClient);

            // Display layout should be empty too

            // TODO: Eventually we will need to dynamically create and destroy our client table layout

            DoClearLayout(iTableLayoutPanelDisplay);

            iTableLayoutPanelDisplay.ColumnCount = 1;

            iTableLayoutPanelDisplay.ColumnStyles.Add(new ColumnStyle(SizeType.Percent, 100F));

            iTableLayoutPanelDisplay.RowCount = 1;

            iTableLayoutPanelDisplay.RowStyles.Add(new RowStyle(SizeType.Percent, 100F));

            //

            iTableLayoutPanelDisplay.SetRowSpan(iTableLayoutPanelCurrentClient, 1);

            iTableLayoutPanelDisplay.SetColumnSpan(iTableLayoutPanelCurrentClient, 1);

            iTableLayoutPanelDisplay.Controls.Add(iTableLayoutPanelCurrentClient,0,0);

            // Is that needed? Why just in release?

            iCurrentClientData = null;

#else

            //When developing we want at least one client for testing

            StartNewClient("abcdefghijklmnopqrst-0123456789", "ABCDEFGHIJKLMNOPQRST-0123456789");

#endif

            //Open display connection on start-up if needed

            if (Properties.Settings.Default.DisplayConnectOnStartup)

            {

                OpenDisplayConnection();

            }

            //Start our server so that we can get client requests

            StartServer();

            //Register for HID events

            RegisterHidDevices();

            //Start Idle client if needed

            if (Properties.Settings.Default.StartIdleClient)

            {

                StartIdleClient();

            }

        }

        private void CreateAudioManager()

        {

            iAudioManager = new AudioManager();

            iAudioManager.Open(OnDefaultMultiMediaDeviceChanged, OnVolumeNotification);

            UpdateAudioDeviceAndMasterVolumeThreadSafe();

        }

        private void DestroyAudioManager()

        {

            if (iAudioManager != null)

            {

                iAudioManager.Close();

                iAudioManager = null;

            }

        }

        /// <summary>

        /// 

        /// </summary>

        /// <param name="sender"></param>

        /// <param name="aEvent"></param>

        public void OnDefaultMultiMediaDeviceChanged(object sender, DefaultDeviceChangedEventArgs aEvent)

        {

            if (aEvent.DataFlow == DataFlow.Render && aEvent.Role == Role.Multimedia)

            {

                ResetAudioManagerThreadSafe();

            }

        }

        /// <summary>

        /// 

        /// </summary>

        private void ResetAudioManagerThreadSafe()

        {

            if (InvokeRequired)

            {

                //Not in the proper thread, invoke ourselves

                BeginInvoke(new Action<FormMain>((sender) => { ResetAudioManagerThreadSafe(); }), this);

                return;

            }

            //Proper thread, go ahead

            DestroyAudioManager();

            CreateAudioManager();

        }

        /// <summary>

        /// Called when our display is opened.

        /// </summary>

        /// <param name="aDisplay"></param>

        private void OnDisplayOpened(Display aDisplay)

        {

            //Make sure we resume frame rendering

            iSkipFrameRendering = false;

            //Set our screen size now that our display is connected

            //Our panelDisplay is the container of our tableLayoutPanel

            //tableLayoutPanel will resize itself to fit the client size of our panelDisplay

            //panelDisplay needs an extra 2 pixels for borders on each sides

            //tableLayoutPanel will eventually be the exact size of our display

            Size size = new Size(iDisplay.WidthInPixels() + 2, iDisplay.HeightInPixels() + 2);

            iPanelDisplay.Size = size;

            //Our display was just opened, update our UI

            UpdateStatus();

            //Initiate asynchronous request

            iDisplay.RequestFirmwareRevision();

            //Audio

            UpdateMasterVolumeThreadSafe();

            //Network

            UpdateNetworkStatus();

#if DEBUG

            //Testing icon in debug, no arm done if icon not supported

            //iDisplay.SetIconStatus(Display.TMiniDisplayIconType.EMiniDisplayIconRecording, 0, 1);

            //iDisplay.SetAllIconsStatus(2);

#endif

        }

        private static void AddActionsToTreeNode(TreeNode aParentNode, Ear.Object aObject)

        {

            foreach (Ear.Action a in aObject.Objects.OfType<Ear.Action>())

            {

                //Create action node

                TreeNode actionNode = aParentNode.Nodes.Add(a.Brief());

                actionNode.Tag = a;

                //Use color from parent unless our action itself is disabled

                actionNode.ForeColor = a.Enabled ? aParentNode.ForeColor : Color.DimGray;

                //Go recursive

                AddActionsToTreeNode(actionNode,a);

            }

        }

        /// <summary>

        /// 

        /// </summary>

        /// <param name="aObject"></param>

        /// <param name="aNode"></param>

        private static TreeNode FindTreeNodeForEarObject(Ear.Object aObject, TreeNode aNode)

        {

            if (aNode.Tag == aObject)

            {

                return aNode;

            }

            foreach (TreeNode n in aNode.Nodes)

            {

                TreeNode found = FindTreeNodeForEarObject(aObject,n);

                if (found != null)

                {

                    return found;

                }

            }

            return null;

        }

        /// <summary>

        /// 

        /// </summary>

        /// <param name="aObject"></param>

        private void SelectEarObject(Ear.Object aObject)

        {

            foreach (TreeNode n in iTreeViewEvents.Nodes)

            {

                TreeNode found = FindTreeNodeForEarObject(aObject, n);

                if (found != null)

                {

                    iTreeViewEvents.SelectedNode=found;

                    iTreeViewEvents.Focus();

                    return;

                }

            }

        }

        /// <summary>

        /// Populate tree view with events and actions

        /// </summary>

        private void PopulateTreeViewEvents(Ear.Object aSelectedObject=null)

        {

            //Reset our tree

            iTreeViewEvents.Nodes.Clear();

            //Populate registered events

            foreach (Ear.Event e in Properties.Settings.Default.EarManager.Events)

            {

                //Create our event node

                //Work out the name of our node

                string eventNodeName = "";

                if (!string.IsNullOrEmpty(e.Name))

                {

                    //That event has a proper name, use it then

                    eventNodeName = $"{e.Name} - {e.Brief()}";

                }

                else

                {

                    //Unnamed events just use brief

                    eventNodeName = e.Brief();

                }

                TreeNode eventNode = iTreeViewEvents.Nodes.Add(eventNodeName);

                eventNode.Tag = e; //For easy access to our event

                if (!e.Enabled)

                {

                    //Dim our nodes if disabled

                    eventNode.ForeColor = Color.DimGray;

                }

                //Add event description as child node

                eventNode.Nodes.Add(e.AttributeDescription).ForeColor = eventNode.ForeColor; 

                //Create child node for actions root

                TreeNode actionsNode = eventNode.Nodes.Add("Actions");

                actionsNode.ForeColor = eventNode.ForeColor;

                // Recursively add our actions for that event

                AddActionsToTreeNode(actionsNode,e);

            }

            iTreeViewEvents.ExpandAll();

            if (aSelectedObject != null)

            {

                SelectEarObject(aSelectedObject);

            }            

            // Just to be safe in case the selection did not work

            UpdateEventView();

        }

        /// <summary>

        /// Called when our display is closed.

        /// </summary>

        /// <param name="aDisplay"></param>

        private void OnDisplayClosed(Display aDisplay)

        {

            //Our display was just closed, update our UI consequently

            UpdateStatus();

        }

        public void OnConnectivityChanged(NetworkManager aNetwork, NLM_CONNECTIVITY newConnectivity)

        {

            //Update network status

            UpdateNetworkStatus();

        }

        /// <summary>

        /// Update our Network Status

        /// </summary>

        private void UpdateNetworkStatus()

        {

            if (iDisplay.IsOpen())

            {

                iDisplay.SetIconOnOff(MiniDisplay.IconType.Internet,

                    iNetworkManager.NetworkListManager.IsConnectedToInternet);

                iDisplay.SetIconOnOff(MiniDisplay.IconType.NetworkSignal, iNetworkManager.NetworkListManager.IsConnected);

            }

        }

        int iLastNetworkIconIndex = 0;

        int iUpdateCountSinceLastNetworkAnimation = 0;

        /// <summary>

        /// 

        /// </summary>

        private void UpdateNetworkSignal(DateTime aLastTickTime, DateTime aNewTickTime)

        {

            iUpdateCountSinceLastNetworkAnimation++;

            iUpdateCountSinceLastNetworkAnimation = iUpdateCountSinceLastNetworkAnimation%4;

            if (iDisplay.IsOpen() && iNetworkManager.NetworkListManager.IsConnected &&

                iUpdateCountSinceLastNetworkAnimation == 0)

            {

                int iconCount = iDisplay.IconCount(MiniDisplay.IconType.NetworkSignal);

                if (iconCount <= 0)

                {

                    //Prevents div by zero and other undefined behavior

                    return;

                }

                iLastNetworkIconIndex++;

                iLastNetworkIconIndex = iLastNetworkIconIndex%(iconCount*2);

                for (int i = 0; i < iconCount; i++)

                {

                    if (i < iLastNetworkIconIndex && !(i == 0 && iLastNetworkIconIndex > 3) &&

                        !(i == 1 && iLastNetworkIconIndex > 4))

                    {

                        iDisplay.SetIconOn(MiniDisplay.IconType.NetworkSignal, i);

                    }

                    else

                    {

                        iDisplay.SetIconOff(MiniDisplay.IconType.NetworkSignal, i);

                    }

                }

            }

        }

        /// <summary>

        /// Receive volume change notification and reflect changes on our slider.

        /// </summary>

        /// <param name="data"></param>

        public void OnVolumeNotification(object sender, AudioEndpointVolumeCallbackEventArgs aEvent)

        {

            UpdateMasterVolumeThreadSafe();

        }

        /// <summary>

        /// Update master volume when user moves our slider.

        /// </summary>

        /// <param name="sender"></param>

        /// <param name="e"></param>

        private void trackBarMasterVolume_Scroll(object sender, EventArgs e)

        {

            //Just like Windows Volume Mixer we unmute if the volume is adjusted

            iAudioManager.Volume.IsMuted = false;

            //Set volume level according to our volume slider new position

            iAudioManager.Volume.MasterVolumeLevelScalar = trackBarMasterVolume.Value/100.0f;

        }

        /// <summary>

        /// Mute check box changed.

        /// </summary>

        /// <param name="sender"></param>

        /// <param name="e"></param>

        private void checkBoxMute_CheckedChanged(object sender, EventArgs e)

        {

            iAudioManager.Volume.IsMuted = checkBoxMute.Checked;

        }

        /// <summary>

        /// Update master volume indicators based our current system states.

        /// This typically includes volume levels and mute status.

        /// </summary>

        private void UpdateMasterVolumeThreadSafe()

        {

            if (InvokeRequired)

            {

                //Not in the proper thread, invoke ourselves

                BeginInvoke(new Action<FormMain>((sender) => { UpdateMasterVolumeThreadSafe(); }), this);

                return;

            }

            //Update volume slider

            float volumeLevelScalar = iAudioManager.Volume.MasterVolumeLevelScalar;

            trackBarMasterVolume.Value = Convert.ToInt32(volumeLevelScalar*100);

            //Update mute checkbox

            checkBoxMute.Checked = iAudioManager.Volume.IsMuted;

            //If our display connection is open we need to update its icons

            if (iDisplay.IsOpen())

            {

                //First take care our our volume level icons

                int volumeIconCount = iDisplay.IconCount(MiniDisplay.IconType.Volume);

                if (volumeIconCount > 0)

                {

                    //Compute current volume level from system level and the number of segments in our display volume bar.

                    //That tells us how many segments in our volume bar needs to be turned on.

                    float currentVolume = volumeLevelScalar*volumeIconCount;

                    int segmentOnCount = Convert.ToInt32(currentVolume);

                    //Check if our segment count was rounded up, this will later be used for half brightness segment

                    bool roundedUp = segmentOnCount > currentVolume;

                    for (int i = 0; i < volumeIconCount; i++)

                    {

                        if (i < segmentOnCount)

                        {

                            //If we are dealing with our last segment and our segment count was rounded up then we will use half brightness.

                            if (i == segmentOnCount - 1 && roundedUp)

                            {

                                //Half brightness

                                iDisplay.SetIconStatus(MiniDisplay.IconType.Volume, i,

                                    (iDisplay.IconStatusCount(MiniDisplay.IconType.Volume) - 1)/2);

                            }

                            else

                            {

                                //Full brightness

                                iDisplay.SetIconStatus(MiniDisplay.IconType.Volume, i,

                                    iDisplay.IconStatusCount(MiniDisplay.IconType.Volume) - 1);

                            }

                        }

                        else

                        {

                            iDisplay.SetIconStatus(MiniDisplay.IconType.Volume, i, 0);

                        }

                    }

                }

                //Take care of our mute icon

                iDisplay.SetIconOnOff(MiniDisplay.IconType.Mute, iAudioManager.Volume.IsMuted);

            }

        }

        /// <summary>

        /// 

        /// </summary>

        private void UpdateAudioVisualization()

        {

            // No point if we don't have a current client

            if (iCurrentClientData == null)

            {

                return;

            }

            // Update our math

            if (iAudioManager==null || iAudioManager.Spectrum==null || !iAudioManager.Spectrum.Update())

            {

                //Nothing changed no need to render

                return;

            }

            // Check if our current client has an Audio Visualizer field

            // and render them as needed

            foreach (DataField f in iCurrentClientData.View.Fields)

            {

                if (f is AudioVisualizerField)

                {

                    AudioVisualizerField avf = (AudioVisualizerField)f;

                    Control ctrl = iTableLayoutPanelCurrentClient.GetControlFromPosition(avf.Column, avf.Row);

                    if (ctrl is PictureBox)

                    {

                        PictureBox pb = (PictureBox)ctrl;

                        if (iAudioManager.Spectrum.Render(pb.Image, Color.Black, Color.Black, Color.White, false))

                        {

                            pb.Invalidate();

                        }

                    }

                }

            }

        }

        /// <summary>

        /// 

        /// </summary>

        private void UpdateAudioDeviceAndMasterVolumeThreadSafe()

        {            

            if (InvokeRequired)

            {

                //Not in the proper thread, invoke ourselves

                BeginInvoke(new Action<FormMain>((sender) => { UpdateAudioDeviceAndMasterVolumeThreadSafe(); }), this);

                return;

            }

            //We are in the correct thread just go ahead.

            try

            {

                //Update our label

                iLabelDefaultAudioDevice.Text = iAudioManager.DefaultDevice.FriendlyName;

                //Show our volume in our track bar

                UpdateMasterVolumeThreadSafe();

                //

                trackBarMasterVolume.Enabled = true;

            }

            catch (Exception ex)

            {

                Debug.WriteLine("Exception thrown in UpdateAudioDeviceAndMasterVolume");

                Debug.WriteLine(ex.ToString());

                //Something went wrong S/PDIF device ca throw exception I guess

                trackBarMasterVolume.Enabled = false;

            }

        }

        /// <summary>

        /// 

        /// </summary>

        private void PopulateDeviceTypes()

        {

            int count = Display.TypeCount();

            for (int i = 0; i < count; i++)

            {

                comboBoxDisplayType.Items.Add(Display.TypeName((MiniDisplay.Type) i));

            }

        }

        /// <summary>

        ///

        /// </summary>

        private void SetupTrayIcon()

        {

            iNotifyIcon.Icon = GetIcon("vfd.ico");

            iNotifyIcon.Text = "Sharp Display Manager";

            iNotifyIcon.Visible = true;

            //Double click toggles visibility - typically brings up the application

            iNotifyIcon.DoubleClick += delegate(object obj, EventArgs args)

            {

                SysTrayHideShow();

            };

            //Adding a context menu, useful to be able to exit the application

            ContextMenu contextMenu = new ContextMenu();

            //Context menu item to toggle visibility

            MenuItem hideShowItem = new MenuItem("Hide/Show");

            hideShowItem.Click += delegate(object obj, EventArgs args)

            {

                SysTrayHideShow();

            };

            contextMenu.MenuItems.Add(hideShowItem);

            //Context menu item separator

            contextMenu.MenuItems.Add(new MenuItem("-"));

            //Context menu exit item

            MenuItem exitItem = new MenuItem("Exit");

            exitItem.Click += delegate(object obj, EventArgs args)

            {

                Application.Exit();

            };

            contextMenu.MenuItems.Add(exitItem);

            iNotifyIcon.ContextMenu = contextMenu;

        }

        /// <summary>

        ///

        /// </summary>

        private void SetupRecordingNotification()

        {

            iRecordingNotification.Icon = GetIcon("record.ico");

            iRecordingNotification.Text = "No recording";

            iRecordingNotification.Visible = false;

        }

        /// <summary>

        /// Access icons from embedded resources.

        /// </summary>

        /// <param name="aName"></param>

        /// <returns></returns>

        public static Icon GetIcon(string aName)

        {

            string[] names = Assembly.GetExecutingAssembly().GetManifestResourceNames();

            foreach (string name in names)

            {

                //Find a resource name that ends with the given name

                if (name.EndsWith(aName))

                {

                    using (Stream stream = Assembly.GetExecutingAssembly().GetManifestResourceStream(name))

                    {

                        return new Icon(stream);

                    }

                }

            }

            return null;

        }

        /// <summary>

        /// Set our current client.

        /// This will take care of applying our client layout and set data fields.

        /// </summary>

        /// <param name="aSessionId"></param>

        void SetCurrentClient(string aSessionId, bool aForce = false)

        {

            if (aSessionId == iCurrentClientSessionId)

            {

                //Given client is already the current one.

                //Don't bother changing anything then.

                return;

            }

            ClientData requestedClientData = iClients[aSessionId];

            //Check when was the last time we switched to that client

            if (iCurrentClientData != null)

            {

                //Do not switch client if priority of current client is higher 

                if (!aForce && requestedClientData.Priority < iCurrentClientData.Priority)

                {

                    return;

                }

                double lastSwitchToClientSecondsAgo = (DateTime.Now - iCurrentClientData.LastSwitchTime).TotalSeconds;

                //TODO: put that hard coded value as a client property

                //Clients should be able to define how often they can be interrupted

                //Thus a background client can set this to zero allowing any other client to interrupt at any time

                //We could also compute this delay by looking at the requests frequencies?

                if (!aForce &&

                    requestedClientData.Priority == iCurrentClientData.Priority &&

                    //Time sharing is only if clients have the same priority

                    (lastSwitchToClientSecondsAgo < 30)) //Make sure a client is on for at least 30 seconds

                {

                    //Don't switch clients too often

                    return;

                }

            }

            //Set current client ID.

            iCurrentClientSessionId = aSessionId;

            //Set the time we last switched to that client

            iClients[aSessionId].LastSwitchTime = DateTime.Now;

            //Fetch and set current client data.

            iCurrentClientData = requestedClientData;

            //Apply layout and set data fields.

            UpdateTableLayoutPanel(iCurrentClientData.View, iTableLayoutPanelCurrentClient);

        }

        private void buttonFont_Click(object sender, EventArgs e)

        {

            //fontDialog.ShowColor = true;

            //fontDialog.ShowApply = true;

            fontDialog.ShowEffects = true;

            fontDialog.Font = cds.Font;

            fontDialog.FixedPitchOnly = checkBoxFixedPitchFontOnly.Checked;

            //fontDialog.ShowHelp = true;

            //fontDlg.MaxSize = 40;

            //fontDlg.MinSize = 22;

            //fontDialog.Parent = this;

            //fontDialog.StartPosition = FormStartPosition.CenterParent;

            //DlgBox.ShowDialog(fontDialog);

            //if (fontDialog.ShowDialog(this) != DialogResult.Cancel)

            if (DlgBox.ShowDialog(fontDialog) != DialogResult.Cancel)

            {

                //Save font settings

                cds.Font = fontDialog.Font;

                Properties.Settings.Default.Save();

                //

                //Set the fonts to all our labels in our layout

                UpdateFonts(iTableLayoutPanelDisplay);

                //

                CheckFontHeight();

            }

        }

        /// <summary>

        /// TODO: review this in respect to our logical font feature when we get there.

        /// </summary>

        void CheckFontHeight()

        {

            //Show font height and width

            labelFontHeight.Text = "Font height: " + cds.Font.Height;

            float charWidth = IsFixedWidth(cds.Font);

            if (charWidth == 0.0f)

            {

                labelFontWidth.Visible = false;

            }

            else

            {

                labelFontWidth.Visible = true;

                labelFontWidth.Text = "Font width: " + charWidth;

            }

            MarqueeLabel label = null;

            //Get the first label control we can find

            foreach (Control ctrl in iTableLayoutPanelCurrentClient.Controls)

            {

                if (ctrl is MarqueeLabel)

                {

                    label = (MarqueeLabel) ctrl;

                    break;

                }

            }

            //Now check font height and show a warning if needed.

            if (label != null && label.Font.Height > label.Height)

            {

                labelWarning.Text = "WARNING: Selected font is too height by " + (label.Font.Height - label.Height) +

                                    " pixels!";

                labelWarning.Visible = true;

            }

            else

            {

                labelWarning.Visible = false;

            }

        }

        private void buttonCapture_Click(object sender, EventArgs e)

        {

            System.Drawing.Bitmap bmp = new System.Drawing.Bitmap(iTableLayoutPanelDisplay.Width, iTableLayoutPanelDisplay.Height);

            iTableLayoutPanelDisplay.DrawToBitmap(bmp, iTableLayoutPanelDisplay.ClientRectangle);

            //Bitmap bmpToSave = new Bitmap(bmp);

            bmp.Save("D:\\capture.png");

            /*

            string outputFileName = "d:\\capture.png";

            using (MemoryStream memory = new MemoryStream())

            {

                using (FileStream fs = new FileStream(outputFileName, FileMode.OpenOrCreate, FileAccess.ReadWrite))

                {

                    bmp.Save(memory, System.Drawing.Imaging.ImageFormat.Png);

                    byte[] bytes = memory.ToArray();

                    fs.Write(bytes, 0, bytes.Length);

                }

            }

             */

        }

        private void CheckForRequestResults()

        {

            if (iDisplay.IsRequestPending())

            {

                switch (iDisplay.AttemptRequestCompletion())

                {

                    case MiniDisplay.Request.FirmwareRevision:

                        toolStripStatusLabelConnect.Text += " v" + iDisplay.FirmwareRevision();

                        //Issue next request then

                        iDisplay.RequestPowerSupplyStatus();

                        break;

                    case MiniDisplay.Request.PowerSupplyStatus:

                        if (iDisplay.PowerSupplyStatus())

                        {

                            toolStripStatusLabelPower.Text = "ON";

                        }

                        else

                        {

                            toolStripStatusLabelPower.Text = "OFF";

                        }

                        //Issue next request then