Merge pull request #240 from kfrn/gh-pages

Reorganise some recipes + add filtergraph explanation 'command'

css/css.css

@@ -2,8 +2,22 @@ h1, h2, h3, h4, h5, h6 {
   font-family: 'Montserrat', sans-serif;
 }
 
+h2 {
+  font-size: 24px;
+}
+
+.intro-lead {
+  font-family: 'Montserrat', sans-serif;
+  font-size: 20px;
+}
+
+.select-from {
+  font-size: 16px;
+}
+
 code {
   word-break: break-all;
+  word-wrap: break-word;
 }
 
 dd {
@@ -72,6 +86,18 @@ div {
   transform: scale(1.3) translateZ(0);
 }
 
+.contents-list {
+  color: black;
+}
+
+.contents-list:hover {
+  color: #2a9fd6;
+}
+
+.contents-list:before {
+  content: "📼"
+}
+
 .codeblock {
   font-family: monospace
   padding: 2px 4px;

readme.md

@@ -1,37 +1,55 @@
 # [ffmprovisr](http://amiaopensource.github.io/ffmprovisr)
 
-Repository of useful FFmpeg command lines for archivists! [AMIA hackday](http://wiki.curatecamp.org/index.php/Association_of_Moving_Image_Archivists_%26_Digital_Library_Federation_Hack_Day_2015) edition.
+Repository of useful FFmpeg command lines for archivists!
 
 ## What is this?
 
-Project Objective: To facilitate better understanding of FFmpeg through collaborative sharing of useful scripts and detailed flag-level description of how each script works so archivists can copy-paste and produce their own scripts but also understand how and why they work.
+#### Project Objective
+
+To facilitate better understanding of FFmpeg through collaborative sharing of useful scripts and detailed flag-level description of how each script works, so archivists can copy-paste and produce their own scripts, but also understand how and why they work.
 
 ## How do I see it?
 
-Code stuff in the gh-pages branch (the default primary branch). Readme is right here. The site is live and lives on github pages. You can see it [here](http://amiaopensource.github.io/ffmprovisr), or you can download a [release](https://github.com/amiaopensource/ffmprovisr/releases) and use it locally.
+The code is found in the gh-pages branch (the default primary branch). Readme is right here. You can see the site live on [GitHub pages](http://amiaopensource.github.io/ffmprovisr).
+
+You can also install the latest [release](https://github.com/amiaopensource/ffmprovisr/releases) on your computer with the command:
+```
+brew install amiaopensource/amiaos/ffmprovisr
+```
+and then call it locally with the command:
+```
+ffmprovisr
+```
+This works currently under macOS, Linux and the Linux subsystem on Windows. On classic Windows you can install the last [release](https://github.com/amiaopensource/ffmprovisr/releases) manually and the open `index.html` in a browser.
 
 ## How do I contribute?
 
-You are welcome to edit the codebase yourself or just supply the information and ask it to be added to the site.
+You are welcome to edit the codebase yourself, or just supply the information and ask it to be added to the site.
 
-To contribute to this project directly (and more quickly), clone this repository and create a new branch (`git checkout -b your-branch-name`) and add or modify a new block in index.html. Then submit a pull request and someone can review and integrate your code. There is a commented-out sample available at the bottom of index.html that can be used to build your own block.
+#### Edit codebase
 
-If you are having trouble with the coding it yourself or with github, feel free to [submit an issue](https://github.com/amiaopensource/ffmprovisr/issues) with the kind of command you would like to see added to the site.
+To contribute to this project directly (and more quickly), clone this repository and create a new branch (`git checkout -b your-branch-name`) and add or modify a new block in `index.html`. Then [submit a pull request](https://github.com/amiaopensource/ffmprovisr/pulls) and the maintainers will review and integrate your code. There is a commented-out sample block available at the bottom of `index.html` that can be as a guideline for your command.
+
+#### Make a request
+
+If you are having trouble with coding it yourself or with GitHub, feel free to [submit an issue](https://github.com/amiaopensource/ffmprovisr/issues) with the kind of command you would like to see added to the site.
+
+#### General help
 
 If you want to help but don't have a new script to add, you can help us by testing out the scripts available, by refining or clarifying the documentation, or [creating an issue](https://github.com/amiaopensource/ffmprovisr/issues) for anything that sounds confusing and requires clarification.
 
-## License
-
-<a rel="license" href="http://creativecommons.org/licenses/by/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by/4.0/80x15.png" /></a><br />This <span xmlns:dct="http://purl.org/dc/terms/" href="http://purl.org/dc/dcmitype/InteractiveResource" rel="dct:type">work</span> by <a xmlns:cc="http://creativecommons.org/ns#" href="http://amiaopensource.github.io/ffmprovisr/" property="cc:attributionName" rel="cc:attributionURL">ffmprovisr</a> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 International License</a>.<br />Based on a work at <a xmlns:dct="http://purl.org/dc/terms/" href="https://github.com/amiaopensource/ffmprovisr" rel="dct:source">https://github.com/amiaopensource/ffmprovisr</a>.
-
 ## Code of Conduct
 
 You can read our contributor code of conduct [here](https://github.com/amiaopensource/ffmprovisr/blob/gh-pages/code_of_conduct.md).
 
+## Maintainers
+
+[Ashley Blewer](https://github.com/ablwr), [Katherine Frances Nagels](https://github.com/kfrn), [Kieran O'Leary](https://github.com/kieranjol) and [Reto Kromer](https://github.com/retokromer)
+
 ## Contributors
 * Gathered using [octohatrack](https://github.com/LABHR/octohatrack)
 
-GitHub Contributors:  
+*GitHub Contributors*:  
 ablwr (Ashley)  
 dericed (Dave Rice)  
 edsu (Ed Summers)  
@@ -40,39 +58,50 @@ kfrn (Katherine Frances Nagels)
 kgrons (Kathryn Gronsbell)  
 kieranjol (Kieran O'Leary)  
 llogan (Lou)  
+pjotrek-b (Peter B.)  
 privatezero (Andrew Weaver)  
 retokromer (Reto Kromer)  
 rfraimow  
   
-All Contributors:  
+*All Contributors*:  
 ablwr (Ashley)  
 audiovisualopen  
 brainwane (Sumana Harihareswara)  
+bturkus  
 dericed (Dave Rice)  
 edsu (Ed Summers)  
 Fizz24  
-jamessam (Jim)  
+jamessam (Jim Sam)  
 jfarbowitz (Jonathan Farbowitz)  
 jronallo (Jason Ronallo)  
+kellyhaydon (metacynic)  
 kfrn (Katherine Frances Nagels)  
 kgrons (Kathryn Gronsbell)  
 kieranjol (Kieran O'Leary)  
 llogan (Lou)  
 mulvya  
+pjotrek-b (Peter B.)  
 privatezero (Andrew Weaver)  
 retokromer (Reto Kromer)  
 rfraimow  
+richardpl (Paul B Mahol)  
 todrobbins (Tod Robbins)  
   
 Repo: amiaopensource/ffmprovisr  
-GitHub Contributors: 11  
-All Contributors: 18  
+GitHub Contributors: 12  
+All Contributors: 22  
 
-## AVHack Team:
+## AVHack Team
 
-[Ashley Blewer](https://github.com/ablwr), Eddy Colloton, Rebecca Dillmeier, [Jonathan Farbowitz](https://github.com/jfarbowitz), Rebecca Fraimow, Samuel Gutterman, Kelly Haydon, [Reto Kromer](https://github.com/retokromer), Nicole Martin, [Katherine Frances Nagels](https://github.com/kfrn), [Kieran O'Leary](https://github.com/kieranjol), Catriona Schlosser, Ben Turkus
+[Association of Moving Image Archivists & Digital Library Federation Hack Day 2015](http://wiki.curatecamp.org/index.php/Association_of_Moving_Image_Archivists_%26_Digital_Library_Federation_Hack_Day_2015)
+
+[Ashley Blewer](https://github.com/ablwr), [Eddy Colloton](https://github.com/eddycolloton), Rebecca Dillmeier, [Jonathan Farbowitz](https://github.com/jfarbowitz), [Rebecca Fraimow](https://github.com/rfraimow), Samuel Gutterman, [Kelly Haydon](https://github.com/kellyhaydon), [Reto Kromer](https://github.com/retokromer), Nicole Martin, [Katherine Frances Nagels](https://github.com/kfrn), [Kieran O'Leary](https://github.com/kieranjol), Catriona Schlosser, [Ben Turkus](https://github.com/bturkus)
 
 ## Sister projects
 
 [Script Ahoy](http://dd388.github.io/crals/): Community Resource for Archivists and Librarians Scripting  
 [sourcecaster](https://datapraxis.github.io/sourcecaster/): helps you use the command line to work through common challenges that come up when working with digital primary sources.
+
+## License
+
+<a rel="license" href="http://creativecommons.org/licenses/by/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by/4.0/80x15.png" /></a><br />This <span xmlns:dct="http://purl.org/dc/terms/" href="http://purl.org/dc/dcmitype/InteractiveResource" rel="dct:type">work</span> by <a xmlns:cc="http://creativecommons.org/ns#" href="http://amiaopensource.github.io/ffmprovisr/" property="cc:attributionName" rel="cc:attributionURL">ffmprovisr</a> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 International License</a>.<br />Based on a work at <a xmlns:dct="http://purl.org/dc/terms/" href="https://github.com/amiaopensource/ffmprovisr" rel="dct:source">https://github.com/amiaopensource/ffmprovisr</a>.

scripts/check_audio_framemd5.sh

@@ -1,19 +1,19 @@
 #!/usr/bin/env bash
   SCRIPT=$(basename "${0}")
- VERSION='2016-12-31'
+ VERSION='2017-07-08'
   AUTHOR='ffmprovisr'
      RED='\033[1;31m'
     BLUE='\033[1;34m'
       NC='\033[0m'
 
-if [[ ${OSTYPE} = "cygwin" ]] || [ ! $(which diff) ]; then
+if [[ "${OSTYPE}" = "cygwin" ]] || [ ! $(which diff) ]; then
     echo -e "${RED}Error: 'diff' is not installed by default. Please install 'diffutils' from Cygwin.${NC}"
     exit 1
 fi
 
 _output_prompt(){
     cat <<EOF
-Usage: ${SCRIPT} [-h] | [ -i <av_file> -m <md5_file> ]
+Usage: ${SCRIPT} -i <av_file> -m <md5_file> | -h
 EOF
     exit 1
 }
@@ -21,18 +21,16 @@ EOF
 _output_help(){
     cat <<EOF
 Syntax:
-  ${SCRIPT}
-    Prompts a short help message.
-  ${SCRIPT} -h
-    This help.
   ${SCRIPT} -i <av_file> -m <md5_file>
     Pass to the script the audio-visual file and the corresponding MD5
     file to check.
+  ${SCRIPT} -h
+    This help.
 Dependency:
   ffmpeg
 About:
   Version: ${VERSION}
-  Website: https://github.com/amiaopensource/ffmprovisr/blob/gh-pages/check_framemd5.sh
+  Website: https://github.com/amiaopensource/ffmprovisr/blob/gh-pages/scripts/check_audio_framemd5.sh
 EOF
     exit 0
 }
@@ -40,11 +38,11 @@ EOF
 unset input_file
 unset input_hash
 
-while getopts ":hi:m:" opt; do
+while getopts ":i:m:h" opt; do
     case "${opt}" in
+        i) input_file=${OPTARG} ;;
+        m) input_hash=${OPTARG} ;;
         h) _output_help ;;
-        i) input_file=$OPTARG ;;
-        m) input_hash=$OPTARG ;;
         :) echo -e "${RED}Error: option -${OPTARG} requires an argument${NC}" ; _output_prompt ;;
         *) echo -e "${RED}Error: bad option -${OPTARG}${NC}" ; _output_prompt ;;
     esac
@@ -54,21 +52,24 @@ done
 echo -e "${BLUE}Please wait...${NC}"
 unset md5_tmp
 if [[ $OSTYPE = "cygwin" ]]; then
-    md5_tmp=""${USERPROFILE}/$(basename ${input_hash}).tmp""
+    md5_tmp="${USERPROFILE}/$(basename "${input_hash}").tmp"
 else
-    md5_tmp="${HOME}/$(basename ${input_hash}).tmp"
+    md5_tmp="${HOME}/$(basename "${input_hash}").tmp"
 fi
-$(ffmpeg -i ${input_file} -loglevel 0 -f framemd5 -an ${md5_tmp})
+# Find audio frame size for hash calculation
+unset sample_rate
+sample_rate=$(grep -v '^#' "${input_hash}" | head -n 1 | tr -d ' ' | cut -d',' -f4)
+ffmpeg -i "${input_file}" -loglevel 0 -af "asetnsamples=n='$sample_rate'" -f framemd5 -vn "${md5_tmp}"
 [[ ! -f ${md5_tmp} ]] && { echo -e "${RED}Error: '${input_file}' is not a valid audio-visual file.${NC}" ; _output_prompt ; }
 unset old_file
 unset tmp_file
-old_file=$(grep -v '^#' ${input_hash})
-tmp_file=$(grep -v '^#' ${md5_tmp})
+old_file=$(grep -v '^#' "${input_hash}")
+tmp_file=$(grep -v '^#' "${md5_tmp}")
 if [[ "${old_file}" = "${tmp_file}" ]]; then
-    echo -e "${BLUE}'$(basename ${input_file})' matches '$(basename ${input_hash})'${NC}"
+    echo -e "${BLUE}'$(basename "${input_file}")' matches '$(basename "${input_hash}")'${NC}"
     rm "${md5_tmp}"
 else
-    echo -e "${RED}The following differences were detected between '$(basename ${input_file})' and '$(basename ${input_hash})':${NC}"
+    echo -e "${RED}The following differences were detected between '$(basename "${input_file}")' and '$(basename "${input_hash}")':${NC}"
     diff "${input_hash}" "${md5_tmp}"
     rm "${md5_tmp}"
 fi

scripts/check_video_framemd5.sh

@@ -0,0 +1,72 @@
+#!/usr/bin/env bash
+  SCRIPT=$(basename "${0}")
+ VERSION='2017-07-08'
+  AUTHOR='ffmprovisr'
+     RED='\033[1;31m'
+    BLUE='\033[1;34m'
+      NC='\033[0m'
+
+if [[ "${OSTYPE}" = "cygwin" ]] || [ ! $(which diff) ]; then
+    echo -e "${RED}Error: 'diff' is not installed by default. Please install 'diffutils' from Cygwin.${NC}"
+    exit 1
+fi
+
+_output_prompt(){
+    cat <<EOF
+Usage: ${SCRIPT} -i <av_file> -m <md5_file> | -h
+EOF
+    exit 1
+}
+
+_output_help(){
+    cat <<EOF
+Syntax:
+  ${SCRIPT} -i <av_file> -m <md5_file>
+    Pass to the script the audio-visual file and the corresponding MD5
+    file to check.
+  ${SCRIPT} -h
+    This help.
+Dependency:
+  ffmpeg
+About:
+  Version: ${VERSION}
+  Website: https://github.com/amiaopensource/ffmprovisr/blob/gh-pages/scripts/check_video_framemd5.sh
+EOF
+    exit 0
+}
+
+unset input_file
+unset input_hash
+
+while getopts ":i:m:h" opt; do
+    case "${opt}" in
+        i) input_file=${OPTARG} ;;
+        m) input_hash=${OPTARG} ;;
+        h) _output_help ;;
+        :) echo -e "${RED}Error: option -${OPTARG} requires an argument${NC}" ; _output_prompt ;;
+        *) echo -e "${RED}Error: bad option -${OPTARG}${NC}" ; _output_prompt ;;
+    esac
+done
+
+[[ -z "${#}" || ! ${input_file} || ! ${input_hash} ]] && _output_prompt
+echo -e "${BLUE}Please wait...${NC}"
+unset md5_tmp
+if [[ "${OSTYPE}" = "cygwin" ]]; then
+    md5_tmp="${USERPROFILE}/$(basename "${input_hash}").tmp"
+else
+    md5_tmp="${HOME}/$(basename "${input_hash}").tmp"
+fi
+ffmpeg -i "${input_file}" -loglevel 0 -f framemd5 -an "${md5_tmp}"
+[[ ! -f "${md5_tmp}" ]] && { echo -e "${RED}Error: '${input_file}' is not a valid audio-visual file.${NC}" ; _output_prompt ; }
+unset old_file
+unset tmp_file
+old_file=$(grep -v '^#' "${input_hash}")
+tmp_file=$(grep -v '^#' "${md5_tmp}")
+if [[ "${old_file}" = "${tmp_file}" ]]; then
+    echo -e "${BLUE}'$(basename "${input_file}")' matches '$(basename "${input_hash}")'${NC}"
+    rm "${md5_tmp}"
+else
+    echo -e "${RED}The following differences were detected between '$(basename "${input_file}")' and '$(basename "${input_hash}")':${NC}"
+    diff "${input_hash}" "${md5_tmp}"
+    rm "${md5_tmp}"
+fi

scripts/ffmprovisr

@@ -0,0 +1,25 @@
+#!/usr/bin/env bash
+
+# This allows to open the online version of the ffmprovisr, when the computer is
+# connected to the Web, and the local version otherwise.
+
+if [[ "$(uname -s)" = "Darwin" ]] ; then
+    default_browser=$(plutil -convert json ~/Library/Preferences/com.apple.LaunchServices/com.apple.launchservices.secure.plist -r -o - | grep https -b1 | tail -n1 | cut -d'"' -f4)
+    if ping -c 1 amiaopensource.github.io >/dev/null 2>&1 ; then
+        ffmprovisr_path='https://amiaopensource.github.io/ffmprovisr/'
+    else
+        ffmprovisr_path=$(find /usr/local/Cellar/ffmprovisr -iname 'index.html' | sort -M | tail -n1)
+    fi
+    if [ -n "${default_browser}" ] ; then
+        open -b "${default_browser}" "${ffmprovisr_path}"
+    else
+        open "${ffmprovisr_path}"
+    fi
+elif [[ "$(uname -s)" = "Linux" ]] ; then
+    if ping -c 1 amiaopensource.github.io >/dev/null 2>&1 ; then
+        ffmprovisr_path='https://amiaopensource.github.io/ffmprovisr/'
+    else
+        ffmprovisr_path=$(find ~/.linuxbrew/Cellar/ffmprovisr -iname 'index.html' | sort -M | tail -n1)
+    fi
+    xdg-open "${ffmprovisr_path}"
+fi