import Parser, { ParsedResponse } from '../index'; import Constants from '../../utils/Constants'; import Actions, { AxioslikeResponse } from '../../core/Actions'; import Player from '../../core/Player'; import TwoColumnWatchNextResults from '../classes/TwoColumnWatchNextResults'; import VideoPrimaryInfo from '../classes/VideoPrimaryInfo'; import VideoSecondaryInfo from '../classes/VideoSecondaryInfo'; import PlayerMicroformat from '../classes/PlayerMicroformat'; import Format from '../classes/misc/Format'; import MerchandiseShelf from '../classes/MerchandiseShelf'; import RelatedChipCloud from '../classes/RelatedChipCloud'; import ChipCloud from '../classes/ChipCloud'; import ItemSection from '../classes/ItemSection'; import PlayerOverlay from '../classes/PlayerOverlay'; import ToggleButton from '../classes/ToggleButton'; import CommentsEntryPointHeader from '../classes/comments/CommentsEntryPointHeader'; import ContinuationItem from '../classes/ContinuationItem'; import LiveChat from '../classes/LiveChat'; import LiveChatWrap from './LiveChat'; import { create } from 'xmlbuilder2'; import { XMLBuilder } from 'xmlbuilder2/lib/interfaces'; import { getStringBetweenStrings, InnertubeError, streamToIterable } from '../../utils/Utils'; export type URLTransformer = (url: URL) => URL; export interface FormatOptions { /** * Video quality; 360p, 720p, 1080p, etc... also accepts 'best' and 'bestefficiency'. */ quality?: string; /** * Download type, can be: video, audio or video+audio */ type?: 'video' | 'audio' | 'video+audio'; /** * File format, use 'any' to download any format */ format?: string; } export interface DownloadOptions extends FormatOptions { /** * Download range, indicates which bytes should be downloaded. */ range?: { start: number; end: number; } } class VideoInfo { #page: [ParsedResponse, ParsedResponse?]; #actions; #player; #cpn; #watch_next_continuation; basic_info; streaming_data; playability_status; annotations; storyboards; endscreen; captions; cards; primary_info; secondary_info; merchandise; related_chip_cloud; watch_next_feed; player_overlays; comments_entry_point_header; livechat; /** * @param data - API response. * @param cpn - Client Playback Nonce */ constructor(data: [AxioslikeResponse, AxioslikeResponse?], actions: Actions, player: Player, cpn: string) { this.#actions = actions; this.#player = player; this.#cpn = cpn; const info = Parser.parseResponse(data[0].data); const next = data?.[1]?.data ? Parser.parseResponse(data[1].data) : undefined; this.#page = [ info, next ]; if (info.playability_status?.status === 'ERROR') throw new InnertubeError('This video is unavailable', info.playability_status); if (!info.microformat?.is(PlayerMicroformat)) throw new InnertubeError('Invalid microformat', info.microformat); this.basic_info = { // This type is inferred so no need for an explicit type ...info.video_details, ...{ /** * Microformat is a bit redundant, so only * a few things there are interesting to us. */ embed: info.microformat?.embed, channel: info.microformat?.channel, is_unlisted: info.microformat?.is_unlisted, is_family_safe: info.microformat?.is_family_safe, has_ypc_metadata: info.microformat?.has_ypc_metadata }, like_count: undefined as number | undefined, is_liked: undefined as boolean | undefined, is_disliked: undefined as boolean | undefined }; this.streaming_data = info.streaming_data; this.playability_status = info.playability_status; this.annotations = info.annotations; this.storyboards = info.storyboards; this.endscreen = info.endscreen; this.captions = info.captions; this.cards = info.cards; const two_col = next?.contents.item().as(TwoColumnWatchNextResults); const results = two_col?.results; const secondary_results = two_col?.secondary_results; if (results && secondary_results) { this.primary_info = results.get({ type: 'VideoPrimaryInfo' })?.as(VideoPrimaryInfo); this.secondary_info = results.get({ type: 'VideoSecondaryInfo' })?.as(VideoSecondaryInfo); this.merchandise = results.get({ type: 'MerchandiseShelf' })?.as(MerchandiseShelf); this.related_chip_cloud = secondary_results?.get({ type: 'RelatedChipCloud' })?.as(RelatedChipCloud)?.content.item().as(ChipCloud); this.watch_next_feed = secondary_results?.get({ type: 'ItemSection' })?.as(ItemSection)?.contents; if (this.watch_next_feed && Array.isArray(this.watch_next_feed)) this.#watch_next_continuation = this.watch_next_feed?.pop()?.as(ContinuationItem); this.player_overlays = next?.player_overlays.item().as(PlayerOverlay); this.basic_info.like_count = this.primary_info?.menu?.top_level_buttons?.get({ icon_type: 'LIKE' })?.as(ToggleButton)?.like_count; this.basic_info.is_liked = this.primary_info?.menu?.top_level_buttons?.get({ icon_type: 'LIKE' })?.as(ToggleButton)?.is_toggled; this.basic_info.is_disliked = this.primary_info?.menu?.top_level_buttons?.get({ icon_type: 'DISLIKE' })?.as(ToggleButton)?.is_toggled; const comments_entry_point = results.get({ target_id: 'comments-entry-point' })?.as(ItemSection); this.comments_entry_point_header = comments_entry_point?.contents?.get({ type: 'CommentsEntryPointHeader' })?.as(CommentsEntryPointHeader); this.livechat = next?.contents_memo.getType(LiveChat)?.[0]; } } /** * Applies given filter to the watch next feed. */ async selectFilter(name: string) { if (!this.filters.includes(name)) throw new InnertubeError('Invalid filter', { available_filters: this.filters }); const filter = this.related_chip_cloud?.chips?.get({ text: name }); if (filter?.is_selected) return this; const response = await filter?.endpoint?.call(this.#actions, undefined, true); const data = response?.on_response_received_endpoints?.get({ target_id: 'watch-next-feed' }); this.watch_next_feed = data?.contents; return this; } /** * Retrieves watch next feed continuation. */ async getWatchNextContinuation() { const response = await this.#watch_next_continuation?.endpoint.call(this.#actions, undefined, true); const data = response?.on_response_received_endpoints?.get({ type: 'appendContinuationItemsAction' }); if (!data) throw new InnertubeError('Continuation not found'); this.watch_next_feed = data?.contents; this.#watch_next_continuation = this.watch_next_feed?.pop()?.as(ContinuationItem); return this; } /** * Likes the video. */ async like() { const button = this.primary_info?.menu?.top_level_buttons?.get({ button_id: 'TOGGLE_BUTTON_ID_TYPE_LIKE' })?.as(ToggleButton); if (!button) throw new InnertubeError('Like button not found', { video_id: this.basic_info.id }); if (button.is_toggled) throw new InnertubeError('This video is already liked', { video_id: this.basic_info.id }); const response = await button.endpoint.call(this.#actions); return response; } /** * Dislikes the video. */ async dislike() { const button = this.primary_info?.menu?.top_level_buttons?.get({ button_id: 'TOGGLE_BUTTON_ID_TYPE_DISLIKE' })?.as(ToggleButton); if (!button) throw new InnertubeError('Dislike button not found', { video_id: this.basic_info.id }); if (button.is_toggled) throw new InnertubeError('This video is already disliked', { video_id: this.basic_info.id }); const response = await button.endpoint.call(this.#actions); return response; } /** * Removes like/dislike. */ async removeLike() { const button = this.primary_info?.menu?.top_level_buttons?.get({ is_toggled: true })?.as(ToggleButton); if (!button) throw new InnertubeError('This video is not liked/disliked', { video_id: this.basic_info.id }); const response = await button.toggled_endpoint.call(this.#actions); return response; } /** * Retrieves Live Chat if available. */ getLiveChat() { if (!this.livechat) throw new InnertubeError('Live Chat is not available', { video_id: this.basic_info.id }); return new LiveChatWrap(this); } get filters() { return this.related_chip_cloud?.chips?.map((chip) => chip.text.toString()) || []; } get actions() { return this.#actions; } get page() { return this.#page; } /** * Get songs used in the video. */ // TODO: this seems to be broken with the new UI, further investigation needed get music_tracks() { /* Const metadata = this.secondary_info?.metadata; if (!metadata) return []; const songs = []; let current_song: Record = {}; let is_music_section = false; for (let i = 0; i < metadata.rows.length; i++) { const row = metadata.rows[i]; if (row.is(MetadataRowHeader)) { if (row.content.toString().toLowerCase().startsWith('music')) { is_music_section = true; i++; // Skip the learn more link } continue; } if (!is_music_section) continue; if (row.is(MetadataRow)) current_song[row.title.toString().toLowerCase().replace(/ /g, '_')] = row.contents; // TODO: this makes no sense, we continue above when if (row.has_divider_line) { songs.push(current_song); current_song = {}; } } if (is_music_section) songs.push(current_song); return songs; */ return []; } chooseFormat(options: FormatOptions) { if (!this.streaming_data) throw new InnertubeError('Streaming data not available', { video_id: this.basic_info.id }); const formats = [ ...(this.streaming_data.formats || []), ...(this.streaming_data.adaptive_formats || []) ]; const requires_audio = options.type ? options.type.includes('audio') : true; const requires_video = options.type ? options.type.includes('video') : true; const quality = options.quality || '360p'; let best_width = -1; const is_best = [ 'best', 'bestefficiency' ].includes(quality); const use_most_efficient = quality !== 'best'; let candidates = formats.filter((format) => { if (requires_audio && !format.has_audio) return false; if (requires_video && !format.has_video) return false; if (options.format !== 'any' && !format.mime_type.includes(options.format || 'mp4')) return false; if (!is_best && format.quality_label !== quality) return false; if (best_width < format.width) best_width = format.width; return true; }); if (!candidates.length) { throw new InnertubeError('No matching formats found', { options }); } if (is_best && requires_video) candidates = candidates.filter((format) => format.width === best_width); if (requires_audio && !requires_video) { const audio_only = candidates.filter((format) => !format.has_video); if (audio_only.length > 0) { candidates = audio_only; } } if (use_most_efficient) { // Sort by bitrate (lower is better) candidates.sort((a, b) => a.bitrate - b.bitrate); } else { // Sort by bitrate (higher is better) candidates.sort((a, b) => b.bitrate - a.bitrate); } return candidates[0]; } toDash(url_transformer: URLTransformer = (url) => url) { if (!this.streaming_data) throw new InnertubeError('Streaming data not available', { video_id: this.basic_info.id }); const { adaptive_formats } = this.streaming_data; const length = adaptive_formats[0].approx_duration_ms / 1000; const root = create({ version: '1.0', encoding: 'UTF-8' }); const period = root .ele('MPD', { xmlns: 'urn:mpeg:dash:schema:mpd:2011', minBufferTime: 'PT1.500S', profiles: 'urn:mpeg:dash:profile:isoff-main:2011', type: 'static', mediaPresentationDuration: `PT${length}S` }) .att('xmlns', 'xsi', 'http://www.w3.org/2001/XMLSchema-instance') .att('xsi', 'schemaLocation', 'urn:mpeg:dash:schema:mpd:2011 http://standards.iso.org/ittf/PubliclyAvailableStandards/MPEG-DASH_schema_files/DASH-MPD.xsd') .ele('Period'); this.#generateAdaptationSet(period, adaptive_formats, url_transformer); return root.end({ prettyPrint: true }); } #generateAdaptationSet(period: XMLBuilder, formats: Format[], url_transformer: URLTransformer) { const mimeTypes: string[] = []; const mimeObjects: Format[][] = [ [] ]; formats.forEach((videoFormat) => { if (!videoFormat.index_range || !videoFormat.init_range) { return; } const mimeType = videoFormat.mime_type; const mimeTypeIndex = mimeTypes.indexOf(mimeType); if (mimeTypeIndex > -1) { mimeObjects[mimeTypeIndex].push(videoFormat); } else { mimeTypes.push(mimeType); mimeObjects.push([]); mimeObjects[mimeTypes.length - 1].push(videoFormat); } }); for (let i = 0; i < mimeTypes.length; i++) { const set = period .ele('AdaptationSet', { id: i, mimeType: mimeTypes[i].split(';')[0], startWithSAP: '1', subsegmentAlignment: 'true', scanType: !mimeTypes[i].includes('audio') ? 'progressive' : undefined }); mimeObjects[i].forEach((format) => { if (format.has_video) { this.#generateRepresentationVideo(set, format, url_transformer); } else { this.#generateRepresentationAudio(set, format, url_transformer); } }); } } #generateRepresentationVideo(set: XMLBuilder, format: Format, url_transformer: URLTransformer) { const codecs = getStringBetweenStrings(format.mime_type, 'codecs="', '"'); if (!format.index_range || !format.init_range) throw new InnertubeError('Index and init ranges not available', { format }); const url = new URL(format.decipher(this.#player)); url.searchParams.set('cpn', this.#cpn); set .ele('Representation', { id: format.itag, codecs, bandwidth: format.bitrate, width: format.width, height: format.height, maxPlayoutRate: '1', frameRate: format.fps }) .ele('BaseURL') .txt(url_transformer(url).toString()) .up() .ele('SegmentBase', { indexRange: `${format.index_range.start}-${format.index_range.end}` }) .ele('Initialization', { range: `${format.init_range.start}-${format.init_range.end}` }); } #generateRepresentationAudio(set: XMLBuilder, format: Format, url_transformer: URLTransformer) { const codecs = getStringBetweenStrings(format.mime_type, 'codecs="', '"'); if (!format.index_range || !format.init_range) throw new InnertubeError('Index and init ranges not available', { format }); const url = new URL(format.decipher(this.#player)); url.searchParams.set('cpn', this.#cpn); set .ele('Representation', { id: format.itag, codecs, bandwidth: format.bitrate }) .ele('AudioChannelConfiguration', { schemeIdUri: 'urn:mpeg:dash:23003:3:audio_channel_configuration:2011', value: format.audio_channels || '2' }) .up() .ele('BaseURL') .txt(url_transformer(url).toString()) .up() .ele('SegmentBase', { indexRange: `${format.index_range.start}-${format.index_range.end}` }) .ele('Initialization', { range: `${format.init_range.start}-${format.init_range.end}` }); } /** * @param options - download options. */ async download(options: DownloadOptions = {}) { if (this.playability_status?.status === 'UNPLAYABLE') throw new InnertubeError('Video is unplayable', { video: this, error_type: 'UNPLAYABLE' }); if (this.playability_status?.status === 'LOGIN_REQUIRED') throw new InnertubeError('Video is login required', { video: this, error_type: 'LOGIN_REQUIRED' }); if (!this.streaming_data) throw new InnertubeError('Streaming data not available.', { video: this, error_type: 'NO_STREAMING_DATA' }); const opts: DownloadOptions = { quality: '360p', type: 'video+audio', format: 'mp4', range: undefined, ...options }; const format = this.chooseFormat(opts); const format_url = format.decipher(this.#player); // If we're not downloading the video in chunks, we just use fetch once. if (opts.type === 'video+audio' && !options.range) { const response = await this.#actions.session.http.fetch_function(`${format_url}&cpn=${this.#cpn}`, { method: 'GET', headers: Constants.STREAM_HEADERS, redirect: 'follow' }); // Throw if the response is not 2xx if (!response.ok) throw new InnertubeError('The server responded with a non 2xx status code', { video: this, error_type: 'FETCH_FAILED', response }); const body = response.body; if (!body) throw new InnertubeError('Could not get ReadableStream from fetch Response.', { video: this, error_type: 'FETCH_FAILED', response }); return body; } // We need to download in chunks. const chunk_size = 1048576 * 10; // 10MB let chunk_start = (options.range ? options.range.start : 0); let chunk_end = (options.range ? options.range.end : chunk_size); let must_end = false; let cancel: AbortController; const readable_stream = new ReadableStream({ // eslint-disable-next-line @typescript-eslint/no-empty-function start() {}, pull: async (controller) => { if (must_end) { controller.close(); return; } if ((chunk_end >= format.content_length) || options.range) { must_end = true; } return new Promise(async (resolve, reject) => { try { cancel = new AbortController(); const response = await this.#actions.session.http.fetch_function(`${format_url}&cpn=${this.#cpn}&range=${chunk_start}-${chunk_end || ''}`, { method: 'GET', headers: { ...Constants.STREAM_HEADERS // XXX: use YouTube's range parameter instead of a Range header. // Range: `bytes=${chunk_start}-${chunk_end}` }, signal: cancel.signal }); const body = response.body; if (!body) throw new InnertubeError('Could not get ReadableStream from fetch Response.', { video: this, error_type: 'FETCH_FAILED', response }); for await (const chunk of streamToIterable(body)) { controller.enqueue(chunk); } chunk_start = chunk_end + 1; chunk_end += chunk_size; resolve(); return; } catch (e: any) { reject(e); } }); }, async cancel(reason) { cancel.abort(reason); } }, { highWaterMark: 1, // TODO: better value? size(chunk) { return chunk.byteLength; } }); return readable_stream; } } export default VideoInfo;