Skip to content

Commit 9166464

Browse files
authored
Update README.md
1 parent fa075bf commit 9166464

File tree

1 file changed

+38
-39
lines changed

1 file changed

+38
-39
lines changed

README.md

Lines changed: 38 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -4,134 +4,133 @@
44

55
<p>
66

7-
É um simples pacote de python para rodar videos no terminal usando caracteres [ASCII](https://en.wikipedia.org/wiki/ASCII).
7+
It's a simple python package to play videos in a terminal using [ASCII](https://en.wikipedia.org/wiki/ASCII) characters.
88

9-
[![Contribuidores financeiros no Open Collective](https://opencollective.com/video-to-ascii/all/badge.svg?label=financial+contributors)](https://opencollective.com/video-to-ascii) [![PyPI version](https://badge.fury.io/py/video-to-ascii.svg)](https://badge.fury.io/py/video-to-ascii)
10-
[![Manutenibilidade](https://api.codeclimate.com/v1/badges/3108b26a0bcfffd4b4fe/maintainability)](https://codeclimate.com/github/joelibaceta/video-to-ascii/maintainability)
11-
[![constribuições bem-vindas](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/joelibaceta/video-to-ascii)
9+
[![Financial Contributors on Open Collective](https://opencollective.com/video-to-ascii/all/badge.svg?label=financial+contributors)](https://opencollective.com/video-to-ascii) [![PyPI version](https://badge.fury.io/py/video-to-ascii.svg)](https://badge.fury.io/py/video-to-ascii)
10+
[![Maintainability](https://api.codeclimate.com/v1/badges/3108b26a0bcfffd4b4fe/maintainability)](https://codeclimate.com/github/joelibaceta/video-to-ascii/maintainability)
11+
[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/joelibaceta/video-to-ascii)
1212

1313
</p>
1414

1515
![Screenshot](./images/Simpsons.apng)
1616

1717
</div>
1818

19-
<details><summary><b>Traduções</b></summary>
19+
<details><summary><b>Translations</b></summary>
2020
<p>
2121

2222
- [🇺🇸 English](./README.md)
2323
- [🇪🇸 Español](./translations/README_es.md)
2424
- [🇹🇼 繁體中文](./translations/README_zh-TW.md)
25-
- [pt-BR Português](./translations/README_pt-BR.md)
2625

2726
<p>
2827
</details>
2928

30-
## Requisitos
29+
## Requirements
3130

3231
- Python3
33-
- PortAudio (_Necessário somente para instalação com suporte de áudio_)
34-
- FFmpeg (_Necessário somente para instalação com suporte de áudio_)
35-
- Linux ou MacOS ... por agora
32+
- PortAudio (_Only required for installation with audio support_)
33+
- FFmpeg (_Only required for installation with audio support_)
34+
- Linux or MacOS ... by now
3635

37-
## Instalação
36+
## Installation
3837

39-
Instalação padrão
38+
Standard installation
4039

4140
```bash
4241
$ pip3 install video-to-ascii
4342
```
4443

45-
Instalação com suporte de áudio
44+
With audio support installation
4645

4746
```bash
4847
$ pip3 install video-to-ascii --install-option="--with-audio"
4948
```
5049

51-
## Como usar
50+
## How to use
5251

53-
Apenas execute `video-to-ascii` em seu terminal
52+
Just run `video-to-ascii` in your terminal
5453

5554
```bash
5655
$ video-to-ascii -f myvideo.mp4
5756
```
5857

59-
### Opções
58+
### Options
6059

6160
**`--strategy`**
62-
Permite escolher a estratégia para renderizar a saída.
61+
Allow to choose a strategy to render the output.
6362

6463
![Render Strategies](./images/Strategies.png)
6564

6665
**`-o --output`**
67-
Exporta a saída renderizada para um arquivo bash para compartilhar com alguém.
66+
Export the rendering output to a bash file to share with someone.
6867

69-
![Exportando](./images/export.png)
68+
![Exporting](./images/export.png)
7069

7170
**`-a --with-audio`**
72-
Se foi feita a instalação com suporte de áudio, você pode usar essa opção para rodar a trilha de áudio enquanto o video renderiza os caracteres em ASCII.
71+
If an installation with audio support was made, you can use this option to play the audio track while rendering the video ascii characters.
7372

74-
## Como funciona
73+
## How it works
7574

76-
Todo video é composto por um número de frames que são executados em uma certa taxa de frames.
75+
Every video is composed by a set of frames that are played at a certain frame rate.
7776

7877
![Video Frames](./images/imgVideoFrames.png)
7978

80-
Uma vez que o terminal tem um número específico de linhas e colunas, nós temos que redimensionar o vídeo para ajustar as limitações da tela do terminal.
79+
Since a terminal has a specific number of rows and columns, we have to resize our video to adjust to the terminal size limitations.
8180

8281
![Terminal](./images/imgTerminal.png)
8382

84-
Para chegar a uma visualização correta de todo o frame nós ajustamos a _altura do frame_ para igualar com as _linhas do terminal_, evitando de usar mais _caracteres_ que o número de _colunas do terminal_.
83+
To reach a correct visualization of an entire frame we need to adjust the _frame height_ to match the _terminal rows_, avoiding using more _characters_ than the number of _terminal columns_.
8584

8685
![Resizing](./images/imgResizing.png)
8786

88-
Quando um caractere é escolhido para representar um pixel nós temos que medir a relevância da cor desse pixel no frame, baseado nisso nós selecionamos o caractere mais apropriado baseado na [iluminação relativa](https://en.wikipedia.org/wiki/Relative_luminance) em espaços colorimétricos, usando a versão simplificada da função de luminosidade.
87+
When picking a character to represent a pixel we need to measure the relevance of that pixel's color in the frame, based on that we can then select the most appropriate character based on the [relative luminance](https://en.wikipedia.org/wiki/Relative_luminance) in colorimetric spaces, using a simplified version of the luminosity function.
8988

9089
<p align="center">
9190
<img src="./images/Luminosity.svg">
9291
</p>
9392

94-
> A luz verde contribui mais para a intensidade percebida pelos humanos, e a luz azul menos.
93+
> Green light contributes the most to the intensity perceived by humans, and blue light the least.
9594
96-
Essa função retorna um inteiro no intervalo entre 0 e 255, nós assinamos um caractere de acordo com a densidade para mostrar superfícies mais coloridas para áreas com maiores intensidades de cor (valores maiores).
95+
This function returns an integer in the range from 0 to 255, we assign a character according to density to show more colored surface for areas with more intense color (highest values).
9796

9897
```python
9998
CHARS_LIGHT = [' ', ' ', '.', ':', '!', '+', '*', 'e', '$', '@', '8']
10099
CHARS_COLOR = ['.', '*', 'e', 's', '@']
101100
CHARS_FILLED = ['', '', '', '']
102101
```
103102

104-
O intervalo de cores reduzidas suportadas pelo terminal é um problema que precisamos levar em conta. Terminais modernos suportam até 256 cores, então nós precisamos encontrar a cor 8 bit mais próxima que se assemelha ao pixel original de cor 16 ou 24 bit, nós chamamos esse set de 256 cores de [cores ANSI](https://stackoverflow.com/questions/4842424/list-of-ansi-color-escape-sequences).
103+
The reduced range of colors supported by the terminal is a problem we need to account for. Modern terminals support up to 256 colors, so we need to find the closest 8 bit color that matches the original pixel in 16 or 24 bit color, we call this set of 256 colors [ANSI colors](https://stackoverflow.com/questions/4842424/list-of-ansi-color-escape-sequences).
105104

106105
![The Mapping of RGB and ANSI Colors](./images/imgPixelSection.png)
107106

108107
![8 Bits Color Table](./images/8-bit_color_table.png)
109108

110-
Finalmente, quando colocamos isso tudo junto, nós temos um caractere apropriado para cada pixel e uma nova cor.
109+
Finally, when putting it all together, we will have an appropriate character for each pixel and a new color.
111110

112111
![Frame Image by Characters](./images/imgPixelImage.png)
113112

114-
## Contribuidores
113+
## Contributors
115114

116-
### Contribuidores de código
115+
### Code Contributors
117116

118-
Esse projeto existe graças as todas as pessoas que contribuíram. [[Contribua](./CONTRIBUTING.md)].
117+
This project exists thanks to all the people who contribute. [[Contribute](./CONTRIBUTING.md)].
119118

120119
<a href="https://github.com/joelibaceta/video-to-ascii/graphs/contributors"><img src="https://opencollective.com/video-to-ascii/contributors.svg?width=890&button=false" /></a>
121120

122-
### Contribuidores Financeiros
121+
### Financial Contributors
123122

124-
Se torne um contribuidor financeiro e ajude a sustentar nossa comunidade. [[Contribua](https://opencollective.com/video-to-ascii/contribute/)].
123+
Become a financial contributor and help us sustain our community. [[Contribute](https://opencollective.com/video-to-ascii/contribute/)].
125124

126-
Ou apenas me ajude [comprando um café](https://ko-fi.com/joelibaceta).
125+
Or maybe just [buy me a coffee](https://ko-fi.com/joelibaceta).
127126

128-
#### Individuos
127+
#### Individuals
129128

130129
<a href="https://opencollective.com/video-to-ascii#backers" target="_blank" rel="noopener"><img src="https://opencollective.com/video-to-ascii/individuals.svg?width=890"></a>
131130

132-
#### Organizações
131+
#### Organizations
133132

134-
Suporte esse projeto com a sua organização. Sua logo vai aparecer aqui com o link do seu website. [[Contribua](https://opencollective.com/video-to-ascii/contribute)]
133+
Support this project with your organization. Your logo will show up here with a link to your website. [[Contribute](https://opencollective.com/video-to-ascii/contribute)]
135134

136135
<a href="https://opencollective.com/video-to-ascii/organization/0/website" target="_blank" rel="noopener"><img src="https://opencollective.com/video-to-ascii/organization/0/avatar.svg"></a>
137136
<a href="https://opencollective.com/video-to-ascii/organization/1/website" target="_blank" rel="noopener"><img src="https://opencollective.com/video-to-ascii/organization/1/avatar.svg"></a>
@@ -144,5 +143,5 @@ Suporte esse projeto com a sua organização. Sua logo vai aparecer aqui com o l
144143
<a href="https://opencollective.com/video-to-ascii/organization/8/website" target="_blank" rel="noopener"><img src="https://opencollective.com/video-to-ascii/organization/8/avatar.svg"></a>
145144
<a href="https://opencollective.com/video-to-ascii/organization/9/website" target="_blank" rel="noopener"><img src="https://opencollective.com/video-to-ascii/organization/9/avatar.svg"></a>
146145

147-
## Visto em
146+
## As Seen On
148147
<a href="https://www.producthunt.com/posts/video-to-ascii" target="_blank" rel="noopener"><img src="https://user-images.githubusercontent.com/864790/124545434-a2e7fe80-ddee-11eb-9d80-f24049524fd9.png" width="100px"></a>

0 commit comments

Comments
 (0)