meemalabs / laravel-media-recognition

src/Traits/CanRecognizeVideos.php

<?php

namespace Meema\MediaRecognition\Traits;

use Exception;

trait CanRecognizeVideos
{
    /**
     * Sets the video to be analyzed.
     *
     * @param $type - used to create a readable identifier.

The doc comment - at position 0 could not be parsed: Unknown type name '-' at position 0 in -.

     * @return void
     * @throws \Exception
     */
    protected function setVideoSettings($type): void
    {
        $disk = $this->disk ?? config('media-recognition.disk');
        $bucketName = config("filesystems.disks.$disk.bucket");

        if (! $bucketName) {
            throw new Exception('Please make sure to set a S3 bucket name.');
        }

        $this->settings['Video'] = [

The property settings does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

            'S3Object' => [
                'Bucket' => $bucketName,
                'Name' => $this->source,
            ],
        ];

        $this->settings['NotificationChannel'] = [
            'RoleArn' => config('media-recognition.iam_arn'),
            'SNSTopicArn' => config('media-recognition.sns_topic_arn'),
        ];

        $uniqueId = $type.'_'.$this->mediaId;
        // Idempotent token used to identify the start request.
        // If you use the same token with multiple StartCelebrityRecognition requests, the same JobId is returned.
        // Use ClientRequestToken to prevent the same job from being accidentally started more than once.
        $this->settings['ClientRequestToken'] = $uniqueId;

        // the JobTag is set to be the media id, so we can adjust the media record with the results once the webhook comes in
        $this->settings['JobTag'] = $uniqueId;
    }

    /**
     * Starts asynchronous detection of labels/objects in a stored video.
     *
     * @param int|null $minConfidence
     * @param int $maxResults
     * @return \Aws\Result
     * @throws \Exception
     */
    public function detectVideoLabels($minConfidence = null, $maxResults = 1000)
    {
        $this->setVideoSettings('labels');
        $this->settings['MinConfidence'] = $minConfidence ?? config('media-recognition.min_confidence');

The property settings does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        $this->settings['MaxResults'] = $maxResults;

        $results = $this->client->startLabelDetection($this->settings);

        if ($results['JobId']) {
            $this->updateJobId($results['JobId'], 'labels');

It seems like updateJobId() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        }

        return $results;
    }

    /**
     * @param array $attributes
     * @return mixed
     * @throws \Exception
     */
    public function detectVideoFaces($attributes = ['DEFAULT'])
    {
        $this->setVideoSettings('faces');

        $this->settings['FaceAttributes'] = $attributes;

The property settings does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        $results = $this->client->startFaceDetection($this->settings);

        if ($results['JobId']) {
            $this->updateJobId($results['JobId'], 'faces');
        }

        return $results;
    }

    /**
     * Starts asynchronous detection of unsafe content in a stored video.
     *
     * @param int|null $minConfidence
     * @return mixed
     * @throws \Exception
     */
    public function detectVideoModeration($minConfidence = null)
    {
        $this->setVideoSettings('moderation');

        $this->settings['MinConfidence'] = $minConfidence ?? config('media-recognition.min_confidence');

The property settings does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        $results = $this->client->startContentModeration($this->settings);

        if ($results['JobId']) {
            $this->updateJobId($results['JobId'], 'faces');
        }

        return $results;
    }

    /**
     * Starts asynchronous detection of text in a stored video.
     *
     * @param array|null $filters
     * @return mixed
     * @throws \Exception
     */
    public function detectVideoText(array $filters = null)
    {
        $this->setVideoSettings('ocr');

        if (is_array($filters)) {
            $this->settings['Filters'] = $filters;

The property settings does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        }

        $results = $this->client->startTextDetection($this->settings);

        if ($results['JobId']) {
            $this->updateJobId($results['JobId'], 'ocr');
        }

        return $results;
    }

    /**
     * Get the labels from the video analysis.
     *
     * @param string $jobId
     * @param int|null $mediaId
     * @return \Aws\Result
     * @throws \Exception
     */
    public function getLabelsByJobId(string $jobId, int $mediaId = null)
    {
        $results = $this->client->getLabelDetection([
            'JobId' => $jobId,
        ]);

        if (is_null($mediaId)) {
            return $results;
        }

        $this->updateVideoResults($results->toArray(), 'labels', $mediaId);

It seems like updateVideoResults() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        return $results;
    }

    /**
     * Get the faces from the video analysis.
     *
     * @param string $jobId
     * @param int|null $mediaId
     * @return \Aws\Result
     * @throws \Exception
     */
    public function getFacesByJobId(string $jobId, int $mediaId = null)
    {
        $results = $this->client->getFaceDetection([
            'JobId' => $jobId,
        ]);

        if (is_null($mediaId)) {
            return $results;
        }

        $this->updateVideoResults($results->toArray(), 'faces', $mediaId);

        return $results;
    }

    /**
     * Get the "content moderation" from the video analysis.
     *
     * @param string $jobId
     * @param int|null $mediaId
     * @return \Aws\Result
     * @throws \Exception
     */
    public function getContentModerationByJobId(string $jobId, int $mediaId = null)
    {
        $results = $this->client->getContentModeration([
            'JobId' => $jobId,
        ]);

        if (is_null($mediaId)) {
            return $results;
        }

        $this->updateVideoResults($results->toArray(), 'moderation', $mediaId);

        return $results;
    }

    /**
     * Get the faces from a video analysis.
     *
     * @param string $jobId
     * @param int|null $mediaId
     * @return \Aws\Result
     * @throws \Exception
     */
    public function getTextDetectionByJobId(string $jobId, int $mediaId = null)
    {
        $results = $this->client->getTextDetection([
            'JobId' => $jobId,
        ]);

        if (is_null($mediaId)) {
            return $results;
        }

        $this->updateVideoResults($results->toArray(), 'ocr', $mediaId);

        return $results;
    }
}