Add Crop Action Type and Parameters for Video Segment Cropping

databases/_upgrade_sponsorTimes_45.sql

@@ -0,0 +1,15 @@
+BEGIN TRANSACTION;
+
+ALTER TABLE "sponsorTimes" ADD "cropLeft" INTEGER;
+ALTER TABLE "sponsorTimes" ADD "cropRight" INTEGER;
+ALTER TABLE "sponsorTimes" ADD "cropTop" INTEGER;
+ALTER TABLE "sponsorTimes" ADD "cropBottom" INTEGER;
+
+ALTER TABLE "archivedSponsorTimes" ADD "cropLeft" INTEGER;
+ALTER TABLE "archivedSponsorTimes" ADD "cropRight" INTEGER;
+ALTER TABLE "archivedSponsorTimes" ADD "cropTop" INTEGER;
+ALTER TABLE "archivedSponsorTimes" ADD "cropBottom" INTEGER;
+
+UPDATE "config" SET value = 45 WHERE key = 'version';
+
+COMMIT;

src/config.ts

@@ -19,7 +19,7 @@ addDefaults(config, {
     privateDBSchema: "./databases/_private.db.sql",
     readOnly: false,
     webhooks: [],
-    categoryList: ["sponsor", "selfpromo", "exclusive_access", "interaction", "intro", "outro", "preview", "music_offtopic", "filler", "poi_highlight", "chapter"],
+    categoryList: ["sponsor", "selfpromo", "exclusive_access", "interaction", "intro", "outro", "preview", "music_offtopic", "filler", "poi_highlight", "chapter", "windowbox"],
     casualCategoryList: ["funny", "creative", "clever", "descriptive", "other"],
     categorySupport: {
         sponsor: ["skip", "mute", "full"],
@@ -32,7 +32,8 @@ addDefaults(config, {
         filler: ["skip", "mute"],
         music_offtopic: ["skip"],
         poi_highlight: ["poi"],
-        chapter: ["chapter"]
+        chapter: ["chapter", "crop"],
+        windowbox: ["full", "crop"]
     },
     deArrowTypes: ["title", "thumbnail"],
     maxTitleLength: 110,

src/routes/getSkipSegments.ts

@@ -218,7 +218,7 @@ async function getSegmentsFromDBByHash(hashedVideoIDPrefix: VideoIDHash, service
     const fetchFromDB = () => db
         .prepare(
             "all",
-            `SELECT "videoID", "startTime", "endTime", "votes", "locked", "UUID", "userID", "category", "actionType", "videoDuration", "hidden", "reputation", "shadowHidden", "hashedVideoID", "timeSubmitted", "description" FROM "sponsorTimes"
+            `SELECT "videoID", "startTime", "endTime", "votes", "locked", "UUID", "userID", "category", "actionType", "videoDuration", "hidden", "reputation", "shadowHidden", "hashedVideoID", "timeSubmitted", "description", "cropLeft", "cropRight", "cropTop", "cropBottom" FROM "sponsorTimes"
             WHERE "hashedVideoID" LIKE ? AND "service" = ? ORDER BY "startTime"`,
             [`${hashedVideoIDPrefix}%`, service],
             { useReplica: true }
@@ -237,7 +237,7 @@ async function getSegmentsFromDBByVideoID(videoID: VideoID, service: Service): P
     const fetchFromDB = () => db
         .prepare(
             "all",
-            `SELECT "startTime", "endTime", "votes", "locked", "UUID", "userID", "category", "actionType", "videoDuration", "hidden", "reputation", "shadowHidden", "timeSubmitted", "description" FROM "sponsorTimes" 
+            `SELECT "startTime", "endTime", "votes", "locked", "UUID", "userID", "category", "actionType", "videoDuration", "hidden", "reputation", "shadowHidden", "timeSubmitted", "description", "cropLeft", "cropRight", "cropTop", "cropBottom" FROM "sponsorTimes" 
             WHERE "videoID" = ? AND "service" = ? ORDER BY "startTime"`,
             [videoID, service],
             { useReplica: true }

src/routes/postSkipSegments.ts

@@ -302,6 +302,34 @@
             return { pass: false, errorMessage: "ActionType is not supported with this category.", errorCode: 400 };
         }
 
+        if (segments[i].actionType === ActionType.Crop) {
+            const cropFields = [
+                { name: 'cropLeft', value: segments[i].cropLeft },
+                { name: 'cropRight', value: segments[i].cropRight },
+                { name: 'cropTop', value: segments[i].cropTop },
+                { name: 'cropBottom', value: segments[i].cropBottom }
+            ];
+            for (const field of cropFields) {
+                if (field.value !== undefined) {
+                    if (!Number.isInteger(field.value) || field.value < 0 || field.value > 255) {
+                        return { pass: false, errorMessage: `${field.name} must be an integer between 0 and 255.`, errorCode: 400 };
+                    }
+                }
+            }
+
+            const leftValue = segments[i].cropLeft || 0;
+            const rightValue = segments[i].cropRight || 0;
+            const topValue = segments[i].cropTop || 0;
+            const bottomValue = segments[i].cropBottom || 0;
+
+            if (leftValue + rightValue > 256) {
+                return { pass: false, errorMessage: "cropLeft + cropRight must not exceed 256.", errorCode: 400 };
+            }
+            if (topValue + bottomValue > 256) {
+                return { pass: false, errorMessage: "cropTop + cropBottom must not exceed 256.", errorCode: 400 };
+            }
+        }
+
         const startTime = parseFloat(segments[i].segment[0]);
         const endTime = parseFloat(segments[i].segment[1]);
 
@@ -612,10 +640,10 @@
             const startingLocked = isVIP ? 1 : 0;
             try {
                 await db.prepare("run", `INSERT INTO "sponsorTimes" 
-                    ("videoID", "startTime", "endTime", "votes", "locked", "UUID", "userID", "timeSubmitted", "views", "category", "actionType", "service", "videoDuration", "reputation", "shadowHidden", "hashedVideoID", "userAgent", "description")
-                    VALUES(?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)`, [
+                    ("videoID", "startTime", "endTime", "votes", "locked", "UUID", "userID", "timeSubmitted", "views", "category", "actionType", "service", "videoDuration", "reputation", "shadowHidden", "hashedVideoID", "userAgent", "description", "cropLeft", "cropRight", "cropTop", "cropBottom")
+                    VALUES(?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)`, [
                     videoID, segmentInfo.segment[0], segmentInfo.segment[1], startingVotes, startingLocked, UUID, userID, timeSubmitted, 0
-                    , segmentInfo.category, segmentInfo.actionType, service, videoDuration, reputation, isBanned ? 1 : 0, hashedVideoID, userAgent, segmentInfo.description
+                    , segmentInfo.category, segmentInfo.actionType, service, videoDuration, reputation, isBanned ? 1 : 0, hashedVideoID, userAgent, segmentInfo.description, segmentInfo.cropLeft, segmentInfo.cropRight, segmentInfo.cropTop, segmentInfo.cropBottom
                 ],
                 );
 

src/types/segments.model.ts

@@ -5,7 +5,7 @@ import { HashedUserID, UserID } from "./user.model";
 export type SegmentUUID = string & { __segmentUUIDBrand: unknown };
 export type VideoID = string & { __videoIDBrand: unknown };
 export type VideoDuration = number & { __videoDurationBrand: unknown };
-export type Category = ("sponsor" | "selfpromo" | "interaction" | "intro" | "outro" | "preview" | "music_offtopic" | "poi_highlight" | "chapter" | "filler" | "exclusive_access") & { __categoryBrand: unknown };
+export type Category = ("sponsor" | "selfpromo" | "interaction" | "intro" | "outro" | "preview" | "music_offtopic" | "poi_highlight" | "chapter" | "filler" | "exclusive_access" | "windowbox") & { __categoryBrand: unknown };
 export type DeArrowType = "title" | "thumbnail";
 export type VideoIDHash = VideoID & HashedValue;
 export type IPAddress = string & { __ipAddressBrand: unknown };
@@ -16,7 +16,8 @@ export enum ActionType {
     Mute = "mute",
     Chapter = "chapter",
     Full = "full",
-    Poi = "poi"
+    Poi = "poi",
+    Crop = "crop"
 }
 
 // Uncomment as needed
@@ -35,6 +36,10 @@ export interface IncomingSegment {
     actionType: ActionType;
     segment: string[];
     description?: string;
+    cropLeft?: number;
+    cropRight?: number;
+    cropTop?: number;
+    cropBottom?: number;
 
     // Used to remove in pre-check stage
     ignoreSegment?: boolean;
@@ -49,6 +54,10 @@ export interface Segment {
     locked: boolean;
     votes: number;
     description: string;
+    cropLeft?: number;
+    cropRight?: number;
+    cropTop?: number;
+    cropBottom?: number;
 }
 
 export enum Visibility {
@@ -78,6 +87,10 @@ export interface DBSegment {
     userAgent: string;
     service: Service;
     description: string;
+    cropLeft?: number;
+    cropRight?: number;
+    cropTop?: number;
+    cropBottom?: number;
 }
 
 export interface OverlappingSegmentGroup {
@@ -133,4 +146,4 @@ export enum VoteType {
     ExtraDownvote = 2,
     Undo = 20,
     Malicious = 30
-}
+}