分享一次与SharpDX坑爹Bug刚正面的过程

最新推荐文章于 2024-03-16 09:44:04 发布
最新推荐文章于 2024-03-16 09:44:04 发布
阅读量1.7k 收藏
点赞数

和SharpDX坑爹的Variant刚正面

几个月前我写了这篇文章《.NET中生成动态验证码》文章，其实里面藏着一个大坑。运行里面的代码，会发现运行的 gif图片并没有循环播放： 

细心的网友也注意到了这个问题：

……但后来他备注说“已解决”，我当时也不知道该怎么解决的，所以我追问了一下，但他一直没有回复。但思路肯定是有的，再不济，也可以将保存为字节数组的数据，用其它的库进行重新解析，然后指定循环次数即可，当然这个方法肯定很搓，想象中较好的办法应该是调用 SharpDX内置的 API来完成。

踩坑之路

就此我开始了 SharpDX的踩坑之路，我找到了许多资料，找到不少示例代码，最后不断实验，最终成功。

C++示例

首先我在网上找到了 SharpDX生成循环 gif文件的 C++开源代码示例，代码源自于https://github.com/GarethRichards/GifSaver/blob/master/GifSaver.cpp：


   
   
  1. PROPVARIANT propValue; PropVariantInit(&propValue);
  2. propValue.vt = VT_UI1 | VT_VECTOR;
  3. propValue.caub.cElems = 11;
  5. DX::ThrowIfFailed(m_imagingFactory->CreateEncoder(GUID_ContainerFormatGif, &GUID_VendorMicrosoft, &m_wicBitmapEncoder));
  6. DX::ThrowIfFailed(m_wicBitmapEncoder->Initialize(m_stream.Get(), WICBitmapEncoderNoCache));
  7. ComPtr<IWICMetadataQueryWriter> pEncoderMetadataQueryWriter;
  8. DX::ThrowIfFailed(m_wicBitmapEncoder->GetMetadataQueryWriter(&pEncoderMetadataQueryWriter));
  9. string elms = "NETSCAPE2.0";
  10. propValue.caub.pElems = const_cast<UCHAR *>(reinterpret_cast<const UCHAR *>(elms.c_str()));
  11. DX::ThrowIfFailed(pEncoderMetadataQueryWriter->SetMetadataByName(L"/appext/Application", &propValue));
  13. // Set animated GIF format
  14. propValue.vt = VT_UI1 | VT_VECTOR;
  15. propValue.caub.cElems = 5;
  16. UCHAR buf[5];
  17. propValue.caub.pElems = &buf[0];
  18. *(propValue.caub.pElems) = 3; // must be > 1,
  19. *(propValue.caub.pElems + 1) = 1; // defines animated GIF
  20. *(propValue.caub.pElems + 2) = 0; // LSB 0 = infinite loop.
  21. *(propValue.caub.pElems + 3) = 0; // MSB of iteration count value
  22. *(propValue.caub.pElems + 4) = 0; // NULL == end of data
  24. DX::ThrowIfFailed(pEncoderMetadataQueryWriter->SetMetadataByName(L"/appext/Data", &propValue));
  25. // ...

注意其中 /appext/Data实际本质是一个字节数组，其内容为 31000，代表无限循环 gif（注释中说得很清楚），这就应该是循环 gif的关键所在。

可见，首先需要创建一个 PROPVARIANT对象，然后调用 IWICBitmapEncoder中的 GetMetadataQueryWriter方法，获取 IWICMetadataQueryWriter，然后通过该方法中的 SetMetadataByName，将 /appext/Application以及 /appext/Data按照指定的格式传入即可，还能有问题什么呢？

问题可大咯！

坑人的Variant

刚好 SharpDX对这些 C++/COM接口有看似正确的移植，首先 GifBitmapEncoder提供了 MetadataQueryWriter属性（而不是 Get函数），非常贴心，该类中也包含了名字相同的设置函数方法，其签名如下：


   
   
  1. public unsafe void SetMetadataByName(string name, object value) { /* ... */ }

