Video and Vision Processing Suite Intel® FPGA IPユーザーガイド

ID 683329
日付 6/26/2023
Public
ドキュメント目次
1. Video and Vision Processing Suiteについて 2. Video and Vision Processing IPのスタートガイド 3. Video and Vision Processing IPの機能の説明 4. Video and Vision Processing IPインターフェイス 5. Video and Vision Processing IPレジスター 6. Video and Vision Processing IPのソフトウェア・プログラミング・モデル 7. Protocol Converter Intel® FPGA IP 8. 3D LUT Intel® FPGA IP 9. AXI-Stream Broadcaster Intel® FPGA IP 10. Bits per Color Sample Adapter Intel FPGA IP 11. Chroma Key Intel® FPGA IP 12. Chroma Resampler Intel® FPGA IP 13. Clipper Intel® FPGA IP 14. Clocked Video Input Intel® FPGA IP 15. Clocked Video to Full-Raster Converter Intel® FPGA IP 16. Clocked Video Output Intel® FPGA IP 17. Color Space Converter Intel® FPGA IP 18. Deinterlacer Intel® FPGA IP 19. FIR Filter Intel® FPGA IP 20. Frame Cleaner Intel® FPGA IP 21. Full-Raster to Clocked Video Converter Intel® FPGA IP 22. Full-Raster to Streaming Converter Intel® FPGA IP 23. Genlock Controller Intel® FPGA IP 24. Generic Crosspoint Intel® FPGA IP 25. Genlock Signal Router Intel® FPGA IP 26. Guard Bands Intel® FPGA IP 27. Interlacer Intel® FPGA IP 28. Mixer Intel® FPGA IP 29. Parallel Converter Intel® FPGA IPのピクセル 30. Scaler Intel® FPGA IP 31. Stream Cleaner Intel® FPGA IP 32. Switch Intel® FPGA IP 33. Tone Mapping Operator Intel® FPGA IP 34. Test Pattern Generator Intel® FPGA IP 35. Video and Vision Monitor Intel FPGA IP 36. Video Frame Buffer Intel® FPGA IP 37. Video Frame Reader Intel FPGA IP 38. Video Frame Writer Intel FPGA IP 39. Video Streaming FIFO Intel® FPGA IP 40. Video Timing Generator Intel® FPGA IP 41. Warp Intel® FPGA IP 42. デザイン・セキュリティー 43. Video and Vision Processing Suiteユーザーガイドの文書改訂履歴

27.5. Interlacer IPのソフトウェアAPI

IPには、ランタイム制御用のソフトウェアが含まれています。このIPは、Nios II HALによって提供されている汎用デバイスモデルのいずれにも適合せず、コントロール・レジスターおよびステータスレジスターへの専用アクセサーのセットを公開します。IPドライバー構造は基本ドライバー構造を継承するため、 Video and Vision Processing IPのソフトウェアAPI で定義されているすべての一般的なメソッドを適用できます。

レジスター定義ヘッダーファイル: intel_vvp_interlacer_regs.h

インクルード・ファイル: intel_vvp_interlacer.h

表 448.  Interlacer IPのソフトウェアAPI
名前 説明
intel_vvp_interlacer_init インターレーサー・インスタンスを初期化します。
intel_vvp_core_* Video and Vision Processing IPのソフトウェア・プログラミング・モデル で定義されたアクセサー。Lite modeがオンのときに書き込み可能。Lite modeがオフで Debug featuresがオンの場合に読み出し可能です。
intel_vvp_interlacer_get_lite_mode Lite modeがオンの場合に返します。
intel_vvp_interlacer_get_debug_enabled Debug featuresがオンの場合に返します。
intel_vvp_interlacer_is_running 現在、IPがデータを処理しているかどうかを返します。
intel_vvp_interlacer_get_commit_status IPにコミットされていない書き込みがある場合に返します。
intel_vvp_interlacer_get_status ステータスレジスターを読み出します。
intel_vvp_interlacer_set_enable インターレースをイネーブルまたはディスエーブルします。
intel_vvp_interlacer_enable

インターレースをイネーブルします。

intel_vvp_interlacer_disable

インターレースをディスエーブルします。

intel_vvp_interlacer_set_ctrl_override 画像情報パケットを使用して、フルバリアントで保持する行を選択することをイネーブルまたはディスエーブルにします。
intel_vvp_interlacer_set_f1_first 出力インターレース・ストリームがF0で始まるかF1で始まるかを選択します。
intel_vvp_interlacer_is_enabled インターレーサーのイネーブルまたはディスエーブルのステータスを返します。
intel_vvp_interlacer_get_ctrl_override 画像情報パケットが破棄する行を選択するかどうかを返します。
intel_vvp_interlacer_get_f1_first 出力インターレース・ストリームがF0、またはF1のどちらで始まるかを選択します。
intel_vvp_interlacer_commit_writes すべての未処理の書き込みをコミットします。

intel_vvp_interlacer_init

プロトタイプ
int intel_vvp_interlacer_init(intel_vvp_interlacer_instance *instance, intel_vvp_core_base base);
説明

