Settings#

class remote_compression.settings.Settings(codec: str = 'libx265', map: bool = True, height: int = 720, replace: bool = False, hostname: str = 'remote_host', stats: dict = None)[source]#

codec#

Name of the encoding codec to use

Type:: str

map#

Enforce full channel redirection. Use it to avoid (a bit) silent conversion errors due to strange multi-channel streams.

Type:: bool

height#

Maximal height (for resizing)

Type:: int, optional

replace#

Should the transcoded version overwrite the original (do it at your own risk!)

Type:: bool, optional

hostname#

Remote host. Details related to connection should lie in the ssh config file.

Type:: str, optional

stats#

Result of last check.

Type:: dict

Examples

>>> settings = Settings()
>>> settings.check('data/big.mp4') 
{'file': 'big.mp4', 'success': True, 'codec': True, 'resize': True, 'todo': True, 'cmd': 'ffmpeg -y -i "%(r_source)s" -vf scale=-1280:720 -map 0 -c:v libx265 -c:a copy -c:s copy -max_muxing_queue_size 9999 "%(r_target)s"'}
>>> settings.check('data/small.mp4') 
{'file': 'small.mp4', 'success': True, 'codec': True, 'resize': False, 'todo': True, 'cmd': 'ffmpeg -y -i "%(r_source)s"  -map 0 -c:v libx265 -c:a copy -c:s copy -max_muxing_queue_size 9999 "%(r_target)s"'}
>>> settings.check('data/ovnis.mp4') 
Issue with ovnis.mp4
{'file': 'ovnis.mp4', 'success': False, 'todo': False}
>>> settings = Settings(height=None, codec='libx264')
>>> settings.check('data/big.mp4') 
{'file': 'big.mp4', 'success': True, 'codec': False, 'resize': False, 'todo': False, 'cmd': 'ffmpeg -y -i "%(r_source)s"  -map 0 -c:v libx264 -c:a copy -c:s copy -max_muxing_queue_size 9999 "%(r_target)s"'}
>>> settings.stats['file'] 
'big.mp4'

remote_compression.settings.probe(file, fields=None)[source]#

Parameters:

file (Path or str) – File location
fields (dict) – Fields to extract

Returns:

dict – Extracted fields.
bool – Success of parsing.

Examples

>>> probe('data/small.mp4') 
({'width': 1280, 'height': 720, 'codec_name': 'h264'}, True)
>>> probe('data/big.mp4') 
({'width': 1920, 'height': 1080, 'codec_name': 'h264'}, True)
>>> probe('data/ovnis.mp4') 
({}, False)