Merge pull request #1393 from Signbank/choose_still

#1392: Generate still images for video, choose modal

Author: susanodd

signbank/dictionary/adminviews.py

@@ -1,3 +1,4 @@
+import os.path
 
 from django.views.generic.list import ListView
 from django.views.generic.detail import DetailView
@@ -7592,3 +7593,33 @@ def annotatedglosslist_ajax_complete(request, annotatedgloss_id):
                    'column_values': column_values,
                    'USE_REGULAR_EXPRESSIONS': USE_REGULAR_EXPRESSIONS,
                    'SHOW_DATASET_INTERFACE_OPTIONS': SHOW_DATASET_INTERFACE_OPTIONS})
+
+def fetch_video_stills_for_gloss(request, gloss_id):
+
+    gloss = Gloss.objects.get(id=gloss_id, archived=False)
+
+    folder = gloss.idgloss + '-' + gloss_id
+    folder = folder.replace(' ', '_')
+    temp_location_frames = os.path.join(settings.GLOSS_IMAGE_DIRECTORY, "signbank-thumbnail-frames", folder)
+    temp_video_frames_folder = os.path.join(settings.WRITABLE_FOLDER,
+                                            settings.GLOSS_IMAGE_DIRECTORY, "signbank-thumbnail-frames", folder)
+    stills = []
+    if os.path.exists(temp_video_frames_folder):
+        for filename in os.listdir(temp_video_frames_folder):
+            still_path = str(os.path.join(temp_location_frames, filename))
+            stills.append(still_path)
+    sorted_stills = sorted(stills)
+    SHOW_DATASET_INTERFACE_OPTIONS = getattr(settings, 'SHOW_DATASET_INTERFACE_OPTIONS', False)
+    USE_REGULAR_EXPRESSIONS = getattr(settings, 'USE_REGULAR_EXPRESSIONS', False)
+
+    selected_datasets = get_selected_datasets_for_user(request.user)
+    dataset_languages = get_dataset_languages(selected_datasets)
+
+    return render(request, 'dictionary/video_stills.html',
+                  {'focus_gloss': gloss,
+                   'stills': sorted_stills,
+                   'dataset_languages': dataset_languages,
+                   'selected_datasets': selected_datasets,
+                   'PREFIX_URL': settings.PREFIX_URL,
+                   'USE_REGULAR_EXPRESSIONS': USE_REGULAR_EXPRESSIONS,
+                   'SHOW_DATASET_INTERFACE_OPTIONS': SHOW_DATASET_INTERFACE_OPTIONS})

signbank/dictionary/models.py

@@ -2518,6 +2518,16 @@ def create_citation_image(self):
         glossvideo = glossvideos.first()
         glossvideo.make_poster_image()
 
+    def generate_stills(self):
+        from signbank.video.models import GlossVideo
+        glossvideos = GlossVideo.objects.filter(gloss=self, glossvideonme=None, glossvideoperspective=None, version=0)
+        if not glossvideos:
+            msg = ("Gloss::create_stills: no video for gloss %s"
+                   % self.pk)
+            raise ValidationError(msg)
+        glossvideo = glossvideos.first()
+        glossvideo.make_image_sequence()
+
     def published_definitions(self):
         """Return a query set of just the published definitions for this gloss
         also filter out those fields not in DEFINITION_FIELDS"""

signbank/dictionary/templates/dictionary/gloss_detail.html

@@ -202,6 +202,59 @@
     <script type="text/javascript" src="{{STATIC_URL}}js/recordscript.js"></script>
 
     <script type='text/javascript'>
