From a9220b2b9e8676d5bc0697cc8c9913a592d780eb Mon Sep 17 00:00:00 2001 From: GOB Date: Tue, 27 Jun 2023 01:07:02 +0900 Subject: [PATCH] Update README for 0.1.1 --- README.en.md | 18 +++++++++--------- README.md | 12 +++++++----- 2 files changed, 16 insertions(+), 14 deletions(-) diff --git a/README.en.md b/README.en.md index 1304922..8ac9299 100644 --- a/README.en.md +++ b/README.en.md @@ -15,7 +15,7 @@ The data format is modified for playback. ## Overview This application streams video files converted to the dedicated format gmv from SD. It uses multi-cores to perform rendering with DMA and audio playback. -The old format gcf + wav is no longer playable since 0.1.1. Please regenerate it in gmv format or convert it using the gcf + wav => gmv conversion script. +***The old format gcf + wav is no longer playable since 0.1.1. Please regenerate it in gmv format or convert it using the gcf + wav => gmv conversion script.*** ## Target devices @@ -24,8 +24,6 @@ It must be able to run the libraries it depends on and have an SD card. * M5Stack Gray * M5Stack Core2 * M5Stack CoreS3 - -However, Basic and Gray, which do not have PSRAM, have significant limitations on the amount of time that audio can be played. ## Required libraries * [M5Unified](https://github.com/m5stack/M5Unified) @@ -54,8 +52,7 @@ However, Basic and Gray, which do not have PSRAM, have significant limitations o |S3\_release_DisplayModule| Support DisplayModule | ### Sample data for playback -Download [sample_003.zip](https://github.com/GOB52/M5Stack_FlipBookSD/files/11746898/sample_003.zip) and copy it to **/gcf** on your SD card. - +Download [sample_0_1_1.zip](https://github.com/GOB52/M5Stack_FlipBookSD/files/11871296/sample_0_1_1.zip), unzip it and copy to **/gcf** on your SD card. ## How to make data ### Required tools @@ -73,12 +70,12 @@ Video data can be in any format that can be processed by FFmpeg. 1. Copy video data to an arbitrarily created directory. 1. Copy [conv.sh](script/conv.sh) and [gmv.py](script/gmv.py) to the same directory. 1. Execute the shell script as follows -**bash conv.sh move_file_name frame_rate [ jpeg_maxumu,_size (Default if not specified is 7168) ]** +**bash conv.sh move_file_name frame_rate [ jpeg_maxumum_size (Default if not specified is 7168) ]** | Argument | Required?| Description | |---|---|---| |move_file_path|YES|Source movie| -|frame_rate|YES|Output frame rate (1 - 30)| +|frame_rate|YES|Output frame rate (1.0 - 30.0)
**Integer or decimal numbers can be specified**| |jpeg_maximum_size|NO|Maximum file size of one image to output (1024 - 10240)
Larger sizes preserve quality but are more likely to cause processing delays (see "Known Issues").| 4. The files that named "videofilename.gmv" output to same directory. @@ -91,7 +88,7 @@ cp bar.mp4 foo cp script/conv.sh foo cp script/gcf.py foo cd foo -bash conv.sh bar.mp4 24 +bash conv.sh bar.mp4 29.97 cp bar.gmv your_sd_card_path/gcf ``` @@ -113,11 +110,14 @@ You can change the output quality, filters, etc. to your liking. The best parame The quality of the audio data is lowered to reduce the processing load. Scripts can be edited to improve quality, but processing delays may occur due to processing load. (See Known Issues) -* Image size and frame rate +* Image size and frame rate When converting a video to JPEG, the width is 320px and the height is a value that maintains the aspect ratio. Currently, 320 x 240 can be played back at about 24 FPS, and 320 x 180 at about 30 FPS. To change the image size, edit the parameter for FFmpeg in conv.sh. **(scale=)** +* Image size and output device size +If the image size is narrower or wider than the output device size, it will be centered. + ## Known issues ### Audio is choppy or playback speed is slow. This may be due to the processing not being completed in time within a frame. diff --git a/README.md b/README.md index 432d7e0..21b44c2 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ SINTEL (Trailer) ## 概要 動画ファイルを専用の形式 (gmv) へ変換したファイルを SD からストリーミング再生するアプリケーションです。 マルチコアを使用して DMA による描画と、音声再生を行っています。 -旧形式である gcf + wav は 0.1.1 より再生不可となりました。gmv 形式で再生成するか、gcf + wav => gmv 変換スクリプトを用いて変換してください。 +***旧形式である gcf + wav は 0.1.1 より再生不可となりました。gmv 形式で再生成するか、gcf + wav => gmv 変換スクリプトを用いて変換してください。*** ## 対象デバイス @@ -51,7 +51,7 @@ SINTEL (Trailer) |S3\_release_DisplayModule| ディスプレイモジュール 対応| ### 再生用サンプルデータ -[sample_003.zip](https://github.com/GOB52/M5Stack_FlipBookSD/files/11746898/sample_003.zip) をダウンロードして SD カードの **/gcf** へコピーしてください。 +[sample_0_1_1.zip](https://github.com/GOB52/M5Stack_FlipBookSD/files/11871296/sample_0_1_1.zip) をダウンロードして解凍し、 SD カードの **/gcf** へコピーしてください。 ## データの作成方法 ### 必要なもの @@ -68,12 +68,12 @@ SINTEL (Trailer) 1. 任意に作ったデータ作成用ディレクトリに動画データをコピーする 1. 同ディレクトリに [conv.sh](script/conv.sh) と [gmv.py](script/gmv.py) をコピーする 1. シェルスクリプトを次のように指定して実行する。 -**bash conv.sh move_file_path frame_rate [ jpeg_maxumu,_size (無指定時は 7168) ]** +**bash conv.sh move_file_path frame_rate [ jpeg_maxumum_size (無指定時は 7168) ]** |引数|必須?|説明| |---|---|---| |move_file_path|YES|元となる動画| -|frame_rate|YES|出力されるデータの FPS (1 - 30)| +|frame_rate|YES|出力されるデータの FPS (1.0 - 30.0)
整数または小数を指定可能| |jpeg_maximum_size|NO|JPEG 1枚あたりの最大ファイルサイズ( 1024 - 10240)
大きいと品質が維持されるが処理遅延が発生する可能性が高くなる(既知の問題参照)| 4. 動画ファイル名.gmv が出力される。 @@ -86,7 +86,7 @@ cp bar.mp4 foo cp script/conv.sh foo cp script/gcf.py foo cd foo -bash conv.sh bar.mp4 24 +bash conv.sh bar.mp4 29.97 cp bar.gmv your_sd_card_path/gcf ``` @@ -113,6 +113,8 @@ ffmpeg -i $1 -r $2 -vf scale=320:-1,dejudder -qmin 1 -q 1 jpg$$/%06d.jpg 現在の所 320 x 240 で 24 FPS 程度、 320 x 180 で 30 FPS 程度の再生が可能です。 画像サイズを変更したい場合は [conv.sh](conv.sh) の FFmpeg へ与えているパラメータを変更してください。 **(scale=)** +* 画像サイズと出力先サイズ +画像データが出力先サイズに満たない、または逸脱する場合は、センタリングして表示されます。 ## 既知の問題 ### 音声が途切れる、再生速度が遅い