Skip to content

Commit

Permalink
Full rework - WIP
Browse files Browse the repository at this point in the history
  • Loading branch information
Roman Miroshnychenko committed Jul 9, 2023
1 parent d06b57e commit 2b95291
Showing 1 changed file with 120 additions and 109 deletions.
229 changes: 120 additions & 109 deletions main.py
View file
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
# Module: main
# Author: Roman V. M.
# Created on: 28.11.2014
# License: GPL v.3 https://www.gnu.org/copyleft/gpl.html
"""
Example video plugin that is compatible with Kodi 19.x "Matrix" and above
Example video plugin that is compatible with Kodi 20.x "Nexus" and above
"""
import sys
from urllib.parse import urlencode, parse_qsl

import xbmcgui
import xbmcplugin

Expand All @@ -15,49 +14,64 @@
# Get the plugin handle as an integer number.
_HANDLE = int(sys.argv[1])

# Free sample videos are provided by www.vidsplay.com
# Here we use a fixed set of properties simply for demonstrating purposes
# Public domain movies are from https://publicdomainmovie.net
# Here we use a hardcoded list of movies simply for demonstrating purposes
# In a "real life" plugin you will need to get info and links to video files/streams
# from some web-site or online service.
VIDEOS = {'Animals': [{'name': 'Crab',
'thumb': 'http://www.vidsplay.com/wp-content/uploads/2017/04/crab-screenshot.jpg',
'video': 'http://www.vidsplay.com/wp-content/uploads/2017/04/crab.mp4',
'genre': 'Animals'},
{'name': 'Alligator',
'thumb': 'http://www.vidsplay.com/wp-content/uploads/2017/04/alligator-screenshot.jpg',
'video': 'http://www.vidsplay.com/wp-content/uploads/2017/04/alligator.mp4',
'genre': 'Animals'},
{'name': 'Turtle',
'thumb': 'http://www.vidsplay.com/wp-content/uploads/2017/04/turtle-screenshot.jpg',
'video': 'http://www.vidsplay.com/wp-content/uploads/2017/04/turtle.mp4',
'genre': 'Animals'}
],
'Cars': [{'name': 'Postal Truck',
'thumb': 'http://www.vidsplay.com/wp-content/uploads/2017/05/us_postal-screenshot.jpg',
'video': 'http://www.vidsplay.com/wp-content/uploads/2017/05/us_postal.mp4',
'genre': 'Cars'},
{'name': 'Traffic',
'thumb': 'http://www.vidsplay.com/wp-content/uploads/2017/05/traffic1-screenshot.jpg',
'video': 'http://www.vidsplay.com/wp-content/uploads/2017/05/traffic1.mp4',
'genre': 'Cars'},
{'name': 'Traffic Arrows',
'thumb': 'http://www.vidsplay.com/wp-content/uploads/2017/05/traffic_arrows-screenshot.jpg',
'video': 'http://www.vidsplay.com/wp-content/uploads/2017/05/traffic_arrows.mp4',
'genre': 'Cars'}
],
'Food': [{'name': 'Chicken',
'thumb': 'http://www.vidsplay.com/wp-content/uploads/2017/05/bbq_chicken-screenshot.jpg',
'video': 'http://www.vidsplay.com/wp-content/uploads/2017/05/bbqchicken.mp4',
'genre': 'Food'},
{'name': 'Hamburger',
'thumb': 'http://www.vidsplay.com/wp-content/uploads/2017/05/hamburger-screenshot.jpg',
'video': 'http://www.vidsplay.com/wp-content/uploads/2017/05/hamburger.mp4',
'genre': 'Food'},
{'name': 'Pizza',
'thumb': 'http://www.vidsplay.com/wp-content/uploads/2017/05/pizza-screenshot.jpg',
'video': 'http://www.vidsplay.com/wp-content/uploads/2017/05/pizza.mp4',
'genre': 'Food'}
]}
# from some website or online service.
VIDEOS = [
{
'genre': 'Drama',
'icon': '',
'movies': [
{
'title': 'The Stranger',
'url': 'https://ia800908.us.archive.org/30/items/TheStranger_0/The_Stranger_512kb.mp4',
'poster': 'https://publicdomainmovie.net/wikimedia.php?id=Movie-Mystery-Magazine-July-1946.jpg',
'plot': 'In 1946, Mr. Wilson (Edward G. Robinson) of the United Nations War Crimes Commission is hunting for '
'a Nazism fugitive Franz Kindler (Orson Welles), a war criminal who has erased all evidence which '
'might identify him. Kindler has assumed a new identity, Charles Rankin, '
'and has become a University-preparatory school#United States and Canada teacher '
'in a small town in the United States. ',
'year': 1946,
},
{
'title': 'The Iron Mask',
'url': 'https://ia600702.us.archive.org/3/items/iron_mask/iron_mask_512kb.mp4',
'poster': 'https://publicdomainmovie.net/wikimedia.php?id=Ironmaskposter.jpg',
'plot': 'The Iron Mask is a 1929 American part-talkie adventure film directed by Allan Dwan. '
'It is an adaptation of the last section of the novel The Vicomte de Bragelonne by '
'Alexandre Dumas, père, which is itself based on the French legend of The Man in the Iron Mask.',
'year': 1929,
},
{
'title': 'Meet John Doe',
'url': 'https://ia804707.us.archive.org/30/items/meet_john_doe_ipod/video_512kb.mp4',
'poster': 'https://publicdomainmovie.net/wikimedia.php?id=Poster_-_Meet_John_Doe_01.jpg',
'plot': 'Meet John Doe is a 1941 in film United States comedy film drama film film directed and produced '
'by Frank Capra, and starring Gary Cooper and Barbara Stanwyck. The film is about a "grassroots" '
'political campaign created unwittingly by a newspaper columnist and pursued by a wealthy businessman.',
'year': 1941,
},
],
},
{
'genre': 'Horror',
'icon': '',
'movies': [
{
'title': 'House on Haunted Hill',
'url': 'https://ia800203.us.archive.org/18/items/house_on_haunted_hill_ipod/house_on_haunted_hill_512kb.mp4',
'poster': 'https://publicdomainmovie.net/wikimedia.php?id=House_on_Haunted_Hill.jpg',
'plot': 'Eccentric millionaire Frederick Loren (Vincent Price) invites five people to a "party" '
'he is throwing for his fourth wife, Annabelle (Carol Ohmart), '
'in an allegedly haunted house he has rented, promising to give them each $10,000 '
'with the stipulation that they must stay the entire night in the house after '
'the doors are locked at midnight.',
'year': 1959,
},
],
},
]


