Skip to content

bandcamp

BandCamp module for downloading and searching songs.

BandCamp(output_format='mp3', cookie_file=None, search_query=None, filter_results=True, yt_dlp_args=None) ¤

Bases: AudioProvider

SoundCloud audio provider class

Arguments¤
  • output_directory: The directory to save the downloaded songs to.
  • output_format: The format to save the downloaded songs in.
  • cookie_file: The path to a file containing cookies to be used by YTDL.
  • search_query: The query to use when searching for songs.
  • filter_results: Whether to filter results.
Source code in spotdl/providers/audio/base.py 
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 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
def __init__(
    self,
    output_format: str = "mp3",
    cookie_file: Optional[str] = None,
    search_query: Optional[str] = None,
    filter_results: bool = True,
    yt_dlp_args: Optional[str] = None,
) -> None:
    """
    Base class for audio providers.

    ### Arguments
    - output_directory: The directory to save the downloaded songs to.
    - output_format: The format to save the downloaded songs in.
    - cookie_file: The path to a file containing cookies to be used by YTDL.
    - search_query: The query to use when searching for songs.
    - filter_results: Whether to filter results.
    """

    self.output_format = output_format
    self.cookie_file = cookie_file
    self.search_query = search_query
    self.filter_results = filter_results

    if self.output_format == "m4a":
        ytdl_format = "bestaudio[ext=m4a]/bestaudio/best"
    elif self.output_format == "opus":
        ytdl_format = "bestaudio[ext=webm]/bestaudio/best"
    else:
        ytdl_format = "bestaudio"

    yt_dlp_options = {
        "format": ytdl_format,
        "quiet": True,
        "no_warnings": True,
        "encoding": "UTF-8",
        "logger": YTDLLogger(),
        "cookiefile": self.cookie_file,
        "outtmpl": str((get_temp_path() / "%(id)s.%(ext)s").resolve()),
        "retries": 5,
    }

    if yt_dlp_args:
        yt_dlp_options = args_to_ytdlp_options(
            shlex.split(yt_dlp_args), yt_dlp_options
        )

    self.audio_handler = YoutubeDL(yt_dlp_options)

get_results(search_term, *_args, **_kwargs) ¤

Get results from slider.kz

Arguments¤
  • search_term: The search term to search for.
  • args: Unused.
  • kwargs: Unused.
Returns¤
  • A list of slider.kz results if found, None otherwise.
Source code in spotdl/providers/audio/bandcamp.py 
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
def get_results(self, search_term: str, *_args, **_kwargs) -> List[Result]:
    """
    Get results from slider.kz

    ### Arguments
    - search_term: The search term to search for.
    - args: Unused.
    - kwargs: Unused.

    ### Returns
    - A list of slider.kz results if found, None otherwise.
    """

    try:
        results = search(search_term)
    except KeyError:
        return []
    except Exception as exc:
        logger.error("Failed to get results from BandCamp", exc_info=exc)
        return []

    simplified_results: List[Result] = []
    for result in results:
        track = BandCampTrack(int(result[0]), int(result[1]))

        simplified_results.append(
            Result(
                source="bandcamp",
                url=track.track_url,
                verified=False,
                name=track.track_title,
                duration=track.track_duration_seconds,
                author=track.artist_title,
                result_id=track.track_url,
                search_query=search_term,
                album=track.album_title,
                artists=tuple(track.artist_title.split(", ")),
            )
        )

    return simplified_results

BandCampTrack(artist_id, track_id) ¤

BandCamp track class based on the bandcamp_api library