インターレーサーのインスタンスを初期化します。ベースアドレスで読み出されたベンダーIDまたは製品IDが一致しない場合、またはレジスターマップのバージョンがサポートされていない場合、初期化は早期に停止します。それ以外の場合、関数はIPコンパイル時のパラメーター化の読み出しと格納に進みます。インスタンスは完全に初期化されていないため、ゼロ以外のエラーコードを返した場合、アプリケーションはそれ以上使用しないでください。

引数

インスタンス - intel_vvp_interlacer_instance ソフトウェア・ドライバー・インスタンス構造体へのポインター

ベース - レジスターマップのベースアドレス

戻り値

成功の場合はkIntelVvpCoreOk (0)、エラーの場合は負のエラーコード

コアのベンダーIDがインテルFPGAベンダーID (0x6AF7) ではない場合は、kIntelVvpCoreVidErr

product_idがInterlacer製品IDと一致しない場合、kIntelVvpCorePidErr

インスタンスがヌルポインターの場合は、kIntelVvpCoreInstanceErr

レジスターマップがサポートされていない場合は、kIntelVvpInterlacerRegMapVersionErr

intel_vvp_interlacer_get_lite_mode

プロトタイプ
bool intel_vvp_interlacer_get_lite_mode(intel_vvp_interlacer_instance *instance);
説明

LITE_MODE レジスターの値を返します。インスタンスは、完全に初期化された有効な intel_vvp_interlacer_instance である必要があります。

引数

インスタンス - intel_vvp_interlacer_instance ソフトウェア・ドライバー・インスタンス構造体へのポインター

戻り値

IPがライトモードでパラメーター化されている場合は、true

intel_vvp_interlacer_get_debug_enabled

プロトタイプ
bool intel_vvp_interlacer_get_debug_enabled(intel_vvp_interlacer_instance *instance);
説明

DEBUG_ENABLED レジスターの値を返します。インスタンスは、完全に初期化された有効な intel_vvp_interlacer_instance である必要があります。

引数

インスタンス - intel_vvp_interlacer_instance ソフトウェア・ドライバー・インスタンス構造体へのポインター

戻り値

IPがデバッグ機能ONでパラメーター化されている場合は、Trueを返します。

intel_vvp_interlacer_is_running

プロトタイプ
bool intel_vvp_interlacer_is_running(intel_vvp_interlacer_instance* instance);
説明

STATUS レジスターの実行ビットを読み出して返します。インスタンスは、完全に初期化された有効な intel_vvp_interlacer_instance である必要があります。

引数

インスタンス - intel_vvp_interlacer_instance ソフトウェア・ドライバー・インスタンス構造体へのポインター

戻り値

IPが現在入力フィールドを受信または格納している場合はTrue、2つの入力フィールドの間にある場合はFalseを返します。

intel_vvp_interlacer_get_commit_status

プロトタイプ
bool intel_vvp_interlacer_get_commit_status(intel_vvp_interlacer_instance* instance);
説明

STATUS レジスターのコミット・ペンディング・ビットを読み出して返します。インスタンスは、完全に初期化され、フルモードでコンフィグレーションされた有効な intel_vvp_interlacer_instance である必要があります。

引数

インスタンス - intel_vvp_interlacer_instance ソフトウェア・ドライバー・インスタンス構造体へのポインター

戻り値

IPがフルモードでコンフィグレーションされており、エージェント・インターフェイスにコミットされていない書き込みが含まれている場合は、Trueとなります。

intel_vvp_interlacer_get_status

プロトタイプ
uint32_t intel_vvp_interlacer_get_status(intel_vvp_interlacer_instance* instance);
説明

STATUS レジスタを読み出します。インスタンスは、完全に初期化された有効な intel_vvp_interlacer_instance である必要があります。

引数

インスタンス - intel_vvp_interlacer_instance ソフトウェア・ドライバー・インスタンス構造体へのポインター

戻り値

STATUS レジスターの内容

intel_vvp_interlacer_set_enable

プロトタイプ
int intel_vvp_interlacer_set_enable(intel_vvp_interlacer_instance *instance, bool enable);
説明

ENABLE レジスターに書き込み、インターレースをイネーブルまたはディスエーブルします。インスタンスは、完全に初期化された有効な intel_vvp_interlacer_instance である必要があります。

引数

インスタンス - intel_vvp_interlacer_instance ソフトウェア・ドライバー・インスタンス構造体へのポインター

イネーブル - インターレースをイネーブルする場合はTrue、入力パススルーの場合はFalse

戻り値

成功の場合はkIntelVvpCoreOk、失敗の場合は負のエラーコード

インスタンスが無効な場合、kIntelVvpCoreInstanceErr

intel_vvp_interlacer_enable

プロトタイプ
int intel_vvp_interlacer_enable(intel_vvp_interlacer_instance *instance);
説明

インターレースをイネーブルします。インスタンスは、完全に初期化された有効な intel_vvp_interlacer_instance である必要があります。

引数