嗯，非常合理，一个键值对而已，能有什么问题？我便用了起来，我自以为代码可能也许大概应该长这个样子：


   
   
  1. encoder.MetadataQueryWriter.SetMetadataByName("/appext/Application", "NETSCAPE2.0");
  2. encoder.MetadataQueryWriter.SetMetadataByName("/appext/Data", new byte[] { 3, 1, 0, 0, 0 });

然而运行报错了，错误信息为：


   
   
  1. SharpDX.SharpDXException: HRESULT: [0x80070057], Module: [General], ApiCode: [E_INVALIDARG/Invalid Arguments], Message: 参数错误。
  3.  at SharpDX.Result.CheckError() in C:\projects\sharpdx\Source\SharpDX\Result.cs:line 197
  4.  at SharpDX.WIC.MetadataQueryWriter.SetMetadataByName(String name, IntPtr varValueRef) in C:\projects\sharpdx\Source\SharpDX.Direct2D1\Generated\REFERENCE\WIC\Interfaces.cs:line 4923
  5.  at SharpDX.WIC.MetadataQueryWriter.SetMetadataByName(String name, Object value) in C:\projects\sharpdx\Source\SharpDX.Direct2D1\WIC\MetadataQueryWriter.cs:line 91
  6.  at UserQuery.SaveD2DBitmap(Int32 width, Int32 height, String text) in C:\Users\sdfly\AppData\Local\Temp\LINQPad6\_uciwedks\kncljn\LINQPadQuery:line 79
  7.  at UserQuery.Main() in C:\Users\sdfly\AppData\Local\Temp\LINQPad6\_uciwedks\kncljn\LINQPadQuery:line 5

反编译它这个 SetMetadataByName一看，其代码如下：


   
   
  1. public unsafe void SetMetadataByName(string name, object value)
  2. {
  3.  byte* variant = stackalloc byte[512];
  4.  Variant* variantStruct = (Variant*)variant;
  5.  variantStruct->Value = value;
  6.  SetMetadataByName(name, (IntPtr)(void*)variant);
  7. }
  9. internal unsafe void SetMetadataByName(string name, IntPtr varValueRef) { /* ... */ }

原来 objectvalue的本质是它内部骚操作创建了一个 Variant，该 Variant就对应了 C++中的 PROPVARIANT，然后后续调用的正确性取决于 Variant.Value属性的设置方法，该属性的源代码如下：


   
   
  1. // SharpDX.Win32.Variant
  2. using SharpDX.Mathematics.Interop;
  3. using System;
  4. using System.Globalization;
  5. using System.Reflection;
  6. using System.Runtime.InteropServices;
  8. public unsafe object Value
  9. {
  10.  get { /* ... */ }
  11.  set
  12.  {
  13.  if (value == null)
  14.  {
  15.  Type = VariantType.Default;
  16.  ElementType = VariantElementType.Null;
  17.  return;
  18.  }
  19.  Type type = value.GetType();
  20.  Type = VariantType.Default;
  21.  if (type.GetTypeInfo().get_IsPrimitive())
  22.  {
  23.  if ((object)type == typeof(byte)) // ...
  24.  if ((object)type == typeof(sbyte)) // ...
  25.  if ((object)type == typeof(int)) // ...
  26.  if ((object)type == typeof(uint)) // ...
  27.  if ((object)type == typeof(long)) // ...
  28.  if ((object)type == typeof(ulong)) // ...
  29.  if ((object)type == typeof(short)) // ...
  30.  if ((object)type == typeof(ushort)) // ...
  31.  if ((object)type == typeof(float)) // ...
  32.  if ((object)type == typeof(double)) // ...
  33.  }
  34.  else
  35.  {
  36.  if (value is ComObject) // ...
  37.  if (value is DateTime) // ...
  38.  if (value is string) // ...
  39.  }
  40.  throw new ArgumentException(string.Format(CultureInfo.InvariantCulture, "Type [{0}] is not handled", new object[1]
  41.  {
  42.  type.get_Name()
  43.  }));
  44.  }
  45. }

在原代码，该属性全部代码长达约 300行，可见作者是花了些心思的，判断了那个 object的“各种”情况，根据上文中的 C++代码，我需要的是 VT_UI1|VT_VECTOR 然而这么多情况，就是没找到我需要的那一种????。

最重要的是，直接传 IntPtr的另一个重载它居然是 internal的，导致我几乎没什么操作空间了。

