search

Dasharo / dasharo-issues

The Dasharo issue tracker
https://dasharo.com/
23 stars 0 forks source link

Improve DCU documentation #682

Open pietrushnic opened 6 months ago

pietrushnic commented 6 months ago

Thanks for adding custom boot logos using DCU (Dasharo Configuration Utility). This was a feature I requested in the early Dasharo Pub meetings last year where you guys asked for suggestions what we want to see in Dasharo if there were a paid version to support sustainablity of the project.

Regarding DCU... could you add some technical info what the converter is supporting. I'm looking at the source code @ https://github.com/Dasharo/dcu/blob/main/src/logo_command.sh and see a bunch of error messages already included which makes me wonder how I can minimize the chance of the image conversion failing or in other words how I can increase the chance that the source image I will provide will be succeessfully converted and included into the coreboot image.

For example the file size both of the original and converted image seem to be a limiting factor. Also the accepted source image file format seems to be PNG, JPEG, SVG or PC bitmap which is awesome but unknown to the user unless we can read about it somewhere.

Originally posted by @Firminator in https://github.com/Dasharo/dasharo-issues/issues/650#issuecomment-1890788806

pietrushnic commented 6 months ago

@BeataZdunczyk @macpijan I would appreciate the creation of a DCU milestone for the next release and adding this issue to the milestone.

mkopec commented 6 months ago

There is 1MB of space for the converted logo, but LZMA compression is applied to the logo so in practice it depends on the image's complexity. A large, complex image like a 1080p photo may not fit, but a smaller photo or a large simple image will probably fit.

We actually had some more info in the docs, but removed it when we migrated to DCU: https://github.com/Dasharo/docs/commit/9ab374589a32a17657c9f0c30c37da6637eea462#diff-0bb66ef7de2d0df01dbd761f33291ea733e6149be364e3829b0eb435e2d7a25b

Maybe we could add the requirements section back.

Firminator commented 6 months ago

Dasharo/docs@9ab3745#diff-0bb66ef7de2d0df01dbd761f33291ea733e6149be364e3829b0eb435e2d7a25b Awesome. This has the information a user might be looking for. Resolution limited to 577×432, 24bit RGB. This info now also raises a question as it says 'uncompressed', but JPG is compressed, so is JPG supported or just BMP?

mkopec commented 6 months ago

@Firminator Uncompressed in this context means the BMP file added to the ROM is in uncompressed BMP format.

This should not be a concern to the user when using DCU as it does the conversion from any JPG, SVG, PNG or BMP file to the correct BMP format automatically: https://github.com/Dasharo/dcu/blob/6817e69d8eab55bc72725a3be4a8627b8d71c31b/src/logo_command.sh#L27

Firminator commented 6 months ago

Sounds good. Thanks for the clarification.

macpijan commented 2 weeks ago

@BeataZdunczyk can we schedule that, if still relevant?