mediaattachment.go (8875B)
1 // GoToSocial 2 // Copyright (C) GoToSocial Authors admin@gotosocial.org 3 // SPDX-License-Identifier: AGPL-3.0-or-later 4 // 5 // This program is free software: you can redistribute it and/or modify 6 // it under the terms of the GNU Affero General Public License as published by 7 // the Free Software Foundation, either version 3 of the License, or 8 // (at your option) any later version. 9 // 10 // This program is distributed in the hope that it will be useful, 11 // but WITHOUT ANY WARRANTY; without even the implied warranty of 12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 // GNU Affero General Public License for more details. 14 // 15 // You should have received a copy of the GNU Affero General Public License 16 // along with this program. If not, see <http://www.gnu.org/licenses/>. 17 18 package gtsmodel 19 20 import ( 21 "time" 22 ) 23 24 // MediaAttachment represents a user-uploaded media attachment: an image/video/audio/gif that is 25 // somewhere in storage and that can be retrieved and served by the router. 26 type MediaAttachment struct { 27 ID string `validate:"required,ulid" bun:"type:CHAR(26),pk,nullzero,notnull,unique"` // id of this item in the database 28 CreatedAt time.Time `validate:"-" bun:"type:timestamptz,nullzero,notnull,default:current_timestamp"` // when was item created 29 UpdatedAt time.Time `validate:"-" bun:"type:timestamptz,nullzero,notnull,default:current_timestamp"` // when was item last updated 30 StatusID string `validate:"omitempty,ulid" bun:"type:CHAR(26),nullzero"` // ID of the status to which this is attached 31 URL string `validate:"required_without=RemoteURL,omitempty,url" bun:",nullzero"` // Where can the attachment be retrieved on *this* server 32 RemoteURL string `validate:"required_without=URL,omitempty,url" bun:",nullzero"` // Where can the attachment be retrieved on a remote server (empty for local media) 33 Type FileType `validate:"oneof=Image Gif Audio Video Unknown" bun:",nullzero,notnull"` // Type of file (image/gif/audio/video) 34 FileMeta FileMeta `validate:"required" bun:",embed:,nullzero,notnull"` // Metadata about the file 35 AccountID string `validate:"required,ulid" bun:"type:CHAR(26),nullzero,notnull"` // To which account does this attachment belong 36 Account *Account `validate:"-" bun:"rel:has-one"` // Account corresponding to accountID 37 Description string `validate:"-" bun:""` // Description of the attachment (for screenreaders) 38 ScheduledStatusID string `validate:"omitempty,ulid" bun:"type:CHAR(26),nullzero"` // To which scheduled status does this attachment belong 39 Blurhash string `validate:"required_if=Type Image,required_if=Type Gif,required_if=Type Video" bun:",nullzero"` // What is the generated blurhash of this attachment 40 Processing ProcessingStatus `validate:"oneof=0 1 2 666" bun:",notnull,default:2"` // What is the processing status of this attachment 41 File File `validate:"required" bun:",embed:file_,notnull,nullzero"` // metadata for the whole file 42 Thumbnail Thumbnail `validate:"required" bun:",embed:thumbnail_,notnull,nullzero"` // small image thumbnail derived from a larger image, video, or audio file. 43 Avatar bool `validate:"-" bun:",notnull,default:false"` // Is this attachment being used as an avatar? 44 Header bool `validate:"-" bun:",notnull,default:false"` // Is this attachment being used as a header? 45 Cached bool `validate:"-" bun:",notnull"` // Is this attachment currently cached by our instance? 46 } 47 48 // File refers to the metadata for the whole file 49 type File struct { 50 Path string `validate:"required,file" bun:",nullzero,notnull"` // Path of the file in storage. 51 ContentType string `validate:"required" bun:",nullzero,notnull"` // MIME content type of the file. 52 FileSize int `validate:"required" bun:",notnull"` // File size in bytes 53 UpdatedAt time.Time `validate:"-" bun:"type:timestamptz,nullzero,notnull,default:current_timestamp"` // When was the file last updated. 54 } 55 56 // Thumbnail refers to a small image thumbnail derived from a larger image, video, or audio file. 57 type Thumbnail struct { 58 Path string `validate:"required,file" bun:",nullzero,notnull"` // Path of the file in storage. 59 ContentType string `validate:"required" bun:",nullzero,notnull"` // MIME content type of the file. 60 FileSize int `validate:"required" bun:",notnull"` // File size in bytes 61 UpdatedAt time.Time `validate:"-" bun:"type:timestamptz,nullzero,notnull,default:current_timestamp"` // When was the file last updated. 62 URL string `validate:"required_without=RemoteURL,omitempty,url" bun:",nullzero"` // What is the URL of the thumbnail on the local server 63 RemoteURL string `validate:"required_without=URL,omitempty,url" bun:",nullzero"` // What is the remote URL of the thumbnail (empty for local media) 64 } 65 66 // ProcessingStatus refers to how far along in the processing stage the attachment is. 67 type ProcessingStatus int 68 69 // MediaAttachment processing states. 70 const ( 71 ProcessingStatusReceived ProcessingStatus = 0 // ProcessingStatusReceived indicates the attachment has been received and is awaiting processing. No thumbnail available yet. 72 ProcessingStatusProcessing ProcessingStatus = 1 // ProcessingStatusProcessing indicates the attachment is currently being processed. Thumbnail is available but full media is not. 73 ProcessingStatusProcessed ProcessingStatus = 2 // ProcessingStatusProcessed indicates the attachment has been fully processed and is ready to be served. 74 ProcessingStatusError ProcessingStatus = 666 // ProcessingStatusError indicates something went wrong processing the attachment and it won't be tried again--these can be deleted. 75 ) 76 77 // FileType refers to the file type of the media attaachment. 78 type FileType string 79 80 // MediaAttachment file types. 81 const ( 82 FileTypeImage FileType = "Image" // FileTypeImage is for jpegs and pngs 83 FileTypeGif FileType = "Gif" // FileTypeGif is for native gifs and soundless videos that have been converted to gifs 84 FileTypeAudio FileType = "Audio" // FileTypeAudio is for audio-only files (no video) 85 FileTypeVideo FileType = "Video" // FileTypeVideo is for files with audio + visual 86 FileTypeUnknown FileType = "Unknown" // FileTypeUnknown is for unknown file types (surprise surprise!) 87 ) 88 89 // FileMeta describes metadata about the actual contents of the file. 90 type FileMeta struct { 91 Original Original `validate:"required" bun:"embed:original_"` 92 Small Small `bun:"embed:small_"` 93 Focus Focus `bun:"embed:focus_"` 94 } 95 96 // Small can be used for a thumbnail of any media type 97 type Small struct { 98 Width int `validate:"required_with=Height Size Aspect"` // width in pixels 99 Height int `validate:"required_with=Width Size Aspect"` // height in pixels 100 Size int `validate:"required_with=Width Height Aspect"` // size in pixels (width * height) 101 Aspect float64 `validate:"required_with=Widhth Height Size"` // aspect ratio (width / height) 102 } 103 104 // Original can be used for original metadata for any media type 105 type Original struct { 106 Width int `validate:"required_with=Height Size Aspect"` // width in pixels 107 Height int `validate:"required_with=Width Size Aspect"` // height in pixels 108 Size int `validate:"required_with=Width Height Aspect"` // size in pixels (width * height) 109 Aspect float64 `validate:"required_with=Widhth Height Size"` // aspect ratio (width / height) 110 } 111 112 // Focus describes the 'center' of the image for display purposes. 113 // X and Y should each be between -1 and 1 114 type Focus struct { 115 X float32 `validate:"omitempty,max=1,min=-1"` 116 Y float32 `validate:"omitempty,max=1,min=-1"` 117 }