Skip to content

Commit 1e2c6ad

Browse files
jrobblejrobble
authored
Update release notes for R7.1.1. (#160)
* Add HAS_CONSTANT_FRAME_RATE.
1 parent 1085e27 commit 1e2c6ad

11 files changed

Lines changed: 231 additions & 34 deletions

File tree

‎docs/docs/CPP-Batch-Component-API.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -611,6 +611,7 @@ MPFVideoJob(
611611
<li><code>MIME_TYPE</code> : the MIME type of the media</li>
612612
<li><code>FRAME_WIDTH</code> : the width of a frame in pixels</li>
613613
<li><code>FRAME_HEIGHT</code> : the height of a frame in pixels</li>
614+
<li><code>HAS_CONSTANT_FRAME_RATE</code> : set to true if the video has a constant frame rate; otherwise, omitted or set to false if the video has variable frame rate or the type of frame rate cannot be determined</li>
614615
</ul>
615616
May include the following key-value pair:
616617
<ul>

‎docs/docs/Java-Batch-Component-API.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -605,6 +605,7 @@ public MPFVideoJob(
605605
<li><code>MIME_TYPE</code> : the MIME type of the media</li>
606606
<li><code>FRAME_WIDTH</code> : the width of a frame in pixels</li>
607607
<li><code>FRAME_HEIGHT</code> : the height of a frame in pixels</li>
608+
<li><code>HAS_CONSTANT_FRAME_RATE</code> : set to true if the video has a constant frame rate; otherwise, omitted or set to false if the video has variable frame rate or the type of frame rate cannot be determined</li>
608609
</ul>
609610
May include the following key-value pair:
610611
<ul>

‎docs/docs/Python-Batch-Component-API.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -718,6 +718,7 @@ Class containing data used for detection of objects in a video file.
718718
<li><code>MIME_TYPE</code> : the MIME type of the media</li>
719719
<li><code>FRAME_WIDTH</code> : the width of a frame in pixels</li>
720720
<li><code>FRAME_HEIGHT</code> : the height of a frame in pixels</li>
721+
<li><code>HAS_CONSTANT_FRAME_RATE</code> : set to true if the video has a constant frame rate; otherwise, omitted or set to false if the video has variable frame rate or the type of frame rate cannot be determined</li>
721722
</ul>
722723
May include the following key-value pair:
723724
<ul>

‎docs/docs/Release-Notes.md‎

Lines changed: 88 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,94 @@
11
**NOTICE:** This software (or technical data) was produced for the U.S. Government under contract, and is subject to the
22
Rights in Data-General Clause 52.227-14, Alt. IV (DEC 2007). Copyright 2022 The MITRE Corporation. All Rights Reserved.
33

4+
# OpenMPF 7.1.x
5+
6+
<h2>7.1.1: December 2022</h2>
7+
8+
<h3>Bug Fixes</h3>
9+
10+
- [[#1634](https://github.com/openmpf/openmpf/issues/1634)] Update version numbers to 7.1
11+
12+
<h2>7.1.0: December 2022</h2>
13+
14+
<h3>Documentation</h3>
15+
16+
- Updated the Object Storage Guide with `S3_UPLOAD_OBJECT_KEY_PREFIX`.
17+
- Updated the Markup Guide with `MARKUP_TEXT_LABEL_MAX_LENGTH`.
18+
19+
<h3>Exemplar Selection Policy</h3>
20+
21+
- The policy for selecting the exemplar detection for each track can now be set using the `EXEMPLAR_POLICY` job property
22+
with following values:
23+
- `CONFIDENCE`: Select the detection with the maximum confidence. If some confidences are the same, select the
24+
detection with the lower frame number. This is the default setting.
25+
- `FIRST`: Select the detection with the lowest frame number
26+
- `LAST`: Select the detection with the highest frame number
27+
- `MIDDLE`: Select the detection with the frame number closest to the middle frame of the track, preferring the
28+
detection with the lower frame number if there is an even number of frames
29+
30+
<h3>Automatic Rotation and Horizontal Flip Enabled by Default</h3>
31+
32+
- It is no longer necessary to explicitly set `AUTO_ROTATE` and `AUTO_FLIP` to true since that is now the default value.
33+
- These properties affect all video and image components that use the MPFImageReader and MPFVideoCapture tools. When
34+
true, if the image has EXIF data, or there is metadata associated with a video that ffmpeg understands, the tools will
35+
use that information to properly orient the frames before returning the frames to the component for processing.
36+
37+
<h3>Support S3 Object Storage Key Prefix</h3>
38+
39+
- Set the `S3_UPLOAD_OBJECT_KEY_PREFIX` job property or `s3.upload.object.key.prefix` system property to add a prefix to
40+
object keys when the Workflow Manager uploads objects to the S3 object store. This affects the JSON output object,
41+
artifacts, markup files, and derivative media.
42+
- Specifically, the Workflow Manager will upload objects to
43+
`<S3_RESULTS_BUCKET>/<S3_UPLOAD_OBJECT_KEY_PREFIX><file-hash-first-two-chars>/<file-hash-second-two-chars>/<file-hash>`.
44+
- For example, if you wish to add "work/" to the object key, then set `S3_UPLOAD_OBJECT_KEY_PREFIX=work/`.
45+
46+
<h3>Features</h3>
47+
48+
- [[#1526](https://github.com/openmpf/openmpf/issues/1526)] Allow markup to display more than 10 characters in the text
49+
part of the label
50+
- [[#1527](https://github.com/openmpf/openmpf/issues/1527)] Enable the Workflow Manager to select the middle detection
51+
as the exemplar
52+
- [[#1566](https://github.com/openmpf/openmpf/issues/1566)] Make `AUTO_ROTATE` and `AUTO_FLIP` true by default
53+
- [[#1569](https://github.com/openmpf/openmpf/issues/1569)] Modify C++ and Python component executor to automatically
54+
add the job name to log messages
55+
- [[#1621](https://github.com/openmpf/openmpf/issues/1621)] Make S3 object keys used for upload configurable
56+
57+
<h3>Updates</h3>
58+
59+
- [[#1602](https://github.com/openmpf/openmpf/issues/1602)] Update Workflow Manager to use Spring Boot
60+
- [[#1631](https://github.com/openmpf/openmpf/issues/1631)] Update byte-buddy, Mockito, and Hibernate versions to
61+
resolve build issue. Most notably, update Hibernate to 5.6.14.
62+
- [[#1632](https://github.com/openmpf/openmpf/issues/1632)] Update ActiveMQ to 5.17.3
63+
64+
<h3>Bug Fixes</h3>
65+
66+
- [[#1581](https://github.com/openmpf/openmpf/issues/1581)] Don't change track start and end frame when
67+
`FEED_FORWARD_TOP_CONFIDENCE_COUNT` is disabled
68+
- [[#1595](https://github.com/openmpf/openmpf/issues/1595)] Work around how Ubuntu only recognizes certificate files
69+
that end in .crt
70+
- [[#1610](https://github.com/openmpf/openmpf/issues/1610)] Prevent premature pipeline creation when using web UI
71+
- [[#1612](https://github.com/openmpf/openmpf/issues/1612)] At startup, prevent Workflow Manager from consuming from
72+
queues before purging them
73+
474
# OpenMPF 7.0.x
575

76+
<h2>7.0.3: September 2022</h2>
77+
78+
<h3>Bug Fixes</h3>
79+
80+
- [[#1561](https://github.com/openmpf/openmpf/issues/1561)] Fix logging for Python components when running through CLI
81+
runner
82+
- [[#1583](https://github.com/openmpf/openmpf/issues/1583)] Can now properly view media while job is in progress
83+
- [[#1587](https://github.com/openmpf/openmpf/issues/1587)] Fix bugs in amq_detection_component's use of select
84+
85+
<h2>7.0.2: August 2022</h2>
86+
87+
<h3>Bug Fixes</h3>
88+
89+
- [[#1562](https://github.com/openmpf/openmpf/issues/1562)] Fix bug where an ffmpeg change prevented detecting video
90+
rotation
91+
692
<h2>7.0.0: July 2022</h2>
793

894
<h3>Documentation</h3>
@@ -108,13 +194,13 @@ Rights in Data-General Clause 52.227-14, Alt. IV (DEC 2007). Copyright 2022 The
108194
- The error codes shown on the left were redundant and replaced with the corresponding error codes on the right:
109195

110196
| Old Error Code | New Error Code |
111-
|-------------------------------|--------------------------------|
197+
| ----------------------------- | ------------------------------ |
112198
| MPF_IMAGE_READ_ERROR | MPF_COULD_NOT_READ_MEDIA |
113199
| MPF_BOUNDING_BOX_SIZE_ERROR | MPF_BAD_FRAME_SIZE |
114200
| MPF_JOB_PROPERTY_IS_NOT_INT | MPF_INVALID_PROPERTY |
115201
| MPF_JOB_PROPERTY_IS_NOT_FLOAT | MPF_INVALID_PROPERTY |
116202
| MPF_INVALID_FRAME_INTERVAL | MPF_INVALID_PROPERTY |
117-
| MPF_DETECTION_TRACKING_FAILED | MPF_OTHER_DETECTION_ERROR_TYPE |
203+
| MPF_DETECTION_TRACKING_FAILED | MPF_OTHER_DETECTION_ERROR_TYPE |
118204

119205
Also, the following error codes are no longer being used and have been removed:
120206

‎docs/site/CPP-Batch-Component-API/index.html‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -908,6 +908,7 @@ <h4 id="mpfvideojob">MPFVideoJob</h4>
908908
<li><code>MIME_TYPE</code> : the MIME type of the media</li>
909909
<li><code>FRAME_WIDTH</code> : the width of a frame in pixels</li>
910910
<li><code>FRAME_HEIGHT</code> : the height of a frame in pixels</li>
911+
<li><code>HAS_CONSTANT_FRAME_RATE</code> : set to true if the video has a constant frame rate; otherwise, omitted or set to false if the video has variable frame rate or the type of frame rate cannot be determined</li>
911912
</ul>
912913
May include the following key-value pair:
913914
<ul>

‎docs/site/Java-Batch-Component-API/index.html‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -949,6 +949,7 @@ <h4 id="mpfvideojob">MPFVideoJob</h4>
949949
<li><code>MIME_TYPE</code> : the MIME type of the media</li>
950950
<li><code>FRAME_WIDTH</code> : the width of a frame in pixels</li>
951951
<li><code>FRAME_HEIGHT</code> : the height of a frame in pixels</li>
952+
<li><code>HAS_CONSTANT_FRAME_RATE</code> : set to true if the video has a constant frame rate; otherwise, omitted or set to false if the video has variable frame rate or the type of frame rate cannot be determined</li>
952953
</ul>
953954
May include the following key-value pair:
954955
<ul>

‎docs/site/Python-Batch-Component-API/index.html‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -922,6 +922,7 @@ <h4 id="mpf_component_apivideojob">mpf_component_api.VideoJob</h4>
922922
<li><code>MIME_TYPE</code> : the MIME type of the media</li>
923923
<li><code>FRAME_WIDTH</code> : the width of a frame in pixels</li>
924924
<li><code>FRAME_HEIGHT</code> : the height of a frame in pixels</li>
925+
<li><code>HAS_CONSTANT_FRAME_RATE</code> : set to true if the video has a constant frame rate; otherwise, omitted or set to false if the video has variable frame rate or the type of frame rate cannot be determined</li>
925926
</ul>
926927
May include the following key-value pair:
927928
<ul>

‎docs/site/Release-Notes/index.html‎

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,9 @@
6161
<a class="current" href="index.html">Release Notes</a>
6262
<ul class="subnav">
6363

64+
<li class="toctree-l3"><a href="#openmpf-71x">OpenMPF 7.1.x</a></li>
65+
66+
6467
<li class="toctree-l3"><a href="#openmpf-70x">OpenMPF 7.0.x</a></li>
6568

6669

@@ -255,7 +258,104 @@
255258

256259
<p><strong>NOTICE:</strong> This software (or technical data) was produced for the U.S. Government under contract, and is subject to the
257260
Rights in Data-General Clause 52.227-14, Alt. IV (DEC 2007). Copyright 2022 The MITRE Corporation. All Rights Reserved.</p>
261+
<h1 id="openmpf-71x">OpenMPF 7.1.x</h1>
262+
<h2>7.1.1: December 2022</h2>
263+
264+
<h3>Bug Fixes</h3>
265+
266+
<ul>
267+
<li>[<a href="https://github.com/openmpf/openmpf/issues/1634">#1634</a>] Update version numbers to 7.1</li>
268+
</ul>
269+
<h2>7.1.0: December 2022</h2>
270+
271+
<h3>Documentation</h3>
272+
273+
<ul>
274+
<li>Updated the Object Storage Guide with <code>S3_UPLOAD_OBJECT_KEY_PREFIX</code>.</li>
275+
<li>Updated the Markup Guide with <code>MARKUP_TEXT_LABEL_MAX_LENGTH</code>.</li>
276+
</ul>
277+
<h3>Exemplar Selection Policy</h3>
278+
279+
<ul>
280+
<li>The policy for selecting the exemplar detection for each track can now be set using the <code>EXEMPLAR_POLICY</code> job property
281+
with following values:<ul>
282+
<li><code>CONFIDENCE</code>: Select the detection with the maximum confidence. If some confidences are the same, select the
283+
detection with the lower frame number. This is the default setting.</li>
284+
<li><code>FIRST</code>: Select the detection with the lowest frame number</li>
285+
<li><code>LAST</code>: Select the detection with the highest frame number</li>
286+
<li><code>MIDDLE</code>: Select the detection with the frame number closest to the middle frame of the track, preferring the
287+
detection with the lower frame number if there is an even number of frames</li>
288+
</ul>
289+
</li>
290+
</ul>
291+
<h3>Automatic Rotation and Horizontal Flip Enabled by Default</h3>
292+
293+
<ul>
294+
<li>It is no longer necessary to explicitly set <code>AUTO_ROTATE</code> and <code>AUTO_FLIP</code> to true since that is now the default value.</li>
295+
<li>These properties affect all video and image components that use the MPFImageReader and MPFVideoCapture tools. When
296+
true, if the image has EXIF data, or there is metadata associated with a video that ffmpeg understands, the tools will
297+
use that information to properly orient the frames before returning the frames to the component for processing.</li>
298+
</ul>
299+
<h3>Support S3 Object Storage Key Prefix</h3>
300+
301+
<ul>
302+
<li>Set the <code>S3_UPLOAD_OBJECT_KEY_PREFIX</code> job property or <code>s3.upload.object.key.prefix</code> system property to add a prefix to
303+
object keys when the Workflow Manager uploads objects to the S3 object store. This affects the JSON output object,
304+
artifacts, markup files, and derivative media.</li>
305+
<li>Specifically, the Workflow Manager will upload objects to
306+
<code>&lt;S3_RESULTS_BUCKET&gt;/&lt;S3_UPLOAD_OBJECT_KEY_PREFIX&gt;&lt;file-hash-first-two-chars&gt;/&lt;file-hash-second-two-chars&gt;/&lt;file-hash&gt;</code>.</li>
307+
<li>For example, if you wish to add "work/" to the object key, then set <code>S3_UPLOAD_OBJECT_KEY_PREFIX=work/</code>.</li>
308+
</ul>
309+
<h3>Features</h3>
310+
311+
<ul>
312+
<li>[<a href="https://github.com/openmpf/openmpf/issues/1526">#1526</a>] Allow markup to display more than 10 characters in the text
313+
part of the label</li>
314+
<li>[<a href="https://github.com/openmpf/openmpf/issues/1527">#1527</a>] Enable the Workflow Manager to select the middle detection
315+
as the exemplar</li>
316+
<li>[<a href="https://github.com/openmpf/openmpf/issues/1566">#1566</a>] Make <code>AUTO_ROTATE</code> and <code>AUTO_FLIP</code> true by default</li>
317+
<li>[<a href="https://github.com/openmpf/openmpf/issues/1569">#1569</a>] Modify C++ and Python component executor to automatically
318+
add the job name to log messages</li>
319+
<li>[<a href="https://github.com/openmpf/openmpf/issues/1621">#1621</a>] Make S3 object keys used for upload configurable</li>
320+
</ul>
321+
<h3>Updates</h3>
322+
323+
<ul>
324+
<li>[<a href="https://github.com/openmpf/openmpf/issues/1602">#1602</a>] Update Workflow Manager to use Spring Boot</li>
325+
<li>[<a href="https://github.com/openmpf/openmpf/issues/1631">#1631</a>] Update byte-buddy, Mockito, and Hibernate versions to
326+
resolve build issue. Most notably, update Hibernate to 5.6.14.</li>
327+
<li>[<a href="https://github.com/openmpf/openmpf/issues/1632">#1632</a>] Update ActiveMQ to 5.17.3</li>
328+
</ul>
329+
<h3>Bug Fixes</h3>
330+
331+
<ul>
332+
<li>[<a href="https://github.com/openmpf/openmpf/issues/1581">#1581</a>] Don't change track start and end frame when
333+
<code>FEED_FORWARD_TOP_CONFIDENCE_COUNT</code> is disabled</li>
334+
<li>[<a href="https://github.com/openmpf/openmpf/issues/1595">#1595</a>] Work around how Ubuntu only recognizes certificate files
335+
that end in .crt</li>
336+
<li>[<a href="https://github.com/openmpf/openmpf/issues/1610">#1610</a>] Prevent premature pipeline creation when using web UI</li>
337+
<li>[<a href="https://github.com/openmpf/openmpf/issues/1612">#1612</a>] At startup, prevent Workflow Manager from consuming from
338+
queues before purging them</li>
339+
</ul>
258340
<h1 id="openmpf-70x">OpenMPF 7.0.x</h1>
341+
<h2>7.0.3: September 2022</h2>
342+
343+
<h3>Bug Fixes</h3>
344+
345+
<ul>
346+
<li>[<a href="https://github.com/openmpf/openmpf/issues/1561">#1561</a>] Fix logging for Python components when running through CLI
347+
runner</li>
348+
<li>[<a href="https://github.com/openmpf/openmpf/issues/1583">#1583</a>] Can now properly view media while job is in progress</li>
349+
<li>[<a href="https://github.com/openmpf/openmpf/issues/1587">#1587</a>] Fix bugs in amq_detection_component's use of select</li>
350+
</ul>
351+
<h2>7.0.2: August 2022</h2>
352+
353+
<h3>Bug Fixes</h3>
354+
355+
<ul>
356+
<li>[<a href="https://github.com/openmpf/openmpf/issues/1562">#1562</a>] Fix bug where an ffmpeg change prevented detecting video
357+
rotation</li>
358+
</ul>
259359
<h2>7.0.0: July 2022</h2>
260360

261361
<h3>Documentation</h3>

‎docs/site/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -376,5 +376,5 @@ <h1 id="overview">Overview</h1>
376376

377377
<!--
378378
MkDocs version : 0.17.5
379-
Build Date UTC : 2022-12-15 13:38:58
379+
Build Date UTC : 2022-12-20 16:47:21
380380
-->

‎docs/site/search/search_index.json‎

Lines changed: 12 additions & 7 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)