逢山开路，遇水搭桥

我花了很多时间怎么在 SharpDX已有提供的 Variant对象上做手脚，但感觉代码会比较复杂，所以我走向了另一条路，从那个 internal，传 IntPtr的接口出发解决。

调用私有方法

传 IntPtr的方法是私有的，不能直接调用，但可以使用反射来创建一个指向该私有方法的委托，然后通过该委托调用这个方法：


   
   
  1. var setMetadataMethod = encoder.MetadataQueryWriter
  2.  .GetType()
  3.  .GetMethod(nameof(WIC.MetadataQueryWriter.SetMetadataByName), BindingFlags.NonPublic | BindingFlags.Instance);
  5. var setMetadata = (Action<string, IntPtr>)setMetadataMethod
  6.  .CreateDelegate(typeof(Action<string, IntPtr>), encoder.MetadataQueryWriter);

这样一来即可通过 setMetadata委托来调用。

不一样的Variant

SharpDX提供了一个 Variant，不代表必须要用他的 Variant，他想通过高达 300行代码的 if/else搞定一切，导致代码超级复杂。而通过查询 C++接口，我能将 Variant简化为如下一个 struct：


   
   
  1. [StructLayout(LayoutKind.Explicit)]
  2. struct PV
  3. {
  4.  [FieldOffset(0)] short VT;
  6.  [FieldOffset(8)] int Length;
  8.  [FieldOffset(8)] IntPtr StringBuffer;
  10.  [FieldOffset(8)] ushort UShortValue;
  12.  [FieldOffset(16)] IntPtr Buffer;
  14.  public static PV CreateUByteVector(int length, IntPtr buffer) => new PV
  15.  {
  16.  VT = (short)VariantType.Vector + (short)VariantElementType.UByte,
  17.  Length = length,
  18.  Buffer = buffer
  19.  };
  21.  public static PV CreateString(IntPtr buffer) => new PV
  22.  {
  23.  VT = (short)VariantElementType.StringPointer,
  24.  StringBuffer = buffer,
  25.  };
  27.  public static PV CreateUI2(ushort val) => new PV
  28.  {
  29.  VT = (short)VariantElementType.UShort,
  30.  UShortValue = val,
  31.  };
  32. }

指定/appext/Application

这是一个指向字符串的指针，正常可能要用 fixed关键字或者 Marshal.AllocHGlobal方法，但这里有更简单的办法，我可以使用 stackalloc，因为此处我具备该内存的所有权，且能精准控制它的生命周期，而且它性能也更好：


   
   
  1. // /appext/Application: NETSCAPE2.0
  2. byte* bytes = stackalloc byte[11] { 78, 69, 84, 83, 67, 65, 80, 69, 50, 46, 48 };
  3. PV pv = PV.CreateUByteVector(11, (IntPtr)bytes);
  4. setMetadata("/appext/Application", (IntPtr)(void*)&pv);

指定/appext/Data

同样的道理，将 /appext/data的 31000分配在栈上代码最简单，性能也最好：


   
   
  1. // /appext/Data: 3, 1, [0, 0], 0
  2. byte* bytes2 = stackalloc byte[5] { 3, 1, 0, 0, 0, };
  3. PV pv2 = PV.CreateUByteVector(5, (IntPtr)bytes2);
  4. setMetadata("/appext/Data", (IntPtr)(void*)&pv2);

注意，不是所有内存都能分配到栈上，它有两大限制，首先栈内存是有限的，其次，该内存必须立即被使用，否则栈销毁后这些内存指针也会立即失效。

优化

其实有了这个，还能做更多的操作。默认图片的运行速度比较慢，可以将图片的速度调快一点，这也是通过设置 /grctlext/Delay实现的，只是该 metadata是存在于帧上（而不是图片容器上）：


   
   
  1. // frame delay by 50ms.
  2. var setMetadata = (Action<string, IntPtr>)setMetadataMethod
  3.  .CreateDelegate(typeof(Action<string, IntPtr>), frame.MetadataQueryWriter);
  4. var pv = PV.CreateUI2(5);
  5. setMetadata("/grctlext/Delay", (IntPtr)(void*)&pv);