Source code in spotdl/providers/audio/bandcamp.py 
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 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
def __init__(self, artist_id: int, track_id: int):
    # object info
    self.type = "track"

    # track information
    self.track_id: int = 0
    self.track_title: str = ""
    self.track_number: int = 0
    self.track_duration_seconds: float = 0.00
    self.track_streamable: Optional[bool] = None
    self.has_lyrics: Optional[bool] = None
    self.lyrics: str = ""
    self.is_price_set: Optional[bool] = None
    self.price: dict = {}
    self.require_email: Optional[bool] = None
    self.is_purchasable: Optional[bool] = None
    self.is_free: Optional[bool] = None
    self.is_preorder: Optional[bool] = None
    self.tags: list = []
    self.track_url: str = ""

    # art
    self.art_id: int = 0
    self.art_url: str = ""

    # artist information
    self.artist_id: int = 0
    self.artist_title: str = ""

    # album information
    self.album_id: int = 0
    self.album_title: str = ""

    # label
    self.label_id: int = 0
    self.label_title: str = ""

    # about
    self.about: str = ""
    self.credits: str = ""
    self.date_released_unix: int = 0

    # advanced
    self.date_last_modified_unix: int = 0
    self.date_published_unix: int = 0
    self.supporters: list = []

    response = requests.get(
        url="https://bandcamp.com/api/mobile/25/tralbum_details?band_id="
        + str(artist_id)
        + "&tralbum_id="
        + str(track_id)
        + "&tralbum_type=t",
        timeout=10,
        proxies=GlobalConfig.get_parameter("proxies"),
    )
    result = response.json()
    self.track_id = result["id"]
    self.track_title = result["title"]
    self.track_number = result["tracks"][0]["track_num"]
    self.track_duration_seconds = result["tracks"][0]["duration"]
    self.track_streamable = result["tracks"][0]["is_streamable"]
    self.has_lyrics = result["tracks"][0]["has_lyrics"]

    # getting lyrics, if there is any
    if self.has_lyrics is True:
        resp = requests.get(
            "https://bandcamp.com/api/mobile/25/tralbum_lyrics?tralbum_id="
            + str(self.track_id)
            + "&tralbum_type=t",
            timeout=10,
            proxies=GlobalConfig.get_parameter("proxies"),
        )
        rjson = resp.json()
        self.lyrics = rjson["lyrics"][str(self.track_id)]

    self.is_price_set = result["is_set_price"]
    self.price = {"currency": result["currency"], "amount": result["price"]}
    self.require_email = result["require_email"]
    self.is_purchasable = result["is_purchasable"]
    self.is_free = result["free_download"]
    self.is_preorder = result["is_preorder"]

    for tag in result["tags"]:
        self.tags.append(tag["name"])

    self.art_id = result["art_id"]
    self.art_url = "https://f4.bcbits.com/img/a" + str(self.art_id) + "_0.jpg"

    self.artist_id = result["band"]["band_id"]
    self.artist_title = result["band"]["name"]

    self.album_id = result["album_id"]
    self.album_title = result["album_title"]

    self.label_id = result["label_id"]
    self.label_title = result["label"]

    self.about = result["about"]
    self.credits = result["credits"]

    self.date_released_unix = result["release_date"]

    self.track_url = result["bandcamp_url"]

search(search_string='') ¤

I got this api url from the iOS app needs a way of removing characters that will screw up an url keep url safe characters

Arguments¤
  • search_string: The search term to search for.
Returns¤
  • A list of artist and track ids if found
Source code in spotdl/providers/audio/bandcamp.py 
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
156
157
158
159
160
def search(search_string: str = ""):
    """
    I got this api url from the iOS app
    needs a way of removing characters
    that will screw up an url
    keep url safe characters

    ### Arguments
    - search_string: The search term to search for.

    ### Returns
    - A list of artist and track ids if found
    """

    response = requests.get(
        "https://bandcamp.com/api/fuzzysearch/2/app_autocomplete?q="
        + search_string
        + "&param_with_locations=true",
        timeout=10,
        proxies=GlobalConfig.get_parameter("proxies"),
    )

    results = response.json()["results"]

    return_results: List[Tuple[str, str]] = []

    for item in results:
        if item["type"] == "t":
            return_results.append((item["band_id"], item["id"]))

    return return_results