search

FileOnQ / Imaging.Heif

A C#/.NET wrapper around libheif for decoding and processing high efficiency image formats (heif, heic).
GNU Lesser General Public License v3.0
15 stars 4 forks source link

Remove experimental note on readme #82

Closed SkyeHoefling closed 2 years ago

SkyeHoefling commented 2 years ago

Fixes: n/a (docs)

Description

Updates the readme to remove experimental note

Merge Checklist

github-actions[bot] commented 2 years ago

Benchmark Comparison - .NET Framework 4.8

Benchmarking comparison between this Pull Request and the comitted values at benchmarks/results

thumbnail

 summary:
better: 4, geomean: 1.364
total diff: 4

No Slower results for the provided threshold = 10% and noise filter = 0.3ns.

| Faster                                                       | base/diff | Base Median (ns) | Diff Median (ns) | Modality|
| ------------------------------------------------------------ | ---------:| ----------------:| ----------------:| --------:|
| FileOnQ.Imaging.Heif.Benchmarks.Thumbnail.Thumbnail_ToSpan   |      1.42 |      58913500.00 |      41513750.00 |         |
| FileOnQ.Imaging.Heif.Benchmarks.Thumbnail.Thumbnail_ToArray  |      1.41 |      58636250.00 |      41587650.00 |         |
| FileOnQ.Imaging.Heif.Benchmarks.Thumbnail.Thumbnail_ToStream |      1.40 |      59449850.00 |      42452700.00 |         |
| FileOnQ.Imaging.Heif.Benchmarks.Thumbnail.Thumbnail_Write    |      1.24 |      59505900.00 |      48125600.00 |         |

No file given

primary

 No differences found between the benchmark results with threshold 10%.

Benchmark Results - .NET Framework 4.8

thumbnail

``` ini BenchmarkDotNet=v0.13.1, OS=Windows 10.0.17763.2452 (1809/October2018Update/Redstone5), VM=Hyper-V Intel Xeon Platinum 8272CL CPU 2.60GHz, 1 CPU, 2 logical and 2 physical cores [Host] : .NET Framework 4.8 (4.8.4420.0), X64 RyuJIT Job-GHSIOX : .NET Framework 4.8 (4.8.4420.0), X64 RyuJIT Runtime=.NET Framework 4.8 InvocationCount=1 LaunchCount=1 UnrollFactor=1 ``` | Method | Mean | Error | StdDev | Allocated native memory | Native memory leak | Allocated | |------------------- |---------:|---------:|---------:|------------------------:|-------------------:|----------:| | Thumbnail_Write | 47.56 ms | 0.948 ms | 1.827 ms | 5,123,907 B | - | 74,504 B | | Thumbnail_ToArray | 41.94 ms | 0.815 ms | 0.723 ms | 5,123,579 B | - | 74,504 B | | Thumbnail_ToSpan | 41.54 ms | 0.152 ms | 0.119 ms | 5,123,563 B | - | - | | Thumbnail_ToStream | 42.55 ms | 0.849 ms | 0.663 ms | 5,123,563 B | - | 140,816 B |

primary

``` ini BenchmarkDotNet=v0.13.1, OS=Windows 10.0.17763.2452 (1809/October2018Update/Redstone5), VM=Hyper-V Intel Xeon CPU E5-2673 v4 2.30GHz, 1 CPU, 2 logical and 2 physical cores [Host] : .NET Framework 4.8 (4.8.4420.0), X64 RyuJIT Job-GHSIOX : .NET Framework 4.8 (4.8.4420.0), X64 RyuJIT Runtime=.NET Framework 4.8 InvocationCount=1 LaunchCount=1 UnrollFactor=1 ``` | Method | Mean | Error | StdDev | Allocated native memory | Native memory leak | Allocated | |---------------------- |--------:|---------:|---------:|------------------------:|-------------------:|------------:| | PrimaryImage_Write | 2.852 s | 0.0535 s | 0.0549 s | 222,028,750 B | - | 1,951,112 B | | PrimaryImage_ToArray | 2.619 s | 0.0520 s | 0.1267 s | 222,028,614 B | - | 1,951,112 B | | PrimaryImage_ToSpan | 2.714 s | 0.0541 s | 0.0990 s | 222,028,406 B | - | - | | PrimaryImage_ToStream | 2.776 s | 0.0544 s | 0.1099 s | 222,028,646 B | - | 3,894,032 B |

Benchmark Comparison - .NET 5