インスタンス - intel_vvp_interlacer_instance ソフトウェア・ドライバー・インスタンス構造体へのポインター

戻り値

成功の場合はkIntelVvpCoreOk、失敗の場合は負のエラーコード

インスタンスが無効な場合、kIntelVvpCoreInstanceErr

intel_vvp_interlacer_disable

プロトタイプ
int intel_vvp_interlacer_disable(intel_vvp_interlacer_instance *instance);
説明

インターレースをディスエーブルし、入力パススルーをイネーブルします。

引数

インスタンス - intel_vvp_interlacer_instance ソフトウェア・ドライバー・インスタンス構造体へのポインター

戻り値

成功の場合はkIntelVvpCoreOk、失敗の場合は負のエラーコード

インスタンスが無効な場合、kIntelVvpCoreInstanceErr

intel_vvp_interlacer_set_ctrl_override

プロトタイプ
int intel_vvp_interlacer_set_ctrl_override(intel_vvp_interlacer_instance* instance, bool ctrl_override);
説明

CTRL_OVERRIDE レジスターに書き込み、画像情報パケットのインターレース・ニブルの読み出しと使用をイネーブル/ディスエーブルし、インターレース中に保持するフィールドを選択します。インスタンスは、初期化された有効なフルバリアント intel_vvp_interlacer_instance である必要があります。

引数

インスタンス - intel_vvp_interlacer_instance ソフトウェア・ドライバー・インスタンス構造体へのポインター

ctrl_override - 画像情報パケットでインターレース・ニブルの使用をイネーブルする場合はTrue、それ以外の場合はFalse

戻り値

成功の場合はkIntelVvpCoreOk、失敗の場合は負のエラーコード

インスタンスが無効またはライトバリアントの場合は、kIntelVvpCoreInstanceErr

intel_vvp_interlacer_set_f1_first

プロトタイプ
int intel_vvp_interlacer_set_f1_first(intel_vvp_interlacer_instance *instance, bool f1_first)
説明

F1_FIRST レジスターに書き込み、セットアップ変更後にどのインターレース・フィールドを最初に生成するかを選択します。

引数

インスタンス - intel_vvp_interlacer_instance ソフトウェア・ドライバー・インスタンス構造体へのポインター

f1_first - IPが入力またはコンフィグレーションの変更を検出するたびに最初にF1フィールドを出力する場合はTrue、F0で開始する場合はFalse

戻り値

成功の場合はkIntelVvpCoreOk、失敗の場合は負のエラーコード

インスタンスが無効な場合、kIntelVvpCoreInstanceErr

intel_vvp_interlacer_is_enabled

プロトタイプ
bool intel_vvp_interlacer_is_enabled(intel_vvp_interlacer_instance *instance)
説明

現在のインターレーサー動作モードを返します。インスタンスは、デバッグをオンにして完全に初期化された有効な intel_vvp_interlacer_instance である必要があります。

引数

インスタンス - intel_vvp_interlacer_instance ソフトウェア・ドライバー・インスタンス構造体へのポインター

戻り値

デバッグがオンの場合の現在のインターレーサー・コンフィグレーション。インターレーサーがアクティブな場合はTrue、プログレッシブ・パススルーの場合またはデバッグがオフの場合はFalse

intel_vvp_interlacer_get_ctrl_override

プロトタイプ
bool intel_vvp_interlacer_get_ctrl_override(intel_vvp_interlacer_instance *instance)
説明

現在のインターレーサーの interlacer ctrl_override 設定を返します。インスタンスは、デバッグがオンになって完全に初期化された有効なフルバリアント intel_vvp_interlacer_instance である必要があります。

引数

インスタンス - intel_vvp_interlacer_instance ソフトウェア・ドライバー・インスタンス構造体へのポインター

戻り値

インターレーサーが入力画像情報パケットのインターレース・ニブルを使用して、プログレッシブ・フレームに保持されるインターレース・フィールドを決定する場合はTrue、それ以外の場合またはデバッグがオフの場合はFalse

intel_vvp_interlacer_get_f1_first

プロトタイプ
bool intel_vvp_interlacer_get_f1_first(intel_vvp_interlacer_instance *instance)
説明

現在のインターレーサーf1の最初の設定を返します。インスタンスは、完全に初期化され、デバッグがオンになっている有効な intel_vvp_interlacer_instance である必要があります。

引数

インスタンス - intel_vvp_interlacer_instance ソフトウェア・ドライバー・インスタンス構造体へのポインター

戻り値

現在のf1_first設定、またはデバッグがオフの場合はFalse

intel_vvp_interlacer_commit_writes

プロトタイプ
int intel_vvp_interlacer_commit_writes(intel_vvp_interlacer_instance* instance)
説明

次のフィールドを処理する前に、ペンディング中の書き込みをすべてコミットします。インスタンスは有効であり、フルモードでパラメーター化されている必要があります。

引数

インスタンス - intel_vvp_interlacer_instance ソフトウェア・ドライバー・インスタンス構造体へのポインター

戻り値

成功の場合はkIntelVvpCoreOk (0)、それ以外の場合は負のエラーコード