+        $('.quick_createstills').click(function(e)
+        {
+            var glossid = $(this).attr('data-glossid');
+            $.ajax({
+               url : url + "/dictionary/generate_video_stills_for_gloss/" + glossid,
+               type: 'POST',
+               data: { 'csrfmiddlewaretoken': csrf_token },
+               success : function(data) {
+                    var lookup = "#stills_gloss_video";
+                    $(lookup).empty();
+                    $.ajax({
+                        url : url + "/dictionary/ajax/fetch_video_stills_for_gloss/" + glossid + "/",
+                        datatype: "json",
+                        async: true,
+                        data: { 'csrfmiddlewaretoken': csrf_token },
+                        success : function(result) {
+                            var parsed = $.parseHTML(result);
+                            $(lookup).first().append(result);
+                        }
+                    });
+               }
+            });
+        });
+        $('.choose_still').click(function(e)
+        {
+            var glossid = $(this).attr('data-glossid');
+            var lookup = "#stills_gloss_video";
+            var chosen_image = [];
+            $(lookup).find('input[name="stillimage"]').each(function() {
+                if (this.checked) {
+                    chosen_image.push(this.value);
+                }
+            });
+            if (!chosen_image.length > 0) {
+                return;
+            }
+            var chosen = chosen_image[0];
+            $.ajax({
+               url : url + "/dictionary/save_chosen_still_for_gloss/" + glossid,
+               type: 'POST',
+               datatype: "json",
+               data: { 'csrfmiddlewaretoken': csrf_token,
+                       'imagepath': chosen },
+               success: function(data) {
+                    var stills_modal = '#stills_modal';
+                    var lookup = "#stills_gloss_video";
+                    $(lookup).empty();
+                    $(stills_modal).modal("hide");
+                    var redirect_url = data.redirect_url;
+                    window.location.replace(redirect_url);
+               }
+            });
+        });
         function play_perspective() {
             $('#videoplayer_middle').trigger('play');
             $('#videoplayer_left').trigger('play');
@@ -458,8 +511,19 @@
 textarea:focus {
     border: 1px solid red;
 }
+.radio_stills label:has(+ input[type="radio"]:checked) > img {
+    outline: 2px solid red;
+}
+.zoom {
+  background-color: transparent;
+  transition: transform .2s; /* Animation */
+  margin: 0 auto;
+}
+.zoom:hover {
+  transform: scale(1.5);
+  outline: 2px solid red;
+}
 </style>
-
 {% endblock %}
 
 {% block content %}
@@ -1013,9 +1077,46 @@ <h4>{% trans "Upload New Citation Form Image" %}</h4>
     {% if gloss.has_video and "change_dataset" in dataset_perms %}
         <div class="editform">
             <h4>{% trans "Create Citation Form Image from Current Video" %}</h4>
-            <a href="{% url 'dictionary:create_citation_image'  gloss.id %}" class="btn btn-primary">Create</a>
+            <a href="{% url 'dictionary:create_citation_image'  gloss.id %}" class="btn btn-primary">{% trans "Create" %}</a>
+
+            <button id='choose_still_btn' class='btn btn-primary' style="width:auto;"
+                 data-toggle='modal'
+                 data-target='#stills_modal'>{% trans "Choose Still Image" %}</button>
         </div>
+        <div class="modal fade" id="stills_modal" tabindex="-1" role="dialog" aria-labelledby="#modalTitleStills" aria-hidden="true">
+             <div class="modal-dialog modal-lg left-modal">
+                <div class="modal-content">
+                    <div class='modal-header'>
+                        <h2 id='modalTitleStills'>{% trans "Choose a Still Image" %}</h2>
+                    </div>
+                    <div class='modal-body'>
 
+                        <div style="width:800px;">
+                            <button id='quick_create_stills'
+                                class="quick_createstills btn btn-primary" style="width:auto;"
+                                name='quick_createstills'
+                                data-glossid='{{gloss.id}}'
+                                type="submit" >{% trans "Generate Stills" %}
+                            </button>
+                            <table class='table table-condensed'>
+                                <tbody class="tbody tbody-light">
+                                    <tr>
+                                        <td id="stills_gloss_video">
+
+                                        </td>
+                                    </tr>
+                                </tbody>
+                            </table>
+                        </div>
+                    </div>
+                    <div class="modal-footer">
+                        <input type="submit" class="choose_still btn btn-primary" id="choose_still" data-glossid="{{gloss.id}}"
+                               style="width:auto;" value='{% trans "Choose Image" %}'>
+                        <button type="button" class="btn btn-primary" data-dismiss="modal">{% trans "Dismiss" %}</button>
+                    </div>
+                </div>
+            </div>
+        </div>
     {% endif %}
 
     {% if "change_dataset" in dataset_perms %}
@@ -2244,7 +2345,7 @@ <h2 id='modalTitleBlend'>{% trans "Delete This Blend" %}</h2>
              data-target='#minimalpairs'>{% trans "Minimal Pairs" %}
         </div>
         <div id='minimalpairs' class='collapse'>
-            <table class='table table-condensed' id = "header_mp_rows">
+            <table class='table table-condensed' id="header_mp_rows">
 
             {% if minimalpairs %}
                <tr>

signbank/dictionary/templates/dictionary/video_stills.html

@@ -0,0 +1,26 @@
+{% load i18n %}
+{% load stylesheet %}
+{% load annotation_idgloss_translation %}
+
+{% load bootstrap3 %}
+{% load tagging_tags %}
+
+{% block extrajs %}
+<script type='text/javascript'>
+    var url = '{{PREFIX_URL}}';
+
+</script>
+{% endblock %}
+
+<div id="glossstills_{{focus_gloss.id}}">
+{% url 'dictionary:protected_media' '' as protected_media_url %}
+{% csrf_token %}
+<div class="radio_stills">
+{% for imagepath in stills %}
+    <label class="still_label" for="still_{{forloop.counter}}">
+    <img class="zoom" src="{{PREFIX_URL}}{{protected_media_url}}{{imagepath}}" width="200">
+    </label>
+    <input type="radio" name="stillimage" value="{{imagepath}}" id="still_{{forloop.counter}}">
+{% endfor %}
+</div>
+</div>

signbank/dictionary/urls.py

@@ -10,7 +10,7 @@
     create_lemma_for_gloss, LemmaUpdateView, SemanticFieldDetailView, SemanticFieldListView, DerivationHistoryDetailView,
     DerivationHistoryListView, GlossVideosView, KeywordListView, AnnotatedSentenceDetailView, AnnotatedSentenceListView)
 