Benchmarking comparison between this Pull Request and the comitted values at benchmarks/results

thumbnail

 summary:
better: 4, geomean: 1.291
total diff: 4

No Slower results for the provided threshold = 10% and noise filter = 0.3ns.

| Faster                                                       | base/diff | Base Median (ns) | Diff Median (ns) | Modality|
| ------------------------------------------------------------ | ---------:| ----------------:| ----------------:| --------:|
| FileOnQ.Imaging.Heif.Benchmarks.Thumbnail.Thumbnail_ToArray  |      1.38 |      58728450.00 |      42608500.00 |         |
| FileOnQ.Imaging.Heif.Benchmarks.Thumbnail.Thumbnail_Write    |      1.36 |      59536600.00 |      43700250.00 |         |
| FileOnQ.Imaging.Heif.Benchmarks.Thumbnail.Thumbnail_ToSpan   |      1.22 |      57887100.00 |      47591950.00 |         |
| FileOnQ.Imaging.Heif.Benchmarks.Thumbnail.Thumbnail_ToStream |      1.22 |      58199200.00 |      47895200.00 |         |

No file given

primary

 summary:
better: 4, geomean: 1.213
total diff: 4

No Slower results for the provided threshold = 10% and noise filter = 0.3ns.

| Faster                                                             | base/diff | Base Median (ns) | Diff Median (ns) | Modality|
| ------------------------------------------------------------------ | ---------:| ----------------:| ----------------:| --------:|
| FileOnQ.Imaging.Heif.Benchmarks.PrimaryImage.PrimaryImage_ToStream |      1.22 |    2982379850.00 |    2450903300.00 |         |
| FileOnQ.Imaging.Heif.Benchmarks.PrimaryImage.PrimaryImage_Write    |      1.21 |    2905592400.00 |    2393362150.00 |         |
| FileOnQ.Imaging.Heif.Benchmarks.PrimaryImage.PrimaryImage_ToSpan   |      1.21 |    2976810300.00 |    2452360800.00 |         |
| FileOnQ.Imaging.Heif.Benchmarks.PrimaryImage.PrimaryImage_ToArray  |      1.21 |    2920373000.00 |    2417330600.00 |         |

No file given

Benchmark Results - .NET 5

thumbnail

``` ini BenchmarkDotNet=v0.13.1, OS=Windows 10.0.17763.2452 (1809/October2018Update/Redstone5) Intel Xeon Platinum 8272CL CPU 2.60GHz, 1 CPU, 2 logical and 2 physical cores .NET SDK=6.0.101 [Host] : .NET 5.0.8 (5.0.821.31504), X64 RyuJIT Job-GIXZFW : .NET 5.0.8 (5.0.821.31504), X64 RyuJIT Runtime=.NET 5.0 InvocationCount=1 LaunchCount=1 UnrollFactor=1 ``` | Method | Mean | Error | StdDev | Allocated native memory | Native memory leak | Allocated | |------------------- |---------:|---------:|---------:|------------------------:|-------------------:|----------:| | Thumbnail_Write | 43.87 ms | 0.776 ms | 0.688 ms | 5,124,409 B | - | 288 B | | Thumbnail_ToArray | 42.79 ms | 0.625 ms | 0.584 ms | 5,123,853 B | - | 66,408 B | | Thumbnail_ToSpan | 47.19 ms | 0.938 ms | 1.567 ms | 5,123,853 B | - | 120 B | | Thumbnail_ToStream | 47.45 ms | 0.945 ms | 1.630 ms | 5,123,853 B | - | 66,472 B |

primary

``` ini BenchmarkDotNet=v0.13.1, OS=Windows 10.0.17763.2452 (1809/October2018Update/Redstone5) Intel Xeon Platinum 8272CL CPU 2.60GHz, 1 CPU, 2 logical and 2 physical cores .NET SDK=6.0.101 [Host] : .NET 5.0.8 (5.0.821.31504), X64 RyuJIT Job-YYBJCL : .NET 5.0.8 (5.0.821.31504), X64 RyuJIT Runtime=.NET 5.0 InvocationCount=1 LaunchCount=1 UnrollFactor=1 ``` | Method | Mean | Error | StdDev | Allocated native memory | Native memory leak | Allocated | |---------------------- |--------:|---------:|---------:|------------------------:|-------------------:|------------:| | PrimaryImage_Write | 2.396 s | 0.0082 s | 0.0072 s | 222,029,428 B | - | 256 B | | PrimaryImage_ToArray | 2.422 s | 0.0108 s | 0.0101 s | 222,028,856 B | - | 1,943,008 B | | PrimaryImage_ToSpan | 2.452 s | 0.0066 s | 0.0062 s | 222,028,920 B | - | 88 B | | PrimaryImage_ToStream | 2.451 s | 0.0037 s | 0.0035 s | 222,028,936 B | - | 1,943,072 B |

