8156742544

Committed 05 Mar 2024 01:03PM UTC coverage: 69.889% (-0.3%) from 70.212%

Build # 8156742544

Build Type

push

github

Committed by

web-flow

Commit Message

Merge pull request #1054 from EsupPortail/develop

[DONE] Develop #3.5.1

Run Details

281 of 580 new or added lines in 23 files covered. (48.45%)

19 existing lines in 11 files now uncovered.

9911 of 14181 relevant lines covered (69.89%)

0.7 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

73.21

/pod/video_encode_transcript/encode.py

"""Esup-Pod module to handle video encoding with CPU."""

from django.conf import settings
from webpush.models import PushInformation

from pod.video.models import Video
from .Encoding_video_model import Encoding_video_model
from .encoding_studio import encode_video_studio
from .models import EncodingLog

from pod.cut.models import CutVideo
from pod.dressing.models import Dressing
from pod.dressing.utils import get_dressing_input
from pod.main.tasks import task_start_encode, task_start_encode_studio
from .encoding_settings import FFMPEG_DRESSING_INPUT
from .utils import (
    change_encoding_step,
    check_file,
    add_encoding_log,
    send_email,
    send_email_encoding,
    send_notification_encoding,
    time_to_seconds,
)
import logging
import time
import threading

__license__ = "LGPL v3"
log = logging.getLogger(__name__)

USE_TRANSCRIPTION = getattr(settings, "USE_TRANSCRIPTION", False)
USE_NOTIFICATIONS = getattr(settings, "USE_NOTIFICATIONS", True)
if USE_TRANSCRIPTION:
    from . import transcript

    TRANSCRIPT_VIDEO = getattr(settings, "TRANSCRIPT_VIDEO", "start_transcript")

CELERY_TO_ENCODE = getattr(settings, "CELERY_TO_ENCODE", False)
EMAIL_ON_ENCODING_COMPLETION = getattr(settings, "EMAIL_ON_ENCODING_COMPLETION", True)

USE_REMOTE_ENCODING_TRANSCODING = getattr(
    settings, "USE_REMOTE_ENCODING_TRANSCODING", False
)
if USE_REMOTE_ENCODING_TRANSCODING:
    from .encoding_tasks import start_encoding_task

FFMPEG_DRESSING_INPUT = getattr(settings, "FFMPEG_DRESSING_INPUT", FFMPEG_DRESSING_INPUT)

# ##########################################################################
# ENCODE VIDEO: THREAD TO LAUNCH ENCODE
# ##########################################################################

# Disable for the moment, will be reactivated in future version
"""
def start_remote_encode(video_id: int):
    # load module here to prevent circular import
    from .remote_encode import remote_encode_video

    log.info("START ENCODE VIDEO ID %s" % video_id)
    t = threading.Thread(target=remote_encode_video, args=[video_id])
    t.setDaemon(True)
    t.start()
"""


def start_encode(video_id: int, threaded=True):
    """Start local encoding."""
    if threaded:
        if CELERY_TO_ENCODE:
            task_start_encode.delay(video_id)
        else:
            log.info("START ENCODE VIDEO ID %s" % video_id)
            t = threading.Thread(target=encode_video, args=[video_id])
            t.setDaemon(True)
            t.start()
    else:
        encode_video(video_id)


def start_encode_studio(recording_id, video_output, videos, subtime, presenter):
    """Start local encoding."""
    if CELERY_TO_ENCODE:
        task_start_encode_studio.delay(
            recording_id, video_output, videos, subtime, presenter
        )
    else:
        log.info("START ENCODE VIDEO ID %s" % recording_id)
        t = threading.Thread(
            target=encode_video_studio,
            args=[recording_id, video_output, videos, subtime, presenter],
        )
        t.setDaemon(True)
        t.start()


"""
def start_studio_remote_encode(recording_id, video_output, videos, subtime, presenter):
    # load module here to prevent circular import
    from .remote_encode import remote_encode_studio

    log.info("START ENCODE RECORDING ID %s" % recording_id)
    t = threading.Thread(
        target=remote_encode_studio,
        args=[recording_id, video_output, videos, subtime, presenter],
    )
    t.setDaemon(True)
    t.start()
"""