-from signbank.dictionary.views import create_citation_image
+from signbank.dictionary.views import create_citation_image, generate_video_stills_for_gloss
 
 # These are needed for the urls below
 import signbank.dictionary.views
@@ -169,6 +169,7 @@
     re_path(r'^ajax/senserow/(?P<sense_id>.*)/$', signbank.dictionary.adminviews.senselist_ajax_complete, name='senselist_ajax_complete'),
     re_path(r'^ajax/senselistheader/$', signbank.dictionary.adminviews.senselistheader_ajax, name='senselistheader_ajax'),
     re_path(r'^ajax/lemmaglossrow/(?P<gloss_id>.*)/$', signbank.dictionary.adminviews.lemmaglosslist_ajax_complete, name='lemmaglosslist_ajax_complete'),
+    re_path(r'^ajax/fetch_video_stills_for_gloss/(?P<gloss_id>.*)/$', signbank.dictionary.adminviews.fetch_video_stills_for_gloss, name='fetch_video_stills_for_gloss'),
 
     re_path(r'^ajax/annotatedglosslistheader/$', signbank.dictionary.adminviews.annotatedglosslistheader_ajax,
             name='annotatedglosslistheader_ajax'),
@@ -286,6 +287,11 @@
     re_path(r'createcitationimage/(?P<pk>\d+)',
             permission_required('dictionary.change_gloss')(signbank.dictionary.views.create_citation_image),
             name='create_citation_image'),
-
+    re_path(r'generate_video_stills_for_gloss/(?P<pk>\d+)',
+            permission_required('dictionary.change_gloss')(signbank.dictionary.views.generate_video_stills_for_gloss),
+            name='generate_video_stills_for_gloss'),
+    re_path(r'save_chosen_still_for_gloss/(?P<pk>\d+)',
+            permission_required('dictionary.change_gloss')(signbank.dictionary.views.save_chosen_still_for_gloss),
+            name='save_chosen_still_for_gloss'),
     re_path(r'gloss/api/', signbank.dictionary.views.gloss_api_get_sign_name_and_media_info, name='gloss_api_get_info')
 ]

signbank/dictionary/views.py

@@ -1,5 +1,7 @@
+import os.path
+
 from django.conf import empty
-from django.http import HttpResponse, HttpResponseRedirect, HttpResponseBadRequest, HttpResponseNotAllowed, Http404
+from django.http import HttpResponse, HttpResponseRedirect, HttpResponseBadRequest, HttpResponseNotAllowed, Http404, JsonResponse
 from django.shortcuts import render, get_object_or_404, redirect
 from django.urls import reverse
 from django.contrib.auth.decorators import login_required
@@ -23,7 +25,7 @@
 import signbank.dictionary.forms
 from signbank.video.models import GlossVideo, small_appendix, add_small_appendix
 
-from signbank.tools import save_media
+from signbank.tools import save_media, get_two_letter_dir
 from signbank.tools import get_selected_datasets_for_user, get_default_annotationidglosstranslation, \
     get_dataset_languages, \
     create_gloss_from_valuedict, compare_valuedict_to_gloss, compare_valuedict_to_lemma, construct_scrollbar, \
@@ -1778,6 +1780,56 @@ def create_citation_image(request, pk):
 
     return redirect(url)
 