Benchmark Comparison - .NET 6

Benchmarking comparison between this Pull Request and the comitted values at benchmarks/results

thumbnail

 No differences found between the benchmark results with threshold 10%.

primary

 summary:
better: 4, geomean: 1.192
total diff: 4

No Slower results for the provided threshold = 10% and noise filter = 0.3ns.

| Faster                                                             | base/diff | Base Median (ns) | Diff Median (ns) | Modality|
| ------------------------------------------------------------------ | ---------:| ----------------:| ----------------:| --------:|
| FileOnQ.Imaging.Heif.Benchmarks.PrimaryImage.PrimaryImage_ToStream |      1.21 |    2979033400.00 |    2470791800.00 |         |
| FileOnQ.Imaging.Heif.Benchmarks.PrimaryImage.PrimaryImage_ToSpan   |      1.20 |    2975119200.00 |    2474769100.00 |         |
| FileOnQ.Imaging.Heif.Benchmarks.PrimaryImage.PrimaryImage_Write    |      1.18 |    2872608900.00 |    2427581600.00 |         |
| FileOnQ.Imaging.Heif.Benchmarks.PrimaryImage.PrimaryImage_ToArray  |      1.18 |    2893204600.00 |    2459273400.00 |         |

No file given

Benchmark Results - .NET 6

thumbnail

``` ini BenchmarkDotNet=v0.13.1, OS=Windows 10.0.17763.2452 (1809/October2018Update/Redstone5) Intel Xeon CPU E5-2673 v4 2.30GHz, 1 CPU, 2 logical and 2 physical cores .NET SDK=6.0.101 [Host] : .NET 6.0.1 (6.0.121.56705), X64 RyuJIT Job-NJONXQ : .NET 6.0.1 (6.0.121.56705), X64 RyuJIT Runtime=.NET 6.0 InvocationCount=1 LaunchCount=1 UnrollFactor=1 ``` | Method | Mean | Error | StdDev | Median | Allocated native memory | Native memory leak | Allocated | |------------------- |---------:|---------:|---------:|---------:|------------------------:|-------------------:|----------:| | Thumbnail_Write | 53.11 ms | 1.062 ms | 2.760 ms | 52.58 ms | 5,124,153 B | - | 832 B | | Thumbnail_ToArray | 51.69 ms | 1.028 ms | 2.319 ms | 51.31 ms | 5,123,597 B | - | 66,888 B | | Thumbnail_ToSpan | 49.46 ms | 0.985 ms | 2.763 ms | 49.21 ms | 5,123,869 B | - | 600 B | | Thumbnail_ToStream | 48.84 ms | 1.031 ms | 3.041 ms | 47.95 ms | 5,123,853 B | - | 66,952 B |

primary

``` ini BenchmarkDotNet=v0.13.1, OS=Windows 10.0.17763.2452 (1809/October2018Update/Redstone5) Intel Xeon Platinum 8272CL CPU 2.60GHz, 1 CPU, 2 logical and 2 physical cores .NET SDK=6.0.101 [Host] : .NET 6.0.1 (6.0.121.56705), X64 RyuJIT Job-TGTITH : .NET 6.0.1 (6.0.121.56705), X64 RyuJIT Runtime=.NET 6.0 InvocationCount=1 LaunchCount=1 UnrollFactor=1 ``` | Method | Mean | Error | StdDev | Allocated native memory | Native memory leak | Allocated | |---------------------- |--------:|---------:|---------:|------------------------:|-------------------:|------------:| | PrimaryImage_Write | 2.428 s | 0.0152 s | 0.0127 s | 222,029,172 B | - | 848 B | | PrimaryImage_ToArray | 2.461 s | 0.0211 s | 0.0197 s | 222,028,552 B | - | 1,943,872 B | | PrimaryImage_ToSpan | 2.474 s | 0.0285 s | 0.0266 s | 222,028,264 B | - | 616 B | | PrimaryImage_ToStream | 2.476 s | 0.0228 s | 0.0213 s | 222,028,952 B | - | 1,943,600 B |