Merge pull request #991 from amiaopensource/linux-doc-updates

Update Linux install instructions

Author: dericed

Release/linux-dependencies.sh

@@ -2,6 +2,7 @@
 
 sudo apt-get install -y --no-install-recommends \
 build-essential \
+curl \
 libgtk2.0-dev \
 libgtk-3-dev \
 bison \
@@ -12,6 +13,7 @@ mkvtoolnix \
 gnuplot \
 xmlstarlet \
 mpv \
+mediaconch \
 libiec61883-dev \
 libraw1394-dev \
 libavc1394-dev \

Resources/Documentation/linux_installation.md

@@ -1,67 +1,38 @@
 # Steps for a successful install of Vrecord on Linux
 
 ## About
-There are many possible ways to install the various dependencies of Vrecord on Linux. The main body of this documentation is oriented towards installing on Ubuntu LTS. For Some information about installing on additional distributions see the section at the bottom of this document. 
+There are many possible ways to install the various dependencies of Vrecord on Linux. The main body of this documentation is oriented towards Ubuntu LTS, and has been tested to work on fresh installations of Ubuntu 24.04 LTS and 26.04 LTS.
 
-## via Homebrew
-The following instructions aim to minimize use of Homebrew installs for packages that can otherwise be installed via native Linux methods. When followed in order, these commands should result in a fully functional install of vrecord.
+### Install non-homebrew core dependencies
+1) If working on a fresh installation of Ubuntu, it is recommended to run `sudo apt-get update && sudo apt-get upgrade -y` prior to installing vrecord to make sure that all packages are their latest versions.
+2) Download and install the latest Linux version of 'Blackmagic Desktop Video' from the [Blackmagic website](https://www.blackmagicdesign.com/support/)
+3) Install dependencies required for a successful build. These can be installed one-by-one from the list in [this script](https://github.com/amiaopensource/vrecord/blob/main/Release/linux-dependencies.sh), or (recommended) that script can be run remotely with the following command.
 
-### Programs to be installed manually
+__Vrecord dependency install command:__ 
 
-* Download and install the latest Linux version of 'Blackmagic Desktop Video' from the [Blackmagic website](https://www.blackmagicdesign.com/support/)
-* Download and install the latest version of the [QCTools CLI tool](https://mediaarea.net/QCTools/Download/Ubuntu) from the MediaArea website
-* Optional: If DV wrapping and splitting is desired, download and install [DVRescue](https://mediaarea.net/DVRescue) from the MediaArea website.
-
-### Programs to be installed via PPA
-
-* Install MPV with the following steps:
-  - Add the MPV PPA with: `sudo add-apt-repository ppa:mc3man/mpv-tests`
-  - Update package manager with: `sudo apt-get update`
-  - Install MPV with `sudo apt-get install mpv`
-
-### Programs to be installed via standard package manager
-
-* Use the following commands to install additional dependencies for full vrecord use:
-  - `sudo apt-get install curl`
-  - `sudo apt-get install gnuplot`
-  - `sudo apt-get install xmlstarlet`
-  - `sudo apt-get install mkvtoolnix`
-  - `sudo apt-get install mediaconch`
-* Install the following dependencies for enabling DV capture in vrecord's FFmpeg build:
-  - `sudo apt-get install libiec61883-dev`
-  - `sudo apt-get install libraw1394-dev`
-  - `sudo apt-get install libavc1394-dev`
-  - `sudo apt-get install libavc1394-tools`
-* If `make` and `gcc` are not already installed, install them with
-  - `sudo apt-get install gcc`
-  - `sudo apt-get install make`
-* Installing a standard version of FFmpeg is highly recommended as a fallback in case of issues with the Homebrew controlled build:
-  - `sudo apt-get install ffmpeg`
+`wget -O - https://raw.githubusercontent.com/amiaopensource/vrecord/refs/heads/linux-doc-updates/Release/linux-dependencies.sh | bash`
 
 ### Install Homebrew
-* Use the following commands, (sourced from the [Homebrew docs](https://docs.brew.sh/Homebrew-on-Linux)) to install and configure Homebrew on Linux:
- - Install Homebrew with: `/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"`
- - Add linuxbrew to path with: 
-~~~
- test -d ~/.linuxbrew && eval $(~/.linuxbrew/bin/brew shellenv)
+4) Install Homebrew via the command on [its homepage](https://brew.sh/). As of writing, this is: `/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"`
 
- test -d /home/linuxbrew/.linuxbrew && eval $(/home/linuxbrew/.linuxbrew/bin/brew shellenv)
+ __Important:__ After this command runs, Homebrew will print several more required commands that must be run to make brew functional. Run these commands! They should look something like:
+  ```
+  echo >> /home/your-user-name/.bashrc
+  echo 'eval "$(/home/linuxbrew/.linuxbrew/bin/brew shellenv bash)"' >> /home/your-user-name/.bashrc
+  eval "$(/home/linuxbrew/.linuxbrew/bin/brew shellenv bash)"
+  ```
+For changes to take effect, either run `reset` or open a new terminal window.
 
- test -r ~/.bash_profile && echo "eval \$($(brew --prefix)/bin/brew shellenv)" >> ~/.bashrc
- ~~~
+5) Add the AMIA Open Source and MediaArea taps for Homebrew with: `brew tap amiaopensource/amiaos && brew tap mediaarea/mediaarea`
 
-  - Alternately some issues (such as the sdl2 conflict) have been avoided by adding Linuxbrew lower down in the path order than the Linuxbrew instructions call for (Such as by editing `/etc/environment` to include `/home/linuxbrew/.linuxbrew/bin` after the other $PATH directories.) Your mileage may vary!
- * Add the AMIA Open Source tap for Homebrew:
-   - `brew tap amiaopensource/amiaos`
+  ### Install vrecord
+6) You now should be able to install vrecord by running: `brew install vrecord`
 
-### Install additional vrecord dependencies via Brew
-* `brew install decklinksdk && brew install ffmpeg-ma --with-iec61883 && brew install gtkdialog` _Note:_ Some users on Ubuntu have reported installation problems with `gtkdialog` at step. See [this note](https://github.com/amiaopensource/homebrew-amiaos/blob/master/TROUBLESHOOTING.md#vrecord)  at the AMIA Open Source Homebrew repository for a possible fix.
-* `brew install vrecord`
+  ### Install optional dependencies
+  
+If DV functionality is desired, download and install the [DVRescue](https://mediaarea.net/DVRescue) command line tools from the MediaArea website.
 
-### Fix conflicting SDL2 dependencies
-* `brew uninstall --ignore-dependencies sdl2`
-* `sudo apt install libsdl2-dev`
-* This step may not be required if Brew has been configured lower in $PATH than standard system directories.
+The FFmpeg DV device can also be used for some DV features; this requires ffmpeg-ma to be compiled with the IEC61883 device. This can be done with `brew install ffmpeg-ma --with-iec61883` for a new installation or `brew reinstall ffmpeg-ma --with-iec61883` if ffmpeg-ma is already installed.
 
 # Instructions/Tips for other Linux Distributions
 ## Linux Mint