def encode_video(video_id: int) -> None:
    """ENCODE VIDEO: MAIN FUNCTION."""
    start = "Start at: %s" % time.ctime()

    video_to_encode = Video.objects.get(id=video_id)
    video_to_encode.encoding_in_progress = True
    video_to_encode.save()

    if not check_file(video_to_encode.video.path):
        msg = "Wrong file or path:\n%s" % video_to_encode.video.path
        add_encoding_log(video_id, msg)
        change_encoding_step(video_id, -1, msg)
        send_email(msg, video_id)
        return

    change_encoding_step(video_id, 0, "start")
    # start and stop cut ?
    encoding_video = get_encoding_video(video_to_encode)
    encoding_video.add_encoding_log("start_time", "", True, start)
    change_encoding_step(video_id, 1, "remove old data")
    encoding_video.remove_old_data()

    change_encoding_step(video_id, 2, "start encoding")
    if USE_REMOTE_ENCODING_TRANSCODING:
        dressing = None
        dressing_input = ""
        if Dressing.objects.filter(videos=video_to_encode).exists():
            dressing = Dressing.objects.get(videos=video_to_encode).to_json()
            if dressing:
                dressing_input = get_dressing_input(dressing, FFMPEG_DRESSING_INPUT)
        start_encoding_task.delay(
            encoding_video.id,
            encoding_video.video_file,
            encoding_video.cutting_start,
            encoding_video.cutting_stop,
            json_dressing=dressing,
            dressing_input=dressing_input,
        )
    else:
        encoding_video.start_encode()
        final_video = store_encoding_info(video_id, encoding_video)

        if encoding_video.error_encoding:
            enc_log, created = EncodingLog.objects.get_or_create(video=final_video)
            msg = "Error during video `%s` encoding." % video_id
            if created is False:
                msg += " See log at:\n%s" % enc_log.logfile.url

            send_email(msg, video_id)
        else:
            end_of_encoding(final_video)


def store_encoding_info(video_id: int, encoding_video: Encoding_video_model) -> Video:
    """Store all encoding file and informations from encoding tasks."""
    change_encoding_step(video_id, 3, "store encoding info")
    final_video = encoding_video.store_json_info()
    final_video.is_video = final_video.get_video_m4a() is None
    final_video.encoding_in_progress = False
    final_video.save()
    return final_video


def get_encoding_video(video_to_encode: Video) -> Encoding_video_model:
    """Get the encoding video object from video."""
    dressing = None
    dressing_input = ""
    if Dressing.objects.filter(videos=video_to_encode).exists():
        dressing = Dressing.objects.get(videos=video_to_encode).to_json()
        if dressing:
            dressing_input = get_dressing_input(dressing, FFMPEG_DRESSING_INPUT)

    if CutVideo.objects.filter(video=video_to_encode).exists():
        cut = CutVideo.objects.get(video=video_to_encode)
        cut_start = time_to_seconds(cut.start)
        cut_end = time_to_seconds(cut.end)
        encoding_video = Encoding_video_model(
            video_to_encode.id,
            video_to_encode.video.path,
            cut_start,
            cut_end,
            json_dressing=dressing,
            dressing_input=dressing_input,
        )
        return encoding_video

    return Encoding_video_model(
        video_to_encode.id,
        video_to_encode.video.path,
        0,
        0,
        json_dressing=dressing,
        dressing_input=dressing_input,
    )


def end_of_encoding(video: Video):
    """Notify user at the end of encoding & call transcription."""
    if (
        USE_NOTIFICATIONS
        and video.owner.owner.accepts_notifications
        and PushInformation.objects.filter(user=video.owner).exists()
    ):
        send_notification_encoding(video)
    if EMAIL_ON_ENCODING_COMPLETION:
        send_email_encoding(video)

    transcript_video(video.id)
    change_encoding_step(video.id, 0, "end of encoding")


def transcript_video(video_id: int):
    """Transcript video audio to text."""
    video = Video.objects.get(id=video_id)
    if USE_TRANSCRIPTION and video.transcript not in ["", "0", "1"]:
        change_encoding_step(video_id, 4, "transcript video")
        start_transcript_video = getattr(transcript, TRANSCRIPT_VIDEO)
        start_transcript_video(video_id, False)