我设置的是 5，代表 50ms，该值的意思就是乘以 10ms，如 10就代表 100ms，每一帧都可以不一样。如果不设置，那就由呈现器决定 gif播放的速度，大部分播放器都是 100ms。如果设置为 1或者 0，则会被呈现器忽略，如果想要在浏览器上运行，我亲测最低可以设置的值为 2。

下图为默认效果： 

下图为 50ms效果： 

下图为 20ms效果： 

还能如指定 Gif的 Comment字段，可以给自己做一个签名：


   
   
  1. // "/commentext/TextEntry": "Created by Flysha.Zhou\0"
  2. var commentsBytes = Encoding.UTF8.GetBytes("Created by Flysha.Zhou\0");
  3. fixed (byte* p = commentsBytes)
  4. {
  5.  var pv3 = PV.CreateString((IntPtr)p);
  6.  setMetadata("/commentext/TextEntry", (IntPtr)(void*)&pv3);
  7. }

结语

上述代码都已经上传到了我的博客 Github中： https://github.com/sdcb/blog-data/tree/master/2019/20191127-the-variant-bug-in-sharpdx

由于 SharpDX官方已经停止维护，但迟迟又没有其它包顶上，官方是不可能修这些东西????，这些坑只能自己默默踩了（这波“福报”只能默默领好了）。有时我觉得要是脾气来了，我甚至可以 SharpDX拿过来自己维护一个发行版，因为 SharpDX在平时的生活工作中实在是太常用、太常见了。

微信不能评论，有想法的朋友可以点击阅读原文，或者到这个地址（博客园）进行点赞/评论：https://www.cnblogs.com/sdflysha/p/20191127-the-variant-bug-in-sharpdx.html

喜欢的朋友 请关注我的微信公众号：【DotNet骚操作】

