Merge pull request #414 from amiaopensource/kfrn/tweaks

Tweaks: naming, whitespace, collapse all recipes
Update 'show/hide recipes' (expand/collapse) functionality
2025-10-25 07:00:52 +02:00 · 2019-12-17 11:48:57 -05:00 · 2019-12-18 05:42:29 +13:00 · 2019-12-17 22:36:47 +13:00 · 2019-12-17 22:34:37 +13:00 · 2019-12-11 12:08:30 -05:00
3 changed files with 76 additions and 27 deletions
--- a/index.html
+++ b/index.html
@@ -2,7 +2,8 @@
 <html lang="en">
 <head>
  <title>ffmprovisr</title>
-  <meta name="viewport" charset="utf-8" content="text/html, width=device-width, initial-scale=1">
+  <meta name="viewport" content="text/html, width=device-width, initial-scale=1">
+  <meta charset="utf-8">
  <link rel="stylesheet" href="css/css.css">
  <link rel="icon" href="img/vhs.ico">
  <script src="js/jquery.min.js"></script>
@@ -18,7 +19,7 @@
  <nav class="sidebar well">
    <h2 class="heading">Table of Contents</h2>
    <a href="#about"><div class="contents-list">About this resource</div></a>
-    <div id="open-all" class="contents-list">Show/hide all recipes</div>
+    <div id="toggle-expand-collapse-all" class="contents-list">Expand/collapse all recipes</div>
    <a href="#basics"><div class="contents-list">FFmpeg basics</div></a>
    <a href="#concepts"><div class="contents-list">Advanced FFmpeg concepts</div></a>
    <a href="#rewrap"><div class="contents-list">Change container (rewrap)</div></a>
@@ -218,6 +219,36 @@
    </div>
    <!-- End Basic rewrap command -->

+    <!-- BWF -->
+    <label class="recipe" for="bwf">Convert to (or create) Broadcast WAV</label>
+    <input type="checkbox" id="bwf">
+    <div class="hiding">
+      <h5>Generate Broadcast WAV</h5>
+      <p><code>ffmpeg -i <em>input_file.wav</em> -c copy -write_bext 1 -metadata field_name='Content' <em>output_file.wav</em></code></p>
+      <p>This command will write a file in the Broadcast Wave Format (BWF) containing a BEXT chunk with related metadata.</p>
+      <dl>
+        <dt>ffmpeg</dt><dd>starts the command</dd>
+        <dt>-i <em>input_file.wav</em></dt><dd>path and name of the input file</dd>
+        <dt>-c copy</dt><dd>this will copy the encoding/sample rate etc from the input. If not using a WAV as the input file you will have to specify codec settings in place of this.</dd>
+        <dt>-write_bext 1</dt><dd>tells FFmpeg to write a BEXT chunk, the part of the file where BWF metadata is stored.</dd>
+        <dt>-metadata field_name='Content'</dt><dd>This is where you can specify which BEXT fields to write, and what information to fill them with by replacing <code>field_name</code> and <code>'Content'</code> respectively. See below for additional details.</dd>
+      </dl>
+      <p>Notes: You can choose which fields to write by repeating <code>-metadata field_name='Content'</code> for each desired field. Flags for commonly used fields (such as those recommended by the <a href="http://www.digitizationguidelines.gov/audio-visual/documents/Embed_Guideline_20120423.pdf">FADGI guidelines</a>) are as follows:</p>
+      <ul>
+        <li>description</li>
+        <li>originator</li>
+        <li>originator_reference</li>
+        <li>origination_date</li>
+        <li>origination_time</li>
+        <li>coding_history</li>
+        <li>IARL</li>
+      </ul>
+      <p>Example: <code>-metadata originator='US, UW Libraries'</code></p>
+      <p>Additionally, users should be aware that BWF metadata fields are limited by characters, with some such as OriginatorReference maxing out at 32. Specific information can be found in the <a href="https://tech.ebu.ch/docs/tech/tech3285.pdf">Broadcast Wave Format specification</a>. Additional examples of BWF metadata usage can be found in the <a href="http://www.dlib.indiana.edu/projects/sounddirections/papersPresent/sd_bp_07.pdf">Sound Directions report</a> by Indiana University and Harvard.</p>
+      <p class="link"></p>
+    </div>
+    <!-- ends BWF -->
+
    <!-- Rewrap DV -->
    <label class="recipe" for="rewrap-dv">Rewrap DV video to .dv file</label>
    <input type="checkbox" id="rewrap-dv">
