Skip to content

Reference for youtube_dl_scraper/converter/audio_converter.py

youtube_dl_scraper.converter.audio_converter.AudioConverter 

AudioConverter(input_path: str, output_path: str, audio_codec: Optional[str], bitrate: Optional[str] = None, force_render: bool = False, experimental: bool = True)

Bases: BaseConverter

AudioConverter class provides functionality to convert audio files into different formats by re-encoding or copying the existing audio stream with the specified audio codec.

Attributes:

Name Type Description
input_path str

Path to the input audio or video file.
output_path str

Path to the output audio file.
audio_codec str

Desired audio codec (e.g., "aac", "mp3").
bitrate Optional[str]

Desired audio bitrate (e.g., "128k", "192k").
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 file (audio or video).

 required
output_path str

Path to the output audio file.

 required
audio_codec Optional[str]

Desired audio codec (e.g., "aac", "mp3").

 required
bitrate Optional[str]

Desired audio bitrate (e.g., "128k", "192k").

 None
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/audio_converter.py 
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
def __init__(
    self,
    input_path: str,
    output_path: str,
    audio_codec: Optional[str],
    bitrate: Optional[str] = None,
    force_render: bool = False,
    experimental: bool = True,
):
    """
    Initialize the converter.

    Args:
        input_path (str): Path to the input file (audio or video).
        output_path (str): Path to the output audio file.
        audio_codec (Optional[str]): Desired audio codec (e.g., "aac", "mp3").
        bitrate (Optional[str]): Desired audio bitrate (e.g., "128k", "192k").
        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.audio_codec = audio_codec
    self.bitrate = bitrate
    self.force_render = force_render
    self.experimental = experimental
convert 
convert() -> str

Perform the conversion.

Converts input audio or video file into the desired audio format, with an optional bitrate.

Returns:

Name Type Description
str str

Path to the converted audio file if successful.

Raises:

Type Description
FileNotFoundError

If the input file does not exist or the output file was not created.
Source code in youtube_dl_scraper/converter/audio_converter.py 
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
def convert(self) -> str:
    """
    Perform the conversion.

    Converts input audio or video file into the desired audio format, with an optional bitrate.

    Returns:
        str: Path to the converted audio file if successful.

    Raises:
        FileNotFoundError: If the input file does not exist or the output file was not created.
    """
    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, _ = os.path.splitext(self.input_path)
        self.output_path = f"{base}-audio-converted{'-' + self.bitrate if self.bitrate else ''}.{self.get_default_extension()}"

    if os.path.exists(self.output_path):
        output_codec = self.get_audio_codec(self.output_path)
        print(f"Output Audio Codec: {output_codec}")

        if output_codec == self.audio_codec:
            print("Output file exists and matches the specified codec.")
            return self.output_path
        else:
            print(
                "Output file exists but does not match the specified codec. Overwriting..."
            )
            os.remove(self.output_path)

    input_codec = self.get_audio_codec(self.input_path)
    print(f"Input Audio Codec: {input_codec}")

    # Extract or convert the audio stream
    if not self.force_render and input_codec == self.audio_codec:
        print("Codec matches! Copying audio stream without re-rendering...")
        (
            ffmpeg.input(self.input_path)
            .output(
                self.output_path,
                codec="copy",
                vn=None,
                strict=(self.experimental and "experimental") or None,
            )
            .run()
        )
    else:
        print(
            "Extracting and/or re-rendering audio with the specified codec and bitrate..."
        )
        ffmpeg_output_options = {"acodec": self.audio_codec or "copy", "vn": None}
        if self.bitrate:
            ffmpeg_output_options["audio_bitrate"] = self.bitrate

        (
            ffmpeg.input(self.input_path)
            .output(
                self.output_path,
                **ffmpeg_output_options,
                strict=(self.experimental and "experimental") or None,
            )
            .run()
        )

    if os.path.exists(self.output_path):
        print(f"Audio conversion complete! File saved at: {self.output_path}")
        return self.output_path
    else:
        raise FileNotFoundError("Output file was not created.")
get_audio_codec staticmethod 
get_audio_codec(file_path: str) -> Optional[str]

Retrieve the audio codec of a file using ffmpeg-python.

Parameters:

Name Type Description Default
file_path str

Path to the file (audio or video).

 required

Returns:

Type Description
Optional[str]

Optional[str]: The audio codec of the file, or None if no audio stream is found.
Source code in youtube_dl_scraper/converter/audio_converter.py 
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
@staticmethod
def get_audio_codec(file_path: str) -> Optional[str]:
    """
    Retrieve the audio codec of a file using ffmpeg-python.

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

    Returns:
        Optional[str]: The audio codec of the file, or None if no audio stream is found.
    """
    probe = ffmpeg.probe(file_path)
    audio_stream = next(
        (stream for stream in probe["streams"] if stream["codec_type"] == "audio"),
        None,
    )
    return audio_stream["codec_name"] if audio_stream else None
get_default_extension 
get_default_extension() -> str

Determine the appropriate file extension based on the audio codec.

Returns:

Name Type Description
str str

A suitable file extension (e.g., ".mp3", ".m4a").
Source code in youtube_dl_scraper/converter/audio_converter.py 
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
def get_default_extension(self) -> str:
    """
    Determine the appropriate file extension based on the audio codec.

    Returns:
        str: A suitable file extension (e.g., ".mp3", ".m4a").
    """
    codec_to_extension = {
        "aac": "m4a",  # AAC is typically stored in M4A
        "mp3": "mp3",
        "flac": "flac",
        "opus": "opus",
        "wav": "wav",
    }
    return codec_to_extension.get(
        self.audio_codec, "m4a"
    )  # Default to m4a for unsupported codecs