Resources.ByType for video files?

martignoni · October 15, 2019, 7:27pm

This

{{ $poster := ((.Page.Resources.ByType "image").GetMatch (printf "%s*" $src)) }}

works very well, but

{{ $video := ((.Page.Resources.ByType "video").GetMatch (printf "%s*" $src)) }}

returns nothing, even when video files are present. Any ideas?

Bonus point (didn’t find in the doc): what file types can be found by ByType?

alexandros · October 15, 2019, 8:28pm

I don’t think that "video" is a media type that is currently recognized by Hugo with .Page.Resources.ByType.

But you may get a video by using a glob to check for the file extension by using resources.Match/GetMatch/Get as described over here

bep · October 15, 2019, 8:34pm

So, Type is the main value in the MIME type, e.g. image/png=> image…

So, by default, this is the list:

github.com

gohugoio/hugo/blob/master/media/mediaType.go#L125


	}
	if len(m.Suffixes) > 0 {
		return m.Suffixes[0]
	}
	// There are MIME types without file suffixes.
	return ""
}


// Definitions from https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types etc.
// Note that from Hugo 0.44 we only set Suffix if it is part of the MIME type.
var (
	CalendarType   = Type{MainType: "text", SubType: "calendar", Suffixes: []string{"ics"}, Delimiter: defaultDelimiter}
	CSSType        = Type{MainType: "text", SubType: "css", Suffixes: []string{"css"}, Delimiter: defaultDelimiter}
	SCSSType       = Type{MainType: "text", SubType: "x-scss", Suffixes: []string{"scss"}, Delimiter: defaultDelimiter}
	SASSType       = Type{MainType: "text", SubType: "x-sass", Suffixes: []string{"sass"}, Delimiter: defaultDelimiter}
	CSVType        = Type{MainType: "text", SubType: "csv", Suffixes: []string{"csv"}, Delimiter: defaultDelimiter}
	HTMLType       = Type{MainType: "text", SubType: "html", Suffixes: []string{"html"}, Delimiter: defaultDelimiter}
	JavascriptType = Type{MainType: "application", SubType: "javascript", Suffixes: []string{"js"}, Delimiter: defaultDelimiter}
	JSONType       = Type{MainType: "application", SubType: "json", Suffixes: []string{"json"}, Delimiter: defaultDelimiter}
	RSSType        = Type{MainType: "application", SubType: "rss", mimeSuffix: "xml", Suffixes: []string{"xml"}, Delimiter: defaultDelimiter}
	XMLType        = Type{MainType: "application", SubType: "xml", Suffixes: []string{"xml"}, Delimiter: defaultDelimiter}

(we do fall back on Go’s MIME registry for the unknowns)

As you see, not much video in that list. But you can add or modify these MIME type definitions in your site configuration.

bep · October 15, 2019, 8:40pm

Also, as discussed in another thead, if you know the file extensions you can do pattern matching.

martignoni · October 15, 2019, 8:43pm

This is what I did, and found a workaround missing video MIME types like this:

github.com

martignoni/hugo-video/blob/b3a4903ae9954613f362b9d2e4ba61ad16853160/layouts/shortcodes/video.html#L25-L37


{{/* Find in page bundle all valid video files with matching name */}}
{{ with $video_files }}
  {{ range . }}
    {{ if (in .MediaType.Suffixes "mp4") }}
      {{ $video_mp4 = . }}
    {{ end }}
    {{ if (in .MediaType.Suffixes "webm") }}
      {{ $video_webm = . }}
    {{ end }}
    {{ if (in .MediaType.Suffixes "ogv") }}
      {{ $video_ogg = . }}
    {{ end }}
  {{ end }}

But I didn’t thought of adding new MIME types in config.

martignoni · October 15, 2019, 8:45pm

Thanks, didn’t think of this.

However, adding some basic video MIME types could be useful for generic videos shortcodes. Any chance a PR for this would be accepted?

bep · October 15, 2019, 8:56pm

It would if we could agree on the scope: The video format world seems even more confusing than images; and the current built-ins are more or less the formats that Hugo deals with on some level, so if we add video to the mix it should be the top 3 MIME types or something.

martignoni · October 15, 2019, 9:03pm

Indeed. I thought about those listed here:

Extension	Description	MIME type
.avi	AVI: Audio Video Interleave	video/x-msvideo
.mpeg	MPEG Video	video/mpeg
.ogv	OGG video	video/ogg
.webm	WEBM video	video/webm
.3gp	3GPP audio/video container	video/3gpp

bep · October 15, 2019, 9:11pm

Yes, that looks reasonable. Also note they also need to be put into the DefaultMediaTypes slice below their definition.

martignoni · October 16, 2019, 2:50pm