@@ -773,13 +804,13 @@
      <p>It's also possible to specify the crop position by adding the x and y coordinates representing the top left of your cropped area to your crop filter, as such:</p>
      <p><code>ffmpeg -i <em>input_file</em> -vf "crop=<em>width</em>:<em>height</em>[:<em>x_position</em>:<em>y_position</em>]" <em>output_file</em></code></p>
      <h5>Examples</h5>
-      <p>The original frame, a screenshot of the SMPTE colorbars:</p>
+      <p>The original frame, a screenshot of Maggie Cheung in the film <i>Hero</i>:</p>
      <img class="sample-image" src="img/crop_example_orig.png" alt="VLC screenshot of Maggie Cheung">
-      <p>Result of the command <code>ffmpeg -i <em>smpte_colorsbars.mov</em> -vf "crop=500:500" <em>output_file</em></code>:</p>
+      <p>Result of the command <code>ffmpeg -i <em>maggie.mov</em> -vf "crop=500:500" <em>output_file</em></code>:</p>
      <img class="sample-image-small" src="img/crop_example_aftercrop1.png" alt="VLC screenshot of Maggie Cheung, cropped from original">
-      <p>Result of the command <code>ffmpeg -i <em>smpte_colorsbars.mov</em> -vf "crop=500:500:0:0" <em>output_file</em></code>, appending <code>:0:0</code> to crop from the top left corner:</p>
+      <p>Result of the command <code>ffmpeg -i <em>maggie.mov</em> -vf "crop=500:500:0:0" <em>output_file</em></code>, appending <code>:0:0</code> to crop from the top left corner:</p>
      <img class="sample-image-small" src="img/crop_example_aftercrop2.png" alt="VLC screenshot of Maggie Cheung, cropped from original">
-      <p>Result of the command <code>ffmpeg -i <em>smpte_colousbars.mov</em> -vf "crop=500:300:500:30" <em>output_file</em></code>:</p>
+      <p>Result of the command <code>ffmpeg -i <em>maggie.mov</em> -vf "crop=500:300:500:30" <em>output_file</em></code>:</p>
      <img class="sample-image-small" src="img/crop_example_aftercrop3.png" alt="VLC screenshot of Maggie Cheung, cropped from original">
      <p class="link"></p>
    </div>
--- a/js/js.js
+++ b/js/js.js
@@ -32,11 +32,21 @@ $(document).ready(function() {
    }
  })

-  // open all windows if button is clicked
-  $('#open-all').on("click", function(){
-    $('input[type=checkbox]').each(function(){
-      this.checked = !this.checked;
-    })
-  });
+  // Collapse all recipes when button is clicked
+  $('#toggle-expand-collapse-all').on("click", function(){
+    var checkboxes = $('input[type=checkbox]');
+    var anyRecipesOpen = $(checkboxes).is(':checked');

+    if (anyRecipesOpen) {
+      // Collapse all
+      $('input[type=checkbox]').each(function() {
+        this.checked = false;
+      });
+    } else new Promise(function(resolve, reject) {
+      // Expand all
+      $('input[type=checkbox]').each(function() {
+        this.checked = true;
+      });
+    });
+  });
 });
