QOL: Move source code under the src directory. (#1318)

src/providers/song-info.ts

@@ -0,0 +1,148 @@
+import { BrowserWindow, ipcMain, nativeImage, net } from 'electron';
+
+import { cache } from './decorators';
+
+import config from '../config';
+
+import type { GetPlayerResponse } from '../types/get-player-response';
+
+export interface SongInfo {
+  title: string;
+  artist: string;
+  views: number;
+  uploadDate?: string;
+  imageSrc?: string | null;
+  image?: Electron.NativeImage | null;
+  isPaused?: boolean;
+  songDuration: number;
+  elapsedSeconds?: number;
+  url?: string;
+  album?: string | null;
+  videoId: string;
+  playlistId?: string;
+}
+
+// Fill songInfo with empty values
+export const songInfo: SongInfo = {
+  title: '',
+  artist: '',
+  views: 0,
+  uploadDate: '',
+  imageSrc: '',
+  image: null,
+  isPaused: undefined,
+  songDuration: 0,
+  elapsedSeconds: 0,
+  url: '',
+  album: undefined,
+  videoId: '',
+  playlistId: '',
+};
+
+// Grab the native image using the src
+export const getImage = cache(
+  async (src: string): Promise<Electron.NativeImage> => {
+
+    const result = await net.fetch(src);
+    const buffer = await result.arrayBuffer();
+    const output = nativeImage.createFromBuffer(Buffer.from(buffer));
+    if (output.isEmpty() && !src.endsWith('.jpg') && src.includes('.jpg')) { // Fix hidden webp files (https://github.com/th-ch/youtube-music/issues/315)
+      return getImage(src.slice(0, src.lastIndexOf('.jpg') + 4));
+    }
+
+    return output;
+  },
+);
+
+const handleData = async (data: GetPlayerResponse, win: Electron.BrowserWindow) => {
+  if (!data) {
+    return;
+  }
+
+  const microformat = data.microformat?.microformatDataRenderer;
+  if (microformat) {
+    songInfo.uploadDate = microformat.uploadDate;
+    songInfo.url = microformat.urlCanonical?.split('&')[0];
+    songInfo.playlistId = new URL(microformat.urlCanonical).searchParams.get('list') ?? '';
+    // Used for options.resumeOnStart
+    config.set('url', microformat.urlCanonical);
+  }
+
+  const { videoDetails } = data;
+  if (videoDetails) {
+    songInfo.title = cleanupName(videoDetails.title);
+    songInfo.artist = cleanupName(videoDetails.author);
+    songInfo.views = Number(videoDetails.viewCount);
+    songInfo.songDuration = Number(videoDetails.lengthSeconds);
+    songInfo.elapsedSeconds = videoDetails.elapsedSeconds;
+    songInfo.isPaused = videoDetails.isPaused;
+    songInfo.videoId = videoDetails.videoId;
+    songInfo.album = data?.videoDetails?.album; // Will be undefined if video exist
+
+    const thumbnails = videoDetails.thumbnail?.thumbnails;
+    songInfo.imageSrc = thumbnails.at(-1)?.url.split('?')[0];
+    if (songInfo.imageSrc) songInfo.image = await getImage(songInfo.imageSrc);
+
+    win.webContents.send('update-song-info', songInfo);
+  }
+};
+
+// This variable will be filled with the callbacks once they register
+export type SongInfoCallback = (songInfo: SongInfo, event?: string) => void;
+const callbacks: SongInfoCallback[] = [];
+
+// This function will allow plugins to register callback that will be triggered when data changes
+const registerCallback = (callback: SongInfoCallback) => {
+  callbacks.push(callback);
+};
+
+let handlingData = false;
+
+const registerProvider = (win: BrowserWindow) => {
+  // This will be called when the song-info-front finds a new request with song data
+  ipcMain.on('video-src-changed', async (_, data: GetPlayerResponse) => {
+    handlingData = true;
+    await handleData(data, win);
+    handlingData = false;
+    for (const c of callbacks) {
+      c(songInfo, 'video-src-changed');
+    }
+  });
+  ipcMain.on('playPaused', (_, { isPaused, elapsedSeconds }: { isPaused: boolean, elapsedSeconds: number }) => {
+    songInfo.isPaused = isPaused;
+    songInfo.elapsedSeconds = elapsedSeconds;
+    if (handlingData) {
+      return;
+    }
+
+    for (const c of callbacks) {
+      c(songInfo, 'playPaused');
+    }
+  });
+};
+
+const suffixesToRemove = [
+  ' - topic',
+  'vevo',
+  ' (performance video)',
+  ' (clip officiel)',
+];
+
+export function cleanupName(name: string): string {
+  if (!name) {
+    return name;
+  }
+
+  name = name.replace(/\((?:official)? ?(?:music)? ?(?:lyrics?)? ?(?:video)?\)$/i, '');
+  const lowCaseName = name.toLowerCase();
+  for (const suffix of suffixesToRemove) {
+    if (lowCaseName.endsWith(suffix)) {
+      return name.slice(0, -suffix.length);
+    }
+  }
+
+  return name;
+}
+
+export default registerCallback;
+export const setupSongInfo = registerProvider;