2023-03-12 18:00:57 +03:00
// GoToSocial
// Copyright (C) GoToSocial Authors admin@gotosocial.org
// SPDX-License-Identifier: AGPL-3.0-or-later
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
2021-04-01 21:46:45 +03:00
2021-04-19 20:42:19 +03:00
package gtsmodel
2021-04-01 21:46:45 +03:00
import (
"time"
)
// MediaAttachment represents a user-uploaded media attachment: an image/video/audio/gif that is
// somewhere in storage and that can be retrieved and served by the router.
type MediaAttachment struct {
2023-08-06 13:22:40 +03:00
ID string ` bun:"type:CHAR(26),pk,nullzero,notnull,unique" ` // id of this item in the database
CreatedAt time . Time ` bun:"type:timestamptz,nullzero,notnull,default:current_timestamp" ` // when was item created
StatusID string ` bun:"type:CHAR(26),nullzero" ` // ID of the status to which this is attached
URL string ` bun:",nullzero" ` // Where can the attachment be retrieved on *this* server
RemoteURL string ` bun:",nullzero" ` // Where can the attachment be retrieved on a remote server (empty for local media)
2024-07-17 18:26:33 +03:00
Type FileType ` bun:",notnull,default:0" ` // Type of file (image/gifv/audio/video/unknown)
2024-06-26 18:01:16 +03:00
FileMeta FileMeta ` bun:",embed:,notnull" ` // Metadata about the file
2023-08-06 13:22:40 +03:00
AccountID string ` bun:"type:CHAR(26),nullzero,notnull" ` // To which account does this attachment belong
Description string ` bun:"" ` // Description of the attachment (for screenreaders)
ScheduledStatusID string ` bun:"type:CHAR(26),nullzero" ` // To which scheduled status does this attachment belong
Blurhash string ` bun:",nullzero" ` // What is the generated blurhash of this attachment
Processing ProcessingStatus ` bun:",notnull,default:2" ` // What is the processing status of this attachment
File File ` bun:",embed:file_,notnull,nullzero" ` // metadata for the whole file
Thumbnail Thumbnail ` bun:",embed:thumbnail_,notnull,nullzero" ` // small image thumbnail derived from a larger image, video, or audio file.
Avatar * bool ` bun:",nullzero,notnull,default:false" ` // Is this attachment being used as an avatar?
Header * bool ` bun:",nullzero,notnull,default:false" ` // Is this attachment being used as a header?
Cached * bool ` bun:",nullzero,notnull,default:false" ` // Is this attachment currently cached by our instance?
2021-04-01 21:46:45 +03:00
}
2024-06-26 18:01:16 +03:00
// IsLocal returns whether media attachment is local.
func ( m * MediaAttachment ) IsLocal ( ) bool {
return m . RemoteURL == ""
}
// IsRemote returns whether media attachment is remote.
func ( m * MediaAttachment ) IsRemote ( ) bool {
return m . RemoteURL != ""
}
2021-04-01 21:46:45 +03:00
// File refers to the metadata for the whole file
type File struct {
2024-06-26 18:01:16 +03:00
Path string ` bun:",notnull" ` // Path of the file in storage.
ContentType string ` bun:",notnull" ` // MIME content type of the file.
FileSize int ` bun:",notnull" ` // File size in bytes
2021-04-01 21:46:45 +03:00
}
// Thumbnail refers to a small image thumbnail derived from a larger image, video, or audio file.
type Thumbnail struct {
2024-06-26 18:01:16 +03:00
Path string ` bun:",notnull" ` // Path of the file in storage.
ContentType string ` bun:",notnull" ` // MIME content type of the file.
FileSize int ` bun:",notnull" ` // File size in bytes
URL string ` bun:",nullzero" ` // What is the URL of the thumbnail on the local server
RemoteURL string ` bun:",nullzero" ` // What is the remote URL of the thumbnail (empty for local media)
2021-04-01 21:46:45 +03:00
}
// ProcessingStatus refers to how far along in the processing stage the attachment is.
type ProcessingStatus int
2021-08-31 16:59:12 +03:00
// MediaAttachment processing states.
2021-04-01 21:46:45 +03:00
const (
2021-08-30 21:20:27 +03:00
ProcessingStatusReceived ProcessingStatus = 0 // ProcessingStatusReceived indicates the attachment has been received and is awaiting processing. No thumbnail available yet.
ProcessingStatusProcessing ProcessingStatus = 1 // ProcessingStatusProcessing indicates the attachment is currently being processed. Thumbnail is available but full media is not.
ProcessingStatusProcessed ProcessingStatus = 2 // ProcessingStatusProcessed indicates the attachment has been fully processed and is ready to be served.
ProcessingStatusError ProcessingStatus = 666 // ProcessingStatusError indicates something went wrong processing the attachment and it won't be tried again--these can be deleted.
2021-04-01 21:46:45 +03:00
)
2024-07-17 18:26:33 +03:00
// FileType refers to the file
// type of the media attaachment.
type FileType int
2021-04-01 21:46:45 +03:00
const (
2024-07-17 18:26:33 +03:00
// MediaAttachment file types.
FileTypeUnknown FileType = 0 // FileTypeUnknown is for unknown file types (surprise surprise!)
FileTypeImage FileType = 1 // FileTypeImage is for jpegs, pngs, and standard gifs
FileTypeAudio FileType = 2 // FileTypeAudio is for audio-only files (no video)
FileTypeVideo FileType = 3 // FileTypeVideo is for files with audio + visual
2024-08-08 11:12:16 +03:00
FileTypeGifv FileType = 4 // FileTypeGifv is for short video-only files (20s or less, mp4, no audio).
2021-04-01 21:46:45 +03:00
)
2024-07-17 18:26:33 +03:00
// String returns a stringified, frontend API compatible form of FileType.
func ( t FileType ) String ( ) string {
switch t {
case FileTypeUnknown :
return "unknown"
case FileTypeImage :
return "image"
case FileTypeAudio :
return "audio"
case FileTypeVideo :
return "video"
2024-08-08 11:12:16 +03:00
case FileTypeGifv :
return "gifv"
2024-07-17 18:26:33 +03:00
default :
panic ( "invalid filetype" )
}
}
2021-04-01 21:46:45 +03:00
// FileMeta describes metadata about the actual contents of the file.
type FileMeta struct {
2023-08-06 13:22:40 +03:00
Original Original ` bun:"embed:original_" `
2022-03-07 13:08:26 +03:00
Small Small ` bun:"embed:small_" `
Focus Focus ` bun:"embed:focus_" `
2021-04-01 21:46:45 +03:00
}
2021-04-19 20:42:19 +03:00
// Small can be used for a thumbnail of any media type
2021-04-01 21:46:45 +03:00
type Small struct {
2023-08-06 13:22:40 +03:00
Width int // width in pixels
Height int // height in pixels
Size int // size in pixels (width * height)
Aspect float32 // aspect ratio (width / height)
2021-04-01 21:46:45 +03:00
}
2021-04-19 20:42:19 +03:00
// Original can be used for original metadata for any media type
2021-04-01 21:46:45 +03:00
type Original struct {
2023-08-06 13:22:40 +03:00
Width int // width in pixels
Height int // height in pixels
Size int // size in pixels (width * height)
Aspect float32 // aspect ratio (width / height)
Duration * float32 // video-specific: duration of the video in seconds
Framerate * float32 // video-specific: fps
Bitrate * uint64 // video-specific: bitrate
2021-04-01 21:46:45 +03:00
}
2021-04-19 20:42:19 +03:00
2021-04-20 19:14:23 +03:00
// Focus describes the 'center' of the image for display purposes.
// X and Y should each be between -1 and 1
2021-04-19 20:42:19 +03:00
type Focus struct {
2023-08-06 13:22:40 +03:00
X float32
Y float32
2021-04-19 20:42:19 +03:00
}