dotNET跨平台
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
C# 从零开始写 SharpDx 应用 初始化dx修改颜色
lindexi
08-27 5743
本文来告诉大家如何在上一篇博客创建的窗口里面使用 Sharpdx 初始化，然后设置窗口颜色
C# 从零开始写 SharpDx 应用 画三角
lindexi
09-30 7746
在当前的画面都是使用三角形，在开始就告诉大家如何画三角，本文告诉大家如何用像素著色器画
【原创】SharpDX第七个例子_ 观察变换和投影变换
12-29
到这里，可以说是初步可用了。 SharpDX的Winform窗口，渲染在Panel中。 使用的非原有例子中的自带窗口。 使用Effect，运用shader渲染三角形 。 自定义根图层和根图元 。添加图层列表。使用矩阵及自定义顶点格式。 使用顶点索引并添加纹理。添加了观察变化和投影矩阵。 https://download.csdn.net/download/jsy000/10886402的后续。
SharpDX - 高性能的.NET DirectX API库
gitblog_00076的博客
03-16 691
SharpDX - 高性能的.NET DirectX API库 SharpDXSharpDX GitHub Repository项目地址:https://gitcode.com/gh_mirrors/sh/SharpDX 是一个开源的.NET库，用于访问DirectX API，包括Direct3D 11、Direct2D 1.1、DirectWrite、XInput、Windows Media ...
WPF 使用 SharpDx 异步渲染
lindexi
06-29 2168
本文告诉大家如何通过 SharpDx 进行异步渲染，但是因为在 WPF 是需要使用 D3DImage 画出来，所以渲染只是画出图片，最后的显示还是需要 WPF 在他自己的主线程渲染
C# 从零开始写 SharpDx 应用 控制台创建 Sharpdx 窗口
lindexi
06-29 5545
本文告诉大家如何在控制台使用 SharpDx 创建窗口，这是一个底层的博客，我会用很多博客告诉大家如何从控制台创建一个高性能渲染程序
c语言小游戏之坑爹大冒险
03-27
总的来说，"c语言小游戏之坑爹大冒险"不仅是一次娱乐体验，更是一个实践和提升C语言技能的机会。通过参与这个游戏的编写和调试，学习者可以巩固基础知识，锻炼问题解决能力，并逐步培养出良好的编程习惯和思维模式，...
坑爹跑酷（马里奥改版）
04-09
超级有趣的坑爹跑酷！！！ 能坑到让你怀疑人生的...新增排行榜，让你与对手一决高下！！！ 作者亲自测试 所有关卡均可通关 满分100分 你能夺得多少分呢？ 赶快下载试试看吧！！！ Tip： ▄█▀█● 马里奥改版 简化版
基于c语言实现的坑爹大冒险游戏
最新发布
05-11
【基于C语言实现的坑爹大冒险游戏】是一款利用C语言编程技术开发的趣味游戏，旨在为学习者提供一个实践C语言技术的平台，同时也适合有一定基础的学习者进行进阶练习。这款游戏的设计不仅考验编程技能，还融入了创新...
扒一扒ZYNQ里面那些坑爹的缩写
07-20
本文介绍与XILINX的EPP平台成员, ZYNQ芯片相关的缩写术语和含义. 与简单翻译术语不同,本文对每个缩写在本行业其他公司的展开含义也略作介绍, 避免混淆. 对术语的技术功能也作简单介绍.
【原创】SharpDX第一个Winform窗口
09-11
第一个SharpDX的Winform窗口，渲染在Panel中。 使用的非原有例子中的自带窗口。
用户体验，如何不坑爹？
03-03
用户体验是一种纯主观在用户使用产品过程中建立起来的感受。新竞争力在网络营销基础与实践中曾提到计算机技术和互联网的发展，使技术创新形态正在发生转变，以用户为中心、以人为本越来越得到重视……（以下省略好多...
C# DirectX API Face-off: SlimDX vs SharpDX – Which should you choose?
fish_mai的专栏
10-21 3190
A question I often see asked by beginning game programmers on the internet is: I want to code my game in C#. Which DirectX wrapper API should I use? As with most such things, all choices hav
c#图像处理入门(-bitmap类和图像像素值获取方法)
hududumo
07-07 1686
一．Bitmap类 Bitmap对象封装了ＧＤＩ+中的一个位图，此位图由图形图像及其属性的像素数据组成.因此Bitmap是用于处理由像素数据定义的图像的对象.该类的主要方法和属性如下： 1. GetPixel方法和SetPixel方法：获取和设置一个图像的指定像素的颜色. 2. PixelFormat属性：返回图像的像素格式. 3. Palette属性：获取和设置图像所使用的颜色调色板. ...
C# 从零开始写 SharpDx 应用 聊聊功能等级
lindexi
01-12 1110
本文将和大家聊聊 DirectX 里面的功能等级在 SharpDx 的使用方法 本文是 SharpDX 系列博客，更多博客请点击SharpDX 系列 在C# 控制台创建 Sharpdx 窗口已经创建了一个窗口，现在需要在这个窗口初始化。因为是从零开始写，所以需要非常多细节，我觉得一篇文章是很难全部告诉大家，所以分为了系列的文章。从零开始写有利于大家了解一个渲染框架是如何做出来，并且从底层优...
棒！使用.NET Core构建3D游戏引擎
weixin_33716154的博客
01-28 339
原文地址：https://mellinoe.wordpress.com/2017/01/18/net-core-game-engine/ 作者：ERIC MELLINO 翻译：杨晓东(Savorboard) 译者序 通过翻译这篇文章，我感受到了 .NET Core 真正的魅力，它真的是无所不能，相信在以后，.NET Core 一定会大放异彩，而.NET的 开源也会吸引越来越来的开发者参与其中。...
C# 从零开始写 SharpDx 应用 从 D3DDevice 获取 DXGIDevice 方法
lindexi
01-12 1638
本文将告诉大家在拿到了 D3D11 的 Device 也就是 D3DDevice 之后，如何去获取 DXGI.Device 以及 DXGI.Factory 的方法 本文是 SharpDX 系列博客，更多博客请点击SharpDX 系列 在 C# 从零开始写 SharpDx 应用 初始化dx修改颜色 这篇博客完成了基础的初始化 而接下来如何根据之前的代码，也就是如何根据上一篇博客创建的 D3D...
2019-9-20-SharpDx-的代替项目
lindexi
11-21 783
title author date CreateTime categories SharpDx 的代替项目 lindexi 2019-09-20 09:13:59 +0800 2019-09-20 09:13:58 +0800 现在 SharpDx 已经不维护了，如果还需要在 ...
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值