https://github.com/gurrutia/videoxt

Extract audio, individual frames, short clips and GIFs from videos.
https://github.com/gurrutia/videoxt

audio cli ffmpeg gif image image-processing images moviepy opencv python video video-processing

Last synced: 3 months ago
JSON representation

Extract audio, individual frames, short clips and GIFs from videos.

• Host: GitHub
• URL: https://github.com/gurrutia/videoxt
• Owner: gurrutia
• License: mit
• Created: 2023-03-04T04:23:48.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-11-17T23:44:03.000Z (12 months ago)
• Last Synced: 2024-07-16T20:41:08.164Z (4 months ago)
• Topics: audio, cli, ffmpeg, gif, image, image-processing, images, moviepy, opencv, python, video, video-processing
• Language: Python
• Homepage: https://pypi.org/project/videoxt/
• Size: 1010 KB
• Stars: 6
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  



[![PyPI](https://img.shields.io/pypi/v/videoxt)](https://pypi.org/project/videoxt) [![Downloads](https://static.pepy.tech/badge/videoxt)](https://pepy.tech/project/videoxt) ![tests](https://github.com/gurrutia/videoxt/actions/workflows/tox.yml/badge.svg)

**VideoXT** is a simple library and CLI tool for extracting audio, individual frames, short clips and GIFs from videos.

See the [documentation](https://gurrutia.github.io/videoxt) for more details.

- [Installation](#installation)

- [Usage](#usage)

- [Contributing](#contributing)

- [Used By](#used-by)

---

## Installation

Available on [pypi](https://pypi.org/project/videoxt/).

```sh

pip install videoxt

```

---

## Usage

From the command-line:

```sh

# extract audio from a video file (default: 'mp3')

$ videoxt audio MyVideo.mp4

{"video": {"filepath": "C:/Users/gurrutia/MyVideo.mp4", ...}, "start_time": 0, ...}

# extracting audio...

{"success": true, ...}

$ ls

MyVideo.mp4  MyVideo.mp3

```

As a library:

```python

$ python

>>> # extract all frames from a video file (default: 'jpg')

>>> import videoxt

>>> filepath = 'C:/Users/gurrutia/MyVideo.mp4'  # or 

>>> result = videoxt.extract_frames(filepath)  # or videoxt.extract('frames', filepath)

>>> result.destpath

pathlib.Path('C:/Users/gurrutia/MyVideo.mp4_frames')

>>> result.elapsed_time

3.14159265358979323

>>> len(list(result.destpath.glob('*.jpg'))) # default: 'jpg'

100  # number of frames extracted

>>> result.json()

{'success': True, ...}

```

---

## Contributing

For guidance on setting up a development environment and to make a contribution, see the [contributing guidelines](https://github.com/gurrutia/videoxt/blob/abdc3fe99a9244e668c270544bc83b44f7b828f3/CONTRIBUTING.md).

---

## Used By

- **Best Buy Teen Tech Center** at **Grand St. Settlement**, allowing filmmaking instructors to gather film stills that aid in constructing lesson plans for their youth workshops. [Download a workshop example here](https://github.com/gurrutia/videoxt/files/10887456/GSS_Filmmaking_Fall_2022_Transfiguration_Schools_W1.pdf).