Warning
This document is for an old release of Galaxy. You can alternatively view this page in the latest release if it exists or view the top of the latest release's documentation.
Source code for galaxy.datatypes.media
"""Video classes"""
import json
import subprocess
import wave
from functools import lru_cache
from typing import (
List,
Tuple,
)
from galaxy.datatypes.binary import Binary
from galaxy.datatypes.metadata import (
ListParameter,
MetadataElement,
)
from galaxy.datatypes.protocols import DatasetProtocol
from galaxy.util import which
@lru_cache(maxsize=128)
def _ffprobe(path):
return subprocess.run(
["ffprobe", "-loglevel", "quiet", "-show_format", "-show_streams", "-of", "json", path], capture_output=True
)
[docs]def ffprobe(path):
completed_process = _ffprobe(path)
completed_process.check_returncode()
data = json.loads(completed_process.stdout.decode("utf-8"))
return data["format"], data["streams"]
[docs]class Audio(Binary):
MetadataElement(
name="duration",
default=0,
desc="Length of audio sample",
readonly=True,
visible=True,
optional=True,
no_value=0,
)
MetadataElement(
name="audio_codecs",
default=[],
desc="Audio codec(s)",
param=ListParameter,
readonly=True,
visible=True,
optional=True,
no_value=[],
)
MetadataElement(
name="sample_rates",
default=[],
desc="Sampling Rate(s)",
param=ListParameter,
readonly=True,
visible=True,
optional=True,
no_value=[],
)
MetadataElement(
name="audio_streams",
default=0,
desc="Number of audio streams",
readonly=True,
visible=True,
optional=True,
no_value=0,
)
[docs] def set_meta(self, dataset: DatasetProtocol, overwrite: bool = True, **kwd) -> None:
if which("ffprobe"):
metadata, streams = ffprobe(dataset.file_name)
dataset.metadata.duration = metadata["duration"]
dataset.metadata.audio_codecs = [
stream["codec_name"] for stream in streams if stream["codec_type"] == "audio"
]
dataset.metadata.sample_rates = [
stream["sample_rate"] for stream in streams if stream["codec_type"] == "audio"
]
dataset.metadata.audio_streams = len([stream for stream in streams if stream["codec_type"] == "audio"])
[docs]class Video(Binary):
MetadataElement(
name="resolution_w",
default=0,
desc="Width of video stream",
readonly=True,
visible=True,
optional=True,
no_value=0,
)
MetadataElement(
name="resolution_h",
default=0,
desc="Height of video stream",
readonly=True,
visible=True,
optional=True,
no_value=0,
)
MetadataElement(
name="fps", default=0, desc="FPS of video stream", readonly=True, visible=True, optional=True, no_value=0
)
MetadataElement(
name="video_codecs",
default=[],
desc="Video codec(s)",
param=ListParameter,
readonly=True,
visible=True,
optional=True,
no_value=[],
)
MetadataElement(
name="audio_codecs",
default=[],
desc="Audio codec(s)",
param=ListParameter,
readonly=True,
visible=True,
optional=True,
no_value=[],
)
MetadataElement(
name="video_streams",
default=0,
desc="Number of video streams",
readonly=True,
visible=True,
optional=True,
no_value=0,
)
MetadataElement(
name="audio_streams",
default=0,
desc="Number of audio streams",
readonly=True,
visible=True,
optional=True,
no_value=0,
)
def _get_resolution(self, streams: List) -> Tuple[int, int, float]:
for stream in streams:
if stream["codec_type"] == "video":
w = stream["width"]
h = stream["height"]
dividend, divisor = stream["avg_frame_rate"].split("/")
fps = float(dividend) / float(divisor)
else:
w = h = fps = 0
return w, h, fps
[docs] def set_meta(self, dataset: DatasetProtocol, overwrite: bool = True, **kwd) -> None:
if which("ffprobe"):
metadata, streams = ffprobe(dataset.file_name)
(w, h, fps) = self._get_resolution(streams)
dataset.metadata.resolution_w = w
dataset.metadata.resolution_h = h
dataset.metadata.fps = fps
dataset.metadata.audio_codecs = [
stream["codec_name"] for stream in streams if stream["codec_type"] == "audio"
]
dataset.metadata.video_codecs = [
stream["codec_name"] for stream in streams if stream["codec_type"] == "video"
]
dataset.metadata.audio_streams = len([stream for stream in streams if stream["codec_type"] == "audio"])
dataset.metadata.video_streams = len([stream for stream in streams if stream["codec_type"] == "video"])
[docs]class Mkv(Video):
file_ext = "mkv"
[docs] def sniff(self, filename: str) -> bool:
if which("ffprobe"):
metadata, streams = ffprobe(filename)
return "matroska" in metadata["format_name"].split(",")
return False
[docs]class Mp4(Video):
"""
Class that reads MP4 video file.
>>> from galaxy.datatypes.sniff import sniff_with_cls
>>> sniff_with_cls(Mp4, 'video_1.mp4')
True
>>> sniff_with_cls(Mp4, 'audio_1.mp4')
False
"""
file_ext = "mp4"
[docs] def sniff(self, filename: str) -> bool:
if which("ffprobe"):
metadata, streams = ffprobe(filename)
return "mp4" in metadata["format_name"].split(",")
return False
[docs]class Flv(Video):
file_ext = "flv"
[docs] def sniff(self, filename: str) -> bool:
if which("ffprobe"):
metadata, streams = ffprobe(filename)
return "flv" in metadata["format_name"].split(",")
return False
[docs]class Mpg(Video):
file_ext = "mpg"
[docs] def sniff(self, filename: str) -> bool:
if which("ffprobe"):
metadata, streams = ffprobe(filename)
return "mpegvideo" in metadata["format_name"].split(",")
return False
[docs]class Mp3(Audio):
"""
Class that reads MP3 audio file.
>>> from galaxy.datatypes.sniff import sniff_with_cls
>>> sniff_with_cls(Mp3, 'audio_2.mp3')
True
>>> sniff_with_cls(Mp3, 'audio_1.wav')
False
"""
file_ext = "mp3"
[docs] def sniff(self, filename: str) -> bool:
if which("ffprobe"):
metadata, streams = ffprobe(filename)
return "mp3" in metadata["format_name"].split(",")
return False
[docs]class Wav(Audio):
"""Class that reads WAV audio file
>>> from galaxy.datatypes.sniff import sniff_with_cls
>>> sniff_with_cls(Wav, 'hello.wav')
True
>>> sniff_with_cls(Wav, 'audio_2.mp3')
False
>>> sniff_with_cls(Wav, 'drugbank_drugs.cml')
False
"""
file_ext = "wav"
blurb = "RIFF WAV Audio file"
is_binary = True
MetadataElement(name="rate", desc="Sample Rate", default=0, no_value=0, readonly=True, visible=True, optional=True)
MetadataElement(
name="nframes", desc="Number of Samples", default=0, no_value=0, readonly=True, visible=True, optional=True
)
MetadataElement(
name="nchannels", desc="Number of Channels", default=0, no_value=0, readonly=True, visible=True, optional=True
)
MetadataElement(
name="sampwidth", desc="Sample Width", default=0, no_value=0, readonly=True, visible=True, optional=True
)
[docs] def set_meta(self, dataset: DatasetProtocol, overwrite: bool = True, **kwd) -> None:
"""Set the metadata for this dataset from the file contents."""
try:
with wave.open(dataset.dataset.file_name, "rb") as fd:
dataset.metadata.rate = fd.getframerate()
dataset.metadata.nframes = fd.getnframes()
dataset.metadata.sampwidth = fd.getsampwidth()
dataset.metadata.nchannels = fd.getnchannels()
except wave.Error:
pass