Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/docs/Markup-Guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ default values can be changed be setting the system property listed for each:

- `MARKUP_LABELS_ENABLED`
- System property: `markup.labels.enabled`
- Default value: `true`
- Default value: `true`
- If true, add a label to each detection box.
- `MARKUP_LABELS_ALPHA`
- System property: `markup.labels.alpha`
Expand Down Expand Up @@ -80,7 +80,7 @@ default values can be changed be setting the system property listed for each:
- The CRF value can be from 0-63. Lower values mean better quality. Recommended values range from 15-35, with 31 being recommended for 1080p HD video. This property is only used if generating VP9-encoded `.webm` files
- `MARKUP_ANIMATION_ENABLED`
- System property: `markup.video.animation.enabled`
- Default value: `true`
- Default value: `false`
- If true, draw bounding boxes to fill in the gaps between detections in each track. Interpolate size and position.

# Video Markup Icons
Expand Down Expand Up @@ -115,10 +115,10 @@ The frame above shows a paper clip icon to indicate that the detection is the re
![Walking With Border Skies](img/markup/walking-with-border-skis.jpg "Walking With Border Skis")

The frame above shows the person detection in addition to a new skis detection. The confidence for the latter is lower, which is good considering the algorithm misclassified the person's shadow as skis. The skis track is only a few frames long, so the WFM determined it was a non-moving (stationary) track. This is represented by the anchor icon at the start of the label. Also, notice that the labels are semi-transparent. This allows you to read labels and see frame content that would otherwise be hidden if the labels were completely opaque. Note that you may want to set `MARKUP_LABELS_ALPHA` to `0.75` or greater when using the `mjpeg` encoder.

# Video Encoder Considerations

Performing markup on an image will always generate a `.png` file. Performing markup on a video will generate a video file based on the value of `MARKUP_VIDEO_ENCODER`. The `vp9`, `h264`, and `mjpg` encoders are supported.
Performing markup on an image will always generate a `.png` file. Performing markup on a video will generate a video file based on the value of `MARKUP_VIDEO_ENCODER`. The `vp9`, `h264`, and `mjpg` encoders are supported.

The `vp9` and `h264` encoders serve the same purpose in that both formats can be played in the WFM web UI in most web browsers, while the `.avi` files resulting from the `mjpeg` format must be downloaded and played using a separate program like [VLC](https://www.videolan.org/vlc/index.html) or [mpv](https://mpv.io/). In general, `h264` encoding is much faster than `vp9` encoding, so you may want to use it instead of `vp9`. Please be aware that you may be required to pay [Usage Royalties](License-And-Distribution.md#usage-royalties) when using the `h264` encoder for commercial purposes.

Expand Down
400 changes: 390 additions & 10 deletions docs/docs/html/REST-API.html

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions docs/site/Markup-Guide/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -252,7 +252,7 @@ <h1 id="configuration">Configuration</h1>
<ul>
<li><code>MARKUP_LABELS_ENABLED</code><ul>
<li>System property: <code>markup.labels.enabled</code></li>
<li>Default value: <code>true</code> </li>
<li>Default value: <code>true</code></li>
<li>If true, add a label to each detection box.</li>
</ul>
</li>
Expand Down Expand Up @@ -346,7 +346,7 @@ <h1 id="configuration">Configuration</h1>
</li>
<li><code>MARKUP_ANIMATION_ENABLED</code><ul>
<li>System property: <code>markup.video.animation.enabled</code></li>
<li>Default value: <code>true</code></li>
<li>Default value: <code>false</code></li>
<li>If true, draw bounding boxes to fill in the gaps between detections in each track. Interpolate size and position.</li>
</ul>
</li>
Expand Down Expand Up @@ -405,7 +405,7 @@ <h1 id="video-markup-examples">Video Markup Examples</h1>
<p><img alt="Walking With Border Skies" src="../img/markup/walking-with-border-skis.jpg" title="Walking With Border Skis" /></p>
<p>The frame above shows the person detection in addition to a new skis detection. The confidence for the latter is lower, which is good considering the algorithm misclassified the person's shadow as skis. The skis track is only a few frames long, so the WFM determined it was a non-moving (stationary) track. This is represented by the anchor icon at the start of the label. Also, notice that the labels are semi-transparent. This allows you to read labels and see frame content that would otherwise be hidden if the labels were completely opaque. Note that you may want to set <code>MARKUP_LABELS_ALPHA</code> to <code>0.75</code> or greater when using the <code>mjpeg</code> encoder.</p>
<h1 id="video-encoder-considerations">Video Encoder Considerations</h1>
<p>Performing markup on an image will always generate a <code>.png</code> file. Performing markup on a video will generate a video file based on the value of <code>MARKUP_VIDEO_ENCODER</code>. The <code>vp9</code>, <code>h264</code>, and <code>mjpg</code> encoders are supported. </p>
<p>Performing markup on an image will always generate a <code>.png</code> file. Performing markup on a video will generate a video file based on the value of <code>MARKUP_VIDEO_ENCODER</code>. The <code>vp9</code>, <code>h264</code>, and <code>mjpg</code> encoders are supported.</p>
<p>The <code>vp9</code> and <code>h264</code> encoders serve the same purpose in that both formats can be played in the WFM web UI in most web browsers, while the <code>.avi</code> files resulting from the <code>mjpeg</code> format must be downloaded and played using a separate program like <a href="https://www.videolan.org/vlc/index.html">VLC</a> or <a href="https://mpv.io/">mpv</a>. In general, <code>h264</code> encoding is much faster than <code>vp9</code> encoding, so you may want to use it instead of <code>vp9</code>. Please be aware that you may be required to pay <a href="../License-And-Distribution/index.html#usage-royalties">Usage Royalties</a> when using the <code>h264</code> encoder for commercial purposes.</p>
<p>The <code>mjpeg</code> encoder is faster than both the <code>vp9</code> and <code>h264</code> encoders, but produces lower quality video. Specifically, the label text is not as clear. You may want to use it when developing components or marking up large video files.</p>
<p>To give you a sense of performance, here are the results of a very limited batch of tests. Note that if you choose to use the <code>vp9</code> encoder, you can increase the CRF value to reduce processing time at the cost of reduced video quality.</p>
Expand Down
Loading