--- a/readme.md
+++ b/readme.md
@@ -83,31 +83,36 @@ You can read our contributor code of conduct [here](https://github.com/amiaopens
  
 *Code Contributors*:  
 ablwr (Ashley)  
+alavigne12 (A. Lavigne)  
+Anushka-codergirl (Anushka Raj)  
 bastibeckr (Basti Becker)  
-b00giehead (Joanna White)  
 bturkus  
 dericed (Dave Rice)  
+digitensions (Joanna White)  
 edsu (Ed Summers)  
 jamessam (Jim Sam)  
 jfarbowitz (Jonathan Farbowitz)  
 kfrn (Katherine Frances Nagels)  
 kgrons (Kathryn Gronsbell)  
 kieranjol (Kieran O'Leary)  
-llogan (Lou)  
+llogan (Lou Logan)  
+macasaurusrex (Maura)  
 mgiraldo (Mauricio Giraldo)  
 pjotrek-b (Peter B.)  
 privatezero (Andrew Weaver)  
 retokromer (Reto Kromer)  
 rfraimow  
  
-*All Contributors*:
+All Contributors:  
 ablwr (Ashley)  
+alavigne12 (A. Lavigne)  
+Anushka-codergirl (Anushka Raj)  
 audiovisualopen  
 bastibeckr (Basti Becker)  
-b00giehead (Joanna White)  
 brainwane (Sumana Harihareswara)  
 bturkus  
 dericed (Dave Rice)  
+digitensions (Joanna White)  
 drodz11 (Dave Rodriguez)  
 edsu (Ed Summers)  
 EG-tech (Ethan Gates)  
@@ -122,7 +127,9 @@ kellyhaydon (metacynic)
 kfrn (Katherine Frances Nagels)  
 kgrons (Kathryn Gronsbell)  
 kieranjol (Kieran O'Leary)  
-llogan (Lou)  
+llogan (Lou Logan)  
+macasaurusrex (Maura)  
+mercuryswitch  
 mgiraldo (Mauricio Giraldo)  
 mulvya  
 nkrabben (Nick Krabbenhoeft)  
@@ -132,12 +139,13 @@ retokromer (Reto Kromer)
 rfraimow  
 richardpl (Paul B Mahol)  
 ross-spencer (Ross Spencer)  
+taschenbach (Tommy Aschenbach)  
 todrobbins (Tod Robbins)  
  
 Repo: amiaopensource/ffmprovisr  
-Code Contributors: 17  
-All Contributors: 32   
-Last updated: 2019-02-11  
+GitHub Contributors: 20  
+All Contributors: 37  
+Last updated: 2019-12-11 

 ## AVHack Team
Author	SHA1	Message	Date
Ashley	e4c327bbac	Merge pull request #414 from amiaopensource/kfrn/tweaks Tweaks: naming, whitespace, collapse all recipes	2019-12-17 11:48:57 -05:00
kfrn	4359d6dd4a	Update 'show/hide recipes' (expand/collapse) functionality Previously, it would expand the recipe if currently collapsed, and vice versa. Now, if any recipes are currently expanded, it will collapse all; otherwise, all recipes will be expanded. The 'expand all' functionality is necessary for full-text searching.	2019-12-18 05:42:29 +13:00
kfrn	d184ed2fe9	Code style: remove trailing whitespace	2019-12-17 22:36:47 +13:00
kfrn	089725a753	Crop video recipe: correct name/description of example images	2019-12-17 22:34:37 +13:00
Ashley	897f1b1616	Merge pull request #413 from amiaopensource/update-contributors Update contributors list with octohatrack	2019-12-11 12:08:30 -05:00
Ashley	358a2ec23b	add "last updated"	2019-12-11 12:04:09 -05:00
Ashley Blewer	de6c08a58d	Update contributors list with octohatrack	2019-12-10 17:56:18 -05:00
Ashley	0d1fc1bfe8	Merge pull request #412 from amiaopensource/BWF_name fix BWF name	2019-12-10 10:41:34 -05:00
Reto Kromer	cbca3ac7ad	fix BWF name	2019-12-10 10:04:07 +01:00
Ashley	bcc425a955	Merge pull request #410 from amiaopensource/add-bext add BWF embedding recipe	2019-12-09 12:15:51 -05:00
weaver	0353c1761e	ch ch ch changes	2019-12-06 08:37:11 -08:00
weaver	e3aa81fb95	add BWF	2019-12-05 16:28:58 -08:00
Ashley	633374f22d	Merge pull request #409 from macasaurusrex/issue-399-meta-tag-validation Update index.html	2019-11-20 10:39:49 -05:00
Maura	1d60060eed	Update index.html fix for ticket 399: meta tag validation error. w3 doesn't like chartset in the same tag as viewport so I split them out based on what was described in the ticket	2019-11-19 18:07:41 -05:00