Skip to content

Commit 5d1d3f0

Browse files
kekyokekyo
committed
Updated readme.
1 parent 93c85ce commit 5d1d3f0

File tree

2 files changed

+34
-18
lines changed

2 files changed

+34
-18
lines changed

Diff for: ‎README.md

+17-9
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
![FlashCap](Images/FlashCap.100.png)
44

5-
FlashCap - Independent camera capture library.
5+
FlashCap - Independent video frame capture library.
66

77
[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
88

@@ -20,10 +20,10 @@ FlashCap - Independent camera capture library.
2020

2121
## What is this?
2222

23-
Do you need to get camera capturing ability on .NET?
24-
Is you tired for camera capturing library solutions on .NET?
23+
Do you need to get video frame capturing ability on .NET?
24+
Is you tired for video frame capturing library solutions on .NET?
2525

26-
This is a camera image capture library by specializing only capturing image data (a.k.a frame grabber).
26+
This is a video frame image capture library by specializing only capturing image data (a.k.a frame grabber).
2727
It has simple API, easy to use, simple architecture and without native libraries.
2828
It also does not depend on any non-official libraries.
2929
[See NuGet dependencies page.](https://www.nuget.org/packages/FlashCap)
@@ -131,12 +131,12 @@ Published introduction article: ["Easy to implement video image capture with Fla
131131

132132
.NET platforms supported are as follows (almost all!):
133133

134-
* .NET 7, 6, 5 (`net7.0` and etc)
134+
* .NET 8 to 5 (`net8.0` and etc)
135135
* .NET Core 3.1, 3.0, 2.2, 2.1, 2.0 (`netcoreapp3.1` and etc)
136136
* .NET Standard 2.1, 2.0, 1.3 (`netstandard2.1` and etc)
137137
* .NET Framework 4.8, 4.6.1, 4.5, 4.0, 3.5 (`net48` and etc)
138138

139-
Platforms on which camera devices can be used:
139+
Platforms on which capture devices can be used:
140140

141141
* Windows (DirectShow devices, tested on x64/x86)
142142
* Windows (Video for Windows devices, tested on x64/x86)
@@ -785,13 +785,21 @@ So, if you intend to port FlashCap to an unsupported Linux platform,
785785
please refer to the following for a porting overview:
786786

787787
* `FlashCap.V4L2Generator` is a generator to automatically generate the interoperable source code needed to port to V4L2.
788-
This project is using the AST JSON files output by [Clang](https://clang.llvm.org/),
788+
This project is using the JSON AST files output by [Clang](https://clang.llvm.org/),
789789
generate C# interoperability definition source code from V4L2 header files with the correct ABI structure strictly applied.
790790
* Therefore, you will first need Clang for the target Linux ABI.
791791
For this reason, it cannot be ported into an environment where a stable ABI has not been established.
792+
* Clang versions 13, 11, and 10 are verified. Other versions may be able to build.
793+
We have verified that there may be differences in the way JSON ASTs are output.
792794
* Similarly, to run `FlashCap.V4L2Generator`, you need mono or .NET runtime running on the target Linux.
793-
* If the target Linux is a Debian-type port, these may be available from the `apt` package, for example:
794-
`sudo apt install build-essential clang mono-devel`, etc., it is more likely.
795+
* If the target Linux is a Debian-type port, these may be available from the `apt` package, for example:
796+
`sudo apt install build-essential clang-13 mono-devel`, etc., it is more likely.
797+
* To prepare a stable build environment for Linux, we strongly recommend building a virtual machine using qemu.
798+
For this purpose, we have placed automated scripts for building the environment in the `qemu-vm-builder/` directory.
799+
Please refer to the scripts and add your own so that we can build your target build environment.
800+
* The official build environment for FlashCap uses the official Debian installer.
801+
We download the `netinst` ISO image from the Debian site to generate the required virtual machines.
802+
* If you do not use Debian, or if your Debian version does not match, you may need to manually modify the generated interoperable source code.
795803
* The efforts of [issue #100](https://github.com/kekyo/FlashCap/issues/100) would also be helpful.
796804
797805
First, you need to build `FlashCap.V4L2Generator`.

Diff for: ‎README_ja.md

+17-9
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
![FlashCap](Images/FlashCap.100.png)
44

5-
FlashCap - シンプルで依存性のない、カメラキャプチャライブラリ
5+
FlashCap - シンプルで依存性のない、ビデオフレームキャプチャライブラリ
66

77
[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
88

@@ -20,10 +20,10 @@ FlashCap - シンプルで依存性のない、カメラキャプチャライブ
2020

2121
## これは何?
2222

23-
.NETでカメラキャプチャ機能を実装する必要がありますか？
24-
.NETでのカメラキャプチャライブラリに困っていますか？
23+
.NETでビデオフレームキャプチャ機能を実装する必要がありますか？
24+
.NETでのビデオフレームキャプチャライブラリに困っていますか？
2525

26-
このライブラリは、カメラのキャプチャ機能のみに特化したカメラ画像取り込みライブラリです（フレームグラバーと呼ばれることもあります）。
26+
このライブラリは、ビデオフレームのキャプチャ機能のみに特化した画像取り込みライブラリです（フレームグラバーと呼ばれることもあります）。
2727
シンプルなAPIで使いやすく、簡素なアーキテクチャで、ネイティブライブラリを含んでいません。
2828
また、公式以外の他のライブラリに依存することもありません。
2929
[NuGetの依存ページを参照して下さい](https://www.nuget.org/packages/FlashCap)
@@ -132,12 +132,12 @@ await deviceObservable.StartAsync();
132132

133133
対応する.NETプラットフォームは以下の通りです（ほぼ全てです！）:
134134

135-
* .NET 7, 6, 5 (`net7.0` and etc)
135+
* .NET 8 to 5 (`net8.0` and etc)
136136
* .NET Core 3.1, 3.0, 2.2, 2.1, 2.0 (`netcoreapp3.1` and etc)
137137
* .NET Standard 2.1, 2.0, 1.3 (`netstandard2.1` and etc)
138138
* .NET Framework 4.8, 4.6.1, 4.5, 4.0, 3.5 (`net48` and etc)
139139

140-
カメラデバイスが使用できるプラットフォーム:
140+
キャプチャデバイスが使用できるプラットフォーム:
141141

142142
* Windows (DirectShowデバイス, x64/x86)
143143
* Windows (Video for Windowsデバイス, x64/x86)
@@ -719,13 +719,21 @@ FlashCapを使って実際にカメラのキャプチャに成功したもので
719719
概要を示すので参考にしてください。
720720

721721
* `FlashCap.V4L2Generator` は、V4L2への移植に必要な相互運用ソースコードを自動生成するためのジェネレータです。
722-
このプロジェクトは、[Clang](https://clang.llvm.org/) が出力するAST JSONファイルを使用して、
722+
このプロジェクトは、[Clang](https://clang.llvm.org/) が出力するJSON ASTファイルを使用して、
723723
V4L2のヘッダファイルから、正しいABI構造を厳密に適用したC#の相互運用定義ソースコードを生成します。
724724
* 従って、まずターゲットとするLinuxのABIに対応したClangが必要になります。
725725
この理由により、安定的なABIが定まっていない環境に移植することはできません。
726+
* Clangのバージョンは、13,11,10を検証しています。これ以外のバージョンでもビルドできる場合があります。
727+
検証したところ、JSON ASTの出力方法に違いがある場合があるようです。
726728
* 同様に、`FlashCap.V4L2Generator` を動作させるために、ターゲットとするLinuxで動作するmono又は.NETランタイムが必要です。
727-
* ターゲットLinuxがDebian系の移植であれば、これらは `apt` パッケージなどから入手可能かもしれません。
728-
`sudo apt install build-essential clang mono-devel` などでインストール出来れば、可能性が高まります。
729+
* ターゲットLinuxがDebian系の移植であれば、これらは `apt` パッケージなどから入手可能かもしれません。
730+
`sudo apt install build-essential clang-13 mono-devel` などでインストール出来れば、可能性が高まります。
731+
* Linuxの安定的なビルド環境を準備するために、qemuを使用した仮想マシンの構築を強く推奨します。
732+
この目的のために、 `qemu-vm-builder/` ディレクトリに、環境構築用の自動化スクリプトを配置しています。
733+
スクリプトを参照して、あなたのターゲットとなるビルド環境を構築できるように、スクリプトを追加してください。
734+
* FlashCapの公式のビルド環境は、Debianの公式インストーラーを用いています。
735+
Debianのサイトから、 `netinst` ISOイメージをダウンロードして、必要な仮想マシンを生成しています。
736+
* Debianを使わない場合や、Debianのバージョンが一致しない場合は、生成される相互運用ソースコードに手動で修正を行う必要があるかもしれません。
729737
* [#100](https://github.com/kekyo/FlashCap/issues/100) の取り組みも参考になると思います。
730738
731739
最初に、 `FlashCap.V4L2Generator` をビルドする必要があります。

0 commit comments

Comments
 (0)