def get_url(**kwargs):
Expand All @@ -71,119 +85,115 @@ def get_url(**kwargs):
return '{}?{}'.format(_URL, urlencode(kwargs))


def get_categories():
def get_genres():
"""
Get the list of video categories.
Here you can insert some parsing code that retrieves
the list of video categories (e.g. 'Movies', 'TV-shows', 'Documentaries' etc.)
from some site or API.
Get the list of video genres
.. note:: Consider using `generator functions <https://wiki.python.org/moin/Generators>`_
instead of returning lists.
Here you can insert some code that retrieves
the list of video sections (in this case movie genres) from some site or API.
:return: The list of video categories
:rtype: types.GeneratorType
:return: The list of video genres
:rtype: list
"""
return VIDEOS.keys()
return VIDEOS


def get_videos(category):
def get_videos(genre_index):
"""
Get the list of videofiles/streams.
Here you can insert some parsing code that retrieves
the list of video streams in the given category from some site or API.
.. note:: Consider using `generators functions <https://wiki.python.org/moin/Generators>`_
instead of returning lists.
Here you can insert some code that retrieves
the list of video streams in the given section from some site or API.
:param category: Category name
:type category: str
:param genre_index: genre index
:type genre_index: int
:return: the list of videos in the category
:rtype: list
"""
return VIDEOS[category]
return VIDEOS[genre_index]


def list_categories():
def list_genres():
"""
Create the list of video categories in the Kodi interface.
Create the list of movie genres in the Kodi interface.
"""
# Set plugin category. It is displayed in some skins as the name
# of the current section.
xbmcplugin.setPluginCategory(_HANDLE, 'My Video Collection')
xbmcplugin.setPluginCategory(_HANDLE, 'Public Domain Movies')
# Set plugin content. It allows Kodi to select appropriate views
# for this type of content.
xbmcplugin.setContent(_HANDLE, 'videos')
# Get video categories
categories = get_categories()
# Iterate through categories
for category in categories:
xbmcplugin.setContent(_HANDLE, 'movies')
# Get movie genres
genres = get_genres()
# Iterate through genres
for index, genre in enumerate(genres):
# Create a list item with a text label and a thumbnail image.
list_item = xbmcgui.ListItem(label=category)
# Set graphics (thumbnail, fanart, banner, poster, landscape etc.) for the list item.
# Here we use the same image for all items for simplicity's sake.
# In a real-life plugin you need to set each image accordingly.
list_item.setArt({'thumb': VIDEOS[category][0]['thumb'],
'icon': VIDEOS[category][0]['thumb'],
'fanart': VIDEOS[category][0]['thumb']})
# Set additional info for the list item.
# Here we use a category name for both properties for for simplicity's sake.
# setInfo allows to set various information for an item.
# For available properties see the following link:
# https://codedocs.xyz/xbmc/xbmc/group__python__xbmcgui__listitem.html#ga0b71166869bda87ad744942888fb5f14
list_item = xbmcgui.ListItem(label=genre['genre'])
# Set additional info for the list item using its InfoTag.
# Here we use a category name for both properties for simplicity's sake.
# InfoTag allows to set various information for an item.
# For available properties and methods see the following link:
# https://codedocs.xyz/xbmc/xbmc/classXBMCAddon_1_1xbmc_1_1InfoTagVideo.html
# 'mediatype' is needed for a skin to display info for this ListItem correctly.
list_item.setInfo('video', {'title': category,
'genre': category,
'mediatype': 'video'})
info_tag = list_item.getVideoInfoTag()
info_tag.setMediaType('video')
info_tag.setTitle(genre)
info_tag.setGenres([genre])
# Set icon for the list item.
# addAvailableArtwork() method can be used to add different types of images: poster, fanart, etc.
info_tag.addAvailableArtwork(genre['icon'], 'icon')
# Create a URL for a plugin recursive call.
# Example: plugin://plugin.video.example/?action=listing&category=Animals
url = get_url(action='listing', category=category)
# Example: plugin://plugin.video.example/?action=listing&genre_index=0
url = get_url(action='listing', genre_index=index)
# is_folder = True means that this item opens a sub-list of lower level items.
is_folder = True
# Add our item to the Kodi virtual folder listing.
xbmcplugin.addDirectoryItem(_HANDLE, url, list_item, is_folder)
# Add a sort method for the virtual folder items (alphabetically, ignore articles)
# Add sort methods for the virtual folder items
xbmcplugin.addSortMethod(_HANDLE, xbmcplugin.SORT_METHOD_LABEL_IGNORE_THE)
xbmcplugin.addSortMethod(_HANDLE, xbmcplugin.SORT_METHOD_VIDEO_YEAR)
# Finish creating a virtual folder.
xbmcplugin.endOfDirectory(_HANDLE)


