Reference for youtube_dl_scraper/converter/video_converter.py

youtube_dl_scraper.converter.video_converter.VideoConverter

VideoConverter(input_path: str, output_path: str, video_codec: str, audio_codec: Optional[str], force_render: bool = False, experimental: bool = True)

Bases: BaseConverter

VideoConverter class provides functionality to convert video files into different formats by re-encoding or copying the existing streams with specified video and audio codecs.

Attributes:

Name	Type	Description
input_path	str	Path to the input video file.
output_path	str	Path to the output video file.
video_codec	str	Desired video codec (e.g., "h264", "hevc").
audio_codec	Optional[str]	Desired audio codec (e.g., "aac", "mp3").
force_render	bool	If True, forces re-rendering even if codecs match.
experimental	bool	If True, allow for experimental codec supported by ffmpeg else don't.

Parameters:

Name	Type	Description	Default
input_path	str	Path to the input video file.	required
output_path	str	Path to the output video file.	required
video_codec	str	Desired video codec (e.g., "h264", "hevc").	required
audio_codec	Optional[str]	Desired audio codec (e.g., "aac", "mp3").	required
force_render	bool	If True, force re-rendering even if codecs match.	False
experimental	bool	If True, allow for experimental codec supported by ffmpeg else don't.	True

Source code in youtube_dl_scraper/converter/video_converter.py

def __init__(
    self,
    input_path: str,
    output_path: str,
    video_codec: str,
    audio_codec: Optional[str],
    force_render: bool = False,
    experimental: bool = True,
):
    """
    Initialize the converter.

    Args:
        input_path (str): Path to the input video file.
        output_path (str): Path to the output video file.
        video_codec (str): Desired video codec (e.g., "h264", "hevc").
        audio_codec (Optional[str]): Desired audio codec (e.g., "aac", "mp3").
        force_render (bool): If True, force re-rendering even if codecs match.
        experimental (bool): If True, allow for experimental codec supported by ffmpeg else don't.
    """
    self.input_path = input_path
    self.output_path = output_path
    self.video_codec = video_codec
    self.audio_codec = audio_codec
    self.force_render = force_render
    self.experimental = experimental

convert

convert() -> str

Perform the conversion.

Skips re-rendering if the codecs already match, unless force_render is True.

Returns:

Name	Type	Description
str	str	Path to the converted video if successful.

Source code in youtube_dl_scraper/converter/video_converter.py

def convert(self) -> str:
    """
    Perform the conversion.

    Skips re-rendering if the codecs already match, unless force_render is True.

    Returns:
        str: Path to the converted video if successful.
    """
    if not os.path.exists(self.input_path):
        raise FileNotFoundError(f"Input file '{self.input_path}' not found.")

    # Handle output path being "."
    if self.output_path == ".":
        base, ext = os.path.splitext(self.input_path)
        self.output_path = f"{base}-converted{ext}"

    if os.path.exists(self.output_path):
        output_codecs = self.get_codecs(self.output_path)
        output_video_codec = output_codecs["video"]
        output_audio_codec = output_codecs["audio"]

        if output_video_codec == self.video_codec and (
            output_audio_codec == self.audio_codec or "aac"
        ):
            print("Output file exists and matches specified codecs.")
            return self.output_path
        else:
            print("Output file exists, overwriting output file...")
            os.remove(self.output_path)

    codecs = self.get_codecs(self.input_path)
    input_video_codec = codecs["video"]
    input_audio_codec = codecs["audio"]

    print(f"Input Video Codec: {input_video_codec}")
    print(f"Input Audio Codec: {input_audio_codec}")
    print(f"Output Video Codec: {self.video_codec}")
    print(f"Output Audio Codec: {self.audio_codec or 'copy'}")

    # Check if re-rendering is needed
    if (
        not self.force_render
        and input_video_codec == self.video_codec
        and input_audio_codec == self.audio_codec
    ):
        print("Codecs match! Copying streams without re-rendering...")
        # Copy streams directly
        (
            ffmpeg.input(self.input_path)
            .output(
                self.output_path,
                codec="copy",
                strict=(self.experimental and "experimental") or None,
            )
            .run()
        )
    else:
        print("Re-rendering with specified codecs...")
        # Re-encode with specified codecs
        (
            ffmpeg.input(self.input_path)
            .output(
                self.output_path,
                vcodec=self.video_codec or "copy",
                acodec=self.audio_codec or "copy",
                strict=(self.experimental and "experimental") or None,
            )
            .run()
        )

    if os.path.exists(self.output_path):
        print(f"Video conversion complete! File saved at: {self.output_path}")
        return self.output_path
    else:
        raise FileNotFoundError("Output file was not created.")

get_codecs staticmethod

get_codecs(file_path: str) -> Dict[str, Optional[str]]

Retrieve the codecs of a file using ffmpeg-python.

Parameters:

Name	Type	Description	Default
file_path	str	Path to the video file.	required

Returns:

Name	Type	Description
dict	Dict[str, Optional[str]]	A dictionary with 'video' and 'audio' keys containing their respective codecs.

Source code in youtube_dl_scraper/converter/video_converter.py

@staticmethod
def get_codecs(file_path: str) -> Dict[str, Optional[str]]:
    """
    Retrieve the codecs of a file using ffmpeg-python.

    Args:
        file_path (str): Path to the video file.

    Returns:
        dict: A dictionary with 'video' and 'audio' keys containing their respective codecs.
    """
    probe = ffmpeg.probe(file_path)
    video_stream = next(
        (stream for stream in probe["streams"] if stream["codec_type"] == "video"),
        None,
    )
    audio_stream = next(
        (stream for stream in probe["streams"] if stream["codec_type"] == "audio"),
        None,
    )

    return {
        "video": video_stream["codec_name"] if video_stream else None,
        "audio": audio_stream["codec_name"] if audio_stream else None,
    }