UpdatedStreamOverlay.tsx 8.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218
  1. import { useEffect, useLayoutEffect, useRef, useState, type CSSProperties, type ReactNode, type RefObject } 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 type { OverlayLayout } from '../utils/overlayLayout';
  7. interface UpdatedStreamOverlayProps {
  8. layout?: OverlayLayout;
  9. backgroundTransparency?: number;
  10. customLogo?: ReactNode;
  11. progressBackground?: string;
  12. size: 'small' | 'medium' | 'large';
  13. camera: { url: string; rotation: number; onError: () => void } | null;
  14. name: string | null;
  15. model: string | null;
  16. filename: string | null;
  17. status: string | null;
  18. state: string | null;
  19. progress: number | null;
  20. layers: string | null;
  21. remaining: string | null;
  22. eta: string | null;
  23. temperatures: { key: string; icon: ReactNode; label: string; current: number; target: number | null }[];
  24. }
  25. // The camera slot's size in px, measured only while the camera is turned
  26. // sideways. Measured rather than written as 100cqh/100cqw because container
  27. // units need Chromium 105+, which older OBS browser sources don't have, and
  28. // the viewport units they would fall back to are wrong for the portrait
  29. // layout, where the camera fills only the middle row.
  30. function useCameraBox(ref: RefObject<HTMLDivElement | null>, active: boolean) {
  31. const [box, setBox] = useState<{ width: number; height: number } | null>(null);
  32. // Layout effect: measured before paint, so a sideways camera never shows a
  33. // frame at the unswapped size.
  34. useLayoutEffect(() => {
  35. const el = ref.current;
  36. if (!active || !el) return;
  37. const measure = () => {
  38. // Layout dimensions exclude the scale applied by OverlayFrame.
  39. const width = el.clientWidth;
  40. const height = el.clientHeight;
  41. if (width > 0 && height > 0) {
  42. setBox((prev) => (prev && prev.width === width && prev.height === height ? prev : { width, height }));
  43. }
  44. };
  45. measure();
  46. if (typeof ResizeObserver === 'undefined') {
  47. window.addEventListener('resize', measure);
  48. return () => window.removeEventListener('resize', measure);
  49. }
  50. const observer = new ResizeObserver(measure);
  51. observer.observe(el);
  52. return () => observer.disconnect();
  53. }, [ref, active]);
  54. return active ? box : null;
  55. }
  56. // Explicit sources keep their orientation; legacy URLs follow the viewport.
  57. function useOverlayOrientation(layout?: OverlayLayout): OverlayLayout {
  58. const [portrait, setPortrait] = useState(() => window.matchMedia('(orientation: portrait)').matches);
  59. useEffect(() => {
  60. if (layout) return;
  61. const media = window.matchMedia('(orientation: portrait)');
  62. const update = (event: MediaQueryListEvent) => setPortrait(event.matches);
  63. setPortrait(media.matches);
  64. media.addEventListener('change', update);
  65. return () => media.removeEventListener('change', update);
  66. }, [layout]);
  67. return layout ?? (portrait ? 'portrait' : 'landscape');
  68. }
  69. export function UpdatedStreamOverlay(props: UpdatedStreamOverlayProps) {
  70. const { t } = useTranslation();
  71. const backgroundAlpha = 1 - (props.backgroundTransparency ?? 0) / 100;
  72. const backgroundStyle: CSSProperties & {
  73. '--overlay-background-alpha': number;
  74. '--overlay-identity-alpha': number;
  75. '--overlay-panel-alpha': number;
  76. } = {
  77. '--overlay-background-alpha': backgroundAlpha,
  78. '--overlay-identity-alpha': backgroundAlpha * 0.9,
  79. '--overlay-panel-alpha': backgroundAlpha * 0.88,
  80. };
  81. useLayoutEffect(() => {
  82. if (backgroundAlpha === 1) return;
  83. // The app's body background would otherwise fill every transparent pixel
  84. // in OBS. Restore it when leaving the overlay or resetting transparency.
  85. const previous = document.body.style.backgroundColor;
  86. document.body.style.backgroundColor = 'transparent';
  87. return () => { document.body.style.backgroundColor = previous; };
  88. }, [backgroundAlpha]);
  89. const layout = useOverlayOrientation(props.layout);
  90. const { camera, name, model, filename, status, state, progress, layers, remaining, eta, temperatures } =
  91. props;
  92. const progressTextStyle = overlayProgressTextStyle(props.progressBackground);
  93. const hasPanel =
  94. filename || status || progress != null || layers || remaining || eta || temperatures.length > 0;
  95. const rotation = camera?.rotation ?? 0;
  96. const sideways = Math.abs(rotation % 180) === 90;
  97. const cameraRef = useRef<HTMLDivElement>(null);
  98. const cameraBox = useCameraBox(cameraRef, sideways && camera != null);
  99. const stats = [
  100. { key: 'layers', icon: <Layers />, label: t('streamOverlay.layer'), value: layers },
  101. { key: 'remaining', icon: <Timer />, label: t('streamOverlay.remaining'), value: remaining },
  102. { key: 'eta', icon: <Clock />, label: t('streamOverlay.eta'), value: eta },
  103. ].filter((stat) => stat.value != null);
  104. return (
  105. <div className="updated-overlay" data-size={props.size} data-layout={layout} data-state={state} style={backgroundStyle}>
  106. <header className="updated-overlay__header">
  107. {(name || model) && (
  108. <div className="updated-overlay__identity">
  109. <Printer aria-hidden="true" />
  110. <div>
  111. {name && <strong>{name}</strong>}
  112. {model && <span>{model}</span>}
  113. </div>
  114. </div>
  115. )}
  116. <div className="updated-overlay__logo flex flex-col items-end">
  117. {props.customLogo}
  118. <a
  119. href="https://github.com/maziggy/bambuddy"
  120. target="_blank"
  121. rel="noopener noreferrer"
  122. >
  123. <img src="/img/bambuddy_logo_powered_by.png" alt="Bambuddy" />
  124. </a>
  125. </div>
  126. </header>
  127. {camera && (
  128. <div className="updated-overlay__camera" ref={cameraRef}>
  129. <img
  130. key={camera.url}
  131. src={camera.url}
  132. alt={t('streamOverlay.cameraStream')}
  133. style={{
  134. transform: `translate(-50%, -50%) rotate(${rotation}deg)`,
  135. // A quarter turn swaps the image's axes, so give it the slot's
  136. // height as width and vice versa; cover then still fills the slot.
  137. ...(sideways && cameraBox ? { width: cameraBox.height, height: cameraBox.width } : {}),
  138. }}
  139. onError={camera.onError}
  140. />
  141. </div>
  142. )}
  143. {hasPanel && (
  144. <section className="updated-overlay__panel">
  145. {(filename || status) && (
  146. <div className="updated-overlay__summary">
  147. {filename && <h1>{filename}</h1>}
  148. {status && (
  149. <div className="updated-overlay__status">
  150. <span aria-hidden="true" />
  151. {status}
  152. </div>
  153. )}
  154. </div>
  155. )}
  156. {progress != null && (
  157. <div className="updated-overlay__progress">
  158. <span style={progressTextStyle}>{t('streamOverlay.progress')}</span>
  159. <div
  160. role="progressbar"
  161. aria-label={t('streamOverlay.progress')}
  162. aria-valuemin={0}
  163. aria-valuemax={100}
  164. aria-valuenow={progress}
  165. >
  166. <div style={{ width: `${progress}%`, background: props.progressBackground }} />
  167. </div>
  168. <strong style={progressTextStyle}>{Math.round(progress)}%</strong>
  169. </div>
  170. )}
  171. {(stats.length > 0 || temperatures.length > 0) && (
  172. <div className="updated-overlay__readings">
  173. {stats.length > 0 && (
  174. <div className="updated-overlay__stats">
  175. {stats.map((stat) => (
  176. <div className="updated-overlay__reading" key={stat.key}>
  177. {stat.icon}
  178. <div>
  179. <span>{stat.label}</span>
  180. <strong>{stat.value}</strong>
  181. </div>
  182. </div>
  183. ))}
  184. </div>
  185. )}
  186. {temperatures.length > 0 && (
  187. <div className="updated-overlay__temperatures">
  188. {temperatures.map((reading) => (
  189. <div className="updated-overlay__reading" key={reading.key}>
  190. {reading.icon}
  191. <div>
  192. <span>{reading.label}</span>
  193. <strong>
  194. {Math.round(reading.current)}°C
  195. {reading.target != null &&
  196. reading.target > 0 &&
  197. Math.round(reading.target) !== Math.round(reading.current) && (
  198. <small> / {Math.round(reading.target)}°C</small>
  199. )}
  200. </strong>
  201. </div>
  202. </div>
  203. ))}
  204. </div>
  205. )}
  206. </div>
  207. )}
  208. </section>
  209. )}
  210. </div>
  211. );
  212. }