2020-10-07 03:48:43 +00:00
|
|
|
use crate::avm2::Domain as Avm2Domain;
|
2019-05-05 22:55:27 +00:00
|
|
|
use crate::backend::audio::SoundHandle;
|
2019-04-25 17:52:22 +00:00
|
|
|
use crate::character::Character;
|
2019-12-07 02:29:36 +00:00
|
|
|
use crate::display_object::TDisplayObject;
|
2020-05-19 02:12:08 +00:00
|
|
|
use crate::font::{Font, FontDescriptor};
|
2019-05-12 16:55:48 +00:00
|
|
|
use crate::prelude::*;
|
2020-10-21 23:15:09 +00:00
|
|
|
use crate::property_map::{Entry, PropertyMap};
|
2020-10-06 02:05:11 +00:00
|
|
|
use crate::tag_utils::{SwfMovie, SwfSlice};
|
2020-08-07 02:46:53 +00:00
|
|
|
use crate::vminterface::AvmType;
|
2020-10-09 01:54:51 +00:00
|
|
|
use gc_arena::{Collect, MutationContext};
|
2019-04-25 17:52:22 +00:00
|
|
|
use std::collections::HashMap;
|
2019-11-14 02:41:38 +00:00
|
|
|
use std::sync::{Arc, Weak};
|
2020-10-06 01:41:51 +00:00
|
|
|
use swf::{CharacterId, TagCode};
|
2019-11-14 02:41:38 +00:00
|
|
|
use weak_table::PtrWeakKeyHashMap;
|
2019-04-25 17:52:22 +00:00
|
|
|
|
2020-08-07 02:46:53 +00:00
|
|
|
/// Boxed error alias.
|
|
|
|
type Error = Box<dyn std::error::Error>;
|
|
|
|
|
2019-11-14 02:41:38 +00:00
|
|
|
/// Symbol library for a single given SWF.
|
2020-05-19 02:12:08 +00:00
|
|
|
#[derive(Collect)]
|
|
|
|
#[collect(no_drop)]
|
2019-11-14 02:41:38 +00:00
|
|
|
pub struct MovieLibrary<'gc> {
|
2019-05-24 17:25:03 +00:00
|
|
|
characters: HashMap<CharacterId, Character<'gc>>,
|
2020-10-21 23:15:09 +00:00
|
|
|
export_characters: PropertyMap<Character<'gc>>,
|
2019-05-03 00:17:02 +00:00
|
|
|
jpeg_tables: Option<Vec<u8>>,
|
2019-12-17 05:21:59 +00:00
|
|
|
device_font: Option<Font<'gc>>,
|
2020-05-19 02:12:08 +00:00
|
|
|
fonts: HashMap<FontDescriptor, Font<'gc>>,
|
2020-10-06 01:41:51 +00:00
|
|
|
avm_type: AvmType,
|
2020-10-09 01:54:51 +00:00
|
|
|
avm2_domain: Option<Avm2Domain<'gc>>,
|
2019-04-25 17:52:22 +00:00
|
|
|
}
|
|
|
|
|
2019-11-14 02:41:38 +00:00
|
|
|
impl<'gc> MovieLibrary<'gc> {
|
2020-10-06 01:41:51 +00:00
|
|
|
pub fn new(avm_type: AvmType) -> Self {
|
2019-11-14 02:41:38 +00:00
|
|
|
MovieLibrary {
|
2019-04-25 17:52:22 +00:00
|
|
|
characters: HashMap::new(),
|
2020-10-21 23:15:09 +00:00
|
|
|
export_characters: PropertyMap::new(),
|
2019-05-03 00:17:02 +00:00
|
|
|
jpeg_tables: None,
|
2019-10-26 06:44:12 +00:00
|
|
|
device_font: None,
|
2020-05-19 02:12:08 +00:00
|
|
|
fonts: HashMap::new(),
|
2020-10-06 01:41:51 +00:00
|
|
|
avm_type,
|
2020-10-07 03:48:43 +00:00
|
|
|
avm2_domain: None,
|
2019-04-25 17:52:22 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2019-05-24 17:25:03 +00:00
|
|
|
pub fn register_character(&mut self, id: CharacterId, character: Character<'gc>) {
|
2019-04-25 17:52:22 +00:00
|
|
|
// TODO(Herschel): What is the behavior if id already exists?
|
2019-07-19 08:32:41 +00:00
|
|
|
if !self.contains_character(id) {
|
2020-05-19 02:12:08 +00:00
|
|
|
if let Character::Font(font) = character.clone() {
|
|
|
|
self.fonts.insert(font.descriptor(), font);
|
|
|
|
}
|
|
|
|
|
2019-07-19 08:32:41 +00:00
|
|
|
self.characters.insert(id, character);
|
|
|
|
} else {
|
|
|
|
log::error!("Character ID collision: Tried to register ID {} twice", id);
|
|
|
|
}
|
2019-04-25 17:52:22 +00:00
|
|
|
}
|
|
|
|
|
2019-12-16 19:29:32 +00:00
|
|
|
/// Registers an export name for a given character ID.
|
|
|
|
/// This character will then be instantiable from AVM1.
|
|
|
|
pub fn register_export(&mut self, id: CharacterId, export_name: &str) {
|
|
|
|
if let Some(character) = self.characters.get(&id) {
|
2020-10-21 23:15:09 +00:00
|
|
|
match self.export_characters.entry(export_name, false) {
|
2019-12-16 19:29:32 +00:00
|
|
|
Entry::Vacant(e) => {
|
|
|
|
e.insert(character.clone());
|
|
|
|
}
|
|
|
|
Entry::Occupied(_) => {
|
|
|
|
log::warn!(
|
|
|
|
"Can't register export {}: Export already exists",
|
|
|
|
export_name
|
|
|
|
);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
} else {
|
|
|
|
log::warn!(
|
|
|
|
"Can't register export {}: Character ID {} doesn't exist",
|
|
|
|
export_name,
|
|
|
|
id
|
|
|
|
)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2019-04-25 17:52:22 +00:00
|
|
|
pub fn contains_character(&self, id: CharacterId) -> bool {
|
|
|
|
self.characters.contains_key(&id)
|
|
|
|
}
|
|
|
|
|
2019-12-07 02:29:36 +00:00
|
|
|
#[allow(dead_code)]
|
2019-12-16 19:29:32 +00:00
|
|
|
pub fn get_character_by_id(&self, id: CharacterId) -> Option<&Character<'gc>> {
|
2019-05-12 16:55:48 +00:00
|
|
|
self.characters.get(&id)
|
|
|
|
}
|
|
|
|
|
2019-12-07 02:29:36 +00:00
|
|
|
#[allow(dead_code)]
|
2019-12-16 19:29:32 +00:00
|
|
|
pub fn get_character_by_export_name(&self, name: &str) -> Option<&Character<'gc>> {
|
2020-10-21 23:15:09 +00:00
|
|
|
self.export_characters.get(name, false)
|
2019-05-12 16:55:48 +00:00
|
|
|
}
|
|
|
|
|
2019-12-17 07:43:30 +00:00
|
|
|
/// Instantiates the library item with the given character ID into a display object.
|
2020-01-20 21:38:23 +00:00
|
|
|
/// The object must then be post-instantiated before being used.
|
2019-12-17 11:25:52 +00:00
|
|
|
pub fn instantiate_by_id(
|
2019-04-25 17:52:22 +00:00
|
|
|
&self,
|
|
|
|
id: CharacterId,
|
2019-05-24 17:25:03 +00:00
|
|
|
gc_context: MutationContext<'gc, '_>,
|
2019-12-07 02:29:36 +00:00
|
|
|
) -> Result<DisplayObject<'gc>, Box<dyn std::error::Error>> {
|
2019-12-17 07:43:30 +00:00
|
|
|
if let Some(character) = self.characters.get(&id) {
|
2020-01-20 21:38:23 +00:00
|
|
|
self.instantiate_display_object(character, gc_context)
|
2019-12-17 07:43:30 +00:00
|
|
|
} else {
|
|
|
|
log::error!("Tried to instantiate non-registered character ID {}", id);
|
|
|
|
Err("Character id doesn't exist".into())
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Instantiates the library item with the given export name into a display object.
|
2020-01-20 21:38:23 +00:00
|
|
|
/// The object must then be post-instantiated before being used.
|
2019-12-17 07:43:30 +00:00
|
|
|
pub fn instantiate_by_export_name(
|
|
|
|
&self,
|
|
|
|
export_name: &str,
|
|
|
|
gc_context: MutationContext<'gc, '_>,
|
|
|
|
) -> Result<DisplayObject<'gc>, Box<dyn std::error::Error>> {
|
2020-10-21 23:15:09 +00:00
|
|
|
if let Some(character) = self.export_characters.get(export_name, false) {
|
2020-01-20 21:38:23 +00:00
|
|
|
self.instantiate_display_object(character, gc_context)
|
2019-12-17 07:43:30 +00:00
|
|
|
} else {
|
|
|
|
log::error!(
|
|
|
|
"Tried to instantiate non-registered character {}",
|
|
|
|
export_name
|
|
|
|
);
|
|
|
|
Err("Character id doesn't exist".into())
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Instantiates the given character into a display object.
|
2020-01-20 21:38:23 +00:00
|
|
|
/// The object must then be post-instantiated before being used.
|
2019-12-17 07:43:30 +00:00
|
|
|
fn instantiate_display_object(
|
|
|
|
&self,
|
|
|
|
character: &Character<'gc>,
|
|
|
|
gc_context: MutationContext<'gc, '_>,
|
|
|
|
) -> Result<DisplayObject<'gc>, Box<dyn std::error::Error>> {
|
2020-01-20 21:38:23 +00:00
|
|
|
match character {
|
|
|
|
Character::Bitmap(bitmap) => Ok(bitmap.instantiate(gc_context)),
|
|
|
|
Character::EditText(edit_text) => Ok(edit_text.instantiate(gc_context)),
|
|
|
|
Character::Graphic(graphic) => Ok(graphic.instantiate(gc_context)),
|
|
|
|
Character::MorphShape(morph_shape) => Ok(morph_shape.instantiate(gc_context)),
|
|
|
|
Character::MovieClip(movie_clip) => Ok(movie_clip.instantiate(gc_context)),
|
|
|
|
Character::Button(button) => Ok(button.instantiate(gc_context)),
|
|
|
|
Character::Text(text) => Ok(text.instantiate(gc_context)),
|
|
|
|
_ => Err("Not a DisplayObject".into()),
|
|
|
|
}
|
2019-04-25 17:52:22 +00:00
|
|
|
}
|
2019-05-03 00:17:02 +00:00
|
|
|
|
2019-12-17 05:21:59 +00:00
|
|
|
pub fn get_font(&self, id: CharacterId) -> Option<Font<'gc>> {
|
|
|
|
if let Some(&Character::Font(font)) = self.characters.get(&id) {
|
2019-05-04 18:45:11 +00:00
|
|
|
Some(font)
|
|
|
|
} else {
|
|
|
|
None
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2020-05-19 02:12:08 +00:00
|
|
|
/// Find a font by it's name and parameters.
|
|
|
|
pub fn get_font_by_name(
|
|
|
|
&self,
|
|
|
|
name: &str,
|
|
|
|
is_bold: bool,
|
|
|
|
is_italic: bool,
|
|
|
|
) -> Option<Font<'gc>> {
|
|
|
|
let descriptor = FontDescriptor::from_parts(name, is_bold, is_italic);
|
|
|
|
|
|
|
|
self.fonts.get(&descriptor).copied()
|
2020-05-16 17:04:35 +00:00
|
|
|
}
|
|
|
|
|
2019-05-05 22:55:27 +00:00
|
|
|
pub fn get_sound(&self, id: CharacterId) -> Option<SoundHandle> {
|
|
|
|
if let Some(Character::Sound(sound)) = self.characters.get(&id) {
|
|
|
|
Some(*sound)
|
|
|
|
} else {
|
|
|
|
None
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2019-05-03 00:17:02 +00:00
|
|
|
pub fn set_jpeg_tables(&mut self, data: Vec<u8>) {
|
2019-11-11 21:37:22 +00:00
|
|
|
if self.jpeg_tables.is_some() {
|
|
|
|
// SWF spec says there should only be one JPEGTables tag.
|
|
|
|
// TODO: What is the behavior when there are multiples?
|
|
|
|
log::warn!("SWF contains multiple JPEGTables tags");
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
// Some SWFs have a JPEGTables tag with 0 length; ignore these.
|
|
|
|
// (Does this happen when there is only a single DefineBits tag?)
|
|
|
|
self.jpeg_tables = if data.is_empty() {
|
|
|
|
None
|
|
|
|
} else {
|
|
|
|
Some(crate::backend::render::remove_invalid_jpeg_data(&data[..]).to_vec())
|
|
|
|
}
|
2019-05-03 00:17:02 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
pub fn jpeg_tables(&self) -> Option<&[u8]> {
|
|
|
|
self.jpeg_tables.as_ref().map(|data| &data[..])
|
|
|
|
}
|
2019-05-24 17:25:03 +00:00
|
|
|
|
2019-10-08 04:02:09 +00:00
|
|
|
/// Returns the device font for use when a font is unavailable.
|
2019-12-17 05:21:59 +00:00
|
|
|
pub fn device_font(&self) -> Option<Font<'gc>> {
|
|
|
|
self.device_font
|
2019-10-26 06:44:12 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/// Sets the device font.
|
2019-12-17 05:21:59 +00:00
|
|
|
pub fn set_device_font(&mut self, font: Option<Font<'gc>>) {
|
2019-10-26 06:44:12 +00:00
|
|
|
self.device_font = font;
|
2019-05-24 17:25:03 +00:00
|
|
|
}
|
2020-08-07 02:46:53 +00:00
|
|
|
|
2020-10-05 22:46:36 +00:00
|
|
|
/// Check if the current movie's VM type is compatible with running code on
|
|
|
|
/// a particular VM. If it is not, then this yields an error.
|
|
|
|
pub fn check_avm_type(&mut self, new_type: AvmType) -> Result<(), Error> {
|
2020-10-06 01:41:51 +00:00
|
|
|
if self.avm_type != new_type {
|
2020-08-07 02:46:53 +00:00
|
|
|
return Err(format!(
|
|
|
|
"Blocked attempt to run {:?} code on an {:?} movie.",
|
2020-10-06 01:41:51 +00:00
|
|
|
new_type, self.avm_type
|
2020-08-07 02:46:53 +00:00
|
|
|
)
|
|
|
|
.into());
|
|
|
|
}
|
|
|
|
|
2020-10-06 01:41:51 +00:00
|
|
|
self.avm_type = new_type;
|
2020-08-07 02:46:53 +00:00
|
|
|
|
|
|
|
Ok(())
|
|
|
|
}
|
2020-08-08 00:39:15 +00:00
|
|
|
|
2020-10-06 01:41:51 +00:00
|
|
|
/// Get the VM type of this movie.
|
|
|
|
pub fn avm_type(&self) -> AvmType {
|
2020-10-05 22:46:36 +00:00
|
|
|
self.avm_type
|
2020-08-08 00:39:15 +00:00
|
|
|
}
|
2020-10-07 03:48:43 +00:00
|
|
|
|
2020-10-09 01:54:51 +00:00
|
|
|
pub fn set_avm2_domain(&mut self, avm2_domain: Avm2Domain<'gc>) {
|
2020-10-07 03:48:43 +00:00
|
|
|
self.avm2_domain = Some(avm2_domain);
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Get the AVM2 domain this movie runs under.
|
|
|
|
///
|
|
|
|
/// Note that the presence of an AVM2 domain does *not* indicate that this
|
|
|
|
/// movie provides AVM2 code. For example, a movie may have been loaded by
|
|
|
|
/// AVM2 code into a particular domain, even though it turned out to be
|
|
|
|
/// an AVM1 movie, and thus this domain is unused.
|
2020-10-09 01:54:51 +00:00
|
|
|
pub fn avm2_domain(&self) -> Avm2Domain<'gc> {
|
2020-10-07 03:48:43 +00:00
|
|
|
self.avm2_domain.unwrap()
|
|
|
|
}
|
2019-05-24 17:25:03 +00:00
|
|
|
}
|
|
|
|
|
2019-11-14 02:41:38 +00:00
|
|
|
/// Symbol library for multiple movies.
|
|
|
|
pub struct Library<'gc> {
|
|
|
|
/// All the movie libraries.
|
|
|
|
movie_libraries: PtrWeakKeyHashMap<Weak<SwfMovie>, MovieLibrary<'gc>>,
|
|
|
|
}
|
|
|
|
|
|
|
|
unsafe impl<'gc> gc_arena::Collect for Library<'gc> {
|
|
|
|
#[inline]
|
|
|
|
fn trace(&self, cc: gc_arena::CollectionContext) {
|
|
|
|
for (_, val) in self.movie_libraries.iter() {
|
|
|
|
val.trace(cc);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
impl<'gc> Library<'gc> {
|
|
|
|
pub fn library_for_movie(&self, movie: Arc<SwfMovie>) -> Option<&MovieLibrary<'gc>> {
|
|
|
|
self.movie_libraries.get(&movie)
|
|
|
|
}
|
|
|
|
|
|
|
|
pub fn library_for_movie_mut(&mut self, movie: Arc<SwfMovie>) -> &mut MovieLibrary<'gc> {
|
|
|
|
if !self.movie_libraries.contains_key(&movie) {
|
2020-10-06 01:41:51 +00:00
|
|
|
let slice = SwfSlice::from(movie.clone());
|
|
|
|
let mut reader = slice.read_from(0);
|
2020-10-06 02:25:50 +00:00
|
|
|
let vm_type = if movie.header().version > 8 {
|
|
|
|
match reader.read_tag_code_and_length() {
|
|
|
|
Ok((tag_code, _tag_len))
|
|
|
|
if TagCode::from_u16(tag_code) == Some(TagCode::FileAttributes) =>
|
|
|
|
{
|
|
|
|
match reader.read_file_attributes() {
|
|
|
|
Ok(attributes) if attributes.is_action_script_3 => AvmType::Avm2,
|
|
|
|
Ok(_) => AvmType::Avm1,
|
|
|
|
Err(e) => {
|
2020-10-11 02:27:42 +00:00
|
|
|
log::error!("Got {} when reading FileAttributes", e);
|
2020-10-06 02:25:50 +00:00
|
|
|
AvmType::Avm1
|
|
|
|
}
|
2020-10-06 02:05:11 +00:00
|
|
|
}
|
2020-10-06 01:41:51 +00:00
|
|
|
}
|
2020-10-11 02:27:42 +00:00
|
|
|
// SWF defaults to AVM1 if FileAttributes is not the first tag.
|
2020-10-06 02:25:50 +00:00
|
|
|
_ => AvmType::Avm1,
|
2020-10-06 02:05:11 +00:00
|
|
|
}
|
2020-10-06 02:25:50 +00:00
|
|
|
} else {
|
|
|
|
AvmType::Avm1
|
2020-10-06 02:05:11 +00:00
|
|
|
};
|
2020-10-06 01:41:51 +00:00
|
|
|
|
2020-10-06 02:05:11 +00:00
|
|
|
self.movie_libraries
|
|
|
|
.insert(movie.clone(), MovieLibrary::new(vm_type));
|
2019-11-14 02:41:38 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
self.movie_libraries.get_mut(&movie).unwrap()
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
impl<'gc> Default for Library<'gc> {
|
|
|
|
fn default() -> Self {
|
|
|
|
Self {
|
|
|
|
movie_libraries: PtrWeakKeyHashMap::new(),
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|