Create a `Subtitle` model

[tcely]

This depends on the Codec table being populated first.

• Create a Codec model #1421

Create a new model for a database table to hold rows for subtitles that are available.

Subtitle database table partial example:

Extension	Original Language	Language	Machine Generated	Codec
vtt	en-US	es-US	True	[Codec.pk of <subtitle,vtt>]
vtt	NULL	en-US	False	[Codec.pk of <subtitle,vtt>]

[jishanahmed-shaikh]

I'd like to take this on — looks like a clean, well-scoped model addition.

A few questions before I open a PR:

1. Codec dependency — issue Create a Codec model #1421 needs to be merged first. Is that already in main, or should I branch off that PR?

2. Proposed model sketch based on the table in the issue:

class Subtitle(models.Model):
    source = models.ForeignKey('Source', on_delete=models.CASCADE, related_name='subtitles')
    media = models.ForeignKey('Media', on_delete=models.CASCADE, related_name='subtitles', null=True, blank=True)
    extension = models.CharField(max_length=8)           # e.g. "vtt"
    original_language = models.CharField(max_length=16, null=True, blank=True)  # e.g. "en-US"
    language = models.CharField(max_length=16)           # e.g. "es-US"
    machine_generated = models.BooleanField(default=False)
    codec = models.ForeignKey('Codec', on_delete=models.SET_NULL, null=True, related_name='subtitles')

    class Meta:
        unique_together = ('media', 'language', 'extension')

    def __str__(self):
        return f'{self.language} ({self.extension}) - {self.media}'

3. Should I include a migration, admin registration, and basic test, or keep this PR strictly to the model definition?

Happy to start once I get a green light on the Codec dependency status.

[tcely]

I'd like to take this on — looks like a clean, well-scoped model addition.

Thanks! I'll assign this issue to your user.

A few questions before I open a PR:

1. Codec dependency — issue Create a Codec model #1421 needs to be merged first. Is that already in main, or should I branch off that PR?

The branch with all the accepted changes is: issue/1419/design-generic-models

I just built a test image and added it to: #1419 (comment)

3. Proposed model sketch based on the table in the issue:>
   class Subtitle(models.Model):
   source = models.ForeignKey('Source', on_delete=models.CASCADE, related_name='subtitles')
   media = models.ForeignKey('Media', on_delete=models.CASCADE, related_name='subtitles', null=True, blank=True)
   extension = models.CharField(max_length=8) # e.g. "vtt"
   original_language = models.CharField(max_length=16, null=True, blank=True) # e.g. "en-US"
   language = models.CharField(max_length=16) # e.g. "es-US"
   machine_generated = models.BooleanField(default=False)
   codec = models.ForeignKey('Codec', on_delete=models.SET_NULL, null=True, related_name='subtitles')

   class Meta:
   unique_together = ('media', 'language', 'extension')

   def str(self):
   return f'{self.language} ({self.extension}) - {self.media}'

We won't want to tie these to Source or Media, so those should be removed.
Also, we want to accept NULL, but probably shouldn't accept an empty string for original_language.

3. Should I include a migration, admin registration, and basic test, or keep this PR strictly to the model definition?

Please take on as much as you feel able to accomplish.

Happy to start once I get a green light on the Codec dependency status.

Great!

[tcely]

@jishanahmed-shaikh

I have added the subtitle codec data and rebuilt the test image (#1419 (comment)).

I'm looking forward to seeing your pull request.

[jishanahmed-shaikh]

@jishanahmed-shaikh

I have added the subtitle codec data and rebuilt the test image (#1419 (comment)).

I'm looking forward to seeing your pull request.

Acknowledged ✅