Skip to content

Commit 0a9e174

Browse files
Merge pull request #3 from rbouqueau/ffmpeg-mispell-case
FFmpeg is the right name
2 parents 1692254 + a2e4464 commit 0a9e174

19 files changed

+52
-52
lines changed

docs/Filters/Rearchitecture.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ This was a long process (almost 2 years) resulting in:
2121
- moving MP4Client compositor and most of the GF_Terminal internals to a filter
2222
- addition of a new application [gpac](gpac_general), whose only purpose is to create and run filter chains
2323
- additions of a bunch of filters, including:
24-
- __encoders__ through [FFMPEG](https://ffmpeg.org/)
24+
- __encoders__ through [FFmpeg](https://ffmpeg.org/)
2525
- generic pipe and socket input and output
2626
- raw audio and video reframers
2727
- HEVC tile splitting and merging filters

docs/Filters/ffavf.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
<!-- automatically generated - do not edit, patch gpac/applications/gpac/gpac.c -->
22

3-
# FFMPEG AVFilter
3+
# FFmpeg AVFilter
44

55
Register name used to load filter: __ffavf__
66
This filter is not checked during graph resolution and needs explicit loading.
77
Filters of this class can connect to each-other.
88

99
This filter provides libavfilter raw audio and video tools.
10-
See FFMPEG documentation (https://ffmpeg.org/documentation.html) for more details
10+
See FFmpeg documentation (https://ffmpeg.org/documentation.html) for more details
1111
To list all supported avfilters for your GPAC build, use `gpac -h ffavf:*`.
1212

1313
# Declaring a filter
@@ -18,7 +18,7 @@ Example
1818
ffavf:f=showspectrum
1919
```
2020

21-
Unlike other FFMPEG bindings in GPAC, this filter does not parse other libavfilter options, you must specify them directly in the filter chain, and the [f](#f) option will have to be escaped.
21+
Unlike other FFmpeg bindings in GPAC, this filter does not parse other libavfilter options, you must specify them directly in the filter chain, and the [f](#f) option will have to be escaped.
2222
Example
2323
```
2424
ffavf::f=showspectrum=size=320x320 or ffavf::f=showspectrum=size=320x320::pfmt=rgb

docs/Filters/ffavin.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
<!-- automatically generated - do not edit, patch gpac/applications/gpac/gpac.c -->
22

3-
# FFMPEG AV Capture
3+
# FFmpeg AV Capture
44

55
Register name used to load filter: __ffavin__
66
This filter may be automatically loaded during graph resolution.
77

8-
Reads from audio/video capture devices using FFMPEG.
9-
See FFMPEG documentation (https://ffmpeg.org/documentation.html) for more details.
8+
Reads from audio/video capture devices using FFmpeg.
9+
See FFmpeg documentation (https://ffmpeg.org/documentation.html) for more details.
1010
To list all supported grabbers for your GPAC build, use `gpac -h ffavin:*`.
1111

1212
# Device identification

docs/Filters/ffbsf.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
<!-- automatically generated - do not edit, patch gpac/applications/gpac/gpac.c -->
22

3-
# FFMPEG BitStream filter
3+
# FFmpeg BitStream filter
44

55
Register name used to load filter: __ffbsf__
66
This filter is not checked during graph resolution and needs explicit loading.
77

88
This filter provides bitstream filters (BSF) for compressed audio and video formats.
9-
See FFMPEG documentation (https://ffmpeg.org/documentation.html) for more details
9+
See FFmpeg documentation (https://ffmpeg.org/documentation.html) for more details
1010
To list all supported bitstream filters for your GPAC build, use `gpac -h ffbsf:*`.
1111

1212
Several BSF may be specified in [f](#f) for different coding types. BSF not matching the coding type are silently ignored.

docs/Filters/ffdec.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
11
<!-- automatically generated - do not edit, patch gpac/applications/gpac/gpac.c -->
22

3-
# FFMPEG decoder
3+
# FFmpeg decoder
44

55
Register name used to load filter: __ffdec__
66
This filter may be automatically loaded during graph resolution.
77

8-
This filter decodes audio and video streams using FFMPEG.
9-
See FFMPEG documentation (https://ffmpeg.org/documentation.html) for more details.
8+
This filter decodes audio and video streams using FFmpeg.
9+
See FFmpeg documentation (https://ffmpeg.org/documentation.html) for more details.
1010
To list all supported decoders for your GPAC build, use `gpac -h ffdec:*`.
1111

1212
Options can be passed from prompt using `--OPT=VAL`
1313
The default threading mode is to let libavcodec decide how many threads to use. To enforce single thread, use `--threads=1`
1414

1515
# Codec Map
1616

17-
The [ffcmap](#ffcmap) option allows specifying FFMPEG codecs for codecs not supported by GPAC.
17+
The [ffcmap](#ffcmap) option allows specifying FFmpeg codecs for codecs not supported by GPAC.
1818
Each entry in the list is formatted as `GID@name` or `GID@+name`, with:
1919
* GID: 4CC or 32 bit identifier of codec ID, as indicated by `gpac -i source inspect:full`
20-
* name: FFMPEG codec name
20+
* name: FFmpeg codec name
2121
* `+': is set and extra data is set and formatted as an ISOBMFF box, removes box header
2222

2323
Example

docs/Filters/ffdmx.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
<!-- automatically generated - do not edit, patch gpac/applications/gpac/gpac.c -->
22

3-
# FFMPEG demultiplexer
3+
# FFmpeg demultiplexer
44

55
Register name used to load filter: __ffdmx__
66
This filter may be automatically loaded during graph resolution.
77

8-
This filter demultiplexes an input file or open a source protocol using FFMPEG.
9-
See FFMPEG documentation (https://ffmpeg.org/documentation.html) for more details.
8+
This filter demultiplexes an input file or open a source protocol using FFmpeg.
9+
See FFmpeg documentation (https://ffmpeg.org/documentation.html) for more details.
1010
To list all supported demultiplexers for your GPAC build, use `gpac -h ffdmx:*`.
1111
This will list both supported input formats and protocols.
1212
Input protocols are listed with `Description: Input protocol`, and the subclass name identifies the protocol scheme.

docs/Filters/ffenc.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
<!-- automatically generated - do not edit, patch gpac/applications/gpac/gpac.c -->
22

3-
# FFMPEG encoder
3+
# FFmpeg encoder
44

55
Register name used to load filter: __ffenc__
66
This filter may be automatically loaded during graph resolution.
77

8-
This filter encodes audio and video streams using FFMPEG.
9-
See FFMPEG documentation (https://ffmpeg.org/documentation.html) for more details.
8+
This filter encodes audio and video streams using FFmpeg.
9+
See FFmpeg documentation (https://ffmpeg.org/documentation.html) for more details.
1010
To list all supported encoders for your GPAC build, use `gpac -h ffenc:*`.
1111

1212
The filter will try to resolve the codec name in [c](#c) against a libavcodec codec name (e.g. `libx264`) and use it if found.

docs/Filters/ffmx.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
<!-- automatically generated - do not edit, patch gpac/applications/gpac/gpac.c -->
22

3-
# FFMPEG multiplexer
3+
# FFmpeg multiplexer
44

55
Register name used to load filter: __ffmx__
66
This filter may be automatically loaded during graph resolution.
77

8-
Multiplexes files and open output protocols using FFMPEG.
9-
See FFMPEG documentation (https://ffmpeg.org/documentation.html) for more details.
8+
Multiplexes files and open output protocols using FFmpeg.
9+
See FFmpeg documentation (https://ffmpeg.org/documentation.html) for more details.
1010
To list all supported multiplexers for your GPAC build, use `gpac -h ffmx:*`.This will list both supported output formats and protocols.
1111
Output protocols are listed with `Description: Output protocol`, and the subclass name identifies the protocol scheme.
1212
For example, if `ffmx:rtmp` is listed as output protocol, this means `rtmp://` destination URLs are supported.

docs/Filters/ffsws.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
<!-- automatically generated - do not edit, patch gpac/applications/gpac/gpac.c -->
22

3-
# FFMPEG video rescaler
3+
# FFmpeg video rescaler
44

55
Register name used to load filter: __ffsws__
66
This filter may be automatically loaded during graph resolution.
77
Filters of this class can connect to each-other.
88

9-
This filter rescales raw video data using FFMPEG to the specified size and pixel format.
9+
This filter rescales raw video data using FFmpeg to the specified size and pixel format.
1010

1111
## Output size assignment
1212
If [osize](#osize) is {0,0}, the output dimensions will be set to the input size, and input aspect ratio will be ignored.
@@ -40,7 +40,7 @@ When sample aspect ratio is kept, the filter will:
4040
- for gauss [p1](#p1) tunes the exponent and thus cutoff frequency
4141
- for lanczos [p1](#p1) tunes the width of the window function
4242

43-
See FFMPEG documentation (https://ffmpeg.org/documentation.html) for more details
43+
See FFmpeg documentation (https://ffmpeg.org/documentation.html) for more details
4444

4545

4646
# Options

docs/Filters/filters_properties.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -507,12 +507,12 @@ prores apcn | ProRes Video 422 STD
507507
prores apcs | ProRes Video 422 LT
508508
prores ap4x | ProRes Video 4444 XQ
509509
prores ap4h | ProRes Video 4444
510-
ffmpeg | FFMPEG unmapped codec
510+
ffmpeg | FFmpeg unmapped codec
511511
tmcd | QT TimeCode
512512
vvc 266 h266 | VVC Video
513513
vvs1 | VVC Subpicture Video
514514
usac xheaac | xHEAAC / USAC Audio
515-
ffv1 | FFMPEG Video Codec 1
515+
ffv1 | FFmpeg Video Codec 1
516516
dvbs | DVB Subtitles
517517
dvbs | DVB-TeleText
518518
div3 | MS-MPEG4 V3

docs/Filters/gpac_general.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ _FILTER_: a single filter declaration (e.g., `-i file`, `-o dump`, `inspect`, ..
77
_[LINK]_: a link instruction (e.g., `@`, `@2`, `@2#StreamType=Visual`, ...), see [gpac -h doc](filters_general#explicit-links-between-filters-link).
88
_[options]_: one or more option strings, each starting with a `-` character.
99
- an option using a single `-` indicates an option of gpac (see [gpac -hx](gpac_general#h)) or of libgpac (see [gpac -hx core](core_options))
10-
- an option using `--` indicates a global filter or meta-filter (e.g. FFMPEG) option, e.g. `--block_size=1000` or `--profile=Baseline` (see [gpac -h doc](core_config#global-filter-options))
10+
- an option using `--` indicates a global filter or meta-filter (e.g. FFmpeg) option, e.g. `--block_size=1000` or `--profile=Baseline` (see [gpac -h doc](core_config#global-filter-options))
1111

1212
Filter declaration order may impact the link resolver which will try linking in declaration order. Most of the time for simple graphs, this has no impact. However, for complex graphs with no link declarations, this can lead to different results.
1313
Options do not require any specific order, and may be present anywhere, including between link statements or filter declarations.

docs/Howtos/dash/DASH-Sequences.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -417,8 +417,8 @@ To generate these DASH sequences, several open-source software tools have been u
417417
* GPAC/MP4Box to process the BIFS visual data and export it to a raw video track in AVI,
418418
* Audacity \[1.3 Beta\] to generate the raw audio track,
419419
* x264 \[0.118.2085 8a62835\] for the AVC|H.264 encoding,
420-
* faac \[as included in ffmpeg build\] for AAC encoding,
421-
* LAME \[as included in ffmpeg build\] for MP3 encoding,
420+
* faac \[as included in FFmpeg build\] for AAC encoding,
421+
* LAME \[as included in FFmpeg build\] for MP3 encoding,
422422
* GPAC/MP42TS \[REV3926\] for Transport Stream packaging,
423423
* GPAC/MP4Box \[REV3926\] for ISOBMF packaging, MPD generation and DASH segmentation (TS and ISOBMFF).
424424

docs/Howtos/dash/DASH-intro.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ For more information on content playback:
1717

1818

1919
## Content Generation
20-
If you generate your content with an third-party application such as ffmpeg, make sure all your video qualities use closed GOP and have the same positions for their IDR frames.
20+
If you generate your content with an third-party application such as ```ffmpeg```, make sure all your video qualities use closed GOP and have the same positions for their IDR frames.
2121
When using GPAC, this is usually ensure by using the `fintra` option.
2222

2323
GPAC can be used to generate both static and live DASH/HLS content. For live cases, GPAC can expose the created files:

docs/Howtos/dash/HEVC-Tile-based-adaptation-guide.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ If you want to produce a live feed of tiled video, you can either:
8181

8282
GPAC does not have a direct wrapper for Kvazaar, but you can either:
8383

84-
- use a FFmpeg build with Kvazaar enabled (`--enable-libkvazaar` in ffmpeg configure) - check GPAC support using `gpac -h ffenc:libkvazaar`
84+
- use a FFmpeg build with Kvazaar enabled (`--enable-libkvazaar` in FFmpeg's configure) - check GPAC support using `gpac -h ffenc:libkvazaar`
8585
- use an external grab+Kvazaar encoding and pipe its output into GPAC.
8686

8787
### Piping encoder output

docs/Howtos/encoding.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -30,15 +30,15 @@ You can directly call your preferred encoder rather than letting the link resolv
3030

3131
```gpac -i source.yuv:size=1280x720 ffenc:c=avc -o test.mp4```
3232

33-
This will explicitly load the FFMPEG encoder to do the job.
33+
This will explicitly load the FFmpeg encoder to do the job.
3434

35-
Note that for `ffenc`, since the filter provides all encoders supported by your FFMPEG build, you may have several choices within FFMPEG itself. To specify the true desired codec rather than the format, use the codec name directly:
35+
Note that for `ffenc`, since the filter provides all encoders supported by your FFmpeg build, you may have several choices within FFmpeg itself. To specify the true desired codec rather than the format, use the codec name directly:
3636

3737
```
3838
gpac -i source.yuv:size=1280x720 enc:c=libx264 -o test.mp4
3939
gpac -i source.yuv:size=1280x720 enc:c=libx264rgb -o test.mp4
4040
```
41-
__Warning: Hardware encoders of FFMPEG have not been tested yet!__
41+
__Warning: Hardware encoders of FFmpeg have not been tested yet!__
4242

4343
## Transcoding from a non raw video file
4444

@@ -53,7 +53,7 @@ As explained previously, the link directive `@` ensures that we do the transcodi
5353

5454
## Setting encoder parameters
5555

56-
Currently, all encoders audio and video in GPAC are using FFMPEG. We therefore only illustrate encoder parameters with the [ffenc](ffenc) filter.
56+
Currently, all encoders audio and video in GPAC are using FFmpeg. We therefore only illustrate encoder parameters with the [ffenc](ffenc) filter.
5757

5858
```gpac -i source.mp4 c=avc:b=2M -o test.avc```
5959

@@ -66,7 +66,7 @@ The above command will encode the video track in `source.mp4` into AVC|H264 at
6666

6767
```gpac -i source.mp4 c=avc::x264-params=no-mbtree:sync-lookahead=0::profile=baseline -o test.avc```
6868

69-
The above command will encode the video track in `source.mp4` into AVC|H264 and pass two options to ffmpeg encoder:
69+
The above command will encode the video track in `source.mp4` into AVC|H264 and pass two options to FFmpeg encoder:
7070

7171
- `x264-params`, with value `no-mbtree:sync-lookahead=0`
7272
- `profile`, with value `baseline`
@@ -82,11 +82,11 @@ To get a list of all options supported by a given encoder of the ffenc filter, f
8282
The above command will encode the video track in `source.mp4` into AVC|H264, converting the source data to YUV 422 8bit planar.
8383

8484
__Discussion__
85-
FFMPEG usually comes with several variations of the same coding type, with different pixel format supported. For example, AVC|H264 encoding can use both `libx264` and `libx264_rgb` encoders. If the source data is decoded into RGB by the decoder, the `ffenc` filter will match the `libx264_rgb` encoder as supporting RGB input and AVC format. The resulting file may be in a profile not supported by most devices !
85+
FFmpeg usually comes with several variations of the same coding type, with different pixel format supported. For example, AVC|H264 encoding can use both `libx264` and `libx264_rgb` encoders. If the source data is decoded into RGB by the decoder, the `ffenc` filter will match the `libx264_rgb` encoder as supporting RGB input and AVC format. The resulting file may be in a profile not supported by most devices !
8686

8787
Setting the pixel format using [pfmt](ffenc) will make sure you encode in YUV format; alternatively, you can also enforce the encoder used by setting `ffc=libx264`.
8888

89-
_Note: The `pfmt` option is a generic option of all present and future encoders in GPAC, while `ffc` option is specific to FFMPEG encoder._
89+
_Note: The `pfmt` option is a generic option of all present and future encoders in GPAC, while `ffc` option is specific to FFmpeg encoder._
9090

9191

9292
## Changing Resolution
@@ -110,7 +110,7 @@ The above command will encode the `source.pcm` 48000 Hz stereo signed 16 bit PCM
110110

111111
```gpac -i source.mp4 enc:c=aac -o test.mp4```
112112

113-
The above command will encode the `source.mp4` audio tracks into AAC, even if the track is already in AAC format, and use FFMPEG `aac` encoder for the job. Note that the `ffc` option will only be used by the ffenc filter. If another filter provides AAC encoding and is used to encode the stream, the `ffc` option will likely be reported as not used by the filter session.
113+
The above command will encode the `source.mp4` audio tracks into AAC, even if the track is already in AAC format, and use FFmpeg `aac` encoder for the job. Note that the `ffc` option will only be used by the ffenc filter. If another filter provides AAC encoding and is used to encode the stream, the `ffc` option will likely be reported as not used by the filter session.
114114

115115
## Changing sample rate
116116

docs/Howtos/filters-oneliners.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@ Mux sources to MPEG-2 TS with a target mux rate - _see [filter](m2tsmx)_
187187
gpac -i source:#ServiceID=1 -i source2:#ServiceID=2 -o dst.ts:rate=10m
188188
```
189189

190-
Mux sources to MKV (for builds with FFMPEG support) - _see [filter](ffmx)_
190+
Mux sources to MKV (for builds with FFmpeg support) - _see [filter](ffmx)_
191191
```
192192
gpac -i source -o dst.mkv
193193
```
@@ -249,7 +249,7 @@ Downscale and transcode to AVC 1mbps and aac 128k while monitoring video output
249249
gpac -i source ffsws:osize=256x144 enc:c=avc:b=1m enc:c=aac:b=128k -o dst.mp4 vout:vsync=0
250250
```
251251

252-
Use two-pass encoding with FFMPEG (libx264 only for GPAC 2.0, all codecs for higher versions) - _see [filter](ffenc)_
252+
Use two-pass encoding with FFmpeg (libx264 only for GPAC 2.0, all codecs for higher versions) - _see [filter](ffenc)_
253253
```
254254
#first pass
255255
gpac -i source enc:c=avc:b=3m:pass1 -o null
@@ -554,7 +554,7 @@ Decode source MP4 enabling only the minimum filters:
554554
gpac -blacklist=-fin,mp4dmx,ffdec,vout source.mp4 vout
555555
```
556556

557-
# FFMPEG support
557+
# FFmpeg support
558558

559559
Set gpac as RTMP output server
560560
```
@@ -636,15 +636,15 @@ gpac -i video.mp4:#ffid=dist -i ref.mp4:#ffid=ref \
636636
@@ @@1 ffavf::f='[dist][ref]ssim=f=ssim2.log' @ -o null
637637
```
638638

639-
SRT session from local file (requires FFMPEG with SRT support)
639+
SRT session from local file (requires FFmpeg with SRT support)
640640
```
641641
#player listening for SRT handshake
642642
gpac -play srt://127.0.0.1:1234:gpac:mode=listener
643643
#streamer with real-time regulation
644644
gpac -i video.mp4 reframer:rt=on -o srt://127.0.0.1:1234:gpac:ffmt=mpegts
645645
```
646646

647-
SRT session from avgen filter (requires FFMPEG with SRT support)
647+
SRT session from avgen filter (requires FFmpeg with SRT support)
648648
```
649649
#player listening for SRT handshake
650650
gpac -play srt://127.0.0.1:1234:gpac:mode=listener

docs/Howtos/raw-formats.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ Prior to GPAC 2.0, the following command had to be used:
5050
The link directive `@` is used to prevent the decoded YUV/RGB data PID to link against the `test.yuv` destination, by enforcing the destination to only accept PIDs coming from `ffsws`, as described in the [general documentation](filters_general#filter-linking-link). GPAC 2.0 and above simplified command line processing to avoid link directives in most cases.
5151

5252

53-
The simplest way to resize a video in GPAC at the current time is to use the ffmpeg-based [rescaler](ffsws).
53+
The simplest way to resize a video in GPAC at the current time is to use the FFmpeg-based [rescaler](ffsws).
5454

5555
The [writegen](writegen) filter used in the extraction process can be used to specify an extraction range using its [start](writegen#start) and [dur](writegen#dur) options:
5656

docs/Player/Player-Features.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -93,8 +93,8 @@ Decoders included in default builds:
9393
- MPEG-4 AAC, MPEG-1/2 audio, Dolby AC-3
9494
- MPEG-1/2/4, H264|AVC, SVC, HEVC, L-HEVC
9595
- AMR speech codec using 3GPP fixed-point reference code
96-
- All codecs supported by FFMPEG
97-
- Xiph Media codecs: Vorbis, Theora (FLAC and Opus supported through FFMPEG)
96+
- All codecs supported by FFmpeg
97+
- Xiph Media codecs: Vorbis, Theora (FLAC and Opus supported through FFmpeg)
9898
- SRT / 3GPP timed text / MPEG-4 Streaming Text decoder /WebVTT (rendering done through GPAC)
9999

100100
# Networking
@@ -127,8 +127,8 @@ Any possible input from GPAC filter architecture is supported by the player. Thi
127127
- RFC 3984 for H264/AVC video (only STAP-A, FU-A and regular NAL units)
128128
- RFC 7798 for H265|HEVC video (AP, FU and regular NAL units)
129129

130-
- Generic input using FFMPEG libavformat, supports most AV containers known (MPEG, VOB, AVI, MOV ...) and many protocols
131-
- Generic frame grabber FFMPEG libavdevice, supports many capture devices
130+
- Generic input using FFmpeg libavformat, supports most AV containers known (MPEG, VOB, AVI, MOV ...) and many protocols
131+
- Generic frame grabber FFmpeg libavdevice, supports many capture devices
132132

133133
# Available plugins
134134
## Audio output

0 commit comments

Comments
 (0)