Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 17 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,23 +41,27 @@ This header is required for HLS workflows but is **disabled by default**
to preserve compatibility with standard WebVTT players.

Example:

```bash
ccextractor input.ts --timestamp-map -o output.vtt
```

### Windows Package Managers

**WinGet:**

```powershell
winget install CCExtractor.CCExtractor
```

**Chocolatey:**

```powershell
choco install ccextractor
```

**Scoop:**

```powershell
scoop bucket add extras
scoop install ccextractor
Expand All @@ -78,25 +82,35 @@ You can also find the list of parameters and their brief description by running

You can find sample files on [our website](https://ccextractor.org/public/general/tvsamples/) to test the software.

### Building from Source
### Building from Source(Building on Windows using Visual Studio)

- [Building on Windows using WSL](docs/build-wsl.md)
1. Install Visual Studio (Community Edition) with "Desktop development with C++".
2. Navigate to the "windows" folder in the repository.
3. Open "the ccextractor.sln" file using Visual Studio.
4. Select the desired build configuration .
5. Click on "Build Solution" from the Build menu.
6. After a successful build, run the generated executable.

This is the recommended method for building CCExtractor on Windows.

#### Linux (Autotools) build notes

CCExtractor also supports an autotools-based build system under the `linux/`
directory.

Important notes:

- The autotools workflow lives inside `linux/`. The `configure` script is
generated there and should be run from that directory.
- Typical build steps are:

```
cd linux
./autogen.sh
./configure
make
```

- Rust support is enabled automatically if `cargo` and `rustc` are available
on the system. In that case, Rust components are built and linked during
`make`.
Expand Down Expand Up @@ -132,4 +146,4 @@ For more information visit the CCExtractor website: [https://www.ccextractor.org

## License

GNU General Public License version 2.0 (GPL-2.0)
GNU General Public License version 2.0 (GPL-2.0)
29 changes: 19 additions & 10 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,31 @@
## CCExtractor

check AUTHORS.TXT for history and developers

## License
GPL 2.0.

GPL 2.0.

## Description

Since the original port, the whole code has been rewritten (more than once,
one might add) and support for most subtitle formats around the world has
been added (teletext, DVB, CEA-708, ISDB...)

## Basic Usage
## Basic Usage

(please run ccextractor with no parameters for the complete manual -
this is for your convenience, really).

ccextractor reads a video stream looking for closed captions (subtitles).
It can do two things:

- Save the data to a "raw", unprocessed file which you can later use
as input for other tools, such as McPoodle's excellent suite.
- Generate a subtitles file (.srt,.smi, or .txt) which you can directly
as input for other tools, such as McPoodle's excellent suite.
- Generate a subtitles file (.srt,.smi, or .txt) which you can directly
use with your favourite player.

Running ccextractor without parameters shows the help screen. Usage is
Running ccextractor without parameters shows the help screen. Usage is
trivial - you just need to pass the input file and (optionally) some
details about the input and output files.

Expand All @@ -33,37 +36,43 @@ ccextractor input_video.ts
This command extracts subtitles from the input video file and generates a subtitle output file
(such as .srt) in the same directory.

Example with output file:

ccextractor input_video.ts -o output.srt
This command extracts subtitles from the input video and saves them as output.srt.

## Languages

Usually English captions are transmitted in line 21 field 1 data,
using channel 1, so the default values are correct so you don't
need to do anything and you don't need to understand what it all
means.

If you want the Spanish captions, you may need to play a bit with
the parameters. From what I've been, Spanish captions are usually
sent in field 2, and sometimes in channel 2.
sent in field 2, and sometimes in channel 2.

So try adding these parameter combinations to your other parameters.

-2
-2
-cc2
-2 -cc2

If there are Spanish subtitles, one of them should work.
If there are Spanish subtitles, one of them should work.

## McPoodle's page

http://www.theneitherworld.com/mcpoodle/SCC_TOOLS/DOCS/SCC_TOOLS.HTML

Essential CC related information and free (with source) tools.

## Encoding

This version, in both its Linux and Windows builds generates by
default Unicode files. You can use -latin1 and -utf8 if you prefer
default Unicode files. You can use -latin1 and -utf8 if you prefer
these encodings (usually it just depends on what your specific
player likes).

## Future work
- Please check www.ccextractor.org for news and future work.

- Please check www.ccextractor.org for news and future work.
10 changes: 10 additions & 0 deletions docs/using_cmake_build.txt
Original file line number Diff line number Diff line change
Expand Up @@ -34,3 +34,13 @@ cmake -DWITH_HARDSUBX=ON ../src/

Hint for looking all the things you want to set from outside
cmake -LAH ../src/

Complete Example:

cd ccextractor
mkdir build
cd build
cmake ../src/
make

This sequence configures and builds CCExtractor using CMake.