caption-inspector

(β˜… 100)

Caption Inspector is a reference decoder for Closed Captions (CEA-608 and CEA-708).

  • .gitignore
  • .travis.yml
  • CMakeLists.txt
  • Dockerfile
  • LICENSE
  • Makefile
  • NOTICE
  • README.md
  • travis_ffmpeg_install.sh

# Installation Guide

1. Get the code
git clone https://github.com/Comcast/caption-inspector

Downloads the entire project code from GitHub to your computer.

cd caption-inspector

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Homebrew A package manager for macOS/Linux.
brew install nasm

Installs the pre-built package via Homebrew β€” no source build required.

brew install yasm

Installs the pre-built package via Homebrew β€” no source build required.

βœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
make docker

Compiles the code based on the generated build configuration to produce an executable.

docker run -t caption-inspector -h

Runs the built image as an actual container.

docker run -tv $(pwd):/files caption-inspector -o /files /files/test/media/BigBuckBunny_256x144-24fps.ts

Runs the built image as an actual container.

docker run -tv $(pwd):/files caption-inspector -o /files /files/test/media/Plan9fromOuterSpace.scc -f 2400

Runs the built image as an actual container.

docker run -tv $(pwd):/files caption-inspector -o /files /files/test/media/NightOfTheLivingDead.mcc

Runs the built image as an actual container.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

4. CMake

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • CMake The tool used to generate build configuration.
  • C/C++ 컴파일러 Windows needs Visual Studio (Community edition, free), macOS needs Xcode Command Line Tools, Linux needs the gcc/g++ package.
mkdir build && cd build

Creates a folder to hold the build output and moves into it.

cmake ..

Analyzes the source code and generates build configuration files (must be run inside the build folder).

make

Compiles the code based on the generated build configuration to produce an executable.

βœ… Check that an executable was created inside the build folder, then run it directly (e.g. ./build/app_name).

5. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make

Compiles the code based on the generated build configuration to produce an executable.

make install

Compiles the code based on the generated build configuration to produce an executable.

make distclean

Compiles the code based on the generated build configuration to produce an executable.

make caption-inspector

Compiles the code based on the generated build configuration to produce an executable.

make ci_with_gpac

Compiles the code based on the generated build configuration to produce an executable.

βœ… If it finishes without errors, it worked. Try running the generated executable directly.

Pulled directly from this repo's README.

// repository documentation