+
+def generate_video_stills_for_gloss(request, pk):
+    if 'HTTP_REFERER' in request.META:
+        url = request.META['HTTP_REFERER']
+    else:
+        url = '/'
+
+    gloss = get_object_or_404(Gloss, pk=pk, archived=False)
+    try:
+        gloss.generate_stills()
+    except (PermissionError, OSError) as e:
+        feedback_message = getattr(e, 'message', repr(e))
+        messages.add_message(request, messages.ERROR, feedback_message)
+
+    return redirect(url)
+
+
+def save_chosen_still_for_gloss(request, pk):
+
+    gloss = get_object_or_404(Gloss, pk=pk, archived=False)
+    redirect_url = reverse('dictionary:admin_gloss_view', kwargs={'pk': pk})
+
+    imagepath = request.POST.get('imagepath', '')
+    if not imagepath:
+        return JsonResponse({'redirect_url': redirect_url})
+
+    image_location = os.path.join(WRITABLE_FOLDER, imagepath)
+    dataset_folder = gloss.lemma.dataset.acronym
+    idgloss = gloss.idgloss
+    two_char_folder = get_two_letter_dir(idgloss)
+
+    vfile_name = idgloss + '-' + str(gloss.id) + '.png'
+    still_goal_location = os.path.join(WRITABLE_FOLDER, GLOSS_IMAGE_DIRECTORY, dataset_folder, two_char_folder, vfile_name)
+    try:
+        if os.path.exists(still_goal_location):
+            os.remove(still_goal_location)
+        os.rename(image_location, still_goal_location)
+    except (PermissionError, OSError) as e:
+        feedback_message = getattr(e, 'message', repr(e))
+        messages.add_message(request, messages.ERROR, feedback_message)
+
+    # clean up the unused image files
+    from signbank.video.models import GlossVideo
+    glossvideo = GlossVideo.objects.filter(gloss=gloss, glossvideonme=None, glossvideoperspective=None, version=0).first()
+    if glossvideo:
+        glossvideo.delete_image_sequence()
+
+    return JsonResponse({'redirect_url': redirect_url})
+
+
 def add_image(request):
 
     if 'HTTP_REFERER' in request.META:

signbank/video/convertvideo.py

@@ -121,6 +121,53 @@ def probe_format(file):
     return r['inputvideoformat']
 
 
+def generate_image_sequence(sourcefile):
+    basename, _ = os.path.splitext(sourcefile.path)
+    temp_location_frames = os.path.join(settings.WRITABLE_FOLDER,
+                                        settings.GLOSS_IMAGE_DIRECTORY, "signbank-thumbnail-frames")
+    filename, ext = os.path.splitext(os.path.basename(sourcefile.name))
+    filename = filename.replace(' ', '_')
+    folder_name, _ = os.path.splitext(filename)
+    temp_video_frames_folder = os.path.join(temp_location_frames, folder_name)
+    # Create the necessary subfolder if needed
+    if not os.path.isdir(temp_location_frames):
+        os.mkdir(temp_location_frames)
+    if not os.path.isdir(temp_video_frames_folder):
+        os.mkdir(temp_video_frames_folder)
+    else:
+        # remove old files before generating again
+        stills_pattern = temp_video_frames_folder + "/*.png"
+        for f in glob.glob(stills_pattern):
+            os.remove(f)
+    (
+        ffmpeg
+        .input(sourcefile.path, ss=1)
+        .filter('fps', fps=15, round='up')
+        .output("%s/%s-%%04d.png" % (temp_video_frames_folder, folder_name), **{'qscale:v': 2})
+        .run(quiet=True)
+    )
+    stills = []
+    for filename in os.listdir(temp_video_frames_folder):
+        still_path = os.path.join(temp_video_frames_folder, filename)
+        stills.append(still_path)
+
+    return stills
+
+
+def remove_stills(sourcefile):
+    basename, _ = os.path.splitext(sourcefile.path)
+    temp_location_frames = os.path.join(settings.WRITABLE_FOLDER,
+                                        settings.GLOSS_IMAGE_DIRECTORY, "signbank-thumbnail-frames")
+    filename, ext = os.path.splitext(os.path.basename(sourcefile.name))
+    filename = filename.replace(' ', '_')
+    folder_name, _ = os.path.splitext(filename)
+    temp_video_frames_folder = os.path.join(temp_location_frames, folder_name)
+    # remove the temp files
+    stills_pattern = temp_video_frames_folder+"/*.png"
+    for f in glob.glob(stills_pattern):
+        os.remove(f)
+
+
 def make_thumbnail_video(sourcefile, targetfile):
     # this method is not called (need to move temp files to /tmp instead)
     # this function also works on source quicktime videos