8000 Update README.md · sdk21/ffmpeg-python@49c877e · GitHub
[go: up one dir, main page]

Skip to content

Commit 49c877e

Browse files
authored
Update README.md
1 parent 995cf67 commit 49c877e

File tree

1 file changed

+33
-16
lines changed

1 file changed

+33
-16
lines changed

README.md

Lines changed: 33 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,10 @@ import ffmpeg
3232
)
3333
```
3434

35+
## [[API reference]](https://kkroening.github.io/ffmpeg-python/)
36+
3537
## Complex filter graphs
36-
FFmpeg is extremely powerful, but its command-line interface gets really complicated really quickly - especially when working with signal graphs and doing anything more than trivial.
38+
FFmpeg is extremely powerful, but its command-line interface gets really complicated rather quickly - especially when working with signal graphs and doing anything more than t 8000 rivial.
3739

3840
Take for example a signal graph that looks like this:
3941

@@ -111,17 +113,6 @@ Here are a few:
111113

112114
See the [Examples README](https://github.com/kkroening/ffmpeg-python/tree/master/examples) for additional examples.
113115

114-
## [API Reference](https://kkroening.github.io/ffmpeg-python/)
115-
116-
API documentation is automatically generated from python docstrings and hosted on github pages: https://kkroening.github.io/ffmpeg-python/
117-
118-
Alternatively, standard python help is available, such as at the python REPL prompt as follows:
119-
120-
```python
121-
>>> import ffmpeg
122-
>>> help(ffmpeg)
123-
```
124-
125116
## Custom Filters
126117

127118
Don't see the filter you're looking for? `ffmpeg-python` includes shorthand notation for some of the most commonly used filters (such as `concat`), but it's easy to use any arbitrary ffmpeg filter:
@@ -155,15 +146,39 @@ Arguments with special names such as `-qscale:v` can be specified as a keyword-a
155146

156147
When in doubt, refer to the [existing filters](https://github.com/kkroening/ffmpeg-python/blob/master/ffmpeg/_filters.py), [examples](https://github.com/kkroening/ffmpeg-python/tree/master/examples), and/or the [official ffmpeg documentation](https://ffmpeg.org/ffmpeg-filters.html).
157148

149+
## Frequently asked questions
150+
151+
**Why do I get an import/attribute/etc error from `import ffmpeg`?*
152+
153+
Make sure you ran `pip install ffmpeg-python` and not `pip install ffmpeg` or `pip install python-ffmpeg`.
154+
155+
**How do I do XYZ?**
156+
157+
Take a look at each of the links in the [Additional Resources](https://kkroening.github.io/ffmpeg-python/) section at the end of this README. If you look everywhere and can't find what you're looking for and have a question that may be relevant to other users, you may open an issue asking how to do it, while providing a thorough explanation of what you're trying to do and what you've tried so far.
158+
159+
Issues not directly related to `ffmpeg-python` or issues asking others to write your code for you or how to do the work of solving a complex signal processing problem for you that's not relevant to other users will be closed.
160+
161+
That said, we hope to continue improving our documentation and provide a community of support for people using `ffmpeg-python` to do cool and exciting things.
162+
163+
**Why did my audio stream get dropped?**
164+
165+
Some ffmpeg filters drop audio streams, and care must be taken to preserve the audio in the final output. The ``.audio`` and ``.video`` operators can be used to reference the audio/video portions of a stream so that they can be processed separately and then re-combined later in the pipeline.
166+
167+
This dilemma is intrinsic to ffmpeg, and ffmpeg-python tries to stay out of the way while users may refer to the official ffmpeg documentation as to why certain filters drop audio.
168+
169+
As usual, take a look at the [Examples](https://github.com/kkroening/ffmpeg-python/tree/master/examples#audiovideo-pipeline) (the "Audio/video pipeline" example in particular).
170+
158171
## Contributing
159172

160173
<img align="right" src="https://raw.githubusercontent.com/kkroening/ffmpeg-python/master/doc/logo.png" alt="ffmpeg-python logo" width="20%" />
161174

162-
Feel free to report any bugs or submit feature requests.
175+
One of the best things you can do to help make `ffmpeg-python` better is to answer [open questions](https://github.com/kkroening/ffmpeg-python/labels/question) in the issue tracker. The questions that are answered will be tagged and eventually incorporated into the documentation, examples, and other learning resources.
176+
177+
If you notice things that could be better in the documentation or overall development experience, please say so in the [issue tracker](https://github.com/kkroening/ffmpeg-python/issues). And of course, feel free to report any bugs or submit feature requests.
163178

164-
It's generally straightforward to use filters that aren't explicitly built into `ffmpeg-python` but if there's a feature you'd like to see included in the library, head over to the [issue tracker](https://github.com/kkroening/ffmpeg-python/issues).
179+
Pull requests are welcome as well, but it wouldn't hurt to touch base in the issue tracker or hop on the [Matrix chat channel](https://riot.im/app/#/room/#ffmpeg-python:matrix.org) first.
165180

166-
Pull requests are welcome as well.
181+
Anyone who fixes any of the [open bugs](https://github.com/kkroening/ffmpeg-python/labels/bug) or implements [requested enhancements](https://github.com/kkroening/ffmpeg-python/labels/enhancement) is a hero, but changes should include passing tests.
167182

168183
<br />
169184

@@ -177,9 +192,11 @@ Pull requests are welcome as well.
177192
## Additional Resources
178193

179194
- [API Reference](https://kkroening.github.io/ffmpeg-python/)
195+
- [Examples](https://github.com/kkroening/ffmpeg-python/tree/master/examples)
180196
- [Filters](https://github.com/kkroening/ffmpeg-python/blob/master/ffmpeg/_filters.py)
181-
- [Tests](https://github.com/kkroening/ffmpeg-python/blob/master/ffmpeg/tests/test_ffmpeg.py)
182197
- [FFmpeg Homepage](https://ffmpeg.org/)
183198
- [FFmpeg Documentation](https://ffmpeg.org/ffmpeg.html)
184199
- [FFmpeg Filters Documentation](https://ffmpeg.org/ffmpeg-filters.html)
200+
- [Test cases](https://github.com/kkroening/ffmpeg-python/blob/master/ffmpeg/tests/test_ffmpeg.py)
201+
- [Issue tracker](https://github.com/kkroening/ffmpeg-python/issues)
185202
- Matrix Chat: [#ffmpeg-python:matrix.org](https://riot.im/app/#/room/#ffmpeg-python:matrix.org)

0 commit comments

Comments
 (0)
0