1	"""Esup-Pod module to handle video encoding with CPU."""
2
3	from django.conf import settings	1✔
4	from webpush.models import PushInformation	1✔
5
6	from pod.video.models import Video	1✔
7	from .Encoding_video_model import Encoding_video_model	1✔
8	from .encoding_studio import encode_video_studio	1✔
9	from .models import EncodingLog	1✔
10
11	from pod.cut.models import CutVideo	1✔
12	from pod.dressing.models import Dressing	1✔
13	from pod.dressing.utils import get_dressing_input	1✔
14	from pod.main.tasks import task_start_encode, task_start_encode_studio	1✔
15	from .encoding_settings import FFMPEG_DRESSING_INPUT	1✔
16	from .utils import (	1✔
17	change_encoding_step,
18	check_file,
19	add_encoding_log,
20	send_email,
21	send_email_encoding,
22	send_notification_encoding,
23	time_to_seconds,
24	)
25	import logging	1✔
26	import time	1✔
27	import threading	1✔
28
29	__license__ = "LGPL v3"	1✔
30	log = logging.getLogger(__name__)	1✔
31
32	USE_TRANSCRIPTION = getattr(settings, "USE_TRANSCRIPTION", False)	1✔
33	USE_NOTIFICATIONS = getattr(settings, "USE_NOTIFICATIONS", True)	1✔
34	if USE_TRANSCRIPTION:	1✔
35	from . import transcript	×
36
37	TRANSCRIPT_VIDEO = getattr(settings, "TRANSCRIPT_VIDEO", "start_transcript")	×
38
39	CELERY_TO_ENCODE = getattr(settings, "CELERY_TO_ENCODE", False)	1✔
40	EMAIL_ON_ENCODING_COMPLETION = getattr(settings, "EMAIL_ON_ENCODING_COMPLETION", True)	1✔
41
42	USE_REMOTE_ENCODING_TRANSCODING = getattr(	1✔
43	settings, "USE_REMOTE_ENCODING_TRANSCODING", False
44	)
45	if USE_REMOTE_ENCODING_TRANSCODING:	1✔
46	from .encoding_tasks import start_encoding_task	×
47
48	FFMPEG_DRESSING_INPUT = getattr(settings, "FFMPEG_DRESSING_INPUT", FFMPEG_DRESSING_INPUT)	1✔
49
50	# ##########################################################################
51	# ENCODE VIDEO: THREAD TO LAUNCH ENCODE
52	# ##########################################################################
53
54	# Disable for the moment, will be reactivated in future version
55	"""
56	def start_remote_encode(video_id: int):
57	# load module here to prevent circular import
58	from .remote_encode import remote_encode_video
59
60	log.info("START ENCODE VIDEO ID %s" % video_id)
61	t = threading.Thread(target=remote_encode_video, args=[video_id])
62	t.setDaemon(True)
63	t.start()
64	"""
65
66
67	def start_encode(video_id: int, threaded=True):	1✔
68	"""Start local encoding."""
69	if threaded:	1✔
70	if CELERY_TO_ENCODE:	1✔
71	task_start_encode.delay(video_id)	×
72	else:
73	log.info("START ENCODE VIDEO ID %s" % video_id)	1✔
74	t = threading.Thread(target=encode_video, args=[video_id])	1✔
75	t.setDaemon(True)	1✔
76	t.start()	1✔
77	else:
78	encode_video(video_id)	×
79
80
81	def start_encode_studio(recording_id, video_output, videos, subtime, presenter):	1✔
82	"""Start local encoding."""
83	if CELERY_TO_ENCODE:	×
84	task_start_encode_studio.delay(	×
85	recording_id, video_output, videos, subtime, presenter
86	)
87	else:
88	log.info("START ENCODE VIDEO ID %s" % recording_id)	×
89	t = threading.Thread(	×
90	target=encode_video_studio,
91	args=[recording_id, video_output, videos, subtime, presenter],
92	)
93	t.setDaemon(True)	×
94	t.start()	×
95
96
97	"""
98	def start_studio_remote_encode(recording_id, video_output, videos, subtime, presenter):
99	# load module here to prevent circular import
100	from .remote_encode import remote_encode_studio
101
102	log.info("START ENCODE RECORDING ID %s" % recording_id)
103	t = threading.Thread(
104	target=remote_encode_studio,
105	args=[recording_id, video_output, videos, subtime, presenter],
106	)
107	t.setDaemon(True)
108	t.start()
109	"""
110
111
112	def encode_video(video_id: int) -> None:	1✔
113	"""ENCODE VIDEO: MAIN FUNCTION."""
114	start = "Start at: %s" % time.ctime()	1✔
115
116	video_to_encode = Video.objects.get(id=video_id)	1✔
117	video_to_encode.encoding_in_progress = True	1✔
118	video_to_encode.save()	1✔
119
120	if not check_file(video_to_encode.video.path):	1✔
121	msg = "Wrong file or path:\n%s" % video_to_encode.video.path	1✔
122	add_encoding_log(video_id, msg)	1✔
123	change_encoding_step(video_id, -1, msg)	1✔
124	send_email(msg, video_id)	1✔
125	return	1✔
126
127	change_encoding_step(video_id, 0, "start")	1✔
128	# start and stop cut ?
129	encoding_video = get_encoding_video(video_to_encode)	1✔
130	encoding_video.add_encoding_log("start_time", "", True, start)	1✔
131	change_encoding_step(video_id, 1, "remove old data")	1✔
132	encoding_video.remove_old_data()	1✔
133
134	change_encoding_step(video_id, 2, "start encoding")	1✔
135	if USE_REMOTE_ENCODING_TRANSCODING:	1✔
NEW 136	dressing = None	×
NEW 137	dressing_input = ""	×
NEW 138	if Dressing.objects.filter(videos=video_to_encode).exists():	×
NEW 139	dressing = Dressing.objects.get(videos=video_to_encode).to_json()	×
NEW 140	if dressing:	×
NEW 141	dressing_input = get_dressing_input(dressing, FFMPEG_DRESSING_INPUT)	×
UNCOV 142	start_encoding_task.delay(	×
143	encoding_video.id,
144	encoding_video.video_file,
145	encoding_video.cutting_start,
146	encoding_video.cutting_stop,
147	json_dressing=dressing,
148	dressing_input=dressing_input,
149	)
150	else:
151	encoding_video.start_encode()	1✔
152	final_video = store_encoding_info(video_id, encoding_video)	1✔
153
154	if encoding_video.error_encoding:	1✔
155	enc_log, created = EncodingLog.objects.get_or_create(video=final_video)	1✔
156	msg = "Error during video `%s` encoding." % video_id	1✔
157	if created is False:	1✔
158	msg += " See log at:\n%s" % enc_log.logfile.url	1✔
159
160	send_email(msg, video_id)	1✔
161	else:
162	end_of_encoding(final_video)	1✔
163
164
165	def store_encoding_info(video_id: int, encoding_video: Encoding_video_model) -> Video:	1✔
166	"""Store all encoding file and informations from encoding tasks."""
167	change_encoding_step(video_id, 3, "store encoding info")	1✔
168	final_video = encoding_video.store_json_info()	1✔
169	final_video.is_video = final_video.get_video_m4a() is None	1✔
170	final_video.encoding_in_progress = False	1✔
171	final_video.save()	1✔
172	return final_video	1✔
173
174
175	def get_encoding_video(video_to_encode: Video) -> Encoding_video_model:	1✔
176	"""Get the encoding video object from video."""
177	dressing = None	1✔
178	dressing_input = ""	1✔
179	if Dressing.objects.filter(videos=video_to_encode).exists():	1✔
NEW 180	dressing = Dressing.objects.get(videos=video_to_encode).to_json()	×
NEW 181	if dressing:	×
NEW 182	dressing_input = get_dressing_input(dressing, FFMPEG_DRESSING_INPUT)	×
183
184	if CutVideo.objects.filter(video=video_to_encode).exists():	1✔
185	cut = CutVideo.objects.get(video=video_to_encode)	×
186	cut_start = time_to_seconds(cut.start)	×
187	cut_end = time_to_seconds(cut.end)	×
188	encoding_video = Encoding_video_model(	×
189	video_to_encode.id,
190	video_to_encode.video.path,
191	cut_start,
192	cut_end,
193	json_dressing=dressing,
194	dressing_input=dressing_input,
195	)
196	return encoding_video	×
197
198	return Encoding_video_model(	1✔
199	video_to_encode.id,
200	video_to_encode.video.path,
201	0,
202	0,
203	json_dressing=dressing,
204	dressing_input=dressing_input,
205	)
206
207
208	def end_of_encoding(video: Video):	1✔
209	"""Notify user at the end of encoding & call transcription."""
210	if (	1✔
211	USE_NOTIFICATIONS
212	and video.owner.owner.accepts_notifications
213	and PushInformation.objects.filter(user=video.owner).exists()
214	):
215	send_notification_encoding(video)	×
216	if EMAIL_ON_ENCODING_COMPLETION:	1✔
217	send_email_encoding(video)	1✔
218
219	transcript_video(video.id)	1✔
220	change_encoding_step(video.id, 0, "end of encoding")	1✔
221
222
223	def transcript_video(video_id: int):	1✔
224	"""Transcript video audio to text."""
225	video = Video.objects.get(id=video_id)	1✔
226	if USE_TRANSCRIPTION and video.transcript not in ["", "0", "1"]:	1✔
227	change_encoding_step(video_id, 4, "transcript video")	×
228	start_transcript_video = getattr(transcript, TRANSCRIPT_VIDEO)	×
229	start_transcript_video(video_id, False)	×

EsupPortail / Esup-Pod / 8156742544

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous