UpdatedStreamOverlay.tsx 7.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193
  1. import { useEffect, useLayoutEffect, useRef, useState, type CSSProperties, type ReactNode, type Ref, type SyntheticEvent } from 'react';
  2. import { useTranslation } from 'react-i18next';
  3. import { Clock, Layers, Printer, Timer } from 'lucide-react';
  4. import './UpdatedStreamOverlay.css';
  5. import { overlayProgressTextStyle } from '../utils/overlayBranding';
  6. import { useSidewaysBox } from '../hooks/useSidewaysBox';
  7. import type { OverlayLayout } from '../utils/overlayLayout';
  8. interface UpdatedStreamOverlayProps {
  9. layout?: OverlayLayout;
  10. backgroundTransparency?: number;
  11. customLogo?: ReactNode;
  12. progressBackground?: string;
  13. size: 'small' | 'medium' | 'large';
  14. // url is undefined while the stream is closed for a renewal (useOverlayCameraRecovery).
  15. camera: {
  16. url: string | undefined;
  17. rotation: number;
  18. onError: (event: SyntheticEvent<HTMLImageElement>) => void;
  19. imgRef?: Ref<HTMLImageElement>;
  20. } | null;
  21. name: string | null;
  22. model: string | null;
  23. filename: string | null;
  24. status: string | null;
  25. state: string | null;
  26. progress: number | null;
  27. layers: string | null;
  28. remaining: string | null;
  29. eta: string | null;
  30. temperatures: { key: string; icon: ReactNode; label: string; current: number; target: number | null }[];
  31. }
  32. // Explicit sources keep their orientation; legacy URLs follow the viewport.
  33. function useOverlayOrientation(layout?: OverlayLayout): OverlayLayout {
  34. const [portrait, setPortrait] = useState(() => window.matchMedia('(orientation: portrait)').matches);
  35. useEffect(() => {
  36. if (layout) return;
  37. const media = window.matchMedia('(orientation: portrait)');
  38. const update = (event: MediaQueryListEvent) => setPortrait(event.matches);
  39. setPortrait(media.matches);
  40. media.addEventListener('change', update);
  41. return () => media.removeEventListener('change', update);
  42. }, [layout]);
  43. return layout ?? (portrait ? 'portrait' : 'landscape');
  44. }
  45. export function UpdatedStreamOverlay(props: UpdatedStreamOverlayProps) {
  46. const { t } = useTranslation();
  47. const backgroundAlpha = 1 - (props.backgroundTransparency ?? 0) / 100;
  48. const backgroundStyle: CSSProperties & {
  49. '--overlay-background-alpha': number;
  50. '--overlay-identity-alpha': number;
  51. '--overlay-panel-alpha': number;
  52. } = {
  53. '--overlay-background-alpha': backgroundAlpha,
  54. '--overlay-identity-alpha': backgroundAlpha * 0.9,
  55. '--overlay-panel-alpha': backgroundAlpha * 0.88,
  56. };
  57. useLayoutEffect(() => {
  58. if (backgroundAlpha === 1) return;
  59. // The app's body background would otherwise fill every transparent pixel
  60. // in OBS. Restore it when leaving the overlay or resetting transparency.
  61. const previous = document.body.style.backgroundColor;
  62. document.body.style.backgroundColor = 'transparent';
  63. return () => { document.body.style.backgroundColor = previous; };
  64. }, [backgroundAlpha]);
  65. const layout = useOverlayOrientation(props.layout);
  66. const { camera, name, model, filename, status, state, progress, layers, remaining, eta, temperatures } =
  67. props;
  68. const progressTextStyle = overlayProgressTextStyle(props.progressBackground);
  69. const hasPanel =
  70. filename || status || progress != null || layers || remaining || eta || temperatures.length > 0;
  71. const rotation = camera?.rotation ?? 0;
  72. const sideways = Math.abs(rotation % 180) === 90;
  73. const cameraRef = useRef<HTMLDivElement>(null);
  74. const cameraBox = useSidewaysBox(cameraRef, sideways && camera != null);
  75. const stats = [
  76. { key: 'layers', icon: <Layers />, label: t('streamOverlay.layer'), value: layers },
  77. { key: 'remaining', icon: <Timer />, label: t('streamOverlay.remaining'), value: remaining },
  78. { key: 'eta', icon: <Clock />, label: t('streamOverlay.eta'), value: eta },
  79. ].filter((stat) => stat.value != null);
  80. return (
  81. <div className="updated-overlay" data-size={props.size} data-layout={layout} data-state={state} style={backgroundStyle}>
  82. <header className="updated-overlay__header">
  83. {(name || model) && (
  84. <div className="updated-overlay__identity">
  85. <Printer aria-hidden="true" />
  86. <div>
  87. {name && <strong>{name}</strong>}
  88. {model && <span>{model}</span>}
  89. </div>
  90. </div>
  91. )}
  92. <div className="updated-overlay__logo flex flex-col items-end">
  93. {props.customLogo}
  94. <a
  95. href="https://github.com/maziggy/bambuddy"
  96. target="_blank"
  97. rel="noopener noreferrer"
  98. >
  99. <img src="/img/bambuddy_logo_powered_by.png" alt="Bambuddy" />
  100. </a>
  101. </div>
  102. </header>
  103. {camera && (
  104. <div className="updated-overlay__camera" ref={cameraRef}>
  105. <img
  106. ref={camera.imgRef}
  107. src={camera.url}
  108. alt={t('streamOverlay.cameraStream')}
  109. style={{
  110. transform: `translate(-50%, -50%) rotate(${rotation}deg)`,
  111. // A quarter turn swaps the image's axes, so give it the slot's
  112. // height as width and vice versa; cover then still fills the slot.
  113. ...(sideways && cameraBox ? { width: cameraBox.height, height: cameraBox.width } : {}),
  114. }}
  115. onError={camera.onError}
  116. />
  117. </div>
  118. )}
  119. {hasPanel && (
  120. <section className="updated-overlay__panel">
  121. {(filename || status) && (
  122. <div className="updated-overlay__summary">
  123. {filename && <h1>{filename}</h1>}
  124. {status && (
  125. <div className="updated-overlay__status">
  126. <span aria-hidden="true" />
  127. {status}
  128. </div>
  129. )}
  130. </div>
  131. )}
  132. {progress != null && (
  133. <div className="updated-overlay__progress">
  134. <span style={progressTextStyle}>{t('streamOverlay.progress')}</span>
  135. <div
  136. role="progressbar"
  137. aria-label={t('streamOverlay.progress')}
  138. aria-valuemin={0}
  139. aria-valuemax={100}
  140. aria-valuenow={progress}
  141. >
  142. <div style={{ width: `${progress}%`, background: props.progressBackground }} />
  143. </div>
  144. <strong style={progressTextStyle}>{Math.round(progress)}%</strong>
  145. </div>
  146. )}
  147. {(stats.length > 0 || temperatures.length > 0) && (
  148. <div className="updated-overlay__readings">
  149. {stats.length > 0 && (
  150. <div className="updated-overlay__stats">
  151. {stats.map((stat) => (
  152. <div className="updated-overlay__reading" key={stat.key}>
  153. {stat.icon}
  154. <div>
  155. <span>{stat.label}</span>
  156. <strong>{stat.value}</strong>
  157. </div>
  158. </div>
  159. ))}
  160. </div>
  161. )}
  162. {temperatures.length > 0 && (
  163. <div className="updated-overlay__temperatures">
  164. {temperatures.map((reading) => (
  165. <div className="updated-overlay__reading" key={reading.key}>
  166. {reading.icon}
  167. <div>
  168. <span>{reading.label}</span>
  169. <strong>
  170. {Math.round(reading.current)}°C
  171. {reading.target != null &&
  172. reading.target > 0 &&
  173. Math.round(reading.target) !== Math.round(reading.current) && (
  174. <small> / {Math.round(reading.target)}°C</small>
  175. )}
  176. </strong>
  177. </div>
  178. </div>
  179. ))}
  180. </div>
  181. )}
  182. </div>
  183. )}
  184. </section>
  185. )}
  186. </div>
  187. );
  188. }