def list_videos(category):
def list_videos(genre_index):
"""
Create the list of playable videos in the Kodi interface.
:param category: Category name
:type category: str
:param genre_index: the index of genre in the list of videos
:type genre_index: int
"""
genre_info = VIDEOS[genre_index]
# Set plugin category. It is displayed in some skins as the name
# of the current section.
xbmcplugin.setPluginCategory(_HANDLE, category)
xbmcplugin.setPluginCategory(_HANDLE, genre_info['genre'])
# Set plugin content. It allows Kodi to select appropriate views
# for this type of content.
xbmcplugin.setContent(_HANDLE, 'videos')
xbmcplugin.setContent(_HANDLE, 'movies')
# Get the list of videos in the category.
videos = get_videos(category)
videos = genre_info['movies']
# Iterate through videos.
for video in videos:
# Create a list item with a text label and a thumbnail image.
list_item = xbmcgui.ListItem(label=video['name'])
# Create a list item with a text label
list_item = xbmcgui.ListItem(label=video['title'])
# Set additional info for the list item.
# 'mediatype' is needed for skin to display info for this ListItem correctly.
list_item.setInfo('video', {'title': video['name'],
'genre': video['genre'],
'mediatype': 'video'})
info_tag = list_item.getVideoInfoTag()
info_tag.setMediaType('movie')
info_tag.setTitle(video['title'])
info_tag.setGenres(genre_info['genre'])
info_tag.setPlot(video['plot'])
info_tag.setYear(video['year'])
# Set graphics (thumbnail, fanart, banner, poster, landscape etc.) for the list item.
# Here we use the same image for all items for simplicity's sake.
# In a real-life plugin you need to set each image accordingly.
list_item.setArt({'thumb': video['thumb'], 'icon': video['thumb'], 'fanart': video['thumb']})
# Here we use only for simplicity's sake.
# In a real-life plugin you may need to set multiple image types.
info_tag.addAvailableArtwork(video['poster'], 'poster')
# Set 'IsPlayable' property to 'true'.
# This is mandatory for playable items!
list_item.setProperty('IsPlayable', 'true')
# Create a URL for a plugin recursive call.
# Example: plugin://plugin.video.example/?action=play&video=http://www.vidsplay.com/wp-content/uploads/2017/04/crab.mp4
url = get_url(action='play', video=video['video'])
url = get_url(action='play', video=video['url'])
# Add the list item to a virtual Kodi folder.
# is_folder = False means that this item won't open any sub-list.
is_folder = False
Expand All @@ -203,7 +213,8 @@ def play_video(path):
:type path: str
"""
# Create a playable item with a path to play.
play_item = xbmcgui.ListItem(path=path)
play_item = xbmcgui.ListItem(offscreen=True)
play_item.setPath(path)
# Pass the item to the Kodi player.
xbmcplugin.setResolvedUrl(_HANDLE, True, listitem=play_item)

Expand All @@ -223,7 +234,7 @@ def router(paramstring):
if params:
if params['action'] == 'listing':
# Display the list of videos in a provided category.
list_videos(params['category'])
list_videos(int(params['genre_index']))
elif params['action'] == 'play':
# Play a video from a provided URL.
play_video(params['video'])
Expand All @@ -235,7 +246,7 @@ def router(paramstring):
else:
# If the plugin is called from Kodi UI without any parameters,
# display the list of video categories
list_categories()
list_genres()


if __name__ == '__main__':
Expand Down

0 comments on commit 2b95291

Please sign in to comment.