Extensions for WPF and System.Drawing key bitmaps moved to StreamDeckKeyBitmaps (to the other factory methods)

Changed the interface (no longer backwards compatible to other versions if you used a byte array as a parameter)

Author: Christian Wischenbart

src/StreamDeckSharp.Examples.Drawing/Program.cs

@@ -28,7 +28,7 @@ static void Main(string[] args)
         static void ExampleWithSystemDrawing(IStreamDeck deck)
         {
             //Create a key with lambda graphics
-            var key = deck.CreateKeyFromGraphics(g =>
+            var key = StreamDeckKeyBitmap.FromGraphics(g =>
             {
                 //See https://stackoverflow.com/questions/6311545/c-sharp-write-text-on-bitmap for details
                 g.SmoothingMode = SmoothingMode.AntiAlias;
@@ -69,7 +69,7 @@ static void ExampleWithWpfElement(IStreamDeck deck)
 
             c.Children.Add(t);
 
-            var k = deck.CreateKeyFromWpfElement(c);
+            var k = StreamDeckKeyBitmap.FromWpfElement(c);
             deck.SetKeyBitmap(7, k);
         }
 

src/StreamDeckSharp/ExtensionsForSystemDrawing.cs

@@ -43,15 +43,8 @@ public interface IStreamDeck : IDisposable
         /// Sets a background image for a given key
         /// </summary>
         /// <param name="keyId">Specifies which key the image will be applied on</param>
-        /// <param name="bitmapData">The raw bitmap pixel data. Details see remarks section. The key will be painted black if this value is null.</param>
-        /// <remarks>
-        /// The raw pixel format is a byte array of length 15552. This number is based on the image
-        /// dimensions used by StreamDeck 72x72 pixels and 3 channels (RGB) for each pixel. 72 x 72 x 3 = 15552.
-        /// 
-        /// The channels are in the order BGR and the pixel rows (stride) are in reverse order.
-        /// If you need some help try <see cref="StreamDeckKeyBitmap"/>
-        /// </remarks>
-        void SetKeyBitmap(int keyId, byte[] bitmapData);
+        /// <param name="bitmapData">Bitmap. The key will be painted black if this value is null.</param>
+        void SetKeyBitmap(int keyId, StreamDeckKeyBitmap bitmapData);
 
         /// <summary>
         /// Shows the Stream Deck logo (Fullscreen)

src/StreamDeckSharp/IStreamDeck.cs

@@ -17,34 +17,12 @@ namespace StreamDeckSharp
     /// </remarks>
     public static class StreamDeckExtensions
     {
-        /// <summary>
-        /// Sets a background image for a given key
-        /// </summary>
-        /// <param name="deck"></param>
-        /// <param name="keyId"></param>
-        /// <param name="bitmap"></param>
-        public static void SetKeyBitmap(this IStreamDeck deck, int keyId, StreamDeckKeyBitmap bitmap)
-        {
-            deck.SetKeyBitmap(keyId, bitmap.rawBitmapData);
-        }
-
         /// <summary>
         /// Sets a background image for all keys
         /// </summary>
         /// <param name="deck"></param>
         /// <param name="bitmap"></param>
         public static void SetKeyBitmap(this IStreamDeck deck, StreamDeckKeyBitmap bitmap)
-        {
-            for (int i = 0; i < StreamDeckHID.numOfKeys; i++)
-                deck.SetKeyBitmap(i, bitmap.rawBitmapData);
-        }
-
-        /// <summary>
-        /// Sets a background image for all keys
-        /// </summary>
-        /// <param name="deck"></param>
-        /// <param name="bitmap"></param>
-        public static void SetKeyBitmap(this IStreamDeck deck, byte[] bitmap)
         {
             for (int i = 0; i < StreamDeckHID.numOfKeys; i++)
                 deck.SetKeyBitmap(i, bitmap);

src/StreamDeckSharp/StreamDeckExtensions.cs

@@ -46,11 +46,10 @@ internal sealed class StreamDeckHID : IStreamDeck
         public int IconSize => iconSize;
         public bool IsConnected => device.IsConnected;
 
-        public void SetKeyBitmap(int keyId, byte[] bitmapData)
+        public void SetKeyBitmap(int keyId, StreamDeckKeyBitmap bitmap)
         {
             VerifyNotDisposed();
-            if (bitmapData != null && bitmapData.Length != (iconSize * iconSize * 3)) throw new NotSupportedException();
-            qqq.Enqueue(keyId, bitmapData);
+            qqq.Enqueue(keyId, bitmap?.rawBitmapData);
         }
 
         public void Dispose()

src/StreamDeckSharp/StreamDeckHID.cs

@@ -6,13 +6,16 @@
 using System.Linq;
 using System.Text;
 using System.Threading.Tasks;
+using System.Windows;
+using System.Windows.Media;
+using System.Windows.Media.Imaging;
 
 namespace StreamDeckSharp
 {
     /// <summary>
     /// Represents a bitmap that can be used as key images
     /// </summary>
-    public class StreamDeckKeyBitmap
+    public partial class StreamDeckKeyBitmap
     {
         /// <summary>
         /// Solid black bitmap
@@ -23,17 +26,15 @@ public class StreamDeckKeyBitmap
         public static StreamDeckKeyBitmap Black { get { return black; } }
         private static readonly StreamDeckKeyBitmap black = new StreamDeckKeyBitmap(null);
 
+        /// <remarks>
+        /// The raw pixel format is a byte array of length 15552. This number is based on the image
+        /// dimensions used by StreamDeck 72x72 pixels and 3 channels (RGB) for each pixel. 72 x 72 x 3 = 15552.
+        /// 
+        /// The channels are in the order BGR and the pixel rows (stride) are in reverse order.
+        /// If you need some help try <see cref="StreamDeckKeyBitmap"/>
+        /// </remarks>
         internal readonly byte[] rawBitmapData;
 
-        /// <summary>
-        /// Returns a copy of the internal bitmap.
-        /// </summary>
-        /// <returns></returns>
-        public byte[] CloneBitmapData()
-        {
-            return (byte[])rawBitmapData.Clone();
-        }
-
         internal StreamDeckKeyBitmap(byte[] bitmapData)
         {
             if (bitmapData != null)
@@ -42,110 +43,5 @@ internal StreamDeckKeyBitmap(byte[] bitmapData)
                 this.rawBitmapData = bitmapData;
             }
         }
-
-        public static StreamDeckKeyBitmap FromRawBitmap(byte[] bitmapData)
-        {
-            return new StreamDeckKeyBitmap(bitmapData);
-        }
-
-        /// <summary>
-        /// Creates a solid color bitmap
-        /// </summary>
-        /// <param name="R">Red channel</param>
-        /// <param name="G">Green channel</param>
-        /// <param name="B">Blue channel</param>
-        /// <returns></returns>
-        public static StreamDeckKeyBitmap FromRGBColor(byte R, byte G, byte B)
-        {
-            //If everything is 0 (black) take a shortcut ;-)
-            if (R == 0 && G == 0 && B == 0) return Black;
-
-            var buffer = new byte[StreamDeckHID.rawBitmapDataLength];
-            for (int i = 0; i < buffer.Length; i += 3)
-            {
-                buffer[i + 0] = B;
-                buffer[i + 1] = G;
-                buffer[i + 2] = R;
-            }
-
-            return new StreamDeckKeyBitmap(buffer);
-        }
-
-        public static StreamDeckKeyBitmap FromStream(Stream bitmapStream)
-        {
-            using (Bitmap bitmap = (Bitmap)Image.FromStream(bitmapStream))
-            {
-                return FromDrawingBitmap(bitmap);
-            }
-        }
-
-        public static StreamDeckKeyBitmap FromFile(string bitmapFile)
-        {
-            using (Bitmap bitmap = (Bitmap)Image.FromFile(bitmapFile))
-            {
-                return FromDrawingBitmap(bitmap);
-            }
-        }
-
-        internal static StreamDeckKeyBitmap FromDrawingBitmap(Bitmap bitmap)
-        {
-            if (bitmap.Width != StreamDeckHID.iconSize || bitmap.Height != StreamDeckHID.iconSize) throw new NotSupportedException("Unsupported bitmap dimensions");
-
-            BitmapData data = null;
-            try
-            {
-                data = bitmap.LockBits(new Rectangle(0, 0, bitmap.Width, bitmap.Height), System.Drawing.Imaging.ImageLockMode.ReadOnly, bitmap.PixelFormat);
-                var managedRGB = new byte[StreamDeckHID.rawBitmapDataLength];
-
-                unsafe
-                {
-                    byte* bdata = (byte*)data.Scan0;
-
-                    //TODO: This should be cleaned up
-                    //I'm locking for a different approach to parse different PixelFormats without
-                    //copying 90% of the code ;-)
-                    if (data.PixelFormat == PixelFormat.Format24bppRgb)
-                    {
-                        for (int y = 0; y < StreamDeckHID.iconSize; y++)
-                        {
-                            for (int x = 0; x < StreamDeckHID.iconSize; x++)
-                            {
-                                var ps = data.Stride * y + x * 3;
-                                var pt = StreamDeckHID.iconSize * 3 * (y + 1) - (x + 1) * 3;
-                                managedRGB[pt + 0] = bdata[ps + 0];
-                                managedRGB[pt + 1] = bdata[ps + 1];
-                                managedRGB[pt + 2] = bdata[ps + 2];
-                            }
-                        }
-                    }
-                    else if (data.PixelFormat == PixelFormat.Format32bppArgb)
-                    {
-                        for (int y = 0; y < StreamDeckHID.iconSize; y++)
-                        {
-                            for (int x = 0; x < StreamDeckHID.iconSize; x++)
-                            {
-                                var ps = data.Stride * y + x * 4;
-                                var pt = StreamDeckHID.iconSize * 3 * (y + 1) - (x + 1) * 3;
-                                double alpha = (double)bdata[ps + 3] / 255f;
-                                managedRGB[pt + 0] = (byte)Math.Round(bdata[ps + 0] * alpha);
-                                managedRGB[pt + 1] = (byte)Math.Round(bdata[ps + 1] * alpha);
-                                managedRGB[pt + 2] = (byte)Math.Round(bdata[ps + 2] * alpha);
-                            }
-                        }
-                    }
-                    else
-                    {
-                        throw new NotSupportedException("Unsupported pixel format");
-                    }
-                }
-
-                return new StreamDeckKeyBitmap(managedRGB);
-            }
-            finally
-            {
-                if (data != null)
-                    bitmap.UnlockBits(data);
-            }
-        }
     }
 }